128
README.md
128
README.md
@@ -1,3 +1,127 @@
|
||||
# Genarrative
|
||||
# AI Native Visual RPG
|
||||
|
||||
叙世
|
||||
一个以“AI 叙事 + 本地规则 + 像素演出”为核心的视觉 RPG 原型。
|
||||
|
||||
当前已经具备这些主要能力:
|
||||
|
||||
- 世界与角色选择
|
||||
- AI 剧情推进与流式对话
|
||||
- 战斗演出、NPC 战斗、切磋
|
||||
- NPC 交易、送礼、求助、招募
|
||||
- 宝藏交互
|
||||
- 同伴跟随与战斗
|
||||
- 预设编辑器 / NPC 视觉编辑器 / 行为编辑器
|
||||
- 自动存档与继续游戏
|
||||
|
||||
## 运行
|
||||
|
||||
前置条件:
|
||||
|
||||
- Node.js
|
||||
|
||||
安装依赖:
|
||||
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
|
||||
准备环境变量:
|
||||
|
||||
- 复制 `.env.example` 为 `.env.local`
|
||||
- 填入 `LLM_API_KEY` / `ARK_API_KEY`
|
||||
- 按需设置 `VITE_LLM_MODEL`
|
||||
- 如需打印完整 prompt/output,可把 `VITE_LLM_DEBUG_LOG` 设为 `true`
|
||||
|
||||
启动开发环境:
|
||||
|
||||
```bash
|
||||
npm run dev
|
||||
```
|
||||
|
||||
构建生产包:
|
||||
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
|
||||
## 常用检查
|
||||
|
||||
类型检查:
|
||||
|
||||
```bash
|
||||
npm run lint
|
||||
```
|
||||
|
||||
编码检查:
|
||||
|
||||
```bash
|
||||
npm run check:encoding
|
||||
```
|
||||
|
||||
内容引用校验:
|
||||
|
||||
```bash
|
||||
npm run check:data
|
||||
```
|
||||
|
||||
编辑器 override 校验:
|
||||
|
||||
```bash
|
||||
npm run check:overrides
|
||||
```
|
||||
|
||||
关键内容 smoke 检查:
|
||||
|
||||
```bash
|
||||
npm run check:smoke
|
||||
```
|
||||
|
||||
一键内容检查:
|
||||
|
||||
```bash
|
||||
npm run check:content
|
||||
```
|
||||
|
||||
## 主要结构
|
||||
|
||||
主运行时:
|
||||
|
||||
- [src/App.tsx](/E:/Repos/ai-native-visual-rpg/src/App.tsx)
|
||||
- [src/components/GameShell.tsx](/E:/Repos/ai-native-visual-rpg/src/components/GameShell.tsx)
|
||||
- [src/hooks/useCombatFlow.ts](/E:/Repos/ai-native-visual-rpg/src/hooks/useCombatFlow.ts)
|
||||
- [src/hooks/useStoryGeneration.ts](/E:/Repos/ai-native-visual-rpg/src/hooks/useStoryGeneration.ts)
|
||||
|
||||
编辑器:
|
||||
|
||||
- [src/components/PresetEditor.tsx](/E:/Repos/ai-native-visual-rpg/src/components/PresetEditor.tsx)
|
||||
- [src/components/NpcVisualEditor.tsx](/E:/Repos/ai-native-visual-rpg/src/components/NpcVisualEditor.tsx)
|
||||
- [src/components/StateFunctionEditor.tsx](/E:/Repos/ai-native-visual-rpg/src/components/StateFunctionEditor.tsx)
|
||||
|
||||
核心数据:
|
||||
|
||||
- [src/data/scenePresets.ts](/E:/Repos/ai-native-visual-rpg/src/data/scenePresets.ts)
|
||||
- [src/data/characterPresets.ts](/E:/Repos/ai-native-visual-rpg/src/data/characterPresets.ts)
|
||||
- [src/data/monsterPresets.ts](/E:/Repos/ai-native-visual-rpg/src/data/monsterPresets.ts)
|
||||
- [src/data/npcInteractions.ts](/E:/Repos/ai-native-visual-rpg/src/data/npcInteractions.ts)
|
||||
- [src/data/treasureInteractions.ts](/E:/Repos/ai-native-visual-rpg/src/data/treasureInteractions.ts)
|
||||
|
||||
## 文档入口
|
||||
|
||||
开发经验沉淀:
|
||||
|
||||
- [docs/PROJECT_DEVELOPMENT_EXPERIENCE.md](/E:/Repos/ai-native-visual-rpg/docs/PROJECT_DEVELOPMENT_EXPERIENCE.md)
|
||||
- [docs/FUNCTION_SCRIPT_CATALOG_2026-04-04.md](/E:/Repos/ai-native-visual-rpg/docs/FUNCTION_SCRIPT_CATALOG_2026-04-04.md)
|
||||
|
||||
移动端与 UI 经验:
|
||||
|
||||
- [docs/MOBILE_UI_DEV_EXPERIENCE.md](/E:/Repos/ai-native-visual-rpg/docs/MOBILE_UI_DEV_EXPERIENCE.md)
|
||||
- [docs/AGENT_UI_CHANGELOG.md](/E:/Repos/ai-native-visual-rpg/docs/AGENT_UI_CHANGELOG.md)
|
||||
- [UI_CODING_STANDARD.md](/E:/Repos/ai-native-visual-rpg/UI_CODING_STANDARD.md)
|
||||
|
||||
优化路线图:
|
||||
|
||||
- [docs/PROJECT_OPTIMIZATION_AND_FEATURE_ROADMAP.md](/E:/Repos/ai-native-visual-rpg/docs/PROJECT_OPTIMIZATION_AND_FEATURE_ROADMAP.md)
|
||||
|
||||
切磋状态机说明:
|
||||
|
||||
- [AGENT_SPAR_STATE_MACHINE_GUIDE.md](C:/Users/windows/Downloads/AGENT_SPAR_STATE_MACHINE_GUIDE.md)
|
||||
|
||||
Reference in New Issue
Block a user