Skip to content

Bukkit plugin for automatically distributing written books to new players, useful for distributing rules, getting started guides, etc.

License

Notifications You must be signed in to change notification settings

ForsakenDev/BookRules

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

38 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

About

Bukkit plugin for automatically distributing written books to new players, useful for distributing rules, getting started guides, etc.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published