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
The plugin thinks that the latest version is 1.2.1 so I keep getting update notices even though I am using 1.2.2
There is new plugin for this http:dev.bukkit.org/server-mods/welcomebook/. Its just updated for 1.4.5 and it is extremly light-weighted :)
Broken in 1.4.6
does this plugin give a book EVERY join? or is that a possibility?
I run essentials & bookrules, and new players get both their starter kit as well as their bookrules books.
Hello, I got a little issue, the plugin Bookrules and Essentials don't work together, and In my essentials config you will receive stuff when you join, and the book will disappear. Is this fixable?
Are books created/given by book commands tradable to villagers who accept written books for emeralds?
For some reason, with BookRules, the text get's cut short on pages. This has broken some of our systems, that require the full page of information. It appears this is happening with several other book plugins, after importing them from BookManager. Even the title of the book gets cut off, yet the content of the page is still there in the book config. Example of one page:
Page-18: '^> รยง4Basis of Orderรยง0 <^
รยง48. รยง3Use common sense.
รยง8รยงo- Failure to follow any of our rules can result in consequences ranging
from a simple warning to a permanent ban. Here at Misery Craft we run the MCBans
plugin, and failure to comply with our rules could result in you receiving a
global ban.
รยง8 รยง33-รยง37-รยง34-รยง32-รยง32'
It will cut off a good part of the bottom.
Would it be possible to have a command like /Bookrules give 1 playername
This way i could get console to give books to people when they donate to explain their new commands etc.
I already use this by the way, its very useful..
I love it!
I hope your "new book system" is added soon, would be nice :) Until that time we just gotta have to wait.
Great Plugin, but:
1. Missing, ability to only give one book on first spawn 2. Missing, ability to disable Bookrules announcements 3. Missing, ability to change announcement for /bookrules get 4. Bug/Limitation, only able to set 16 characters in book title
Please add a per-book-permissions feature. I want my staff to have a certain book that I do not want others being able to get. Example rulebooks.get.1
Any updates on the give command? I like the book on first join. But I would also like to know if the give command will work with the Command Block. As admins we can create several books explaining commands per plugin and players would have to go in a "Command Room" with Command Blocks linking to buttons with signs labeling the book name, in which players can pick any title they need information for.
@mstiles92
Make sure that players can't trade the Rulebook with villagers, else it would be a free emerald farm! Thanks for all the work you've done. ;)
@Grolsol
Right now it only gives the books to the players who join the server for the first time ever. If they played before this plugin was added, they won't be given any books. I am working on a new system that will change this though. Soon each player will be tracked by the plugin, and given any books they have not received before. You will be able to even make new books and players will receive them the next time they log in, even if they had been given other books by this plugin before.
@Grolsol
Because they are not new to that world. Try creating a new world and see if it works.
I have Give-Books-On-First-Join: true on but people don't get books, why?
when i use /rulebook reload, it deletes all my books. How to fix?
@deathisepic
Color codes should already work. Just use ยง2 for example.
@xATon2x
How are you adding the books? If you are doing it via the in-game command, it should work perfectly. If you are editing the config.yml, it may be an issue with your text editor.
Suggestion: Color codes.