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 ;) )
Seems to cause some lag when I install it.. That or my host choose a convenient day to fuck up lol.
@xH3LLRAIZ3Rx
In config file, set perms to "SP" (without quotes, must exactly match) and that's it.
how do i use pex with it
@blockcraft18
Try reloading the server. Page 1 of 0 means it hadn't found any commands, and that's not good for help plugin. Haven't you got any error(s) in your console?
Hey, I installed it and it worked but when I type /help it doesn't say anything but page 1 of 0 what do I do next?
@TTlabambaTT
Thanks! I'd just like to know whether it works right, because it was working for me.
Dayum you are one brainy dude will be updating the plugin as soon as the number of people on my server lower.
@AcidSikeO
Well, the error says, that it can't download commands from one place and that's not problem, because it just uses another place :) (it's really an intelligent plugin :D ). Although, this error is going to be fixed in next build. Thanks for reporting that and good feedback. :)
Your plugin seems to be doing its job on my server. I haven't had any problems using it, so far, but I noticed this in the console output:
Great plugin, btw. I intend to continue using as long as the error I got is of no concern. :)
@TTlabambaTT
Try checking out the newest release. I've added a "permission resolver", so it can detect permission for each command itself. If it won't work, just comment/create a ticket. I'm really glad you like this :)
Hi. Awesome plugin I really wanted something like this, the only one that does is essentials and that is a huge plugin to just use the /help with it. I would love to see the ability not to show certain commands on maybe just a "show: true/false" system for each command because the odd command gets through even though they don't have permissions for it. Thanks
TTlabambaTT
@tomsik68
Yep. You were right, and this worked! Thank you so much!
@ThyFluffyOne
It's locally stored in file plugins/HelpPlus/HelpPlus.db , am I right? If so, deleting this file should solve all your problems.
@tomsik68
Well the thing is, ever since the first time I started pail, the console never came up again. I'll see what I can do about that, cause their has to be a way to get the original cmd-esque console back. Oh, and I'm not using any databases, it's all locally stored in one file.
Here's two pictures showcasing my problems, which is about the best I can do sorry... http://imgur.com/hxQmy&EagGy&jZzRZ&MoIss#2
@ThyFluffyOne
It's always first time, because it always fails indexing commands. It looks like a database error to me. Could you please disable Pail,start server in console and send me those errors? Also, are you running SQLite or MySQL database?
I get the same problem as morizuki. I start up my server with the latest release of CB and HelpPlus, both 1.2.5 for sure, and every time i type /help is says
"[HelpPlus] This command was used 1st time! Indexing commands... it may take a while An internal error occurred while attempting to perform this command"
It says that every time, no matter what. The server console says:
"[HelpPlus] CommandMap hooking failed. Probably not a craftbukkit server. Falling back to an API function"
Also, on startup, the console says:
"[SEVERE] Error occurred while enabling HelpPlus v0.6 (Is it up to date?) "
I'm sorry, but this is the best error report I can provide since I use Pail, and it gets rid of most of the coding gibberish that comes out of the console. Again, I am 100% Sure craftbukkit is 1.2.5 r1.0, and so is the plugin. Help?
@tomsik68
Ah thanks for that. I'll give it a try.
@MuttzNutz
I think there's such feature included in current version. The feature is in state of testing, because it's been causing some problems. However, you can feel free to use it. It's: /help <plugin name> . That command displays all commands which specified plugin handles. It may be included or not. I'm very unsure about it. If it's not included, it's on my TO-DO list.
Is there any chance you could make it organise the lists from /help into their respective plugins? So like for instance if I had 2 plugins, one being Herochat the other being MultiSpawn it would list the help like so: Example
This would help a great deal as it's near impossible finding commands any faster than opening up the plugins webpage and looking for them on there when you have 23 pages from just 12 plugins all mixed up amongst each other.
At the moment there doesn't seem to be a help plugin done the way I have suggested. Essentials handles my help at the moment but it is exactly the same layout as this is atm. Not putting your plugin down by all means. You've done a good job but would be nice if it could be the way I have suggested as then that makes this the only one that is like that.
Anyway thanks for reading. I got no beef if you say you don't want to for any reason :P
@morizuki
What version of CB & HelpPlus? It should only be first time when you enable server or restart HelpPlus either via plugin manager or reload command.