MyHelpPages

Table of Contents

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.

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 and pages.yml files will be created in plugins/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

MyHelpPages on GitHub

Tutorials

You might want to look here for a German Tutorial:

Nitrado-Wiki

Minecraft-Server.eu Thread

Comments

Forge_User_83064763
- Join Date: 9/30/2011
- Posts: 470
- Member Details
#45 Forge_User_83064763

View User Profile

Send Message

Posted Feb 22, 2012
@WayGroovy

Actually I already got it :)

I just havent done it for this plugin yet.

I made this plugin a while back. So I'm a bit ashamed of the code. :P
I might update it one more time, before I put it on github...

Last edited by Forge_User_83064763: Feb 22, 2012

Rollback Post to Revision RollBack
_ForgeUser6834455
- Join Date: 5/19/2011
- Posts: 192
- Member Details
#44 _ForgeUser6834455

View User Profile

Send Message

Posted Feb 22, 2012
github is a pain to learn if you don't have a clue what you're doing... I'm attempting to use it for my project, and not getting very far. I finally got Eclipse pushing to Github after finding some EGit plugin video tutorial on youtube

Rollback Post to Revision RollBack
Psithief_
- Location: Psithief
- Join Date: 10/19/2011
- Posts: 123
- Member Details
#43 Psithief_

View User Profile

Send Message

Posted Feb 13, 2012
@Mtihc

Gasp. The shame.

Rollback Post to Revision RollBack
Forge_User_83064763
- Join Date: 9/30/2011
- Posts: 470
- Member Details
#42 Forge_User_83064763

View User Profile

Send Message

Posted Feb 13, 2012
I wish I knew how github worked.

Why does it have to be so complicated?

Rollback Post to Revision RollBack
_ForgeUser7094515
- Join Date: 6/29/2011
- Posts: 24
- Member Details
#41 _ForgeUser7094515

View User Profile

Send Message

Posted Feb 13, 2012
the last version of the helpage editor (i dont update it annymore)

https://docs.google.com/viewer?a=v&pid=explorer&chrome=true&srcid=0B5IOdFVBhVS5N2Y1OGVmYzktMGZlMC00NzY3LThjZWEtOTljMmVkOTEyZjUw

Rollback Post to Revision RollBack
_ForgeUser7094515
- Join Date: 6/29/2011
- Posts: 24
- Member Details
#40 _ForgeUser7094515

View User Profile

Send Message

Posted Feb 13, 2012
@Mtihc

it's the space before! (see under)

- '%red%Change these lines,'

- '%red%Change these lines,'

@Psithief: just do it?, the YLM ignore the spaces?

Rollback Post to Revision RollBack
_ForgeUser6834455
- Join Date: 5/19/2011
- Posts: 192
- Member Details
#39 _ForgeUser6834455

View User Profile

Send Message

Posted Feb 12, 2012
I used to use MyHelpPages, but it stopped working on me. It was simple, easy to use, easy to configure... I wish you would release source on git. I'd be willing to wager that someone will take up development if you do.

Rollback Post to Revision RollBack
_ForgeUser7499319
- Join Date: 9/4/2011
- Posts: 163
- Member Details
#38 _ForgeUser7499319

View User Profile

Send Message

Posted Feb 12, 2012
@Mtihc

Could you maybe release the source so that someone else might take this up?

Rollback Post to Revision RollBack
Forge_User_83064763
- Join Date: 9/30/2011
- Posts: 470
- Member Details
#37 Forge_User_83064763

View User Profile

Send Message

Posted Feb 11, 2012
@jellewie

I'm afraid I will not be updating this plugin any time soon. If i ever will

Rollback Post to Revision RollBack
Forge_User_83064763
- Join Date: 9/30/2011
- Posts: 470
- Member Details
#36 Forge_User_83064763

View User Profile

Send Message

Posted Feb 11, 2012
@Psithief

Call me crazy, but i dont see the difference

Rollback Post to Revision RollBack
Forge_User_83064763
- Join Date: 9/30/2011
- Posts: 470
- Member Details
#35 Forge_User_83064763

View User Profile

Send Message

Posted Feb 11, 2012
@Psithief

The list is on this page. You just have to look a little better.

Here they are
aqua, black, blue, darkaqua, darkblue, darkgray, darkgreen, darkpurple, darkred, gold, gray, green, lightpurple, red, white, yellow

Rollback Post to Revision RollBack
Psithief_
- Location: Psithief
- Join Date: 10/19/2011
- Posts: 123
- Member Details
#34 Psithief_

View User Profile

Send Message

