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 23, 2021This is awesome. Looking forward to trying to get this working on my 1.6.4 tekkit server :D thanks for the old plugin man :D
-
View User Profile
-
Send Message
Posted Jun 14, 2017If anyone is still using this plugin then you can build your own 1.12 compatible version over here: https://github.com/sorifiend/MyHelpPages
Or to just download the latest 1.12 compatible jar see here:
https://github.com/sorifiend/MyHelpPages/tree/master/compiled-jar
I have put in a pull request with the original code base, so use that if its newer:
https://github.com/Mtihc/MyHelpPages
-
View User Profile
-
Send Message
Posted Dec 1, 2015Great job! I love it that it doesn't override the /? command!
-
View User Profile
-
Send Message
Posted Dec 1, 2015Great!
-
View User Profile
-
Send Message
Posted Apr 22, 2015Can you code it to use basic unicode characters next please?
-
View User Profile
-
Send Message
Posted Jul 19, 2014@ConnectCraft
My mistake... we can already use %bold% %underline% %italic% %reset%
-
View User Profile
-
Send Message
Posted Mar 18, 2014Yeah it still works perfectly for me with all the latest Spigot builds to
-
View User Profile
-
Send Message
Posted Mar 3, 2014@Meta_Cz
this should actually still work, it's not really dependant of anything which will change often, so just give it a try :)
@lANTHONYl
I'm currently out of time, since my degree is coming up soon, but i might add that after I am not longer in school :)
-
View User Profile
-
Send Message
Posted Feb 13, 2014Hello This plugin looks really god, but are you going to update it for MC 1.7.x or are we supposed to find another plugin?
-
View User Profile
-
Send Message
Posted Jan 11, 2014I have the same exact files on 3 different servers. On one server, everything works perfectly fine. On the other 2, derp derp derp. I'm sure it has something to do with my use of the ยง symbol to get bold, underline, reset, etc. text. Can you add the ability to have %bold% and all the other chat formatting things so we don't need to use the ยง symbol?
-
View User Profile
-
Send Message
Posted Aug 23, 2013can you aliase "/?"??
-
View User Profile
-
Send Message
Posted Jul 24, 2013heh, MyHellAges
-
View User Profile
-
Send Message
Posted Jul 17, 2013I'm receiving this error on a line when I try to load the plugin: this is from my pages.yml
found character '%' that cannot start any token
in "<unicode string>", line 94, column 6:
- '%yellow%======================= ...
^
This looks exactly like the example config to me... so what's wrong with it?
-
View User Profile
-
Send Message
Posted Jul 16, 2013Make so /? is same as /help
-
View User Profile
-
Send Message
Posted Apr 25, 2013@lANTHONYl
i was just looking though the code again (to try the <perm>.* thing) and thought, since our server updated to 1.5.1 and i got this project open, why not export it, and use the newer version
after a day i thought
if i am able to access it, why doesn't everyone else should be able to :) / yeah, it was kind of unnecessary, i think the next update will follow when something breaks
-
View User Profile
-
Send Message
Posted Apr 16, 2013@ConnectCraft
Most of the plugins by Mtihc are fantastic! I don't really see a web form being needed... Might just be a waste of time imo. My pages.yml file is 3000 lines, i've had no issues except that sometimes it complains about special characters in yaml... but that's due to me extracting backups from a zip file. The ยง character seems to get derped if i have to restore from a backup.
Also, why the need to push an update? There isn't any NMS/OBC code so it works regardless of mc version. Did you change anything else, or did something change in the bukkit API that requires a version update?
-
View User Profile
-
Send Message
Posted Apr 5, 2013@lANTHONYl
nice to see that you're satisfied with my* plugin! :)
i am thinking of making a webform to speed up writing those helppages, what do you think?
but i might look into the <node>.* thing
edit:
-
View User Profile
-
Send Message
Posted Apr 2, 2013@ConnectCraft
Late reply... It's no worries really, i've just allowed all help pages to all players. I don't have any staff specific pages in there, although i might at some point so i suppose i could negate the individual pages as needed. Having a comprehensive help system is great, if you are willing to spend the time writing everything out... My pages.yml file is 100KB and growing.
-
View User Profile
-
Send Message
Posted Mar 3, 2013@lANTHONYl
could you show me a part of your setup?
-
View User Profile
-
Send Message
Posted Feb 14, 2013I've broken up the rules into their own pages. Am i able to give myhelppages.help-rules.*, or do i need to give each one individually?