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
It's an okay plugin.. I would use it, however there is no color support. Add that and it's a keeper.
This Plugin Is Kinda annoying i edited the book inside the config i edited it about 4 times and it was fine the first 3 times when i done /bookrules reload it completely deleted the book... not surprised
Anyway you could make it have world specific books, like a player enters a world and they get a book explaining the world or whatever, maybe it could just be a permission that gives them a book that i just give on one world. Just a thought. Great plugin, thanks for your hard work.
@Mike4898
When this error occurred, did you have a books.yml file from an earlier version of the plugin? Or was this a fresh install?
@etherz10
What do you mean by color support? The plugin will save any colors entered in books just fine.
@mstiles92
Well, the whole plugin doesn't work anymore. It only gives internal errors, doesn't matter what command you're using, and doesn't give the books: Here are is the error around the bookrules error (I'm not sure they had something to do with it or not)
11.04 15:28:40 [Server] INFO at net.minecraft.server.v1_5_R2.ThreadServerApplication.run(SourceFile:573) 11.04 15:28:40 [Server] INFO at net.minecraft.server.v1_5_R2.MinecraftServer.run(MinecraftServer.java:407) 11.04 15:28:40 [Server] INFO at net.minecraft.server.v1_5_R2.MinecraftServer.q(MinecraftServer.java:474) 11.04 15:28:40 [Server] INFO at net.minecraft.server.v1_5_R2.DedicatedServer.r(DedicatedServer.java:225) 11.04 15:28:40 [Server] INFO at net.minecraft.server.v1_5_R2.MinecraftServer.r(MinecraftServer.java:510) 11.04 15:28:40 [Server] INFO at org.bukkit.craftbukkit.v1_5_R2.scheduler.CraftScheduler.mainThreadHeartbeat(CraftScheduler.java:345) 11.04 15:28:40 [Server] INFO at org.bukkit.craftbukkit.v1_5_R2.scheduler.CraftTask.run(CraftTask.java:53) 11.04 15:28:40 [Server] INFO at com.mstiles92.bookrules.GiveBookRunnable.run(GiveBookRunnable.java:52) 11.04 15:28:40 [Server] INFO at com.mstiles92.bookrules.BookStorage.getInstance(BookStorage.java:69) 11.04 15:28:40 [Server] INFO at com.mstiles92.bookrules.BookStorage.<init>(BookStorage.java:80) 11.04 15:28:40 [Server] INFO at com.mstiles92.bookrules.BookStorage.loadFromFile(BookStorage.java:122) 11.04 15:28:40 [Server] INFO at com.mstiles92.bookrules.BookStorage.convertFromOldFormat(BookStorage.java:167) 11.04 15:28:40 [Server] INFO java.lang.NullPointerException 11.04 15:28:40 [Server] WARNING Task #7347 for BookRules v2.0 generated an exception
@mstiles92
Can you add colour support?
@Mike4898
What about it doesn't work? What error messages are you getting? If it says invalid configuration, please send me a pastebin of your config.yml, books.yml, and players.yml.
It completely broke after updating, even downgrading doesn't work anymore...
@skillman1428
I have not tried it, but I see no reason why those characters wouldn't work.
@KAJSERCRAFT
Could you make a pastebin of your books.yml and config.yml? Not sure what the problem would be without seeing those.
@NutellaisGod
Thanks! Glad you like it :)
GREAT PLUGIN KEEP IT UPDATED! Now i can give New Players a Rule book! :) LOVE IT!
I can't transfer my books from one server to another, it says config invalid and disables the plugin.
Please help!
Is it posible to use åäö?
You need to add lores. So people can make their own custom lore.
@skookiesprite
For now you can edit the books.yml file in the plugin's data directory. In the next update, you will have the ability to unsign books via a command. So you could get the book, unsign it, edit it to your liking, sign it again, then delete it from the plugin and add the edited one again.
Seems to work great on 1.4.7.r1 for me... and I've been using for a while now. Good job and thanks for the plugin. Only suggestion would be a command to allow the user to edit a previously closed/signed book (because rules change)... even though i don't use this plug to give rulebooks, it would be a nice feature. Is that a difficult function to implement?
Regardless, good job, and thanks so much for your work! Cheers!
@flutter1
Not really sure what you mean by this. Is there a problem with this plugin on 1.4.7? None of the Bukkit API used in this plugin was changed for 1.4.7, and it worked fine for me in all my tests. It should still work on 1.5 when it comes out too, but I will be sure to fix anything that gets broken. Glad you like it!
can we 1.4.7 api ready this? I don't want to lose it when the new update comes out for Minecraft. I love this plugin!
@KSum
I by no means intend to let this die, the currently released version works just fine on 1.4.7.
I have been working on a very thorough update for a while now, just haven't had much free time lately to put into it. Got some nice new features on the way (hopefully soon) :)
@JohnCraft110
Colors should work fine with this plugin if entered correctly. See the wiki page if you need more information about formatting books. If there is an issue caused by this plugin, let me know and I will work to fix it.
Don't let this die, please update for 1.4.7+. It's a great addition to an RPG server.