DUXPLIMA Documentation

market.yml

The player market's money, listing rules, capture, purchases, reports, moderation and categories.

Everything about the player market except its texts and menus. A key missing from your copy keeps its default. Numbers out of range are clamped; a misspelt mode falls back to its default and a negative amount to 0, with a warning in the console, so a typo never stops the market. /builders admin reload applies changes, except cache.syncSeconds.

enabled: true
economy:      # commission, listing fee, price range, payouts
listing:      # titles, live listings, copies, duplicates
capture:      # size limits, land, what a capture leaves out
purchase:     # builds per purchase, copies per buyer, blueprints
reports:      # auto-hide and who may report
moderation:   # seller bans and revokes
cooldowns:    # waits between a player's actions
text:         # the word filter
cache:        # several servers on one database
categories:   # the market's categories

The market's Discord posts are switched and routed in webhooks.yml, with events and moderationUrl; market.yml has no webhook section.

Block ids may leave out minecraft:, and a * in an id stands for any text: minecraft:*shulker_box is every shulker box. Amounts are in the server's money.

enabled and economy

KeyDefaultMeaning
enabledtrueOff: nothing can be captured, listed or bought; bought designs stay buildable
economy.commissionPercent10.0The market's share of each sale; uxmbuilders.market.commission.<n> sets it per player. Each listing keeps the rate its seller had when listing, so a change applies to new listings
economy.commissionAccountemptyA player name or UUID credited with commissions and listing fees; empty destroys them. An unknown name is warned about and treated as empty
economy.listingFee500.0What listing a design costs; uxmbuilders.market.fee.exempt pays nothing
economy.priceMin, priceMax100.0, 10000000.0The price range of a listing
economy.payoutINSTANTINSTANT: sellers are paid right after a sale. ON_JOIN: when they join or claim

listing

KeyDefaultMeaning
titleMin, titleMax3, 32Title length in characters, at most 64
descriptionMax160Description length, at most 512; 0 leaves the description out
maxLiveDefault3Live listings for a player without uxmbuilders.market.listings.<n>
limitedMaxCopies1000The most copies a limited listing may sell
allowUnlimitedtrueAllow listings with unlimited copies
priceChangeCooldownMinutes10Minutes between two price changes of one listing
dedupeGLOBALGLOBAL: a design is on sale once on the whole network. SELLER: once per seller, so co-owners may each list it
blockResaleOfPurchasedtrueA player cannot list a design they bought, in any rotation
lockLimitedEditionstrueA design that sold copies as a limited edition cannot be listed again by its seller

capture

KeyDefaultMeaning
requireBuildPermissiontrueAsk the protection plugins whether the seller may build on the whole selection
wildernessDENYA selection on nobody's land: DENY refuses it, ALLOW accepts it. Applies only while a protection plugin is active
maxWidth, maxLength, maxHeight64 eachThe largest selection
maxVolume131072The largest selection volume; uxmbuilders.market.size.<n> can lower it per player
minBlocks20The fewest blocks a design may have
trimAirtrueShrink the selection to the blocks it holds
blacklistPolicyAIRBlocks never sold become air (AIR), or refuse the capture (REJECT)
extraBlacklistemptyMore blocks never sold, on top of the market's own list and schematic.blacklist
stripValuablestrueWhile materials.enabled is off, turn valuableBlocks into air
valuableBlocksdiamond, emerald, netherite, gold, iron blocks, ancient debris, beacon, conduit, every shulker boxBlocks too valuable to hand out for free
allowFluidsfalseKeep water, lava and waterlogged blocks
normalizeemptyBlocks reset before they are sold, on top of the market's own table; see below
worlds.mode, worlds.listNONE, emptyNONE: every world. WHITELIST: only the listed worlds. BLACKLIST: all but them
maxSnapshotKilobytes2048The largest stored design, 16 to 65536
timeoutSeconds30How long reading a selection may take, 5 to 600

normalize maps a block to a state or to another block. An empty value turns one of the market's own entries off:

capture:
  normalize:
    minecraft:campfire: 'lit=false'
    minecraft:lava_cauldron: 'minecraft:cauldron'
    minecraft:composter: ''

What the market's own lists hold is on Selling a build.

purchase

KeyDefaultMeaning
buildsPerPurchase1Builds one purchase allows; -1 for any number
maxPerBuyerLimited1Copies of one limited listing a player may buy; 0 is no limit
maxPerBuyerUnlimited0The same for an unlimited listing
creditReturnMaxProgress10Cancelling a market build at or below this percent gives the build back
blueprintBoundtrueOnly the buyer may build from their blueprint

reports and moderation

KeyDefaultMeaning
reports.autoHideThreshold3Open reports that hide a listing until staff decide; 0 never hides
reports.minPlaytimeMinutes60Playtime a player needs before reporting
reports.dailyLimit5Reports one player may make in 24 hours; 0 is no limit
reports.noteMax100Longest report note kept, at most 255
moderation.onSellerBanHIDEWhat a market ban does to the seller's listings: HIDE or REMOVE
moderation.holdEarningsOfBannedtrueHold what the market owes a banned seller until the ban is lifted
moderation.revokeRefundFULLFULL: buyers get their money back when staff revoke a design. NONE: they do not. Either way the seller gives back what those sales earned, so with NONE the server keeps that money

cooldowns

Seconds between two actions of one player; 0 for none. uxmbuilders.market.bypass.cooldown skips them.

KeyDefaultBetween two
createSeconds300Listings
purchaseSeconds3Purchases
reportSeconds60Reports
reissueSeconds60Blueprints issued again for the same design

text and cache

KeyDefaultMeaning
text.blockedWordsemptyWords refused in titles, descriptions and sign text. Case, accents and digits standing for letters (b4d) are ignored, and letters written apart (b a d) still match; a word only matches a whole word, so class is never refused for ass
text.blockedPatternsemptyRegular expressions refused the same way; one that does not compile is skipped with a warning
cache.syncSeconds15How often other servers' market changes are read from a shared database, at least 5; read at startup

categories

categories:
  houses:
    display: '<green>Houses</green>'
    icon: OAK_DOOR
    order: 1
    permission: ''
KeyMeaning
The id (houses)What listings store: 1 to 32 letters, digits, - or _
displayThe name menus show, in MiniMessage
iconThe material of its tab
orderPosition in menus
permissionNeeded to list in it, to see it and to buy from it; empty for everyone

The shipped categories are houses, castles, farms and decorations. Their names follow general.language; the language switch rewrites them like any other text.

Related: Player market, webhooks.yml, config.yml