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:
@Mtihc
Actually, it is my experience that you - the author - can link to any new file you upload (and put that link in the comments). It just won't appear in the file tab until it's approved.
@Psithief
Oh snap! You're right it was for Java 1.7.
I just uploaded 1.4.1... compiled for 1.6.
That should fix the error.
You have to wait until the file is approved, before you can download it.
@Mtihc
Oh dear, what version of Java did you compile this for?
The new version has 0 downloads yet. I guess people moved on since the project was inactive for a while.
@ConnectCraft
Here's the new code
Got rid of the external project for handling commands and configuration.
Now using normal CommandExecutor for commands. And my good old YamlFile class for the configuration file.
Also added some more comments and javadocs.
@Mtihc
Minecraft Book is an app for Android, coming out for iPhone soon ;)
Okay, thanks :3
(may you comment in the src what thingy does what? im new in that coding stuff, even if he helps me)
- At-M
@ConnectCraft
No didn't know either of those plugins. (I don't know much in general haha)
Marionette looks funny, I can't find Minecraft Book.
Anyway, I am willing to update this plugin 1 more time.
So you have some clean code to work with. Because... frankly...
I'm ashamed of the current code.
I'm gonna start working on that now. And see if I can keep that promise.
@Legokid184
im using the newest uploaded version, and it works great!
@Mtihc
ok, because i want to learn java, as another admin from Cc did (you know "Marionette(plugin) " or "Minecraft Book" ? try it out :D) to keep our plugins cool :)
would be nice if you can do that
greetz At-M
Is their an updated version for 1.2.5 or will it work with it?
@ConnectCraft
@Mtihc
I almost forgot. You also need this library to make it work:
https://github.com/Mtihc/BukkitPluginCore
@ConnectCraft
Yes, you can continue this project!
Here's the source code:
https://github.com/Mtihc/MyHelpPages
If you are serious about it. I will make you manager of this page or whatever. And I guess you should just clone the github repository. Or make a new one.
@Mtihc
Please release the source, or atleast email me it: [email protected] I'm gonna continue if thats ok
@Mayhem777
If you found smth, please let me know
searching ofr a replace....
Sorry dudes,
I will not be working on this plugin anymore.
I understand that it's useful. But it's the most boring project ever haha.
And well, I have better things to do.
Bye
Still working on R4? :D
Could you make it, that the comands are not Case Sensitiv?
Hello, can u make this simbols allowed? :
áéíóú ÁÉÍÓÚ ¡¿ ñÑ
Thanks!
I am still alive. And I still have a subscription to this comments section.
Only sometimes I neglect it for a long time.
If it doesn't work anymore. Just leave a message. I will read it eventually :)
@LoveRokenbok
It does still work
Is this plugin still active????