Difference between revisions of "HELP"

From CoffeeMud Wiki
Jump to navigation Jump to search
 
(One intermediate revision by the same user not shown)
Line 5: Line 5:
 
|Description=Shows you a description of the commands and terminology used in the CoffeeMud system.  Each command is broken into five parts.  
 
|Description=Shows you a description of the commands and terminology used in the CoffeeMud system.  Each command is broken into five parts.  
 
*Command : Shows you the proper command name.
 
*Command : Shows you the proper command name.
*Usage  : Shows you the formal usage information.  Words in parenthesis () are not required.  Words in brackets () should not be typed as is, but describe the kind of thing to type in.
+
*Usage  : Shows you the formal usage information.  Words in parenthesis () are not required.  Words in brackets [] should not be typed as is, but describe the kind of thing to type in.
 
*Example : Gives a command example of how the command is typed in.  
 
*Example : Gives a command example of how the command is typed in.  
 
*Short(s): If a command has a shorter version, they will be listed here.
 
*Short(s): If a command has a shorter version, they will be listed here.
Line 12: Line 12:
  
 
===Notes===
 
===Notes===
.
+
*HELP SOCIAL (SocialName) will provide the help file for a specific social.  This is especially useful in cases where there is an ability with the same name as the social, like KICK.
 +
*HELP may provide additional cross-references in case your help text is mentioned in multiple help entries.

Latest revision as of 14:22, 22 July 2022

CoffeeMUD
Administrator                                                  Builder                                                              Player
=CoffeeMUD Player Information=
Basics Info     Commands     Socials     Combat     Groups Character Stats     Races     Classes     Abilities     Expertises     Achievements
World Deities     Areas     Property     Quests     Clans     Triumphs Items Items     Crafting     Ships
=CoffeeMUD Commands=
Account        Character        Combat        Commerce        Communication        Configuration        Items        Movement        Role Play        Sailing Ships       
Special    A       B       C       D       E       F       G       H       I       J       K       L       M        N       O       P       Q       R        S       T        U       V       W       Y
===HELP===
Usage: HELP "COMMAND NAME"
Examples: help commands
Shorts:
Description: Shows you a description of the commands and terminology used in the CoffeeMud system. Each command is broken into five parts.
  • Command : Shows you the proper command name.
  • Usage : Shows you the formal usage information. Words in parenthesis () are not required. Words in brackets [] should not be typed as is, but describe the kind of thing to type in.
  • Example : Gives a command example of how the command is typed in.
  • Short(s): If a command has a shorter version, they will be listed here.
  • Description: A summary of what the command actually does.


Notes

  • HELP SOCIAL (SocialName) will provide the help file for a specific social. This is especially useful in cases where there is an ability with the same name as the social, like KICK.
  • HELP may provide additional cross-references in case your help text is mentioned in multiple help entries.