Features
Automatically give players written books containing rules, getting started guides, etc when they join your server.
Commands
CommandDescription
/bookrules
Show current plugin information.
/bookrules info
Show current plugin information.
/bookrules version
Show current plugin information.
/bookrules commands
Show description of all commands available to the player.
/bookrules reload
Reload data from the config files.
/bookrules get [id | title]
Get book specified by ID or title, or all books if no ID or title is specified.
/bookrules give <player> [id | title]
Give the specified player the book specified by ID or title, or all books if no ID or title is specified.
/bookrules add
Add the currently held book to the plugin.
/bookrules delete <id | title>
Delete the book specified by ID or title from the plugin.
/bookrules list
Show all of the books currently stored by the plugin.
/bookrules setauthor <author>
Change the author of the currently held book.
/bookrules settitle <title>
Change the title of the currently held book.
/bookrules unsign
Unsign the currently held book, changing it back to a book and quill.
Permissions
Permission NodeDescription
bookrules.*
Allow full access to all commands in the plugin.
bookrules.info
Allow use of /bookrules [info | version] to see the plugin information.
bookrules.reload
Allow use of /bookrules reload to reload data from file.
bookrules.receivealerts
Receive alerts when there is an update to the plugin.
bookrules.get
Allow use of /bookrules get to get the books stored by the plugin.
bookrules.give
Allow use of /bookrules give to give books to other players.
bookrules.add
Allow use of /bookrules add to add a new book to be stored by the plugin.
bookrules.delete
Allow use of /bookrules delete to delete a book stored by the plugin.
bookrules.list
Allow use of /bookrules list to list all books stored by the plugin.
bookrules.setauthor
Allow use of /bookrules setauthor to set the author of the currently held book.
bookrules.settitle
Allow use of /bookrules settitle to set the title of the currently held book.
bookrules.unsign
Allow use of /bookrules unsign to unsign written books, changing them back to book and quills.
Configuration
SettingDescription
Verbose
Boolean value that enables/disables logging to the console. (Used for debug)
Seconds-Delay
Integer value that controls the delay of giving books to new players after logging in. (Useful when using other plugins that modify inventories at login, such as StarterKit and AuthMe.
Check-for-Updates
Boolean value that determines whether the plugin will check for updates and send alerts when there is a new version.
Give-New-Books-On-Join
Boolean value that determines whether players will automatically be given all books they have not yet received upon logging in to the server.
Display-Messages
Boolean value that determines whether messages will be sent to players when they receive new books from this plugin.
Block-Villager-Book-Trading
Boolean value that determines whether players will be prevented from trading written books generated by the plugin with villagers.
Give-Books-Every-Join
Boolean value that determines whether players will be given a new copy of all books every time they join the server.
Language
Abbreviation of the language to load the plugin in. See the translations section below for valid abbreviations.
Translations
This plugin contains an extensive localization system, allowing it to be translated into different languages. The following is a list of the currently available languages:
LanguageAbbreviationTranslator
EnglishEN
If you would like to supply a translation to be included in the plugin, please let me know. If you know how, feel free to create a pull request on GitHub with the translation file included. Otherwise, send me a private message and I will get you a list of the messages that need to be translated.
Update Checking
This plugin periodically checks BukkitDev for a new version, and will notify the console and players with the "bookrules.recievealerts" permission of a new version. If you would like to disable this feature, simply set "Check-for-Updates" to false in plugins/BookRules/config.yml.
Stats Collection
Anonymous statistics are collected automatically by this plugin and sent to MCStats. If you would like to view the data, you can do so here. If you would like to disable this feature, set "opt-out" to true in plugins/PluginMetrics/config.yml.
Planned
- Optional groups for books, allowing groups to only be given to players with the correct permission (defined on add command?)
- Multiverse support (possibly, no guarantee)
- Option to let players keep books on death
- Update to UUID system
Support and Feature Requests
If you have found a bug with the plugin, or would like to suggest a feature to be added, please create an issue on Github to make sure I see it. You can do this by clicking either the Tickets link at the top of the BukkitDev page or the Issues link on the Github repo, then click New Issue and provide as much information as possible. The more information you provide, the better I can help you.
Links
BukkitDev Page
GitHub Repository
Twitter
Donations
Donations are by no means required, but would be much appreciated. If you feel that my plugins have been of great use to you and would like to give me a little something in return, this is the way to do it.
Donate
Legal
Licensed under the Common Development and Distribution License Version 1.0 (CDDL-1.0).
For license information, see the LICENSE file, or on the web at http://opensource.org/licenses/CDDL-1.0
To everyone who is having issues with the book file being cleared/just not working, I have finally identified the cause. It is actually an issue with Bukkit and the way it loads the configuration files. Bukkit's built-in configuration loading loads files with the system's default character encoding. Basically, if the encoding of the file does not match the default encoding on the system, the plugin may fail to load the file. This is why people sometimes have issues moving the files from their computer to a host, from host to host, etc.
I know one sure way that it will fail is when using UTF-8 encoding with a BOM (http://en.wikipedia.org/wiki/Byte_order_mark) at the beginning of the file. I will make the plugin check for and strip off any occurrence of a BOM from the files before reading them in the next release of the plugin. I am hoping that this will fix most, if not all of the issues with loading these files. Other than that, there is not much I can do to help fix this, as it is a Bukkit issue. If you are having issues, make sure your system is set to use the same character encoding as the configuration files you are using.
If you would like to read more about the issue, here is a link to the issue: https://bukkit.atlassian.net/browse/BUKKIT-2609
If you would like to check your books file, this is a very handy tool to use as well: http://wiki.ess3.net/yaml/. It will tell you exactly where any errors occur in your configuration.
I understand this is inactive and all but why does this not work??
It won't let me add a book.. it says Rulebook "ahsdoajasd" is not exist? When I'm holding the book.
Please help!
very good plugin!!!
My books file cleared for some reason, and when I stop my server to change this(What it currently is):http://pastebin.com/UGDt7EAa to: http://pastebin.com/PNUuSBac, when I start the server back up it resets to the first one, and I don't know why.
make it so every time a player spwans in they can be given a book regardless if they have been given it before.
For example. a player spawns in on one day, throws away the book, then leaves. The next day they spawn in, I want this player to get the book again
I really can't wait for the Group-Optional books feature. It's going to be so helpful.
I see no reason why this plugin would break under 1.6.1 but I'll ask anyway.. Does it? :P
Nice plugin. This one is a keeper. Keep it up to date please.
Hello,
Is this plugin compatible with multiverse?
I have 2 worlds and I would like for both worlds to have a different rule book of their own when people go in the world.
Thanks.
@Marium0505
Try before you cry. It's running without hassle with CB 1.5.2
Update for 1.5.2, please.
Please fix ä & ö letters they are showed as "?". It makes things looks messy.
Hmm any update on the color bug mstiles92?
im havin the same save problem to please fix it
Great thanks. This plugin is a great help for those new players on my server, and I had to remove it due to this bug. Hope to see it soon fixed mstiles, BookRules is a must have :P
@idrum69
@Absolutionmc
Ahh, ok. I was finally able to duplicate this on a friend's pc. I never had this issue on my own for whatever reason. Will look into a fix ASAP!
The colors are not saved fine. Here's the problem. When I add colors to my book it all looks perfect and as expected, even after using /rulebook add and then /rulebook get to see if the book was saved perfectly. However if you reload the plugin or do a restart, the colors seem to disappear and are replaced with the characters for them.
@idrum69
What exactly do you mean by color support? I keep seeing people ask for this, but I'm not quite sure what you guys want. Colors entered in books will be saved by the plugin just fine. See the wiki here if you need help with that: http://www.minecraftwiki.net/wiki/Book_and_Quill#Special_codes_.28coloring.29
If I'm just totally misunderstanding, let me know more about what you want and I will see what I can do :)