BookRules

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 must login to post a comment. Don't have an account? Register to get one!

  • Avatar of LordKainzo LordKainzo Sep 12, 2014 at 01:50 UTC - 0 likes

    @mstiles92: Go

    Can you post a link to the new DL?

  • Avatar of DuskFireHD DuskFireHD Sep 07, 2014 at 06:20 UTC - 0 likes

    can you please make it so I can edit the lang of the pl

  • Avatar of LordKainzo LordKainzo Aug 25, 2014 at 20:44 UTC - 0 likes

    sounds good, thanks @mstiles92 !

  • Avatar of mstiles92 mstiles92 Aug 24, 2014 at 16:19 UTC - 0 likes

    @LordKainzo: Go

    The command will be case-insensitive in the next release of the plugin. I have fixed that error for the next release as well. Thanks for reporting it.

  • Avatar of mstiles92 mstiles92 Aug 24, 2014 at 16:17 UTC - 0 likes

    @LordKainzo: Go

    @Daconway: Go

    The BookRules lore will not be in the next version of the plugin. It was just a temporary way of differentiating these books from others so they could be blocked from trading with villagers while still allowing player-written books to be traded.

  • Avatar of mstiles92 mstiles92 Aug 24, 2014 at 16:07 UTC - 0 likes

    @fuzzysgirl: Go

    Watch your console as you start the server and make sure there are no errors from BookRules then. It sounds like the plugin is not getting enabled when the server is started. If you see a stack trace on start-up, PasteBin it here and I will take a look. Otherwise, try downloading the plugin again to make sure the download didn't get corrupted.

  • Avatar of mstiles92 mstiles92 Aug 24, 2014 at 16:04 UTC - 0 likes

    @angrybirds85: Go

    Double-check that the book was actually added with the "/bookrules list" command. Also make sure that the config option "Give-New-Books-On-Join" is enabled. If the book was given to you once already, you won't automatically receive another copy of the same book unless the "Give-Books-Every-Join" config option is enabled.

  • Avatar of mstiles92 mstiles92 Aug 24, 2014 at 15:59 UTC - 0 likes

    @minecrafter38: Go

    It sounds like you have the "Give-Books-Every-Join" option enabled. With that enabled, players will receive a copy of all books every time they join the server. Disable that, but keep "Give-New-Books-On-Join" enabled to only give players books that they have not yet received.

  • Avatar of mstiles92 mstiles92 Aug 24, 2014 at 15:54 UTC - 0 likes

    @timsavage: Go

    Thanks for the idea! I will plan on adding this with the next release version.

  • Avatar of mstiles92 mstiles92 Aug 24, 2014 at 15:54 UTC - 0 likes

    @Dyllaann: Go

    Yes, this functionality will be in the next version of the plugin.

Facts

Date created
Aug 30, 2012
Categories
Last update
Jun 27, 2014
Development stage
Release
License
Common Development and Distribution License (CDDL)
Curse link
BookRules
Downloads
27,158
Recent files
  • R: v2.1.1 for CB 1.7.9-R0.1 Jun 27, 2014
  • R: v2.0.0 for CB 1.7.9-R0.1 Mar 18, 2013
  • R: v1.2.2 for CB 1.4.7-R1.0 Dec 28, 2012
  • R: v1.2.1 for CB 1.3.1-R2.0 Sep 08, 2012
  • R: v1.2.0 for CB 1.3.1-R2.0 Sep 03, 2012

Authors