Inactive [INFO] HelpPages 1.30 - Group-Specific Custom Help Pages [1337]

Discussion in 'Inactive/Unsupported Plugins' started by ToastedJelly, May 23, 2011.

  1. Offline



    Version: v1.30
    CB Builds Tested: 1337,1060, 1000, 953, 935, 928, 860, 818, 803, 798, 766

    Download: Current Version 1.30 - older: V1.21 v1.20 v1.10, v1.00
    Completely customizable Group-Specific Help Pages. Permissions supported, but works without it. Powerful System to define what is shown depending on group and parameter after /help. Unrestricted: /help can be different from /help 1, pageable named help topics like /help warps, /help warps 2 or even /help 42 without having to define /help 41.
    It's recommended to conform to known standards for the normal help pages, but you can additionaly add easter eggs or store clues for treasure hunts etc.

    • Simple configuration - No YML madness
    • Automatic configuration reload on change
    • Permissions: Group-Specific Help Pages
    • Supported Permission systems: Permissions 2/3, PermissionsEx, GroupManager, Op
    • Reuse of Help Pages for different groups
    • Numbered or Named Help Pages or a Mix
    • Unlimited Number of Pages and Lines per Page (max 10 recommended)
    • Standard Color Codes
    • Color preserving word-wrapping
    • Mutlilanguage Support - Every Message can be customized
    • Custom Group-Specific Variables
    • Testmode to check Help Pages for other Groups
    • Works in-game and in the Console.
    • Creates a list of all Commands and Descriptions on first Start for easy Copy'n'Paste
    • Updateable by CraftBukkitUpToDate
    How to Install:
    1. Download HelpPages.jar from the above Link.
    2. Put it in your plugins folder.
    3. Run the plugin at least once to create the HelpPages directory
    4. Customize HelpPages/config.txt and that's it. No need to reload the plugin. Configuration changes are automatically reloaded.
    5. To integrate this with other plugins that have a /help command like essentials, open the jar file of the other plugin with something like 7zip, extract the plugins.yml, edit it with a text editor and remove the lines defining the help command - i.e. the line "help:" and the following indented lines starting with "description", "usage" etc. Then add the customized plugins.yml back to the jar file.
    Permissions are optional. If you don't use Permissions or the Command sender is not a Player (Console), Op-status is checked instead:​
    • HelpPages.setgroup - Allows you to view other groups Help Pages for testing purposes.
    • /help <page_selector> - Shows the selected Page. The page_selector is optional and can be something simple like 1 or something more complex like wolf 2
    • /help <page_selector> @ groupname - Shows help for different groups - needs Permission
    Basic Configuration (open)

    • Define your Pages and name them. The name is arbitrary, but has to be unique. Example:
      [[page Page1
                          	&4---------------- &fSHAFT&7LANDS &4/help 1&c/2 &4----------------
                          	Lock your chests, furnaces and doors by putting &6[private]
                          	signs next to them - for more Options see &3Lockette &fPlugin!
                          	Chat-Colors: &0&&0&1&&1&2&&2&3&&3&4&&4&5&&5&6&&6&7&&7&8&&8&9&&9&a&&a&b&&b&c&&c&d&&d&e&&e&f&&f
                          	&c/help &7#  &f-  Views help page &7#
                          	&c/m  &f-  Sends a private message to the specified player
                          	&c/r  &f-  Reply to the last player you communicated with
                          	&c/me  &f-  Allows you to emote
                          [[page Page2
                          	&4---------------- &fSHAFT&7LANDS &4/help 2&c/2 &4----------------
                          	&c/who  &f-  Lists the players online and how many slots are left
                          	&c/spawn  &f-  Teleports you to the global spawn
                          	&c/home help  &f-  Shows home related help
                          	&c/warp help  &f-  Shows warp related help
                          	&c/kit  &f-  Obtains the specified kit or views all available kits
                          	&c/ping  &f-  Pong! (Check server response time)
                          	&c/getpos  &f-  Displays your current coordinates
                          	&c/back  &f-  Transports you back to your last deathpoint
    • As you see, you can use the Standard Color Codes:
    • The Order in which the Pages are defined is not important. They are referenced by their name.
    • Then you define which group sees which page depending on the selector
      [[group Administrators,Moderators,(OP)
                          [[group *
    • The Order in which you define those group blocks is important, because the first one that matches your User is used. As you see, Administrators, Moderators (if you use Permissions) and Ops are getting APage1-6 - which I didn't show in the Page definition above and all Users that don't match any of those Groups, fall through and match on * and they get Page1 and Page2. It is recommended to set it up as above - having the empty selector pointing to the same page as the 1 selector, as that's how User expects it to be. You can of course deviate from this, if you know what you're doing.
    • Special groups are (OP) for Ops and Console, (USER) for non-Ops in case you don't have Permissions and * which matches Every User and should be used last as a catch-all, so Everyone gets some Help Pages.
    • Another Example: Setting up the topic Mining with two pages and Monsters with one page.
      [[group Whatever
                           mining    => miningPage1
                           mining 1  => miningPage1
                           mining 2  => miningPage2
                           monster   => monsterPage
                           monster 1 => monsterPage
      • Selectors and Page names are case-insensitiv and additional spaces can be used for formatting purposes and are ignored.
      • Test mode Example: /help Creepers 2 @ SemiOps would show what SemiOps would see, if they would type /help Creepers 2 - given you have the permission to set the group - it's ignored otherwise.
    Advanced Configuration: Variables (open)

    • Default Variables available:
      • {name}, {displayname}
      • {group}
      • {world}
      • {health}
      • {pos} and {pos.x}, {pos.y}, {pos.z}
    • Custom Variables Example:
                         [[group Administrators,Moderators,(OP)
                         [[group *
                         [[page Page1
                         Hello {title} {displayname}
    • Using Custom Variables to reuse Pages at different Positions
                        [[group Administrators,Moderators,(OP)
                          pageCount = 3
                          basicPageNum = 2
                        [[group *
                          pageCount = 1
                          basicPageNum = 1
                        [[page AdminCmds
                        -------- Page 1/3 --------
                        [[page BasicCmds
                        -------- Page {basicPageNum}/{pageCount} --------
    • Another extensive Example is available here:

    Your turn:
    Do you have any suggestions on features you would like to have or did you find a Bug? Post a reply below! Please use a services like for Exceptions and complete Configuration files. I would also like to hear success stories or unusual use cases.​
    Finally if you like this plugin and would like to express your appreciation monetarily, feel free to​

    • Version 1.30 2011-06-16
      • Tested Builds: 860, 928, 935, 953, 1000, 1060,1337
      • Permissions plugin support added for: Permissions 2/3, PermissionsEx, GroupManager
      • Bugfix: Customized Messages not loaded from configuration file.
    • Version 1.21 2011-06-01
      • Tested Builds: 818, 860
      • Bugfix: Bug introduced with v1.20: default config files isn't created. (Thanks WayGroovy, Azelote)
    • Version 1.20 2011-05-30
      • Tested Builds: 803, 818
      • Automatic reload of changed configuration file
      • removed /hp_reload and corresponding permission node
    • Version 1.10 2011-05-26
      • Tested Builds: 803
      • Color preserving word-wrapping added
      • Variables added
    • Version 1.00 2011-05-23
      • Tested Builds: 766, 798, 803
      • Initial Release
    aidancbrady and zipron like this.
  2. Offline


    This is HUGE. Thanks for the update. I need / love this help system. I have at least 3 hours in setting up the menu structure with the command each group can use, and helpful tips when using them. I was getting ready to try to find someone else to port this. Thank you ToastedJelly I will wait with patient anticipation.
    KJanar likes this.
  3. Offline


    champion ;-)
  4. Offline


    Aren't all bukkit plugins open source?
  5. Offline


  6. Offline


    Dont work? :S

    14.03 21:25:01 [Server] INFO... 12 more
    14.03 21:25:01 [Server] INFOat org.bukkit.command.PluginCommand.execute(
    14.03 21:25:01 [Server] INFOat me.ToastedJelly.HelpPages.HelpPagesPlugin.onCommand(
    14.03 21:25:01 [Server] INFOat me.ToastedJelly.HelpPages.HelpPagesPlugin.cmdHelp(
    14.03 21:25:01 [Server] INFOat me.ToastedJelly.HelpPages.HelpPagesConfiguration.load(
    14.03 21:25:01 [Server] INFOat me.ToastedJelly.HelpPages.HelpPagesConfiguration.parse(
    14.03 21:25:01 [Server] INFOat me.ToastedJelly.HelpPages.HelpPagesConfiguration.augmentColors(
    14.03 21:25:01 [Server] INFO Caused by: java.lang.NoSuchMethodError: org.bukkit.ChatColor.getByCode(I)Lorg/bukkit/ChatColor;
    14.03 21:25:01 [Server] INFOat
    14.03 21:25:01 [Server] INFOat
    14.03 21:25:01 [Server] INFOat net.minecraft.server.MinecraftServer.w(
    14.03 21:25:01 [Server] INFOat net.minecraft.server.NetworkListenThread.a(
    14.03 21:25:01 [Server] INFOat net.minecraft.server.NetServerHandler.a(
    14.03 21:25:01 [Server] INFOat net.minecraft.server.NetworkManager.b(
    14.03 21:25:01 [Server] INFOat net.minecraft.server.Packet3Chat.handle(
    14.03 21:25:01 [Server] INFOat net.minecraft.server.NetServerHandler.a(
    14.03 21:25:01 [Server] INFOat
    14.03 21:25:01 [Server] INFOat net.minecraft.server.NetServerHandler.handleCommand(
    14.03 21:25:01 [Server] INFOat org.bukkit.craftbukkit.CraftServer.dispatchCommand(
    14.03 21:25:01 [Server] INFOat org.bukkit.command.SimpleCommandMap.dispatch(
    14.03 21:25:01 [Server] INFOat org.bukkit.command.PluginCommand.execute(
    14.03 21:25:01 [Server] INFO org.bukkit.command.CommandException: Unhandled exception executing command 'help' in plugin HelpPages v1.3
    14.03 21:25:01 [Server] INFO >
  7. Offline


    No. Not CB 1.2.3 ready yet
  8. Offline


    Can you please update. Pretty Please:)
  9. Offline


  10. Offline


    Everyone does. :(
  11. Offline


    2 weeks are gone :(
  12. Offline


  13. Offline


    Hey, I hope you will be active soon and get HelpPages CB 1.2.4 ready. We could really need the plugin :D
    Objit likes this.
  14. Offline


    I know I need it to really badly. I have been waiting a long time for it
  15. Offline


    Have you made any progress HelpPages master? Because just testing MCDocs and damn how it sucks :D It has so many little annoying bugs. HelpPages is hardcore manual helppage where you can manipulate everything :D CAN I HAZ HELPPAGE?????????? :D
  16. Offline


    Does this work with 1.2.5?
  17. Offline


    Is the update coming out soon? Please :D
  18. Offline


    Good Day

    Would it be possible to add a switch in the console that allows the creation of a simple text file with all the possible commands from all the active plugins?

    This file could be created similar to the config file and in the same directory.

    As we add plugins to our servers it gets a bit tricky to keep track of all the possible commands and switches. Since these are listed in each of the plugins, having access to this info via one text file would really help.

    Just a hope :-P

    Sorry if it has been asked before.

  19. Offline


    That's actually a good idea since it creates the easy copy/paste commands once on first start up.

    Thumbs up
  20. Offline


    Im half temped to re write this plugin myself

    Alot of ppl are after an updated version as am I.

    lorindellia likes this.
  21. Offline


    ToastedJelly If you do not have time to update the version of the plugin we walk. java and who knows if they do update it alone
    lorindellia likes this.
  22. Offline


    Hi there,
    I am new to server ownership and am having a hard time understanding how I get the user ranks and their abilities set up. I installed permissionsex but i don't see any place where I can define the ranks, and I don't see a list of possible abilities.

    Since I am so new to this whole thing, I must admit it is quite the learning curve; my players had been having fun up until I installed permissionsex and now only ops can break blocks etc. So I kinda need to fix this ratehr quick.

    PS //fixwater 10 returns unknow block type error. Got a fix?
    Please help:
  23. Offline


    A follow-up; NO thanks to the Guy at the IRC channel for the PEX plug in who was taudry and rude and even called me a f*moron; I did fix this.

    You have to delete the entire Permissionsex folder and re-install the very latest update to fix this.


  24. Offline


    I accidentally revived this.. if you want to check it out, it's on my plugin page.

Share This Page