Dev & Build
Build scripts
Windows .exe
.github\scripts\build_windows.ps1
MacOS .app Bundle
important
macOS Gatekeeper will not allow unsigned .app Bundles to run on other devices. When you build it yourself it will run on your Mac but if you share it, it will be blocked.
.github/scripts/build_macos.sh
CLI
Set the python directory as the root of your project if you are using PyCharm.
The python/.idea contains run configurations and other things that make setting up PyCharm easier for you.
Dev Setup
important
Execute these commands in the python directory
Windows
- Install uv.
- Install Python.
uv python install - Install dev dependencies.
uv sync --dev - Install pre-commit.
uvx pre-commit install - Verify the player runs on CLI by showing the help.
uv run adb-auto-player -h
MacOS
- Install Homebrew
- Install uv.
- Install Python.
uv python install - Install ADB
- Install Tesseract
- Verify the player runs on CLI by showing the help.
uv run adb-auto-player -h
Note:
UV creates a standard python virtual environment by default. Standard Unix command:
source .venv/bin/activate
More examples in UV Docs.
GUI Dev Build
- Follow all the steps in the CLI section
- Install Go
- Install Node
- (MacOS) Install Xcode
- Install Wails3
- Run the dev command from the root directory
wails3 dev