Getting started

Installation

The loader jar and the licence key, dependencies, the files the plugin writes and updating.

Getting the plugin

ExyliaScreens is a premium plugin. It ships through the Lukittu loader, so the file you install is the loader jar, Exylia-Screens-Loader.jar. It is not sold on BuiltByBit yet: request your licence key on the Exylia Discord, and manage your keys and servers at licenses.exylia.net. The loader checks the licence on every start and then hands over to the plugin.

Before you start

Plugin	What for
Paper 1.21.4+ or Folia	The server. Folia is supported.
`ExyliaLib`	Required (the README states 1.539.0 or newer). It provides the menu, screen and 3D engines, the actions, the economy and the database.
`packetevents`	Required by ExyliaLib. Screens and 3D menus are packets.
`PlaceholderAPI`	Optional. Its placeholders work in any text a menu shows.

ExyliaLib is installed for you

The loader's paper-plugin.yml does not require ExyliaLib on purpose: the loader installs it. On a server without ExyliaLib it downloads the newest release into plugins/ and a fresh install needs one more restart.

An economy plugin is only needed for menus that use [MONEY] or balance(); ExyliaLib's economy.yml decides which one.

Installing

Drop in the jar

Exylia-Screens-Loader.jar into plugins/, next to packetevents.

Start the server

The loader writes loader.yml. Stop the server, put your key in license_key and start it again. If the loader had to install ExyliaLib, restart once more.

Let it generate

The plugin writes its configuration and the example menus (see below).

Try it

Run /hub, or /screensadmin list. See First steps.

Generated files

All of them live in plugins/ExyliaScreens/.

File or folder	Contents
`loader.yml`	Written by the loader: `license_key` and `version`.
`config.yml`	Four settings. See Configuration.
`messages.yml`	The plugin's own messages, translated per language.
`screens/`	`<id>.html` screens, `theme.css`, per-screen `<id>.css` and your `custom.css`.
`menus/`	`<id>.yml` chest menus.
`spatial/`	`<id>.yml` 3D menus.
`open-items.yml`	Hotbar items that open a menu. See Items that open a menu.
`hud.yml`, `scoreboards.yml`, `bossbars.yml`, `hud/`	Text, sidebars and boss bars kept on screen. See HUD.
`lang/<code>/screens/<id>.yml`	Optional words per language for screens.
`database.yml`	Where per-player values are stored. Written by ExyliaLib (H2 by default).

The examples

On the first start the plugin writes example menus once: the hub, profile and shop screens with their chest menus (hub_chest, shop_chest), a players chest list, a 3D warps_3d menu, screens/theme.css and open-items.yml. They are written in the server's language when the plugin ships that translation, and a file that already exists is never replaced. Change or delete them freely: a marker file, .examples-written, lists what was written and stops it coming back. Delete a line from it to get that example again; an example added by an update still reaches your server.

Updating

Replace the loader jar and restart, or leave version on its default. Menu files are yours: the plugin reads them again within two seconds of being saved, added or removed, and never overwrites them.

Something missing on this page? Tell us on Discord