Installation

BranchPy requires Python 3.11+ and is distributed as a pre-release package containing an installer, a Python wheel, and a VS Code extension.

Requirements

• Python 3.11 or newer
• A Ren’Py project with a game/ folder (7.x or 8.x)
• VS Code (optional — for the Control Center UI)

Install via the guided installer (recommended)

Unzip your BranchPy pre-release package, then:

Windows: double-click install_branchpy.bat

macOS / Linux:

chmod +x install_branchpy.sh
./install_branchpy.sh

The installer:

1. Detects Python and checks the version.
2. Installs (or upgrades) the BranchPy package automatically.
3. Detects VS Code and offers to install the extension.
4. Walks you through your first analysis.

Upgrading: run the installer again. It detects your existing version and upgrades silently — no manual uninstall needed.

Verify the installation

python -m branchpy --version

First run

Once installed, open your Ren’Py project root in VS Code, open the BranchPy Control Center, and click Analyze.

Or from the CLI:

python -m branchpy --project /path/to/my-game analyze --open

→ Continue: Quick Start in 3 Minutes