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