Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 72 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# ci.yml — tts-desktop PR 门禁:前端 build + cargo check(UI-4 Stage B3)
#
# 三条故意约束(不要"修"掉):
# 1) 只跑 `npm run build`(tsc + vite build),**不跑 `cargo build`**:
# Tauri 全量构建在 windows-latest 上首次 15~25min,PR 门禁扛不住;
# Rust 侧只做 `cargo check`(类型/借用/配置校验),真正出安装包留给 release
# (Stage C 本地 `npm run tauri build`)。
# 2) **顺序:cargo check 排在 npm run build 之后**。
# 实测(本机,2026-10-08):清掉 tts-desktop 的 cargo fingerprint 后,即使
# src-tauri/../dist 不存在,`cargo check` 仍 exit 0 —— check 不做前端资源嵌入,
# 所以这条顺序**不是**硬依赖;保持它是因为 (a) 前端 tsc 失败应当先报(秒级 vs 分钟级),
# (b) tauri.conf.json 的 build.frontendDist = "../dist",将来若把 check 换成
# `cargo build`/`tauri build`,dist/ 缺失会在 generate_context! 处直接报
# "this path doesn't exist",届时顺序就是硬依赖。
# 3) **不在 CI 跑 npm run compare-screenshots**:基准目录写死在
# D:/Codex/TTS图包制作维护工具/ui-design/round-03/shots(本机绝对路径,不在仓内),
# runner 上必不存在;五面截图 diff≤5% 属 Stage C 本机人工验收项,不上 CI。
name: CI

on:
pull_request:
push:
branches:
- main
- 'feat/**'

env:
CI: true

jobs:
build-check:
runs-on: windows-latest
steps:
- uses: actions/checkout@v4

- uses: actions/setup-node@v4
with:
node-version: 24
cache: npm

# 与 tts-toolkit 的 ci.yml 同款:package.json 无 packageManager 字段,
# corepack 对 npm 无效;显式装 npm 11.9.0 保证 npm ci 行为可复现。
- name: Pin npm
run: npm install -g npm@11.9.0

- name: Install
run: npm ci

# 前端构建(tsc 类型检查 + vite build);同时产出 dist/ 供下面的 cargo check 嵌入
- name: Build (frontend)
run: npm run build

# 缓存必须在 cargo check **之前**:actions/cache 在步骤开始时恢复,命中即省掉
# 依赖下载与全量编译;未命中时它注册 post 钩子,在 job 结束时保存本次产物。
# 用官方 actions/cache 而非 Swatinem/rust-cache(第三方 action,此处不需要它的
# target 目录拆分能力,少引一个供应链面)。
- name: Cache cargo registry + target
uses: actions/cache@v4
with:
path: |
~/.cargo/registry
~/.cargo/git
src-tauri/target
key: ${{ runner.os }}-cargo-${{ hashFiles('src-tauri/Cargo.lock') }}
restore-keys: |
${{ runner.os }}-cargo-

# Rust 侧类型校验 —— 必须在 Build 之后,见头注 2;--locked 保证 Cargo.lock
# 已随 Cargo.toml 一起提交(改了依赖/版本就要本地 cargo check 后提交锁文件)
- name: Cargo check
working-directory: src-tauri
run: cargo check --locked
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ src-tauri/target/

# UI-4 screenshot compare artifacts (round-03/shots is baseline, in git)
screenshots/current/
screenshots/compare-report.json

# Stage-D test outputs (mirror tts-toolkit convention)
.stage-d/
Expand Down
44 changes: 44 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Changelog

本文件记录 tts-desktop 的所有重要变更。

