share/command.yaml

   1 ---
   2 _copy: Copyright (c) 2004-2020 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.evaluate.debugging: true
  24 command.evaluate.description: Evaluate a Python expression.
  25 command.evaluate.help: For debugging purposes, you can use this to run certain
  26     Python language expressions within the running engine's context, though for
  27     safety reasons only a limited set of builtins are allowed, as well as
  28     objects in the mudpy package namespace and the active universe object.
  29     Expressions containing "__" or "lambda" are also prohobited for additional
  30     safety. Everything following the word "evaluate" is assumed to be a Python
  31     expression, and is passed to the eval() built-in, outputting a string
  32     representation of whatever it returns. Any exceptions are caught in an
  33     attempt to avoid accidentally crashing the engine. This command is mostly
  34     useful for inspecting the contents of in-memory objects, for
  35     example:$(eol)$(eol) evaluate universe.groups['actor'].keys()
  36
  37 command.delete.administrative: true
  38 command.delete.description: Delete an existing facet from an element.
  39 command.delete.help: You can delete any facet of an element as
  40     follows:$(eol)$(eol)   delete area.boardroom terrain
  41
  42 command.destroy.administrative: true
  43 command.destroy.description: Destroy an existing element in the universe.
  44 command.destroy.help: You can destroy any element in the universe as
  45     follows:$(eol)$(eol)   destroy prop.dagger
  46
  47 command.halt.administrative: true
  48 command.halt.description: Shut down the world.
  49 command.halt.help: This will save all active accounts, disconnect all clients
  50     and stop the entire program.
  51
  52 command.help.description: List commands or get help on one.
  53 command.help.help: This will list all command words available to you along with
  54     a brief description or, alternatively, give you detailed information on one
  55     command.
  56
  57 command.look.description: Look around.
  58 command.look.help: With the look command, you can see where you are.
  59
  60 command.move.description: Move in a specific direction.
  61 command.move.help: Move to another place by supplying the name of a
  62     portal/direction or a suitable abbreviation for one,
  63     like:$(eol)$(eol)   move north$(eol)   move s
  64
  65 command.preferences.description: View or change your preferences.
  66 command.preferences.help: If invoked with no parameters, all your current
  67     preferences and their values are listed. If one parameter is supplied, the
  68     value of the preference with that name is displayed. If more than one
  69     parameter is supplied, the first must be the name of a preference and the
  70     remainder is the value to which you wish to change it.
  71     Examples:$(eol)$(eol)   preferences$(eol)   preferences
  72     prompt$(eol)   preferences prompt $_(time)>
  73
  74 command.quit.description: Leave the World.
  75 command.quit.help: This will deactivate your avatar and return you to the main
  76     menu.
  77
  78 command.reload.administrative: true
  79 command.reload.description: Reload modules and data.
  80 command.reload.help: This will reload all python modules and read-only data
  81     files.
  82
  83 command.say.description: State something out loud.
  84 command.say.help: This allows you to speak to other characters within the same
  85     area. If you end your sentence with punctuation, the message displayed will
  86     incorporate an appropriate action (ask, exclaim, et cetera). It will also
  87     correct common typographical errors, add punctuation and capitalize your
  88     sentence as needed (assuming you speak one sentence per line). For
  89     example:$(eol)$(eol)   > say youre sure i went teh wrong way?$(eol)   You
  90     ask, "You're sure I went the wrong way?"$(eol)$(eol)If necessary, enclose
  91     literal statements in quotation marks:$(eol)$(eol)   > say "youre sure i
  92     went teh wrong way?"$(eol)   You say, "youre sure i went teh wrong way?"
  93 command.say.see_also:
  94     - chat
  95
  96 command.set.action: command.c_set
  97 command.set.administrative: true
  98 command.set.description: Set a facet of an element.
  99 command.set.help: Invoke it like
 100     this:$(eol)$(eol)   set actor.avatar_dominique_0 description You see
 101     nothing special.
 102
 103 command.show.administrative: true
 104 command.show.description: Show various data.
 105 command.show.help: Here are the possible incantations (<parameter> is required,
 106     [option] is optional, (note) is a note):$(eol)$(eol)   show element
 107     <element> (list facet definitions for an element)$(eol)   show file
 108     <filename> (list elements in a file)$(eol)   show files (list all element
 109     data files)$(eol)   show group <group> (list the elements in a
 110     group)$(eol)   show groups (list all element group names)$(eol)   show log
 111     [level [start [stop]]] (list logs above level from start to
 112     stop)$(eol)   show time (return several current timer
 113     values)$(eol)   show version (display running version and dependencies)