Content generated with AI — it may contain mistakes.

ExyliaLib

The modules every Exylia plugin builds on: typed configuration with languages, in-game settings and a web editor, a setup wizard, YAML menus, packet-drawn screens and HUD, database with network groups, leaderboards, placeholders, sequences, holograms, NPCs, ragdolls and custom mobs drawn with display entities, regions, replays, rewards, economy and one scheduler for Paper 1.21.1+ and Folia 1.21.4+.

54 pages, read in order
Version
v1.622.0
Minecraft
1.21+
Category
Library

Start in three steps

From the jar to the first match, in this order.

  1. 1IntroductionWhat ExyliaLib is, the modules it ships, and the rules it is built on.
  2. 2InstallationInstalling the library on a server and depending on it from a plugin.
  3. 3The library's own filesplugins/ExyliaLib/config.yml and its neighbours: language, updates, metrics, the web editor and what each other file holds.

Straight to the reference

Chapter 01

Getting started

  1. 1IntroductionWhat ExyliaLib is, the modules it ships, and the rules it is built on.
  2. 2InstallationInstalling the library on a server and depending on it from a plugin.
  3. 3The library's own filesplugins/ExyliaLib/config.yml and its neighbours: language, updates, metrics, the web editor and what each other file holds.
  4. 4Server versionsRunning on Paper 1.21.1 while compiling against 1.21.4: what the library probes, shims and switches off.
  5. 5Setup wizardThe first-run setup offered to admins after a fresh install: language, menu style, colours and a tested shared database for the whole network.
  6. 6A first pluginguideConfig, a command, a menu and a database table — end to end, in one file each.

Chapter 02

Customise (all Exylia plugins)

  1. 7Change the colours of your Exylia pluginsRecolour every Exylia plugin at once from one file, colors.yml: the palette, the theme colour, hex values, gradients and how to use the colours in your own messages.
  2. 8Change messages and the languagePick the language of your Exylia plugins, find and edit any message, use colours, hex, gradients and click-able text, change the prefix and reload.
  3. 9Edit the menus of your Exylia pluginsMenus are plain files: change a title, an item name, an icon, a slot or a sound, hide a button, and reload.
  4. 10Set up the economy for your Exylia pluginsChoose which money your Exylia plugins charge and pay in: Vault, PlayerPoints or an ExyliaEconomy currency, with one file, economy.yml.
  5. 11Set up the database of your Exylia pluginsWhere Exylia plugins keep their data by default, how to move to MySQL, MariaDB or PostgreSQL step by step, and how to share data between servers.

Chapter 03

Foundations

  1. 12ConfigurationYAML files declared as Java records, generated from them, and migrated when they change shape.
  2. 13Text and placeholdersOne parser for every player-facing string, the shared palette, a plugin's own message lines, and one registry for %placeholders%.
  3. 14Tasks and threadsOne scheduler that runs on Spigot, Paper and Folia without a branch in your code.
  4. 15DatabaseRecords stored in H2, MySQL, MariaDB, PostgreSQL or MongoDB — one pool, no reflection per row, nothing blocking.

Chapter 04

Interfaces

  1. 16MenusEverything a menu file can say: windows, lists, groups, templates, fillers, conditions, clicks, sounds and redrawing.
  2. 17ScreensFull-screen 2D menus with a mouse cursor, drawn with packet displays and no resource pack: opening one, input, preferences, menu style and routing chest menus.
  3. 18Screen markupWrite a screen as XHTML and CSS: tags, attributes, the CSS subset, expressions, actions, components and words.
  4. 19HUDText on a player's screen that never takes their controls: widgets, notices and big moments, designed widgets, anchors and the minimap.
  5. 20ItemsAn item described in YAML — menu icon, kit entry, special item or shield — read once and drawn per viewer.
  6. 21ActionsCompiled, namespaced actions shared by menus, items and any other event boundary.
  7. 22Input, editors and wizardsAsking a player for something, editing a list of things, fine-tuning with the mouse wheel and walking somebody through a setup.
  8. 23Player settingsPreferences every Exylia plugin registers, announcement channels players can mute, and one /settings screen that shows them all.
  9. 24In-game settingsChange every plugin's settings and content catalogues from a menu with /exylialib config, with no code in the plugin.
  10. 25OverlaysItems in a player's own inventory that the server does not have — a staff hotbar a crash cannot leave behind.
  11. 26Notices and toastsAdvancement toasts for anything worth noticing, and messages left for a player who may not be online to read them.
  12. 27ChatWho reads whose chat messages, and taking a line out of chat before anybody else reads it.
  13. 28Discord webhooksMessages to Discord written as config templates, sent as Components V2 cards, with pings, rate limits and dead webhooks handled.
  14. 29CosmeticsOne question every cosmetic plugin asks, buying a cosmetic with any currency, and places that show cosmetics off on their own.

