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:
-
View User Profile
-
Send Message
Posted Feb 1, 2012@jellewie
Oh dus jij bent ook een Nederlander :P
I meant it would be nice, if the link stays the same!Anyway, I can update the link once in while, that's no problem either.
Edit: Lolz, i totally read over the word NOT... you even capitalized it :/
-
View User Profile
-
Send Message
Posted Feb 1, 2012@Mtihc
It's hard (but not inposible) to NOT change the link
VERSION 1.1 https://docs.google.com/open?id=0B5IOdFVBhVS5NWYxOTU2MDMtYzU3NS00ZmJmLThjODUtNjcyNmY3YTZkZjJi
the Dutch release on my website http://jellewie.weebly.com/myhelppage.html
-
View User Profile
-
Send Message
Posted Feb 1, 2012@jellewie
I was starting to have mixed feelings about this plugin. It's useful! but it's hard to use.
Your excel file makes me happy again :P
If you update the file on Google Docs, the link does not have to change. At least I think it works that way.
-
View User Profile
-
Send Message
Posted Feb 1, 2012@Mtihc
And i am not finished yet with the excel,
comming soon: give a message when you use a '
color the line when you use a '
color the line when you add 2 text in 1 line
I am looking forward to post it ;)
-
View User Profile
-
Send Message
Posted Jan 31, 2012@jellewie
Glad it was just because of the typo's :)
That excel file you made is cool! That makes it much nicer to type long stories xD
-
View User Profile
-
Send Message
Posted Jan 31, 2012@Mtihc
thank you very much, it works
maybe you don't like it but i got make a editor in Microsoft Excel (NO MACROS! because people think it's is a virus??)
you can download it here
https://docs.google.com/open?id=0B5IOdFVBhVS5YjhiN2RmMGMtMjA4ZC00OTNjLTgwNDUtODY1OTEyNzEzMWZh
-
View User Profile
-
Send Message
Posted Jan 26, 2012@jellewie
I can see some errors in your config file.
(first of all, shouldn't Config.yml be with a small c? Not sure if it matters)
You have 3 things wrong in your config.yml file.
But I don't think that will solve your problem.
It looks like some other plugin... or something... is trying to execute my custom help command.
As if it's like... "duhhhh.. you executed a command wrong.. here's how it works".
This plugin itself never uses that specific text you get
"/help [page] /help -reload /help -list [listpage] /help [search term] [page]"
So I think maybe another plugin has priority over my plugin, but it's still using my command or something. I'm just rambling.
Please try uninstalling this plugin (move the jar-file to another folder)
Then, start the server... and see what plugin uses the help command.
I tested this with the Essentials plugin also installed. And when I do the help command, I get my own plugin's help-text, because Essentials is loaded very early in the startup process. My plugin is loaded later. So it overrides the Essentials plugin's help command.
Maybe you have a plugin that is enabled later than my plugin. A plugin that also uses the original help command.
-
View User Profile
-
Send Message
Posted Jan 26, 2012wat are i am doing wrong? its only says
/help [page] /help -reload /help -list [listpage] /help [search term] [page]
no matter what i typ
https://docs.google.com/open?id=0B5IOdFVBhVS5YmRjZGYxZjgtMTViNS00ZmZmLWE5MmQtNTlmYzk1OGM2MTIy
-
View User Profile
-
Send Message
Posted Jan 15, 2012@ArmyHill01
Since bukkit version ... (i dont know)... there's a little bit more info in the configuration error messages. I didn't even have to do anything haha.
This does probably give me the ability to be more precise in my custom errors.
Still not sure if I will ever do this.
Bukkit is constantly being updated. Keep track of the latest development build over here:
http://ci.bukkit.org/job/dev-CraftBukkit/
-
View User Profile
-
Send Message
Posted Jan 7, 2012@ArmyHill01
I hear what you're saying. I could probably add more help like that. But I'm not sure how precise I can get.
This is a good suggestion. But I'm starting to spend less and less time on plugins. I cannot promise anything.
-
View User Profile
-
Send Message
Posted Jan 6, 2012Firstly, love the plugin. Simple and neat, just what i wanted.
Is there anyway you can add a line number for errors to help debug? So if on the 5th line i forget a ' at the end, the console can give a parse error at line 5? If you can I'd love that soo much as I'm sure others would too.
Thanks again and keep up the good work!
-
View User Profile
-
Send Message
Posted Jan 6, 2012To be fair, Essentials' help does look good :)
-
View User Profile
-
Send Message
Posted Jan 6, 2012@exmental
Hey man! That's bad advertising haha. ;)
I should look into that. Everyone uses essentials!
My problem is, I start with something without looking if it's already been done :P
-
View User Profile
-
Send Message
Posted Jan 6, 2012@Mtihc i just removed this plugin and used essentials much easier as i tryed everything and every node to try and fix but no luck :D
-
View User Profile
-
Send Message
Posted Jan 6, 2012@exmental
There's something weird, about what you said:
You use myhelppages.help-user
And then try command /help listuser
Don't you mean /help user
-
View User Profile
-
Send Message
Posted Jan 6, 2012seems my permission nodes for this plugin dont seem to work i dont get errors or anything they just dont seem to show the help page for my groups ingame.
i use this for my User group for example . myhelppages.help-User but ingame it says you dont have the permissions to see /help listuser :/ anyone can help it would be much appreciated or point me in the right direction for nodes :D.
-
View User Profile
-
Send Message
Posted Jan 1, 2012@ace1177
It seems like you figured it out. But I will give an explenation of how it works anyway.
I'm not sure what you mean but...
I came up with the %page% stuff because, well... mainly because of the
pageTitleproperty. I wanted to provide a way to set a title that comes up with every page.It would only make sense if you can include the page name in that title. Hence the %page% variable.
So you can set the
pageTitleproperty like this: pageTitle: This is page %page%-
View User Profile
-
Send Message
Posted Dec 31, 2011@Mtihc
Hmm so with that am I still missing the obvious way to change the name of every page where it shows in-game as that page?
Edit: Found another way without naming pages.
-
View User Profile
-
Send Message
Posted Dec 31, 2011@ace1177
Remember, you can only use %page% in those 3 messages. noPagePermission, pageNotFound, pageTitle.
-
View User Profile
-
Send Message
Posted Dec 31, 2011I dont get how the %page% works as I try it and it does nothing.