From 9fba8a319112fecff0f7be4f1061bd6641e0aef3 Mon Sep 17 00:00:00 2001 From: kdletters Date: Tue, 21 Apr 2026 00:45:58 +0800 Subject: [PATCH] docs: add story module package placeholder --- .../01_M0_M2_FOUNDATION_AND_AUTH.md | 3 +- server-rs/README.md | 40 +++++++++---------- server-rs/packages/module-story/README.md | 30 ++++++++++++++ 3 files changed, 52 insertions(+), 21 deletions(-) create mode 100644 server-rs/packages/module-story/README.md diff --git a/backend-rewrite-tasklist/01_M0_M2_FOUNDATION_AND_AUTH.md b/backend-rewrite-tasklist/01_M0_M2_FOUNDATION_AND_AUTH.md index 7d330a22..f78c5644 100644 --- a/backend-rewrite-tasklist/01_M0_M2_FOUNDATION_AND_AUTH.md +++ b/backend-rewrite-tasklist/01_M0_M2_FOUNDATION_AND_AUTH.md @@ -53,7 +53,8 @@ 交付物:[../server-rs/packages/module-auth/README.md](../server-rs/packages/module-auth/README.md) - [x] 创建 `packages/module-runtime` 交付物:[../server-rs/packages/module-runtime/README.md](../server-rs/packages/module-runtime/README.md) -- [ ] 创建 `packages/module-story` +- [x] 创建 `packages/module-story` + 交付物:[../server-rs/packages/module-story/README.md](../server-rs/packages/module-story/README.md) - [ ] 创建 `packages/module-combat` - [ ] 创建 `packages/module-inventory` - [ ] 创建 `packages/module-npc` diff --git a/server-rs/README.md b/server-rs/README.md index 67ae0db6..c2315cff 100644 --- a/server-rs/README.md +++ b/server-rs/README.md @@ -14,7 +14,7 @@ ## 2. 当前阶段说明 -当前目录已经完成以下七项初始化: +当前目录已经完成以下八项初始化: 1. 为新后端预留正式目录并把路径固定到仓库结构中。 2. 创建虚拟 workspace `Cargo.toml`,后续 package 会逐项挂入。 @@ -23,28 +23,28 @@ 5. 创建 `apps/spacetime-module/` 目录占位,固定 SpacetimeDB 主工程落位。 6. 创建 `packages/module-auth/` 目录占位,固定鉴权模块 package 落位。 7. 创建 `packages/module-runtime/` 目录占位,固定运行时状态基座模块 package 落位。 +8. 创建 `packages/module-story/` 目录占位,固定故事主循环模块 package 落位。 后续任务会继续在本目录内按顺序补齐: -1. `packages/module-story` -2. `packages/module-combat` -3. `packages/module-inventory` -4. `packages/module-npc` -5. `packages/module-progression` -6. `packages/module-quest` -7. `packages/module-runtime-item` -8. `packages/module-custom-world` -9. `packages/module-assets` -10. `packages/module-editor` -11. `packages/module-ai` -12. `packages/shared-contracts` -13. `packages/shared-kernel` -14. `packages/platform-auth` -15. `packages/platform-oss` -16. `packages/platform-llm` -17. `packages/spacetime-client` -18. `packages/tests-support` -19. `scripts/*` +1. `packages/module-combat` +2. `packages/module-inventory` +3. `packages/module-npc` +4. `packages/module-progression` +5. `packages/module-quest` +6. `packages/module-runtime-item` +7. `packages/module-custom-world` +8. `packages/module-assets` +9. `packages/module-editor` +10. `packages/module-ai` +11. `packages/shared-contracts` +12. `packages/shared-kernel` +13. `packages/platform-auth` +14. `packages/platform-oss` +15. `packages/platform-llm` +16. `packages/spacetime-client` +17. `packages/tests-support` +18. `scripts/*` ## 3. 已冻结边界 diff --git a/server-rs/packages/module-story/README.md b/server-rs/packages/module-story/README.md new file mode 100644 index 00000000..adeaac2f --- /dev/null +++ b/server-rs/packages/module-story/README.md @@ -0,0 +1,30 @@ +# module-story 独立模块 package 占位说明 + +日期:`2026-04-20` + +## 1. package 职责 + +`module-story` 是故事主循环模块 package,后续负责: + +1. `story_session`、`story_event` 等故事会话状态模型 +2. story action 主循环与状态推进规则 +3. `currentStory`、story state、兼容视图模型的模块级拼装 +4. 与 `apps/api-server` 的 story facade 与 SSE 输出对接 +5. 与 `apps/spacetime-module` 的 story 表、reducer、view 聚合对接 + +## 2. 当前阶段说明 + +当前提交仅完成目录占位,不提前进入 reducer、view 与 SSE 兼容实现。 + +后续与本 package 直接相关的任务包括: + +1. 设计 `story_session`、`story_event` +2. 设计 `resolve_story_action`、`continue_story`、`begin_story_session` +3. 对齐 `RuntimeStoryActionResponse`、`RuntimeStoryOptionView` +4. 落地 `/api/runtime/story/*` 兼容链路 + +## 3. 边界约束 + +1. `module-story` 负责故事状态真相与主循环规则,不把外部 LLM、OSS、短信、微信等副作用塞进模块内部。 +2. 流式文本输出与 HTTP 协议兼容由 `apps/api-server` 暴露,但阶段状态与故事真相必须回写到 `apps/spacetime-module` 聚合的状态模型中。 +3. 跨模块联动通过明确的 reducer 与模块边界协作,不回到单大 service 直接改整包 JSON 的旧实现方式。