Chapter 05

Visuals

  1. 30Effects and sequencesTitles, action bars, boss bars, sounds, particles, fireworks and potion effects — declared by the owner, played by the plugin.
  2. 31SequencesChoreographed effects written in configuration: every token, every shape, camera shots, and the parameters that move a display.
  3. 32Displays and NPCsSolid objects, timed effects and player-shaped bodies, sent as packets and animated by the client.
  4. 33HologramsPacket holograms declared in configuration: styled lines, motion, pages per viewer, buttons and clicks.
  5. 34RagdollsA player's body cut into its parts and choreographed: thrown apart, danced, imported from Blockbench or Emotecraft.
  6. 35Mobs and modelsBlockbench models worn by mobs without a resource pack, and custom mobs from templates with skills, casts and phases.
  7. 36Sidebars, holograms, nametags and bordersEverything drawn on a player's screen, sent as packets and declared in configuration.
  8. 37In-world screens and utilitiesSpatial 3D menus, stages, the crate scene, guides, abilities, action bars, build zones and runtime commands.

Chapter 06

Gameplay

  1. 38SchedulesTimetables: what starts by itself, when, and what has to be true for it to happen.
  2. 39RegionsAreas of the world with rules attached: shapes, policies, enter and exit events, enforcement, the selector and outlines.
  3. 40Schematics and worldsSaving and pasting boxes of the world, regenerating arenas, creating worlds from any thread, the shared temporary world, and blocks and borders only some players see.
  4. 41ReplaysRecord a fight tick by tick from the server's own state and play it back as packet bodies, with a black box that keeps the last minute around everyone.
  5. 42PlayersOne claim registry, stays, cooldowns local and network-wide, alts, placed blocks, teleports, snapshots, clans, combat and heads.
  6. 43Client integrationWaypoints, HUD cooldowns and timers, teams, rallies, chat channels and keybinds on Lunar, Feather and the SurvivalCore client mod — without branching on the client.
  7. 44RewardsWhat a player earned: items, commands, money, experience and effects, with odds, conditions and a queue for whoever is not there.
  8. 45Crates and lootWhat comes out of a chest, a spawner or a broken block, Fortune for a plugin's own drops, and a key crate any plugin opens over its own catalogue.
  9. 46EconomyMoney for every Exylia plugin: one facade over the server's economies, prices any plugin can ask, boosters any plugin can feed, and how amounts are written.
  10. 47Minigame and network modulesArenas, escrow, trades, lobbies, modes, network messages, playtime, respawns and plugin hooks: the pieces game plugins share.
  11. 48LeaderboardsLeaderboards that keep themselves: kills, money or playtime, of all time and per day, week, month and year, offline players included.
  12. 49Lobby and economy toolsHotbars, double jump and jump pads, dialogues, the kit room and the economy ledger.

Chapter 07

Reference

  1. 50Public APIguideOne artifact the whole Exylia suite answers through: add it, look a service up, listen for its events.
  2. 51Module indexEvery module, what it is for, and where its entry point lives.
  3. 52CommandsEvery /exylialib subcommand, who may run it, and what it answers.
  4. 53Web editorEditing every Exylia plugin's files from the browser with /exylialib editor, and what a plugin registers for richer screens.
  5. 54Frequently asked questionsThe questions that come up when building on the library.