logo

ExtendedCustomHelp 1.0.2 Released

THIS IS CustomHelp Plugin

1.8.x , 1.7.x Spigot, CraftBukkit Supported !!

1.6.x, 1.5.x Not tested

My English grammar is bad. Please ask a favour. :(

If you found a bug, Please leave a comment below. :)

What is this?

though previously I've implemented a Help page for VariableTriggers to replace the Help page, I have a complaint against that too and inconvenience, the process slows down. So, I cannot help towarding the line of sight to existed Help Page. I have been considering about the existing problems in the Help Command. therefore, I created a problem to improve the plugin. There are many plugins associated with the Help Command. However, it is inevitable that they lack help functionality. This plugin is granted details page, Permission, Variable substitution on Help Command.

If you think your server lack the functionality of existing Help command, Try using THIS!

As a conclusion, ExtendedCustomhelp improved Help functionality. In orher words, this feature has been extended.

Update?

• Add message method "Reload-Not-Permission" in config.yml

• Automatically update config.yml

• Permission bug fixed

How can I use?

Please refer to the following topics.

Major existing plugin problem

* Cannot granted to permission each of page

* Unsupported detailed page

* When Server load an XML file, saved ANSI letter broken

Help Setting

If you run this plugin at first time, There are two files.

* config.yml

* Help.yml

config.yml : There are few features of this file, But You can modified using message showing in the game when there is a problem with the Help command or page.

Help.yml : When you enter the Help Command, which is responsible for guiding the message file.

Commands

* /help: Help commands.

* /ehelp : Help commands.

* /help <Method> [Children] : Help commands.

* /helpreload : reload help.yml.

Permissions

* exendedcustomhelp.* : Permission to view all pages.

* exendedcustomhelp.<Method>.* : Permission to view <Method> pages and include children page.

* extendedcustomhelp.<Method>.<Children> : Permission to view <Method> pages and include <Children> page.

* exendedcustomhelp.reload : reload the help.yml.

SUPPORT

* Coloured Text

If you want to coloured text, just use the Formatting codes shown on the Minecraft Wiki:

http://www.minecraftwiki.net/wiki/Formatting_codes

* Variable

When you insert the variables described in the following sentence, it is replaced by a particular value.

%player% : Player name

This plugon is an early version. It does support only one variable. However, I will increase every time develop.

If you know a good idea, Please leave a comment. A small care of yours will be a big support for me. :)

Yaml Explanation

The contents of the following sample. If you know Help.yml, Refer to this.

Important! When Help.xml file syntax is incorrect, the plugin does not work!

config.yml Example

# ExtendedCustomHelp main configuration

# %page% : get page name

# %permission% : get permission name

Config-Version: 2
# Don't touch. This is the method used to check for updates.

Help-Not-Found: "&cThe page %page% not found. try other page."
# The message output when you can not find the page.

Not-Permission: "&cThe page %page% access deined. %permission%"
# The message output when you have not %page% permission.

Reload-Complete: "&3ExtendedCustomHelp Reload Complete."
# The message output when a reload and complete.

Reload-Not-Permission: "&cYou cannot access to reload this plugin."
# The message output when you have not reload permission.

Help.yml Example

#How to run command : /help <Methods> [Children]

# Main page is required. do not delete this method.

# %player% : Player name

Main:

  Text:

    - 'Hello minecraft!'

    - 'your name is %player%'

    - 'Need Help? Use command /help'

Children:

  Survival: # /help Survival

    Need-Permission: true

    # In other words, The player need permission, 'ExtendedCustomHelp.Survival'

    Text:

    - 'Survival Page'

    - '&aColor format supported'

    Children:

      info: # /help Survival info

        Need-Permission: true

        Text:

        - 'Detailed Creative Help Page'

        - '&eThanks for use my plugin!'

      info2:

        Need-Permission: true

        Text:

        - 'This page name is info2.'

        - 'Finished :)'

  Creative:

    Need-Permission: true

    Text: # /help Creative

    - 'Creative Main Page'

    - '&bThank you!'

    Children:

      more: # /help Creative more

        Need-Permission: true

         # In other words, The player need permission, 'ExtendedCustomHelp.Creative.more'

        Text:

        - 'Detailed Creative Help Page'

        - '&bThanks for use my plugin!'