forked from datawhale/whale-town-front
docs:更新主要项目文档
- 更新README添加Web部署说明 - 精简API文档,移除冗余内容 - 添加新功能使用指南 - 完善项目架构说明
This commit is contained in:
29
README.md
29
README.md
@@ -14,7 +14,7 @@
|
|||||||
|
|
||||||
### 环境要求
|
### 环境要求
|
||||||
- [Godot Engine 4.5+](https://godotengine.org/download)
|
- [Godot Engine 4.5+](https://godotengine.org/download)
|
||||||
- Python 3.7+ (用于API测试)
|
- Python 3.7+ (用于API测试和Web服务器)
|
||||||
|
|
||||||
### 运行项目
|
### 运行项目
|
||||||
```bash
|
```bash
|
||||||
@@ -29,6 +29,19 @@ cd whale-town
|
|||||||
python tests/api/simple_api_test.py
|
python tests/api/simple_api_test.py
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Web版本部署
|
||||||
|
```bash
|
||||||
|
# Windows用户
|
||||||
|
scripts\build_web.bat # 导出Web版本
|
||||||
|
scripts\serve_web.bat # 启动本地测试服务器
|
||||||
|
|
||||||
|
# Linux/macOS用户
|
||||||
|
./scripts/build_web.sh # 导出Web版本
|
||||||
|
./scripts/serve_web.sh # 启动本地测试服务器
|
||||||
|
```
|
||||||
|
|
||||||
|
详细部署指南请查看: [Web部署完整指南](docs/web_deployment_guide.md)
|
||||||
|
|
||||||
## 🏗️ 项目架构
|
## 🏗️ 项目架构
|
||||||
|
|
||||||
### 核心设计理念
|
### 核心设计理念
|
||||||
@@ -52,6 +65,10 @@ whaleTown/
|
|||||||
├── 📝 scripts/ # 业务逻辑脚本
|
├── 📝 scripts/ # 业务逻辑脚本
|
||||||
│ ├── scenes/ # 场景脚本
|
│ ├── scenes/ # 场景脚本
|
||||||
│ ├── network/ # 网络相关
|
│ ├── network/ # 网络相关
|
||||||
|
│ ├── build_web.bat # Windows Web导出脚本
|
||||||
|
│ ├── build_web.sh # Linux/macOS Web导出脚本
|
||||||
|
│ ├── serve_web.bat # Windows 本地服务器
|
||||||
|
│ ├── serve_web.sh # Linux/macOS 本地服务器
|
||||||
│ └── ui/ # UI组件脚本
|
│ └── ui/ # UI组件脚本
|
||||||
├── 🧩 module/ # 可复用模块
|
├── 🧩 module/ # 可复用模块
|
||||||
│ ├── UI/ # UI组件模块
|
│ ├── UI/ # UI组件模块
|
||||||
@@ -82,6 +99,8 @@ whaleTown/
|
|||||||
└── 📚 docs/ # 项目文档
|
└── 📚 docs/ # 项目文档
|
||||||
├── auth/ # 认证相关文档
|
├── auth/ # 认证相关文档
|
||||||
├── api-documentation.md # API接口文档
|
├── api-documentation.md # API接口文档
|
||||||
|
├── web_deployment_guide.md # Web部署完整指南
|
||||||
|
├── web_deployment_changelog.md # Web部署更新日志
|
||||||
├── project_structure.md # 项目结构说明
|
├── project_structure.md # 项目结构说明
|
||||||
├── naming_convention.md # 命名规范
|
├── naming_convention.md # 命名规范
|
||||||
├── code_comment_guide.md # 代码注释规范
|
├── code_comment_guide.md # 代码注释规范
|
||||||
@@ -117,6 +136,13 @@ EventSystem.connect_event("player_died", _on_player_died)
|
|||||||
- **GitHub OAuth** - 第三方登录集成
|
- **GitHub OAuth** - 第三方登录集成
|
||||||
- **错误处理** - 完整的错误提示和频率限制
|
- **错误处理** - 完整的错误提示和频率限制
|
||||||
|
|
||||||
|
### 🌐 Web版本部署
|
||||||
|
- **自动化导出** - 一键导出Web版本
|
||||||
|
- **本地测试服务器** - 内置HTTP服务器用于测试
|
||||||
|
- **生产环境配置** - 完整的服务器配置指南
|
||||||
|
- **跨平台支持** - Windows、Linux、macOS全平台支持
|
||||||
|
- **性能优化** - 资源压缩和加载优化
|
||||||
|
|
||||||
### 🎮 游戏功能
|
### 🎮 游戏功能
|
||||||
- **主场景** - 游戏主界面和菜单系统
|
- **主场景** - 游戏主界面和菜单系统
|
||||||
- **认证场景** - 完整的登录注册界面
|
- **认证场景** - 完整的登录注册界面
|
||||||
@@ -164,6 +190,7 @@ git commit -m "docs:更新项目文档"
|
|||||||
- 📝 [命名规范](docs/naming_convention.md) - 详细的命名规则
|
- 📝 [命名规范](docs/naming_convention.md) - 详细的命名规则
|
||||||
- 💬 [代码注释规范](docs/code_comment_guide.md) - 注释标准和AI辅助指南
|
- 💬 [代码注释规范](docs/code_comment_guide.md) - 注释标准和AI辅助指南
|
||||||
- 🔀 [Git提交规范](docs/git_commit_guide.md) - 提交信息标准
|
- 🔀 [Git提交规范](docs/git_commit_guide.md) - 提交信息标准
|
||||||
|
- 🌐 [Web部署指南](docs/web_deployment_guide.md) - 完整的Web部署文档
|
||||||
|
|
||||||
### API和测试文档
|
### API和测试文档
|
||||||
- 🔌 [API接口文档](docs/api-documentation.md) - 完整的API说明和测试指南
|
- 🔌 [API接口文档](docs/api-documentation.md) - 完整的API说明和测试指南
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user