Skip to main content

Install GUIFX

Server requirements

  • Java 21
  • Spigot, Paper, or Purpur
  • Minecraft 1.21 through 1.21.11

GUIFX does not require ProtocolLib, NMS, packets, or a client mod.

First startup

  1. Place GUIFX-1.0.1.jar into your server’s plugins/ folder.
  2. Start the server once.
  3. GUIFX creates its working folders below plugins/GUIFX/.

The main folders are:

plugins/GUIFX/
├─ graphics/
├─ menus/
├─ themes/
├─ sounds/
├─ client-ui/
│ └─ profiles/
├─ examples/
└─ generated/

The release jar deliberately ships without development proof profiles or README clutter. The folders still appear on first startup, ready for your own content.

First commands

/guifx reload
/guifx validate
/guifx pack build

Start with the example menu/theme YAML files, then replace their artwork paths with your own files. GUIFX validation should be clean before you use the generated pack on a live server.