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 Jan 15, 2013@XVampiregurlX
which version are you using?
little idea from me:
maybe an old one, and updated, and forgot to move the pages into the new pages.yml?
-
View User Profile
-
Send Message
Posted Jan 9, 2013It is not working for me, I changed the help to:
help:
- '%darkred%/help <your rank>,'
- '%lightpurple%will give you a list of commands'
- '%lightpurple%and tips that pertain to your rank.'
- '%lightpurple%But, don't be afraid to ask otherwise.'
(without excessive spacing, had to do it for comment to spread them)
I then /help -reload then /help
And it says: Page help does not exist
-
View User Profile
-
Send Message
Posted Jan 8, 2013Tell me, as well as realize tilt text?
add: Question is removed. Can iispolzovat %italic%
-
View User Profile
-
Send Message
Posted Dec 28, 2012@z00100100
this should be working with 1.4.6, if it doesnt please post a ticket :)
-
View User Profile
-
Send Message
Posted Dec 27, 2012could this be updated for compatibility on 1.4.6 or is the plugin already compatible?
-
View User Profile
-
Send Message
Posted Dec 24, 2012@MrGermanrain
sry for looking so late, im gonna try tomorrow what i can do, kind of tired now, merry xmas!
edit:
a line of my pages.yml looks like this:
- '%red%
##########'and it works o.รด
-
View User Profile
-
Send Message
Posted Dec 18, 2012I get an error , when I put lets say, - '%red%Blablabla
I get an error from the server: found that %%' can not start a token, I have tried many things but I dont know how to fix this :/ can you please pm me the answer! if you want ill msg you what i put in the pages.yml and maybe you can tell me how to do this better :)
-
View User Profile
-
Send Message
Posted Nov 24, 20121.4.5 Update will come this Weekend!
(well the previous versions work with them too, but theres more stuff )
I've got the code finished, just need to update this frontpage and upload it
edit: waiting for approval!
edit2: for the impatient ones: http://dev.bukkit.org/server-mods/myhelppages/files/6-myhelp-pages-1-4-2/
-
View User Profile
-
Send Message
Posted Nov 7, 2012Just chiming in to say this is a great plugin, and it's working fine on our 1.4.2r0.2 server. Thanks!
-
View User Profile
-
Send Message
Posted Oct 20, 2012@ShadowKillerx
I've got an temporarily solution, just disable that /plugin check of NCP and in your permissions, do this:
(the thing is, I'm using Permissions Bukkit, so you need to adapt this Part to your Perms-Plugin)
bukkit.command.plugins: false bukkit.command.help: false
-
View User Profile
-
Send Message
Posted Sep 1, 2012@Mtihc
Can you add aliases for that? Or change default command to another?
-
View User Profile
-
Send Message
Posted Aug 30, 2012@Goblom
This post is also important for you, Goblom!
@Psithief
-
View User Profile
-
Send Message
Posted Aug 30, 2012@mrloaxx
@ConnectCraft
@Psithief
Ok nice.
Thanks for your continuing support Psithief! :D
-
View User Profile
-
Send Message
Posted Aug 29, 2012@Mtihc
NoCheatPlus implemented an anti-help command check, as bukkit's /help became on by default when they added their help system.
It also affects MyHelpPages. Thus, NCP by default blocks this entire plugin. It can be turned off by disabling the protect-plugins check. In my opinion, this is the most likely source of the commenter's problem.
-
View User Profile
-
Send Message
Posted Aug 28, 2012@mrloaxx
@Mtihc
Reading the comment again. I realize I didnt really understand.
So permissions are not working at all huh?
I should have a look at that. What kind of permission plugin are you using?
And did you try myhelppages.allpages
-
View User Profile
-
Send Message
Posted Aug 28, 2012@Goblom
Well then, stop using '*' permissions.
That's the first thing I learned when I installed my first plugin back in the day
-
View User Profile
-
Send Message
Posted Aug 27, 2012@mrloaxx
same here, it really annoys me to because my players need /help so they can understand more about my pvp arenas and what you can do with them.
-
View User Profile
-
Send Message
Posted Aug 21, 2012@mrloaxx
I'm gonna start looking through that this week i think ;)
edit: sorry didn't have time for that, just read the sentence above again :D
-
View User Profile
-
Send Message
Posted Aug 20, 2012@mrloaxx
Have you tried updating PermissionsBukkit and Essentials?
Or maybe something changed in bukkit's permission system since 1.3.1.
It could be.... not sure how I'm gonna figure this out though
-
View User Profile
-
Send Message
Posted Aug 20, 2012Hello, I do use your plugin (which is amazingly useful!) but recently, after one of the newer bukkit 1.3.1 builds, I'm having problems giving permissions to /help.. I'm only able to read the help pages being OP, giving users myhelppages.* or a certain page is not working. It was before the new bukkit build though.. I'm using PermissionsBukkit and Essentials, these are the only plugins that should be able to cause 'conflicts' if there are any. Hope I can get this sorted out soon, I wrote an entire book with myhelppages. :)