share/command.yaml

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