Skip to main content

Installation

Requirements​

RequirementMinimum Version
Sigma Orders & Auctions (Orders module enabled)Latest
Java21
Paper / Folia1.21

The addon's plugin.yml declares a hard dependency on SigmaOrders-Auction. If that plugin is not present and enabled, or its Orders module is off, SellGui Addon logs an error and disables itself on startup.

Installation Steps​

1. Install Sigma Orders & Auctions​

Ensure the core plugin is installed and running, with the Orders module enabled, before adding this addon. Keep the core plugin and this addon on matching, up-to-date builds.

2. Drop the Addon Jar​

Place sell-gui-addon-x.x.x.jar into your server's plugins/ folder.

plugins/
├── SigmaOrders-Auction.jar       ← core plugin (required)
└── sell-gui-addon-x.x.x.jar      ← this addon

3. Start the Server​

Full restart required

Always do a full server restart, not /reload, when installing or updating this addon. Paper's plugin remap cache can serve a stale jar if you use /reload.

On first start, the addon generates its configuration file:

plugins/
└── SellGuiAddon/
    ├── config.yml
    └── manifests/
        └── policy-cache.json     ← created after first manifest fetch

4. Configure the Addon​

Open plugins/SellGuiAddon/config.yml and review:

  • enabled — turn the sell GUI on or off
  • match-strategy — how orders are picked (BEST_PRICE, FIFO, ANY)
  • command-aliases — additional aliases beyond the built-in /sell
  • messages — all user-facing text (fully translatable)

See Configuration for a full reference.

5. Set Permissions (Optional)​

Both permissions default to true for players, so no setup is needed for a default install. To restrict the sell GUI to specific groups, deny sellgui.use by default and grant it to those groups:

/lp group default permission set sellgui.use false
/lp group vip permission set sellgui.use true

Remember that players also need the core sigmaorders.fulfill permission to deliver to orders.

Verifying the Installation​

  1. Check the server log for [SellGuiAddon] Connected to SigmaOrders OrderManager/ItemManager.
  2. Also check for the manifest line, e.g. Manifest: max-tested=..., src=remote
  3. Run /sell in-game — a 54-slot GUI with a red RETURN ALL button and a green SELL button should open

File Layout​

plugins/
└── SellGuiAddon/
    ├── config.yml              ← enabled flag, aliases, match strategy, all messages
    └── manifests/
        └── policy-cache.json   ← last successful manifest (used when GitHub is offline)

Updating​

  1. Stop the server
  2. Replace the old jar with the new version (and update the core plugin if the release notes say so)
  3. Full restart (not /reload)
  4. config.yml is preserved. Keys added in a newer version fall back to their built-in defaults even if they are missing from your file, so an update never breaks an existing config

See Also​