Getting started
What you need
| Needed | |
|---|---|
| Paper or Folia | Minecraft 1.21.4 or newer, on Java 21 or newer. |
| PacketEvents | Required. Use a build that supports your server's Minecraft version. |
| A license key | From your purchase. Activate it once at the dashboard. |
| Optional | Adds |
|---|---|
| PlaceholderAPI | Other plugins' placeholders in your text, and your NxGui variables in other plugins. |
| Vault and an economy plugin | The Money node and %nx_money%. |
| Geyser and Floodgate | Menus and HUDs for Bedrock players — see Bedrock. |
Install
- Put the NxGui jar and PacketEvents in
plugins/and start the server once. - Paste your key into
license-keyinplugins/NxGui/config.ymland restart. Without a valid key NxGui turns itself off.
Open the editor
Run /nxgui editor in game or from the console, then click Open the editor in chat. The link works once and the session lasts an hour — run the command again for a new one.
Make a menu
- On Projects, click New project and pick Scene.
- Click Add screen. Keep the kind on Shader-Safe unless you need Standard (which one?).
- Add elements with the + above the layers. Make buttons do things in the Logic tab — the Logic tutorials show how.
Deploy
- Click Build & Deploy (top right), then Build & deploy.
- Run the command shown under Run in game —
/nxgui applyedit <id>. Your changes are live at once, no restart. - Give players the resource pack: see Resource pack. To test a build yourself straight away, click Apply the resource pack in chat after
applyedit.
Open your menu
/nxgui open <project>:<screen>For example /nxgui open shop:main. The project part is the project's file name without .nxg — it's shown under the project's title. /nxgui list lists every menu as a clickable command.
To give a menu its own command, like /shop, fill in Open command in the screen's Preferences tab. Who can open it, on the same tab, sets a permission.