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
you should allow colors to be in the book.
@TheRygr11
@Abnormal_Zombie
The delay also effects when the books are given, so setting the delay very large like that would prevent the players from receiving the books as well. You can set the welcome message to be empty like so:
However, this will still show [BookRules] (with no other message after it) in the current version of the plugin. This will be changed in the next update of the plugin, which will have a config option to turn the messages on or off.
@Abnormal_Zombie
I would say to set the delay to 99999999999999
How do I disable the welcome message? I do not want it :/
@austin4195
ty. :)
@Eronair
It does work on 1.4.7 R1.0, i have been using it on my server for a while now
Have Fun, Austin
Hello.
Just wanted to hear, if this version is stable on Craftbukkit 1.4.7-R0.1
regards Eronair
Do you think that you could make it so that we can also write it on the config and that we edit a book with /rulebook edit maybe and add color codes through the a config and through the game i think that this could be a great idea even if you don't add all of them what i would really like is that we could make book through a config and edit them and add all the color codes. if you do add the /rulebook edit command can you add a permission node? for example: "rulebook.edit" Also maybe you could add like a newspaper sort of thing for example if we could add books and maybe we could add a currency to books which would be used through all currency plugins like Fe,Iconomy, ect.
@zedadiaswick
Yes, I planned on making an option that would block trading the books created by this plugin. This seems like a better option to me than just limiting the amount of books they can receive. Glad you like it :)
@kahlilnc
Is there a problem with color codes? They should work fine, you just have to use the § symbol, just like you would with the vanilla game.
Color codes? :D
There is an exploit involving this plugin where players can use '/rulebook get' to acquire written books, then trade them with villagers for emeralds (essentially for free). Could the command have a timer applied to it, to only allow each book to be spawned once every X seconds? A check against them having the books already in their inventory would also be good.
Otherwise, this plugin is really great. Giving players rule/guide books in place of signs works wonders. Truly appreciated on my server. Thank you for making it ^_^
@berryboy98
The newest version of the plugin is already available on here to download. Version 1.2.2 is the latest version.
@Soledge777
If you use the /bookrules reload command after making changes to the books file, it should pull those changes in to the plugin. If it doesn't, let me know and I will fix it. As for the second part, what exactly are you asking? Sounds like you would like permission nodes for each book? If so, that is something I plan on adding in the future as well. Glad you enjoy the plugin!
If found that its impossible for me to edit a book which is already written and imported even though i have the option in the books file. this feature would be nice to expand on so that i can edit the starters book when necessary.
Im also planning on using this plugin to give ingame rulebooks to other types of members like mods and admins and donors which have custom special abilities with certain limitations.
If you could expand bookrules to incorporate these that would be awesome.
For now im going to put the /rulebook get 1 command into my shopping system on my website for any rank people buy. this way i can automate the system for my donors.
Automation is key! thanks for this gem. it will help a lot.
@mstiles92
Hello im making a video tut on the newest version of this i would ask if you would put it up on here
@deleted_8579151
Right now, books are only given to players who have never joined your server before. This is temporary, and I will be changing it to track each book individually, so players will receive a copy of every book regardless of when they first join the server. For now you can just ask them to use the command /rulebook get 1
How i am making someone get a book in the first log in ? The book ID is 1
@AtreyuMarcs
Should be able to get it from here in the meantime: http:dev.bukkit.org/server-mods/bookrules/files/6-v1-2-2/
Any chance of getting a mediafire or dropbox link to the 1.2.2 jar while we wait on Bukkit to do their thing?
@Rat_Cat12
Yes, it goes off of the latest approved version of the plugin. It will be fixed as soon as the 1.2.2 file is approved here on BukkitDev.
Thanks for the update.
Does anyone here know some good html code that could generate bookrules formatted books?
I'd love to see a WYSIWYG web interface with proper formatting and paginating. Not sure how impossibru that would be to create.
I'm thinking something similar http:yaml-online-parser.appspot.com/.