Help Plus
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!
Contact Author
If you wish to contact author somewhere else, you can do so on:
- Blog: http://tomsik68.blogspot.com/
- Twitter: https://twitter.com/tomsik68
- E-Mail: [email protected]
- GitHub: https://github.com/tomsik68 (also, sources of all plugins!)
- Skype: Tomsik68 (my pic is redstone dust ;) )
Yeah, that is a great idea, Vault it up a notch!
Also, I think I read below that you said a lot of permissions are undeterminable and so many commands will show up for users that shouldn't be showing which they have no permission to use. I can see they say Null for permissions. But how exactly does the game determine permissions when people try to do things then and can't you somehow use that?
I think Essentials help was showing the proper commands somehow or another but I don't know how it did it. Is there some way to hook into something so we don't have to manually type out all the commands with Null permissions and try to figure out and assemble everything?
Even just a command to output all the commands into that commands section of the config would be emensely helpful. Then all we would have to do is put in the proper permissions into them.
I have 34 pages of help I don't want to have to sift through for weeks typing everything out and trying to type them all out and match up their permissions. That just seems like something coding was invented for =)
I having the same issue as tomsik68 with GroupManager.
Have you considered Vault?
@tomsik68
Thank you, but I can't seem to get it to work with GroupManager still. It does seem to work with bPermissions though.
@Sacredox
Nope :). GM's page says it's fully compatible with superperms, what makes you able to use "Permissions" as permission system.
Am I out of luck if I'm using GroupManager for permissions? Maybe I should switch to bPermissions?
@bigscary
Commands are already sorted alphabetically. I could sort them by plugin (as they're in 0.2), but I'd have to remove alphabetical sorting. /help <plugin> is great idea, but I think it'll have to be /help <plugin> [page] (e.g. worldedit has 17 pages of commands). And this option would probably have to have permission too. Anyway, thanks for suggestion :) It'll appear in next version.
Thanks for doing this, Tomsik. A filtered list of commands is very helpful. Can you sort the commands by plugin, and offer a /help <plugin> for easy search?
@GreenSlime
Use Permissions. Please note that not every command has permission inside its description, so it may not work properly.
I have PermissionsBukkit installed, may I know what perms settings I should use to limit the availability of help?
@BetaStream
I don't think it's a bug of the plugin. A lot of commands haven't got information about permission which is needed to execute the command. I'll make so you'll be able to override commands' description(including permission). This option will make vanilla commands displaying possible. BTW Thanks everyone for great feedback! :)
Problem/Bug: When the config file looks like this:
and an user types /help it shows him all the commands not only these that he has permissions for :(
Is there a way to make it display vanilla commands that are available to the users, or is this not possible?
This plugin is great otherwise.
Thank you! I love you! The best! The only plugin that fits my needs about this thing!!!
@BetaStream
Yes, it's possible. I'll implement it today.
Could you possibly make it to shows the commands that the user has permissions for?
This is a good idea because this is the only standalone /help plugin that finds all the descriptions, i think? Anyway thanks man!