Install and Build instructions

Requirements

Windows

• Microsoft Visual C++ 14.0 or greater may be required to build the executable. Get it with Microsoft C++ Build Tools.

Linux

• You need to be part of the input and tty groups, as well as have permissions on a few files and folders.
  If you are missing from either groups, the install script will take care of it on its first run, but you'll need to restart your session.

WSL

If using WSL to test on Windows, you might need to tell uv to point to a different environment than .venv. You can point to your system environment by running:

export UV_PROJECT_ENVIRONMENT=$(python3 -c "import sysconfig; print(sysconfig.get_config_var('prefix'))")

Read more: https://docs.astral.sh/uv/concepts/projects/config/#project-environment-path

Or you can create a separate environment then activate it:

uv venv .venv-linux
source .venv-linux/bin/activate

All scripts pass the --active flag to make sure the active environment is used.

All platforms

• uv
• PowerShell is used to run all the scripts.
  • This is needed even for Windows, as the bundled PowerShell 5.1 is too old.
• VSCode is not required, but highly recommended.
  • Everything already configured in the workspace, including Run (F5) and Build (Ctrl+Shift+B) commands, default shell, and recommended extensions.
  • PyCharm is also a good Python IDE, but nothing is configured. If you are a PyCharm user, feel free to open a PR with all necessary workspace configurations!

Install and Build steps

• Run ./scripts/install.ps1 to create/update a virtual environment and install all dependencies.
• Run the app directly with ./scripts/start.ps1 [--auto-controlled] [--minimized].
  • Or debug by pressing F5 in VSCode.
  • The --auto-controlled flag is passed when AutoSplit is started by LiveSplit.
  • The --minimized flag starts the app minimized to the taskbar. Also intended for use with the LiveSplit integration.
• Run ./scripts/build.ps1 or press CTRL+Shift+B in VSCode to build an executable.
• Optional: Recompile resources after modifications by running ./scripts/compile_resources.ps1.
  • This should be done automatically by other scripts