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 ;) )
tried this, and when I type /help its always 1st time 1st time..
@dbh937
It's not possible now, but it's a great idea. I'll add it soon.
@tomsik68
Thanks so much for your help. I have another question, then. Is it possible to just disable help for WorldEdit (or any other plugin)? It takes up a lot of pages and I don't want my regular users getting confused with administration stuff.
Thanks again, dbh937
@dbh937
It's not a noob question. Seems to me like you're confused, so: Showing only available commands to players is not available, since I'm looking for the best solution of this problem. The state of this feature at the moment is, that it only works with few commands. Not all commands. Only few commands.
Is PermissionsBukkit supported? If not, how can one use SuperPermsBridge to only show commands a player has access to?
Sorry If this is a n00b question.
@sillyrosster
The real state of the feature is that it only works with few commands. However, lots of people are confused, so I removed it from features list. I'll have to work on it.
@tomsik68
So this feature works for you, right? If it doesn't, I would just remove it from the feature list for now.
@zxcdserf
I guess you're doing everything right as well as the plugin. The problem is, that HelpPlus doesn't know what permission node is neccessary for some of your commands. If you haven't got too much commands, you can setup permissions manually(see this page for more info on setting permission node manually). The fix for this isn't released yet, but I hope I'll be suggested/I'll find a way to fix this ugly problem, because it's the worst thing about this plugin.
I'm still very confused. The Feature list says "Displaying users only commands they can use", but when a normal user logs on and use the /help command, it shows every command on the server. Is there a fix or am I doing something wrong?
@darkmyre
Are you getting any error report in console? If so, please make a ticket including that error report. If not, don't make the ticket. Anyway, added the example config to main page.
Just installed this and tried to run it, and it doesn't seem to have created the config.yml. Can you post an example of the default config.yml so I can create one?
@sillyrosster
Yes. I'm interested in this plugin myself and I'm getting very nice feedback as well. Definitely keeping up! :)
Are you going to update to R5 when it comes out? This is a really nice plugin and I would like to use it when R5 comes out.
Would love to see this compatible with R3. I just installed it and am having the same crashes as the ones mentioned below. Overall I love it. Short. Simple. and Colorful.(:
@ledhead900
I'm having this problem too. Looking forward to this being fixed, this is a neat plugin and there aren't any proper replacements.
I see why this kept crashing the server now.
^ issue is I never got any NPE as a non OP player browsing help eventually just locks the server up this was not fixed from prev 0.52- 0.53 versions as it said it was.
displays all commands regardless of permissions using latest help plus 0.54 and pex 1.18
what should be flagged [INFO] comes up as [SEVERE] 2012-01-30 05:09:22 [INFO] [HelpPlus] Unloading HelpPlus v0.54. 2012-01-30 05:09:22 [SEVERE] [HelpPlus v0.54]Disabled 2012-01-30 05:09:22 [SEVERE] Jan 30, 2012 5:09:22 AM sk.tomsik68.helpplus.HelpPlus onDisable INFO: Disabled
Those Severe's should log at INFO level ;)
This is tested on 1.1 ;)
does not work with 1.1
@tomsik68
You mean a shite system ;), why cant he just be normal.