MyHelpPages
Description
Define your own custom /help pages using this plugin.
Configure help pages in the pages file.
Set up custom Messages in the config file.
Give players permissions to certain pages.
Screenshots
Here is a screenshot showing the server's console window on the bottom right side,
the pages.yml file on the bottom left side and the ingameview on the top.
You can see the command that is being executed. And what the configuration looks like.
Features
- Make your own help commands that show custom text
- Permission node for all pages (
myhelppages.allpages) - Permission node per help page (
myhelppages.help-example-pagein small letters)
/help -reloadTo reload the config and page files/help -list [list number]To list all pages you have permission for
- Some custom messages
- Able to use colors
- Able to use variable
%page%in all messages. Will be replaced with the page name.
How to install
- Download the latest version here.
- Place it in the
pluginsfolder - Restart/reload the server.
- The default
config.ymlandpages.ymlfiles will be created inplugins/MyHelpPages.
Commands and Permissions
| Command | Description | Permission |
|---|---|---|
/help -reload | Reload the config.yml & pages.yml file | myhelppages.reload |
/help -list | List all pages you have permission for | myhelppages.list |
/help/help example page | Show a custom help page Keep the corresponding permission in small letters! | myhelppages.helpmyhelppages.help-example-pagemyhelppages.allpages |
Configuration
Colors
You can use colors in the text. For example: %red% means the following text will be red.
The colors are: aqua, black, blue, darkaqua, darkblue, darkgray, darkgreen, darkpurple, darkred, gold, gray, green, lightpurple, red, white, yellow, magic
Pages
The name of the page can be a number or text, it doesn't matter.
For example:
| If you want the command... | the page name in would be... | and the permission would be |
|---|---|---|
/help Example Page | help-Example-Page | myhelppages.help-example-page |
Custom Messages
You can specify some custom messages (config.yml):
noPagePermission- When the player does not have permission for the specified help page.
pageNotFound- When the player specified a non-existing help page.
pageTitle- The first line of every help page.
You can use the variable %page% anywhere. It will be replaced with the actual page name.
You have to be careful in the text, with characters like -, : and '. If you want to use them, surround the text with ' '.
Are you overwhelmed by all the dashes, semicolons and quotation marks?
Download this excel file, by jellewie. (Thanks!)
Type your text on one side, and copy the code from the other side.
And this is a useful tool, to see if your file has any errors!
Versions
- Version 1.5.1
- Tested with CB 1.5.1 Beta 0.1
- Version 1.4.2
- Tested with CB 1.4.5 r0.2
- Code cleanup
- ConnectCraft is now supporting this Plugin too!
- Version 1.4
- Tested with CB 1.3.1-R1.0
- Code cleanup
- Added /help ? (for command list)
- Version 1.2
- Tested with CB 1.1-R4
- Added support for chat color %magic%.
In fact, When there are new colors, the plugin should automatically support them - Added support for longer page names,
like help-me-getting-started would be /help me getting started - Allowing %page% variable in all text. Not just the ones in the messages section
- Version 1.1
- Fixed colors, use for example %red% instead of $c
- Version 1.0
- Release
- Colors not working properly
Source code
Tutorials
You might want to look here for a German Tutorial:
Comments
-
Forge_User_83064763 Owner
-
_ForgeUser8083764 Maintainer
-
View User Profile
-
Send Message
Posted Apr 30, 2012Hi,
great plugin, but I have one sugggestion!
If a mistake is found in config.yml, you overwrite the file. It would be better to make a backup!
-
View User Profile
-
Send Message
Posted Apr 26, 2012Great plugin! I've used HelpPages in the past and I loved it, to bad it stopped.
But could you maybe make the option to change the page title per page?
Now it's just a general title and I don't want that.
-
View User Profile
-
Send Message
Posted Apr 18, 2012Someone should help the HelpPages dude to get up to date. Because I think thats one of the best help pages system ever, specially for PEX users. MCDocs might sadisfy people too when it fixes his bugs.
-
View User Profile
-
Send Message
Posted Apr 18, 2012Has anyone taken on this project, or found a spiritual successor?
-
View User Profile
-
Send Message
Posted Apr 1, 2012@Mtihc
Aww I hope you at least keep it up-to-date. I love this plugin :D
-
View User Profile
-
Send Message
Posted Mar 26, 2012@TehMagilla
Sounds like a good feature.
I'm not so motivated to work on this plugin anymore. So I'm glad you suggested that I upload the code.
Here it is:
Github
-
View User Profile
-
Send Message
Posted Mar 26, 2012Request for an addition: the ability for people in certain permission groups to be able to send a given help page to other people (with checks to make sure the receiving party has permissions to receive the page).
If you give me access to the code, I'm happy to make the proposed changes for you...
-Thanks
-
View User Profile
-
Send Message
Posted Mar 20, 2012@Psithief
Yeah, just accidentally reloaded my server. :/ The plugin seems to be glitched and needs to be updated. None of my pages work other than the regular /help. /help Something only shows up as page not found.
-
View User Profile
-
Send Message
Posted Mar 18, 2012Running 1.2.3 b 2083, if I type "/help" followed by a bukkit command it executes the bukkit command.
"/help stop" executes "/stop" "/help list" executes "/list" and so on.
Is MyHelpPages responsible for this?
-
View User Profile
-
Send Message
Posted Mar 17, 2012Very nice plugin, I'm really hoping it's compatible with 1.2.3!
I have another suggestion, too. It's a simple one - could you make it so that /help also uses the /? alias so that it is basically impossible to call the ingame help menu? That would be perfect since I want this to be the only 'help' page on my server.
-
View User Profile
-
Send Message
Posted Mar 15, 2012Amazing plugin. very useful on my server :)
-
View User Profile
-
Send Message
Posted Mar 7, 2012@re4397
Would be cool huh? :)
Anybody up for it?
-
View User Profile
-
Send Message
Posted Mar 7, 2012please put printscreens or video
-
View User Profile
-
Send Message
Posted Mar 2, 2012Am I correct that v1.2 no longer takes precedence over bukkit's new help system? I've been getting reports that bukkit grabs /help list before this plugin does.
However this may be a permission error on my part.
-
View User Profile
-
Send Message
Posted Feb 28, 2012@jellewie
I am using a really * * * * * library called Spyc. It does not understand very many things about YAML, particularly mixing list and non-list nodes at the same indentation.
Link to the worst YAML parser ever: http://code.google.com/p/spyc/
-
View User Profile
-
Send Message
Posted Feb 28, 2012I updated for version 1.1-R4.
I bet it will work fine for R5 as well.
Waiting for file approval at the moment.
-
View User Profile
-
Send Message
Posted Feb 28, 2012Can you update this to upcoming R5 API just in case HelpPages plugin brokes?
Thanks
-
View User Profile
-
Send Message
Posted Feb 23, 2012@Mtihc
My mistake, I was not aware of YAML's line-folding capabilities.
-
View User Profile
-
Send Message
Posted Feb 23, 2012@Psithief
Minecraft itself has a wordwrap feature.
What kind of bug are you talking about? You're being too vague.
Did you get an error? Did text disappear? Did you computer explode?
-
View User Profile
-
Send Message
Posted Feb 23, 2012I think you have an auto wordwrap feature. I believe there is a bug with wordwrapping a too-long line that starts with %. Can you look into it?