forked from datawhale/whale-town-front
docs: 完善项目文档和README，修复字符显示问题
- 修复README.md中的emoji字符显示问题 - 移除文档质量评级系统 - 添加贡献者致谢部分，创建详细的CONTRIBUTORS.md - 创建核心系统文件EventNames.gd和ProjectPaths.gd - 更新项目配置文件project.godot，添加输入映射 - 完善各模块文档，修正路径引用问题 - 创建文档更新日志CHANGELOG.md - 优化文档结构和导航系统
This commit is contained in:
536
README.md
536
README.md
@@ -1,365 +1,349 @@
|
||||
# 🐋 Whale Town - 像素游戏前端客户端
|
||||
# 🐋 WhaleTown - 现代化像素游戏
|
||||
|
||||
> 一个基于 Godot 4.5 引擎开发的现代化 2D 像素风游戏前端，采用模块化架构设计，集成完整的用户认证系统、实时通信和游戏核心功能。
|
||||
> 一个基于 Godot 4.5 引擎开发的企业级 2D 像素风游戏，采用模块化架构设计，集成完整的用户认证系统和游戏核心功能。
|
||||
|
||||
[](https://godotengine.org/)
|
||||
[](https://godotengine.org/)
|
||||
[](https://docs.godotengine.org/en/stable/tutorials/scripting/gdscript/index.html)
|
||||
[](./LICENSE)
|
||||
[](https://godotengine.org/download)
|
||||
[](./docs/)
|
||||
[](https://godotengine.org/download)
|
||||
|
||||
## 🎯 项目简介
|
||||
|
||||
Whale Town 是一个功能完整的像素游戏前端客户端，采用模块化架构设计：
|
||||
WhaleTown 是一个功能完整的现代化像素游戏，具有以下特色：
|
||||
|
||||
- 🔐 **用户认证系统** - 完整的登录、注册、密码管理、邮箱验证界面
|
||||
- 🎮 **游戏核心功能** - 角色系统、战斗系统、对话系统、背包系统
|
||||
- 🌐 **实时通信** - WebSocket集成，支持实时多人交互
|
||||
- 🎨 **现代化UI** - 响应式界面设计，支持多分辨率适配
|
||||
- 🧪 **完整测试体系** - UI测试、API测试、性能测试全覆盖
|
||||
- 📱 **跨平台支持** - Windows、Linux、macOS、移动端
|
||||
- 🔧 **模块化架构** - 高度解耦的组件系统，易于扩展和维护
|
||||
- 🏗️ **企业级架构** - 模块化设计，高度解耦，易于扩展
|
||||
- 🔐 **完整认证系统** - 登录、注册、邮箱验证、密码管理
|
||||
- 🎮 **丰富游戏功能** - 角色系统、场景管理、事件通信
|
||||
- 🌐 **网络通信** - RESTful API集成，支持实时数据交互
|
||||
- 📚 **企业级文档** - 18个文档，覆盖开发全流程
|
||||
- 🧪 **完整测试体系** - API测试、UI测试、性能测试
|
||||
- 🚀 **一键部署** - 支持Web、桌面多平台发布
|
||||
|
||||
---
|
||||
|
||||
## 🚀 快速开始
|
||||
## 🚀 5分钟快速体验
|
||||
|
||||
### 📋 环境要求
|
||||
### 📋 准备工作
|
||||
|
||||
- **Godot Engine** >= 4.5.0 (推荐 4.5.1)(https://godotengine.org/download)
|
||||
- **Python** >= 3.7.0 (用于API测试，可选)
|
||||
- **Git** >= 2.0.0
|
||||
**你需要安装：**
|
||||
- [Godot Engine 4.5+](https://godotengine.org/download) - 游戏引擎
|
||||
- [Git](https://git-scm.com/) - 版本控制工具
|
||||
|
||||
### 🛠️ 安装与运行
|
||||
### 🛠️ 启动项目
|
||||
|
||||
```bash
|
||||
# 1. 克隆项目
|
||||
# 1️⃣ 获取项目
|
||||
git clone <repository-url>
|
||||
cd whale-town
|
||||
|
||||
# 2. 使用Godot编辑器打开项目
|
||||
# 双击 project.godot 文件或在Godot编辑器中导入项目
|
||||
# 2️⃣ 打开项目
|
||||
# 双击 project.godot 文件，或在Godot编辑器中选择"导入项目"
|
||||
|
||||
# 3. 运行项目
|
||||
# 按F5或点击"运行"按钮启动游戏
|
||||
# 3️⃣ 运行游戏
|
||||
# 在Godot编辑器中按 F5 或点击"运行项目"按钮
|
||||
```
|
||||
|
||||
🎉 **游戏启动成功！** 进入认证界面开始体验
|
||||
🎉 **成功！** 你应该看到游戏的认证界面
|
||||
|
||||
### 🧪 快速测试
|
||||
### 🎮 体验功能
|
||||
|
||||
1. **注册新用户** - 体验完整的邮箱验证流程
|
||||
2. **登录系统** - 尝试用户名/邮箱登录
|
||||
3. **游戏界面** - 探索主游戏场景
|
||||
|
||||
### 🧪 测试API（可选）
|
||||
|
||||
```bash
|
||||
# API接口测试
|
||||
python tests/api/simple_api_test.py
|
||||
# 安装Python依赖
|
||||
pip install requests
|
||||
|
||||
# 快速API测试
|
||||
python tests/api/quick_test.py
|
||||
|
||||
# 完整功能测试
|
||||
python tests/api/api_test.py --verbose
|
||||
python tests/api/api_client_test.py
|
||||
```
|
||||
|
||||
**测试内容：**
|
||||
- ✅ 用户认证流程测试
|
||||
- ✅ API接口连通性测试
|
||||
- ✅ 错误处理和边界条件测试
|
||||
- ✅ 网络通信功能测试
|
||||
---
|
||||
|
||||
## 📚 新手开发指南
|
||||
|
||||
### 🎯 第一步：了解项目
|
||||
|
||||
**⚠️ 重要：开始开发前必读**
|
||||
|
||||
1. **[📖 项目入门总览](docs/01-项目入门/README.md)** - 5分钟了解项目
|
||||
2. **[🏗️ 项目结构说明](docs/01-项目入门/项目结构说明.md)** - 理解架构设计
|
||||
3. **[⚙️ 项目设置指南](docs/01-项目入门/项目设置指南.md)** - 配置开发环境
|
||||
|
||||
### 🎯 第二步：学习规范
|
||||
|
||||
**代码质量保证**
|
||||
|
||||
1. **[📝 命名规范](docs/02-开发规范/命名规范.md)** - 统一命名标准
|
||||
2. **[🏛️ 架构与通信规范](docs/02-开发规范/架构与通信规范.md)** - 组件通信方式
|
||||
3. **[💬 代码注释规范](docs/02-开发规范/代码注释规范.md)** - 注释标准
|
||||
4. **[🔄 Git提交规范](docs/02-开发规范/Git提交规范.md)** - 版本控制规范
|
||||
|
||||
### 🎯 第三步：开始开发
|
||||
|
||||
**技术实现指导**
|
||||
|
||||
1. **[🔧 实现细节规范](docs/03-技术实现/实现细节规范.md)** - 游戏对象实现
|
||||
2. **[🌐 API接口文档](docs/03-技术实现/API接口文档.md)** - 后端接口使用
|
||||
3. **[🧪 测试指南](docs/03-技术实现/测试指南.md)** - 测试方法和工具
|
||||
|
||||
### 🎯 第四步：高级开发
|
||||
|
||||
**进阶技能**
|
||||
|
||||
1. **[🚀 性能优化指南](docs/04-高级开发/性能优化指南.md)** - 性能调优
|
||||
2. **[🎬 场景设计规范](docs/04-高级开发/场景设计规范.md)** - 场景架构
|
||||
3. **[🧩 模块开发指南](docs/04-高级开发/模块开发指南.md)** - 模块化开发
|
||||
|
||||
### 🎯 第五步：项目发布
|
||||
|
||||
**部署和运维**
|
||||
|
||||
1. **[🌐 Web部署指南](docs/05-部署运维/Web部署指南.md)** - 完整部署流程
|
||||
|
||||
---
|
||||
|
||||
## 🎓 新开发者指南
|
||||
## 🏗️ 项目架构一览
|
||||
|
||||
### 第一步：了解项目规范 📚
|
||||
|
||||
**⚠️ 重要：在开始开发前，请务必阅读以下文档**
|
||||
|
||||
1. **[项目结构详解](./docs/project_structure.md)** 🏗️
|
||||
- 理解模块化架构设计
|
||||
- 掌握目录组织规则
|
||||
- 学习组件通信机制
|
||||
|
||||
2. **[命名规范](./docs/naming_convention.md)** 📝
|
||||
- 场景、脚本、节点命名规则
|
||||
- 资源文件命名标准
|
||||
- 变量和函数命名约定
|
||||
|
||||
3. **[代码注释规范](./docs/code_comment_guide.md)** 💬
|
||||
- 注释标准和最佳实践
|
||||
- AI辅助开发指南
|
||||
- 文档生成规范
|
||||
|
||||
4. **[Git提交规范](./docs/git_commit_guide.md)** 🔄
|
||||
- 提交信息格式标准
|
||||
- 分支管理策略
|
||||
- 代码审查流程
|
||||
|
||||
### 第二步：熟悉项目架构 🏗️
|
||||
### 📁 目录结构
|
||||
|
||||
```
|
||||
whaleTown/
|
||||
├── 🎬 scenes/ # 游戏场景
|
||||
│ ├── auth_scene.tscn # 🔐 用户认证场景
|
||||
│ ├── main_scene.tscn # 🎮 主游戏场景
|
||||
│ └── prefabs/ # 🧩 预制体组件
|
||||
├── 🔧 core/ # 核心系统（自动加载）
|
||||
│ ├── managers/ # 🎯 全局管理器
|
||||
│ ├── systems/ # ⚙️ 系统组件
|
||||
│ └── utils/ # 🛠️ 工具类
|
||||
├── 📝 scripts/ # 业务逻辑脚本
|
||||
│ ├── scenes/ # 🎬 场景脚本
|
||||
│ ├── network/ # 🌐 网络相关
|
||||
│ └── ui/ # 🎨 UI组件脚本
|
||||
├── 🧩 module/ # 可复用模块
|
||||
│ ├── UI/ # 🎨 UI组件模块
|
||||
│ ├── Character/ # 👤 角色模块
|
||||
│ ├── Combat/ # ⚔️ 战斗模块
|
||||
│ ├── Dialogue/ # 💬 对话模块
|
||||
│ └── Inventory/ # 🎒 背包模块
|
||||
├── 🎨 assets/ # 游戏资源
|
||||
│ ├── sprites/ # 🖼️ 精灵图资源
|
||||
│ ├── audio/ # 🔊 音频文件
|
||||
│ ├── ui/ # 🎨 UI界面资源
|
||||
│ └── fonts/ # 🔤 字体资源
|
||||
├── 📊 data/ # 配置数据
|
||||
│ ├── configs/ # ⚙️ 游戏配置
|
||||
│ ├── localization/ # 🌍 本地化文件
|
||||
│ └── characters/ # 👤 角色数据
|
||||
├── 🧪 tests/ # 测试文件
|
||||
│ ├── api/ # 🔌 API接口测试
|
||||
│ ├── auth/ # 🔐 认证UI测试
|
||||
│ └── unit/ # 🧪 单元测试
|
||||
└── 📚 docs/ # 项目文档
|
||||
├── auth/ # 🔐 认证相关文档
|
||||
└── api-documentation.md # 📖 API接口文档
|
||||
WhaleTown/ # 🐋 项目根目录
|
||||
├── 📚 docs/ # 📖 完整文档系统（18个文档）
|
||||
│ ├── 01-项目入门/ # 👋 新人必读
|
||||
│ ├── 02-开发规范/ # 📋 编码标准
|
||||
│ ├── 03-技术实现/ # 🔧 开发指导
|
||||
│ ├── 04-高级开发/ # 🚀 进阶技巧
|
||||
│ ├── 05-部署运维/ # 🌐 发布部署
|
||||
│ └── 06-功能模块/ # 🎮 功能文档
|
||||
├── 🎬 scenes/ # 🎭 游戏场景
|
||||
│ ├── Maps/ # 🗺️ 地图场景
|
||||
│ └── Components/ # 🧩 组件预制体
|
||||
├── 🔧 _Core/ # ⚙️ 核心系统
|
||||
│ ├── managers/ # 🎯 全局管理器
|
||||
│ ├── systems/ # 🔄 系统组件
|
||||
│ ├── EventNames.gd # 📝 事件名称定义
|
||||
│ └── ProjectPaths.gd # 📂 路径统一管理
|
||||
├── 🎨 UI/ # 🖼️ 用户界面
|
||||
│ └── Windows/ # 🪟 窗口界面
|
||||
├── 🔨 Utils/ # 🔨 工具类
|
||||
├── 🎮 module/ # 🧩 功能模块
|
||||
├── 🎨 assets/ # 🖼️ 游戏资源
|
||||
├── ⚙️ Config/ # 📋 配置文件
|
||||
├── 🧪 tests/ # 🔬 测试文件
|
||||
└── 🌐 web_assets/ # 🌍 Web部署资源
|
||||
```
|
||||
|
||||
**架构特点：**
|
||||
- 🏗️ **模块化设计** - 按功能而非技术组织代码
|
||||
- 🔄 **事件驱动** - 通过EventSystem实现组件间通信
|
||||
- 📦 **清晰分层** - 场景层 → 业务层 → 核心层
|
||||
- 🧪 **测试友好** - 完整的测试覆盖和文档
|
||||
### 🔧 核心组件
|
||||
|
||||
### 第三步：体验核心功能 🎮
|
||||
|
||||
1. **用户认证系统** 🔐
|
||||
- 邮箱验证码注册
|
||||
- 多方式登录（用户名/邮箱/手机号）
|
||||
- 密码重置功能
|
||||
|
||||
2. **游戏核心系统** 🎮
|
||||
- 场景管理和切换
|
||||
- 角色状态管理
|
||||
- 实时网络通信
|
||||
|
||||
3. **开发工具** 🛠️
|
||||
- 内置测试场景
|
||||
- API测试脚本
|
||||
- 性能监控工具
|
||||
|
||||
### 第四步：开始贡献 🤝
|
||||
|
||||
1. **Fork项目** 到你的账户
|
||||
2. **创建功能分支**：`git checkout -b feature/your-feature`
|
||||
3. **遵循规范开发**（参考文档）
|
||||
4. **添加测试用例**：确保功能正确性
|
||||
5. **提交代码**：`git commit -m "feat：添加新功能"`
|
||||
6. **创建Pull Request**
|
||||
| 组件 | 作用 | 文档链接 |
|
||||
|------|------|----------|
|
||||
| **EventSystem** | 全局事件通信 | [架构规范](docs/02-开发规范/架构与通信规范.md) |
|
||||
| **GameManager** | 游戏状态管理 | [实现细节](docs/03-技术实现/实现细节规范.md) |
|
||||
| **SceneManager** | 场景切换管理 | [场景设计](docs/04-高级开发/场景设计规范.md) |
|
||||
| **NetworkManager** | 网络请求管理 | [网络管理器](docs/03-技术实现/网络管理器设置.md) |
|
||||
| **ProjectPaths** | 路径统一管理 | [项目结构](docs/01-项目入门/项目结构说明.md) |
|
||||
|
||||
---
|
||||
|
||||
## <EFBFBD>[️ 技术栈
|
||||
## 🎮 核心功能
|
||||
|
||||
### 🎮 游戏引擎
|
||||
- **Godot Engine** `4.5.1` - 开源游戏引擎，支持2D/3D开发
|
||||
- **GDScript** - Godot专用脚本语言，Python风格语法
|
||||
- **Forward Plus** - 现代渲染管线，支持高质量光照
|
||||
### 🔐 用户认证系统
|
||||
|
||||
### 🏗️ 架构设计
|
||||
- **模块化架构** - 按功能组织的可复用组件系统
|
||||
- **事件驱动** - 基于EventSystem的松耦合通信
|
||||
- **单例管理器** - GameManager、SceneManager等全局管理器
|
||||
- **状态机模式** - 游戏状态和角色状态管理
|
||||
**完整的用户管理功能**
|
||||
- ✅ 用户注册（用户名+邮箱验证）
|
||||
- ✅ 多方式登录（用户名/邮箱/验证码）
|
||||
- ✅ 密码管理（修改/重置）
|
||||
- ✅ 表单验证（实时验证+友好提示）
|
||||
- ✅ 错误处理（网络异常+业务错误）
|
||||
|
||||
### 🌐 网络通信
|
||||
- **RESTful API** - 标准HTTP接口通信
|
||||
- **JSON数据格式** - 轻量级数据交换格式
|
||||
- **WebSocket** - 实时双向通信支持
|
||||
- **错误处理** - 完整的网络异常处理机制
|
||||
**技术特色**
|
||||
- 📱 响应式UI设计
|
||||
- 🔄 实时表单验证
|
||||
- ⏰ 验证码冷却机制
|
||||
- 🎨 流畅动画效果
|
||||
|
||||
### 🎨 UI系统
|
||||
- **响应式设计** - 支持多分辨率自适应
|
||||
- **主题系统** - 统一的UI风格管理
|
||||
- **动画系统** - 流畅的界面过渡效果
|
||||
- **本地化支持** - 多语言界面切换
|
||||
### 🎮 游戏核心系统
|
||||
|
||||
### 🧪 测试框架
|
||||
- **Godot内置测试** - 场景和组件测试
|
||||
- **Python测试脚本** - API接口自动化测试
|
||||
- **性能监控** - 帧率和内存使用监控
|
||||
- **错误追踪** - 完整的日志和错误报告
|
||||
**模块化游戏架构**
|
||||
- 🎭 场景管理系统
|
||||
- 🔄 事件通信系统
|
||||
- 🎯 状态管理系统
|
||||
- 🌐 网络通信系统
|
||||
|
||||
### 📱 跨平台支持
|
||||
- **桌面平台** - Windows、Linux、macOS
|
||||
- **移动平台** - Android、iOS（规划中）
|
||||
- **Web平台** - HTML5导出支持（规划中）
|
||||
**开发友好特性**
|
||||
- 🧩 高度模块化
|
||||
- 📝 完整文档覆盖
|
||||
- 🧪 测试用例齐全
|
||||
- 🔧 开发工具完善
|
||||
|
||||
---
|
||||
|
||||
## 🏗️ 核心功能
|
||||
## 🧪 测试系统
|
||||
|
||||
### 🔐 用户认证系统 (scenes/auth_scene.tscn)
|
||||
- **多方式登录** - 用户名/邮箱/手机号
|
||||
- **邮箱验证** - 完整的验证码流程和倒计时
|
||||
- **密码安全** - 强度验证和安全提示
|
||||
- **错误处理** - 友好的错误提示和状态管理
|
||||
- **响应式UI** - 自适应布局和动画效果
|
||||
### 🔬 测试类型
|
||||
|
||||
### 🎮 游戏核心系统 (core/)
|
||||
- **GameManager** - 全局游戏状态管理（LOADING、AUTH、IN_GAME等）
|
||||
- **SceneManager** - 场景切换和生命周期管理
|
||||
- **EventSystem** - 全局事件通信系统
|
||||
- **StringUtils** - 字符串处理工具集
|
||||
| 测试类型 | 工具 | 覆盖范围 | 文档 |
|
||||
|----------|------|----------|------|
|
||||
| **API测试** | Python脚本 | 17个接口全覆盖 | [测试指南](docs/03-技术实现/测试指南.md) |
|
||||
| **UI测试** | Godot场景 | 认证流程完整测试 | [认证测试](docs/06-功能模块/auth/认证测试指南.md) |
|
||||
| **单元测试** | GUT框架 | 核心组件测试 | [测试指南](docs/03-技术实现/测试指南.md) |
|
||||
|
||||
### 🧩 模块化组件 (module/)
|
||||
- **UI组件** - 可复用的界面组件和动画
|
||||
- **角色系统** - 角色数据和行为管理
|
||||
- **战斗系统** - 战斗逻辑和技能系统
|
||||
- **对话系统** - 对话树和文本显示
|
||||
- **背包系统** - 物品管理和交互
|
||||
|
||||
### 🌐 网络通信 (scripts/network/)
|
||||
- **API集成** - RESTful接口调用封装
|
||||
- **实时通信** - WebSocket连接管理
|
||||
- **数据同步** - 客户端服务器数据同步
|
||||
- **离线处理** - 网络异常和离线模式
|
||||
|
||||
### 🧪 测试体系 (tests/)
|
||||
- **API测试** - 完整的接口功能测试
|
||||
- **UI测试** - 交互式界面测试场景
|
||||
- **单元测试** - 组件和函数级别测试
|
||||
- **集成测试** - 完整业务流程测试
|
||||
- **性能测试** - 帧率和内存性能监控
|
||||
|
||||
---
|
||||
|
||||
## 📊 开发与测试
|
||||
|
||||
### 🔧 开发命令
|
||||
### 🚀 快速测试
|
||||
|
||||
```bash
|
||||
# 启动Godot编辑器
|
||||
godot --editor
|
||||
# 🔌 API接口测试（30秒）
|
||||
python tests/api/quick_test.py
|
||||
|
||||
# 运行项目（无编辑器）
|
||||
godot --main-pack game.pck
|
||||
# 🔍 完整功能测试（2-3分钟）
|
||||
python tests/api/api_client_test.py
|
||||
|
||||
# 导出项目
|
||||
godot --export "Windows Desktop" game.exe
|
||||
|
||||
# 运行测试
|
||||
godot --headless --script tests/run_tests.gd
|
||||
# 🎮 UI交互测试（在Godot中运行）
|
||||
# 打开 tests/auth/auth_ui_test.tscn 场景
|
||||
```
|
||||
|
||||
### 🧪 测试命令
|
||||
|
||||
```bash
|
||||
# API接口测试
|
||||
python tests/api/simple_api_test.py
|
||||
|
||||
# 完整功能测试
|
||||
python tests/api/api_test.py --verbose
|
||||
|
||||
# 自定义服务器测试
|
||||
python tests/api/simple_api_test.py https://your-server.com
|
||||
|
||||
# UI交互测试
|
||||
# 在Godot编辑器中运行 tests/auth/auth_ui_test.tscn
|
||||
```
|
||||
|
||||
### 📈 测试覆盖率
|
||||
- **API测试**: 17个接口全覆盖 ✅
|
||||
- **UI测试**: 认证流程完整测试 ✅
|
||||
- **错误处理**: 边界条件和异常测试 ✅
|
||||
- **性能测试**: 帧率和内存监控 ✅
|
||||
|
||||
---
|
||||
|
||||
## 🌍 部署配置
|
||||
## 🚀 部署发布
|
||||
|
||||
### 🖥️ 桌面版本
|
||||
|
||||
### 开发环境（默认）
|
||||
```bash
|
||||
# 本地开发配置
|
||||
API_BASE_URL=http://localhost:3000
|
||||
DEBUG_MODE=true
|
||||
LOG_LEVEL=debug
|
||||
# Windows
|
||||
godot --export "Windows Desktop" build/WhaleTown.exe
|
||||
|
||||
# Linux
|
||||
godot --export "Linux/X11" build/WhaleTown.x86_64
|
||||
|
||||
# macOS
|
||||
godot --export "macOS" build/WhaleTown.app
|
||||
```
|
||||
|
||||
### 生产环境
|
||||
### 🌐 Web版本
|
||||
|
||||
```bash
|
||||
# 生产环境配置
|
||||
API_BASE_URL=https://your-api-server.com
|
||||
DEBUG_MODE=false
|
||||
LOG_LEVEL=info
|
||||
ENABLE_ANALYTICS=true
|
||||
# 使用自动化脚本
|
||||
scripts/build_web.bat # Windows
|
||||
scripts/build_web.sh # Linux/macOS
|
||||
|
||||
# 本地测试
|
||||
scripts/serve_web.bat # 启动本地服务器
|
||||
```
|
||||
|
||||
### 导出设置
|
||||
- **Windows**: 64位可执行文件
|
||||
- **Linux**: AppImage格式
|
||||
- **macOS**: .app应用包
|
||||
- **Android**: APK安装包（规划中）
|
||||
**详细部署流程**: [Web部署指南](docs/05-部署运维/Web部署指南.md)
|
||||
|
||||
---
|
||||
|
||||
## 📚 文档中心
|
||||
## 📊 项目统计
|
||||
|
||||
### 🎯 新手必读
|
||||
1. **[项目结构详解](./docs/project_structure.md)** - 架构设计和组织规则
|
||||
2. **[命名规范](./docs/naming_convention.md)** - 代码和资源命名标准
|
||||
3. **[代码注释规范](./docs/code_comment_guide.md)** - 注释标准和AI辅助
|
||||
4. **[Git提交规范](./docs/git_commit_guide.md)** - 版本控制最佳实践
|
||||
### 📚 文档系统
|
||||
|
||||
### 📖 功能文档
|
||||
- **[用户认证系统](./docs/auth/)** - 认证流程和界面设计
|
||||
- **[API接口文档](./docs/api-documentation.md)** - 完整的API使用指南
|
||||
- **[测试指南](./tests/api/README.md)** - 测试用例和使用方法
|
||||
| 类别 | 文档数 | 完成度 |
|
||||
|------|--------|--------|
|
||||
| 项目入门 | 3 | 100% |
|
||||
| 开发规范 | 5 | 100% |
|
||||
| 技术实现 | 4 | 100% |
|
||||
| 高级开发 | 3 | 100% |
|
||||
| 部署运维 | 1 | 100% |
|
||||
| 功能模块 | 2 | 100% |
|
||||
| **总计** | **18** | **100%** |
|
||||
|
||||
### 🏗️ 开发指南
|
||||
- **[模块开发指南](./docs/module_development.md)** - 如何创建新模块
|
||||
- **[场景设计规范](./docs/scene_design.md)** - 场景架构和最佳实践
|
||||
- **[性能优化指南](./docs/performance_guide.md)** - 性能调优技巧
|
||||
### 🧪 测试覆盖
|
||||
|
||||
- **API接口**: 17个接口 ✅
|
||||
- **认证流程**: 完整测试 ✅
|
||||
- **错误处理**: 边界测试 ✅
|
||||
- **性能监控**: 帧率/内存 ✅
|
||||
|
||||
---
|
||||
|
||||
## 🤝 贡献者
|
||||
## 🤝 参与贡献
|
||||
|
||||
感谢所有为项目做出贡献的开发者！
|
||||
|
||||
### 🏆 核心团队
|
||||
- **[moyin](https://gitea.xinghangee.icu/moyin)** - 核心开发者
|
||||
- **[jianuo](https://gitea.xinghangee.icu/jianuo)** - 核心开发者
|
||||
- **[angjustinl](https://gitea.xinghangee.icu/ANGJustinl)** - 核心开发者
|
||||
|
||||
查看完整贡献者名单：[docs/CONTRIBUTORS.md](./docs/CONTRIBUTORS.md)
|
||||
|
||||
### 🌟 如何贡献
|
||||
|
||||
我们欢迎所有形式的贡献：
|
||||
### 🌟 贡献方式
|
||||
|
||||
1. **🐛 Bug修复** - 发现并修复问题
|
||||
2. **✨ 新功能** - 添加有价值的功能
|
||||
2. **✨ 新功能** - 添加有价值的功能
|
||||
3. **📚 文档改进** - 完善项目文档
|
||||
4. **🧪 测试用例** - 提高代码覆盖率
|
||||
5. **🎨 UI/UX改进** - 提升用户体验
|
||||
6. **⚡ 性能优化** - 优化游戏性能
|
||||
|
||||
**贡献流程：**
|
||||
1. Fork项目 → 2. 创建分支 → 3. 开发功能 → 4. 提交PR
|
||||
### 📋 贡献流程
|
||||
|
||||
```bash
|
||||
# 1️⃣ Fork项目到你的账户
|
||||
|
||||
# 2️⃣ 克隆到本地
|
||||
git clone <your-fork-url>
|
||||
cd whale-town
|
||||
|
||||
# 3️⃣ 创建功能分支
|
||||
git checkout -b feature/your-feature
|
||||
|
||||
# 4️⃣ 开发功能（遵循项目规范）
|
||||
# 参考: docs/02-开发规范/
|
||||
|
||||
# 5️⃣ 添加测试用例
|
||||
# 参考: docs/03-技术实现/测试指南.md
|
||||
|
||||
# 6️⃣ 提交代码
|
||||
git commit -m "feat：添加新功能"
|
||||
# 参考: docs/02-开发规范/Git提交规范.md
|
||||
|
||||
# 7️⃣ 推送分支
|
||||
git push origin feature/your-feature
|
||||
|
||||
# 8️⃣ 创建Pull Request
|
||||
```
|
||||
|
||||
### 📖 开发规范
|
||||
|
||||
**必读文档**：
|
||||
- [命名规范](docs/02-开发规范/命名规范.md) - 代码命名标准
|
||||
- [Git提交规范](docs/02-开发规范/Git提交规范.md) - 提交信息格式
|
||||
- [代码注释规范](docs/02-开发规范/代码注释规范.md) - 注释标准
|
||||
|
||||
### 🙏 贡献者致谢
|
||||
|
||||
感谢所有为 WhaleTown 项目做出贡献的开发者们！详细的贡献者信息和统计请查看：
|
||||
|
||||
**[📖 贡献者详细信息](docs/CONTRIBUTORS.md)**
|
||||
|
||||
---
|
||||
|
||||
## 📞 联系我们
|
||||
## 📞 获取帮助
|
||||
|
||||
### 🔍 问题解决
|
||||
|
||||
| 问题类型 | 解决方案 |
|
||||
|----------|----------|
|
||||
| **🤔 不知道从哪开始** | [项目入门总览](docs/01-项目入门/README.md) |
|
||||
| **🏗️ 不理解项目架构** | [项目结构说明](docs/01-项目入门/项目结构说明.md) |
|
||||
| **🔧 开发环境问题** | [项目设置指南](docs/01-项目入门/项目设置指南.md) |
|
||||
| **📝 不知道怎么命名** | [命名规范](docs/02-开发规范/命名规范.md) |
|
||||
| **🔄 组件通信问题** | [架构与通信规范](docs/02-开发规范/架构与通信规范.md) |
|
||||
| **🌐 API调用问题** | [API接口文档](docs/03-技术实现/API接口文档.md) |
|
||||
| **🧪 测试相关问题** | [测试指南](docs/03-技术实现/测试指南.md) |
|
||||
| **🚀 部署发布问题** | [Web部署指南](docs/05-部署运维/Web部署指南.md) |
|
||||
|
||||
### 📚 文档导航
|
||||
|
||||
- **[📖 完整文档中心](docs/README.md)** - 所有文档的导航页面
|
||||
- **[📋 文档更新日志](docs/CHANGELOG.md)** - 文档版本变更记录
|
||||
|
||||
### 💬 联系方式
|
||||
|
||||
- **项目地址**: [Gitea Repository](https://gitea.xinghangee.icu/datawhale/whale-town)
|
||||
- **问题反馈**: [Issues](https://gitea.xinghangee.icu/datawhale/whale-town/issues)
|
||||
- **功能建议**: [Discussions](https://gitea.xinghangee.icu/datawhale/whale-town/discussions)
|
||||
|
||||
---
|
||||
|
||||
## 📄 许可证
|
||||
|
||||
本项目采用 [MIT License](./LICENSE) 开源协议。
|
||||
@@ -368,10 +352,12 @@ ENABLE_ANALYTICS=true
|
||||
|
||||
<div align="center">
|
||||
|
||||
**🐋 Whale Town - 让像素世界更精彩！**
|
||||
**🐋 WhaleTown - 企业级像素游戏开发框架**
|
||||
|
||||
Made with ❤️ by the Whale Town Team
|
||||
*让游戏开发更简单，让代码质量更优秀*
|
||||
|
||||
[⭐ Star](https://gitea.xinghangee.icu/datawhale/whale-town) | [🍴 Fork](https://gitea.xinghangee.icu/datawhale/whale-town/fork) | [📖 Docs](./docs/) | [🐛 Issues](https://gitea.xinghangee.icu/datawhale/whale-town/issues)
|
||||
[⭐ Star](https://gitea.xinghangee.icu/datawhale/whale-town) | [🍴 Fork](https://gitea.xinghangee.icu/datawhale/whale-town/fork) | [📖 文档](./docs/) | [🐛 反馈](https://gitea.xinghangee.icu/datawhale/whale-town/issues)
|
||||
|
||||
</div>
|
||||
**文档版本**: v1.2.0 | **最后更新**: 2025-12-31
|
||||
|
||||
</div>
|
||||
Reference in New Issue
Block a user