config.toml

# This file contains the default configuration for the game.

# You can use the following directive in the start of a new config file to override configuration locally while keeping
# this file up to date from upstream:
#   include = "config.toml"

[server]
# The listen address for the game server.
host = "127.0.0.1"
port = 8080

[database]
# The SQLite database file name from which local card packs are loaded.
file = "cards.db"

[game]
# Maximum length for game titles.
title.max_length = 32
# Format for the default game title. {USER} is replaced with creator's username.
title.default = "{USER}'s game"
# A list of regexes that will be disallowed in game titles.
title.blacklist = []

# The minimum and maximum length of game passwords, and the length of the default generated password.
password.length = { default = 0, min = 0, max = 100 }
# The characters used in generated passwords.
password.characters = "ABCDEFGHJKLMNPQRSTUVWXYZ23456789"

# Whether or not games are public by default.
public.default = false
# Whether or not games can be made public.
public.allowed = true
# Whether or not games must be public.
public.required = false

# How many seconds before a player is deemed idle and skipped.
think_time = { default = 60, min = 5, max = 600 }
# How many seconds between the winner being chosen and the next round starting.
round_end_time = { default = 8, min = 2, max = 30 }
# How many rounds a player can idle before they are kicked.
idle_rounds = { default = 2, min = 1, max = 5 }

# How many blank cards are included in the deck.
blank_cards.count = { default = 0, min = 0, max = 40 }
# The maximum length of blank card text in characters.
blank_cards.max_length = 200
# A list of regexes that will be disallowed in blank cards.
blank_cards.blacklist = []

# How many players are allowed in a game.
player_limit = { default = 10, min = 3, max = 20 }
# How many points to win a game.
point_limit = { default = 8, min = 1, max = 50 }

# How many cards are in a player's hand after drawing.
hand_size = 10

# The characters from which game codes are constructed.
code.characters = "ABCDEFGHJKLMNPQRSTUVWXYZ23456789"
# The length of game codes.
code.length = 5

[users]
# The characters allowed in usernames. Must be a valid string to put inside a regex character class in both Python and
# JavaScript; -, ] and \ have a special meaning and must be escaped to represent theirselves.
# Note that the frontend currently doesn't provide a sensible error message if this is changed.
# Leading, trailing and consecutive spaces are always disallowed.
username.characters = "a-zA-Z0-9_\\- "
# The minimum and maximum lengths of usernames.
username.length = { min = 3, max = 32 }
# A list of regexes that will be disallowed in usernames.
username.blacklist = []

# How many seconds before a disconnected user is kicked from their game, regardless of game state.
disconnect_kick_time = 120
# How many seconds before a disconnected user is forgotten, i.e. the username is freed.
disconnect_forget_time = 300

[chat]
# The maximum length of chat messages in characters.
max_length = 1024
# A list of regexes that will be disallowed in chat.
blacklist = []

[debug]
# Whether or not to enable various debug features, such as DEBUG level logging.
enabled = false
# How many bots to keep running. Bots join random public games and play randomly.
bots.count = 0
# How many players the bots will target to have per game. If all games are near this limit, bots may opt to create new
# games.
bots.game_size = 5
# Whether or not bots will create games or just wait for humans to create ones.
bots.create_games = true
# Parameters for the normal distribution that determines the time bots take to play.
bots.play_speed = { mean = 5.0, stddev = 2.0 }
# Raw game options that bots will set on games they host.
bots.game_options = {}