BookRules

Features

Automatically give players written books containing rules, getting started guides, etc when they join your server.

Commands

/rulebook Show current plugin information.
/rulebook info Show current plugin information.
/rulebook version Show current plugin information.
/rulebook commands Show description of all commands available to the player.
/rulebook reload Reload data from the config files.
/rulebook get [id | title] Get book specified by ID or title, or all books if no ID or title is specified.
/rulebook 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.
/rulebook add Add the currently held book to the plugin.
/rulebook delete <id | title> Delete the book specified by ID or title from the plugin.
/rulebook list Show all of the books currently stored by the plugin.
/rulebook setauthor <author> Change the author of the currently held book.
/rulebook settitle <title> Change the title of the currently held book.
/rulebook unsign Unsign the currently held book, changing it back to a book and quill.

Permissions

bookrules.* Allow full access to all commands in the plugin.
bookrules.info Allow use of /rulebook [info | version] to see the plugin information.
bookrules.reload Allow use of /rulebook reload to reload data from file.
bookrules.receivealerts Receive alerts when there is an update to the plugin.
bookrules.get Allow use of /rulebook get to get the books stored by the plugin.
bookrules.give Allow use of /rulebook give to give books to other players.
bookrules.add Allow use of /rulebook add to add a new book to be stored by the plugin.
bookrules.delete Allow use of /rulebook delete to delete a book stored by the plugin.
bookrules.list Allow use of /rulebook list to list all books stored by the plugin.
bookrules.setauthor Allow use of /rulebook setauthor to set the author of the currently held book.
bookrules.settitle Allow use of /rulebook settitle to set the title of the currently held book.
bookrules.unsign Allow use of /rulebook unsign to unsign written books, changing them back to book and quills.

Configuration

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.

Planned

  • Optional groups for books, allowing groups to only be given to players with the correct permission
  • Localization options, allow plugin to be translated to different languages

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

  • Avatar of austin4195 austin4195 Feb 10, 2013 at 15:26 UTC - 0 likes

    @Eronair: Go

    It does work on 1.4.7 R1.0, i have been using it on my server for a while now

    Have Fun, Austin

  • Avatar of Eronair Eronair Jan 25, 2013 at 19:47 UTC - 0 likes

    Hello.

    Just wanted to hear, if this version is stable on Craftbukkit 1.4.7-R0.1

    regards Eronair

  • Avatar of Redstone_ Redstone_ Jan 18, 2013 at 03:40 UTC - 0 likes

    Do you think that you could make it so that we can also write it on the config and that we edit a book with /rulebook edit maybe and add color codes through the a config and through the game i think that this could be a great idea even if you don't add all of them what i would really like is that we could make book through a config and edit them and add all the color codes. if you do add the /rulebook edit command can you add a permission node? for example: "rulebook.edit" Also maybe you could add like a newspaper sort of thing for example if we could add books and maybe we could add a currency to books which would be used through all currency plugins like Fe,Iconomy, ect.

    Join My Server! Mc.BlockVentures.Us.To
    24/7 NoLagg Freebuild

  • Avatar of mstiles92 mstiles92 Jan 12, 2013 at 21:03 UTC - 0 likes

    @zedadiaswick: Go

    Yes, I planned on making an option that would block trading the books created by this plugin. This seems like a better option to me than just limiting the amount of books they can receive. Glad you like it :)

    @kahlilnc: Go

    Is there a problem with color codes? They should work fine, you just have to use the § symbol, just like you would with the vanilla game.

  • Avatar of kahlilnc kahlilnc Jan 12, 2013 at 18:54 UTC - 0 likes

    Color codes? :D

    Servers in the work: http://mineshire.net and http://meleecraft.net! Coming Soon!
    If you are experienced and willing to help add me on Skype: kahlil NC !!!

Facts

Date created
Aug 30, 2012
Categories
Last update
Mar 18, 2013
Development stage
Release
License
Common Development and Distribution License (CDDL)
Curse link
BookRules
Downloads
22,763
Recent files
  • R: v2.0 for CB 1.7.2-R0.3 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 for CB 1.3.1-R2.0 Sep 03, 2012
  • R: V1.1 for CB 1.3.1-R2.0 Sep 01, 2012

Authors