share/command.yaml

   1 # Copyright (c) 2004-2015 Jeremy Stanley <fungi@yuggoth.org>. Permission
   2 # to use, copy, modify, and distribute this software is granted under
   3 # terms provided in the LICENSE file distributed with this software.
   4
   5 __control__:
   6     read_only: yes
   7
   8 command:chat:
   9     action: command_chat(actor)
  10     description: Enter and leave chat mode.
  11     help: The chat command toggles chat mode. When in chat mode, all input is passed as a parameter to the say command, unless prepended by an exclamation mark (!). For example, to leave chat mode, use:$(eol)$(eol)   !chat
  12     see_also: say
  13
  14 command:create:
  15     action: command_create(actor, parameters)
  16     administrative: yes
  17     description: Create a new element in the universe.
  18     help: Ways to create an element:$(eol)$(eol)   create actor:fred$(eol)   create other:garply foo/bar/baz
  19
  20 command:delete:
  21     action: command_delete(actor, parameters)
  22     administrative: yes
  23     description: Delete an existing facet from an element.
  24     help: You can delete any facet of an element as follows:$(eol)$(eol)   delete area:boardroom terrain
  25
  26 command:destroy:
  27     action: command_destroy(actor, parameters)
  28     administrative: yes
  29     description: Destroy an existing element in the universe.
  30     help: You can destroy any element in the universe as follows:$(eol)$(eol)   destroy prop:dagger
  31
  32 command:halt:
  33     action: command_halt(actor, parameters)
  34     administrative: yes
  35     description: Shut down the world.
  36     help: This will save all active accounts, disconnect all clients and stop the entire program.
  37
  38 command:help:
  39     action: command_help(actor, parameters)
  40     description: List commands or get help on one.
  41     help: This will list all comand words available to you along with a brief description or, alternatively, give you detailed information on one command.
  42
  43 command:look:
  44     action: command_look(actor, parameters)
  45     description: Look around.
  46     help: With the look command, you can see where you are.
  47
  48 command:move:
  49     action: command_move(actor, parameters)
  50     description: Move in a specific direction.
  51     help: You move in a direction by entering:$(eol)$(eol)   move north
  52
  53 command:quit:
  54     action: command_quit(actor)
  55     description: Leave the World.
  56     help: This will deactivate your avatar and return you to the main menu.
  57
  58 command:reload:
  59     action: command_reload(actor)
  60     administrative: yes
  61     description: Reload modules and data.
  62     help: This will reload all python modules and read-only data files.
  63
  64 command:say:
  65     action: command_say(actor, parameters)
  66     description: State something out loud.
  67     help: This allows you to speak to other characters within the same area. If you end your sentence with punctuation, the message displayed will incorporate an appropriate action (ask, exclaim, et cetera). It will also correct common typographical errors, add punctuation and capitalize your sentence as needed (assuming you speak one sentence per line). For example:$(eol)$(eol)   > say youre sure i went teh wrong way?$(eol)   You ask, "You're sure I went the wrong way?"$(eol)$(eol)If necessary, enclose literal statements in quotation marks:$(eol)$(eol)   > say "youre sure i went teh wrong way?"$(eol)   You say, "youre sure i went teh wrong way?"
  68     see_also: chat
  69
  70 command:set:
  71     action: command_set(actor, parameters)
  72     administrative: yes
  73     description: Set a facet of an element.
  74     help: Invoke it like this:$(eol)$(eol)   set actor:dominique description You see nothing special.
  75
  76 command:show:
  77     action: command_show(actor, parameters)
  78     administrative: yes
  79     description: Show various data.
  80     help: Here are the possible incantations (<parameter> is required, [option] is optional, (note) is a note):$(eol)$(eol)   show categories (list all element category names)$(eol)   show category <category> (list the elements in a category)$(eol)   show element <element> (list facet definitions for an element)$(eol)   show file <filename> (list elements in a file)$(eol)   show files (list all element data files)$(eol)   show log [level [start [stop]]] (list logs above level from start to stop)$(eol)   show result <expression> (evaluates a python expression)$(eol)   show time (returns several current timer values)