books/<book>.yml
##Configuración de archivos de libros
##Introducción
Cada libro en MiniBook se define mediante su propio archivo YAML ubicado en la carpeta books del plugin. Estos archivos describen cómo se ve el libro, quién puede acceder a él y qué contenido contiene. Este sistema te permite crear libros completamente personalizables con permisos, restricciones premium y formato de texto avanzado.
MiniBook utiliza MiniMessage para todo el formato de texto, lo que permite usar degradados, colores, eventos de clic, texto al pasar el cursor y mucho más.
- Referencia del formato MiniMessage: https://docs.advntr.dev/minimessage/format.html
##** Estructura del archivo del libro**
Cada archivo de libro sigue esta estructura general:
- El nombre del archivo (sin
.yml) es el ID del libro. - Todos los campos son opcionales, a menos que se indique lo contrario.
##** Campos básicos**
title: "<gradient:#FF4545:#FFE645:#7BFF59:#6161FF><bold>Welcome!</bold></gradient>"
author: "<#FF4545><b>Server Staff</b></#FF4545>"- title: El título que se muestra en la portada del libro. Soporta formato completo de MiniMessage.
- author: El nombre del autor que se muestra en el libro. También soporta MiniMessage.
##** Premium y permisos**
premium: false
permission: "minibook.book.welcome"premium: Marca el libro como premium.
- Si está en
true, el jugador debe tener el permiso especificado para abrir o recibir el libro. - (Opciones:
true,false)
- Si está en
permission: El permiso requerido para acceder al libro cuando
premiumestá activado.- Si se omite, MiniBook usará automáticamente:
minibook.book.<bookId>
- Si se omite, MiniBook usará automáticamente:
##** Páginas**
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: Una lista de páginas del libro.
Cada página:
- Se define usando
|para permitir contenido multilínea. - Soporta completamente las etiquetas de MiniMessage.
- Representa una página dentro del juego.
- Se define usando
##** Consejos de formato**
- Usa
<gradient>o<rainbow>para títulos llamativos. - Usa
<click:open_url>para añadir enlaces clicables. - Los emojis y símbolos UTF-8 son totalmente compatibles.
- Evita páginas demasiado largas para que el texto no se desborde dentro del juego.
##** Notas y comportamiento**
- Si
pagesestá vacío o no existe, MiniBook generará una página por defecto. - Los cambios en los archivos de libros requieren un
/minibook reloadpara aplicarse. - Los nombres de archivo deben ser únicos — los IDs duplicados serán ignorados.
Puedes usar este sistema para crear libros de bienvenida, libros de reglas, tutoriales, contenido narrativo o contenido premium exclusivo, con contr