MiniBook • books/<book>.yml

📘 Book Files Configuration

📄 Introduction

Each book in MiniBook is defined by its own YAML file located in the plugin's books folder. These files describe how the book looks, who can access it, and what content it contains. This system allows you to create fully customizable books with permissions, premium restrictions, and rich text formatting.

MiniBook uses MiniMessage for all text formatting, allowing gradients, colors, click events, hover text, and more.

🔗 MiniMessage format reference: https://docs.advntr.dev/minimessage/format.html

📂 Book File Structure

Each book file follows this general structure:

The file name (without .yml) is the book ID.
All fields are optional unless stated otherwise.

🧩 Basic Fields

title: "<gradient:#FF4545:#FFE645:#7BFF59:#6161FF><bold>Welcome!</bold></gradient>"
author: "<#FF4545><b>Server Staff</b></#FF4545>"

title: The title displayed on the book cover. Supports full MiniMessage formatting.
author: The author name shown on the book. Also supports MiniMessage.

🔒 Premium & Permissions

premium: false
permission: "minibook.book.welcome"

premium: Marks the book as premium.
- If set to true, the player must have the specified permission to open or receive the book.
- (Options: true, false)
permission: The permission required to access the book when premium is enabled.
- If omitted, MiniBook will automatically use: minibook.book.<bookId>

📖 Pages

pages:
  - |
    <gradient:#FF4545:#6161FF><bold>━━━━━━━━━━━━━━━</bold></gradient>
    <b><gradient:#FF4545:#6161FF>Welcome</gradient></b>
    <gradient:#FF4545:#6161FF><bold>━━━━━━━━━━━━━━━</bold></gradient>
    
    Thank you for joining our community!
    
    <#7BFF59><b>Rules:</b></#7BFF59>
    <gray>• Be respectful
    • No cheating
    • No griefing
    • Have fun!</gray>
    
    <gradient:#FFE645:#7BFF59>Commands:</gradient>
    <aqua>/spawn /sethome /home</aqua>

  - |
    <rainbow><b>Join Our Community!</b></rainbow>
    
    <gold><b>💰 Economy:</b></gold>
    <gray>Vote daily, sell items at /shop, complete quests!</gray>
    
    <green><b>🏠 Protection:</b></green>
    <gray>Use /claim to protect your builds</gray>
    
    <blue><b>📞 Support:</b></blue>
    <click:open_url:'https://discord.gg/myserver'>
      <u><gradient:#5865F2:#7289DA>Join our Discord!</gradient></u>
    </click>
    
    <gradient:#FF4545:#6161FF>Enjoy your stay!</gradient>

pages: A list of book pages.
Each page:
- Is defined using |- to allow multi-line content.
- Fully supports MiniMessage tags.
- Represents one in-game page.

✨ Formatting Tips

Use <gradient> or <rainbow> for eye-catching titles.
Use <click:open_url> to add clickable links.
Emojis and UTF-8 symbols are fully supported.
Avoid overly long pages to prevent text from overflowing in-game.

⚠️ Notes & Behavior

If pages is empty or missing, MiniBook will generate a default page.
Changes to book files require a /minibook reload to apply.
File names must be unique — duplicate IDs will be ignored.

You can use this system to create welcome books, rule books, tutorials, story content, or premium-exclusive content with full control and style. 🚀

books/<book>.yml 📝