Help

Settings

Configuration File

As you can see here : Configuration Explanations there is an important setting for help. getHelpForAllPlugins: true This setting mean, the help will look into every installed plugin to populate the index. Using the plugin's name as a Key.

Extra Help

As you saw in Configuration Explanations there is a folder called HelpFiles where you can put … help file (like the one for AdminCmd).

They are extra help files created by the dev or other users. You can find them here : FabianN ExtraHelp Repository

To install it, you just have to create a directory having the name of the plugin and put the file in it. Now in the help command for that plugin, you'll have that help displayed.

The format for the help entries is like this:

acserverstop:
    command: stop [-t second]
    description: "Stop the server by kicking first every connected players. If the -t parameter is set, wait the time before stopping, else take the one configured in the configuration file."
    detailed: ""
    plugin: AdminCmd
    permissions: admincmd.server.stop
    cmdname: bal_stop

Where the variables are the following:

  • acserverstop - the name of the Help entry, each should be unique an only appear once
  • command - the command without the '/' and any parameters you can set
  • description - Should be self explanatory
  • detailed - You can put a longer explanation here which will be displayed when you look for it like this: /help AdminCmd -d stop
  • plugin - The plugin to which this command belongs
  • permissions - The permission associated with the command, you can set this to OP (must be upper case!) or ommit it. IMPORTANT: Do not forget the s in permissions!!!
  • cmdname: The name under which this command is known for bukkit

Allowed special characters in the desciption and detailed are: \n for a newline and &# for colouring, see Color Explanation for more information

How To Use

After checking the node.

Help command have 2 optional parameters and -s and -d flags : /help [PluginName || list || plugins ] [-s toSearch || Page || -d cmdName]

  • PluginName : the name of the plugin you want the help if you type list, it will list every plugin that you can have the help.
  • Page : the Page of the plugin help.
  • toSearch : when using the -s flag, represent the command you are looking for.
  • plugins && list : keyword to show the list of plugins with help.
  • cmdName : When using the -d flag you will get a detailed description of the given command

If you type /help list or /help plugins, you'll see :

About the -s flag :

First the command will try to match the begin of every command with what you typed, if the system can't found it, it will check the description.
If you don't provide a PluginName to the help command, it will search for your command in every plugins installed, and will show you the commands that match it.

Examples

Example /help -s sto :

Example /help -s ick :

AdminCmd

If you don't provide a plugin or a page to the command, you'll see the first page of AdminCmd help :

If you type /help 2 you'll have the second help page of AdminCmd.

Other Plugins

If you want the help for other plugins installed, and you put the help file in the helpFile dir or activated the help for every plugin in config :

/help Plugin Will show you the first page of that plugin.
/help Plugin 2 Will show you the 2nd page of that plugin
Etc …

features/help.txt · Last modified: 2012/06/01 22:40 by balor
Back to top
CC Attribution-Noncommercial-Share Alike 3.0 Unported
chimeric.de = chi`s home Valid CSS Driven by DokuWiki do yourself a favour and use a real browser - get firefox!! Recent changes RSS feed Valid XHTML 1.0