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
V1.1 no work for authme and starterkit
new player join game
i see book in my pack
but register done
book Disappear
delay Least need 31sec....
authme is 30sec register fail
Also, every paragraph in my book gets returned to a ? when i reboot my server. It looks like it doens't even recognize the paragraph sign. Can you please fix that?
Having the same error with the 'null' and also constantly giving me a book on join. Not that i don't like that it would give me a new book every join because i know people will lose it, but the 'null' error is just annoying. Also, this is the first plugin that really works: thanks a lot and i love you. :D
Matt, Add Support - http://mcstats.org/ - I want to track your plugin!
@etherz10
@Faffling94
I will look into the [BookRules] null message and why it gives a book on every login. I'm not sure why it would do this off the top of my head, but I will investigate when I get access to my computer.
I will also be adding a configurable time delay to help with AuthMe compatibility.
Expect a new version in the next day or two with these fixes.
(Sorry for multi-post but I got a few things more to say)
1. I don't want my players to be shown this [BookRules] null message! 2. The plugin gives for every single login a new book, I only want my players to get one at the FIRST join! 3. Add a delay (as I already said)
Thanks!
It doesn't work with AuthMe correctly, you have to change the following option in AuthMe:
Would be nice if you could make it compatible with an editable delay-time or something like that.
Me Gusta. I love this plugin.
When I have option to Give-Books-On-First-Join: true it continues to give them a book if they relog and it says [BookRules] null
Running 2340 CB
hey, how about if we could storage these writenbooks in bookshelfs?
Hi, there is a problem with AuthMe, new player get it but when he register, he lost it.
@Zefram
Yeah, that is what I did to make it work with StarterKit. I didn't create a config for it, I just hard-coded the 15 tick delay in. Do you need to be able to change the delay, or is it fine how it works now?
player join game
wait 1min
after give new player book
This can be bypassed StarterKit clear inventory
Give-Books-On-First-Join: true
Verbose: false
CurrentID-DO-NOT-CHANGE: 2
delay: 60
@xalixilax
Isn't that exactly what the /rulebook get <id> command does? They can do /rulebook list to see a list of all the books and their id numbers, then /rulebook get <id> to get whatever book they need. Unless I am misunderstanding what you want?
@Zefram
I will look into making it compatible with StarterKit. When StarterKit gives new players the kit, it clears their inventory first, wiping out any books they may have been given. I have an idea on how to get around that though. What did you mean by Delay sec Options? Did you mean an option to limit how often players can get a book by command?
EDIT: Compatibility with StarterKit solved with v1.1, so go ahead and use that version.
i have install StarterKit
but BookRules no work ....
please add Delay sec Options
thanks
It could be nice if player could make a command like /rulebook give <id>
So even if they are not new, they can get the book via a command or any book. or somthing like /rulebook give <name of the book> It can prevent player for loosing it.
Omg! Just what I need!
download http://dev.bukkit.org/server-mods/bookrules/files/1-v1-0/
I've been waiting for this! Thanks man.
@StefanoPorta
This is not the principle of the plugin?
(Sorry if I speak bad english, I'm french :3)