本地源码与开发环境

用于阅读源码、调试插件或提交 PR。最终用户请从 Steam 安装官方版本。

---

1. 环境

项	要求
OS	Windows 10/11 64 位
Python	3.11 或 3.12（>=3.11,<3.13）
包管理	uv（推荐）
GPU	本地模型推荐 NVIDIA；云端引擎可无独显

软件仓库路径示例：F:\projects\trans-box（与官网仓库同级或按你的磁盘布局）。

---

2. 安装与启动

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

Steam 发行目录打包（开发者）：

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

---

3. 浏览器扩展

源码中位于仓库根目录 browser-extension/：

1. Chrome/Edge 打开 chrome://extensions/
2. 开启开发者模式
3. 加载已解压的扩展程序 → 选择该文件夹

与应用内 设置 → 浏览器字幕（默认端口 8765）配合使用。

---

4. 插件开发目录

路径	用途
extensions/	官方示例与本地调试 MOD
src/transbox/plugins/base.py	SPI 基类
src/transbox/plugins/manifest.py	mod.json 解析
src/transbox/plugins/registry.py	扫描与加载
src/transbox/locales/zh-CN.json	界面文案键名

把你的 MOD 文件夹拷进 extensions/ 后，在应用 扩展工坊 → 刷新 即可加载（源码运行时也可扫描 %APPDATA%\transbox\extensions\）。

---

5. 官网文档如何构建

官网仓库 trans-box-website：

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

文档源文件在 docs/manual/ 与 docs/developer/。