docs: align project status with official sync pipeline

Update the authoritative docs, guides, architecture notes, gap list, deployment guidance, handoff notes, and changelog to reflect the current Rust official resource sync boundary.
This commit is contained in:
2026-07-06 00:34:22 +08:00
parent 789402c887
commit 5e76ea4ae3
15 changed files with 661 additions and 345 deletions
+96 -7
View File
@@ -2,11 +2,11 @@
## 架构概览
BlueArchive Toolkit 支持多种部署模式:
BlueArchive Toolkit 的部署文档分为当前可用模式和目标模式:
1. **本地开发模式**:代码在本地,连接远程数据库
2. **单机部署**:所有组件运行在一台服务器
3. **分布式部署**多实例 API Server + 独立数据库服务器
1. **本地开发模式**:代码在本地,连接本地或远程数据库
2. **官方资源同步生产任务**:当前可用,运行 Rust `bat-official-sync --watch`
3. **完整单机/分布式部署**目标模式,等待 API Server、数据库迁移和 Web 实现后补齐。
---
@@ -98,9 +98,98 @@ REDIS_PORT=6379
---
## 模式 3生产环境部署
## 模式 3官方资源同步生产任务
待补充(Phase 6 实现 API Server 后)
当前可部署的生产任务是 Rust 官方资源同步 binary。API Server 和 Web 尚未实现,不能按完整服务端产品部署。
### 构建
```bash
cargo build --release -p bat-infrastructure --bin bat-official-sync
```
产物:
```text
target/release/bat-official-sync
```
### 目录约定
推荐生产状态目录:
```text
/var/lib/bluearchive-toolkit/official/
```
该目录会保存:
- `official-sync-snapshot.json`
- `official-bootstrap-cache.json`
- `official-download-manifest.json`
- `.official-sync.lock`
- 下载得到的官方资源文件
不要把输出目录设为:
- 已安装游戏客户端目录
- 官方启动器安装目录
- 开发机现有资源目录,例如 `/home/wanye/D/BlueArchive`
- Git 工作区目录
### 一次性检查
```bash
/opt/bluearchive-toolkit/bin/bat-official-sync \
--auto-discover \
--platforms Windows,Android \
--output /var/lib/bluearchive-toolkit/official \
--dry-run
```
### 常驻自动更新
```bash
/opt/bluearchive-toolkit/bin/bat-official-sync \
--auto-discover \
--platforms Windows,Android \
--output /var/lib/bluearchive-toolkit/official \
--watch
```
`--watch` 是 Rust 内部持久检查模式,默认每 1 小时执行一次检查。远端和本地一致时默认静默;有远端变化或本地文件损坏时自动下载或 repair,并输出 JSON report。
### systemd service 示例
systemd 只负责进程守护,不负责定时逻辑:
```ini
[Unit]
Description=BlueArchiveToolkit official resource sync
After=network-online.target
Wants=network-online.target
[Service]
Type=simple
User=bat
Group=bat
ExecStart=/opt/bluearchive-toolkit/bin/bat-official-sync --auto-discover --platforms Windows,Android --output /var/lib/bluearchive-toolkit/official --watch
Restart=on-failure
RestartSec=30
StateDirectory=bluearchive-toolkit
NoNewPrivileges=true
[Install]
WantedBy=multi-user.target
```
如果业务层需要热更新、热重载或发布新资源,应该由上层服务在观察到 JSON report 或 snapshot 变化后决定。Rust 同步进程只负责拉取、校验和维护本地状态。
---
## 模式 4:完整生产环境部署
待补充(API Server、数据库迁移和 Web 实现后)
---
@@ -172,4 +261,4 @@ docker exec bat-redis redis-cli ping
---
更多问题请查看 [故障排查指南](./troubleshooting.md)(待创建)
更多当前状态请查看 `CURRENT_STATUS.md``docs/reports/CURRENT_GAPS.md` 和本文件中的健康检查命令。