Getting started

Introduction

What ExyliaScreens is, the three forms of menu it reads from files, and how this documentation is organised.

ExyliaScreens is a menu plugin with no Java and no resource pack. You write menus as files in plugins/ExyliaScreens/, and the plugin opens them with commands, items, clicks and joins. It is a DeluxeMenus replacement, plus two forms DeluxeMenus cannot draw. It is built on ExyliaLib's menu, screen and spatial engines.

It is a premium plugin, installed through a licence loader. See Installation.

Three forms, one id

A menu is one file, and the folder says what it is. The file name is its id.

Folder	Form	Client needed
`screens/<id>.html`	A screen: a full-screen menu with a mouse cursor, written in HTML and CSS.	Java 1.20.2 or newer
`menus/<id>.yml`	A chest menu: a normal chest window.	Any client
`spatial/<id>.yml`	A 3D menu: panels standing in the world in front of the player.	Java 1.21.4 or newer

All three open the same way (command, aliases, permission, requirement, arguments) and run the same action lines. A menu can name another in fallback, the one a client that cannot draw it gets. You write the fallback yourself; nothing is generated. See Opening and fallbacks.

What is included

Screens

HTML and CSS menus with a cursor, tabs, grids, tooltips and state.

Chest menus

Slots with priority, conditions, per-click requirements and lists that fill themselves.

3D menus

Panels, grids and buttons standing in the world.

Opening and fallbacks

Commands, arguments, requirements, client limits and the fallback chain.

Actions and requirements

Every step a click can run and every expression a requirement can use.

Importer

Converting DeluxeMenus and zMenu menus, and what does not map.

Also: styling with theme.css, translations, values kept per player and items that open a menu.

Requirements

Requirement	Detail
Server	Paper 1.21.4 or newer (the `api-version` of `paper-plugin.yml`), or Folia (`folia-supported: true`).
ExyliaLib	Required. The README states 1.539.0 or newer.
PacketEvents	Needed by ExyliaLib; screens and 3D menus are drawn with packets.
Optional	PlaceholderAPI.

Screens and 3D menus are not drawn for Bedrock players or for Java clients older than the numbers above. Chest menus are drawn for everybody.

The ExyliaLib reference

The full markup, CSS, expression and motion reference for screens belongs to ExyliaLib (its docs/screens.md, with the markup reference and the cookbook next to it). It is not reproduced here: this documentation covers what a server owner needs, and links the concepts. Chest menu lists, pages and fillers are on ExyliaLib: Menus. Run /exylialib screens gallery in game to see every screen element, ready to copy.

How to read this documentation

Start with Installation and First steps. Menus covers each form and everything a click can do; Server is the importer; Reference lists commands, permissions, placeholders, configuration and the FAQ.

Something missing on this page? Tell us on Discord