Add descriptions to sample datafiles
[mudpy.git] / share / command.yaml
1 _copy: Copyright (c) 2004-2017 Jeremy Stanley <fungi@yuggoth.org>.
2     Permission to use, copy, modify, and distribute this software is granted
3     under terms provided in the LICENSE file distributed with this software.
4
5 _desc: This is the standard library of command definitions.
6
7 _lock: true
8
9 command:chat:
10     action: command_chat(actor)
11     description: Enter and leave chat mode.
12     help: The chat command toggles chat mode. When in chat mode, all input is passed as a parameter to the say command, unless prepended by an exclamation mark (!). For example, to leave chat mode, use:$(eol)$(eol)   !chat
13     see_also: say
14
15 command:create:
16     action: command_create(actor, parameters)
17     administrative: yes
18     description: Create a new element in the universe.
19     help: Ways to create an element:$(eol)$(eol)   create actor:fred$(eol)   create other:garply foo/bar/baz
20
21 command:delete:
22     action: command_delete(actor, parameters)
23     administrative: yes
24     description: Delete an existing facet from an element.
25     help: You can delete any facet of an element as follows:$(eol)$(eol)   delete area:boardroom terrain
26
27 command:destroy:
28     action: command_destroy(actor, parameters)
29     administrative: yes
30     description: Destroy an existing element in the universe.
31     help: You can destroy any element in the universe as follows:$(eol)$(eol)   destroy prop:dagger
32
33 command:halt:
34     action: command_halt(actor, parameters)
35     administrative: yes
36     description: Shut down the world.
37     help: This will save all active accounts, disconnect all clients and stop the entire program.
38
39 command:help:
40     action: command_help(actor, parameters)
41     description: List commands or get help on one.
42     help: This will list all comand words available to you along with a brief description or, alternatively, give you detailed information on one command.
43
44 command:look:
45     action: command_look(actor, parameters)
46     description: Look around.
47     help: With the look command, you can see where you are.
48
49 command:move:
50     action: command_move(actor, parameters)
51     description: Move in a specific direction.
52     help: You move in a direction by entering:$(eol)$(eol)   move north
53
54 command:quit:
55     action: command_quit(actor)
56     description: Leave the World.
57     help: This will deactivate your avatar and return you to the main menu.
58
59 command:reload:
60     action: command_reload(actor)
61     administrative: yes
62     description: Reload modules and data.
63     help: This will reload all python modules and read-only data files.
64
65 command:say:
66     action: command_say(actor, parameters)
67     description: State something out loud.
68     help: This allows you to speak to other characters within the same area. If you end your sentence with punctuation, the message displayed will incorporate an appropriate action (ask, exclaim, et cetera). It will also correct common typographical errors, add punctuation and capitalize your sentence as needed (assuming you speak one sentence per line). For example:$(eol)$(eol)   > say youre sure i went teh wrong way?$(eol)   You ask, "You're sure I went the wrong way?"$(eol)$(eol)If necessary, enclose literal statements in quotation marks:$(eol)$(eol)   > say "youre sure i went teh wrong way?"$(eol)   You say, "youre sure i went teh wrong way?"
69     see_also: chat
70
71 command:set:
72     action: command_set(actor, parameters)
73     administrative: yes
74     description: Set a facet of an element.
75     help: Invoke it like this:$(eol)$(eol)   set actor:dominique description You see nothing special.
76
77 command:show:
78     action: command_show(actor, parameters)
79     administrative: yes
80     description: Show various data.
81     help: Here are the possible incantations (<parameter> is required, [option] is optional, (note) is a note):$(eol)$(eol)   show categories (list all element category names)$(eol)   show category <category> (list the elements in a category)$(eol)   show element <element> (list facet definitions for an element)$(eol)   show file <filename> (list elements in a file)$(eol)   show files (list all element data files)$(eol)   show log [level [start [stop]]] (list logs above level from start to stop)$(eol)   show result <expression> (evaluates a python expression)$(eol)   show time (returns several current timer values)