BookRules is a rules plugin, where you need to accept the rules to play.
Highly configurable and 1.12-1.18 support.
Join my Discord for feature requests and support!
Open a book to a player on his first join with the contents configured.
On the last page, the player will be able to accept or decline the rules.
If a player wants to remove their accepted status, they can either type
/declinerules or type
/rulebook to open the book again and click on decline.
There are also
clickable buttons in the book on the last page, that run the command and close the book.
The player can type
/rulebook to open the book again.
You can reload the plugin in-game and remove/add a
player's status as accepted/not accepted. Full UUID support.
Commands:
/acceptrules - accept the rules
/declinerules - decline the rules
/rulebook - open the book again
(if you didn't accept the rules it opens automatically again)
/bookrules - admin command
/bookrules reload - reload the configuration
/bookrules status [player] - check the status of a player
/bookrules acceptrules [player] - accept the rules for a player
/bookrules declinetrules [player] - decline the rules for a player
Permissions:
bookrules.commands - all /bookrules reload, acceptrules, declinerules
bookrules.reload - /bookrules reload
bookrules.status - /bookrules status [player]
bookrules.acceptrules - /bookrules acceptrules [player]
bookrules.declinerules - /bookrules declinerules [player]
Only works with permission mode:
bookrules.accept - /acceptrules
bookrules.decline - /declinerules
bookrules.rulebook - /rulebook
bookrules.onjoin - open the book when a player joins and didn't accept the rules
bookrules.onclose - open the book when a player closes it and didn't accept the rules
prefix: Prefix showing on all commands (except /bookrules)
accept-text: Text on the last page of the book
accept-button: Text on the button placeholder
<acceptbutton> and trigger for /acceptrules
decline-button: Text on the button placeholder
<declinebutton> and trigger for /declinerules
kick-text: The kick message when a player declines the rules
no-permission: Message when a player doesn't have permissions for a command
accept-message: Message sent when a player accepts the rules
already-accepted-message: Message sent when a player tries to accept the rules while he already accepted them
use-permissions: Extra permissions
debug-mode: If enabled, outputs useful information about what the plugin does
storage-method:
The storage method. Either
local or
mysql.
mysql:
host: The IP of the MySQL server
port: The port of the MySQL server
username and password: Login credentials
database: The database name
prefix: The table prefix
content: set the pages:
For each page, you put the next number like in the default config. For each line in a page, you put a
Code (Text):
- 'and here the line'.
If the line doesn't fit, it will still be put in the next line in the book.
Just look and the defaults, there you can see it better.
Example:
Code (YAML):
content:
'1'
:
- '&7
[&61&7
] &6Don''t grief!'
- '&7
[&62&7
] &6Don''t hack!'
This plugin supports
clickable/
hoverable text and makes
gradients easy to make. It is done through MiniMessage parsing. If you want to deep dive into the possibilities you have with
MiniMessage, you should visit the
Adventure Documentation.
Example:
Code (YAML):
'3'
:
- 'MiniMessage examples:'
- '<click:run_command:/say hello>Click</click> to say hello'
- '<hover:show_text:''<red>test''>hover :
)</hover>'
- ' '
- 'If you need help configuring, go to the wiki!'
- 'http://bit.ly/bookrules-wiki'
The plugin supports
PlaceholderAPI in the following strings:
accept-text,
kick-text, and
content
(the pages in the book).
To ask for support join my
Discord server:
https://discord.gg/C8US3QmXhJ
If you find issues, please report them on
GitHub:
https://github.com/Skyslycer/BookRules
Pictures:
Thanks for using my plugin!
I will try to fix issues as soon as possible if an issue comes up.
Downloads
100
200
300
400
500
600
700