71 lines
3.6 KiB
Markdown
71 lines
3.6 KiB
Markdown
# Story 事件协作 Web 编辑器（M5）
|
||
|
||
设计：`docs/plans/2026-06-06-story-event-pipeline-design.md`（§5.1/§6, D1–D4/D8）
|
||
计划：`docs/plans/2026-06-08-story-event-M5-web-editor-plan.md`
|
||
|
||
少数人凭共享口令在网页里审校/编辑剧情事件 → 静态校验 + 剧本试走（零引擎）→ 一键编译
|
||
所有 confirmed 事件成 `.events.json` + `.i18n.tsv` 打包下载。校验/编译走 `ir_core`，与 CLI
|
||
（`ir_compile.py`）逐字节同口径。
|
||
|
||
## 起服务
|
||
|
||
```bash
|
||
cd tools/event_authoring/web
|
||
pip install -r requirements.txt
|
||
# Windows PowerShell: $env:STORY_WEB_PASSWORD="your-pass"
|
||
set STORY_WEB_PASSWORD=your-pass # 默认 story
|
||
uvicorn app:app --host 0.0.0.0 --port 8787
|
||
```
|
||
|
||
浏览器打开 `http://<host>:8787`，输入共享口令进入。
|
||
|
||
## 用法
|
||
|
||
1. **导入 IR**：右上「导入 IR」，粘贴单个或数组形式的 IR JSON（同 `samples/*.ir.json`）。
|
||
2. **审校/编辑**：左栏选事件 → 中栏分支树 → 点节点在右栏改文案/增删节点/下拉改分支/角色表/点位下拉。
|
||
3. **校验**：与 CLI 同口径（断链、选项无兜底、未登记 kind、未声明角色、点位缺失、out_ref 失效…）。
|
||
4. **试走**：从首节点走，点选项/掷随机/手选战斗胜负，实时累计银两/道具/友好度账面与结局。
|
||
5. **确认/丢弃**：改事件状态（pending/confirmed/discarded）。
|
||
6. **导出 confirmed**：编译所有 confirmed → `story_export.zip`；任一 confirmed 校验不过则整体拒绝。
|
||
|
||
导出后把 `{group}.events.json` 放进 `Assets/StreamingAssets/Story/Config/`（或 `Qiyu/` 子目录），
|
||
`{group}.i18n.tsv` 的韩文翻译合并进 `Assets/StreamingAssets/i18n/ko.tsv`。
|
||
|
||
## 数据
|
||
|
||
- 事件存 SQLite `story_events.db`（本目录，已 gitignore；末次写入生效，不做锁）。
|
||
- 词典 `../ir_dictionary.json`、点位集 `Assets/StreamingAssets/Story/PointSets/*.points.json` 只读引用。
|
||
|
||
## Docker 部署（M6）
|
||
|
||
单容器（FastAPI + 静态前端 + SQLite + 纯 Python 编译器）。构建上下文是
|
||
`tools/event_authoring`（需含 `ir_core`/`ir_dictionary.json`/`web`）。
|
||
|
||
```bash
|
||
cd tools/event_authoring/web
|
||
STORY_WEB_PASSWORD=your-pass docker compose up -d --build
|
||
# 或不用 compose：
|
||
# docker build -f web/Dockerfile -t story-event-web ..
|
||
# docker run -d -p 8787:8787 -e STORY_WEB_PASSWORD=your-pass \
|
||
# -v "$PWD/web/data:/data" \
|
||
# -v "$PWD/Assets/StreamingAssets/Story/PointSets:/pointsets:ro" story-event-web
|
||
```
|
||
|
||
- **卷**：`./data:/data`（SQLite 持久化，容器重建不丢事件，**勿删**）；
|
||
`…/PointSets:/pointsets:ro`（开发侧点位集只读；缺失时坐标校验降级为警告）。
|
||
- **环境变量**：`STORY_WEB_PASSWORD`（口令）、`STORY_WEB_PORT`（宿主端口，默认 8787）、
|
||
`STORY_DB_PATH`（默认 `/data/story_events.db`）、`STORY_POINTSETS_DIR`（默认 `/pointsets`）、
|
||
可选 `TZ=Asia/Shanghai`（否则 `updated_at` 按 UTC 显示）。
|
||
- **NAS + VPS**：NAS 跑容器，VPS 用反代/frp/Cloudflare Tunnel 把 8787 映射出去。点位集更新只需
|
||
同步文件到 NAS 的 `/pointsets` 卷路径，**无需重建镜像**。备份=拷 `data/story_events.db`。
|
||
|
||
## API（鉴权后）
|
||
|
||
`POST /api/login` · `GET /api/dictionary` · `GET /api/pointsets` · `POST /api/import` ·
|
||
`GET /api/events?status=` · `GET /api/events/{group}` · `PUT /api/events/{group}` ·
|
||
`POST /api/events/{group}/status` · `POST /api/validate` · `POST /api/export`
|
||
|
||
## 非目标（见设计）
|
||
|
||
容器化部署（M6）、多人账号/并发锁、手拖画布、引擎侧新语义、把坐标嵌进 events.json。
|