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 mstiles92 mstiles92 Feb 27, 2013 at 18:36 UTC - 0 likes

    @flutter1: Go

    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!

    Last edited Feb 27, 2013 by mstiles92
  • Avatar of flutter1 flutter1 Feb 27, 2013 at 16:39 UTC - 0 likes

    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!

  • Avatar of mstiles92 mstiles92 Feb 27, 2013 at 00:34 UTC - 0 likes

    @KSum: Go

    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) :)

  • Avatar of mstiles92 mstiles92 Feb 27, 2013 at 00:29 UTC - 0 likes

    @JohnCraft110: Go

    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.

  • Avatar of KSum KSum Feb 26, 2013 at 22:47 UTC - 0 likes

    Don't let this die, please update for 1.4.7+. It's a great addition to an RPG server.

  • Avatar of JohnCraft110 JohnCraft110 Feb 24, 2013 at 21:28 UTC - 0 likes

    you should allow colors to be in the book.

  • Avatar of mstiles92 mstiles92 Feb 18, 2013 at 03:32 UTC - 0 likes

    @TheRygr11: Go

    @Abnormal_Zombie: Go

    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:

    Welcome-Message: ''
    

    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.

  • Avatar of TheRygr11 TheRygr11 Feb 18, 2013 at 02:26 UTC - 0 likes

    @Abnormal_Zombie: Go

    I would say to set the delay to 99999999999999

  • Avatar of Abnormal_Zombie Abnormal_Zombie Feb 15, 2013 at 23:10 UTC - 0 likes

    How do I disable the welcome message? I do not want it :/

  • Avatar of Eronair Eronair Feb 15, 2013 at 15:41 UTC - 0 likes

    @austin4195: Go

    ty. :)

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
25,768
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