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
@NathanTheDragon
Yes, I will be switching it all over to the UUID system soon.
@frol1
Yes, it currently works with color codes using the ยง character like you would use in-game. In a future update, I will include support for using color codes with the & character as well.
As you've probably hear, Mojang changed their Username system to the UUID system. Will you support this?
Thanks, ~ Nathan
P.S. My server uses this, that's why I'm asking XD
do colour codes work?
@winter4w
"Boolean value that determines whether players will automatically be given all books they have not yet received upon logging in to the server."
Short answer: correct, you will only receive EACH book once with the onjoin setting
Is this when they first join the server or when they log in?
@Eiretek
Players have permission to use the info, list, and get commands by default (so servers without a permission plugin can still use it). If you would like to remove this permission from a group, you can add a negative permission node for that permission (usually by adding the permission node with an extra dash in front of it, depends on the permission plugin).
@xxbabygirlstar
Define a book in the book.txt file (which should be inside the essentials folder):
and give the book to players in the kit thusly:
where ActualBookTitle would be something like Book o' Colors (in the previous example), AuthorName would be the person who wrote the book (obviously), lore would be the purple text when you mouse over the item in the game that describes the item, and book refers to the actual name used in the book.txt file.
Remember not to make the lore too long; putting the mouse over an item at the bottom of the screen will cutoff the text.
And, of course, you can use color codes just about everywhere in the above.
@Eiretek
This mod is outdated (it's 1.5.2-R1.0). You can use essentials to give people custom-made books anyway.
No players have permissions for any bookrules commands, yet can still use /rb get. I've triple checked my perm file to confirm. Thoughts? I'm on 1.7.2
@MrMoshi
In reply to this, I have my own question. Can you add it to an essentials kit?
Is there anyway i can make it where they only get the book at spawn when they join the server for the first time? Thanks!
Server 192.99.0.186:25605
Love this plugin, but i have trouble using Swedish characters its only becomes "?" in saved file, how to solve this?
Will gladly donate once i get this solved.
@club727
I LOVE THIS PLUGIN, THE BEST OR MY SERVER !
Feature I'd really like to see: Ability to flag/unflag books in the list that you want new users to receive. For example, I want them to only receive a single main book on first join, but still have others books in the list available upon request.
Everything seems to be working fine except for Give-New-Books-On-Join whether I have it set to true of false, it will still give new players all books I've made.
Any chances to get this updated? I get some errors.
[SEVERE] Could not pass event InventoryClickEvent to BookRules v2.0
could you make rules book keep inventory on death?, maybe restrict drop rule book will be great
@ticotaco
@ebear123
Right now it doesn't, no. I will be adding this as an option in the next release of this plugin. Thanks for the idea!
Will this give a book to players EVERY TIME they login? No one seems to do that :/