update readme
This commit is contained in:
33
EN_README.md
33
EN_README.md
@@ -36,22 +36,17 @@ If you like this project, consider starring it~ You can also watch intro videos
|
||||
## Development Progress
|
||||
|
||||
### 🏗️ Foundation
|
||||
- ✅ World map basics
|
||||
- ✅ World map basics, time, event system
|
||||
- ✅ Diverse terrain types (plain, mountain, forest, desert, water, etc.)
|
||||
- ✅ Time system
|
||||
- ✅ Frontend UI
|
||||
- ✅ Web-based frontend interface
|
||||
- ✅ Simulation framework
|
||||
- ✅ Project documentation
|
||||
- ✅ Config system
|
||||
- ✅ Configuration files
|
||||
- ✅ Standalone release (packaged exe)
|
||||
- ✅ Menu bar & Save & Load
|
||||
|
||||
### 🔭 Long-term Systems
|
||||
- [ ] Web frontend support
|
||||
- [ ] ECS parallel toolkit
|
||||
- [ ] Player-customizable prompts
|
||||
- [ ] Novelization/imagery/video for history and events
|
||||
- [ ] Player-controlled character
|
||||
|
||||
### 🗺️ World System
|
||||
- ✅ Basic tile mechanics
|
||||
@@ -74,6 +69,7 @@ If you like this project, consider starring it~ You can also watch intro videos
|
||||
- ✅ Techniques
|
||||
- ✅ Combat equipment & auxiliary equipment
|
||||
- ✅ Short/Long term memory
|
||||
- ✅ Character's short and long term objectives, supporting player active setting
|
||||
- [ ] Character compatibility
|
||||
- [ ] Epithets/nicknames
|
||||
- [ ] Skill learning system:
|
||||
@@ -186,27 +182,14 @@ If you like this project, consider starring it~ You can also watch intro videos
|
||||
```
|
||||
For supported models, refer to [litellm documentation](https://docs.litellm.ai/docs/providers)
|
||||
|
||||
4. Run the simulator (Local Pygame version):
|
||||
```bash
|
||||
python -m src.run.run
|
||||
```
|
||||
|
||||
5. Run Web version (WIP):
|
||||
Start both backend and frontend.
|
||||
|
||||
**Backend:**
|
||||
4. Run:
|
||||
Need to start both backend and frontend.
|
||||
|
||||
```bash
|
||||
# In project root
|
||||
python src/server/main.py
|
||||
```
|
||||
|
||||
**Frontend:**
|
||||
```bash
|
||||
# In a new terminal, inside 'web' directory
|
||||
cd web
|
||||
npm run dev
|
||||
```
|
||||
Then visit http://localhost:5173
|
||||
The browser will automatically open the web frontend.
|
||||
|
||||
|
||||
## Contributors
|
||||
|
||||
35
README.md
35
README.md
@@ -16,7 +16,7 @@
|
||||
|
||||
### 技术架构
|
||||
|
||||
- **前端显示**: pygame (未来可能支持Web)
|
||||
- **前端显示**: 基于Web的高性能展示
|
||||
- **模拟引擎**: 自研事件驱动模拟器
|
||||
- **世界模型**: 基于规则的确定性系统
|
||||
- **AI集成**: LLM接口生成动作、决策、小剧场
|
||||
@@ -38,22 +38,17 @@
|
||||
## 功能开发进度
|
||||
|
||||
### 🏗️ 基础系统
|
||||
- ✅ 基础世界地图系统
|
||||
- ✅ 基础世界地图、时间、事件系统
|
||||
- ✅ 多样化地形类型(平原、山脉、森林、沙漠、水域等)
|
||||
- ✅ 时间系统
|
||||
- ✅ 前端显示界面
|
||||
- ✅ 基于Web前端显示界面
|
||||
- ✅ 基础模拟器框架
|
||||
- ✅ 项目文档
|
||||
- ✅ 配置文件系统
|
||||
- ✅ 单独release打包好的exe文件
|
||||
- ✅ 配置文件
|
||||
- ✅ release 一键即玩的exe
|
||||
- ✅ 菜单栏 & 存档 & 读档
|
||||
|
||||
### 🔭 远期系统
|
||||
- [ ] Web前端支持
|
||||
- [ ] ECS并行工具
|
||||
- [ ] 玩家自定义prompt
|
||||
- [ ] 历史/事件的小说化&图片化&视频化
|
||||
- [ ] 玩家自主控制角色
|
||||
|
||||
### 🗺️ 世界系统
|
||||
- ✅ 基础tile地块系统
|
||||
@@ -76,6 +71,7 @@
|
||||
- ✅ 角色功法
|
||||
- ✅ 角色兵器 & 辅助装备
|
||||
- ✅ 角色长短期记忆
|
||||
- ✅ 角色的长短期目标,支持玩家主动设定
|
||||
- [ ] 角色之间的相性
|
||||
- [ ] 角色绰号
|
||||
- [ ] 技能学习系统:
|
||||
@@ -183,33 +179,18 @@
|
||||
在 `static/config.yml` 中配置LLM参数:
|
||||
```yaml
|
||||
llm:
|
||||
model_name: "qwen-plus" # 或其他litellm支持的模型名称
|
||||
key: "your-api-key-here" # 你的API密钥
|
||||
base_url: "https://dashscope.aliyuncs.com/compatible-mode/v1"
|
||||
```
|
||||
具体支持的模型请参考 [litellm文档](https://docs.litellm.ai/docs/providers)
|
||||
|
||||
4. 运行模拟器(本地 Pygame 版):
|
||||
```bash
|
||||
python -m src.run.run
|
||||
```
|
||||
|
||||
5. 运行 Web 版本(开发中):
|
||||
4. 运行:
|
||||
需要同时启动后端和前端。
|
||||
|
||||
**后端:**
|
||||
```bash
|
||||
# 在项目根目录
|
||||
python src/server/main.py
|
||||
```
|
||||
|
||||
**前端:**
|
||||
```bash
|
||||
# 打开新终端,进入 web 目录
|
||||
cd web
|
||||
npm run dev
|
||||
```
|
||||
然后访问 http://localhost:5173
|
||||
浏览器会自动打开网页前端。
|
||||
|
||||
|
||||
## 贡献者
|
||||
|
||||
Reference in New Issue
Block a user