Help API

Discussion in 'Bukkit Preview' started by deltahat, Mar 11, 2012.

  1. Offline

    deltahat

    The new help API automatically generates a help index for all commands in your server using the description, usage, and permission information provided by the plugin.yml file. If the required information is missing, server administrator can update the help contents by editing the help.yml file. Additionally, server administrators can define their own help topics for inclusion in the index.

    The most basic way for a plugin to leverage the new help system is to properly fill out the description, usage, and permission nodes for each command in the plugin.yml file. Doing so will populate all the information in the generic help topic template and ensure that the command help is only visible to those who can access the command. If a plugin developer wants more control over the contents of a plugin's help, implementing a custom HelpTopic subclass will allow for complete control over all aspects of the topic's contents.

    For an example plugin that demonstrates all the plugin development features of help, see https://github.com/rmichela/HelpDem...java/com/ryanmichela/helpdemo/HelpPlugin.java
     
    iKeirNez, DrAgonmoray, manniL and 2 others like this.

Share This Page