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 mstiles92 mstiles92 Apr 16, 2014 at 22:15 UTC - 0 likes

    @NathanTheDragon: Go

    Yes, I will be switching it all over to the UUID system soon.

  • Avatar of mstiles92 mstiles92 Apr 16, 2014 at 22:02 UTC - 0 likes

    @frol1: Go

    Yes, it currently works with color codes using the § character like you would use in-game. In a future update, I will include support for using color codes with the & character as well.

  • Avatar of NathanTheDragon NathanTheDragon Apr 15, 2014 at 13:43 UTC - 0 likes

    As you've probably hear, Mojang changed their Username system to the UUID system. Will you support this?

    Thanks, ~ Nathan

    P.S. My server uses this, that's why I'm asking XD

  • Avatar of frol1 frol1 Apr 12, 2014 at 03:31 UTC - 0 likes

    do colour codes work?

  • Avatar of MarkehMe MarkehMe Apr 01, 2014 at 05:47 UTC - 0 likes

    @winter4w: Go

    "Boolean value that determines whether players will automatically be given all books they have not yet received upon logging in to the server."

    Short answer: correct, you will only receive EACH book once with the onjoin setting

    Last edited Apr 01, 2014 by MarkehMe

    Want a faster response from me? Follow me and tweet me on twitter! @markehme BFAK:90607746,6bd5d8183f15ef6bbc8c5469c97e0a66d662d410c11146dc88dbd1a9a0a8f471

  • Avatar of winter4w winter4w Mar 16, 2014 at 19:01 UTC - 0 likes

    Is this when they first join the server or when they log in?

    BFAK:83305,ebfe435cda01e3b145b8004046acd07f7254aa271d483935ce11b50c24e8eb9b

  • Avatar of mstiles92 mstiles92 Mar 04, 2014 at 02:06 UTC - 0 likes

    @Eiretek: Go

    Players have permission to use the info, list, and get commands by default (so servers without a permission plugin can still use it). If you would like to remove this permission from a group, you can add a negative permission node for that permission (usually by adding the permission node with an extra dash in front of it, depends on the permission plugin).

  • Avatar of Stormbow Stormbow Mar 04, 2014 at 01:17 UTC - 0 likes

    @xxbabygirlstar: Go

    Define a book in the book.txt file (which should be inside the essentials folder):

    #Book_o'_Colors
    Minecraft colors:
    &0 &&0  &1 &&1  &2 &&2  &3 &&3
    &4 &&4  &5 &&5  &6 &&6  &7 &&7
    &8 &&8  &9 &&9  &a &&a  &b &&b
    &c &&c  &d &&d  &e &&e  &f &&f
    &0 
    &&k &kMagic&r   &&l &lBold
    &&m &mStrike&r  &&n &nUline
    &&o &oItalic&r   &&r &rReset
    

    and give the book to players in the kit thusly:

      book_o'_colors:
        delay: 6000
        items:
          - 387 1 title:ActualBookTitle author:AuthorName lore:Description_of_the_book.|Vertical_bar_starts_a_new_line. book:BookName_In_BooksTxt_File
    


    where ActualBookTitle would be something like Book o' Colors (in the previous example), AuthorName would be the person who wrote the book (obviously), lore would be the purple text when you mouse over the item in the game that describes the item, and book refers to the actual name used in the book.txt file.

    Remember not to make the lore too long; putting the mouse over an item at the bottom of the screen will cutoff the text.

    And, of course, you can use color codes just about everywhere in the above.

    http://img.photobucket.com/albums/v298/Stormbow/no-trolling.gif

  • Avatar of Stormbow Stormbow Mar 04, 2014 at 01:06 UTC - 0 likes

    @Eiretek: Go

    This mod is outdated (it's 1.5.2-R1.0). You can use essentials to give people custom-made books anyway.

  • Avatar of Eiretek Eiretek Jan 21, 2014 at 00:10 UTC - 0 likes

    No players have permissions for any bookrules commands, yet can still use /rb get. I've triple checked my perm file to confirm. Thoughts? I'm on 1.7.2

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,723
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