Getting Started

1 · Install

Drop NxGui-1.0-BETA.jar and the PacketEvents jar into /plugins.
Restart. NxGui generates its data folder and seeds a complete example workspace — the NEXUS hub GUI — so you have something working immediately.
Try it: /nxgui run nexus.

2 · Activate your license

Activate your key once at the NxGui dashboard, then paste it into config.yml:

license-key: "YOUR_KEY_HERE"

One key, one server. The key also authenticates the editor session below.

3 · Open the editor

In game, run /nxgui editor. The plugin uploads your current workspace and gives you a one-time link — open it in any browser. The editor loads with your project already in it; no account, no setup.

4 · The edit → deploy loop

Design and wire logic in the editor. It autosaves continuously (locally + to your session every 25 s), and if you reload the page it restores your newest unsaved work.
Press Deploy. The resource pack is baked in your browser and pushed with the compiled screens.
The editor shows a command like /nxgui applyedit <uuid> — run it on the server. NxGui downloads everything, hot-reloads all screens, and reopens menus for anyone currently viewing them.
If the pack changed you'll be prompted — run /nxgui confirm within 30 seconds to apply the new resource pack to yourself.

Give the pack to everyone /nxgui confirm applies the pack to you for instant testing. For your players, host the generated plugins/NxGui/output/resourcepack.zip as your server resource pack (server.properties → resource-pack). Our free Resource Pack Host gives you a direct link + hash in one upload.

Working without the cloud

Prefer manual? Build Pack in the editor downloads the same artifacts: the resource pack zip and per-screen JSON files. Put the JSONs in plugins/NxGui/screens/, host the pack, then /nxgui reload. You can also Save/Load the whole project as a .nxproj.json file — that's your backup format and how premade GUIs are imported.