[INACTIVE][GEN] HelpPages 1.4 [612] Custom index and sub /help pages

Download


Overview:
This plugin overrides the /help command to allow a two tiered /help file that is fully customizable from a help.txt file.

If a user types "/help" they will see something like the following:



and then if they used "/help server" they would see this:



Usage:

The help.txt file is laid out like follows:

Code:

[Server, <Page> - Server Commands]
/help, <Page> - Shows a list of commands. 7 per page.
/playerlist
/kit, [Kit] - Gives a kit. To get a list of kits type /kit
/motd, - Displays the MOTD

#add an extra text line and blank line to help page
[;Some extra help text]
[;]

[Position, <Page> - Commands for movement:mods]
;Commands for movement:
/spawn, - Teleports you to spawn
/home, - Teleports you home
/sethome, - Sets your home
/listwarps, - Gives a list of available warps
/warp, [Warp] - Warps to the specified warp.
/getpos, - Displays your current position.
/compass, - Gives you a compass reading.

Define your own help message by using the format:
/command, your help message

Lines that start with the ; character will just be added as plain text without checking for a command. This can also be used to add blank lines.


In the config above the page server will be visible to the default user group and the page position will be visible to the group mods. More than one group can be added by separating the group names with a comma like so: vip,mods,admins


Installation

Copy the HelpPages.jar to the plugins directory reload your plugins. It will create all the needed files the first time it runs. You can then edit your plugins/HelpPages/help.txt file to suit your server.

Version History
v1.4

• Works on RB612 and with Permissions and GroupManager

v1.2

• Fixed GroupManager connections. Now supports Permissions 2.5 as well.

v1.1

• GroupManager integration added (optional)

v1.0

• Updated for craftbukkit 450 (Minecraft 1.3)
• Using newest onCommand and plugin constructors
• No feature changes, but required for craftbukkit compatibility.

v0.9

• Initial port from hMod
• Removed implementation of groups and permissions

v0.9.1

• Fixed major bug. If you have downloaded the original version this is a required update or all of your other plugins will stop responding to player commands.

 

I am currently using 1.4 with CB 612 and I'm still experiencing the same problems as before. However, this time I was forced to update to 1.4 since CB 612 did not support 1.2.

Regular users can't see the help pages even if I add the group Default to it. I can see it perfectly fine as an admin (If I add the group to the helppages). I have tried renaming the group Default to something else and changing it in the helppages accordingly but to no avail.

 

Myrrdin
I have the same

 

Please help us

 

Admin here of my server have tried every template of a helpfile posted here including the one by jonbas. It doesn't matter what command i type, /help, /help1, /help server, /help Server, /help Position, /help position, all of these yield the same results either:
"An internal error occurred while attempting to perform this command"
or the oh so explanatory:
"Available help categories (Page 1 of 1)"
"Usage: /help [category] <page> - []required <> optional"

Craftbukkit Version: 617
HelpPages Version: 1.4 [clean install]
Permissions Version: 2.5.5 [clean install and setup]

HELP.TXT

Code:

[Server, <Page> - Server Commands]
;/help, <Page> - Shows a list of commands. 7 per page.
;/playerlist
;/kit, [Kit] - Gives a kit. To get a list of kits type /kit
;/motd, - Displays the MOTD

#add an extra text line and blank line to help page
[;Some extra help text]
[;]

[Position, <Page> - Commands for movement:mods]
;Commands for movement:
/spawn, - Teleports you to spawn
/home, - Teleports you home
/sethome, - Sets your home
/listwarps, - Gives a list of available warps
/warp, [Warp] - Warps to the specified warp.
/getpos, - Displays your current position.
/compass, - Gives you a compass reading.

I really like the idea of this mod but atm the command system rather than just typing /help to get the first menu is in my opinion a very bad choice of syntax. /help should bring up the initial menu to tell you what other /help <category> exist as this is what 99% of users expect to see in game. I am definately not trying to tell you how to do your plug-ins just an opinion and suggestion from my ball park. At this point in time I would just be happy to get this working to have some form of customizable help on my server again.

Thank you for your time.

JD

 

