config.yml

name: "AICoach"
# Where to look for replays
replay_folder: "C:\\Users\\student\\Documents\\StarCraft II\\Accounts\\1234567568\\2-S2-1-123456\\Replays\\Multiplayer"
# Game shorter than this will be ignored and the replays deleted when the clean option is on
instant_leave_max: 50
# Look for new replays every X seconds
deamon_polling_rate: 1

# Audiomode, one of "full", "text", "in", "out"
audiomode: "text"
# Index of the audio device as returned by pyaudio
microphone_index: 2
# Which model to use from openwakeword
oww_model: "hey_jarvis"
# Sensitivity of the wake word
oww_sensitivity: 0.65
# which speech recognition model to use from huggingface speech-to-text
speech_recognition_model: "openai/whisper-large-v3"
# Configure speech recognition from microphone
recognizer:
  # minimum audio energy to consider for recording
  energy_threshold: 500
  # seconds of non-speaking audio before a phrase is considered complete
  pause_threshold: 0.3
  # minimum seconds of speaking audio before we consider the speaking audio a phrase - values below this are ignored (for filtering out clicks and pops)
  phrase_threshold: 0.3
  # seconds of non-speaking audio to keep on both sides of the recording
  non_speaking_duration: 0.1
  # how much of the captured audio must be detected as voice for transcribing to start
  speech_threshold: 0.3
# Hotkey to call up the AI coach prompt when run in text-in mode
wake_key: "ctrl+alt+w"
# Determines whether you can interact with AI coach; if False, AI coach will handle replays but won't ask for your input
interactive: True

# Configure the "student" - the player using AI coach
student:
  name: "studentname"
  race: "Terran"
  # Emoji to represent the student in output
  emoji: ":man_technologist:"
  # URL pointing to your public sc2replaystats profile's map stats (optional)
  sc2replaystats_map_url:

# Address of the SC2 game client server
sc2_client_url: "http://127.0.0.1:6119"

# AI coach backend, use "Mocked" for testing without an AI backend
aibackend: "OpenAI"
# which GPT model to use for OpenAI Assistant API
gpt_model: "gpt-4o-2024-08-06"
# Cost per prompt token
gpt_prompt_pricing: 0.0000025
# Cost per completion token
gpt_completion_pricing: 0.000010

# Which events should the AI coach react to
coach_events:
  - game_start
  - wake
  - new_replay

# Integration with OBS; Faster detection of new game started but requires manual OBS setup
obs_integration: False
# relative path to screenshot file which OBS takes when the map is loading
screenshot: "obs/screenshots/_maploading.png"
# Where tesserocr should look for the tesseract data
tessdata_dir: "C:\\Program Files\\Tesseract-OCR\\tessdata"

# The battle.net region we play on
blizzard_region: "EU"
# delta in MMR between player and potential opponent to consider opponent for barcode unmasking
rating_delta_max: 500
# maximum time since last played game to consider opponent for barcode unmasking in seconds
last_played_ago_max: 2400

# Current ladder season
season: 61
# Maps in the current ladder pool
ladder_maps:
 - Neon Violet Square LE
 - Amygdala
 - Ultralove
 - Abyssal Reef LE
 - Frostline LE
 - Ley Lines
 - Whispers of Gold
 - King's Cove LE
 - El Dorado

# Configure which replay fields to include per default when reading replays
default_projection:
  _id: 1
  date: 1
  game_length: 1
  map_name: 1
  players.avg_apm: 1
  players.highest_league: 1
  players.name: 1
  players.messages: 1
  players.pick_race: 1
  players.pid: 1
  players.play_race: 1
  players.result: 1
  players.scaled_rating: 1
  players.stats: 1
  players.toon_handle: 1
  players.build_order.time: 1
  players.build_order.name: 1
  players.build_order.supply: 1
  players.build_order.is_chronoboosted: 1
  real_length: 1
  stats: 1
  unix_timestamp: 1

# Name of the MongoDB database where the replay collection is stored
db_name: "SC2"