Skip to main content

Worth Addon - Overview

The Worth Addon is a small companion plugin for Sigma Orders & Auctions that shows players a live "worth" estimate for items they're holding or have stored - computed directly from active order and auction listings. It has no GUI of its own: its entire feature surface is a hover-tooltip overlay plus a single toggle command.

What It Does​

Instead of relying on a static price list, the addon continuously aggregates every active, undelivered order listing into a per-item-variant snapshot (price, listing count, best/worst price). When a player hovers an item that matches one of those variants - in their inventory, a chest, a shulker box, and other real containers - a "Worth" line is appended live to that item's tooltip on the client. The player's actual item data is never touched; the line is injected purely at the packet level.

Key Features​

Live Worth Calculation​

  • Aggregated from real listings - Worth is computed from active SigmaOrders order listings, not a static price table
  • Per-variant pricing - Items are matched by material and enchantments/custom-item id, since an enchanted item isn't the same tradeable good as a plain one
  • Configurable refresh interval - A background cache recalculates worth on a fixed interval (default every 10 seconds) instead of hitting the orders API on every tooltip
  • AVG / MIN / MAX calculation modes - Choose whether {price} shows the average, lowest, or highest active listing price

Hover Tooltip Overlay​

  • Requires ProtocolLib - if it's not installed, the addon still runs (commands/placeholders work) but the overlay itself is disabled
  • Injects a configurable lore line into matching items' tooltips without ever mutating the real item
  • Shulker box contents worth - A shulker box itself is never "worth" anything, but the addon reads its stored contents and shows the combined worth of whatever matching items are packed inside, without needing to open it
  • Container restriction - By default, the overlay only appears in real, world-backed containers (chest, barrel, furnace, etc.), so it never leaks into other plugins' custom shop/menu GUIs that happen to be built on a vanilla inventory
  • Creative-mode safe - The overlay is never shown to creative-mode players, avoiding packet desyncs with the client's self-authoritative creative inventory

Per-Player Toggle​

  • /worth toggle lets each player turn the overlay on or off for themselves
  • Preference is persisted to toggles.yml and survives restarts
  • Falls back to the configured toggle.default-enabled value for players who have never toggled

PlaceholderAPI Integration​

  • Exposes %worthaddon_status% (Enabled/Disabled) and %worthaddon_enabled% (true/false) for the requesting player
  • Only registers if PlaceholderAPI is installed

Resilience​

  • Automatically reconnects to the Sigma Orders API if the core plugin reloads
  • Disables itself cleanly if Sigma Orders & Auctions (specifically the Auction module) isn't present

How It Works​

  1. A cache refresh task runs on a fixed interval, pulling all active (non-cancelled, non-completed) order listings with undelivered remainder from the Sigma Orders API
  2. Listings are aggregated per item variant (material + enchantments + custom-item id) into average/best/worst price and listing count
  3. When the server sends an inventory/slot packet to a player, the addon intercepts it and checks each item against the cached snapshot
  4. If a match is found (and the player hasn't opted out via /worth toggle), a worth lore line is appended to the tooltip the client renders
  5. Inventory clicks/drags trigger a forced refresh packet so the overlay updates immediately rather than waiting for the next natural packet

Requirements​

RequirementDetails
Sigma Orders & AuctionsRequired - specifically the SigmaOrders-Auction module; the addon will not enable without it
Java21+
Paper / Spigot / Folia1.21+
ProtocolLibSoft dependency - required for the tooltip overlay; without it the addon loads but shows nothing
PlaceholderAPISoft dependency - only needed for the %worthaddon_*% placeholders

Quick Start​

  1. Install Sigma Orders & Auctions with the Auction module enabled, plus ProtocolLib
  2. Drop WorthAddon.jar into your plugins/ folder and start the server
  3. Hover an item that matches an active order listing - a "Worth" line appears in its tooltip
  4. Players can run /worth toggle to opt out of seeing the overlay

Next Steps​