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