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 ;) )
@sithlordtom2
WorldEdit uses different system to register its commands. I'll look at it.
For some reason WorldEdit commands aren't showing up on the help pages. There aren't any errors either. Any ideas?
@mrvertigo27
You mean splitting up usage into several parts? I'll add it in 0.6
This (in a perfect world) is a great solution. I will be testing this tonight!!
P.S. it might be nice if you stated in the OP or on another page how the plugin lists variables in commands.
@Silarn
Please post me the error report in a ticket.
@LordKainzo: I believe this is the phase of this plugin, when it's buggy. You can help by testing and posting me the error reports in a ticket of course. Better description of problem helps me to fix that faster. When there'll be no more error posts, I'll publicly release 0.6. I guess it's what youre waiting for. Every bug mentioned here will obviously not be there.
Still receiving MySQL errors with 0.53 on boot. Ed: On 1.1 server.*
I love the concept of this plugin, I'm scared of the crashing.
@tomsik68
thanks will test it
EDIT with Permissions why does it not support PEX anymore for the config ?
EDIT:
Happens with R1 and your latest upload.
The recent update seems to have broken something with the MySQL queries:
Thanks for the fix! I had not noticed the ticket system. I'll use that next time. Also I'm glad to hear you already have it on github. Here's the link I found, for anyone else who is wondering:
https://github.com/tomsik68/HelpPlus
@clehner
The source is already on github :) . I exactly know where the problem is: some of your commands has too long description/usage. I've again uploaded fix, so wait until it gets approved. In the future, please use ticket system to submit your issues. It keeps things more organised.
@tomsik68
Nice. Well I updated to Java 7 for it already, but that's good that the dep was removed.
Now the plugin loads but still has an error when the command is used. It did work once, so I'm not sure what happened.
Thanks for making this by the way. It's very useful. Consider putting the source on github so other people can help you out with it.
@clehner
I've just uploaded 0.51. Once it gets approved, you can download it(you shouldn't get that error with 0.51). The error you're getting is about your Java version. 0.5 requires Java 7. I removed the dependency in 0.51.
I get this error:
What is this version referring to?
@ledhead900
0.5 should solve all of your issues. If you had a lot of commands or HelpPlus slowed your server down/caused lag, database will handle that for you at the fastest speed. enjoy :) !
@ledhead900
I've created a ticket based on your report. I'll check it out, but first, send me your configuration of Help+(add comment to ticket). http://dev.bukkit.org/server-mods/help-plus/tickets/2-reply-493134-my-server-has-been-locking/
@tomsik68
My server has been locking up for weeks now and we finally pin pointed it we think as it was reproduce able by typing /help 2 as a NON OP player. I think your plugin has a serious bug somewhere as cpu usage hit the roof and server could only be closed by closing the processes as all else was non responsive.
http://akic23.blogspot.com/
@tomsik68
More about permissions: Permissions which this plugin uses are just documentation which plugin developers need to write separately from permission checking, which is done in code. Help+ isn't able to go through code and find the permission nodes for commands. Documentation(Help+ uses) and permission checking(which is done in code) are separated. That's it. I hope it makes you the problem more clear :).
@Sacredox
I haven't even known about that :D, so thanks for informing me :). I'll add it to 0.4. Also, next change will be: commands will be red from plugins' ymls only first time and they'll be copyed to config file and you'll not have to rewrite your 34 pages.