Files

85 lines
2.7 KiB
Markdown
Raw Permalink Normal View History

2026-03-10 23:54:23 -04:00
# Auction House
---
The **Auction House** is a global player marketplace where players can list items, bid against each other, and purchase instantly. Combined with a built-in currency system, it creates a full economy for your server.
---
## Currency System
2026-03-11 17:11:57 -04:00
CNPC+ has a **built-in currency** — fully configurable name, starting balance, and max cap. Profile-persistent across character slots. Integrates with Vault-compatible economy plugins. Tracks lifetime earned/spent per player. Full scripting API support.
2026-03-10 23:54:23 -04:00
---
## Selling
2026-03-11 17:11:57 -04:00
List items with a **Starting Price** for bidding and an optional **Buyout Price** for instant purchase. Auctions last **24 hours** by default. Configurable listing fee, sales tax, and minimum listing price.
2026-03-10 23:54:23 -04:00
---
## Bidding
2026-03-11 17:11:57 -04:00
Bids must meet a **minimum increment** above the current bid (default 5%, configurable). **Snipe Protection** extends auctions on last-second bids. Outbid currency is automatically refunded.
2026-03-10 23:54:23 -04:00
---
## Buyout
2026-03-11 17:11:57 -04:00
Instant purchase at the seller's Buyout Price. If you're the highest bidder, you only pay the **difference** between your bid and the buyout.
2026-03-10 23:54:23 -04:00
---
## My Trades
2026-03-11 17:11:57 -04:00
Manage all auction activity in one screen: Active Listings, Active Bids, and Ready to Claim. Cancel your own listings (items returned as claims, configurable cancellation penalty if bids exist, default 10%).
2026-03-10 23:54:23 -04:00
2026-03-11 17:11:57 -04:00
> Claims expire after **20 days**.
2026-03-10 23:54:23 -04:00
---
## Search & Sorting
2026-03-11 17:11:57 -04:00
Search by **item name** and **seller name** simultaneously. Listings show item attributes and stats. Sort by: Newest, Ending Soon, Price (Low/High), Most Bids.
2026-03-10 23:54:23 -04:00
---
## Notifications
2026-03-11 17:11:57 -04:00
Instant notifications for: item sold, outbid, auction won, auction expired, claim ready. Offline players receive a **claim summary** on login.
2026-03-10 23:54:23 -04:00
---
## Trade Slots
2026-03-11 17:11:57 -04:00
Players get limited **Trade Slots** (default 8) shared across listings, bids, and pending claims. Expandable via permissions (`customnpcs.auction.trades.X`, up to 45, or `.*` for unlimited).
2026-03-10 23:54:23 -04:00
---
## Item Blacklist
2026-03-11 17:11:57 -04:00
Block items by: specific registry name, wildcard patterns, entire mods, or NBT tags. **Soulbound** and **Profile-Slotbound** items are always blocked.
2026-03-10 23:54:23 -04:00
2026-03-11 17:11:57 -04:00
**Commands:** `/kam auction blacklist add|remove|list|reload|check`
2026-03-10 23:54:23 -04:00
---
## Auctioneer Role
2026-03-11 17:11:57 -04:00
Set the Auctioneer role on any NPC — players interact to open the full Auction House.
2026-03-10 23:54:23 -04:00
---
## Admin Tools
2026-03-11 17:11:57 -04:00
**Admin GUI** with three tabs: Listings (view/search/stop/cancel), Create (server listings with custom seller/prices/durations), Claims (global admin pool).
2026-03-10 23:54:23 -04:00
2026-03-11 17:11:57 -04:00
**Commands:** `/kam auction open` (player), `/kam auction list [page]` and `/kam auction view <player>` (admin). Configurable per-type auction logging.
2026-03-10 23:54:23 -04:00
---
## Scripting API
2026-03-11 17:11:57 -04:00
All auction events are **cancelable**: CreateEvent, BidEvent, BuyoutEvent, CancelEvent, ClaimEvent.
2026-03-10 23:54:23 -04:00
---