Skip to content

Settings Commands

Jump to bottom
Tyler Bloom edited this page Oct 7, 2022 · 2 revisions

Overview

Every setting discussed here can be adjusted in two places, the server's defaults and live tournaments. For adjusting your server's default tournament settings, you use the !settings <name> command. For adjusting the settings of an existing tournament, you can use the !t settings <name> command.

Note that adjusting your server's default settings will not affect live tournaments.

In both cases, you need the tournament admin role.

General Settings

Format

This command adjusts the format that is played in the tournament.

Note that (currently) this is mostly for record keeping. SquireBot doesn't verify the legality of a player's deck.

  • Name: format
  • Examples:
    • !settings format Pioneer
    • !t settings format Pioneer

Min & Max Deck Count

These commands adjust the minumum and maximum deck counts. For these to be meaningful, the setting to require deck registration need to be enabled too.

The example below is for a tournament where players are required to register a deck and are allowed an optional second deck.

  • Name: deck-count min and deck-count max
  • Examples:
    • !settings deck-count min 1
    • !t settings deck-count max 2

Require Deck

This command toggles if you are requiring deck registration.

  • Name: require-deck
  • Examples:
    • !settings require-deck true
    • !t settings require-deck true

Require Checkin

This command toggles if players need to check in before the tournament starts.

  • Name: require-checkin
  • Examples:
    • !settings require-checkin true
    • !t settings require-checkin true

Round Length

This command adjusts how long new match will last. The given number is the number of minutes a match will last.

Note that for live tournaments, adjusting this will not affect any existing match. If you wish to give a round more time, you need to use the time extension command.

  • Name: round-length
  • Examples:
    • !settings round-length 50
    • !t settings round-length 50

Pairing Settings

These settings adjust how pairings are made. Note that only match-size affects manual-match creation. All settings here must be prefixed with pairings.

Match Size

This command adjusts the number of players that will be in each new match. SquireBot will hold you to this even when manually creating matches.

Note that for live tournaments, adjusting this will not affect any existing match.

  • Name: match-size
  • Examples:
    • !settings pairings match-size 4
    • !t settings pairings match-size 4

Repair Tolerance

This command adjusts the repair tolerance used when creating new pairings.

What this tolerance is exactly is a bit technical and varies a bit for each algorithm. For a full description, see the documentation here. In short, SquireBot doesn't repair players that have played against each other in other matches. This tolerance controls how many individual pairs of players are allowed to be repaired. For example, there are 6 unique two-player pairs in a four-player pod. If the tolerance is one, then one pair (say players A and B) is allowed to have played against each other before, but no other pair of players is allowed to.

  • Name: repair-tolerance
  • Examples:
    • !settings pairings repair-tolerance 0
    • !t settings pairings repair-tolerance 0

Algorithm

This adjusts which algorithm is used when creating new pairings. There are currently only two options, Greedy and Branching. To read up on how they work, see the full documentation here.

The effects of these algorithms can be subtle.

  • Name: algorithm
  • Examples:
    • !settings pairings algorithm Branching
    • !t settings pairings algorithm Branching

Swiss

There is currently only one Swiss pairing setting, do-deckins. When enabled, all players need to check-in after their last match is certified before the next round can be paired

  • Name: do-checkins
  • Examples:
    • !settings pairings swiss do-checkins false
    • !t settings pairings swiss do-checkins false

Fluid

There are currently no fluid-specific settings.

Scoring Settings

Currently, SquireBot only supports "standard" scoring (similar to what you would see at most Magic tournaments). To read more about standard pairings, you about it here.

Since more scoring types will be supported in the future, you must prefix all these commands with scoring.

Match Points

These commands adjust how many match points a match win, loss, and draw are worth. The points for each of these do not need to be whole numbers.

The example below is how you would set your defaults to the standard point spread for 60-card, 1-v-1 magic.

  • Names:
    • match-win-points
    • match-draw-points
    • match-loss-points
  • Examples:
    • !settings scoring standard match-win-points 3 or !t settings scoring standard match-win-points 3
    • !settings scoring standard match-draw-points 1 or !t settings scoring standard match-draw-points 1
    • !settings scoring standard match-loss-points 0 or !t settings scoring standard match-loss-points 0

Game Points

These commands adjust how many game points a game win, loss, and draw are worth. The points for each of these do not need to be whole numbers.

The example below is how you would set your defaults to the standard point spread for 60-card, 1-v-1 magic.

  • Names:
    • game-win-points
    • game-draw-points
    • game-loss-points
  • Examples:
    • !settings scoring standard game-win-points 3 or !t settings scoring standard game-win-points 3
    • !settings scoring standard game-draw-points 1 or !t settings scoring standard game-draw-points 1
    • !settings scoring standard game-loss-points 0 or !t settings scoring standard game-loss-points 0

Bye Points

This command adjusts how many match points a bye is worth. Normally, this is the same as a match win, but you don't have to do that. Notably, changing the match win points will not change the bye points!

  • Name: bye-points
  • Examples:
    • !settings scoring standard bye-points 3
    • !t settings scoring standard bye-points 3

Include scores

Not all tournaments need or want to have all the scores the standard model provides. You can include/exclude them as you see fit. Excluded scores will not affect a player's placement in the standings.

There are a few acronyms to make things shorter to type. These are "MWP", "GWP" which are "match win percentage" and "game win percentage", respectively.

  • Names:
    • include-byes
    • include-match-points
    • include-game-points
    • include-mwp
    • include-gwp
    • include-opp-mwp
    • include-opp-gwp
  • Examples:
    • !settings scoring standard include-gwp false
    • !t settings scoring standard include-gwp false

Discord Settings

These commands adjust discord integration settings. You need to prefix all these commands with discord.

Pairings Channel

This command adjusts which channel will be used for sending match information when a match is paired.

  • Name: pairings-channel
  • Examples:
    • !settings discord pairings-channel #look-matches
    • !t settings discord pairings-channel #look-matches

Matches Category

This command adjusts which category match-specific channels are created in.

  • Name: matches-category
  • Examples:
    • !settings discord matches-category #match-channels
    • !t settings discord matches-category #match-channels

Create VC

This command toggles if voice channels will be created when a match is created.

  • Name: create-vc
  • Examples:
    • !settings discord create-vc true
    • !t settings discord create-vc true

Create TC

This command toggles if text channels will be created when a match is created.

  • Name: create-tc
  • Examples:
    • !settings discord create-tc false
    • !t settings discord create-tc false
Clone this wiki locally