Posted Feb 11, 2012
There's no list of all the supported colours? Aqua instead of cyan? :( Here's the list I made from trial and error. 0x0 through 0xF

black
darkblue
darkgreen
darkaqua
darkred
darkpurple
gold
gray
darkgray
blue
lightgreen
aqua
red
lightpurple
yellow
white
Last edited by Psithief_: Feb 11, 2012

Rollback Post to Revision RollBack
Psithief_
- Location: Psithief
- Join Date: 10/19/2011
- Posts: 123
- Member Details
#33 Psithief_

View User Profile

Send Message

Posted Feb 11, 2012
I find this really really bizarre.

Why like this:

pages:
  help:
  - '%red%Change these lines,'
  - '%red%in the config file.'
  - '%red%This page comes up when you type /help'
  help-1:
  - '%red%Change these lines,'
  - '%red%in the config file.'
  - '%red%This page comes up when you type /help 1'
  help-2:
  - '%red%Change these lines,'
  - '%red%in the config file.'
  - '%red%This page comes up when you type /help 2'
  help-example:
  - '%red%Change these lines,'
  - '%red%in the config file.'

instead of like this:

pages:
  help:
   - '%red%Change these lines,'
   - '%red%in the config file.'
   - '%red%This page comes up when you type /help'
  help-1:
   - '%red%Change these lines,'
   - '%red%in the config file.'
   - '%red%This page comes up when you type /help 1'
  help-2:
   - '%red%Change these lines,'
   - '%red%in the config file.'
   - '%red%This page comes up when you type /help 2'
  help-example:
   - '%red%Change these lines,'
   - '%red%in the config file.'

The second example makes so much more sense!

Rollback Post to Revision RollBack
_ForgeUser7094515
- Join Date: 6/29/2011
- Posts: 24
- Member Details
#32 _ForgeUser7094515

View User Profile

Send Message

Posted Feb 5, 2012
can you make it posible that you can edit /rules and /plugins on the same whay?

Rollback Post to Revision RollBack
Forge_User_83064763
- Join Date: 9/30/2011
- Posts: 470
- Member Details
#31 Forge_User_83064763

View User Profile

Send Message

Posted Feb 5, 2012
This is also useful: http://yaml-online-parser.appspot.com/

To see if your code has any errors

Rollback Post to Revision RollBack
Forge_User_83064763
- Join Date: 9/30/2011
- Posts: 470
- Member Details
#30 Forge_User_83064763

View User Profile

Send Message

Posted Feb 1, 2012
@jellewie

Nice

Rollback Post to Revision RollBack
_ForgeUser7094515
- Join Date: 6/29/2011
- Posts: 24
- Member Details
#29 _ForgeUser7094515

View User Profile

Send Message

Posted Feb 1, 2012
@Mtihc

All versions of MyHelpPage_Editor: https://docs.google.com/open?id=0B5IOdFVBhVS5MjZlY2IxNmQtNThhYi00YTAwLThiYjYtMWNjZmNhMjhkMzY1

MyHelpPage_Editor_V1.3 https://docs.google.com/open?id=0B5IOdFVBhVS5Yzg4ZDczNTItMDUzYy00NTA3LTg2ZDktODA4OGE4Yzg4ZGZk

Rollback Post to Revision RollBack
_ForgeUser7094515
- Join Date: 6/29/2011
- Posts: 24
- Member Details
#28 _ForgeUser7094515

View User Profile

Send Message

Posted Feb 1, 2012
@Mtihc

see you PM

Rollback Post to Revision RollBack
Forge_User_83064763
- Join Date: 9/30/2011
- Posts: 470
- Member Details
#27 Forge_User_83064763

View User Profile

Send Message

Posted Feb 1, 2012
@jellewie

Oh haha, got it

Rollback Post to Revision RollBack
_ForgeUser7094515
- Join Date: 6/29/2011
- Posts: 24
- Member Details
#26 _ForgeUser7094515

View User Profile

Send Message

Posted Feb 1, 2012
@Mtihc

Probably because i got edit it XD

Rollback Post to Revision RollBack
To post a comment, please login or register a new account.

Project ID

33662
Created

Nov 9, 2011
Last Released File

Apr 16, 2013
Total Downloads

10,165
License

MIT License

Bukkit

MyHelpPages

Bukkit Plugins

MyHelpPages

Table of Contents

Description

Screenshots

Features

How to install

Commands and Permissions

Configuration

Colors

Pages

Custom Messages

Versions

Source code

Tutorials

Comments

About This Project

Categories

Members

Recent Files

Bukkit