Skip to main content

Installation

Requirements​

RequirementMinimum Version
Sigma Orders & Auctions (core plugin, Auction module enabled)Latest
Java21
Paper / Spigot / Folia1.21
ProtocolLibLatest (soft dependency - overlay disabled without it)
PlaceholderAPILatest (soft dependency - placeholders disabled without it)

The addon's plugin.yml declares a hard dependency on SigmaOrders-Auction. If that module isn't present and enabled, the Worth Addon disables itself on startup.

Installation Steps​

1. Install Sigma Orders & Auctions​

Ensure the core plugin is installed, running, and the Auction module is enabled before adding this addon.

Without ProtocolLib, the addon still loads and /worth toggle//worth reload still work, but the tooltip overlay - the addon's only real feature - is disabled.

3. Drop the Addon Jar​

Place WorthAddon.jar into your server's plugins/ folder.

plugins/
├── SigmaOrders-Auction.jar   ← core plugin (required)
├── ProtocolLib.jar           ← recommended, enables the tooltip overlay
└── WorthAddon.jar            ← this addon

4. Start the Server​

On first start, the addon generates its configuration file:

plugins/
└── WorthAddon/
    ├── config.yml
    └── toggles.yml           ← created after the first player toggle

5. Configure the Addon​

Open plugins/WorthAddon/config.yml and configure:

  • Cache refresh interval - how often worth is recalculated
  • Lore lines - the tooltip text shown for matching items and shulker box contents
  • Container restrictions - which real container types are allowed to show the overlay

See Configuration for a full reference.

6. Reload or Restart​

Apply your configuration changes with:

/worth reload

or restart the server.

Verifying the Installation​

  1. Check the server log for Worth Addon enabled - tracking item worth from active order listings.
  2. If ProtocolLib is installed, you should also see ProtocolLib found - hover-tooltip worth overlay enabled.
  3. Create an order listing for an item, then hover that item in your inventory - a "Worth" line should appear in its tooltip

File Layout​

plugins/
└── WorthAddon/
    ├── config.yml          ← cache, logging, toggle defaults, and lore settings
    └── toggles.yml         ← per-player overlay on/off preference (auto-managed)

The addon stores no other data - all order/listing data is read live from the Sigma Orders & Auctions core plugin.

Updating​

  1. Stop the server
  2. Replace WorthAddon.jar with the new version
  3. Start the server - configuration is preserved automatically
  4. Review the changelog for any new config keys

See Also​