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 ;) )
Hello, after making hard decisions, I've decided to mark HelpPlus as inactive, because it is completely replaced by bukkit's help system. Bukkit's help system detects all commands along with permission, plugin, description and allows you to write your own topics. Main purpose of HelpPlus was to detect all commands, which is what Bukkit's help system now does, so HelpPlus is not necessary anymore. Thank you for supporting this project, if any plugin developers wish to take over, just toss me a PM :)
Need help with minecraft server's ? i am very good at setting up home hosted server's and Serverhosted Servers U Pay for if u need help i will help u add me on skype:Sniperfykiller or u can EmailMe-->Sniperfykiller
BUT I WILL CHARGE 5$ PER SERVER I WORK ON
@crunkazcanbe
Handling permissions is easy. However, my plugin still doesn't know where to find permission nodes for existing commands on your server. I'm still trying to use more and more sophisticated methods, but if plugin devs don't attach the permission information, HelpPlus has no chance of knowing it...
If you have 100 pages of commands why would you want to go through the trouble of exporting each command and making it not show thats 250+ commands . All I have ever tried to find is a simple help plugin that only displays the commands available to that group there in in permissions ex instead I have to use the essentials plugin its the only one that does that for help.
[22:09:11] [SEVERE] [HelpPlus] CommandMap hooking failed. This is not fatal error, but plugin will not find most of your commands.
@OriginalMadman
(Sorry for delayed answer, I'm constantly busy) You can easily do that like this:
1. Export all unwanted commands with /hpexport. 2. Set permission for all unwanted commands to non-existing permission. Something like 'i.dont.want.this.to.show'. 3. Done.
Plugin will test every player for permission 'i.dont.want.this.to.show' and it will not show those commands in the help anymore! :)
Nice plugin!
Request: Simple whitelist/blacklist function of commands you want or don't want to show up. My problem now is that I have 48 pages of commands for regular users and 70 for admins... I need a good way to reduce em quickly and easily.
@Mizery01
No, I'm still working on that, but there's a more serious error I encountered: The server with HelpPlus can't even enable! I believe I can't release next update till I fix that...
The project was abandoned ? Because always no update !
@Mizery01
Thank you for reporting this error. It's small, but still very important exploit I didn't manage to find :) It'll be fixed immediately
Hello, I have a problem with your plugin.
Link Removed: http://www.mediafire.com/?0dtdscbwyb1s8jv
@elemental115
So... what is your opinion on HelpPlus 1.0? Is it better?
@idrum69
Ok, thanks for feedback. I'll try harder on optimizing the code. However, I have some questions regarding your server:
The newest version (1.0) I would certainly use this plugin, except for that "facepalm" upon startup. If wouldn't be an issue if it didn't kick out my players.. However it does kick them. Maybe have the plugin have a delayed enable so that it will not kick the players out when they join in the seconds after startup?
@idrum69
That's normal behavior if you have tons of commands. HelpPlus needs to index them all. Which version are you using?
Howcome it says "Help+ has facepalmed." for 5-10 seconds after startup? I noticed that in that time in which it says this, players are kicked out of the server upon login... Is this normal behavior?
@elemental115 Ok, I'll do my best. Thanks for submitting the issue. Update ETA is April 15th, since I'll be now at EuroMath...
Although I can't do without something as useful as this,
This plugin is causing the shutdown of some Paid hosting accounts, by rampaging through the servers folder spamming the plugins on *every* startup, regardless of existing entries.
Their excuse is, since the HD I/O increases to 100% and makes lag for other customers, server must be disabled and debugged. :(
I think, and option to slow down the checking of each plugin, disabling the use of /help until it is complete would be a lifesaver for many, and again, a " /help update " to manually rescan all plugins if you know some have been removed, doing the whole folder with the slower method above, would make this *the* plugin for every server to have ;)
I hope we can resolve this trouble.
Updated list of plugins we are using. Thanks for the great plugin!
http://pastebin.com/v3vFFUve