Help Plus

This project is abandoned and its default file will likely not work with the most recent version of Minecraft. Whether this project is out of date or its author has marked it as abandoned, this project is no longer maintained.

This project is now inactive, for more information see comment http:dev.bukkit.org/bukkit-plugins/help-plus/?comment=136

HelpPlus is an automated database-powered help plugin. It collects all commands from all your plugins and displays them when you type /help.

Features

  • Displays all commands from all plugins
  • Help is split up into pages
  • No need to write your own documentation on commands if you don't want to (description of a lot of commands is stored in plugins' ymls)
  • Configurable colors
  • Fast help search (SQL)
  • Players who don't have permission to use some command won't see the command. - Doesn't have to work for every command, but covers most commands.
  • From version 1.0, plugin is more efficient

Command usage

  • /help - Displays 1st page of commands
  • /help [page] - Displays specified page of commands
  • /help <command> - Displays information about single command
  • /hplisting - Lists all your commands & permission nodes into a single TXT file
  • /hpexport - Exports specified command to config file for overriding. Can be used like /hpexport <command name> or with patterns like /hpexport -p <pattern>
    • You can always type /h+ or /hp instead of /help if you want.

Installation

Download HelpPlus.jar and copy it to your plugins folder.

What does it display?

  • Command name
  • Permission needed for command(if any) - Important note: some commands don't include information about what permission do you need, so even if you setup everything right, it doesn't have to work.
  • Usage
  • Command aliases

Configuration

On the first launch, HelpPlus generates its own configuration file. If not, you can create it manually( it must be located in plugins/HelpPlus and must be named config.yml ) by copying an example one from this page.

Configuration Nodes

  • perms - Permissions system to use. Possible values(must exactly match): OP, None, SP.
  • cmds-on-page - How much commands to display on one page
  • colors.a - 1st color (default = blue) Possible values(can be lowercase): BLACK, DARK_BLUE, DARK_GREEN, DARK_AQUA, DARK_RED, DARK_PURPLE, GOLD, GRAY, DARK_GRAY, BLUE, GREEN, AQUA, RED, LIGHT_PURPLE, YELLOW, WHITE.
  • colors.b - 2nd color (default = gold) Possible values = same as above
  • colors.c - 3rd color (default = green) Possible values = same as above
  • show.plugin - Whether the user should see which plugin takes care of specified command( true/false )
  • help.perm - Whether you need permission(helpplus.help) to use /help (true or false)
  • commands - See Page "Overriding commands' info"
  • config-is-primary - If configuration should override information in database

Where are those information from?

Information are downloaded on each plugin list change or bukkit version change from plugins' ymls. If you're a plugin developer, please always put information about your commands into your plugins' ymls. Thanks. Don't know how to format commands in plugin.yml? Check page 'Formatting commands in plugin.yml'

Permissions

  • If you set help.perm to true in your config file, your users need to have permission "helpplus.help" to use /help.
  • helpplus.listing is needed for /hplisting command.
  • helpplus.hpexport is needed for /hpexport.

Achievement get!

using_helpplus

Contact Author

If you wish to contact author somewhere else, you can do so on:

Comments

Posts Quoted:
Reply
Clear All Quotes

About This Project

Categories

Members

Recent Files

Bukkit