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
can you also add something like when a character reaches a certain level he/she receives a book that would be a great asset to this plugin ^^
@jbanto
& characters dont work with books.
This plugin works fine on 1.4.2. Thanks :D
@xATon2x
Try using '&' in place of '§', if you're using a web based server console like multicraft for your FTP, use filezilla or another seperate FTP client instead and edit the config with a flat text editor like notepad or notepad++
@mstiles92
http://pastebin.com/ZtP0dLey It replaces all § with ? in the bookrules config.
@xATon2x
Could you send me a pastebin of your books.yml before the § characters get replaced? (you can PM it if you don't want it public). It might help me figure out why it is doing this.
@mstiles92
I am using CB 1.3.2-R2.0. When I save the books they are fine and it works perfectly. But after a server restart or shutdown and startup, the flatfile has replaced all of the § characters with ? characters. This is annoying as the Bookrules will have to be replaced after every startup. And when it isnt replaced people see ? all over the books.
@xATon2x
@kbryantLA24
I have tested it before CB 1.3.1-R2.0 and I am not able to reproduce this. None of the § symbols get replaced, all colors are kept fine. What version of CraftBukkit are you using? Are you using the latest version of the plugin?
@EricPickup
@SolarPrizm
I am considering a way to set names for books instead of using ids. This may be coming in a future update of the plugin. I may also set a way to only give certain books to new players, and allow others to be retrieved on command.
My only suggestion is making it so we can give ;onstart; players only 1 book instead of all
I add colors to the text in my book using the § symbol. I then add it, and I can retrieve it fine. However, the moment I reload the plugin or restart my server, the book gets messed up and the § gets replaced by "?", losing my coloring and messing up my book.
You need to add support for the § symbol! please!
This plugin is absolutely fantastic!
Suggestions:
Great plugin :)
Great plugin, I suggest you add an option to let us change the name of the books, instead of just 1,2,3.. and so on. For example, you could do /rulebook add shop, and then you can tell your users to type /rulebook shop to get it.
@fluffypsyco
Hmm, this plugin doesn't do anything with the books once they are given to players, they are just normal written books. I don't think it would be my plugin causing this. Could it be another plugin doing something to them?
@mstiles92:
The books are turning empty when you logout and back in.
Are you working on fixing this?
Thnx for the update earlier!
Hi, try this: http://dev.bukkit.org/server-mods/authenticator/ It's for plugin developers and it gives a possibility to do things after login.
Thanks :3
@seriosbrad
Right now it uses a built-in function of bukkit that checks to see if there is a world/players/username.dat file created for them. I have been thinking about rewriting it to store who has been given books so all players can receive a copy of the books. Maybe I will even make it possible on a book-by-book basis, so if a new book is made while an old player is offline, they would be given the book the next time they join. I have been looking into this and hope to get it working this way sometime in the near future. For now you can just have them use the /rulebook get command to get the books. I will be adding a give command soon as well.
@Mayhem777
Yes, I actually planned on adding this to the plugin already
Can you add a give commands? to give them to users :)
How does this plugin recognize players that have first joined from old members? I would like to give out the book to everyone that joins from this moment forward. Perhaps your own method of storing usernames? like a seenplayers.yml or something. Besides that, how can I manually send out a book to all current players?