MyHelpPages

This project is abandoned and its default file will likely not work with the most recent version of Minecraft. Whether this project is out of date or its author has marked it as abandoned, this project is no longer maintained.

http://i.imgur.com/aXb50.png


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.

http://i.imgur.com/ex3PP.png


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

  1. Download the latest version here.
  2. Place it in the plugins folder
  3. Restart/reload the server.
  4. The default config.yml and pages.yml files will be created in plugins/MyHelpPages.


Commands and Permissions

CommandDescriptionPermission
/help -reloadReload the config.yml & pages.yml filemyhelppages.reload
/help -listList all pages you have permission formyhelppages.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 Pagehelp-Example-Pagemyhelppages.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

MyHelpPages on GitHub


Tutorials

You might want to look here for a German Tutorial:

Nitrado-Wiki

Minecraft-Server.eu Thread


Comments

Posts Quoted:
Reply
Clear All Quotes

About This Project

  • Project ID
    33662
  • Created
    Nov 9, 2011
  • Last Released File
    Apr 16, 2013
  • Total Downloads
    8,728
  • License

Categories

Members

Recent Files

Bukkit