格式基于 [Keep a Changelog](https://keepachangelog.com/zh-CN/1.1.0/),
版本号遵循 [语义化版本](https://semver.org/lang/zh-CN/)。
组件名、CLI/路由名保留英文原文,其余叙述使用中文。

## [Unreleased]

> 占位:v0.1.0 之后的变更从这里开始累积。UI-4 收尾(动效三件套、Tauri 打包、
> 五面截图比对)尚未合并前的条目仍并入下面的 `[0.1.0]` 段。

## [0.1.0] - 待发布

> 占位:日期在打 tag `v0.1.0` 当天替换为 `YYYY-MM-DD`。

### Added / 新增

- **桌面工作台**:tts-toolkit 的桌面端工作台,实现 Round-03 蓝图设计
(工程图纸语法、双线图框、三层字族)。
- **五面**:总览(Overview)/代码(Code)/代理(Agent)/卡牌(Cards)/素材(Assets)。
- **九个可复用组件**:Frame、LayerNav、LegendBar、SignBlock、ConfirmGate、
ProcessStamps、JobSheet、EventFlow、SliceGrid。
- **hub 集成**:基于 fetch 的 HubClient(16 条路由)、经 EventSource 的 SSE 事件流、
版本兼容检查(与 tts-toolkit ≥ 0.7.0 可运行,≥ 0.8.0 特性齐备)。
- **确认门(ConfirmGate)**:所有危险操作(push、批量覆盖)一律经确认门,
并向 hub 传 `confirm: true`。
- **跨面联动**:素材面的死链卡片会禁用卡牌面的切片按钮。
- **设计令牌**:13 个 CSS 变量(双色底蓝图 + 4 个语义色 + 3 层字族 + 动效令牌),
全站不写死值。

### Requirements / 运行要求

- Windows 10 1809+(WebView2)
- tts-toolkit ≥ 0.7.0(≥ 0.8.0 特性齐备)
- Tabletop Simulator 已启动并加载存档(在线功能所需)

### Test baseline / 测试基线

- 针对真实 TTS + hub 的手工 UI 验证;暂无自动化 UI 测试(计划 v0.2.0)。

[Unreleased]: https://github.com/Smirk1921/tts-desktop/commits/main
[0.1.0]: https://github.com/Smirk1921/tts-desktop/releases/tag/v0.1.0
59 changes: 31 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,55 +2,58 @@

> TTS 图包工作台 — 蓝图纸语言桌面应用
>
> Round-03 设计方案([ui-design/round-03](https://github.com/Smirk1921/tts-toolkit))的 Tauri 2 + React 18 实现。
> v0.8.0 窗口 UI-1a:基座 + tokens.css + 5 骨架组件静态渲染。
> Round-03 设计方案([ui-design/round-03](https://github.com/Smirk1921/tts-toolkit))的 Tauri 2 + React 19 实现。
> v0.8.0 窗口 UI-4:⓪总览 + 动效三件套 + 应用图标 + Tauri 打包完工。

## 前置依赖

| 依赖 | 版本 | 说明 |
|---|---|---|
| Windows | **10 1809+ / 11** | 仅 Windows(v0.1.0 不做跨平台) |
| WebView2 Runtime | 任意 | Win10 1809+ 自带;缺失时启动钩子会在 stderr 警告,[点此下载](https://go.microsoft.com/fwlink/p/?LinkId=2124703) |
| WebView2 Runtime | 任意 | Win10 1809+ 自带;缺失时 HubLauncher 引导面板顶部红条提示 + 一键下载 |
| tts-toolkit (CLI) | **≥ 0.7.0** | 桌面应用经 `tts-hub` 与 TTS 通信;0.7.x 为降级模式(无 /v1/files 读写),0.8.0 解锁全功能 |
| Tabletop Simulator | 任意 Steam 版 | 联通功能需要;UI 空骨架可独立浏览 |
| Node.js | **24+** | 仅开发期需要 |
| Rust | **1.99+** (stable-msvc) | 仅开发期需要;`rustup` 安装 |
| VS Build Tools 2022 | C++ 工作负载 | 仅开发期需要;含 MSVC + Windows SDK |
| tts-toolkit (CLI) | ≥ 0.7.0 | **本窗口 (UI-1a) 不需要**;UI-1b 起需要开发期手动起 `tts-hub` |
| Tabletop Simulator | 任意 Steam 版 | **本窗口不需要**;UI-1b 联通验收时需要 |

## 快速开始(用户)

1. `npm install -g @smirk1921/tts-toolkit`(一次)
2. 在图包工作区目录起一个终端跑 `tts-hub`(保持窗口开启)
3. 运行安装包 `tts-desktop_0.1.0_x64-setup.exe`(或开发期 `npm run tauri dev`)
4. 应用检测到 39995 端口的 hub → 进入五面工作台;未检测到 → 引导面板(一键复制安装/启动命令)

## 快速开始(开发)

```bash
# 1. 装依赖
npm install
npm run tauri dev # 首次 cargo build 5-10 min
npm run dev # 浏览器调试(不开 Tauri 壳,HubLauncher 走 HTTP 探测降级)

# 2. 起 Tauri dev(首次 cargo build 5-10 min)
npm run tauri dev

# 浏览器调试(不开 Tauri 壳,UI-1a 阶段可选)
npm run dev
npm run build # tsc + vite build
npm run tauri build # 出 NSIS 安装包(src-tauri/target/release/bundle/nsis/)
npm run make-icons # 从 assets-src/icon.svg 重生成 src-tauri/icons/ 全套
npm run compare-screenshots # 五面截图 vs round-03 基准 pixelmatch 比对(需先截图入 screenshots/current/)
```

## 当前状态:UI-1a 骨架
## 当前状态:v0.1.0 候选(UI-4 完工)

完工交付物:
五面全部落地:

- [x] Tauri 2 + React 18 + TypeScript + Vite 骨架
- [x] `src/tokens.css` — round-03 §2 设计令牌(10 色彩 + 3 字体 + 4 字号 + 6 间距 + 6 动效 + 几何约束)
- [x] 5 骨架组件静态渲染:
- `<Frame>` 双线图框 + 图名栏 + 42px 网格底纹 + 状态行
- `<LayerNav>` 5 面切换(⓪①②③④ + 状态圆点)
- `<LegendBar>` 6 组全局图例
- `<SignBlock>` 右下会签栏(交付清单 / 出厂工序 / 操作)
- `<ConfirmGate>` 确认门(危险操作唯一组件,右下生长动效)
- [x] 5 路由占位(UI-2/3/4 填充真实内容)
- [x] WebView2 启动检测钩子(`src-tauri/src/lib.rs` setup hook)
- **⓪ 总览**:工序章五章横排(拉取→切片→拼版→校样→出厂,四态色)+ 待办清单 + 迷你文件树 + 事件流 + 四面状态磁贴,首进阶梯动效
- **① 代码**:pull → 条目级 diff(红绿块)→ CodeMirror 编辑(Lua/XML 高亮)→ 乐观锁保存(409 冲突条)→ 确认门写回游戏
- **② 代理**:Lua 直执 + 作业流水(hub 路由调用行)+ SSE 事件流(Error 整行红)
- **③ 卡牌**:牌堆列表 + 切片网格(14 真实格 + 虚线占位)+ 卡面预览 + 死链卡牌切片禁用
- **④ 素材**:台账表格(>500 行强制虚拟化,3500 行实测 renderedRows=41)+ 行内编辑 + 批量体检死链标红 + 导入预览

不在本窗口(后续窗口交付):
顶层机制:

- `src/hub/`(HubClient + SSE) — **UI-1b**
- ①代码 / ②代理 — **UI-2**
- ③卡牌 / ④素材 — **UI-3**
- ⓪总览 + 动效三件套 + 应用图标 + 打包 — **UI-4**
- 五层 Provider:HubContext → ConfirmGate → Sse → DeadLink → Dirty
- `<ConfirmGate>` 全站唯一危险确认组件(确认门生长动效 + 勾选"我已知晓")
- 跨面联动:④ 体检死链 → ③ 切片禁用;① 脏文件 → LayerNav ①蓝点;死链/差异 → ⓪红点
- hub 版本兼容:0.7.x 降级提示 / 0.8.0 全功能(`capabilitiesFromStatus`)
- 设计令牌:`src/tokens.css`(10 色彩 + 3 字体 + 4 字号 + 6 间距 + 6 动效 + 几何约束),全站引用无写死值

## 设计红线(round-03 §10)

Expand Down
32 changes: 32 additions & 0 deletions assets-src/icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading