Make command actions implicit
[mudpy.git] / share / command.yaml
1 ---
2 _copy: Copyright (c) 2004-2019 mudpy authors. Permission to use, copy,
3     modify, and distribute this software is granted under terms
4     provided in the LICENSE file distributed with this software.
5
6 _desc: This is the standard library of command definitions.
7
8 _lock: true
9
10 command.chat.description: Enter and leave chat mode.
11 command.chat.help: The chat command toggles chat mode. When in chat mode, all
12     input is passed as a parameter to the say command, unless prepended by an
13     exclamation mark (!). For example, to leave chat mode,
14     use:$(eol)$(eol)   !chat
15 command.chat.see_also: say
16
17 command.create.administrative: true
18 command.create.description: Create a new element in the universe.
19 command.create.help: Ways to create an element:$(eol)$(eol)   create
20     actor.avatar_fred_1$(eol)   create other.garply foo/bar/baz
21
22 command.delete.administrative: true
23 command.delete.description: Delete an existing facet from an element.
24 command.delete.help: You can delete any facet of an element as
25     follows:$(eol)$(eol)   delete area.boardroom terrain
26
27 command.destroy.administrative: true
28 command.destroy.description: Destroy an existing element in the universe.
29 command.destroy.help: You can destroy any element in the universe as
30     follows:$(eol)$(eol)   destroy prop.dagger
31
32 command.halt.administrative: true
33 command.halt.description: Shut down the world.
34 command.halt.help: This will save all active accounts, disconnect all clients
35     and stop the entire program.
36
37 command.help.description: List commands or get help on one.
38 command.help.help: This will list all comand words available to you along with
39     a brief description or, alternatively, give you detailed information on one
40     command.
41
42 command.look.description: Look around.
43 command.look.help: With the look command, you can see where you are.
44
45 command.move.description: Move in a specific direction.
46 command.move.help: You move in a direction by entering:$(eol)$(eol)   move
47     north
48
49 command.preferences.description: View or change your preferences.
50 command.preferences.help: If invoked with no parameters, all your current
51     preferences and their values are listed. If one parameter is supplied, the
52     value of the preference with that name is displayed. If more than one
53     parameter is supplied, the first must be the name of a preference and the
54     remainder is the value to which you wish to change it.
55     Examples:$(eol)$(eol)   preferences$(eol)   preferences
56     prompt$(eol)   preferences prompt $_(time)>
57
58 command.quit.description: Leave the World.
59 command.quit.help: This will deactivate your avatar and return you to the main
60     menu.
61
62 command.reload.administrative: true
63 command.reload.description: Reload modules and data.
64 command.reload.help: This will reload all python modules and read-only data
65     files.
66
67 command.say.description: State something out loud.
68 command.say.help: This allows you to speak to other characters within the same
69     area. If you end your sentence with punctuation, the message displayed will
70     incorporate an appropriate action (ask, exclaim, et cetera). It will also
71     correct common typographical errors, add punctuation and capitalize your
72     sentence as needed (assuming you speak one sentence per line). For
73     example:$(eol)$(eol)   > say youre sure i went teh wrong way?$(eol)   You
74     ask, "You're sure I went the wrong way?"$(eol)$(eol)If necessary, enclose
75     literal statements in quotation marks:$(eol)$(eol)   > say "youre sure i
76     went teh wrong way?"$(eol)   You say, "youre sure i went teh wrong way?"
77 command.say.see_also: chat
78
79 command.set.action: command.c_set
80 command.set.administrative: true
81 command.set.description: Set a facet of an element.
82 command.set.help: Invoke it like
83     this:$(eol)$(eol)   set actor.avatar_dominique_0 description You see
84     nothing special.
85
86 command.show.administrative: true
87 command.show.description: Show various data.
88 command.show.help: Here are the possible incantations (<parameter> is required,
89     [option] is optional, (note) is a note):$(eol)$(eol)   show element
90     <element> (list facet definitions for an element)$(eol)   show file
91     <filename> (list elements in a file)$(eol)   show files (list all element
92     data files)$(eol)   show group <group> (list the elements in a
93     group)$(eol)   show groups (list all element group names)$(eol)   show log
94     [level [start [stop]]] (list logs above level from start to
95     stop)$(eol)   show result <expression> (evaluate a python
96     expression)$(eol)   show time (return several current timer
97     values)$(eol)   show version (display running version and dependencies)