Índice de módulos
Todos los módulos, para qué sirve cada uno, y dónde está su punto de entrada.
Todos los módulos se alcanzan igual: una clase estática con el nombre del módulo, normalmente con un
of(plugin) que devuelve una vista que pertenece a tu plugin.
Módulos más nuevos#
- Módulos de minijuegos y red: arenas, depósito, intercambios, sala, modos, mensajes de red, tiempo jugado, reapariciones, hooks, grupos, derribados, objetivos, tránsitos, puntos de clic, mascotas.
- Pantallas en el mundo y utilidades: menús espaciales, stage, escena de cajas, guide, habilidades, barras de acción, zonas de construcción, comandos dinámicos.
- Ajustes en el juego:
/exylialib config. - Versiones de servidor: soporte de Paper 1.21.1.
- Asistente de configuración:
/exylialib setup, el traslado de base de datos y compartir una base. - Pantallas y marcado de pantallas: menús 2D por paquetes con cursor, estilo de menú, XHTML y CSS.
- HUD: widgets, avisos y momentos que nunca quitan los controles.
- Clasificaciones: tablas que se mantienen solas por día, semana, mes, año y de siempre.
- Herramientas de lobby y economía: hotbars, doble salto, plataformas de salto, diálogos, sala de kits, libro mayor.
Fundamentos#
| Módulo | Punto de entrada | Para qué sirve |
|---|---|---|
| Task | Tasks.of(plugin) | Programación que corre en Spigot, Paper y Folia desde una llamada. |
| Config | Configs.define(plugin, nombre, tipo) | Archivos YAML declarados y leídos como records de Java. |
| Text | Text.of(cadena) | Cada cadena visible, a componentes de Adventure. |
| Placeholders | Placeholders.group(plugin, prefijo) | Un registro para %placeholders%, con o sin PlaceholderAPI. |
| Formats | Formats, Amounts | Números, dinero, porcentajes y fechas que lee un jugador — y cantidades que teclea. |
| Debug | Debug.of(plugin) | Salida de consola con color, con un interruptor global. |
| Reloading | Reloads.of(plugin) | Pasos de recarga con nombre y fallos contenidos, más listeners de recarga de la librería. |
| Modules | PluginModules.of(plugin, interruptores) | Partes de un plugin que se encienden y apagan, cada una con sus archivos, listeners, acciones, menús, comandos y temporizadores. |
| Metrics | Metrics.describe(plugin, detalles) | Cómo se describe la configuración de un plugin a stats.exylia.net. Ver Métricas. |
| Web editor | WebEditor.of(plugin) | Editar los archivos de un plugin desde el navegador. |
| Logs | Logs.of(plugin) | Un registro de auditoría del staff en el que escribe cada plugin, leído con /exylialib logs. |
Almacenamiento#
| Módulo | Punto de entrada | Para qué sirve |
|---|---|---|
| Database | Databases.of(plugin) | Records en H2, MySQL, MariaDB, PostgreSQL o MongoDB. |
| Transfer | Transfers.of(plugin) | La base de datos entera de un plugin a un archivo y de vuelta. |
| Redis | configuración | Una caché compartida que hace que una base de datos se vea igual desde cada servidor. |
| Snapshots | Snapshots.of(plugin) | El estado de un jugador guardado para después, en memoria o almacenado. |
| Proxy | Proxy.request(módulo, payload) | Hablar con ExyliaProxyUtils en Velocity o BungeeCord, con respuesta a cada petición. |
Interfaces#
| Módulo | Punto de entrada | Para qué sirve |
|---|---|---|
| Menus | Menus.of(plugin) | Menús escritos en configuración: listas, plantillas, condiciones, valores en vivo. |
| Items | Items.of(plugin) | Items descritos en configuración, leídos una vez y dibujados por jugador. |
| Actions | Actions.of(plugin, namespace) | Acciones compiladas y con namespace, compartidas por menús e items. |
| Input | Inputs.of(plugin) | Pedirle a un jugador texto, números, opciones o un formulario entero. |
| Editors | Editors.of(plugin) | Pantallas para editar las listas que configura un plugin. |
| Wizards | Wizards.of(plugin) | Guiar a un jugador por varias preguntas, aplicadas solo al confirmar. |
| Previews | Previews.of(plugin) | Mostrarle a un jugador un efecto contra un cielo vacío. |
| Heads | Heads.browse(inputs, …) | El catálogo de cabezas decorativas, buscable desde un menú, una página cada vez. |
| Interactions | Interactions.compile(plugin, lineas) | Lo que hace hacer clic en algo del mundo: líneas con filtros de clic, comandos y tokens de efecto. |
| Tuner | Tuner.of(plugin, sujeto) | Ajuste fino con la rueda del ratón, con un HUD en boss bar y vista previa en vivo. |
| Settings | Settings.register(plugin, ajuste) | Preferencias de jugador que registra cada plugin, y la única pantalla /settings. |
| Toasts | Toasts.send(player, icono, título, marco) | El aviso de logro de la esquina, con una alternativa configurable. |
| Notices | Notices.of(plugin) | Mensajes dejados a un jugador: mostrados ahora, a través de la red, o en su próxima entrada. |
| Discord webhooks | Webhooks.of(plugin) | Mensajes a Discord escritos en config, con valores escapados y límites de ritmo. |
En pantalla#
| Módulo | Punto de entrada | Para qué sirve |
|---|---|---|
| Effects | Effects.play(config, viewer) | Títulos, barras de acción, boss bars, sonidos, partículas, fuegos. |
| Sequences | Sequences.of(plugin) | Efectos coreografiados desde configuración: veintiséis formas, sonidos, pausas, displays y cuerpos. |
| Displays | Displays.of(plugin) | Displays de objeto, bloque y texto que se mueven, giran y caen solos, animados por el cliente. |
| NPCs | Npcs.of(plugin) | Cuerpos con forma de jugador que solo existen en un cliente. |
| Ragdolls | Ragdolls.of(plugin) | Uno de esos cuerpos deshaciéndose, en doce poses. |
| Overlays | Overlays.of(plugin) | Objetos en el inventario del jugador que el servidor no tiene. |
| Packets | Packets.of(plugin) | Vanish, bloques falsos, bordes del mundo por jugador, congelar, un espectador falso, mirar cofres en silencio y líneas en items. |
| Scoreboard | Scoreboards.show(plugin, player, config) | Sidebars por paquetes declarados en config. |
| Hologram | Holograms.show(plugin, id, location, config) | Hologramas por paquetes declarados en config: etiquetas por línea, páginas, clics y botones. |
| Nametags | Nametags.of(plugin) | Color del nombre, brillo y colisión según quién mira. |
| Chat | Chats.rule(plugin, rule) | Quién lee los mensajes de quién, quitados de la audiencia antes de entregar. |
| Cosmetics | Cosmetics.rule(plugin, rule) | Si se dibujan los cosméticos de un jugador — la pregunta que hace cada plugin cosmético. |
| Client | Clients.of(plugin) | Lunar, Feather y el mod de SurvivalCore: waypoints, equipos, temporizadores y barras en el HUD, cooldowns. |
| Skulls | Skulls.player(nombre) | Cabezas de jugador desde base64, una URL o un nombre — cacheadas y sin bloquear. |
| Models | Models.of(plugin) | Modelos de Blockbench que llevan entidades vivas, sin resource pack. |
| VFX | Vfx.at(ubicación) | Efectos construidos en Java y reproducidos como una línea de tiempo: displays, sonidos, partículas, temblor de pantalla. |
| Cameras | Cameras.of(plugin) | Mostrarle a un jugador a sí mismo desde fuera, devolviéndole siempre la vista. |
| Replays | Replays.of(plugin) | Grabar lo que pasó y reproducirlo como cuerpos por paquetes. |
| Showcases | Showcases.of(plugin) | Lugares que muestran en bucle los cosméticos de un plugin a quien se acerque. |
Mundo#
| Módulo | Punto de entrada | Para qué sirve |
|---|---|---|
| Regions | Regions.of(plugin) | Formas, un índice espacial, políticas de solape, eventos de entrada y salida, contornos. |
| Schematics | Schematics.of(plugin) | Guardar una caja del mundo y pegarla de vuelta. |
| World | Worlds.create(key, nombre) | Crear y borrar mundos, desde cualquier hilo. |
| WorldGuard | WorldGuardRegions, WorldGuardFlags | Consultas de región y las flags propias del ecosistema — kill-effects, hit-effects, arrows-effects — sin dependencia en compilación. |
| Blocks | Blocks.of(plugin) | Bloques que responden a clics en vez de comportarse como su material, y si un bloque lo puso un jugador. |
Jugadores#
| Módulo | Punto de entrada | Para qué sirve |
|---|---|---|
| Sessions | Sessions.of(plugin) | Un registro de reservas para que dos plugins no tengan al mismo jugador. |
| Players | ExyliaPlayers.of(…) | Un ExyliaPlayer sobre jugadores conectados, desconectados y de la red, resuelto sin bloquear. |
| Stays | Stays.of(plugin) | Un jugador retenido en una arena y devuelto exactamente como llegó. |
| Cooldowns | Cooldowns.forPlugin(plugin) | La base sobre la que se apoya cada cooldown del ecosistema. |
| Schedules | Schedules.of(plugin) | Horarios: qué arranca solo, cuándo y bajo qué condiciones. |
| Teleport | Teleports.of(plugin) | Calentamientos, aterrizajes seguros, /back, peticiones y traspasos. |
| Combat | Combat.isTagged(player) | Si un jugador está peleando, sobre DeluxeCombat o PvPManager. |
| Clan | Clans.clanOf(uuid) | Una API sobre ocho plugins de clanes y puentes externos. |
| Mobs | Mobs.of(plugin) | Mobs personalizados desde una plantilla, con habilidades, fases y quién los hirió informado al morir. |
Lo que gana un jugador#
| Módulo | Punto de entrada | Para qué sirve |
|---|---|---|
| Rewards | Rewards.of(plugin) | Items, comandos, dinero, probabilidades y condiciones — a prueba de desconexiones. |
| Loot | Loot.parseAll(lineas) | Lo que sale de un cofre, un generador o un bloque roto. |
| Economy | Economy.balance(uuid) | Saldos, cobros y transferencias sobre Vault, PlayerPoints o tu propia moneda. |
| Crates | Crates.of(plugin) | La tirada, las llaves, los rodillos, el pago y los bloques de una caja, compartidos; las recompensas quedan para el plugin. |
| Modifiers | Modifiers.register(plugin, proveedor) | Una sola cadena de multiplicadores para lo que ganan los jugadores, alimentada por boosters, rangos y lugares. |
| Prices | Prices.sell(stack) | Por cuánto se vende un item, respondido por la tienda o lista de precios que lo tenga. |
No son módulos#
| Clase | Qué es |
|---|---|
net.exylia.lib.ExyliaLib | El plugin en sí: ciclo de vida y limpieza, nada más. |
net.exylia.lib.platform.Platform | current(), isFolia(), isPaper(). |
net.exylia.lib.api.practicebot.PracticeBots | En el artefacto de la API pública: un puente al plugin de bots de entrenamiento, get() y available(). Vacío cuando no está. |
net.exylia.lib.internal.* | Interno. Libre de cambiar sin aviso. |
| Cleanup | Sin API: plugins/ExyliaLib/cleanup.yml. Barre la carpeta logs/ del servidor de archivos con más de keep-days días, un minuto tras arrancar y cada seis horas. |
Recargar#
Reloads.of(this)
.step("configs", () -> { settings.reload(); menus.reload(); })
.step("arenas", () -> arenas.load())
.run(sender);Cada paso informa por sí mismo: uno que lance se nombra en consola y al emisor se le dice cuántos salieron bien. Un plugin recargado a medias que no dice nada es peor que uno que nombra lo que falló.
Cuando /exylialib reload ve que cambió el idioma de un plugin (language: default siguiendo un idioma nuevo de la librería),
ejecuta una vez todo su Reloads declarado, así menús, mensajes y catálogos leen el idioma nuevo sin un segundo comando
(1.534.0+). Los plugins van por turnos, uno cada pocos ticks, para que el servidor siga corriendo mientras se extiende el idioma (1.542.0+).
El Reloads que un plugin declaró por última vez es también lo que se ejecuta después de que
/exylialib updates apply o el editor web escriben uno de sus archivos, así que
el cambio queda activo sin recargar a mano. Decláralo una vez, en un campo, en vez de construirlo dentro del
comando de recarga.
Reloads.onLibraryReload(this, () -> menus.reload());El /exylialib reload de la propia librería dispara ese listener. El motivo habitual de quererlo es que
cambie la paleta: cada menú compilado se queda con los colores de la semana pasada hasta que se vuelve a
leer.
Módulos de plugin#
Un plugin hecho de partes que el dueño del servidor enciende y apaga. Cada parte tiene sus archivos, listeners, acciones, menús, comandos y temporizadores, y una parte apagada no cuesta nada.
modules = PluginModules.of(this, id -> settings.get().modules().switchOf(id));
modules.register(new MarketModule());
modules.register(new AuctionsModule()); // requiredModules() devuelve ["market"]
modules.registerActions(actions); // antes de compilar los menús
menus.load(modules.menuIds());
modules.commandHandlers().forEach(lamp::register);
modules.loadOnlinePlayers(Bukkit.getOnlinePlayers());
modules.startTimers();public final class AuctionsModule extends PluginModule {
public AuctionsModule() { super("auctions"); }
@Override protected List<String> requiredModules() { return List.of("market"); }
@Override protected void registerConfigs() { config("modules/auctions/config", AuctionsConfig.class).load(); }
@Override protected void onEnable() { manager = new AuctionManager(); }
@Override protected void onDisable() { if (manager != null) manager.shutdown(); }
@Override protected List<Object> commandHandlers() { return List.of(new AuctionsCommand()); }
@Override protected void timers() { timer(20L, 20L, () -> manager.sweep()); }
}| El interruptor se lee al arrancar | Un módulo cuyo id no tiene interruptor en la config se queda apagado y se informa, para que una clave mal escrita nunca falle en silencio. Un interruptor cambiado después solo lo informa pendingRestart(). |
| Requisitos | requiredPlugins() y requiredModules() mantienen un módulo apagado, con una línea en consola, mientras falte lo que necesita. |
| Un módulo nunca tumba a los demás | Un módulo que lanza al activarse pierde los listeners nuevos, recibe su propio onDisable y se queda apagado; el resto arranca igual. |
| Las consultas solo responden por módulos en marcha | getModule(id) e isEnabled(id) están vacíos para un módulo apagado, sin requisitos o que falló. |
| Recarga | reloadConfigs() recarga cada módulo en marcha, cada uno por su cuenta. reload(id) recarga un solo módulo en el sitio — para un editor en el juego que cambió los ajustes de un módulo. |
| Comandos | commandHandlers() devuelve objetos handler simples para que el plugin los registre con su propio Lamp. registerCommands(lamp) está obsoleto. |
Al desactivar, disableAll() desactiva los módulos en marcha en orden inverso.
Cambiar un módulo en caliente#
Desde 1.557.0, modules.setEnabled("auctions", false) enciende o apaga un módulo sin reiniciar y devuelve un ModuleToggle
(succeeded(), changed(), missing(), menus()). Guardar el interruptor es cosa del plugin.
| Estado | Significado |
|---|---|
ENABLED / DISABLED | ahora corre, o está apagado; changed() guarda los dependientes que se movieron con él |
UNCHANGED | ya estaba en ese estado |
BLOCKED | sigue apagado: missing() nombra los plugins o módulos que necesita y no corren |
FAILED | lanzó al activarse, se liberó y sigue apagado |
UNKNOWN | ningún módulo tiene ese id |
- Apagar: todo módulo en marcha que lo necesita se apaga antes, el último registrado primero: se quitan los listeners de
onEnable, paran los temporizadores y correonDisable. Encender:registerConfigs,onEnable, acciones, jugadores conectados, temporizadores, y luego vuelven los dependientes cuyo interruptor está activo. El interruptor pedido gana el resto de la ejecución. - Las acciones de un módulo apagado responden
stop("switched off")(actions.onlyWhile(module::isEnabled)), así los menús compilados siguen valiendo. - Los comandos no se pueden desregistrar en Lamp: registra
modules.allCommandHandlers()y rechaza los comandos de un módulo apagado con unacommandConditionque usemodules.offModuleOf(method).
Salida de depuración#
Debug debug = Debug.of(this);
debug.success("Configs cargadas");
debug.warn("La arena 'main' no tiene esquemática");
debug.error("No se pudo alcanzar la base de datos", failure);
debug.debug("Sesión vaciada: " + entries); // solo con debug activoDebug.all(true) enciende las líneas de debug de todos los plugins a la vez, que es el interruptor al
que acudir para reproducir algo en vez de editar la config de cada plugin.
¿Falta algo en esta página? Dínoslo en Discord