Skip to main content

Installation

Requirements​

RequirementMinimum Version
Sigma Orders & Auctions (Auction module enabled)Latest
Java21
Paper / Folia1.21.7
ViaVersionLatest (soft dependency — enables old-client auto-detection)
Floodgate / GeyserLatest (soft dependency — enables Bedrock auto-detection)

The addon's plugin.yml declares a hard dependency on SigmaOrders-Auction. If that plugin is not present and enabled, the QuickBuy 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.

2. (Optional) Install ViaVersion / Floodgate​

Without ViaVersion, old-client detection reads Bukkit's bridged protocol number, which reports the server's own version regardless of what the client actually speaks. With ViaVersion installed, the addon queries its API for the real client protocol, ensuring accurate routing. Without Floodgate, Bedrock clients are not detected and will receive the Dialog picker (which they cannot render).

3. Drop the Addon Jar​

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

plugins/
├── SigmaOrders-Auction.jar       ← core plugin (required)
├── ViaVersion.jar                ← recommended for old-client detection
├── Floodgate.jar                 ← recommended for Bedrock detection
└── quickbuy-addon-x.x.x.jar     ← this addon

4. 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 and player data directory:

plugins/
└── QuickBuyAddon/
    ├── config.yml
    ├── manifests/
    │   └── policy-cache.json     ← created after first manifest fetch
    └── playerdata/
        └── <uuid>.yml            ← created per player on first open

5. Configure the Addon​

Open plugins/QuickBuyAddon/config.yml and configure:

  • shop-size — how many slots each player's shop has (multiple of 9, 9–54)
  • command-aliases — additional /quickbuy aliases beyond the built-in /qb
  • slot-permissions — per-permission-group slot allotments for VIP tiers
  • messages — all user-facing text (fully translatable)

See Configuration for a full reference.

6. Set Up Slot Permissions (Optional)​

If you want different player groups to have different slot counts, add overrides to config.yml:

slot-permissions:
  default-slots: 9
  overrides:
    - permission: "quickbuy.slots.18"
      limit: 18
    - permission: "quickbuy.slots.54"
      limit: 54

Then assign the permissions in LuckPerms:

/lp group vip permission set quickbuy.slots.18 true
/lp group premium permission set quickbuy.slots.54 true

Verifying the Installation​

  1. Check the server log for [QuickBuyAddon] Connected to SigmaOrders AuctionManager.
  2. Also check for the manifest line, e.g. Manifest: max-tested=1.21.11, src=remote
  3. Run /quickbuy in-game — the shop GUI should open with green empty slots

File Layout​

plugins/
└── QuickBuyAddon/
    ├── config.yml              ← shop size, aliases, permissions, all messages
    ├── manifests/
    │   └── policy-cache.json  ← last successful manifest (used when GitHub is offline)
    └── playerdata/
        └── <uuid>.yml         ← per-player slot configurations (auto-managed)

Updating​

  1. Stop the server
  2. Replace the old jar with the new version
  3. Full restart (not /reload)
  4. config.yml is preserved — review the changelog for any new keys

See Also​