UserGuide
About
The help pages say more about your server than you sometimes want. Userguide gives your players a book instead of the usual help. This book is completely customizable so that it fits your server!
Warning: This plugin overrides the original /help command!
If you want the old one back: delete the plugin and its content!
How to use
Commands
- /help
- Gives the Book
- /userguide
- Gives information about the plugin
- /userguide givebook
- Alternative way to give yourself the Book
- /userguide help
- Displays all commands
- /userguide reload
- Reloads the config.yml file
Permissions
userguide.givebook Allow's to use /userguide givebook
userguide.reload Allow's to use /userguide reload
Config
- book-title
- This is the title of your user guide
- book-author
- This is the author of your user guide
- message
- The message being send to the payer when he executes /help
- pages
- This is the content that is in the book. This is working a little bit different than you might think, every line is a new page. You need to experiment a little!
Bug's
You have found a bug? Great! you can report it trough the "Ticket" button on the right side of the page!
Upcoming features
Done! Is going to be in the next update!
Working on
Not yet started on
Tags like %PLAYER%
Ideas and suggestions
Do you have any idea's or suggestions?
Leave them down bellow in the comments!
Source code
The source code will be available again after version 2.1
Review's
Feel free to make one if you have the mood for it :D
[Outdated] Video by TheJadyha:
[Outdated] Video by MrBlackDrag0nfly:
Hello! Help me. I have an error "an internal error occurred while attempting to perform this command" when I enter. '/help" Version minecraft 1.7.2
@Mwguy52
Yes I think I'm going to add that one time. I've experienced that as well, by making the userguide you need to reload a lot.
Sure one thing I want in there
are you going to add a command where the config reloads on a command instad of restarting or reloading the whole server?
@thief001
Great to hear :)
ups,
my bad then sorry.
i dont have any problems i love the plugin.. handing out a short decription (64 pages actually :D ) and some important comands via userguide.. works just great.
just would have been nice if one would get the updated book automaticly when i change something in the config ;)
kinda checking for a creation date and then swap the book in inventory if a newer dated book is out.. something like that i hoped for.
but if everyone would get what he wants, life would be booring, right? ;)
thx anyway for the explanation :)
just got fooled by the admin bypass.
@thief001
By default when operators use /help they get the message(This is because I wanted to later make help accessible for operators). That is why I made the command /userguide-book, so that operators could get the book to check if everything looked good.
Do your players have the permission node userguide.bypass? If so remove it and only give admins/owners the permission.
Keeping the book in sync is unfortunately impossible. Every time you edit the book in the config it's a diffrent item than the previous book
I hope you don't have any problems from now on!
help.
/help dosent work anymore!
(craftbukkit-1.7.2-R0.3-20140202.193358-30 (and bevor)
if i use /help to get a new userguide, i instead get the message:
"a real help is going to be implemented later :( for now you can use /?"
/? gives the default bukkit help texts but no way of getting a userguide this way
without the userguide plugin /help delivers the bukkit help texts.
i always have to use /userguide-book to hand out a copy to the folks.
also, is there a way to keep existing userguides in sync with the config? im using the userguide to deliver a "short" description of plugins/ commands (59 pages...) to anyone, but as things change, i have to handout a new one every now and then. it would be easier, if there would be a way to update all userguides to the latest config on a config/server reload/ restart.
thanks for the work :)
@sha5901
Great to hear that!
@RubenRME
It became work after few days!!
@sha5901
No problem! I wanted to make the plugin supporting the previous versions as we'll Otherwise I just release a 1.6.2 one :P
but does the plugin not work on 1.6.2?
@KORSamsung
Take away the permissions for essentials help and it will work. If you're doing /help as an op or have the essentials help permissions, you're going to see the essentials help. Try doing /help as a regular user after removing the permission nodes.
Sorry, but I need an 1.6.2 version of plugin.
@KORSamsung
Not for me?
The command "/help" crashed with essential's "/help" command. Will you update please?
Is there anyway to make it so that the book open stright away? e.g when i type /help the book opens in your hand, Not just goes into your inventory. That would be a good update.
:D
@TheBusyBiscuit
You helped me a lot! Not just with explaining it but with the way of explaining :D Very clear and nice :D Really thank you so much!
:O hmmm, the Page adding sounds familiar xD .But nice job!