I serious need some help. In my help.txt are it writen like this:
[Server, <Page> - Server Commands] /help, <Page> - Shows a list of commands. 7 per page. /playerlist /kit, [Kit] - Gives a kit. To get a list of kits type /kit /motd, - Displays the MOTD #add an extra text line and blank line to help page [;Some extra help text] [;] [Position, <Page> - Commands for movement:mods] ;Commands for movement: /spawn, - Teleports you to spawn /home, - Teleports you home /sethome, - Sets your home /listwarps, - Gives a list of available warps /warp, [Warp] - Warps to the specified warp. /getpos, - Displays your current position. /compass, - Gives you a compass reading.

But when I type /help do there only comes:
Available help categoris (Page 1 of 1):
Usage: /help [category] <page> - [] required << optional
Some extra help text

That is the only thing there are writen please help!

 

Even thou users will automatically be added to the default group in Permissions, HelpPages only reads what is actually saved in the permissions.yml file. This means that a user would have to be manually added to the default group for HelpPages to recognize them. The only way to allow access to users that have not been manually added is to clear the groups from the category.

I believe what you're trying to say here is actually exactly how this plug-in works. Also I think your problem exists in your use for groups and your help.txt file. You yourself are either not in a group at all and are added as and OP or you are in the the group admin which isn't listed in your help.txt at all.

You are also having the same issue. There are two major issues to considder when setting this plug-in up.

1. Permissions group inheritace doesn't work.
2. Default users need to be manually added to the Permissions configuration for HelpPages to recognize them.

 

It is a bug in the plugin all with my permissions work

 

@Jonbas Isn't there some way to use the help that is built-in to each plugin to grab the descriptions instead of having to manually enter in every single one? I'd love to be able to just make lists of commands for each page and not waste time putting int descriptions that are already entered somewhere...

Every page entry needs to start with [; . I.E., you see [;Some extra help text] and [;], and those are what show up, whereas you have [Server, [Kit] (which shouldn't be there), [Position, [Warp] (which also shouldn't be there). None of those have ; in the beginning. Make them instead
[;Server , [;Position
And get rid of [Kit] and [Warp].

@Jonbas I also am getting the "Internal error occurred" message whenever I try to make it give me a sub-page (when I type /help server, for example, and I have a server page, it's listed when I type /help).

EDIT by Moderator: merged posts, please use the edit button instead of double posting.

 

The same thing happens to me.

Also, I realized another way to show the help commands right when you type /help
This does work pretty well if you don't have a lot of commands because with this method you can't have multiple pages, it will just be a long list.

Just make your commands like this instead of the pages.

Code:

[;/motd - Displays MOTD again]
[;/spawn - Teleports you to spawn]
[;/sethome - Sets your home]
[;/home - Teleports you to your home]

 

so in my testings, i have found that this isn't working, at least with 670....?

 

Aeros comment just made me think of a simple idea that might be crude but will actually enable users to enable help the way alot of people are trying to do.

Instead of making the categories per group permissions, you make the help itself per group. This way you can just write out your help file for admins then exclude commands as you work your way down to a default group.

Using this method will allow admins to write their help files per group as a short stop between the plug-in actually recognizing what permissions users have.

 

Can you please fix the permissions issue, where a player HAS to be in a group to show the help pages. It's annoying (as I have to restart the server in order to make a player be able to see it), I rather have a 'helppages.*' key in my permisisons file to allow a player to see everything, rather than managing it from the help.txt.

 

this doesn't work with "Default Command" plugin T_T

 

there must be a Bug with Permission hook i installed first HelpPages and tested it all works fine, then installed Permissions (2.5.5) and then i only see this:

as Help pages but my help.txt looks like this

so pls fix the permissions add

EDIT:
tested again, when i change

to

i can see the Positions site, but i cant see the Server page there is no problem with permission just problem with your check if there are a ":".

EDIT 2:

found your mistake, u set the default group to

pls make it able to set the default group in the properties then it have to work
EDIT 3:
i have made a little tool to create easy the Help.txt without to know how the syntax is.
download here: http://ul.to/kvjrkupv
Greetings
Helfull

 

I already tried that before, that's not really a solution. Every single time someone gets added to the whitelist we'd need to add them to the group as well. I have also tried with no group in the category and it doesn't work then either.

 

Nothing against @Jonbas but I've moved over to mcDocs.

 

Can you add to the post the permission commands?
And you say it is compatible with permissions, can I set different help pages for different groups?

Cranky

 

I'm putting this on the back-burner for now and goin over to try out mcDocs until Jonbas can get the issues sorted out on this.

 

Please update to latest RB for releases.

 

please update his plugin

 

I really want this, please update.