Local Source & Development Environment

For reading the source, debugging plugins, or submitting PRs. End users should install the official version from Steam.

---

1. Requirements

Item	Requirement
OS	Windows 10/11 64-bit
Python	3.11 or 3.12 (>=3.11,<3.13)
Package manager	uv (recommended)
GPU	NVIDIA recommended for local models; cloud engines can run without a discrete GPU

Example software repository path: F:\projects\trans-box (sibling of the website repo, or match your disk layout).

---

2. Install & Run

cd F:\projects\trans-box
uv sync
uv run transbox

Steam release packaging (developers):

uv run --with pyinstaller python scripts/build_steam_release.py

---

3. Browser Extension

Located in the repository root as browser-extension/:

1. Open chrome://extensions/ in Chrome/Edge
2. Enable Developer mode
3. Load unpacked → select that folder

Works together with the in-app Settings → Browser Captions (default port 8765).

---

4. Plugin Development Directories

Path	Purpose
extensions/	Official examples and local debug MODs
src/transbox/plugins/base.py	SPI base classes
src/transbox/plugins/manifest.py	mod.json parsing
src/transbox/plugins/registry.py	Scanning and loading
src/transbox/locales/zh-CN.json	UI string keys

After copying your MOD folder into extensions/, open Extension Workshop → Refresh in the app to load it (when running from source, %APPDATA%\transbox\extensions\ is also scanned).

---

5. How the Website Docs Are Built

Website repository trans-box-website:

pnpm install
pnpm run dev      # http://127.0.0.1:5173/
pnpm run build

Documentation source files live under docs/manual/ and docs/developer/.