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-page
in small letters)
/help -reload
To 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
plugins
folder - Restart/reload the server.
- The default
config.yml
andpages.yml
files 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.help myhelppages.help-example-page myhelppages.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:
Love this mod! Thank you so much, it works wonderfully on a 1.0 server.
To those having issues: Check your ' ending and beginnings, that will mess you up!
Still doesn't work. I think i might have messed up in my writing but I don't know where.
@KIN0025
My bad at version 1.1 In the config file at
noPagePermission
, change "don't" to "do not".Edit:
FYI, that line doesn't really need to be changed.
@KIN0025
I cannot open the link :(
I really like this plugin but the server says it can't load my config. It says : Could not load configutration file. This is my config file- Your text to link here...