MiniBook • messages.yml

📄 Introduction

The messages.yml file allows you to fully customize all messages sent by the MiniBook plugin. This includes command feedback, errors, help pages, book management messages, and plugin status notifications. Customizing this file helps you match your server’s theme and improve clarity for players and staff.

💡 Breakdown of the `messages.yml` file

🔖 `prefix`

prefix: "#FF4545&lM#FFE645&li#7BFF59&ln#6161FF&li&r&lBook &8»&r"

Defines the main prefix used in all plugin messages.

Supports legacy color codes (&)
Supports hex colors (#RRGGBB)
The %prefix% placeholder can be used anywhere in the file

💻 Command Messages

🔄 `commands.reload`

commands:
  reload:
    error: "%prefix% #FF0000🚫 Failed on plugin reload."
    success: "%prefix% #a0ff72✔ Plugin reloaded successfully"

error – Shown if the plugin fails to reload.
success – Shown when the plugin reloads correctly.

Placeholders: %prefix%

❓ `commands.help`

Multi-line help page displayed when using /mk help.

commands:
  help:
    - " "
    - " "
    - "                        #FF4545&lM#FFE645&li#7BFF59&ln#6161FF&i&r&lBook &8» &r&fHelp"
    - " "
    - "                       #fff18d&lʙᴏᴏᴋ ᴄᴏᴍᴍᴀɴᴅꜱ"
    - "&f  /ᴍᴋ ᴏᴘᴇɴ <ʙᴏᴏᴋ> [ᴘʟᴀʏᴇʀ/*] #707070- #ccccccOpens the selected book to the player(s) or itself."
    - "&f  /ᴍᴋ ʟɪꜱᴛ #707070- #ccccccDisplays a list of all configured books."
    - " "
    - "                    #fff18d&lᴘʟᴜɢɪɴ ᴄᴏᴍᴍᴀɴᴅꜱ"
    - "&f  /ᴍᴋ ʜᴇʟᴘ #707070» #ccccccShows this help message"
    - "&f  /ᴍᴋ ʀᴇʟᴏᴀᴅ #707070» #ccccccReloads the plugin configuration"
    - "&f  /ᴍᴋ ɪɴꜰᴏ #707070- #ccccccDisplays information about the plugin."
    - " "
    - " "
    - " "

Each list entry is a line sent to the player in order.

📘 Book Management Messages

➕ `commands.create`

commands:
  create:
    insufficient_args: "%prefix% #FF0000🚫 Insufficient args. #ccccccUse &f/mk create <id> \"<title>\" \"<author>\""
    already_exist: "%prefix% #FF0000🚫 Book '%book%' already exists."
    success:
      first: "%prefix% #a0ff72✔ Created book '%book%'"
      second: "#ccccccFor editing your book, open #efefef&oplugins/MiniBook/books/%book%.yml"
    failed: "%prefix% #FF0000🚫 Failed on creating book '%book%'"

insufficient_args – Not enough arguments provided.
already_exist – Book ID already exists.
success.first / success.second – Shown after successful creation.
failed – Book creation failed.

Placeholders: %prefix%, %book%

🗑 `commands.delete`

commands:
  delete:
    success: "%prefix% #a0ff72✔ Deleted book '%book%'"

Shown when a book is successfully deleted.

Placeholders: %prefix%, %book%

📋 `commands.list`

commands:
  list:
    no_books: "%prefix% #FF0000🚫 Can't find any books"
    header: "#cccccc         &m----------  &r#FF4545&lM#FFE645&li#7BFF59&ln#6161FF&li&r&lBook #cccccc&m----------"
    row: "<color:#efefef>  -</color> <color:#fffaab><book></color> <color:#eeeeee>(</color><title><color:#eeeeee>/</color><author><color:#eeeeee>)</color>"

row uses MiniMessage formatting only.

Placeholders: %prefix%, <book>, <title>, <author>

📖 `commands.open`

commands:
  open:
    insufficient_args: "%prefix% #FF0000🚫 Insufficient args. #ccccccUse &f/mk open <book> [player/*]"
    premium: "%prefix% #FF0000🚫 You need permission '%permission%' for open book '%book%'."
    book_not_found: "%prefix% #FF0000🚫 Can't find book '%book%'"
    failed: "%prefix% #FF0000🚫 Failed on opening book '%book%'"
    only_players: "%prefix% #FF0000🚫 You need to specify a target when running in the console. &7Use &f/mk open <id> <target/*>"
    target_not_found: "%prefix% #FF0000🚫 Can't find player '%target%'"
    success:
      self: "%prefix% #a0ff72✔ Opened '%book%'"
      target: "%prefix% #a0ff72✔ Opened '%book%' to player '%target%'"
      all: "%prefix% #a0ff72✔ Opened '%book%' to all online players."

Placeholders: %prefix%, %book%, %target%, %permission%

🎁 `commands.give`

commands:
  give:
    insufficient_args: "%prefix% #FF0000🚫 Insufficient args. #ccccccUse &f/mk give <book> [player/*]"
    premium: "%prefix% #FF0000🚫 You need permission '%permission%' for give/get book '%book%'."
    book_not_found: "%prefix% #FF0000🚫 Can't find book '%book%'"
    failed: "%prefix% #FF0000🚫 Failed on opening book '%book%'"
    only_players: "%prefix% #FF0000🚫 You need to specify a target when running in the console. &7Use &f/mk give <id> <target/*>"
    target_not_found: "%prefix% #FF0000🚫 Can't find player '%target%'"
    success:
      self: "%prefix% #a0ff72✔ Received '%book%'"
      target: "%prefix% #a0ff72✔ Given '%book%' to player '%target%'"
      all: "%prefix% #a0ff72✔ Given '%book%' to all online players."

Placeholders: %prefix%, %book%, %target%, %permission%

❌ Error Messages

error:
  no_permission: "%prefix% #FF0000🚫 Don't have permission to use this command."
  invalid_command: "%prefix% #FF0000🚫 Invalid command. #ccccccUse &f/mk help #ccccccto see the plugin commands."

Used for permission issues and invalid command handling.

Placeholders: %prefix%

🧩 Placeholders Summary

%prefix% — Main message prefix
%book% — Book ID
%title% — Book title
%author% — Book author
%target% — Target player
%permission% — Required permission node

💡 Tip: MiniBook supports legacy color codes, hex colors, and MiniMessage (where explicitly stated). Placeholders are replaced in the messages where they can be found previously.

messages.yml 📝

📄 Introduction

💡 Breakdown of the messages.yml file

🔖 prefix

💻 Command Messages

🔄 commands.reload

❓ commands.help