Rulebook

Rulebook

A server-side rules screening mod for Fabric.

Supports Placeholder API, Simplified Text Format, and per player permissions with LuckPerms.

Accept

Reject

Clarifications

You accept the rules by viewing all pages and closing the rulebook.
You can close by clicking the Done or Take Book buttons, or pressing Escape on your keyboard.
The Take Book button will give you an actual in-game rulebook item.

Commands (and permissions):

• /rulebook and /rules – Displays the rules in chat (rulebook.main, available by default)
• /rulebook open and /rules open – Displays the rules as a book (rulebook.main, available by default)
• /rulebook reload – Reloads configuration (requires rulebook.reload)
• /rulebook update – Resets all players’ rule status and kicks them, forcing them to accept the rules again (requires rulebook.update)
• /rulebook update <players> – Same as above but only for targeted players (requires rulebook.update)
• /rulebook update offline – Same as above but only for offline players (requires rulebook.update)
• /rulebook accept – Used for accepting the rules (rulebook.main, available by default)

Configuration

// New lines can be added with `\n`!
{
  // Header at the top of each book page and at the top of the rules command
  "rules_header": "Rules Header\n",
  // Rule formatting, supports the variables %rule_number%, %rule_title%, %rule_description%
  "rule_schema": "%rule_number%. %rule_title%\n%rule_description%\n",
  // Displayed at the last page
  "final_page": "By closing the rulebook <bold>%player:name%</bold> you hereby agree to <underline>all the rules</underline>",
  // Messages for when a player is kicked
  "kick_messages": {
    // Player hasn't visited all pages
    "didnt_read": "<red>You didn't read all the rules!</red>",
    // Player's rules have been updated
    "updated_rules": "<yellow>Rules updated, please reconnect</yellow>"
  },
  // All the different rules, each with a title and description
  "rules": [
    {
      "title": "title",
      "description": "description"
    },
    {
      "title": "more title",
      "description": "more description"
    }
  ],
  // List of players that have accepted
  "accepted_players": []
}

Credits

• LilydevMC/Rules [code and inspiration]