Skip to main content

Round Events Configuration

Round Events occur at the start of rounds (or at the very start of the auction session if configured in start-events). They reveal information about the masked preview container items, allowing players to make informed bids.

Events are configured in the events/ folder as individual YAML (.yml) files.


Example Event Configs

1. Rarity Condition Reveal

name: "Common Exposure"
desc: "All common items are fully revealed!"
actions:
- type: "full"
selection: "all"
count: 0
rarity: "common"

2. Random Selection with Rarity Condition

name: "Reveal Five Rare"
desc: "Reveal 5 items that have rarity rare"
actions:
- type: "full"
selection: "random"
count: 5
conditions:
rarity: "rare"

Action Configurations

An event config is composed of a name, desc (description), and a list of actions to run.

Each action supports the following fields:

FieldTypeDefaultDescription
typeStringRequiredThe reveal type to apply:
- "type": Reveals only the item's custom type.
- "rarity": Reveals only the item's rarity.
- "size": Reveals only the item's layout size (width/height).
- "full": Fully reveals the item stack details.
selectionString"random"The selection strategy:
- "random": Randomly picks items up to the configured count.
- "all": Applies to all matching items.
countInteger0The number of items to reveal when using "random" selection.
rarityStringLegacy shorthand condition for filtering by rarity ID.
conditionsMapConditional rules to filter items. Supports:
- rarity: String rarity ID filter.
- min-total-size: Minimum grid space size filter (width × height).