54 Commits

Author SHA1 Message Date
48216b72f7 Merge pull request 'revert d671e4d3117ae8d902cb15a43a1c1d9c30fc8e27' (#14) from moyin-patch-1 into main
Reviewed-on: #14
2026-01-14 16:45:00 +08:00
229461c83f revert d671e4d311
revert Merge pull request '聊天系统' (#13) from qbb0530/whale-town-front:main into main

Reviewed-on: #13
2026-01-14 16:44:46 +08:00
d671e4d311 Merge pull request '聊天系统' (#13) from qbb0530/whale-town-front:main into main
Reviewed-on: #13
2026-01-14 15:22:13 +08:00
625fe0ff6c merge upstream 2026-01-14 15:19:15 +08:00
WhaleTown Developer
0e5b9f947b refactor: 移除SocketIOClient并更新认证场景
- 移除SocketIOClient.gd及.uid文件
- 更新ChatManager以适配新的架构
- 添加认证UI图片资源和背景音乐
- 优化AuthScene布局和配置
- 更新MainScene和项目配置
2026-01-11 23:12:35 +08:00
7cca58cb07 Merge pull request 'feature/whaletown-developer-skill' (#12) from feature/whaletown-developer-skill into main
Reviewed-on: #12
2026-01-10 19:31:05 +08:00
王浩
749e2c257b assets: 添加认证UI图片资源 2026-01-09 23:24:32 +08:00
王浩
e335a35f6c feat(chat-ui): 更新聊天UI和场景配置
- 优化聊天消息显示
- 调整UI布局
2026-01-09 23:23:41 +08:00
王浩
136e1344a0 fix(chat): 修复WebSocket连接和消息格式
- 修复连接状态检测时机问题
- 修复聊天消息格式为 {t: chat, content, scope}
- 添加 _send_login_message 函数
- 移除空消息心跳避免服务器错误
2026-01-09 23:21:12 +08:00
WhaleTown Developer
25a21f92be feat(chat): 优化聊天UI布局和WebSocket连接
- 更新 WebSocket URL 以支持 Socket.IO 握手参数 (EIO=4)
- 重构聊天面板布局,使用绝对定位和百分比锚点
- 优化输入框样式,添加装饰元素
- 修复输入框焦点释放的事件冲突问题
- 将 ChatUI 集成到主场景中
- 改进主场景容器布局设置
2026-01-08 23:59:21 +08:00
王浩
9c2e3bf15a refactor(chat-ui): 移除HeaderContainer和SendButton,添加装饰图片,修复Enter键监听
- 删除 HeaderContainer 和 StatusLabel(状态显示)
- 删除 SendButton(发送按钮)
- 添加聊天框背景图和装饰图片
- 设置 TextureRect modulate 为白色,修复黑框问题
- 移除 ChatPanel 背景色,使背景透明
- 修复 is_key_pressed 错误,改用 InputEventKey 类型检查
- 移除 _update_connection_status 函数及相关调用
2026-01-08 18:14:48 +08:00
WhaleTown Developer
9e288dbb62 docs: 更新聊天系统实施进度
- 简化文档,移除详细修复记录
- 更新实施状态:所有编译错误已修复
- 记录待后端解决的 Zulip 集成问题
2026-01-08 00:31:07 +08:00
WhaleTown Developer
c8e73bec59 fix: 修复聊天系统编译错误
- 修复 WebSocketManager/SocketIOClient 函数缩进错误
- 重命名 is_connected() 避免与 Object 基类冲突
- 修复 tscn 文件多余前导空格
- 修复测试文件 GUT 断言函数调用
- 添加 GUT 测试框架
2026-01-08 00:11:12 +08:00
王浩
16f24ab26f feat:添加聊天UI资源文件
- 添加聊天界面UI资源(缩略框背景、输入框背景、装饰图片)
- 修复 GrassTile.gd.uid 文件缺失

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
2026-01-07 17:46:26 +08:00
王浩
414225e8c1 docs:更新项目规范文档
- 在 claude.md 添加 Plan Mode Protocol 章节
- 明确规划阶段的输出要求和执行报告流程
- 强制要求在每个 TODO 完成后更新文档并等待用户确认

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
2026-01-07 17:42:48 +08:00
王浩
fb7cba4088 feat:实现聊天系统核心功能
- 添加 SocketIOClient.gd 实现 Socket.IO 协议封装
- 添加 WebSocketManager.gd 管理连接生命周期和自动重连
- 添加 ChatManager.gd 实现聊天业务逻辑与会话管理
  - 支持当前会话缓存(最多 100 条消息)
  - 支持历史消息按需加载(每次 100 条)
  - 每次登录/重连自动重置会话缓存
  - 客户端频率限制(10 条/分钟)
  - Token 管理与认证
- 添加 ChatMessage.gd/tscn 消息气泡 UI 组件
- 添加 ChatUI.gd/tscn 聊天界面
- 在 EventNames.gd 添加 7 个聊天事件常量
- 在 AuthManager.gd 添加 game_token 管理方法
- 添加完整的单元测试(128 个测试用例)
  - test_socketio_client.gd (42 个测试)
  - test_websocket_manager.gd (38 个测试)
  - test_chat_manager.gd (48 个测试)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
2026-01-07 17:42:31 +08:00
7b85147994 chore: 合并 main 分支,统一 CLAUDE.md 格式规范
合并 main 分支对 CLAUDE.md 的格式改进,同时保留 feature 分支新增的标准开发工作流(第 8 节)。

主要改动:
- 更新 Godot 版本要求从 4.2+ 到 4.5+
- 规范化 Markdown 格式(代码块、粗体、列表)
- 保留新增的「Standard Development Workflow」章节
- 调整章节编号(第 9、10 节)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
2026-01-06 19:41:29 +08:00
e3c4d08021 Merge pull request '修正语法错误' (#11) from qbb0530/whale-town-front:main into main
Reviewed-on: #11
2026-01-05 11:28:13 +08:00
王浩
3bdda47191 修正语法错误 2026-01-04 17:17:34 +08:00
43e0c2b928 feat:添加whaletown-developer标准开发工作流技能
- 创建whaletown-developer skill自动化7步开发流程
- 添加完整的使用说明文档和质量检查清单
- 更新CLAUDE.md集成标准开发工作流说明
- 新增标准开发工作流详细文档

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
2026-01-04 00:46:48 +08:00
3d6c4e5356 Merge pull request 'feature/网格瓦片系统' (#9) from feature/网格瓦片系统 into main
Reviewed-on: #9
2026-01-03 22:40:55 +08:00
c621d70475 chore:清理空的占位文件
- 删除sprites目录下的空.gitkeep文件
- 删除tools目录下的空README.md文件
2026-01-03 22:37:04 +08:00
f527fa3c38 docs:添加网格瓦片系统功能文档
- 详细说明32x32网格系统的使用方法
- 包含核心组件介绍和API参考
- 提供编辑器和代码使用示例
2026-01-03 22:35:36 +08:00
e9fa21280e scene:创建广场地图场景并添加环境瓦片资源
- 新增square.tscn广场地图场景
- 添加多种环境瓦片纹理资源
- 包含草地、地板、路缘等瓦片素材
2026-01-03 22:35:13 +08:00
a3d384d39d style:统一代码文件末尾换行格式 2026-01-03 22:33:56 +08:00
ced69fd4b6 scene:创建草地瓦片预制体
- 实现GrassTile组件,支持32x32网格对齐
- 添加自动纹理验证和占位符生成
- 提供网格位置设置和世界坐标转换
- 包含位置变化信号和调试功能
2026-01-03 22:30:03 +08:00
7a6e5be4f8 config:更新核心配置支持网格系统
- EventNames添加网格相关事件定义
- ProjectPaths添加网格系统和地形资源路径
2026-01-03 22:28:29 +08:00
ba5b0daa13 feat:实现32x32网格系统核心功能
- 添加GridSystem类提供网格坐标转换
- 支持世界坐标与网格坐标互转
- 提供位置吸附和距离计算方法
- 包含网格区域和边界检查功能
2026-01-03 22:28:06 +08:00
83404d031e Merge pull request 'feature/auth-system-refactor' (#8) from feature/auth-system-refactor into main
Reviewed-on: #8
2026-01-02 21:25:30 +08:00
709242d223 docs:更新项目结构说明和路径配置
- 更新ProjectPaths.gd中的路径常量
- 更新项目结构说明文档
- 清理临时测试文件的uid引用

确保文档与实际项目结构保持一致
2026-01-02 21:20:31 +08:00
2f1ccbc2cd docs:为核心管理器添加详细中文注释
- GameManager.gd:游戏状态管理注释
- NetworkManager.gd:网络请求管理注释
- SceneManager.gd:场景切换管理注释
- StringUtils.gd:字符串工具函数注释

按照docs注释规范,添加文件头、函数说明、参数描述和使用示例
方便协同开发者快速理解和调用
2026-01-02 21:19:53 +08:00
aaaf2b31a8 fix:修复EventSystem中的GDScript语法错误
- 移除不支持的try/except语句
- 改为直接调用回调函数
- 确保EventSystem能正常编译运行
2026-01-02 21:19:25 +08:00
93baf1a5b5 refactor:统一AuthScene命名规范
- 将LoginWindow.tscn重命名为AuthScene.tscn
- 更新MainScene.tscn中的场景引用路径
- 实现命名一致性:
  - 场景文件:AuthScene.tscn
  - 脚本文件:AuthScene.gd
  - 节点名称:AuthScene
- AuthScene比LoginWindow更准确描述功能(登录+注册)
2026-01-02 21:19:04 +08:00
5f915c61b6 refactor:AuthScene解耦重构,实现视图与业务逻辑分离
- 创建AuthManager.gd:负责所有认证业务逻辑
  - 用户登录/注册逻辑
  - 表单验证逻辑
  - 验证码管理逻辑
  - 网络请求管理

- 创建ToastManager.gd:负责Toast消息管理
  - Toast创建和显示
  - 动画和生命周期管理
  - 支持成功/失败样式

- 重构AuthScene.gd:纯视图层实现
  - 只负责UI交互和显示
  - 通过信号与业务层通信
  - 移除所有业务逻辑代码

- 修复GDScript警告:
  - 未使用参数添加下划线前缀
  - 修复变量名与基类方法冲突
  - 修复EventSystem中的try语法错误
  - 修复AuthManager中的方法名不匹配错误

符合docs中的架构要求,实现完全解耦
2026-01-02 21:18:38 +08:00
d256249789 refactor:将MainScene移动到scenes根目录
- 将MainScene从scenes/Maps/移动到scenes/根目录
- 更新project.godot中的主场景路径配置
- 符合项目结构规范,MainScene作为图像显示入口文件
2026-01-02 21:17:56 +08:00
29c6740870 Merge pull request 'feature/project-structure-refactor' (#7) from feature/project-structure-refactor into main
Reviewed-on: #7
2026-01-02 01:03:07 +08:00
7b1affa360 Merge branch 'main' into feature/project-structure-refactor 2026-01-02 01:02:59 +08:00
fa360e1c78 docs:更新项目文档以反映新的结构变更
- 更新 README.md 中的项目结构说明
- 修订项目结构说明文档,反映最新的目录组织
- 确保文档与实际项目结构保持同步
2026-01-02 00:59:25 +08:00
d80feaa02b test:更新测试文件以适配新的项目结构
- 更新 auth_ui_test.tscn 中的场景引用路径
- 修复 enhanced_toast_test.gd 中的脚本路径引用
- 确保测试文件与重构后的项目结构保持一致
2026-01-02 00:59:05 +08:00
f1a60137e1 fix:修复代码警告和UID冲突问题
- 更新 ProjectPaths.gd 中的路径引用,适配新的目录结构
- 修复 SceneManager.gd 中的场景路径问题
- 更新 project.godot 配置,修复 AutoLoad 路径
- 修复 MainScene 相关文件的 UID 冲突
- 解决代码中的路径引用警告
2026-01-02 00:58:51 +08:00
3175c98ea3 refactor:实现新的项目结构组织
- 添加 _Core/components/ 和 _Core/utils/ 目录
- 重新组织 scenes/ 目录结构,按功能分类
- 迁移 StringUtils.gd 到新的 _Core/utils/ 位置
- 迁移 AuthScene.gd 到新的 scenes/ui/ 位置
- 添加 AI 文档支持目录 docs/AI_docs/
- 添加开发参考文档 claude.md
2026-01-02 00:58:34 +08:00
a18c7a54b1 refactor:重构项目结构,删除旧的文件组织
- 删除旧的 UI/Windows/ 目录下的认证相关文件
- 删除旧的 Utils/ 目录下的工具类文件
- 删除旧的 scenes/Components/ 目录结构
- 为新的目录结构让路
2026-01-02 00:58:16 +08:00
fca3eb79dd chore:清理临时文档文件
- 删除迁移完成标记文件 MIGRATION_COMPLETE.md
- 删除重构说明文件 REFACTORING.md
- 删除结构对比文件 STRUCTURE_COMPARISON.md
- 删除临时文档 cloude.md
2026-01-02 00:57:53 +08:00
e128328d93 Merge pull request 'fix: 修复GDScript警告和UID冲突问题' (#6) from fix/code-warnings-and-uid-conflicts into main
Reviewed-on: #6
2025-12-31 19:36:48 +08:00
fdedb21cbd fix: 修复GDScript警告和UID冲突问题
代码修复:
- NetworkManager.gd: 修复参数名冲突和未使用变量警告
- StringUtils.gd: 修复变量名与内置函数char冲突
- ResponseHandler.gd: 移除static关键字,改为实例方法
- AuthScene.gd: 恢复正确的ResponseHandler调用方式

 资源清理:
- 删除assets/sprites/icon/下的重复图标文件
- 删除UI/Theme/下的重复字体和主题文件
- 统一使用assets/路径下的资源文件

 配置修复:
- 修复LoginWindow.tscn和main_scene.tscn中的UID引用
- 更新chinese_theme.tres中的字体路径引用
- 添加project.godot调试设置以减少渲染器警告

 文档更新:
- 更新项目设置指南中的主题和字体路径引用

解决问题:
-  修复所有GDScript编译警告
-  解决UID重复冲突警告
-  统一资源文件路径结构
-  保持Web部署兼容性
2025-12-31 19:35:20 +08:00
d49983079a Merge pull request 'fix/verification-code-button-state' (#5) from fix/verification-code-button-state into main
Reviewed-on: #5
2025-12-31 19:00:19 +08:00
51e79c6c6d Merge branch 'main' into fix/verification-code-button-state 2025-12-31 19:00:09 +08:00
0edd1c740b docs: 完善项目文档和README,修复字符显示问题
- 修复README.md中的emoji字符显示问题
- 移除文档质量评级系统
- 添加贡献者致谢部分,创建详细的CONTRIBUTORS.md
- 创建核心系统文件EventNames.gd和ProjectPaths.gd
- 更新项目配置文件project.godot,添加输入映射
- 完善各模块文档,修正路径引用问题
- 创建文档更新日志CHANGELOG.md
- 优化文档结构和导航系统
2025-12-31 18:58:38 +08:00
a85a7b4d0e docs: 完善项目入门README,强调输入映射配置的重要性
发现的关键问题:
- 项目代码中使用了输入映射,但project.godot中未配置
- 缺少输入映射会导致游戏无法正常运行

 主要改进:
- 强调输入映射配置为必需步骤
- 添加重要提醒和警告标识
- 新增常见启动问题排查指南
- 明确列出必需的6个输入动作
- 完善完成检查清单

 问题排查:
- 游戏无法响应输入  输入映射未配置
- Invalid action错误  缺少必需输入动作
- AutoLoad单例报错  配置验证问题

 确保新人成功:
- 明确标注必需步骤的优先级
- 提供具体的错误解决方案
- 强调验证配置的重要性
2025-12-31 18:17:58 +08:00
51d2ad1629 docs: 修正项目设置指南,确保信息准确
修正的问题:
- 路径错误: core/managers/  _Core/managers/
- 补充完整的AutoLoad配置列表 (5个单例)
- 修正NetworkManager.login()方法调用方式
- 添加实际的project.godot配置验证

 新增内容:
- 完整的AutoLoad配置表格
- 其他重要项目设置 (主题、渲染、窗口)
- 详细的验证测试代码
- 常见问题排查指南
- 配置检查清单

 确保准确性:
- 所有路径基于实际项目结构验证
- 代码示例基于实际API接口
- 配置信息与project.godot文件一致
2025-12-31 18:13:08 +08:00
6f545b04e9 docs: 更新项目结构说明,匹配实际项目结构
主要更新:
- 根据实际项目目录结构重写文档
- 明确三类团队协作模式:开发、美术、策划
- 详细说明每个目录的职责和使用方式
- 添加团队协作指南和工作流程
- 提供实际的代码示例和配置示例

 新增内容:
- 团队协作模式说明 (开发/美术/策划)
- 详细的目录结构和文件说明
- 开发工作流和版本发布流程
- 最佳实践和规范要求

 确保准确性:
- 所有目录结构都基于实际项目检查
- 文件路径和命名完全匹配当前状态
- 团队职责划分清晰明确
2025-12-31 18:08:31 +08:00
1ff677b3b2 docs: 重新组织文档结构,按开发阶段分类
新的目录结构:
  01-项目入门/     # 新人必读,项目基础
  02-开发规范/     # 编码标准和规范
  03-技术实现/     # 具体开发指导
  04-高级开发/     # 进阶开发技巧
  05-部署运维/     # 发布和部署
  06-功能模块/     # 特定功能文档

 新增导航文档:
- docs/README.md - 完整的文档导航和使用指南
- 各目录下的README.md - 分类说明和使用指导

 优化效果:
- 开发者可以按阶段快速定位需要的文档
- 新人有清晰的学习路径
- 不同角色有针对性的文档推荐
- 提供了问题导向的快速查找功能
2025-12-31 18:02:16 +08:00
2998fd2d11 docs: 补充开发规范相关文档
新增文档:
- docs/输入映射配置.md - 游戏输入配置指南
- docs/架构与通信规范.md - 项目架构和组件通信规范
- docs/实现细节规范.md - 游戏对象具体实现要求
- docs/开发哲学与最佳实践.md - 开发理念和编程最佳实践

 覆盖内容:
- 输入映射的配置方法和验证
- EventSystem事件系统使用规范
- 玩家、NPC、TileMap的实现标准
- 代码质量标准和审查清单
- 性能优化和资源管理指导

这些文档补充了开发规范.md中提到但在docs目录中缺失的内容
2025-12-31 17:50:19 +08:00
60edcc9868 docs: 文档中文化和清理
新增:
- 开发规范.md (翻译自CLAUDE.md)

 重命名为中文:
- project_structure.md  项目结构说明.md
- naming_convention.md  命名规范.md
- code_comment_guide.md  代码注释规范.md
- git_commit_guide.md  Git提交规范.md
- api-documentation.md  API接口文档.md
- network_manager_setup.md  网络管理器设置.md
- setup.md  项目设置指南.md
- testing_guide.md  测试指南.md
- web_deployment_guide.md  Web部署指南.md
- module_development.md  模块开发指南.md
- performance_optimization.md  性能优化指南.md
- scene_design.md  场景设计规范.md
- auth/form_validation.md  auth/表单验证规范.md
- auth/testing_guide.md  auth/认证测试指南.md

 删除总结性文档:
- final_update_summary.md
- web_deployment_changelog.md
- CLAUDE.md
2025-12-31 17:45:04 +08:00
127 changed files with 9140 additions and 4243 deletions

View File

@@ -0,0 +1,7 @@
{
"permissions": {
"allow": [
"Skill(whaletown-developer)"
]
}
}

View File

@@ -0,0 +1,335 @@
---
name: whaletown-developer
description: Automate WhaleTown project's standard development workflow. Use this skill when implementing features, fixing bugs, creating scenes, or any code development tasks. Guides through 7-step process - architecture analysis, implementation, comment/naming validation, testing, and Git commit generation following project conventions.
---
# WhaleTown Standard Development Workflow Skill
This skill automates the standard development workflow for the WhaleTown project, ensuring all developers follow unified specifications and quality standards.
## When to Use This Skill
Activate this skill when:
- Implementing new features ("实现XX功能", "添加XX系统")
- Fixing bugs ("修复XX Bug", "解决XX问题")
- Creating scenes ("创建XX场景", "设计XX界面")
- Developing modules ("开发XX模块", "构建XX组件")
- Any code development task requiring adherence to project standards
## Development Workflow Overview
```
Step 1: Architecture Analysis (读取架构规范)
Step 2: Implementation (按规范编码)
Step 3: Comment Validation (注释规范检查)
Step 4: Naming Validation (命名规范检查)
Step 5: Test Writing (编写测试代码)
Step 6: Test Execution (运行测试验证)
Step 7: Git Commit (生成规范提交信息)
```
## Step-by-Step Workflow
### Step 1: Architecture Analysis
Read and apply the architecture specifications before implementation.
**Actions:**
1. Read `docs/02-开发规范/架构与通信规范.md`
2. Determine file location based on feature type:
- Core systems → `_Core/managers/` or `_Core/systems/`
- Game scenes → `scenes/Maps/`, `scenes/Entities/`, `scenes/Components/`
- UI components → `scenes/ui/`
3. Identify communication method (MUST use EventSystem for cross-module communication)
4. List dependencies (required managers and systems)
5. Design event definitions (add to `_Core/EventNames.gd`)
**Layered Architecture:**
```
UI Layer (界面层) → scenes/ui/
Scenes Layer (游戏层) → scenes/Maps/, scenes/Entities/
_Core Layer (框架层) → _Core/managers/, _Core/systems/
```
**Communication Principle:** "Signal Up, Call Down"
- Parents call child methods (downward calls)
- Children emit signals to notify parents (upward signals)
- Cross-module communication MUST use EventSystem
### Step 2: Implementation
Implement the feature following strict project conventions.
**Requirements:**
- **Type Safety**: All variables and functions MUST have type annotations
```gdscript
var speed: float = 200.0
func move(delta: float) -> void:
```
- **Godot 4.2+ Syntax**: NO `yield()`, use `await`
- **Node Caching**: Use `@onready` to cache node references, avoid `get_node()` in `_process()`
- **EventSystem Communication**: Use EventSystem for cross-module messaging
```gdscript
EventSystem.emit_event(EventNames.PLAYER_MOVED, {"position": global_position})
EventSystem.connect_event(EventNames.INTERACT_PRESSED, _on_interact_pressed)
```
- **Nearest Filter**: All Sprite2D/TileMap resources MUST use Nearest filter (no Linear filter)
- **AutoLoad Restrictions**: Only GameManager, SceneManager, EventSystem, NetworkManager, ResponseHandler allowed as autoloads
- **Low-level Entities**: Do NOT directly reference GameManager in Player/NPC entities, use events instead
### Step 3: Comment Validation
Ensure code comments meet project standards.
**Actions:**
1. Read `docs/02-开发规范/代码注释规范.md`
2. Verify file header comment is complete:
```gdscript
# ============================================================================
# 文件名: FeatureName.gd
# 作用: 简短描述功能
#
# 主要功能:
# - 功能点1
# - 功能点2
#
# 依赖: 列出依赖的管理器/系统
# 作者: [开发者名称]
# 创建时间: YYYY-MM-DD
# ============================================================================
```
3. Verify all public functions have complete documentation:
```gdscript
# 函数功能描述
#
# 参数:
# param_name: Type - 参数说明
#
# 返回值:
# Type - 返回值说明
#
# 使用示例:
# var result = function_name(param)
func function_name(param: Type) -> ReturnType:
```
4. Ensure complex logic has inline comments explaining WHY, not WHAT
### Step 4: Naming Validation
Verify all naming follows project conventions.
**Actions:**
1. Read `docs/02-开发规范/命名规范.md`
2. Validate naming conventions:
- **Class names**: PascalCase (`class_name PlayerController`)
- **Variables/Functions**: camelCase (`var moveSpeed: float`, `func updateMovement()`)
- **Constants**: UPPER_CASE (`const MAX_HEALTH: int = 100`)
- **Private members**: Underscore prefix (`var _velocity: Vector2`)
- **Scene files**: snake_case with suffix (`player_scene.tscn`, `enemy_prefab.tscn`)
- **Script files**: PascalCase.gd (`PlayerController.gd`, `GameManager.gd`)
**Common Patterns:**
```gdscript
# ✅ Correct
const MAX_SPEED: float = 300.0
var currentHealth: int
var _isInitialized: bool = false
func getPlayerPosition() -> Vector2:
func _calculateDamage(baseDamage: int) -> int:
# ❌ Incorrect
const maxSpeed: float = 300.0 # Constants must be UPPER_CASE
var CurrentHealth: int # Variables must be camelCase
var is_initialized: bool = false # No snake_case for variables
func GetPlayerPosition() -> Vector2: # Functions must be camelCase
```
### Step 5: Test Writing
Create unit tests for the implemented functionality.
**Actions:**
1. Read `docs/03-技术实现/测试指南.md`
2. For _Core/ managers/systems, MUST create corresponding test file in `tests/unit/`
3. Test file naming: `test_[name].gd`
4. Test file structure:
```gdscript
extends GutTest
## [FeatureName] 单元测试
var feature: FeatureName
func before_each():
feature = preload("res://_Core/managers/FeatureName.gd").new()
add_child(feature)
func after_each():
feature.queue_free()
func test_initialization():
var result = feature.initialize()
assert_true(result, "Feature should initialize successfully")
func test_core_functionality():
# Test core functionality
pass
```
### Step 6: Test Execution
Run tests to ensure code quality.
**Actions:**
1. Run GUT tests using Bash tool:
```bash
godot --headless -s addons/gut/gut_cmdline.gd -gdir=res://tests/ -ginclude_subdirs
```
2. Verify all tests pass
3. If tests fail:
- Identify the root cause
- Fix the implementation or test
- Re-run tests until all pass
### Step 7: Git Commit
Generate standardized Git commit message.
**Actions:**
1. Read `docs/02-开发规范/Git提交规范.md`
2. Determine commit type based on changes:
- `feat` - New features
- `fix` - Bug fixes
- `docs` - Documentation updates
- `refactor` - Code refactoring
- `perf` - Performance optimization
- `test` - Test additions/modifications
- `scene` - Scene file changes
- `ui` - UI related changes
3. Generate commit message using Chinese colon ():
```
<类型><简短描述>
[可选的详细描述]
```
4. Follow principles:
- **One commit, one change** - Most important rule
- Use imperative verbs (添加, 修复, 更新)
- Keep description concise (< 50 characters)
- If multiple types of changes, split into separate commits
**Examples:**
```bash
# ✅ Good commits
git commit -m "feat实现玩家二段跳功能"
git commit -m "fix修复角色跳跃时的碰撞检测问题"
git commit -m "test添加角色控制器单元测试"
# ❌ Bad commits
git commit -m "fix + feat修复Bug并添加新功能" # Mixed types
git commit -m "update player" # Vague, English
```
## Progress Tracking
Use TodoWrite tool to track workflow progress:
```gdscript
TodoWrite.create_todos([
"Step 1: 架构分析 - 读取架构规范",
"Step 2: 功能实现 - 按规范编码",
"Step 3: 注释规范检查",
"Step 4: 命名规范检查",
"Step 5: 测试代码编写",
"Step 6: 测试验证 - 运行测试",
"Step 7: Git 提交 - 生成提交信息"
])
```
Mark each step as `completed` immediately after finishing.
## Quality Checklist
Before completing the workflow, verify:
- [ ] File location follows layered architecture (_Core, scenes, UI)
- [ ] Uses EventSystem for cross-module communication
- [ ] Event names added to EventNames.gd
- [ ] All variables and functions have type annotations
- [ ] Naming conventions correct (PascalCase/camelCase/UPPER_CASE)
- [ ] File header comment complete
- [ ] Public functions have complete documentation
- [ ] Unit tests created and passing
- [ ] Git commit message follows specification
- [ ] No Godot 3.x syntax (yield → await)
- [ ] Node references cached with @onready
- [ ] Sprite2D/TileMap use Nearest filter
## Reference Documents
The skill automatically reads these documents at appropriate steps:
- Architecture: `docs/02-开发规范/架构与通信规范.md`
- Comments: `docs/02-开发规范/代码注释规范.md`
- Naming: `docs/02-开发规范/命名规范.md`
- Testing: `docs/03-技术实现/测试指南.md`
- Git: `docs/02-开发规范/Git提交规范.md`
- Project Instructions: `claude.md` (root directory)
For detailed checklist reference, see `references/checklist.md` in this skill directory.
## Example Workflow
User request: "实现玩家二段跳功能"
1. **Architecture Analysis** ✅
- Read architecture spec
- Target: `scenes/Entities/Player/Player.gd`
- Communication: Emit `PLAYER_DOUBLE_JUMPED` event
- Dependencies: EventSystem, Input
- Event: Add `PLAYER_DOUBLE_JUMPED` to EventNames.gd
2. **Implementation** ✅
- Create double jump logic with type annotations
- Use EventSystem.emit_event() for notifications
- Cache references with @onready
- Use await instead of yield
3. **Comment Validation** ✅
- Add file header with feature description
- Document double jump function parameters
- Add inline comments for jump logic
4. **Naming Validation** ✅
- Verify: `var canDoubleJump: bool` (camelCase)
- Verify: `const MAX_DOUBLE_JUMPS: int` (UPPER_CASE)
- Verify: `func performDoubleJump()` (camelCase)
5. **Test Writing** ✅
- Create `tests/unit/test_player_double_jump.gd`
- Test initialization, jump execution, limits
6. **Test Execution** ✅
- Run: `godot --headless -s addons/gut/gut_cmdline.gd`
- All tests pass ✅
7. **Git Commit** ✅
```bash
git add scenes/Entities/Player/Player.gd _Core/EventNames.gd tests/unit/test_player_double_jump.gd
git commit -m "feat实现玩家二段跳功能"
```
## Notes
- This skill enforces quality standards through automated validation
- Each step builds upon the previous, ensuring comprehensive quality control
- Skipping steps will result in incomplete or non-compliant code
- The 7-step workflow is designed for team consistency and maintainability

View File

@@ -0,0 +1,285 @@
# WhaleTown Development Quality Checklist
快速参考检查清单,用于验证代码是否符合项目规范。
## 架构检查清单
### 文件位置
- [ ] 核心系统文件位于 `_Core/managers/``_Core/systems/`
- [ ] 游戏场景文件位于 `scenes/Maps/`, `scenes/Entities/`, `scenes/Components/`
- [ ] UI 组件文件位于 `scenes/ui/`
- [ ] 测试文件位于 `tests/unit/``tests/integration/`
### 通信方式
- [ ] 跨模块通信使用 EventSystem
- [ ] 新增事件定义在 `_Core/EventNames.gd`
- [ ] 遵循 "Signal Up, Call Down" 原则
- [ ] 父节点调用子节点方法(向下调用)
- [ ] 子节点发出信号通知父节点(向上信号)
### 依赖管理
- [ ] 仅使用允许的自动加载GameManager, SceneManager, EventSystem, NetworkManager, ResponseHandler
- [ ] 底层实体Player, NPC不直接访问 GameManager
- [ ] 底层实体通过事件系统与全局管理器通信
---
## 代码规范检查清单
### 类型安全
- [ ] 所有变量都有类型注解:`var speed: float = 200.0`
- [ ] 所有函数都有参数和返回值类型:`func move(delta: float) -> void:`
- [ ] 常量都有类型注解:`const MAX_HEALTH: int = 100`
### Godot 4.2+ 语法
- [ ] 使用 `await` 代替 `yield()`
- [ ] 使用 `@onready` 缓存节点引用
- [ ] 避免在 `_process()` 中使用 `get_node()`
- [ ] 信号连接使用 `.connect()` 语法
### 资源设置
- [ ] 所有 Sprite2D 使用 Nearest 滤镜(不使用 Linear
- [ ] 所有 TileMap 使用 Nearest 滤镜
---
## 命名规范检查清单
### 类名
- [ ] 使用 PascalCase`class_name PlayerController`
- [ ] 文件名与类名一致:`PlayerController.gd`
### 变量
- [ ] 公共变量使用 camelCase`var moveSpeed: float`
- [ ] 私有变量使用下划线前缀:`var _velocity: Vector2`
- [ ] 布尔变量使用 is/has/can 前缀:`var isJumping: bool`
### 函数
- [ ] 使用 camelCase`func updateMovement()`
- [ ] 获取函数使用 `get` 前缀:`func getPlayerPosition()`
- [ ] 设置函数使用 `set` 前缀:`func setHealth(value: int)`
- [ ] 判断函数使用 `is/has/can` 前缀:`func isAlive()`, `func canJump()`
- [ ] 私有函数使用下划线前缀:`func _calculateDamage()`
### 常量
- [ ] 使用 UPPER_CASE`const MAX_HEALTH: int = 100`
- [ ] 使用下划线分隔:`const JUMP_FORCE: float = -400.0`
### 枚举
- [ ] 枚举类型使用 PascalCase`enum PlayerState`
- [ ] 枚举值使用 UPPER_CASE`IDLE, WALKING, RUNNING`
### 文件命名
- [ ] 脚本文件PascalCase.gd (`PlayerController.gd`)
- [ ] 场景文件snake_case_scene.tscn (`main_scene.tscn`)
- [ ] 预制体文件snake_case_prefab.tscn (`player_prefab.tscn`)
- [ ] 资源文件snake_case (`sprite_player_idle.png`)
---
## 注释规范检查清单
### 文件头注释
- [ ] 包含文件名
- [ ] 包含作用描述
- [ ] 列出主要功能
- [ ] 列出依赖的管理器/系统
- [ ] 包含作者和创建时间
示例:
```gdscript
# ============================================================================
# 文件名: PlayerController.gd
# 作用: 玩家角色控制器,处理玩家输入和移动逻辑
#
# 主要功能:
# - 处理键盘和手柄输入
# - 控制角色移动和跳跃
# - 管理角色状态切换
#
# 依赖: EventSystem, InputManager
# 作者: [开发者名称]
# 创建时间: 2025-01-03
# ============================================================================
```
### 函数注释
- [ ] 公共函数有完整注释
- [ ] 包含功能描述
- [ ] 列出参数说明(名称、类型、含义)
- [ ] 说明返回值(类型、含义)
- [ ] 提供使用示例(对于复杂函数)
- [ ] 标注注意事项(如果有)
示例:
```gdscript
# 处理玩家输入并更新移动状态
#
# 参数:
# delta: float - 帧时间间隔
#
# 返回值: 无
#
# 注意事项:
# - 需要在 _physics_process 中调用
# - 会自动处理重力和碰撞
func handleMovement(delta: float) -> void:
```
### 行内注释
- [ ] 复杂逻辑有注释说明
- [ ] 注释解释 WHY为什么不解释 WHAT是什么
- [ ] 避免显而易见的注释
- [ ] 使用 TODO/FIXME/NOTE 等标记
---
## 测试规范检查清单
### 测试文件
- [ ] _Core/ 中的管理器/系统都有对应测试文件
- [ ] 测试文件位于 `tests/unit/``tests/integration/`
- [ ] 测试文件命名:`test_[name].gd`
- [ ] 测试文件继承自 GutTest`extends GutTest`
### 测试结构
- [ ] 包含测试类注释
- [ ] 实现 `before_each()` 进行测试前置设置
- [ ] 实现 `after_each()` 进行测试清理
- [ ] 测试方法命名:`test_[功能名称]()`
### 测试覆盖
- [ ] 测试核心功能的正常流程
- [ ] 测试错误处理和边界条件
- [ ] 测试初始化和清理逻辑
- [ ] 所有测试都能通过
示例:
```gdscript
extends GutTest
## PlayerController 单元测试
var player: PlayerController
func before_each():
player = preload("res://scenes/Entities/Player/PlayerController.gd").new()
add_child(player)
func after_each():
player.queue_free()
func test_initialization():
var result = player.initialize()
assert_true(result, "Player should initialize successfully")
func test_movement():
# 测试移动功能
pass
```
---
## Git 提交规范检查清单
### 提交类型
- [ ] 使用正确的提交类型:
- `feat` - 新功能
- `fix` - Bug 修复
- `docs` - 文档更新
- `refactor` - 代码重构
- `test` - 测试相关
- `scene` - 场景文件
- `ui` - UI 相关
### 提交格式
- [ ] 使用中文冒号(:)
- [ ] 描述简洁明了(< 50 字符)
- [ ] 使用动词开头(添加、修复、更新)
- [ ] 一次提交只包含一种类型的改动
### 提交原则
- [ ] 一次提交只做一件事
- [ ] 提交的代码能够正常运行
- [ ] 避免 fix + feat 混合提交
- [ ] 如需多种改动,拆分成多次提交
示例:
```bash
# ✅ 正确
git commit -m "feat实现玩家二段跳功能"
git commit -m "fix修复角色跳跃时的碰撞检测问题"
git commit -m "test添加角色控制器单元测试"
# ❌ 错误
git commit -m "fix + feat修复Bug并添加新功能" # 混合类型
git commit -m "update player" # 描述不清晰,使用英文
git commit -m "fix: 修复Bug" # 使用英文冒号
```
---
## 完整工作流检查清单
使用此清单验证开发任务是否完整执行 7 步工作流:
### Step 1: 架构分析
- [ ] 已读取 `docs/02-开发规范/架构与通信规范.md`
- [ ] 已确定文件位置_Core, scenes, UI
- [ ] 已确定通信方式EventSystem
- [ ] 已列出依赖的管理器/系统
- [ ] 已设计事件定义(如需要)
### Step 2: 功能实现
- [ ] 代码遵循分层架构
- [ ] 所有变量和函数有类型注解
- [ ] 使用 Godot 4.2+ 语法
- [ ] 使用 EventSystem 进行跨模块通信
- [ ] 使用 @onready 缓存节点引用
### Step 3: 注释规范检查
- [ ] 已读取 `docs/02-开发规范/代码注释规范.md`
- [ ] 文件头注释完整
- [ ] 公共函数有完整注释
- [ ] 复杂逻辑有行内注释
### Step 4: 命名规范检查
- [ ] 已读取 `docs/02-开发规范/命名规范.md`
- [ ] 类名使用 PascalCase
- [ ] 变量/函数使用 camelCase
- [ ] 常量使用 UPPER_CASE
- [ ] 私有成员使用下划线前缀
### Step 5: 测试代码编写
- [ ] 已读取 `docs/03-技术实现/测试指南.md`
- [ ] 创建了测试文件 `tests/unit/test_[name].gd`
- [ ] 测试文件继承自 GutTest
- [ ] 编写了核心功能测试
### Step 6: 测试验证
- [ ] 运行了 GUT 测试命令
- [ ] 所有测试通过
- [ ] 如有失败,已修复并重新测试
### Step 7: Git 提交
- [ ] 已读取 `docs/02-开发规范/Git提交规范.md`
- [ ] 生成了符合规范的提交信息
- [ ] 提交类型正确
- [ ] 使用中文冒号
- [ ] 遵循"一次提交只做一件事"原则
---
## 快速自检问题
在提交代码前,问自己以下问题:
1. **架构**: 文件放在正确的位置了吗?
2. **通信**: 是否使用 EventSystem 进行跨模块通信?
3. **类型**: 所有变量和函数都有类型注解吗?
4. **命名**: 命名是否符合规范PascalCase/camelCase/UPPER_CASE
5. **注释**: 文件头和公共函数有完整注释吗?
6. **测试**: 创建并运行测试了吗?所有测试都通过了吗?
7. **提交**: Git 提交信息符合规范吗?
如果以上问题都能回答"是",那么代码已经符合 WhaleTown 项目的质量标准!✅

View File

@@ -0,0 +1,312 @@
# WhaleTown Developer Skill 使用说明
## 📖 简介
`whaletown-developer` 是 WhaleTown 项目的标准开发工作流自动化技能,确保所有开发任务都遵循统一的项目规范和质量标准。
## 🎯 适用场景
在以下情况下使用此 skill
- ✅ 实现新功能("实现玩家二段跳"、"添加存档系统"
- ✅ 修复 Bug"修复角色碰撞问题"、"解决UI显示错误"
- ✅ 创建场景("创建商店场景"、"设计背包界面"
- ✅ 开发模块("开发任务系统"、"构建战斗组件"
- ✅ 任何需要遵循项目规范的代码开发任务
## 🚀 调用方式
### 方式一:通过 Claude推荐
```
用户:帮我实现一个 NPC
Claude/whaletown-developer 实现一个 NPC
```
### 方式二:直接请求
```
用户:使用 whaletown-developer skill 创建玩家移动系统
```
## 📋 7 步工作流程
skill 会自动执行以下标准化流程:
```
Step 1: 架构分析
↓ 读取架构规范,确定文件位置、通信方式、依赖关系
Step 2: 功能实现
↓ 按照类型安全、命名规范、EventSystem 通信等要求编码
Step 3: 注释规范检查
↓ 验证文件头、函数文档、行内注释是否完整
Step 4: 命名规范检查
↓ 验证 PascalCase/camelCase/UPPER_CASE 命名规范
Step 5: 测试代码编写
↓ 为核心功能创建 GUT 单元测试
Step 6: 测试验证
↓ 运行测试确保功能正常
Step 7: Git 提交
↓ 生成符合规范的提交信息
```
## 💡 使用示例
### 示例 1创建玩家控制器
**用户输入:**
```
帮我创建一个玩家角色控制器
```
**Skill 执行:**
1. 分析架构 → 确定放在 `scenes/Entities/Player/PlayerController.gd`
2. 实现功能 → 创建带类型注解的移动、跳跃逻辑
3. 检查注释 → 添加完整的文件头和函数文档
4. 检查命名 → 确保 `moveSpeed``MAX_HEALTH` 等命名正确
5. 编写测试 → 创建 `tests/unit/test_player_controller.gd`
6. 运行测试 → 验证功能正常
7. 生成提交 → `feat实现玩家角色控制器`
### 示例 2修复跳跃 Bug
**用户输入:**
```
修复玩家跳跃时的碰撞检测问题
```
**Skill 执行:**
1. 分析架构 → 定位到 `scenes/Entities/Player/Player.gd`
2. 实现修复 → 修改碰撞检测逻辑
3. 检查注释 → 添加修复说明注释
4. 检查命名 → 确保变量命名规范
5. 编写测试 → 添加碰撞测试用例
6. 运行测试 → 确认 Bug 已修复
7. 生成提交 → `fix修复玩家跳跃时的碰撞检测问题`
### 示例 3添加事件通信
**用户输入:**
```
实现 NPC 对话系统的事件通信
```
**Skill 执行:**
1. 分析架构 → 使用 EventSystem 跨模块通信
2. 实现功能 → 在 EventNames.gd 添加 `NPC_DIALOG_STARTED` 事件
3. 检查注释 → 文档化事件数据格式
4. 检查命名 → 确保事件名称符合规范
5. 编写测试 → 测试事件发送和接收
6. 运行测试 → 验证通信正常
7. 生成提交 → `feat实现NPC对话系统的事件通信`
## ✅ 质量保证
每次使用 skill 后,代码都会符合以下标准:
### 架构层面
- ✅ 文件位置符合分层架构_Core、scenes、UI
- ✅ 使用 EventSystem 实现跨模块通信
- ✅ 事件名称已添加到 EventNames.gd
- ✅ 遵循"Signal Up, Call Down"原则
### 代码质量
- ✅ 所有变量和函数都有类型注解
- ✅ 命名规范正确PascalCase/camelCase/UPPER_CASE
- ✅ 使用 Godot 4.2+ 语法await 而非 yield
- ✅ 节点引用使用 @onready 缓存
### 文档规范
- ✅ 文件头注释完整(文件名、作用、功能、依赖)
- ✅ 公共函数有完整文档(参数、返回值、示例)
- ✅ 复杂逻辑有行内注释说明
### 测试覆盖
- ✅ 核心功能有单元测试
- ✅ 测试文件命名规范test_*.gd
- ✅ 测试通过验证
### Git 规范
- ✅ 提交信息格式正确(类型:描述)
- ✅ 遵循"一次提交只做一件事"原则
- ✅ 使用中文冒号和动词开头
## 📚 相关文档
Skill 会自动读取以下规范文档:
- `docs/02-开发规范/架构与通信规范.md` - 分层架构和 EventSystem
- `docs/02-开发规范/代码注释规范.md` - 注释格式要求
- `docs/02-开发规范/命名规范.md` - 命名约定
- `docs/03-技术实现/测试指南.md` - 测试框架使用
- `docs/02-开发规范/Git提交规范.md` - 提交信息格式
- `CLAUDE.md` - 项目总体指导
## ⚙️ 配置文件
Skill 相关配置文件位置:
```
.claude/skills/whaletown-developer/
├── SKILL.md # Skill 定义文件
├── 使用说明.md # 本文档
└── references/
└── checklist.md # 质量检查清单
```
## 🔄 工作流程可视化
```
用户请求
调用 whaletown-developer skill
[Step 1] 架构分析
├─ 读取架构规范文档
├─ 确定文件位置
├─ 识别通信方式
└─ 设计事件定义
[Step 2] 功能实现
├─ 遵循类型安全
├─ 使用 EventSystem
├─ 缓存节点引用
└─ 使用 Godot 4.2+ 语法
[Step 3] 注释规范检查
├─ 验证文件头注释
├─ 验证函数文档
└─ 检查行内注释
[Step 4] 命名规范检查
├─ 类名 PascalCase
├─ 变量/函数 camelCase
├─ 常量 UPPER_CASE
└─ 私有成员 _prefix
[Step 5] 测试代码编写
├─ 创建测试文件
├─ 编写测试用例
└─ 覆盖核心功能
[Step 6] 测试验证
├─ 运行 GUT 测试
├─ 验证测试通过
└─ 修复失败测试
[Step 7] Git 提交
├─ 确定提交类型
├─ 生成提交信息
└─ 遵循提交规范
完成 ✅
```
## 🎓 最佳实践
### 1. 明确任务描述
```bash
# ✅ 好的描述
"实现玩家二段跳功能"
"修复敌人AI路径寻找Bug"
"创建商店购买界面"
# ❌ 模糊描述
"改一下玩家"
"修复Bug"
"做个界面"
```
### 2. 一次处理一个功能
```bash
# ✅ 推荐
用户:实现玩家移动
用户:实现玩家跳跃
# ❌ 不推荐
用户:实现玩家移动、跳跃、攻击、技能系统
```
### 3. 信任 Skill 流程
- Skill 会按照 7 步流程确保质量
- 不需要手动检查命名、注释等细节
- 专注于功能需求和业务逻辑
### 4. 查看生成的提交信息
- Skill 会在 Step 7 生成规范的提交信息
- 可以直接使用或根据需要微调
## ⚠️ 注意事项
1. **首次使用**
- 确保已阅读 `CLAUDE.md` 了解项目规范
- 确认所有规范文档都已存在
2. **测试环境**
- 确保 GUT 测试框架已安装(如需运行测试)
- Godot 可执行文件在 PATH 中Step 6 测试执行)
3. **中断处理**
- 如果工作流被中断,可以继续执行剩余步骤
- Skill 使用 TodoWrite 追踪进度
4. **规范更新**
- 项目规范文档更新时Skill 会自动读取最新版本
- 无需手动同步
## 🤝 反馈与改进
如果遇到问题或有改进建议:
1. 检查是否所有规范文档都已更新
2. 确认任务描述清晰明确
3. 查看 Skill 执行日志定位问题
4. 向团队报告问题或建议
## 📊 效果对比
### 不使用 Skill
```
开发者手动:
1. 不确定文件放哪里 ❌
2. 可能忘记类型注解 ❌
3. 注释不完整 ❌
4. 命名不一致 ❌
5. 没有测试 ❌
6. 提交信息格式错误 ❌
结果:代码质量参差不齐
```
### 使用 Skill
```
Skill 自动化:
1. 自动确定正确位置 ✅
2. 强制类型安全 ✅
3. 完整注释文档 ✅
4. 统一命名规范 ✅
5. 自动生成测试 ✅
6. 规范提交信息 ✅
结果:高质量、一致性代码
```
## 🎯 总结
whaletown-developer skill 是你的开发助手,它会:
- 🤖 **自动化** 7 步标准流程
- 📏 **标准化** 代码质量
- 🔒 **保证** 规范遵循
-**加速** 开发效率
- 🧪 **确保** 测试覆盖
**记住:专注于功能实现,让 Skill 处理规范和质量!**
---
**开始使用:** 只需告诉 Claude "帮我实现 XXX 功能" 即可!

View File

@@ -1,96 +0,0 @@
# 🎯 CLAUDE.md - WhaleTown Project Instructions
## 1. Project Vision & Context
- **Project**: "WhaleTown" - A 2D top-down pixel art RPG.
- **Engine**: Godot 4.2+ (Strictly NO Godot 3.x syntax).
- **Architecture**: Strictly layered: `_Core` (Framework), `Scenes` (Gameplay), `UI` (Interface).
- **Core Principle**: "Signal Up, Call Down". High decoupling via `EventSystem`.
## 2. 🛠 Command Reference & Setup
- **Input Map (Required Configuration)**:
- `move_left`, `move_right`, `move_up`, `move_down` (WASD / Arrows)
- `interact` (E Key / Space)
- `pause` (ESC)
- **Run Game**: `godot --path .`
- **Run Tests (GUT)**: `godot --headless -s addons/gut/gut_cmdline.gd -gdir=res://tests/ -ginclude_subdirs`
- **Init Structure**: `mkdir -p _Core/managers _Core/systems Scenes/Maps Scenes/Entities Scenes/Components UI/Windows UI/HUD Assets/Sprites tests/unit tests/integration`
## 3. 📂 File Path Rules (STRICT LOWERCASE)
*Claude: Root folders MUST be lowercase. Scripts and Scenes MUST stay together.*
- **Core Managers**: `_Core/managers/[Name].gd`
- **Core Systems**: `_Core/systems/[Name].gd`
- **Entities**: `Scenes/Entities/[EntityName]/[EntityName].tscn` (Script `.gd` in same folder).
- **Maps**: `Scenes/Maps/[map_name].tscn`
- **Components**: `Scenes/Components/[ComponentName].gd` (Reusable logic nodes).
- **UI Windows**: `UI/Windows/[WindowName].tscn`
- **Tests**: `tests/[unit|integration]/test_[name].gd` (Folder is lowercase `tests`).
## 4. 📋 Coding Standards (The Law)
- **Type Safety**: ALWAYS use strict static typing: `var speed: float = 100.0`, `func _ready() -> void`.
- **Naming Conventions**:
- `class_name PascalCase` at the top of every script.
- Variables/Functions: `snake_case`. Constants: `SCREAMING_SNAKE_CASE`.
- Private members: Prefix with underscore `_` (e.g., `var _health: int`).
- **Node Access**: Use `%UniqueName` for UI and internal scene components.
- **Signals**: Use "Signal Up, Call Down". Parent calls child methods; Child emits signals.
- **Forbidden Patterns**:
- ❌ NO `yield()` -> Use `await`.
- ❌ NO `get_node()` in `_process` -> Cache with `@onready`.
- ❌ NO Linear Filter -> All Sprite2D/TileMap resources MUST use **Nearest** filter.
## 5. 🏛 Architecture & Communication
- **EventSystem**: Use `_Core/systems/EventSystem.gd` for cross-module messaging.
- **Event Registry**: Use `class_name EventNames` in `_Core/EventNames.gd`.
```gdscript
class_name EventNames
const PLAYER_MOVED = "player_moved"
const INTERACT_PRESSED = "interact_pressed"
const NPC_TALKED = "npc_talked"
Singletons: Only GameManager, SceneManager, EventSystem allowed as Autoloads.
Decoupling: Low-level entities MUST NOT reference GameManager. Use events.
6. 🏗 Implementation Details
Player: CharacterBody2D. Must include Camera2D with position_smoothing_enabled = true.
NPC/Interactables: Use Area2D named InteractionArea. Trigger via EventSystem.
TileMap Layers:
Layer 0: Ground (No collision).
Layer 1: Obstacles (Physics Layer enabled).
Layer 2: Decoration (Y-Sort enabled).
Camera: Must auto-calculate limits via TileMap.get_used_rect().
7. 🧪 Testing Requirements (MANDATORY)
Coverage: Every Manager/System in _Core/ MUST have a GUT test.
Naming: Test files must start with test_ and extend GutTest.
Example:
code
Gdscript
extends GutTest
func test_event_emission():
var sender = Node.new()
watch_signals(EventSystem)
EventSystem.emit_event(EventNames.PLAYER_MOVED, {})
assert_signal_emitted(EventSystem, "event_raised")
8. 🧘 The Zen of Development
Juice or Death: Every interaction (UI popup, NPC talk) MUST have a Tween placeholder.
Zero Magic Numbers: All speeds/timers MUST be @export or defined in Config/.
Simplicity: If a function does two things, split it.
Back of the Fence: Hidden logic (like ResponseHandler.gd) must be as clean as the HUD.
9. 📝 Code Template (Entity Pattern)
code
Gdscript
extends CharacterBody2D
class_name Player
# 1. Exports & Constants
@export var move_speed: float = 200.0
# 2. Node References
@onready var sprite: Sprite2D = %Sprite2D
# 3. Lifecycle
func _physics_process(delta: float) -> void:
_move(delta)
# 4. Private Methods
func _move(_delta: float) -> void:
var dir := Input.get_vector("move_left", "move_right", "move_up", "move_down")
velocity = dir * move_speed
move_and_slide()

View File

@@ -1,235 +0,0 @@
# ✅ 项目结构重构完成报告
## 📅 完成时间
2025-12-31
## 🎉 重构成功
项目已成功从混乱的文件结构重构为清晰、模块化的架构!
---
## 📊 最终结构总览
```
whale-town-front/
├── _Core/ ✅ [框架层] 全局单例和系统
├── Scenes/ ✅ [玩法层] 游戏世界实体
├── UI/ ✅ [界面层] 所有UI界面
├── Assets/ ✅ [资源层] 美术资源
├── Config/ ✅ [配置层] 静态数据
├── Utils/ ✅ [工具层] 工具类
├── Tests/ ✅ [测试层] 测试脚本
└── docs/ 📄 项目文档
```
---
## ✅ 已完成的迁移
### 1⃣ 框架层 (_Core/)
-`GameManager.gd``_Core/managers/`
-`SceneManager.gd``_Core/managers/` (已更新路径)
-`NetworkManager.gd``_Core/managers/`
-`ResponseHandler.gd``_Core/managers/`
-`EventSystem.gd``_Core/systems/`
### 2⃣ 场景层 (Scenes/)
-`scenes/main_scene.tscn``Scenes/Maps/main_scene.tscn`
-`scripts/scenes/MainScene.gd``Scenes/Maps/MainScene.gd`
-`scenes/prefabs/``Scenes/Components/`
### 3⃣ 界面层 (UI/)
-`scenes/auth_scene.tscn``UI/Windows/LoginWindow.tscn`
-`scripts/scenes/AuthScene.gd``UI/Windows/AuthScene.gd`
-`assets/ui/chinese_theme.tres``UI/Theme/MainTheme.tres`
-`assets/fonts/``UI/Theme/Fonts/`
### 4⃣ 配置层 (Config/)
-`data/configs/game_config.json``Config/game_config.json`
-`data/localization/zh_CN.json``Config/zh_CN.json`
### 5⃣ 工具层 (Utils/)
-`core/utils/StringUtils.gd``Utils/StringUtils.gd`
### 6⃣ 资源层 (Assets/)
-`assets/sprites/``Assets/Sprites/`
-`assets/audio/``Assets/Audio/`
- ✅ 其他资源文件保留在 `assets/`(待后续整理)
### 7⃣ 构建脚本
-`scripts/build_web.sh``./build_web.sh`
-`scripts/serve_web.sh``./serve_web.sh`
---
## 🗑️ 已删除的旧目录
-`core/` - 已迁移到 `_Core/`
-`module/` - 空目录,未使用
-`scripts/` - 脚本已内联到场景目录
-`scenes/` - 已迁移到 `Scenes/``UI/`
-`data/` - 配置已移至 `Config/`
---
## 🔧 已更新的配置
### project.godot
```ini
✅ run/main_scene="res://Scenes/Maps/main_scene.tscn"
✅ GameManager="*res://_Core/managers/GameManager.gd"
✅ SceneManager="*res://_Core/managers/SceneManager.gd"
✅ EventSystem="*res://_Core/systems/EventSystem.gd"
✅ NetworkManager="*res://_Core/managers/NetworkManager.gd"
✅ ResponseHandler="*res://_Core/managers/ResponseHandler.gd"
```
### SceneManager.gd
```gdscript
"main": "res://Scenes/Maps/main_scene.tscn"
"auth": "res://UI/Windows/LoginWindow.tscn"
```
### 测试文件
```gdscript
tests/auth/enhanced_toast_test.gd -
tests/auth/auth_ui_test.tscn -
```
---
## 📚 创建的文档
1. **REFACTORING.md** - 详细的重构文档
- 迁移映射表
- 设计原则
- 注意事项
- 后续建议
2. **STRUCTURE_COMPARISON.md** - 结构对比分析
- 旧结构问题分析
- 新结构优势说明
- 对比表格
- 团队协作改进
---
## 🎯 关键改进
### 清晰的分层
- **_Core**: 框架代码,全局系统
- **Scenes**: 游戏世界,地图和实体
- **UI**: 所有界面HUD和弹窗
- **Config**: 静态数据,策划可编辑
- **Utils**: 通用工具函数库
### 组件化设计
```gdscript
Scenes/Components/ //
characters/ //
effects/ //
items/ //
ui/ // UI预制体
```
### 场景内聚
- 每个 `.tscn` 配套一个 `.gd`
- 脚本紧邻场景文件
- 符合 Godot 原生习惯
### UI 独立化
```
UI/
├── Windows/ // 模态窗口(登录、设置)
├── HUD/ // 常驻界面(聊天框)
├── Dialog/ // 对话系统
└── Theme/ // 全局样式
```
---
## ⚠️ 后续步骤
### 必做事项
- [ ] 在 Godot 编辑器中打开项目,让编辑器重新索引文件
- [ ] 测试主场景加载: `Scenes/Maps/main_scene.tscn`
- [ ] 验证登录窗口: `UI/Windows/LoginWindow.tscn`
- [ ] 测试所有自动加载脚本
- [ ] 运行完整测试套件
### 建议优化
- [ ] 补充 `Scenes/Components/` 下的可复用组件
- [ ] 完善 `UI/HUD/``UI/Dialog/`
- [ ] 添加 `Scenes/Entities/Player/` 玩家实体
- [ ] 将硬编码数值移至 `Config/`
### 代码审查
- [ ] 检查是否还有硬编码的旧路径
- [ ] 验证所有 `.import` 文件正常
- [ ] 确认网络连接功能正常
- [ ] 验证 UI 主题显示正确
---
## 🎓 团队协作指南
### 工作目录划分
```
🎨 美术组 → Assets/Sprites/, Assets/Audio/
📋 策划组 → Config/
💻 前端程序 → UI/, Scenes/Entities/
⚙️ 后端程序 → _Core/, Utils/
🧪 测试组 → Tests/
```
### Git 提交建议
```bash
# 按目录分类提交
git add _Core/
git commit -m "refactor: 迁移核心框架代码到 _Core/"
git add Scenes/
git commit -m "refactor: 重组场景文件到 Scenes/"
git add UI/
git commit -m "refactor: 独立 UI 界面到 UI/"
```
---
## 📈 预期收益
### 可维护性提升
- 🟢 目录职责清晰,降低认知负担
- 🟢 新人快速定位文件
- 🟢 减少代码冲突
### 开发效率提升
- 🟢 组件复用更容易
- 🟢 团队协作更流畅
- 🟢 代码审查更高效
### 符合最佳实践
- ✅ Godot 官方推荐结构
- ✅ 场景内聚原则
- ✅ 组件化设计思想
- ✅ 配置与代码分离
---
## 🎉 总结
**重构完成!** 项目现在拥有:
- ✅ 清晰的 6 层架构
- ✅ 符合 Godot 最佳实践
- ✅ 易于维护和扩展
- ✅ 团队协作友好
感谢您的耐心!如有问题,请查看详细文档:
- [REFACTORING.md](./REFACTORING.md) - 重构详情
- [STRUCTURE_COMPARISON.md](./STRUCTURE_COMPARISON.md) - 结构对比
---
**下一步:在 Godot 编辑器中打开项目并测试!** 🚀

914
README.md

File diff suppressed because it is too large Load Diff

View File

@@ -1,222 +0,0 @@
# 项目结构重构文档
## 📅 重构时间
2025-12-31
## 🎯 重构目标
将项目从混乱的文件结构重构为清晰、模块化的架构,采用 Godot 最佳实践。
## 📊 重构前后对比
### 旧结构问题
```
❌ core/ - 概念模糊,混合了框架和业务逻辑
❌ module/ - 空壳目录,设计未落地
❌ scripts/ - 与 scenes/ 重复,脚本分散
❌ scenes/ - 场景、预制体、脚本混在一起
❌ data/ - 配置和运行时数据不分
```
### 新结构优势
```
✅ _Core/ - 框架层:全局单例和系统
✅ Scenes/ - 玩法层:按游戏世界组织
✅ UI/ - 界面层独立的UI管理
✅ Assets/ - 资源层:纯美术资源
✅ Config/ - 配置层:静态数据
✅ Utils/ - 工具层:通用函数库
```
## 🏗️ 新的目录结构
```
res://
├── _Core/ # [框架层] 游戏的底层框架,单例,全局管理器
│ ├── managers/ # 游戏管理器
│ │ ├── GameManager.gd # 游戏状态管理
│ │ ├── SceneManager.gd # 场景管理(已更新路径)
│ │ ├── NetworkManager.gd # 网络通信
│ │ └── ResponseHandler.gd # API响应处理
│ ├── systems/ # 核心系统
│ │ └── EventSystem.gd # 事件系统
│ └── singletons/ # 其他单例(待扩展)
├── Scenes/ # [玩法层] 具体的游戏场景、实体、地图
│ ├── Maps/ # 地图场景
│ │ └── main_scene.tscn # 主游戏场景
│ ├── Entities/ # 游戏实体
│ │ ├── Player/ # 玩家实体
│ │ ├── NPC/ # NPC实体
│ │ └── Interactables/ # 交互物
│ └── Components/ # 可复用组件
├── UI/ # [界面层] 所有UI相关的预制体和逻辑
│ ├── HUD/ # 抬头显示(常驻)
│ ├── Windows/ # 模态窗口
│ │ └── LoginWindow.tscn # 登录窗口原auth_scene.tscn
│ ├── Dialog/ # 对话系统
│ └── Theme/ # 全局样式
│ ├── MainTheme.tres # 主主题
│ └── Fonts/ # 字体文件
├── Assets/ # [资源层] 美术、音频、字体
│ ├── Sprites/ # 精灵图
│ ├── Audio/ # 音频
│ └── Fonts/ # 字体
├── Config/ # [配置层] 游戏配置文件
│ ├── game_config.json # 游戏配置
│ └── zh_CN.json # 中文本地化
├── Utils/ # [工具层] 通用辅助脚本
│ └── StringUtils.gd # 字符串工具
└── Tests/ # [测试层] 单元测试脚本
├── api/ # API测试
├── auth/ # 认证测试
├── integration/ # 集成测试
├── performance/ # 性能测试
└── unit/ # 单元测试
```
## 🔄 迁移映射表
| 旧路径 | 新路径 | 说明 |
|--------|--------|------|
| `core/managers/*` | `_Core/managers/` | 框架层管理器 |
| `core/systems/*` | `_Core/systems/` | 框架层系统 |
| `core/utils/*` | `Utils/` | 工具类 |
| `scenes/main_scene.tscn` | `Scenes/Maps/main_scene.tscn` | 主游戏场景 |
| `scenes/auth_scene.tscn` | `UI/Windows/LoginWindow.tscn` | 登录窗口 |
| `data/configs/*.json` | `Config/` | 配置文件 |
| `data/localization/*.json` | `Config/` | 本地化配置 |
| `assets/ui/chinese_theme.tres` | `UI/Theme/MainTheme.tres` | UI主题 |
| `assets/fonts/*` | `UI/Theme/Fonts/` | 字体文件 |
## ✂️ 已删除的目录
-`core/` - 已迁移到 `_Core/`
-`module/` - 空目录,未使用
-`scripts/` - 脚本应内联到场景目录
-`scenes/` - 已迁移到 `Scenes/``UI/`
-`data/` - 配置已移至 `Config/`
## 🔧 已更新的配置文件
### project.godot
```ini
# 更新主场景路径
run/main_scene="res://Scenes/Maps/main_scene.tscn"
# 更新自动加载路径
GameManager="*res://_Core/managers/GameManager.gd"
SceneManager="*res://_Core/managers/SceneManager.gd"
EventSystem="*res://_Core/systems/EventSystem.gd"
NetworkManager="*res://_Core/managers/NetworkManager.gd"
ResponseHandler="*res://_Core/managers/ResponseHandler.gd"
```
### SceneManager.gd
```gdscript
# 更新场景路径映射
var scene_paths: Dictionary = {
"main": "res://Scenes/Maps/main_scene.tscn",
"auth": "res://UI/Windows/LoginWindow.tscn",
# ... 其他场景路径
}
```
### 测试文件
- `tests/auth/enhanced_toast_test.gd` - 已更新脚本路径
- `tests/auth/auth_ui_test.tscn` - 已更新场景路径
## 🎨 设计原则
### 1. 清晰的分层
- **_Core**: 框架代码,与具体游戏逻辑无关
- **Scenes**: 游戏世界,地图和实体
- **UI**: 所有界面HUD和弹窗
- **Config**: 静态数据,策划可编辑
### 2. 组件化设计
```gdscript
# 可复用组件放在 Scenes/Components/
Scenes/Components/
InteractableArea.tscn # 让任何物体"可交互"
MovementSync.gd # 网络位置同步
NameTag3D.tscn # 头顶名字条
```
### 3. 场景内聚
- 每个 .tscn 配套一个 .gd
- 脚本紧邻场景文件存放
- 符合 Godot 原生开发习惯
### 4. 职责单一
```
UI/Windows/ - 模态窗口(登录、设置、商店)
UI/HUD/ - 常驻界面(聊天框、状态栏)
UI/Dialog/ - 对话系统
```
## 🚀 后续建议
### 待完善的功能
1. **组件化开发**
- 创建 `Scenes/Components/` 下的可复用组件
- 使用组合优于继承的设计模式
2. **UI 独立化**
- 补充 `UI/HUD/` 下的常驻界面
- 创建 `UI/Dialog/` 对话系统
3. **场景管理**
- 补充更多地图场景到 `Scenes/Maps/`
- 添加玩家实体到 `Scenes/Entities/Player/`
4. **配置驱动**
- 将硬编码的数值移到 `Config/`
- 使用 Resource 文件管理游戏数据
### 团队协作
- **美术组**: 主要在 `Assets/` 工作
- **策划组**: 主要在 `Config/` 工作
- **程序组**: 主要在 `_Core/`, `Scenes/`, `UI/` 工作
- **测试组**: 主要在 `Tests/` 工作
## 📝 迁移检查清单
- [x] 创建新的目录结构
- [x] 迁移核心管理器
- [x] 迁移工具类
- [x] 迁移场景文件
- [x] 分离 UI 界面
- [x] 迁移配置文件
- [x] 重组资源文件
- [x] 更新 project.godot
- [x] 更新路径引用
- [x] 清理旧目录
- [ ] 在 Godot 编辑器中测试场景加载
- [ ] 验证所有自动加载脚本正常工作
- [ ] 测试网络连接功能
- [ ] 验证 UI 主题显示
## ⚠️ 注意事项
1. **场景引用更新**: 所有旧场景的引用都已更新,但建议在 Godot 编辑器中重新打开项目,让编辑器重新索引文件
2. **.import 文件**: 移动资源文件后Godot 可能会重新生成 .import 文件,这是正常的
3. **版本控制**: 如果使用 Git旧文件的删除会在下次提交时体现
4. **测试覆盖**: 迁移后建议运行完整的测试套件确保功能正常
## 🎓 参考资料
- [Godot 官方项目组织建议](https://docs.godotengine.org/en/stable/tutorials/best_practices/project_organization.html)
- [GDScript 场景组织](https://docs.godotengine.org/en/stable/tutorials/scripting/gdscript/gdscript_basics.html#scenes-and-scripts)
- [ECS 架构模式](https://github.com/SmitUS/Pine-Tree-ECS-For-Godot-4)
---
**重构完成!项目现在拥有清晰的架构,易于维护和扩展。** 🎉

View File

@@ -1,213 +0,0 @@
# 🏗️ 项目结构对比
## 旧结构 ❌
```
whale-town-front/
├── core/ # ❌ 概念模糊
│ ├── managers/ # - 框架代码?
│ ├── systems/ # - 还是业务逻辑?
│ └── utils/ # - 边界不清
├── module/ # ❌ 空壳目录(无 .gd 文件)
│ ├── Character/
│ ├── Combat/
│ ├── Dialogue/
│ ├── Inventory/
│ └── UI/
├── scenes/ # ❌ 混乱的组织
│ ├── auth_scene.tscn
│ ├── main_scene.tscn
│ ├── Components/
│ ├── Entities/
│ ├── Maps/
│ └── prefabs/
├── scripts/ # ❌ 与 scenes/ 重复
│ ├── characters/
│ ├── scenes/
│ ├── ui/
│ └── network/
├── data/ # ❌ 配置和数据混在一起
│ ├── configs/
│ ├── characters/
│ ├── dialogues/
│ └── localization/
├── assets/ # ✅ 相对清晰
│ ├── audio/
│ ├── fonts/
│ ├── icon/
│ ├── materials/
│ ├── shaders/
│ ├── sprites/
│ └── ui/
├── tests/ # ✅ 结构良好
│ ├── api/
│ ├── auth/
│ ├── integration/
│ ├── performance/
│ └── unit/
└── docs/
```
**问题总结:**
1. 🔴 脚本分散:`scripts/``scenes/` 都有脚本,职责不清
2. 🔴 空壳模块:`module/` 目录存在但无实际代码
3. 🔴 场景混乱:场景文件、预制体、脚本平级放置
4. 🔴 分层不明:`core/`, `module/`, `scripts/` 三层交叉
5. 🔴 数据混杂:`data/` 既包含配置也包含运行时数据
---
## 新结构 ✅
```
whale-town-front/
├── _Core/ # ✅ 框架层 - 清晰的单例和系统
│ ├── managers/ # - 全局管理器
│ ├── systems/ # - 核心系统
│ └── singletons/ # - 其他单例
├── Scenes/ # ✅ 玩法层 - 按游戏世界组织
│ ├── Maps/ # - 地图场景
│ │ └── main_scene.tscn
│ ├── Entities/ # - 游戏实体
│ │ ├── Player/ # - 玩家
│ │ ├── NPC/ # - NPC
│ │ └── Interactables/ # - 交互物
│ └── Components/ # - 可复用组件
├── UI/ # ✅ 界面层 - 独立的UI管理
│ ├── HUD/ # - 抬头显示(常驻)
│ ├── Windows/ # - 模态窗口
│ │ └── LoginWindow.tscn # (原 auth_scene)
│ ├── Dialog/ # - 对话系统
│ └── Theme/ # - 全局样式
│ ├── MainTheme.tres
│ └── Fonts/
├── Assets/ # ✅ 资源层 - 纯美术资源
│ ├── Sprites/ # - 精灵图
│ ├── Audio/ # - 音频
│ └── Fonts/ # - 字体
├── Config/ # ✅ 配置层 - 静态数据
│ ├── game_config.json
│ └── zh_CN.json
├── Utils/ # ✅ 工具层 - 通用函数库
│ └── StringUtils.gd
├── Tests/ # ✅ 测试层 - 完整的测试覆盖
│ ├── api/
│ ├── auth/
│ ├── integration/
│ ├── performance/
│ └── unit/
└── docs/ # 📄 项目文档
└── web_deployment_guide.md
```
**改进总结:**
1. 🟢 **分层清晰**: 框架、玩法、界面、资源、配置、工具各司其职
2. 🟢 **场景内聚**: .tscn 和 .gd 成对出现,逻辑紧耦合场景
3. 🟢 **UI 独立**: 所有界面统一管理,避免和游戏场景混淆
4. 🟢 **配置分离**: Config 只存放静态数据,策划可直接编辑
5. 🟢 **组件化**: Scenes/Components/ 提供可复用的逻辑组件
---
## 📊 核心改进对比表
| 维度 | 旧结构 | 新结构 | 改进效果 |
|:---:|:---:|:---:|:---:|
| **目录层级** | 8层 | 6层 | ✅ 更扁平 |
| **脚本管理** | 分散在2处 | 集中在场景内 | ✅ 内聚性高 |
| **UI 组织** | 混在 scenes/ | 独立 UI/ | ✅ 职责清晰 |
| **框架代码** | core/ 概念模糊 | _Core/ 明确 | ✅ 边界清楚 |
| **配置管理** | data/ 混杂 | Config/ 专职 | ✅ 策划友好 |
| **可维护性** | ⭐⭐⭐ | ⭐⭐⭐⭐⭐ | ✅ 提升67% |
| **学习曲线** | ⭐⭐ | ⭐⭐⭐⭐ | ✅ 新人友好 |
---
## 🎯 Godot 最佳实践对照
### ✅ 符合 Godot 规范
- [x] 场景脚本内聚(.tscn + .gd 相邻)
- [x] 使用 autoload 全局单例
- [x] 组件化设计(可复用的 Components/
- [x] 资源独立管理Assets/
- [x] 配置与代码分离Config/
### 🔧 待完善项
- [ ] 补充 Scenes/Components/ 下的可复用组件
- [ ] 完善事件系统的使用
- [ ] 添加 SaveSystem 到 _Core/systems/
- [ ] 实现资源热重载机制
---
## 📈 团队协作改进
### 角色与目录对应
```
┌─────────────────┬─────────────────────────────────┐
│ 角色 │ 主要工作目录 │
├─────────────────┼─────────────────────────────────┤
│ 🎨 美术组 │ Assets/Sprites/, Assets/Audio/ │
│ 📋 策划组 │ Config/ │
│ 💻 前端程序 │ UI/, Scenes/Entities/ │
│ ⚙️ 后端程序 │ _Core/, Utils/ │
│ 🧪 测试组 │ Tests/ │
└─────────────────┴─────────────────────────────────┘
```
### 协作优势
1. **减少冲突**: 不同角色在不同目录工作
2. **职责清晰**: 每个目录有明确的负责人
3. **易于审查**: PR 可以按目录分类评审
4. **快速定位**: 新人快速找到相关文件
---
## 🚀 扩展性对比
### 旧结构的扩展问题
```gdscript
//
module/FeatureName/ //
scenes/feature_scene/ //
scripts/feature_logic/ //
data/feature_config/ //
```
### 新结构的扩展方式
```gdscript
//
Scenes/Entities/NewFeature/ // +
Config/feature_config.json //
```
---
## 📚 参考架构
这个新结构参考了业界最佳实践:
- **Godot 官方**: [Project Organization](https://docs.godotengine.org/en/stable/tutorials/best_practices/project_organization.html)
- **Unity 模式**: Assets/Scenes/Scripts 分离
- **ECS 架构**: Entities + Components 思想
- **微服务思维**: 按功能域而非技术分层
---
## 🎓 学习资源
如果你是新人,这里有一些学习路径:
1. **先熟悉目录** → 查看 [REFACTORING.md](./REFACTORING.md)
2. **理解核心系统** → 阅读 `_Core/systems/EventSystem.gd`
3. **学习场景管理** → 查看 `_Core/managers/SceneManager.gd`
4. **研究 UI 结构** → 打开 `UI/Windows/LoginWindow.tscn`
5. **运行测试** → 执行 `Tests/` 下的测试用例
---
**结论:新结构更加清晰、模块化、易于维护,符合 Godot 最佳实践!** 🎉

Binary file not shown.

View File

@@ -1,41 +0,0 @@
[remap]
importer="font_data_dynamic"
type="FontFile"
uid="uid://ce7ujbeobblyr"
path="res://.godot/imported/msyh.ttc-ee5749038370cbe296598e3bc4218102.fontdata"
[deps]
source_file="res://UI/Theme/Fonts/msyh.ttc"
dest_files=["res://.godot/imported/msyh.ttc-ee5749038370cbe296598e3bc4218102.fontdata"]
[params]
Rendering=null
antialiasing=1
generate_mipmaps=false
disable_embedded_bitmaps=true
multichannel_signed_distance_field=false
msdf_pixel_range=8
msdf_size=48
allow_system_fallback=true
force_autohinter=false
modulate_color_glyphs=false
hinting=1
subpixel_positioning=4
keep_rounding_remainders=true
oversampling=0.0
Fallbacks=null
fallbacks=[]
Compress=null
compress=false
preload=[{
"chars": "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz!@#$%^&*()_+-=[]{}|;':\",./<>?`~一二三四五六七八九十百千万亿用户名密码登录注册验证码邮箱小镇鲸鱼欢迎来到开始你的之旅请输入不能为空获取发送忘记返回居民身份确认再次已被使用换个等待分钟后试稍后正在创建账户测试模式生成查看控制台网络连接失败系统维护中升级稍后再试频繁联系管理员禁用审核先邮箱后使用成功进入镇错误或过期未找到存在",
"glyphs": [],
"name": "Web预加载",
"size": Vector2i(16, 0)
}]
language_support={}
script_support={}
opentype_features={}

View File

@@ -1,7 +0,0 @@
[gd_resource type="Theme" load_steps=2 format=3 uid="uid://cp7t8tu7rmyad"]
[ext_resource type="FontFile" uid="uid://ce7ujbeobblyr" path="res://assets/fonts/msyh.ttc" id="1_ftb5w"]
[resource]
resource_local_to_scene = true
default_font = ExtResource("1_ftb5w")

File diff suppressed because it is too large Load Diff

View File

@@ -1 +0,0 @@
uid://bs1vy3ierj66t

View File

@@ -1,199 +0,0 @@
class_name StringUtils
# 字符串工具类 - 提供常用的字符串处理功能
# 验证邮箱格式
static func is_valid_email(email: String) -> bool:
var regex = RegEx.new()
regex.compile("^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$")
return regex.search(email) != null
# 验证用户名格式(字母、数字、下划线)
static func is_valid_username(username: String) -> bool:
if username.is_empty() or username.length() > 50:
return false
var regex = RegEx.new()
regex.compile("^[a-zA-Z0-9_]+$")
return regex.search(username) != null
# 验证密码强度
static func validate_password_strength(password: String) -> Dictionary:
var result = {"valid": false, "message": "", "strength": 0}
if password.length() < 8:
result.message = "密码长度至少8位"
return result
if password.length() > 128:
result.message = "密码长度不能超过128位"
return result
var has_letter = false
var has_digit = false
var has_special = false
for i in range(password.length()):
var char = password[i]
if char >= 'a' and char <= 'z' or char >= 'A' and char <= 'Z':
has_letter = true
elif char >= '0' and char <= '9':
has_digit = true
elif char in "!@#$%^&*()_+-=[]{}|;:,.<>?":
has_special = true
var strength = 0
if has_letter:
strength += 1
if has_digit:
strength += 1
if has_special:
strength += 1
if password.length() >= 12:
strength += 1
result.strength = strength
if not (has_letter and has_digit):
result.message = "密码必须包含字母和数字"
return result
result.valid = true
result.message = "密码强度: " + ["", "", "", "很强"][min(strength - 1, 3)]
return result
# 截断字符串
static func truncate(text: String, max_length: int, suffix: String = "...") -> String:
if text.length() <= max_length:
return text
return text.substr(0, max_length - suffix.length()) + suffix
# 首字母大写
static func capitalize_first(text: String) -> String:
if text.is_empty():
return text
return text[0].to_upper() + text.substr(1)
# 转换为标题格式(每个单词首字母大写)
static func to_title_case(text: String) -> String:
var words = text.split(" ")
var result = []
for word in words:
if not word.is_empty():
result.append(capitalize_first(word.to_lower()))
return " ".join(result)
# 移除HTML标签
static func strip_html_tags(html: String) -> String:
var regex = RegEx.new()
regex.compile("<[^>]*>")
return regex.sub(html, "", true)
# 格式化文件大小
static func format_file_size(bytes: int) -> String:
var units = ["B", "KB", "MB", "GB", "TB"]
var size = float(bytes)
var unit_index = 0
while size >= 1024.0 and unit_index < units.size() - 1:
size /= 1024.0
unit_index += 1
if unit_index == 0:
return str(int(size)) + " " + units[unit_index]
else:
return "%.1f %s" % [size, units[unit_index]]
# 将UTC时间字符串转换为本地时间显示
static func format_utc_to_local_time(utc_time_str: String) -> String:
# 解析UTC时间字符串 (格式: 2025-12-25T11:23:52.175Z)
var regex = RegEx.new()
regex.compile("(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2})")
var result = regex.search(utc_time_str)
if result == null:
return utc_time_str # 如果解析失败,返回原字符串
# 提取时间组件
var year = int(result.get_string(1))
var month = int(result.get_string(2))
var day = int(result.get_string(3))
var hour = int(result.get_string(4))
var minute = int(result.get_string(5))
var second = int(result.get_string(6))
# 创建UTC时间字典
var utc_dict = {
"year": year,
"month": month,
"day": day,
"hour": hour,
"minute": minute,
"second": second
}
# 转换为Unix时间戳UTC
var utc_timestamp = Time.get_unix_time_from_datetime_dict(utc_dict)
# 获取本地时间Godot会自动处理时区转换
var local_dict = Time.get_datetime_dict_from_unix_time(utc_timestamp)
# 格式化为易读的本地时间
return "%04d%02d%02d%02d:%02d:%02d" % [
local_dict.year,
local_dict.month,
local_dict.day,
local_dict.hour,
local_dict.minute,
local_dict.second
]
# 获取相对时间描述(多少分钟后)
static func get_relative_time_until(utc_time_str: String) -> String:
# 解析UTC时间字符串
var regex = RegEx.new()
regex.compile("(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2})")
var result = regex.search(utc_time_str)
if result == null:
return "时间格式错误"
# 提取时间组件
var year = int(result.get_string(1))
var month = int(result.get_string(2))
var day = int(result.get_string(3))
var hour = int(result.get_string(4))
var minute = int(result.get_string(5))
var second = int(result.get_string(6))
# 创建UTC时间字典
var utc_dict = {
"year": year,
"month": month,
"day": day,
"hour": hour,
"minute": minute,
"second": second
}
# 转换为Unix时间戳
var target_timestamp = Time.get_unix_time_from_datetime_dict(utc_dict)
var current_timestamp = Time.get_unix_time_from_system()
# 计算时间差(秒)
var diff_seconds = target_timestamp - current_timestamp
if diff_seconds <= 0:
return "现在可以重试"
elif diff_seconds < 60:
return "%d秒后" % diff_seconds
elif diff_seconds < 3600:
var minutes = int(diff_seconds / 60)
return "%d分钟后" % minutes
else:
var hours = int(diff_seconds / 3600)
var minutes = int((diff_seconds % 3600) / 60)
if minutes > 0:
return "%d小时%d分钟后" % [hours, minutes]
else:
return "%d小时后" % hours

View File

@@ -1 +0,0 @@
uid://csxag1y8yq57j

60
_Core/EventNames.gd Normal file
View File

@@ -0,0 +1,60 @@
# ============================================================================
# 事件名称定义 - EventNames.gd
#
# 定义项目中所有事件的名称常量,确保事件名称的一致性和可维护性
#
# 使用方式:
# EventSystem.emit_event(EventNames.PLAYER_MOVED, data)
# EventSystem.connect_event(EventNames.INTERACT_PRESSED, callback)
# ============================================================================
class_name EventNames
# ============================================================================
# 玩家相关事件
# ============================================================================
const PLAYER_MOVED = "player_moved"
const PLAYER_SPAWNED = "player_spawned"
const PLAYER_HEALTH_CHANGED = "player_health_changed"
const PLAYER_DIED = "player_died"
const PLAYER_RESPAWNED = "player_respawned"
const PLAYER_ATTACK = "player_attack"
# ============================================================================
# 交互事件
# ============================================================================
const INTERACT_PRESSED = "interact_pressed"
const NPC_TALKED = "npc_talked"
const ITEM_COLLECTED = "item_collected"
const OBJECT_INTERACTED = "object_interacted"
# ============================================================================
# UI事件
# ============================================================================
const UI_BUTTON_CLICKED = "ui_button_clicked"
const DIALOG_OPENED = "dialog_opened"
const DIALOG_CLOSED = "dialog_closed"
const MENU_OPENED = "menu_opened"
const MENU_CLOSED = "menu_closed"
# ============================================================================
# 游戏状态事件
# ============================================================================
const GAME_PAUSED = "game_paused"
const GAME_RESUMED = "game_resumed"
const SCENE_CHANGED = "scene_changed"
const SCENE_DATA_TRANSFER = "scene_data_transfer"
# ============================================================================
# 系统事件
# ============================================================================
const TILEMAP_READY = "tilemap_ready"
const COMPONENT_MESSAGE = "component_message"
const POSITION_UPDATE = "position_update"
const GRID_POSITION_CHANGED = "grid_position_changed"
const GRID_SNAP_REQUESTED = "grid_snap_requested"
# ============================================================================
# 测试事件
# ============================================================================
const TEST_EVENT = "test_event"

1
_Core/EventNames.gd.uid Normal file
View File

@@ -0,0 +1 @@
uid://qn0imbklx1m0

118
_Core/ProjectPaths.gd Normal file
View File

@@ -0,0 +1,118 @@
# ============================================================================
# 项目路径配置 - ProjectPaths.gd
#
# 统一管理项目中所有路径常量,确保路径的一致性和可维护性
#
# 使用方式:
# var scene_path = ProjectPaths.SCENES_COMPONENTS + "ui/Button.tscn"
# var config_path = ProjectPaths.DATA_CONFIG + "game_config.json"
# ============================================================================
class_name ProjectPaths
# ============================================================================
# 核心系统路径
# ============================================================================
const CORE_ROOT = "res://_Core/"
const CORE_MANAGERS = CORE_ROOT + "managers/"
const CORE_SYSTEMS = CORE_ROOT + "systems/"
const CORE_COMPONENTS = CORE_ROOT + "components/"
const CORE_UTILS = CORE_ROOT + "utils/"
# 系统文件路径
const GRID_SYSTEM = CORE_SYSTEMS + "GridSystem.gd"
const EVENT_SYSTEM = CORE_SYSTEMS + "EventSystem.gd"
const TILE_SYSTEM = CORE_SYSTEMS + "TileSystem.gd"
# ============================================================================
# 场景路径
# ============================================================================
const SCENES_ROOT = "res://scenes/"
const SCENES_MAPS = SCENES_ROOT + "Maps/"
const SCENES_COMPONENTS = SCENES_ROOT + "Components/"
const SCENES_UI_COMPONENTS = SCENES_COMPONENTS + "ui/"
const SCENES_CHARACTER_COMPONENTS = SCENES_COMPONENTS + "characters/"
const SCENES_EFFECT_COMPONENTS = SCENES_COMPONENTS + "effects/"
const SCENES_ITEM_COMPONENTS = SCENES_COMPONENTS + "items/"
# ============================================================================
# UI路径
# ============================================================================
const UI_ROOT = "res://scenes/ui/"
const UI_WINDOWS = UI_ROOT
# ============================================================================
# 资源路径
# ============================================================================
const ASSETS_ROOT = "res://assets/"
const ASSETS_SPRITES = ASSETS_ROOT + "sprites/"
const ASSETS_AUDIO = ASSETS_ROOT + "audio/"
const ASSETS_FONTS = ASSETS_ROOT + "fonts/"
const ASSETS_MATERIALS = ASSETS_ROOT + "materials/"
const ASSETS_SHADERS = ASSETS_ROOT + "shaders/"
# 地形资源路径
const ASSETS_TERRAIN = ASSETS_SPRITES + "terrain/"
const ASSETS_GRASS = ASSETS_TERRAIN + "grass/"
# ============================================================================
# 数据路径
# ============================================================================
const DATA_ROOT = "res://data/"
const DATA_CONFIG = "res://Config/"
const DATA_SCENES = DATA_ROOT + "scenes/"
const DATA_LEVELS = DATA_ROOT + "levels/"
const DATA_DIALOGUES = DATA_ROOT + "dialogues/"
# ============================================================================
# Web资源路径
# ============================================================================
const WEB_ASSETS = "res://web_assets/"
# ============================================================================
# 测试路径
# ============================================================================
const TESTS_ROOT = "res://tests/"
const TESTS_UNIT = TESTS_ROOT + "unit/"
const TESTS_INTEGRATION = TESTS_ROOT + "integration/"
const TESTS_AUTH = TESTS_ROOT + "auth/"
# ============================================================================
# 工具路径
# ============================================================================
const UTILS_ROOT = "res://_Core/utils/"
# ============================================================================
# 模块路径
# ============================================================================
const MODULES_ROOT = "res://module/"
# ============================================================================
# 辅助方法
# ============================================================================
# 获取场景组件路径
static func get_component_path(category: String, component_name: String) -> String:
match category:
"ui":
return SCENES_UI_COMPONENTS + component_name + ".tscn"
"characters":
return SCENES_CHARACTER_COMPONENTS + component_name + ".tscn"
"effects":
return SCENES_EFFECT_COMPONENTS + component_name + ".tscn"
"items":
return SCENES_ITEM_COMPONENTS + component_name + ".tscn"
_:
return SCENES_COMPONENTS + component_name + ".tscn"
# 获取模块路径
static func get_module_path(module_name: String) -> String:
return MODULES_ROOT + module_name + "/"
# 获取模块配置路径
static func get_module_config_path(module_name: String) -> String:
return get_module_path(module_name) + "data/module_config.json"
# 获取场景数据路径
static func get_scene_data_path(scene_name: String) -> String:
return DATA_SCENES + scene_name.to_lower() + ".json"

View File

@@ -0,0 +1 @@
uid://dybcuscku7tyl

View File

@@ -0,0 +1,2 @@
# 基础组件实现目录
# 存放项目的基础组件类

View File

@@ -0,0 +1,589 @@
class_name AuthManager
# ============================================================================
# AuthManager.gd - 认证管理器
# ============================================================================
# 认证系统的业务逻辑管理器,负责处理所有认证相关的业务逻辑
#
# 核心职责:
# - 用户登录业务逻辑(密码登录 + 验证码登录)
# - 用户注册业务逻辑
# - 表单验证逻辑
# - 验证码管理逻辑
# - 网络请求管理
# - 响应处理和状态管理
#
# 使用方式:
# var auth_manager = AuthManager.new()
# auth_manager.login_success.connect(_on_login_success)
# auth_manager.execute_password_login(username, password)
#
# 注意事项:
# - 这是业务逻辑层不包含任何UI相关代码
# - 通过信号与UI层通信
# - 所有验证逻辑都在这里实现
# ============================================================================
extends RefCounted
# ============ 信号定义 ============
# 登录成功信号
signal login_success(username: String)
# 登录失败信号
signal login_failed(message: String)
# 注册成功信号
signal register_success(message: String)
# 注册失败信号
signal register_failed(message: String)
# 验证码发送成功信号
signal verification_code_sent(message: String)
# 验证码发送失败信号
signal verification_code_failed(message: String)
# 表单验证失败信号
signal form_validation_failed(field: String, message: String)
# 网络状态变化信号
signal network_status_changed(is_connected: bool, message: String)
# 按钮状态变化信号
signal button_state_changed(button_name: String, is_loading: bool, text: String)
# Toast消息信号
signal show_toast_message(message: String, is_success: bool)
# ============ 枚举定义 ============
# 登录模式枚举
enum LoginMode {
PASSWORD, # 密码登录模式
VERIFICATION # 验证码登录模式
}
# ============ 成员变量 ============
# 登录状态
var current_login_mode: LoginMode = LoginMode.PASSWORD
var is_processing: bool = false
# 验证码管理
var verification_codes_sent: Dictionary = {}
var code_cooldown: float = 60.0
var current_email: String = ""
# 网络请求管理
var active_request_ids: Array = []
# ============ 生命周期方法 ============
# 初始化管理器
func _init():
print("AuthManager 初始化完成")
# 清理资源
func cleanup():
# 取消所有活动的网络请求
for request_id in active_request_ids:
NetworkManager.cancel_request(request_id)
active_request_ids.clear()
# ============ 登录相关方法 ============
# 执行密码登录
#
# 参数:
# username: String - 用户名/邮箱
# password: String - 密码
#
# 功能:
# - 验证输入参数
# - 发送登录请求
# - 处理响应结果
func execute_password_login(username: String, password: String):
if is_processing:
show_toast_message.emit("请等待当前操作完成", false)
return
# 验证输入
var validation_result = validate_login_inputs(username, password)
if not validation_result.valid:
form_validation_failed.emit(validation_result.field, validation_result.message)
return
# 设置处理状态
is_processing = true
button_state_changed.emit("main_btn", true, "登录中...")
show_toast_message.emit("正在验证登录信息...", true)
# 发送网络请求
var request_id = NetworkManager.login(username, password, _on_login_response)
if request_id != "":
active_request_ids.append(request_id)
else:
_reset_login_state()
show_toast_message.emit("网络请求失败", false)
# 执行验证码登录
#
# 参数:
# identifier: String - 用户标识符
# verification_code: String - 验证码
func execute_verification_login(identifier: String, verification_code: String):
if is_processing:
show_toast_message.emit("请等待当前操作完成", false)
return
# 验证输入
if identifier.is_empty():
form_validation_failed.emit("username", "请输入用户名/手机/邮箱")
return
if verification_code.is_empty():
form_validation_failed.emit("verification", "请输入验证码")
return
# 设置处理状态
is_processing = true
button_state_changed.emit("main_btn", true, "登录中...")
show_toast_message.emit("正在验证验证码...", true)
# 发送网络请求
var request_id = NetworkManager.verification_code_login(identifier, verification_code, _on_verification_login_response)
if request_id != "":
active_request_ids.append(request_id)
else:
_reset_login_state()
show_toast_message.emit("网络请求失败", false)
# 切换登录模式
func toggle_login_mode():
if current_login_mode == LoginMode.PASSWORD:
current_login_mode = LoginMode.VERIFICATION
else:
current_login_mode = LoginMode.PASSWORD
# 获取当前登录模式
func get_current_login_mode() -> LoginMode:
return current_login_mode
# ============ 注册相关方法 ============
# 执行用户注册
#
# 参数:
# username: String - 用户名
# email: String - 邮箱
# password: String - 密码
# confirm_password: String - 确认密码
# verification_code: String - 邮箱验证码
func execute_register(username: String, email: String, password: String, confirm_password: String, verification_code: String):
if is_processing:
show_toast_message.emit("请等待当前操作完成", false)
return
# 验证注册表单
var validation_result = validate_register_form(username, email, password, confirm_password, verification_code)
if not validation_result.valid:
form_validation_failed.emit(validation_result.field, validation_result.message)
return
# 设置处理状态
is_processing = true
button_state_changed.emit("register_btn", true, "注册中...")
show_toast_message.emit("正在创建账户...", true)
# 发送注册请求
var request_id = NetworkManager.register(username, password, username, email, verification_code, _on_register_response)
if request_id != "":
active_request_ids.append(request_id)
else:
_reset_register_state()
show_toast_message.emit("网络请求失败", false)
# ============ 验证码相关方法 ============
# 发送邮箱验证码
#
# 参数:
# email: String - 邮箱地址
func send_email_verification_code(email: String):
# 验证邮箱格式
var email_validation = validate_email(email)
if not email_validation.valid:
form_validation_failed.emit("email", email_validation.message)
return
# 检查冷却时间
if not _can_send_verification_code(email):
var remaining = get_remaining_cooldown_time(email)
show_toast_message.emit("该邮箱请等待 %d 秒后再次发送" % remaining, false)
return
# 记录发送状态
_record_verification_code_sent(email)
# 发送请求
var request_id = NetworkManager.send_email_verification(email, _on_send_code_response)
if request_id != "":
active_request_ids.append(request_id)
else:
_reset_verification_code_state(email)
show_toast_message.emit("网络请求失败", false)
# 发送登录验证码
#
# 参数:
# identifier: String - 用户标识符
func send_login_verification_code(identifier: String):
if identifier.is_empty():
form_validation_failed.emit("username", "请先输入用户名/手机/邮箱")
return
button_state_changed.emit("get_code_btn", true, "发送中...")
show_toast_message.emit("正在发送登录验证码...", true)
var request_id = NetworkManager.send_login_verification_code(identifier, _on_send_login_code_response)
if request_id != "":
active_request_ids.append(request_id)
else:
button_state_changed.emit("get_code_btn", false, "获取验证码")
show_toast_message.emit("网络请求失败", false)
# 发送密码重置验证码
#
# 参数:
# identifier: String - 用户标识符
func send_password_reset_code(identifier: String):
if identifier.is_empty():
show_toast_message.emit("请先输入邮箱或手机号", false)
return
if not _is_valid_identifier(identifier):
show_toast_message.emit("请输入有效的邮箱或手机号", false)
return
button_state_changed.emit("forgot_password_btn", true, "发送中...")
show_toast_message.emit("正在发送密码重置验证码...", true)
var request_id = NetworkManager.forgot_password(identifier, _on_forgot_password_response)
if request_id != "":
active_request_ids.append(request_id)
else:
button_state_changed.emit("forgot_password_btn", false, "忘记密码")
show_toast_message.emit("网络请求失败", false)
# ============ 验证方法 ============
# 验证登录输入
func validate_login_inputs(username: String, password: String) -> Dictionary:
var result = {"valid": false, "field": "", "message": ""}
if username.is_empty():
result.field = "username"
result.message = "用户名不能为空"
return result
if password.is_empty():
result.field = "password"
result.message = "密码不能为空"
return result
result.valid = true
return result
# 验证注册表单
func validate_register_form(username: String, email: String, password: String, confirm_password: String, verification_code: String) -> Dictionary:
var result = {"valid": false, "field": "", "message": ""}
# 验证用户名
var username_validation = validate_username(username)
if not username_validation.valid:
result.field = "username"
result.message = username_validation.message
return result
# 验证邮箱
var email_validation = validate_email(email)
if not email_validation.valid:
result.field = "email"
result.message = email_validation.message
return result
# 验证密码
var password_validation = validate_password(password)
if not password_validation.valid:
result.field = "password"
result.message = password_validation.message
return result
# 验证确认密码
var confirm_validation = validate_confirm_password(password, confirm_password)
if not confirm_validation.valid:
result.field = "confirm"
result.message = confirm_validation.message
return result
# 验证验证码
var code_validation = validate_verification_code(verification_code)
if not code_validation.valid:
result.field = "verification"
result.message = code_validation.message
return result
# 检查是否已发送验证码
if not _has_sent_verification_code(email):
result.field = "verification"
result.message = "请先获取邮箱验证码"
return result
result.valid = true
return result
# 验证用户名
func validate_username(username: String) -> Dictionary:
var result = {"valid": false, "message": ""}
if username.is_empty():
result.message = "用户名不能为空"
return result
if not StringUtils.is_valid_username(username):
if username.length() > 50:
result.message = "用户名长度不能超过50字符"
else:
result.message = "用户名只能包含字母、数字和下划线"
return result
result.valid = true
return result
# 验证邮箱
func validate_email(email: String) -> Dictionary:
var result = {"valid": false, "message": ""}
if email.is_empty():
result.message = "邮箱不能为空"
return result
if not StringUtils.is_valid_email(email):
result.message = "请输入有效的邮箱地址"
return result
result.valid = true
return result
# 验证密码
func validate_password(password: String) -> Dictionary:
return StringUtils.validate_password_strength(password)
# 验证确认密码
func validate_confirm_password(password: String, confirm: String) -> Dictionary:
var result = {"valid": false, "message": ""}
if confirm.is_empty():
result.message = "确认密码不能为空"
return result
if password != confirm:
result.message = "两次输入的密码不一致"
return result
result.valid = true
return result
# 验证验证码
func validate_verification_code(code: String) -> Dictionary:
var result = {"valid": false, "message": ""}
if code.is_empty():
result.message = "验证码不能为空"
return result
if code.length() != 6:
result.message = "验证码必须是6位数字"
return result
for i in range(code.length()):
var character = code[i]
if not (character >= '0' and character <= '9'):
result.message = "验证码必须是6位数字"
return result
result.valid = true
return result
# ============ 网络响应处理 ============
# 处理登录响应
func _on_login_response(success: bool, data: Dictionary, error_info: Dictionary):
_reset_login_state()
var result = ResponseHandler.handle_login_response(success, data, error_info)
if result.should_show_toast:
show_toast_message.emit(result.message, result.success)
if result.success:
var username = ""
if data.has("data") and data.data.has("user") and data.data.user.has("username"):
username = data.data.user.username
# 延迟发送登录成功信号
await Engine.get_main_loop().create_timer(1.0).timeout
login_success.emit(username)
else:
login_failed.emit(result.message)
# 处理验证码登录响应
func _on_verification_login_response(success: bool, data: Dictionary, error_info: Dictionary):
_reset_login_state()
var result = ResponseHandler.handle_verification_code_login_response(success, data, error_info)
if result.should_show_toast:
show_toast_message.emit(result.message, result.success)
if result.success:
var username = ""
if data.has("data") and data.data.has("user") and data.data.user.has("username"):
username = data.data.user.username
await Engine.get_main_loop().create_timer(1.0).timeout
login_success.emit(username)
else:
login_failed.emit(result.message)
# 处理注册响应
func _on_register_response(success: bool, data: Dictionary, error_info: Dictionary):
_reset_register_state()
var result = ResponseHandler.handle_register_response(success, data, error_info)
if result.should_show_toast:
show_toast_message.emit(result.message, result.success)
if result.success:
register_success.emit(result.message)
else:
register_failed.emit(result.message)
# 处理发送验证码响应
func _on_send_code_response(success: bool, data: Dictionary, error_info: Dictionary):
var result = ResponseHandler.handle_send_verification_code_response(success, data, error_info)
if result.should_show_toast:
show_toast_message.emit(result.message, result.success)
if result.success:
verification_code_sent.emit(result.message)
else:
verification_code_failed.emit(result.message)
_reset_verification_code_state(current_email)
# 处理发送登录验证码响应
func _on_send_login_code_response(success: bool, data: Dictionary, error_info: Dictionary):
button_state_changed.emit("get_code_btn", false, "获取验证码")
var result = ResponseHandler.handle_send_login_code_response(success, data, error_info)
if result.should_show_toast:
show_toast_message.emit(result.message, result.success)
# 处理忘记密码响应
func _on_forgot_password_response(success: bool, data: Dictionary, error_info: Dictionary):
button_state_changed.emit("forgot_password_btn", false, "忘记密码")
var result = ResponseHandler.handle_send_login_code_response(success, data, error_info)
if result.should_show_toast:
show_toast_message.emit(result.message, result.success)
# ============ 网络测试 ============
# 测试网络连接
func test_network_connection():
var request_id = NetworkManager.get_app_status(_on_network_test_response)
if request_id != "":
active_request_ids.append(request_id)
# 处理网络测试响应
func _on_network_test_response(success: bool, data: Dictionary, error_info: Dictionary):
var result = ResponseHandler.handle_network_test_response(success, data, error_info)
network_status_changed.emit(result.success, result.message)
# ============ 私有辅助方法 ============
# 重置登录状态
func _reset_login_state():
is_processing = false
button_state_changed.emit("main_btn", false, "进入小镇")
# 重置注册状态
func _reset_register_state():
is_processing = false
button_state_changed.emit("register_btn", false, "注册")
# 检查是否可以发送验证码
func _can_send_verification_code(email: String) -> bool:
if not verification_codes_sent.has(email):
return true
var email_data = verification_codes_sent[email]
if not email_data.sent:
return true
var current_time = Time.get_time_dict_from_system()
var current_timestamp = current_time.hour * 3600 + current_time.minute * 60 + current_time.second
return (current_timestamp - email_data.time) >= code_cooldown
# 获取剩余冷却时间
func get_remaining_cooldown_time(email: String) -> int:
if not verification_codes_sent.has(email):
return 0
var email_data = verification_codes_sent[email]
var current_time = Time.get_time_dict_from_system()
var current_timestamp = current_time.hour * 3600 + current_time.minute * 60 + current_time.second
return int(code_cooldown - (current_timestamp - email_data.time))
# 记录验证码发送状态
func _record_verification_code_sent(email: String):
var current_time = Time.get_time_dict_from_system()
var current_timestamp = current_time.hour * 3600 + current_time.minute * 60 + current_time.second
if not verification_codes_sent.has(email):
verification_codes_sent[email] = {}
verification_codes_sent[email].sent = true
verification_codes_sent[email].time = current_timestamp
current_email = email
# 重置验证码状态
func _reset_verification_code_state(email: String):
if verification_codes_sent.has(email):
verification_codes_sent[email].sent = false
# 检查是否已发送验证码
func _has_sent_verification_code(email: String) -> bool:
if not verification_codes_sent.has(email):
return false
return verification_codes_sent[email].get("sent", false)
# 验证标识符格式
func _is_valid_identifier(identifier: String) -> bool:
return StringUtils.is_valid_email(identifier) or _is_valid_phone(identifier)
# 验证手机号格式
func _is_valid_phone(phone: String) -> bool:
var regex = RegEx.new()
regex.compile("^\\+?[1-9]\\d{1,14}$")
return regex.search(phone) != null

View File

@@ -0,0 +1 @@
uid://bpdyraefv0yta

View File

@@ -1,50 +1,142 @@
extends Node
# 游戏管理器 - 全局游戏状态管理
# 单例模式,管理游戏的整体状态和生命周期
# ============================================================================
# GameManager.gd - 游戏管理器
# ============================================================================
# 全局单例管理器,负责游戏状态管理和生命周期控制
#
# 核心职责:
# - 游戏状态切换 (加载、认证、游戏中、暂停等)
# - 用户信息管理
# - 全局配置访问
# - 系统初始化和清理
#
# 使用方式:
# GameManager.change_state(GameManager.GameState.IN_GAME)
# GameManager.set_current_user("player123")
#
# 注意事项:
# - 作为自动加载单例,全局可访问
# - 状态变更会触发 game_state_changed 信号
# - 状态切换应该通过 change_state() 方法进行
# ============================================================================
# ============ 信号定义 ============
# 游戏状态变更信号
# 参数: new_state - 新的游戏状态
signal game_state_changed(new_state: GameState)
# ============ 枚举定义 ============
# 游戏状态枚举
# 定义了游戏的各种运行状态
enum GameState {
LOADING, # 加载中
AUTH, # 认证状态
MAIN_MENU, # 主菜单
IN_GAME, # 游戏中
PAUSED, # 暂停
SETTINGS # 设置
LOADING, # 加载中 - 游戏启动时的初始化状态
AUTH, # 认证状态 - 用户登录/注册界面
MAIN_MENU, # 主菜单 - 游戏主界面
IN_GAME, # 游戏中 - 正在进行游戏
PAUSED, # 暂停 - 游戏暂停状态
SETTINGS # 设置 - 设置界面
}
var current_state: GameState = GameState.LOADING
var previous_state: GameState = GameState.LOADING
var current_user: String = ""
var game_version: String = "1.0.0"
# ============ 成员变量 ============
# 状态管理
var current_state: GameState = GameState.LOADING # 当前游戏状态
var previous_state: GameState = GameState.LOADING # 上一个游戏状态
# 用户信息
var current_user: String = "" # 当前登录用户名
# 游戏配置
var game_version: String = "1.0.0" # 游戏版本号
# ============ 生命周期方法 ============
# 初始化游戏管理器
# 在节点准备就绪时调用,设置初始状态
func _ready():
print("GameManager 初始化完成")
change_state(GameState.AUTH)
change_state(GameState.AUTH) # 启动时进入认证状态
# ============ 状态管理方法 ============
# 切换游戏状态
#
# 参数:
# new_state: GameState - 要切换到的新状态
#
# 功能:
# - 检查状态是否需要切换
# - 记录状态变更历史
# - 发送状态变更信号
# - 输出状态变更日志
func change_state(new_state: GameState):
# 避免重复切换到相同状态
if current_state == new_state:
return
# 记录状态变更
previous_state = current_state
current_state = new_state
# 输出状态变更日志
print("游戏状态变更: ", GameState.keys()[previous_state], " -> ", GameState.keys()[current_state])
# 发送状态变更信号
game_state_changed.emit(new_state)
# 获取当前游戏状态
#
# 返回值:
# GameState - 当前的游戏状态
func get_current_state() -> GameState:
return current_state
# 获取上一个游戏状态
#
# 返回值:
# GameState - 上一个游戏状态
#
# 使用场景:
# - 从暂停状态恢复时,返回到之前的状态
# - 错误处理时回退到安全状态
func get_previous_state() -> GameState:
return previous_state
# ============ 用户管理方法 ============
# 设置当前登录用户
#
# 参数:
# username: String - 用户名
#
# 功能:
# - 存储当前登录用户信息
# - 输出用户设置日志
#
# 注意事项:
# - 用户登录成功后调用此方法
# - 用户登出时应传入空字符串
func set_current_user(username: String):
current_user = username
print("当前用户设置为: ", username)
# 获取当前登录用户
#
# 返回值:
# String - 当前登录的用户名,未登录时为空字符串
func get_current_user() -> String:
return current_user
# 检查用户是否已登录
#
# 返回值:
# bool - true表示已登录false表示未登录
#
# 使用场景:
# - 进入需要登录的功能前检查
# - UI显示逻辑判断
func is_user_logged_in() -> bool:
return not current_user.is_empty()

View File

@@ -1,45 +1,96 @@
extends Node
# 网络请求管理器 - 统一处理所有HTTP请求
# ============================================================================
# NetworkManager.gd - 网络请求管理器
# ============================================================================
# 全局单例管理器统一处理所有HTTP请求
#
# 核心职责:
# - 统一的HTTP请求接口 (GET, POST, PUT, DELETE, PATCH)
# - 认证相关API封装 (登录、注册、验证码等)
# - 请求状态管理和错误处理
# - 支持API v1.1.1规范的响应处理
#
# 使用方式:
# NetworkManager.login("user@example.com", "password", callback)
# var request_id = NetworkManager.get_request("/api/data", callback)
#
# 注意事项:
# - 作为自动加载单例,全局可访问
# - 所有请求都是异步的,通过回调函数或信号处理结果
# - 支持请求超时和取消功能
# - 自动处理JSON序列化和反序列化
# ============================================================================
# 信号定义
# ============ 信号定义 ============
# 请求完成信号
# 参数:
# request_id: String - 请求唯一标识符
# success: bool - 请求是否成功
# data: Dictionary - 响应数据
signal request_completed(request_id: String, success: bool, data: Dictionary)
# 请求失败信号
# 参数:
# request_id: String - 请求唯一标识符
# error_type: String - 错误类型名称
# message: String - 错误消息
signal request_failed(request_id: String, error_type: String, message: String)
# API配置
# ============ 常量定义 ============
# API基础URL - 所有请求的根地址
const API_BASE_URL = "https://whaletownend.xinghangee.icu"
# 默认请求超时时间(秒)
const DEFAULT_TIMEOUT = 30.0
# 请求类型枚举
# ============ 枚举定义 ============
# HTTP请求方法枚举
enum RequestType {
GET,
POST,
PUT,
DELETE,
PATCH
GET, # 获取数据
POST, # 创建数据
PUT, # 更新数据
DELETE, # 删除数据
PATCH # 部分更新数据
}
# 错误类型枚举
# 用于分类不同类型的网络错误
enum ErrorType {
NETWORK_ERROR, # 网络连接错误
TIMEOUT_ERROR, # 请求超时
PARSE_ERROR, # JSON解析错误
HTTP_ERROR, # HTTP状态码错误
BUSINESS_ERROR # 业务逻辑错误
NETWORK_ERROR, # 网络连接错误 - 无法连接到服务器
TIMEOUT_ERROR, # 请求超时 - 服务器响应时间过长
PARSE_ERROR, # JSON解析错误 - 服务器返回格式错误
HTTP_ERROR, # HTTP状态码错误 - 4xx, 5xx状态码
BUSINESS_ERROR # 业务逻辑错误 - API返回的业务错误
}
# 请求状态
# ============ 请求信息类 ============
# 请求信息封装类
# 存储单个HTTP请求的所有相关信息
class RequestInfo:
var id: String
var url: String
var method: RequestType
var headers: PackedStringArray
var body: String
var timeout: float
var start_time: float
var http_request: HTTPRequest
var callback: Callable
var id: String # 请求唯一标识符
var url: String # 完整的请求URL
var method: RequestType # HTTP请求方法
var headers: PackedStringArray # 请求头数组
var body: String # 请求体内容
var timeout: float # 超时时间(秒)
var start_time: float # 请求开始时间戳
var http_request: HTTPRequest # Godot HTTPRequest节点引用
var callback: Callable # 完成时的回调函数
# 构造函数
#
# 参数:
# request_id: String - 请求唯一标识符
# request_url: String - 请求URL
# request_method: RequestType - HTTP方法
# request_headers: PackedStringArray - 请求头(可选)
# request_body: String - 请求体(可选)
# request_timeout: float - 超时时间可选默认使用DEFAULT_TIMEOUT
func _init(request_id: String, request_url: String, request_method: RequestType,
request_headers: PackedStringArray = [], request_body: String = "",
request_timeout: float = DEFAULT_TIMEOUT):
@@ -49,40 +100,107 @@ class RequestInfo:
headers = request_headers
body = request_body
timeout = request_timeout
# 记录请求开始时间(简化版时间戳)
start_time = Time.get_time_dict_from_system().hour * 3600 + Time.get_time_dict_from_system().minute * 60 + Time.get_time_dict_from_system().second
# 活动请求管理
var active_requests: Dictionary = {}
var request_counter: int = 0
# ============ 成员变量 ============
# 活动请求管理
var active_requests: Dictionary = {} # 存储所有活动请求 {request_id: RequestInfo}
var request_counter: int = 0 # 请求计数器用于生成唯一ID
# ============ 生命周期方法 ============
# 初始化网络管理器
# 在节点准备就绪时调用
func _ready():
print("NetworkManager 已初始化")
# ============ 公共API接口 ============
# 发送GET请求
#
# 参数:
# endpoint: String - API端点路径如: "/api/users"
# callback: Callable - 完成时的回调函数(可选)
# timeout: float - 超时时间可选默认30秒
#
# 返回值:
# String - 请求ID可用于取消请求或跟踪状态
#
# 使用示例:
# var request_id = NetworkManager.get_request("/api/users", my_callback)
func get_request(endpoint: String, callback: Callable = Callable(), timeout: float = DEFAULT_TIMEOUT) -> String:
return send_request(endpoint, RequestType.GET, [], "", callback, timeout)
# 发送POST请求
#
# 参数:
# endpoint: String - API端点路径
# data: Dictionary - 要发送的数据将自动转换为JSON
# callback: Callable - 完成时的回调函数(可选)
# timeout: float - 超时时间(可选)
#
# 返回值:
# String - 请求ID
#
# 使用示例:
# var data = {"name": "张三", "age": 25}
# var request_id = NetworkManager.post_request("/api/users", data, my_callback)
func post_request(endpoint: String, data: Dictionary, callback: Callable = Callable(), timeout: float = DEFAULT_TIMEOUT) -> String:
var body = JSON.stringify(data)
var headers = ["Content-Type: application/json"]
return send_request(endpoint, RequestType.POST, headers, body, callback, timeout)
# 发送PUT请求
#
# 参数:
# endpoint: String - API端点路径
# data: Dictionary - 要更新的数据
# callback: Callable - 完成时的回调函数(可选)
# timeout: float - 超时时间(可选)
#
# 返回值:
# String - 请求ID
func put_request(endpoint: String, data: Dictionary, callback: Callable = Callable(), timeout: float = DEFAULT_TIMEOUT) -> String:
var body = JSON.stringify(data)
var headers = ["Content-Type: application/json"]
return send_request(endpoint, RequestType.PUT, headers, body, callback, timeout)
# 发送DELETE请求
#
# 参数:
# endpoint: String - API端点路径
# callback: Callable - 完成时的回调函数(可选)
# timeout: float - 超时时间(可选)
#
# 返回值:
# String - 请求ID
func delete_request(endpoint: String, callback: Callable = Callable(), timeout: float = DEFAULT_TIMEOUT) -> String:
return send_request(endpoint, RequestType.DELETE, [], "", callback, timeout)
# ============ 认证相关API ============
# 用户登录
#
# 参数:
# identifier: String - 用户标识符(邮箱或手机号)
# password: String - 用户密码
# callback: Callable - 完成时的回调函数(可选)
#
# 返回值:
# String - 请求ID
#
# 回调函数签名:
# func callback(success: bool, data: Dictionary, error_info: Dictionary)
#
# 使用示例:
# NetworkManager.login("user@example.com", "password123", func(success, data, error):
# if success:
# print("登录成功: ", data)
# else:
# print("登录失败: ", error.message)
# )
func login(identifier: String, password: String, callback: Callable = Callable()) -> String:
var data = {
"identifier": identifier,
@@ -91,6 +209,18 @@ func login(identifier: String, password: String, callback: Callable = Callable()
return post_request("/auth/login", data, callback)
# 验证码登录
#
# 参数:
# identifier: String - 用户标识符(邮箱或手机号)
# verification_code: String - 验证码
# callback: Callable - 完成时的回调函数(可选)
#
# 返回值:
# String - 请求ID
#
# 使用场景:
# - 用户忘记密码时的替代登录方式
# - 提供更安全的登录选项
func verification_code_login(identifier: String, verification_code: String, callback: Callable = Callable()) -> String:
var data = {
"identifier": identifier,
@@ -99,11 +229,39 @@ func verification_code_login(identifier: String, verification_code: String, call
return post_request("/auth/verification-code-login", data, callback)
# 发送登录验证码
#
# 参数:
# identifier: String - 用户标识符(邮箱或手机号)
# callback: Callable - 完成时的回调函数(可选)
#
# 返回值:
# String - 请求ID
#
# 功能:
# - 向已注册用户发送登录验证码
# - 支持邮箱和手机号
# - 有频率限制保护
func send_login_verification_code(identifier: String, callback: Callable = Callable()) -> String:
var data = {"identifier": identifier}
return post_request("/auth/send-login-verification-code", data, callback)
# 用户注册
#
# 参数:
# username: String - 用户名
# password: String - 密码
# nickname: String - 昵称
# email: String - 邮箱地址(可选)
# email_verification_code: String - 邮箱验证码(可选)
# callback: Callable - 完成时的回调函数(可选)
#
# 返回值:
# String - 请求ID
#
# 注意事项:
# - 如果提供邮箱,建议同时提供验证码
# - 用户名和邮箱必须唯一
# - 密码需要符合安全要求
func register(username: String, password: String, nickname: String, email: String = "",
email_verification_code: String = "", callback: Callable = Callable()) -> String:
var data = {
@@ -112,6 +270,7 @@ func register(username: String, password: String, nickname: String, email: Strin
"nickname": nickname
}
# 可选参数处理
if email != "":
data["email"] = email
if email_verification_code != "":
@@ -120,11 +279,35 @@ func register(username: String, password: String, nickname: String, email: Strin
return post_request("/auth/register", data, callback)
# 发送邮箱验证码
#
# 参数:
# email: String - 邮箱地址
# callback: Callable - 完成时的回调函数(可选)
#
# 返回值:
# String - 请求ID
#
# 功能:
# - 向指定邮箱发送验证码
# - 用于注册时的邮箱验证
# - 支持测试模式(开发环境)
func send_email_verification(email: String, callback: Callable = Callable()) -> String:
var data = {"email": email}
return post_request("/auth/send-email-verification", data, callback)
# 验证邮箱
#
# 参数:
# email: String - 邮箱地址
# verification_code: String - 验证码
# callback: Callable - 完成时的回调函数(可选)
#
# 返回值:
# String - 请求ID
#
# 功能:
# - 验证邮箱验证码的有效性
# - 通常在注册流程中使用
func verify_email(email: String, verification_code: String, callback: Callable = Callable()) -> String:
var data = {
"email": email,
@@ -133,20 +316,66 @@ func verify_email(email: String, verification_code: String, callback: Callable =
return post_request("/auth/verify-email", data, callback)
# 获取应用状态
#
# 参数:
# callback: Callable - 完成时的回调函数(可选)
#
# 返回值:
# String - 请求ID
#
# 功能:
# - 检查API服务器状态
# - 获取应用基本信息
# - 用于网络连接测试
func get_app_status(callback: Callable = Callable()) -> String:
return get_request("/", callback)
# 重新发送邮箱验证码
#
# 参数:
# email: String - 邮箱地址
# callback: Callable - 完成时的回调函数(可选)
#
# 返回值:
# String - 请求ID
#
# 使用场景:
# - 用户未收到验证码时重新发送
# - 验证码过期后重新获取
func resend_email_verification(email: String, callback: Callable = Callable()) -> String:
var data = {"email": email}
return post_request("/auth/resend-email-verification", data, callback)
# 忘记密码 - 发送重置验证码
#
# 参数:
# identifier: String - 用户标识符(邮箱或手机号)
# callback: Callable - 完成时的回调函数(可选)
#
# 返回值:
# String - 请求ID
#
# 功能:
# - 向用户发送密码重置验证码
# - 用于密码找回流程的第一步
func forgot_password(identifier: String, callback: Callable = Callable()) -> String:
var data = {"identifier": identifier}
return post_request("/auth/forgot-password", data, callback)
# 重置密码
#
# 参数:
# identifier: String - 用户标识符
# verification_code: String - 重置验证码
# new_password: String - 新密码
# callback: Callable - 完成时的回调函数(可选)
#
# 返回值:
# String - 请求ID
#
# 功能:
# - 使用验证码重置用户密码
# - 密码找回流程的第二步
func reset_password(identifier: String, verification_code: String, new_password: String, callback: Callable = Callable()) -> String:
var data = {
"identifier": identifier,
@@ -156,6 +385,19 @@ func reset_password(identifier: String, verification_code: String, new_password:
return post_request("/auth/reset-password", data, callback)
# 修改密码
#
# 参数:
# user_id: String - 用户ID
# old_password: String - 旧密码
# new_password: String - 新密码
# callback: Callable - 完成时的回调函数(可选)
#
# 返回值:
# String - 请求ID
#
# 功能:
# - 已登录用户修改密码
# - 需要验证旧密码
func change_password(user_id: String, old_password: String, new_password: String, callback: Callable = Callable()) -> String:
var data = {
"user_id": user_id,
@@ -165,6 +407,21 @@ func change_password(user_id: String, old_password: String, new_password: String
return put_request("/auth/change-password", data, callback)
# GitHub OAuth登录
#
# 参数:
# github_id: String - GitHub用户ID
# username: String - GitHub用户名
# nickname: String - 显示昵称
# email: String - GitHub邮箱
# avatar_url: String - 头像URL可选
# callback: Callable - 完成时的回调函数(可选)
#
# 返回值:
# String - 请求ID
#
# 功能:
# - 通过GitHub账号登录或注册
# - 支持第三方OAuth认证
func github_login(github_id: String, username: String, nickname: String, email: String, avatar_url: String = "", callback: Callable = Callable()) -> String:
var data = {
"github_id": github_id,
@@ -173,6 +430,7 @@ func github_login(github_id: String, username: String, nickname: String, email:
"email": email
}
# 可选头像URL
if avatar_url != "":
data["avatar_url"] = avatar_url
@@ -206,8 +464,8 @@ func send_request(endpoint: String, method: RequestType, headers: PackedStringAr
active_requests[request_id] = request_info
# 连接信号
http_request.request_completed.connect(func(result: int, response_code: int, headers: PackedStringArray, body: PackedByteArray):
_on_request_completed(request_id, result, response_code, headers, body)
http_request.request_completed.connect(func(result: int, response_code: int, response_headers: PackedStringArray, response_body: PackedByteArray):
_on_request_completed(request_id, result, response_code, response_headers, response_body)
)
# 发送请求
@@ -243,7 +501,7 @@ func _on_request_completed(request_id: String, result: int, response_code: int,
print("警告: 未找到请求ID ", request_id)
return
var request_info = active_requests[request_id]
var _request_info = active_requests[request_id]
var response_text = body.get_string_from_utf8()
print("响应体长度: ", body.size(), " 字节")
@@ -440,4 +698,4 @@ func get_request_info(request_id: String) -> Dictionary:
func _notification(what):
if what == NOTIFICATION_WM_CLOSE_REQUEST:
# 应用关闭时取消所有请求
cancel_all_requests()
cancel_all_requests()

View File

@@ -84,7 +84,7 @@ const HTTP_STATUS_MESSAGES = {
# ============ 主要处理方法 ============
# 处理登录响应
static func handle_login_response(success: bool, data: Dictionary, error_info: Dictionary = {}) -> ResponseResult:
func handle_login_response(success: bool, data: Dictionary, error_info: Dictionary = {}) -> ResponseResult:
var result = ResponseResult.new()
if success:
@@ -103,7 +103,7 @@ static func handle_login_response(success: bool, data: Dictionary, error_info: D
return result
# 处理验证码登录响应
static func handle_verification_code_login_response(success: bool, data: Dictionary, error_info: Dictionary = {}) -> ResponseResult:
func handle_verification_code_login_response(success: bool, data: Dictionary, error_info: Dictionary = {}) -> ResponseResult:
var result = ResponseResult.new()
if success:
@@ -121,7 +121,7 @@ static func handle_verification_code_login_response(success: bool, data: Diction
return result
# 处理发送验证码响应 - 支持邮箱冲突检测
static func handle_send_verification_code_response(success: bool, data: Dictionary, error_info: Dictionary = {}) -> ResponseResult:
func handle_send_verification_code_response(success: bool, data: Dictionary, error_info: Dictionary = {}) -> ResponseResult:
var result = ResponseResult.new()
if success:
@@ -149,7 +149,7 @@ static func handle_send_verification_code_response(success: bool, data: Dictiona
return result
# 处理发送登录验证码响应
static func handle_send_login_code_response(success: bool, data: Dictionary, error_info: Dictionary = {}) -> ResponseResult:
func handle_send_login_code_response(success: bool, data: Dictionary, error_info: Dictionary = {}) -> ResponseResult:
var result = ResponseResult.new()
if success:
@@ -174,7 +174,7 @@ static func handle_send_login_code_response(success: bool, data: Dictionary, err
return result
# 处理注册响应
static func handle_register_response(success: bool, data: Dictionary, error_info: Dictionary = {}) -> ResponseResult:
func handle_register_response(success: bool, data: Dictionary, error_info: Dictionary = {}) -> ResponseResult:
var result = ResponseResult.new()
if success:
@@ -193,7 +193,7 @@ static func handle_register_response(success: bool, data: Dictionary, error_info
return result
# 处理邮箱验证响应
static func handle_verify_email_response(success: bool, data: Dictionary, error_info: Dictionary = {}) -> ResponseResult:
func handle_verify_email_response(success: bool, data: Dictionary, error_info: Dictionary = {}) -> ResponseResult:
var result = ResponseResult.new()
if success:
@@ -207,7 +207,7 @@ static func handle_verify_email_response(success: bool, data: Dictionary, error_
return result
# 处理重新发送邮箱验证码响应
static func handle_resend_email_verification_response(success: bool, data: Dictionary, error_info: Dictionary = {}) -> ResponseResult:
func handle_resend_email_verification_response(success: bool, data: Dictionary, error_info: Dictionary = {}) -> ResponseResult:
var result = ResponseResult.new()
if success:
@@ -232,7 +232,7 @@ static func handle_resend_email_verification_response(success: bool, data: Dicti
return result
# 处理忘记密码响应
static func handle_forgot_password_response(success: bool, data: Dictionary, error_info: Dictionary = {}) -> ResponseResult:
func handle_forgot_password_response(success: bool, data: Dictionary, error_info: Dictionary = {}) -> ResponseResult:
var result = ResponseResult.new()
if success:
@@ -257,7 +257,7 @@ static func handle_forgot_password_response(success: bool, data: Dictionary, err
return result
# 处理重置密码响应
static func handle_reset_password_response(success: bool, data: Dictionary, error_info: Dictionary = {}) -> ResponseResult:
func handle_reset_password_response(success: bool, data: Dictionary, error_info: Dictionary = {}) -> ResponseResult:
var result = ResponseResult.new()
if success:
@@ -273,7 +273,7 @@ static func handle_reset_password_response(success: bool, data: Dictionary, erro
# ============ 错误处理方法 ============
# 处理登录错误
static func _handle_login_error(data: Dictionary, error_info: Dictionary) -> ResponseResult:
func _handle_login_error(data: Dictionary, error_info: Dictionary) -> ResponseResult:
var result = ResponseResult.new()
var error_code = data.get("error_code", "")
var message = data.get("message", "登录失败")
@@ -297,7 +297,7 @@ static func _handle_login_error(data: Dictionary, error_info: Dictionary) -> Res
return result
# 处理验证码登录错误
static func _handle_verification_code_login_error(data: Dictionary, error_info: Dictionary) -> ResponseResult:
func _handle_verification_code_login_error(data: Dictionary, error_info: Dictionary) -> ResponseResult:
var result = ResponseResult.new()
var error_code = data.get("error_code", "")
var message = data.get("message", "验证码登录失败")
@@ -317,7 +317,7 @@ static func _handle_verification_code_login_error(data: Dictionary, error_info:
return result
# 处理发送验证码错误 - 支持邮箱冲突检测和频率限制
static func _handle_send_code_error(data: Dictionary, error_info: Dictionary) -> ResponseResult:
func _handle_send_code_error(data: Dictionary, error_info: Dictionary) -> ResponseResult:
var result = ResponseResult.new()
var error_code = data.get("error_code", "")
var message = data.get("message", "发送验证码失败")
@@ -361,7 +361,7 @@ static func _handle_send_code_error(data: Dictionary, error_info: Dictionary) ->
return result
# 处理发送登录验证码错误
static func _handle_send_login_code_error(data: Dictionary, error_info: Dictionary) -> ResponseResult:
func _handle_send_login_code_error(data: Dictionary, error_info: Dictionary) -> ResponseResult:
var result = ResponseResult.new()
var error_code = data.get("error_code", "")
var message = data.get("message", "发送登录验证码失败")
@@ -382,7 +382,7 @@ static func _handle_send_login_code_error(data: Dictionary, error_info: Dictiona
return result
# 处理注册错误 - 支持409冲突状态码
static func _handle_register_error(data: Dictionary, error_info: Dictionary) -> ResponseResult:
func _handle_register_error(data: Dictionary, error_info: Dictionary) -> ResponseResult:
var result = ResponseResult.new()
var error_code = data.get("error_code", "")
var message = data.get("message", "注册失败")
@@ -416,7 +416,7 @@ static func _handle_register_error(data: Dictionary, error_info: Dictionary) ->
return result
# 处理邮箱验证错误
static func _handle_verify_email_error(data: Dictionary, error_info: Dictionary) -> ResponseResult:
func _handle_verify_email_error(data: Dictionary, error_info: Dictionary) -> ResponseResult:
var result = ResponseResult.new()
var error_code = data.get("error_code", "")
var message = data.get("message", "邮箱验证失败")
@@ -439,7 +439,7 @@ static func _handle_verify_email_error(data: Dictionary, error_info: Dictionary)
return result
# 处理网络测试响应
static func handle_network_test_response(success: bool, data: Dictionary, error_info: Dictionary = {}) -> ResponseResult:
func handle_network_test_response(success: bool, _data: Dictionary, _error_info: Dictionary = {}) -> ResponseResult:
var result = ResponseResult.new()
if success:
@@ -454,7 +454,7 @@ static func handle_network_test_response(success: bool, data: Dictionary, error_
return result
# 处理重新发送邮箱验证码错误
static func _handle_resend_email_verification_error(data: Dictionary, error_info: Dictionary) -> ResponseResult:
func _handle_resend_email_verification_error(data: Dictionary, error_info: Dictionary) -> ResponseResult:
var result = ResponseResult.new()
var error_code = data.get("error_code", "")
var message = data.get("message", "重新发送验证码失败")
@@ -471,7 +471,7 @@ static func _handle_resend_email_verification_error(data: Dictionary, error_info
return result
# 处理忘记密码错误
static func _handle_forgot_password_error(data: Dictionary, error_info: Dictionary) -> ResponseResult:
func _handle_forgot_password_error(data: Dictionary, error_info: Dictionary) -> ResponseResult:
var result = ResponseResult.new()
var error_code = data.get("error_code", "")
var message = data.get("message", "发送重置验证码失败")
@@ -490,7 +490,7 @@ static func _handle_forgot_password_error(data: Dictionary, error_info: Dictiona
return result
# 处理重置密码错误
static func _handle_reset_password_error(data: Dictionary, error_info: Dictionary) -> ResponseResult:
func _handle_reset_password_error(data: Dictionary, error_info: Dictionary) -> ResponseResult:
var result = ResponseResult.new()
var error_code = data.get("error_code", "")
var message = data.get("message", "重置密码失败")
@@ -509,7 +509,7 @@ static func _handle_reset_password_error(data: Dictionary, error_info: Dictionar
# ============ 工具方法 ============
# 获取错误消息 - 支持更多状态码和错误处理
static func _get_error_message(error_code: String, original_message: String, error_info: Dictionary) -> String:
func _get_error_message(error_code: String, original_message: String, error_info: Dictionary) -> String:
# 优先使用错误码映射
if ERROR_CODE_MESSAGES.has(error_code):
return ERROR_CODE_MESSAGES[error_code]
@@ -544,17 +544,17 @@ static func _get_error_message(error_code: String, original_message: String, err
return original_message if original_message != "" else "操作失败"
# 处理频率限制消息
static func _handle_rate_limit_message(message: String, error_info: Dictionary) -> String:
func _handle_rate_limit_message(message: String, _error_info: Dictionary) -> String:
# 可以根据throttle_info提供更详细的信息
return message + ",请稍后再试"
# 处理维护模式消息
static func _handle_maintenance_message(message: String, error_info: Dictionary) -> String:
func _handle_maintenance_message(_message: String, _error_info: Dictionary) -> String:
# 可以根据maintenance_info提供更详细的信息
return "系统维护中,请稍后再试"
# 通用响应处理器 - 支持更多操作类型
static func handle_response(operation_type: String, success: bool, data: Dictionary, error_info: Dictionary = {}) -> ResponseResult:
func handle_response(operation_type: String, success: bool, data: Dictionary, error_info: Dictionary = {}) -> ResponseResult:
match operation_type:
"login":
return handle_login_response(success, data, error_info)
@@ -587,4 +587,4 @@ static func handle_response(operation_type: String, success: bool, data: Diction
result.success = false
result.message = _get_error_message(data.get("error_code", ""), data.get("message", "操作失败"), error_info)
result.toast_type = "error"
return result
return result

View File

@@ -1,33 +1,96 @@
extends Node
# 场景管理器 - 负责场景切换和管理
# 提供场景切换的统一接口
# ============================================================================
# SceneManager.gd - 场景管理器
# ============================================================================
# 全局单例管理器,负责场景切换和管理
#
# 核心职责:
# - 场景切换的统一接口
# - 场景路径映射管理
# - 场景切换过渡效果
# - 场景状态跟踪
#
# 使用方式:
# SceneManager.change_scene("main")
# SceneManager.register_scene("custom", "res://scenes/custom.tscn")
#
# 注意事项:
# - 作为自动加载单例,全局可访问
# - 场景切换是异步操作,支持过渡效果
# - 场景名称必须在 scene_paths 中注册
# ============================================================================
# ============ 信号定义 ============
# 场景切换完成信号
# 参数: scene_name - 切换到的场景名称
signal scene_changed(scene_name: String)
# 场景切换开始信号
# 参数: scene_name - 即将切换到的场景名称
signal scene_change_started(scene_name: String)
var current_scene_name: String = ""
var is_changing_scene: bool = false
# ============ 成员变量 ============
# 场景路径映射
# 场景状态
var current_scene_name: String = "" # 当前场景名称
var is_changing_scene: bool = false # 是否正在切换场景
# 场景路径映射表
# 将场景名称映射到实际的文件路径
# 便于统一管理和修改场景路径
var scene_paths: Dictionary = {
"main": "res://Scenes/Maps/main_scene.tscn",
"auth": "res://UI/Windows/LoginWindow.tscn",
"game": "res://Scenes/Maps/game_scene.tscn",
"battle": "res://Scenes/Maps/battle_scene.tscn",
"inventory": "res://UI/Windows/InventoryWindow.tscn",
"shop": "res://UI/Windows/ShopWindow.tscn",
"settings": "res://UI/Windows/SettingsWindow.tscn"
"main": "res://scenes/MainScene.tscn", # 主场景 - 游戏入口
"auth": "res://scenes/ui/LoginWindow.tscn", # 认证场景 - 登录窗口
"game": "res://scenes/maps/game_scene.tscn", # 游戏场景 - 主要游戏内容
"battle": "res://scenes/maps/battle_scene.tscn", # 战斗场景 - 战斗系统
"inventory": "res://scenes/ui/InventoryWindow.tscn", # 背包界面
"shop": "res://scenes/ui/ShopWindow.tscn", # 商店界面
"settings": "res://scenes/ui/SettingsWindow.tscn" # 设置界面
}
# ============ 生命周期方法 ============
# 初始化场景管理器
# 在节点准备就绪时调用
func _ready():
print("SceneManager 初始化完成")
# ============ 场景切换方法 ============
# 切换到指定场景
#
# 参数:
# scene_name: String - 要切换到的场景名称必须在scene_paths中注册
# use_transition: bool - 是否使用过渡效果默认为true
#
# 返回值:
# bool - 切换是否成功
#
# 功能:
# - 检查场景切换状态和场景是否存在
# - 显示过渡效果(可选)
# - 执行场景切换
# - 更新当前场景状态
# - 发送相关信号
#
# 使用示例:
# var success = SceneManager.change_scene("main", true)
# if success:
# print("场景切换成功")
#
# 注意事项:
# - 场景切换是异步操作
# - 切换过程中会阻止新的切换请求
# - 场景名称必须预先注册
func change_scene(scene_name: String, use_transition: bool = true):
# 防止重复切换
if is_changing_scene:
print("场景切换中,忽略新的切换请求")
return false
# 检查场景是否存在
if not scene_paths.has(scene_name):
print("错误: 未找到场景 ", scene_name)
return false
@@ -35,40 +98,89 @@ func change_scene(scene_name: String, use_transition: bool = true):
var scene_path = scene_paths[scene_name]
print("开始切换场景: ", current_scene_name, " -> ", scene_name)
# 设置切换状态
is_changing_scene = true
scene_change_started.emit(scene_name)
# 显示过渡效果
if use_transition:
await show_transition()
# 执行场景切换
var error = get_tree().change_scene_to_file(scene_path)
if error != OK:
print("场景切换失败: ", error)
is_changing_scene = false
return false
# 更新状态
current_scene_name = scene_name
is_changing_scene = false
scene_changed.emit(scene_name)
# 隐藏过渡效果
if use_transition:
await hide_transition()
print("场景切换完成: ", scene_name)
return true
# ============ 查询方法 ============
# 获取当前场景名称
#
# 返回值:
# String - 当前场景的名称
func get_current_scene_name() -> String:
return current_scene_name
# ============ 场景注册方法 ============
# 注册新场景
#
# 参数:
# scene_name: String - 场景名称(用于切换时引用)
# scene_path: String - 场景文件路径
#
# 功能:
# - 将场景名称和路径添加到映射表
# - 支持运行时动态注册场景
#
# 使用示例:
# SceneManager.register_scene("boss_battle", "res://scenes/boss/boss_battle.tscn")
func register_scene(scene_name: String, scene_path: String):
scene_paths[scene_name] = scene_path
print("注册场景: ", scene_name, " -> ", scene_path)
# ============ 过渡效果方法 ============
# 显示场景切换过渡效果
#
# 功能:
# - 显示场景切换时的过渡动画
# - 为用户提供视觉反馈
#
# 注意事项:
# - 这是异步方法需要await等待完成
# - 当前实现为简单的延时,可扩展为复杂动画
#
# TODO: 实现淡入淡出、滑动等过渡效果
func show_transition():
# TODO: 实现场景切换过渡效果
print("显示场景切换过渡效果")
await get_tree().create_timer(0.2).timeout
# 隐藏场景切换过渡效果
#
# 功能:
# - 隐藏场景切换完成后的过渡动画
# - 恢复正常的游戏显示
#
# 注意事项:
# - 这是异步方法需要await等待完成
# - 与show_transition()配对使用
#
# TODO: 实现与show_transition()对应的隐藏效果
func hide_transition():
# TODO: 隐藏场景切换过渡效果
print("隐藏场景切换过渡效果")

View File

@@ -0,0 +1,234 @@
class_name ToastManager
# ============================================================================
# ToastManager.gd - Toast消息管理器
# ============================================================================
# 负责创建和管理Toast消息的显示
#
# 核心功能:
# - 创建Toast消息实例
# - 管理Toast动画和生命周期
# - 支持多个Toast同时显示
# - 自动排列和清理Toast
# - 支持中文字体显示
#
# 使用方式:
# var toast_manager = ToastManager.new()
# toast_manager.setup(toast_container)
# toast_manager.show_toast("消息内容", true)
#
# 注意事项:
# - 需要提供一个容器节点来承载Toast
# - 自动处理Toast的位置计算和动画
# - 支持Web平台的字体处理
# ============================================================================
extends RefCounted
# ============ 成员变量 ============
# Toast容器和管理
var toast_container: Control # Toast消息容器
var active_toasts: Array = [] # 当前显示的Toast消息列表
var toast_counter: int = 0 # Toast计数器用于生成唯一ID
# ============ 初始化方法 ============
# 设置Toast管理器
#
# 参数:
# container: Control - Toast消息的容器节点
func setup(container: Control):
toast_container = container
print("ToastManager 初始化完成")
# ============ 公共方法 ============
# 显示Toast消息
#
# 参数:
# message: String - 消息内容
# is_success: bool - 是否为成功消息(影响颜色)
func show_toast(message: String, is_success: bool = true):
if toast_container == null:
print("错误: toast_container 节点不存在")
return
print("显示Toast消息: ", message, " 成功: ", is_success)
_create_toast_instance(message, is_success)
# 清理所有Toast
func clear_all_toasts():
for toast in active_toasts:
if is_instance_valid(toast):
toast.queue_free()
active_toasts.clear()
# ============ 私有方法 ============
# 创建Toast实例
func _create_toast_instance(message: String, is_success: bool):
toast_counter += 1
# Web平台字体处理
var is_web = OS.get_name() == "Web"
# 1. 创建Toast Panel方框UI
var toast_panel = Panel.new()
toast_panel.name = "Toast_" + str(toast_counter)
# 设置Toast样式
var style = StyleBoxFlat.new()
if is_success:
style.bg_color = Color(0.15, 0.7, 0.15, 0.95)
style.border_color = Color(0.2, 0.9, 0.2, 0.9)
else:
style.bg_color = Color(0.7, 0.15, 0.15, 0.95)
style.border_color = Color(0.9, 0.2, 0.2, 0.9)
style.border_width_left = 3
style.border_width_top = 3
style.border_width_right = 3
style.border_width_bottom = 3
style.corner_radius_top_left = 12
style.corner_radius_top_right = 12
style.corner_radius_bottom_left = 12
style.corner_radius_bottom_right = 12
style.shadow_color = Color(0, 0, 0, 0.3)
style.shadow_size = 4
style.shadow_offset = Vector2(2, 2)
toast_panel.add_theme_stylebox_override("panel", style)
# 设置Toast基本尺寸
var toast_width = 320
toast_panel.size = Vector2(toast_width, 60)
# 2. 创建VBoxContainer
var vbox = VBoxContainer.new()
vbox.add_theme_constant_override("separation", 0)
vbox.set_anchors_and_offsets_preset(Control.PRESET_FULL_RECT)
vbox.alignment = BoxContainer.ALIGNMENT_CENTER
# 3. 创建CenterContainer
var center_container = CenterContainer.new()
center_container.size_flags_horizontal = Control.SIZE_EXPAND_FILL
center_container.size_flags_vertical = Control.SIZE_SHRINK_CENTER
# 4. 创建Label文字控件
var text_label = Label.new()
text_label.text = message
text_label.add_theme_color_override("font_color", Color(1, 1, 1, 1))
text_label.add_theme_font_size_override("font_size", 14)
# 平台特定的字体处理
if is_web:
print("Web平台Toast字体处理")
# Web平台使用主题文件
var chinese_theme = load("res://assets/ui/chinese_theme.tres")
if chinese_theme:
text_label.theme = chinese_theme
print("Web平台应用中文主题")
else:
print("Web平台中文主题加载失败")
else:
print("桌面平台Toast字体处理")
# 桌面平台直接加载中文字体
var desktop_chinese_font = load("res://assets/fonts/msyh.ttc")
if desktop_chinese_font:
text_label.add_theme_font_override("font", desktop_chinese_font)
print("桌面平台使用中文字体")
text_label.autowrap_mode = TextServer.AUTOWRAP_WORD_SMART
text_label.custom_minimum_size = Vector2(280, 0)
text_label.horizontal_alignment = HORIZONTAL_ALIGNMENT_CENTER
text_label.vertical_alignment = VERTICAL_ALIGNMENT_CENTER
# 组装控件层级
center_container.add_child(text_label)
vbox.add_child(center_container)
toast_panel.add_child(vbox)
# 计算位置
var margin = 20
var start_x = toast_container.get_viewport().get_visible_rect().size.x
var final_x = toast_container.get_viewport().get_visible_rect().size.x - toast_width - margin
# 计算Y位置
var y_position = margin
for existing_toast in active_toasts:
if is_instance_valid(existing_toast):
y_position += existing_toast.size.y + 15
# 设置初始位置
toast_panel.position = Vector2(start_x, y_position)
# 添加到容器
toast_container.add_child(toast_panel)
active_toasts.append(toast_panel)
# 等待一帧让布局系统计算尺寸
await toast_container.get_tree().process_frame
# 让Toast高度自适应内容
var content_size = vbox.get_combined_minimum_size()
var final_height = max(60, content_size.y + 20) # 最小60加20像素边距
toast_panel.size.y = final_height
# 重新排列所有Toast
_rearrange_toasts()
# 开始动画
_animate_toast_in(toast_panel, final_x)
# Toast入场动画
func _animate_toast_in(toast_panel: Panel, final_x: float):
var tween = toast_container.create_tween()
tween.set_ease(Tween.EASE_OUT)
tween.set_trans(Tween.TRANS_BACK)
tween.parallel().tween_property(toast_panel, "position:x", final_x, 0.6)
tween.parallel().tween_property(toast_panel, "modulate:a", 1.0, 0.4)
toast_panel.modulate.a = 0.0
# 等待3秒后开始退场动画
await toast_container.get_tree().create_timer(3.0).timeout
_animate_toast_out(toast_panel)
# Toast退场动画
func _animate_toast_out(toast_panel: Panel):
if not is_instance_valid(toast_panel):
return
var tween = toast_container.create_tween()
tween.set_ease(Tween.EASE_IN)
tween.set_trans(Tween.TRANS_QUART)
var end_x = toast_container.get_viewport().get_visible_rect().size.x + 50
tween.parallel().tween_property(toast_panel, "position:x", end_x, 0.4)
tween.parallel().tween_property(toast_panel, "modulate:a", 0.0, 0.3)
await tween.finished
_cleanup_toast(toast_panel)
# 清理Toast
func _cleanup_toast(toast_panel: Panel):
if not is_instance_valid(toast_panel):
return
active_toasts.erase(toast_panel)
_rearrange_toasts()
toast_panel.queue_free()
# 重新排列Toast位置
func _rearrange_toasts():
var margin = 20
var current_y = margin
for i in range(active_toasts.size()):
var toast = active_toasts[i]
if is_instance_valid(toast):
var tween = toast_container.create_tween()
tween.tween_property(toast, "position:y", current_y, 0.2)
current_y += toast.size.y + 15

View File

@@ -0,0 +1 @@
uid://buk7d21cag262

View File

@@ -1,44 +1,125 @@
extends Node
# 全局事件系统 - 提供解耦的事件通信机制
# 允许不同模块之间通过事件进行通信,避免直接依赖
# ============================================================================
# EventSystem.gd - 全局事件系统
# ============================================================================
# 全局单例管理器,提供解耦的事件通信机制
#
# 核心职责:
# - 事件监听器注册和管理
# - 事件发送和分发
# - 自动清理无效监听器
# - 支持带参数的事件通信
#
# 使用方式:
# EventSystem.connect_event("player_moved", _on_player_moved)
# EventSystem.emit_event("player_moved", {"position": Vector2(100, 200)})
#
# 注意事项:
# - 作为自动加载单例,全局可访问
# - 监听器会自动检查目标节点的有效性
# - 建议使用EventNames类中定义的事件名称常量
# ============================================================================
# ============ 成员变量 ============
# 事件监听器存储
# 结构: {event_name: [{"callback": Callable, "target": Node}, ...]}
var event_listeners: Dictionary = {}
# ============ 生命周期方法 ============
# 初始化事件系统
# 在节点准备就绪时调用
func _ready():
print("EventSystem 初始化完成")
# ============ 事件监听器管理 ============
# 注册事件监听器
#
# 参数:
# event_name: String - 事件名称建议使用EventNames中的常量
# callback: Callable - 回调函数
# target: Node - 目标节点(可选,用于自动清理)
#
# 功能:
# - 将回调函数注册到指定事件
# - 支持同一事件多个监听器
# - 自动管理监听器生命周期
#
# 使用示例:
# EventSystem.connect_event(EventNames.PLAYER_MOVED, _on_player_moved, self)
#
# 注意事项:
# - 如果提供target参数当target节点被销毁时会自动清理监听器
# - 同一个callback可以监听多个事件
func connect_event(event_name: String, callback: Callable, target: Node = null):
# 初始化事件监听器数组
if not event_listeners.has(event_name):
event_listeners[event_name] = []
# 创建监听器信息
var listener_info = {
"callback": callback,
"target": target
}
# 添加到监听器列表
event_listeners[event_name].append(listener_info)
print("注册事件监听器: ", event_name, " -> ", callback)
# 移除事件监听器
#
# 参数:
# event_name: String - 事件名称
# callback: Callable - 要移除的回调函数
# target: Node - 目标节点(可选,用于精确匹配)
#
# 功能:
# - 从指定事件中移除特定的监听器
# - 支持精确匹配callback + target
#
# 使用示例:
# EventSystem.disconnect_event(EventNames.PLAYER_MOVED, _on_player_moved, self)
func disconnect_event(event_name: String, callback: Callable, target: Node = null):
if not event_listeners.has(event_name):
return
var listeners = event_listeners[event_name]
# 从后往前遍历,避免删除元素时索引问题
for i in range(listeners.size() - 1, -1, -1):
var listener = listeners[i]
# 匹配callback和target
if listener.callback == callback and listener.target == target:
listeners.remove_at(i)
print("移除事件监听器: ", event_name, " -> ", callback)
break
# ============ 事件发送 ============
# 发送事件
#
# 参数:
# event_name: String - 事件名称
# data: Variant - 事件数据(可选)
#
# 功能:
# - 向所有注册的监听器发送事件
# - 自动跳过无效的监听器
# - 支持任意类型的事件数据
#
# 使用示例:
# EventSystem.emit_event(EventNames.PLAYER_MOVED, {"position": Vector2(100, 200)})
# EventSystem.emit_event(EventNames.GAME_PAUSED) # 无数据事件
#
# 注意事项:
# - 事件发送是同步的,所有监听器会立即执行
# - 如果监听器执行出错,不会影响其他监听器
func emit_event(event_name: String, data: Variant = null):
print("发送事件: ", event_name, " 数据: ", data)
# 检查是否有监听器
if not event_listeners.has(event_name):
return
@@ -57,24 +138,58 @@ func emit_event(event_name: String, data: Variant = null):
else:
callback.call()
# ============ 维护方法 ============
# 清理无效的监听器
#
# 功能:
# - 遍历所有监听器,移除已销毁节点的监听器
# - 防止内存泄漏
# - 建议定期调用或在场景切换时调用
#
# 使用场景:
# - 场景切换时清理
# - 定期维护(如每分钟一次)
# - 内存优化时调用
func cleanup_invalid_listeners():
for event_name in event_listeners.keys():
var listeners = event_listeners[event_name]
# 从后往前遍历,避免删除元素时索引问题
for i in range(listeners.size() - 1, -1, -1):
var listener = listeners[i]
var target = listener.target
# 如果目标节点无效,移除监听器
if target != null and not is_instance_valid(target):
listeners.remove_at(i)
print("清理无效监听器: ", event_name)
# ============ 查询方法 ============
# 获取事件监听器数量
#
# 参数:
# event_name: String - 事件名称
#
# 返回值:
# int - 监听器数量
#
# 使用场景:
# - 调试时检查监听器数量
# - 性能分析
func get_listener_count(event_name: String) -> int:
if not event_listeners.has(event_name):
return 0
return event_listeners[event_name].size()
# 清空所有事件监听器
#
# 功能:
# - 移除所有已注册的事件监听器
# - 通常在游戏重置或退出时使用
#
# 警告:
# - 这是一个危险操作,会影响所有模块
# - 使用前请确保所有模块都能正确处理监听器丢失
func clear_all_listeners():
event_listeners.clear()
print("清空所有事件监听器")

143
_Core/systems/GridSystem.gd Normal file
View File

@@ -0,0 +1,143 @@
# ============================================================================
# 网格系统 - GridSystem.gd
#
# 提供32x32像素的最小网格单元控制用于规范地图大小和位置计算
#
# 使用方式:
# var grid_pos = GridSystem.world_to_grid(world_position)
# var world_pos = GridSystem.grid_to_world(grid_position)
# var snapped_pos = GridSystem.snap_to_grid(position)
# ============================================================================
class_name GridSystem
extends RefCounted
# ============================================================================
# 常量定义
# ============================================================================
const GRID_SIZE: int = 32 # 网格单元大小 32x32 像素
const HALF_GRID_SIZE: float = GRID_SIZE * 0.5 # 网格中心偏移
# ============================================================================
# 坐标转换方法
# ============================================================================
# 世界坐标转换为网格坐标
static func world_to_grid(world_pos: Vector2) -> Vector2i:
return Vector2i(
int(world_pos.x / GRID_SIZE),
int(world_pos.y / GRID_SIZE)
)
# 网格坐标转换为世界坐标(返回网格左上角)
static func grid_to_world(grid_pos: Vector2i) -> Vector2:
return Vector2(
grid_pos.x * GRID_SIZE,
grid_pos.y * GRID_SIZE
)
# 网格坐标转换为世界坐标(返回网格中心)
static func grid_to_world_center(grid_pos: Vector2i) -> Vector2:
return Vector2(
grid_pos.x * GRID_SIZE + HALF_GRID_SIZE,
grid_pos.y * GRID_SIZE + HALF_GRID_SIZE
)
# 将位置吸附到最近的网格点(左上角)
static func snap_to_grid(position: Vector2) -> Vector2:
return Vector2(
floor(position.x / GRID_SIZE) * GRID_SIZE,
floor(position.y / GRID_SIZE) * GRID_SIZE
)
# 将位置吸附到最近的网格中心
static func snap_to_grid_center(position: Vector2) -> Vector2:
var grid_pos = world_to_grid(position)
return grid_to_world_center(grid_pos)
# ============================================================================
# 距离和区域计算
# ============================================================================
# 计算两个网格坐标之间的曼哈顿距离
static func grid_distance_manhattan(grid_pos1: Vector2i, grid_pos2: Vector2i) -> int:
return abs(grid_pos1.x - grid_pos2.x) + abs(grid_pos1.y - grid_pos2.y)
# 计算两个网格坐标之间的欧几里得距离
static func grid_distance_euclidean(grid_pos1: Vector2i, grid_pos2: Vector2i) -> float:
var diff = grid_pos1 - grid_pos2
return sqrt(diff.x * diff.x + diff.y * diff.y)
# 获取指定网格坐标周围的邻居网格4方向
static func get_grid_neighbors_4(grid_pos: Vector2i) -> Array[Vector2i]:
return [
Vector2i(grid_pos.x, grid_pos.y - 1), # 上
Vector2i(grid_pos.x + 1, grid_pos.y), # 右
Vector2i(grid_pos.x, grid_pos.y + 1), # 下
Vector2i(grid_pos.x - 1, grid_pos.y) # 左
]
# 获取指定网格坐标周围的邻居网格8方向
static func get_grid_neighbors_8(grid_pos: Vector2i) -> Array[Vector2i]:
var neighbors: Array[Vector2i] = []
for x in range(-1, 2):
for y in range(-1, 2):
if x == 0 and y == 0:
continue
neighbors.append(Vector2i(grid_pos.x + x, grid_pos.y + y))
return neighbors
# ============================================================================
# 区域和边界检查
# ============================================================================
# 检查网格坐标是否在指定矩形区域内
static func is_grid_in_bounds(grid_pos: Vector2i, min_grid: Vector2i, max_grid: Vector2i) -> bool:
return (grid_pos.x >= min_grid.x and grid_pos.x <= max_grid.x and
grid_pos.y >= min_grid.y and grid_pos.y <= max_grid.y)
# 获取矩形区域内的所有网格坐标
static func get_grids_in_rect(min_grid: Vector2i, max_grid: Vector2i) -> Array[Vector2i]:
var grids: Array[Vector2i] = []
for x in range(min_grid.x, max_grid.x + 1):
for y in range(min_grid.y, max_grid.y + 1):
grids.append(Vector2i(x, y))
return grids
# ============================================================================
# 地图尺寸规范化
# ============================================================================
# 将像素尺寸规范化为网格尺寸的倍数
static func normalize_size_to_grid(pixel_size: Vector2i) -> Vector2i:
return Vector2i(
int(ceil(float(pixel_size.x) / GRID_SIZE)) * GRID_SIZE,
int(ceil(float(pixel_size.y) / GRID_SIZE)) * GRID_SIZE
)
# 计算指定像素尺寸需要多少个网格单元
static func get_grid_count(pixel_size: Vector2i) -> Vector2i:
return Vector2i(
int(ceil(float(pixel_size.x) / GRID_SIZE)),
int(ceil(float(pixel_size.y) / GRID_SIZE))
)
# ============================================================================
# 调试和可视化辅助
# ============================================================================
# 获取网格的边界矩形(用于调试绘制)
static func get_grid_rect(grid_pos: Vector2i) -> Rect2:
var world_pos = grid_to_world(grid_pos)
return Rect2(world_pos, Vector2(GRID_SIZE, GRID_SIZE))
# 打印网格信息(调试用)
static func print_grid_info(world_pos: Vector2) -> void:
var grid_pos = world_to_grid(world_pos)
var snapped_pos = snap_to_grid(world_pos)
var center_pos = grid_to_world_center(grid_pos)
print("世界坐标: ", world_pos)
print("网格坐标: ", grid_pos)
print("吸附位置: ", snapped_pos)
print("网格中心: ", center_pos)

View File

@@ -0,0 +1 @@
uid://dceqpffgti4jb

2
_Core/utils/.gitkeep Normal file
View File

@@ -0,0 +1,2 @@
# 核心工具类目录
# 存放字符串处理、数学计算等工具类

386
_Core/utils/StringUtils.gd Normal file
View File

@@ -0,0 +1,386 @@
class_name StringUtils
# ============================================================================
# StringUtils.gd - 字符串工具类
# ============================================================================
# 静态工具类,提供常用的字符串处理功能
#
# 核心功能:
# - 输入验证(邮箱、用户名、密码)
# - 字符串格式化和转换
# - 时间格式化和相对时间计算
# - 文件大小格式化
#
# 使用方式:
# var is_valid = StringUtils.is_valid_email("user@example.com")
# var formatted_time = StringUtils.format_utc_to_local_time(utc_string)
#
# 注意事项:
# - 所有方法都是静态的,无需实例化
# - 验证方法返回布尔值或包含详细信息的字典
# - 时间处理方法支持UTC到本地时间的转换
# ============================================================================
# ============ 输入验证方法 ============
# 验证邮箱格式
#
# 参数:
# email: String - 待验证的邮箱地址
#
# 返回值:
# bool - true表示格式正确false表示格式错误
#
# 验证规则:
# - 必须包含@符号
# - @前后都必须有内容
# - 域名部分必须包含至少一个点
# - 顶级域名至少2个字符
#
# 使用示例:
# if StringUtils.is_valid_email("user@example.com"):
# print("邮箱格式正确")
static func is_valid_email(email: String) -> bool:
var regex = RegEx.new()
regex.compile("^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$")
return regex.search(email) != null
# 验证用户名格式
#
# 参数:
# username: String - 待验证的用户名
#
# 返回值:
# bool - true表示格式正确false表示格式错误
#
# 验证规则:
# - 只能包含字母、数字、下划线
# - 长度不能为空且不超过50个字符
# - 不能包含空格或特殊字符
#
# 使用示例:
# if StringUtils.is_valid_username("user_123"):
# print("用户名格式正确")
static func is_valid_username(username: String) -> bool:
# 检查长度
if username.is_empty() or username.length() > 50:
return false
# 检查字符组成
var regex = RegEx.new()
regex.compile("^[a-zA-Z0-9_]+$")
return regex.search(username) != null
# 验证密码强度
#
# 参数:
# password: String - 待验证的密码
#
# 返回值:
# Dictionary - 包含验证结果的详细信息
# {
# "valid": bool, # 是否符合最低要求
# "message": String, # 验证结果消息
# "strength": int # 强度等级 (1-4)
# }
#
# 验证规则:
# - 最少8位最多128位
# - 必须包含字母和数字
# - 强度评级:包含字母(+1)、数字(+1)、特殊字符(+1)、长度>=12(+1)
#
# 使用示例:
# var result = StringUtils.validate_password_strength("MyPass123!")
# if result.valid:
# print("密码强度: ", result.message)
static func validate_password_strength(password: String) -> Dictionary:
var result = {"valid": false, "message": "", "strength": 0}
# 检查长度限制
if password.length() < 8:
result.message = "密码长度至少8位"
return result
if password.length() > 128:
result.message = "密码长度不能超过128位"
return result
# 检查字符类型
var has_letter = false # 是否包含字母
var has_digit = false # 是否包含数字
var has_special = false # 是否包含特殊字符
for i in range(password.length()):
var character = password[i]
if character >= 'a' and character <= 'z' or character >= 'A' and character <= 'Z':
has_letter = true
elif character >= '0' and character <= '9':
has_digit = true
elif character in "!@#$%^&*()_+-=[]{}|;:,.<>?":
has_special = true
# 计算强度等级
var strength = 0
if has_letter:
strength += 1
if has_digit:
strength += 1
if has_special:
strength += 1
if password.length() >= 12:
strength += 1
result.strength = strength
# 检查最低要求
if not (has_letter and has_digit):
result.message = "密码必须包含字母和数字"
return result
# 密码符合要求
result.valid = true
result.message = "密码强度: " + ["", "", "", "很强"][min(strength - 1, 3)]
return result
# ============ 字符串格式化方法 ============
# 截断字符串
#
# 参数:
# text: String - 原始字符串
# max_length: int - 最大长度
# suffix: String - 截断后缀(默认为"..."
#
# 返回值:
# String - 截断后的字符串
#
# 功能:
# - 如果字符串长度超过限制,截断并添加后缀
# - 如果字符串长度未超过限制,返回原字符串
#
# 使用示例:
# var short_text = StringUtils.truncate("这是一个很长的文本", 10, "...")
# # 结果: "这是一个很长..."
static func truncate(text: String, max_length: int, suffix: String = "...") -> String:
if text.length() <= max_length:
return text
return text.substr(0, max_length - suffix.length()) + suffix
# 首字母大写
#
# 参数:
# text: String - 原始字符串
#
# 返回值:
# String - 首字母大写的字符串
#
# 使用示例:
# var capitalized = StringUtils.capitalize_first("hello world")
# # 结果: "Hello world"
static func capitalize_first(text: String) -> String:
if text.is_empty():
return text
return text[0].to_upper() + text.substr(1)
# 转换为标题格式
#
# 参数:
# text: String - 原始字符串
#
# 返回值:
# String - 每个单词首字母大写的字符串
#
# 功能:
# - 将每个单词的首字母转换为大写
# - 其余字母转换为小写
# - 以空格分隔单词
#
# 使用示例:
# var title = StringUtils.to_title_case("hello world game")
# # 结果: "Hello World Game"
static func to_title_case(text: String) -> String:
var words = text.split(" ")
var result = []
for word in words:
if not word.is_empty():
result.append(capitalize_first(word.to_lower()))
return " ".join(result)
# 移除HTML标签
#
# 参数:
# html: String - 包含HTML标签的字符串
#
# 返回值:
# String - 移除HTML标签后的纯文本
#
# 功能:
# - 使用正则表达式移除所有HTML标签
# - 保留标签之间的文本内容
#
# 使用示例:
# var plain_text = StringUtils.strip_html_tags("<p>Hello <b>World</b></p>")
# # 结果: "Hello World"
static func strip_html_tags(html: String) -> String:
var regex = RegEx.new()
regex.compile("<[^>]*>")
return regex.sub(html, "", true)
# 格式化文件大小
#
# 参数:
# bytes: int - 文件大小(字节)
#
# 返回值:
# String - 格式化后的文件大小字符串
#
# 功能:
# - 自动选择合适的单位B, KB, MB, GB, TB
# - 保留一位小数(除了字节)
# - 使用1024作为换算基数
#
# 使用示例:
# var size_text = StringUtils.format_file_size(1536)
# # 结果: "1.5 KB"
static func format_file_size(bytes: int) -> String:
var units = ["B", "KB", "MB", "GB", "TB"]
var size = float(bytes)
var unit_index = 0
# 自动选择合适的单位
while size >= 1024.0 and unit_index < units.size() - 1:
size /= 1024.0
unit_index += 1
# 格式化输出
if unit_index == 0:
return str(int(size)) + " " + units[unit_index]
else:
return "%.1f %s" % [size, units[unit_index]]
# ============ 时间处理方法 ============
# 将UTC时间字符串转换为本地时间显示
#
# 参数:
# utc_time_str: String - UTC时间字符串格式: 2025-12-25T11:23:52.175Z
#
# 返回值:
# String - 格式化的本地时间字符串
#
# 功能:
# - 解析ISO 8601格式的UTC时间
# - 转换为本地时区时间
# - 格式化为易读的中文时间格式
#
# 使用示例:
# var local_time = StringUtils.format_utc_to_local_time("2025-12-25T11:23:52.175Z")
# # 结果: "2025年12月25日 19:23:52" (假设本地时区为UTC+8)
static func format_utc_to_local_time(utc_time_str: String) -> String:
# 解析UTC时间字符串 (格式: 2025-12-25T11:23:52.175Z)
var regex = RegEx.new()
regex.compile("(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2})")
var result = regex.search(utc_time_str)
if result == null:
return utc_time_str # 如果解析失败,返回原字符串
# 提取时间组件
var year = int(result.get_string(1))
var month = int(result.get_string(2))
var day = int(result.get_string(3))
var hour = int(result.get_string(4))
var minute = int(result.get_string(5))
var second = int(result.get_string(6))
# 创建UTC时间字典
var utc_dict = {
"year": year,
"month": month,
"day": day,
"hour": hour,
"minute": minute,
"second": second
}
# 转换为Unix时间戳UTC
var utc_timestamp = Time.get_unix_time_from_datetime_dict(utc_dict)
# 获取本地时间Godot会自动处理时区转换
var local_dict = Time.get_datetime_dict_from_unix_time(utc_timestamp)
# 格式化为易读的本地时间
return "%04d%02d%02d%02d:%02d:%02d" % [
local_dict.year,
local_dict.month,
local_dict.day,
local_dict.hour,
local_dict.minute,
local_dict.second
]
# 获取相对时间描述
#
# 参数:
# utc_time_str: String - UTC时间字符串
#
# 返回值:
# String - 相对时间描述(如"5分钟后"、"2小时30分钟后"
#
# 功能:
# - 计算指定时间与当前时间的差值
# - 返回人性化的相对时间描述
# - 支持秒、分钟、小时的组合显示
#
# 使用示例:
# var relative_time = StringUtils.get_relative_time_until("2025-12-25T12:00:00Z")
# # 结果: "30分钟后" 或 "现在可以重试"
static func get_relative_time_until(utc_time_str: String) -> String:
# 解析UTC时间字符串
var regex = RegEx.new()
regex.compile("(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2})")
var result = regex.search(utc_time_str)
if result == null:
return "时间格式错误"
# 提取时间组件
var year = int(result.get_string(1))
var month = int(result.get_string(2))
var day = int(result.get_string(3))
var hour = int(result.get_string(4))
var minute = int(result.get_string(5))
var second = int(result.get_string(6))
# 创建UTC时间字典
var utc_dict = {
"year": year,
"month": month,
"day": day,
"hour": hour,
"minute": minute,
"second": second
}
# 转换为Unix时间戳
var target_timestamp = Time.get_unix_time_from_datetime_dict(utc_dict)
var current_timestamp = Time.get_unix_time_from_system()
# 计算时间差(秒)
var diff_seconds = target_timestamp - current_timestamp
# 格式化相对时间
if diff_seconds <= 0:
return "现在可以重试"
elif diff_seconds < 60:
return "%d秒后" % diff_seconds
elif diff_seconds < 3600:
var minutes = int(diff_seconds / 60)
return "%d分钟后" % minutes
else:
var hours = int(diff_seconds / 3600)
var minutes = int((diff_seconds % 3600) / 60)
if minutes > 0:
return "%d小时%d分钟后" % [hours, minutes]
else:
return "%d小时后" % hours

View File

@@ -0,0 +1 @@
uid://bu8onmk6q8wic

Binary file not shown.

After

Width:  |  Height:  |  Size: 351 KiB

View File

@@ -2,16 +2,16 @@
importer="texture"
type="CompressedTexture2D"
uid="uid://dt24j6p0cijqo"
path="res://.godot/imported/icon32.png-d677605f61a2a3a87d4018004b1f6aa4.ctex"
uid="uid://b2gci3tcylfiw"
path="res://.godot/imported/curb.png-aea973bea0e48d7135256b05941024a3.ctex"
metadata={
"vram_texture": false
}
[deps]
source_file="res://assets/sprites/icon/icon32.png"
dest_files=["res://.godot/imported/icon32.png-d677605f61a2a3a87d4018004b1f6aa4.ctex"]
source_file="res://assets/sprites/environment/curb.png"
dest_files=["res://.godot/imported/curb.png-aea973bea0e48d7135256b05941024a3.ctex"]
[params]

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.4 MiB

View File

@@ -0,0 +1,40 @@
[remap]
importer="texture"
type="CompressedTexture2D"
uid="uid://djmpsp6t8vbra"
path="res://.godot/imported/download_1767426187137.png-a7252aa9f644c4f3ab14cefb1a59847c.ctex"
metadata={
"vram_texture": false
}
[deps]
source_file="res://assets/sprites/environment/download_1767426187137.png"
dest_files=["res://.godot/imported/download_1767426187137.png-a7252aa9f644c4f3ab14cefb1a59847c.ctex"]
[params]
compress/mode=0
compress/high_quality=false
compress/lossy_quality=0.7
compress/uastc_level=0
compress/rdo_quality_loss=0.0
compress/hdr_compression=1
compress/normal_map=0
compress/channel_pack=0
mipmaps/generate=false
mipmaps/limit=-1
roughness/mode=0
roughness/src_normal=""
process/channel_remap/red=0
process/channel_remap/green=1
process/channel_remap/blue=2
process/channel_remap/alpha=3
process/fix_alpha_border=true
process/premult_alpha=false
process/normal_map_invert_y=false
process/hdr_as_srgb=false
process/hdr_clamp_exposure=false
process/size_limit=0
detect_3d/compress_to=1

Binary file not shown.

After

Width:  |  Height:  |  Size: 137 KiB

View File

@@ -0,0 +1,40 @@
[remap]
importer="texture"
type="CompressedTexture2D"
uid="uid://c3yr7cietnip3"
path="res://.godot/imported/floor_tile.png-922ec9c726f71491a3ebe25e6696192d.ctex"
metadata={
"vram_texture": false
}
[deps]
source_file="res://assets/sprites/environment/floor_tile.png"
dest_files=["res://.godot/imported/floor_tile.png-922ec9c726f71491a3ebe25e6696192d.ctex"]
[params]
compress/mode=0
compress/high_quality=false
compress/lossy_quality=0.7
compress/uastc_level=0
compress/rdo_quality_loss=0.0
compress/hdr_compression=1
compress/normal_map=0
compress/channel_pack=0
mipmaps/generate=false
mipmaps/limit=-1
roughness/mode=0
roughness/src_normal=""
process/channel_remap/red=0
process/channel_remap/green=1
process/channel_remap/blue=2
process/channel_remap/alpha=3
process/fix_alpha_border=true
process/premult_alpha=false
process/normal_map_invert_y=false
process/hdr_as_srgb=false
process/hdr_clamp_exposure=false
process/size_limit=0
detect_3d/compress_to=1

Binary file not shown.

After

Width:  |  Height:  |  Size: 475 KiB

View File

@@ -2,16 +2,16 @@
importer="texture"
type="CompressedTexture2D"
uid="uid://bwy5r7soxi76a"
path="res://.godot/imported/icon144.png-27a33b914815b6d4af200572bfdaa6ff.ctex"
uid="uid://7o0xyqmqbvov"
path="res://.godot/imported/square.png-f3b8edd32d9382a7b98d24fd60e1b771.ctex"
metadata={
"vram_texture": false
}
[deps]
source_file="res://assets/sprites/icon/icon144.png"
dest_files=["res://.godot/imported/icon144.png-27a33b914815b6d4af200572bfdaa6ff.ctex"]
source_file="res://assets/sprites/environment/square.png"
dest_files=["res://.godot/imported/square.png-f3b8edd32d9382a7b98d24fd60e1b771.ctex"]
[params]

Binary file not shown.

After

Width:  |  Height:  |  Size: 523 KiB

View File

@@ -2,16 +2,16 @@
importer="texture"
type="CompressedTexture2D"
uid="uid://drpllpsjdiaex"
path="res://.godot/imported/icon180.png-1d6fc41d452b1d5b5b66c12dbeb9a657.ctex"
uid="uid://dt33hewme0p1k"
path="res://.godot/imported/square1.png-5d845f041b32e4a2880ddc03c7e210e2.ctex"
metadata={
"vram_texture": false
}
[deps]
source_file="res://assets/sprites/icon/icon180.png"
dest_files=["res://.godot/imported/icon180.png-1d6fc41d452b1d5b5b66c12dbeb9a657.ctex"]
source_file="res://assets/sprites/environment/square1.png"
dest_files=["res://.godot/imported/square1.png-5d845f041b32e4a2880ddc03c7e210e2.ctex"]
[params]

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.8 KiB

View File

@@ -0,0 +1,40 @@
[remap]
importer="texture"
type="CompressedTexture2D"
uid="uid://ignbtjvnp5k7"
path="res://.godot/imported/广场瓦片集.png-b224b40553b9f690e690f67a89e2b520.ctex"
metadata={
"vram_texture": false
}
[deps]
source_file="res://assets/sprites/environment/广场瓦片集.png"
dest_files=["res://.godot/imported/广场瓦片集.png-b224b40553b9f690e690f67a89e2b520.ctex"]
[params]
compress/mode=0
compress/high_quality=false
compress/lossy_quality=0.7
compress/uastc_level=0
compress/rdo_quality_loss=0.0
compress/hdr_compression=1
compress/normal_map=0
compress/channel_pack=0
mipmaps/generate=false
mipmaps/limit=-1
roughness/mode=0
roughness/src_normal=""
process/channel_remap/red=0
process/channel_remap/green=1
process/channel_remap/blue=2
process/channel_remap/alpha=3
process/fix_alpha_border=true
process/premult_alpha=false
process/normal_map_invert_y=false
process/hdr_as_srgb=false
process/hdr_clamp_exposure=false
process/size_limit=0
detect_3d/compress_to=1

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.6 KiB

View File

@@ -2,16 +2,16 @@
importer="texture"
type="CompressedTexture2D"
uid="uid://bqg5e8qn1j74u"
path="res://.godot/imported/icon16.png-7cdae0838b274bb32361bfaa80a42a0f.ctex"
uid="uid://dvsb51jintro"
path="res://.godot/imported/草地.png-2fa7f2346d7dc837788dd21e5693cec7.ctex"
metadata={
"vram_texture": false
}
[deps]
source_file="res://assets/sprites/icon/icon16.png"
dest_files=["res://.godot/imported/icon16.png-7cdae0838b274bb32361bfaa80a42a0f.ctex"]
source_file="res://assets/sprites/environment/草地.png"
dest_files=["res://.godot/imported/草地.png-2fa7f2346d7dc837788dd21e5693cec7.ctex"]
[params]

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 644 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.7 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 78 KiB

View File

@@ -1,40 +0,0 @@
[remap]
importer="texture"
type="CompressedTexture2D"
uid="uid://dt817lem3dwee"
path="res://.godot/imported/icon512.png-5f7b6d37423049879d2db9cc5a9126f5.ctex"
metadata={
"vram_texture": false
}
[deps]
source_file="res://assets/sprites/icon/icon512.png"
dest_files=["res://.godot/imported/icon512.png-5f7b6d37423049879d2db9cc5a9126f5.ctex"]
[params]
compress/mode=0
compress/high_quality=false
compress/lossy_quality=0.7
compress/uastc_level=0
compress/rdo_quality_loss=0.0
compress/hdr_compression=1
compress/normal_map=0
compress/channel_pack=0
mipmaps/generate=false
mipmaps/limit=-1
roughness/mode=0
roughness/src_normal=""
process/channel_remap/red=0
process/channel_remap/green=1
process/channel_remap/blue=2
process/channel_remap/alpha=3
process/fix_alpha_border=true
process/premult_alpha=false
process/normal_map_invert_y=false
process/hdr_as_srgb=false
process/hdr_clamp_exposure=false
process/size_limit=0
detect_3d/compress_to=1

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.5 KiB

View File

@@ -1,40 +0,0 @@
[remap]
importer="texture"
type="CompressedTexture2D"
uid="uid://ci42rd5qe6icl"
path="res://.godot/imported/icon64.png-e3684ecc6e07cbb7b0527f9c18c4431a.ctex"
metadata={
"vram_texture": false
}
[deps]
source_file="res://assets/sprites/icon/icon64.png"
dest_files=["res://.godot/imported/icon64.png-e3684ecc6e07cbb7b0527f9c18c4431a.ctex"]
[params]
compress/mode=0
compress/high_quality=false
compress/lossy_quality=0.7
compress/uastc_level=0
compress/rdo_quality_loss=0.0
compress/hdr_compression=1
compress/normal_map=0
compress/channel_pack=0
mipmaps/generate=false
mipmaps/limit=-1
roughness/mode=0
roughness/src_normal=""
process/channel_remap/red=0
process/channel_remap/green=1
process/channel_remap/blue=2
process/channel_remap/alpha=3
process/fix_alpha_border=true
process/premult_alpha=false
process/normal_map_invert_y=false
process/hdr_as_srgb=false
process/hdr_clamp_exposure=false
process/size_limit=0
detect_3d/compress_to=1

Binary file not shown.

Before

Width:  |  Height:  |  Size: 150 KiB

View File

@@ -1,40 +0,0 @@
[remap]
importer="texture"
type="CompressedTexture2D"
uid="uid://cnw6e3wmy0ea4"
path="res://.godot/imported/image(1).png-14ccba2bcca2f261c1c009e0a9e237f6.ctex"
metadata={
"vram_texture": false
}
[deps]
source_file="res://assets/sprites/icon/image(1).png"
dest_files=["res://.godot/imported/image(1).png-14ccba2bcca2f261c1c009e0a9e237f6.ctex"]
[params]
compress/mode=0
compress/high_quality=false
compress/lossy_quality=0.7
compress/uastc_level=0
compress/rdo_quality_loss=0.0
compress/hdr_compression=1
compress/normal_map=0
compress/channel_pack=0
mipmaps/generate=false
mipmaps/limit=-1
roughness/mode=0
roughness/src_normal=""
process/channel_remap/red=0
process/channel_remap/green=1
process/channel_remap/blue=2
process/channel_remap/alpha=3
process/fix_alpha_border=true
process/premult_alpha=false
process/normal_map_invert_y=false
process/hdr_as_srgb=false
process/hdr_clamp_exposure=false
process/size_limit=0
detect_3d/compress_to=1

Binary file not shown.

Before

Width:  |  Height:  |  Size: 91 KiB

View File

@@ -1,40 +0,0 @@
[remap]
importer="texture"
type="CompressedTexture2D"
uid="uid://c7v22i1hgo1x6"
path="res://.godot/imported/image.png-409a48a8fb5774839179f1fee74603d2.ctex"
metadata={
"vram_texture": false
}
[deps]
source_file="res://assets/sprites/icon/image.png"
dest_files=["res://.godot/imported/image.png-409a48a8fb5774839179f1fee74603d2.ctex"]
[params]
compress/mode=0
compress/high_quality=false
compress/lossy_quality=0.7
compress/uastc_level=0
compress/rdo_quality_loss=0.0
compress/hdr_compression=1
compress/normal_map=0
compress/channel_pack=0
mipmaps/generate=false
mipmaps/limit=-1
roughness/mode=0
roughness/src_normal=""
process/channel_remap/red=0
process/channel_remap/green=1
process/channel_remap/blue=2
process/channel_remap/alpha=3
process/fix_alpha_border=true
process/premult_alpha=false
process/normal_map_invert_y=false
process/hdr_as_srgb=false
process/hdr_clamp_exposure=false
process/size_limit=0
detect_3d/compress_to=1

View File

@@ -1 +0,0 @@
# 保持目录结构 - 角色精灵资源目录

View File

@@ -1 +0,0 @@
# 保持目录结构 - 特效精灵资源目录

View File

@@ -1 +0,0 @@
# 保持目录结构 - 环境精灵资源目录

161
claude.md Normal file
View File

@@ -0,0 +1,161 @@
# 🎯 CLAUDE.md - WhaleTown Project Instructions
## 1. Project Vision & Context
- **Project**: "WhaleTown" - A 2D top-down pixel art RPG.
- **Engine**: Godot 4.5+ (Strictly NO Godot 3.x syntax).
- **Architecture**: Strictly layered: `_Core` (Framework), `Scenes` (Gameplay), `UI` (Interface).
- **Core Principle**: "Signal Up, Call Down". High decoupling via `EventSystem`.
## 2. 🛠 Command Reference & Setup
- **Input Map (Required Configuration)**:
- `move_left`, `move_right`, `move_up`, `move_down` (WASD / Arrows)
- `interact` (E Key / Space)
- `pause` (ESC)
- **Run Game**: `godot --path .`
- **Run Tests (GUT)**: `godot --headless -s addons/gut/gut_cmdline.gd -gdir=res://tests/ -ginclude_subdirs`
- **Init Structure**: `mkdir -p _Core/managers _Core/systems Scenes/Maps Scenes/Entities Scenes/Components UI/Windows UI/HUD Assets/Sprites tests/unit tests/integration`
## 3. 📂 File Path Rules (STRICT LOWERCASE)
*Claude: Root folders MUST be lowercase. Scripts and Scenes MUST stay together.*
- **Core Managers**: `_Core/managers/[Name].gd`
- **Core Systems**: `_Core/systems/[Name].gd`
- **Entities**: `Scenes/Entities/[EntityName]/[EntityName].tscn` (Script `.gd` in same folder).
- **Maps**: `Scenes/Maps/[map_name].tscn`
- **Components**: `Scenes/Components/[ComponentName].gd` (Reusable logic nodes).
- **UI Windows**: `UI/Windows/[WindowName].tscn`
- **Tests**: `tests/[unit|integration]/test_[name].gd` (Folder is lowercase `tests`).
## 4. 📋 Coding Standards (The Law)
- **Type Safety**: ALWAYS use strict static typing: `var speed: float = 100.0`, `func _ready() -> void`.
- **Naming Conventions**:
- `class_name PascalCase` at the top of every script.
- Variables/Functions: `camelCase` (e.g., `var moveSpeed`, `func updateMovement()`). Constants: `UPPER_CASE`.
- Private members: Prefix with underscore `_` (e.g., `var _velocity: Vector2`).
- **Node Access**: Use `%UniqueName` for UI and internal scene components.
- **Signals**: Use "Signal Up, Call Down". Parent calls child methods; Child emits signals.
- **Forbidden Patterns**:
- ❌ NO `yield()` -> Use `await`.
- ❌ NO `get_node()` in `_process` -> Cache with `@onready`.
- ❌ NO Linear Filter -> All Sprite2D/TileMap resources MUST use **Nearest** filter.
## 5. 🏛 Architecture & Communication
- **EventSystem**: Use `_Core/systems/EventSystem.gd` for cross-module messaging.
- **Event Registry**: Use `class_name EventNames` in `_Core/EventNames.gd`.
```gdscript
class_name EventNames
const PLAYER_MOVED = "player_moved"
const INTERACT_PRESSED = "interact_pressed"
const NPC_TALKED = "npc_talked"
```
- **Singletons**: Only GameManager, SceneManager, EventSystem allowed as Autoloads.
- **Decoupling**: Low-level entities MUST NOT reference GameManager. Use events.
## 6. 🏗 Implementation Details
- **Player**: CharacterBody2D. Must include Camera2D with `position_smoothing_enabled = true`.
- **NPC/Interactables**: Use Area2D named InteractionArea. Trigger via EventSystem.
- **TileMap Layers**:
- Layer 0: Ground (No collision).
- Layer 1: Obstacles (Physics Layer enabled).
- Layer 2: Decoration (Y-Sort enabled).
- **Camera**: Must auto-calculate limits via `TileMap.get_used_rect()`.
## 7. 🧪 Testing Requirements (MANDATORY)
- **Coverage**: Every Manager/System in `_Core/` MUST have a GUT test.
- **Naming**: Test files must start with `test_` and extend GutTest.
- **Example**:
```gdscript
extends GutTest
func test_event_emission():
var sender = Node.new()
watch_signals(EventSystem)
EventSystem.emit_event(EventNames.PLAYER_MOVED, {})
assert_signal_emitted(EventSystem, "event_raised")
```
## 🔄 8. Standard Development Workflow (MANDATORY)
**CRITICAL**: When performing ANY development task (implementing features, fixing bugs, creating scenes), you MUST follow this 7-step standardized workflow:
### Quick Start: Use the Skill (Recommended) ⭐
```bash
/whaletown-developer [任务描述]
```
Example: `/whaletown-developer 实现玩家二段跳功能`
The skill automates the entire 7-step process and enforces all quality standards.
### The 7-Step Workflow
```
Step 1: Architecture Analysis → Read docs/02-开发规范/架构与通信规范.md
Step 2: Implementation → Follow layered architecture, type safety, EventSystem
Step 3: Comment Validation → Read docs/02-开发规范/代码注释规范.md
Step 4: Naming Validation → Read docs/02-开发规范/命名规范.md
Step 5: Test Writing → Read docs/03-技术实现/测试指南.md
Step 6: Test Execution → Run: godot --headless -s addons/gut/gut_cmdline.gd
Step 7: Git Commit → Read docs/02-开发规范/Git提交规范.md
```
### Workflow Enforcement Rules
1. **Never Skip Steps**: All 7 steps are mandatory for every development task
2. **Read Specs First**: Each step requires reading the corresponding specification document
3. **Use TodoWrite**: Track progress through all 7 steps using TodoWrite tool
4. **Mark Completed**: Mark each step as completed immediately after finishing
5. **Quality Gates**: Cannot proceed to next step until current step passes validation
### Naming Convention Clarification
**IMPORTANT**: The project uses **camelCase** for variables/functions, NOT snake_case:
- ✅ Correct: `var moveSpeed: float`, `func updateMovement()`
- ❌ Incorrect: `var move_speed: float`, `func update_movement()`
See `docs/02-开发规范/命名规范.md` for complete details.
### Quality Checklist (Every Development Task)
- [ ] File location follows layered architecture (_Core, scenes, UI)
- [ ] Uses EventSystem for cross-module communication
- [ ] Event names added to EventNames.gd
- [ ] All variables/functions have type annotations
- [ ] Naming: PascalCase (classes), camelCase (vars/funcs), UPPER_CASE (constants)
- [ ] File header comment complete
- [ ] Public functions have complete documentation
- [ ] Unit tests created and passing
- [ ] Git commit message follows specification
- [ ] No Godot 3.x syntax (await not yield, @onready cached)
### Reference Documents
- **Full Workflow**: `docs/AI_docs/workflows/standard_development_workflow.md`
- **Quick Checklist**: `.claude/skills/whaletown-developer/references/checklist.md`
- **Skill Definition**: `.claude/skills/whaletown-developer/SKILL.md`
**Remember**: Consistency through automation. Use `/whaletown-developer` to ensure no steps are missed.
## 9. 🧘 The Zen of Development
- **Juice or Death**: Every interaction (UI popup, NPC talk) MUST have a Tween placeholder.
- **Zero Magic Numbers**: All speeds/timers MUST be `@export` or defined in `Config/`.
- **Simplicity**: If a function does two things, split it.
- **Back of the Fence**: Hidden logic (like ResponseHandler.gd) must be as clean as the HUD.
## 10. 📝 Code Template (Entity Pattern)
```gdscript
extends CharacterBody2D
class_name Player
# 1. Exports & Constants
@export var move_speed: float = 200.0
# 2. Node References
@onready var sprite: Sprite2D = %Sprite2D
# 3. Lifecycle
func _physics_process(delta: float) -> void:
_move(delta)
# 4. Private Methods
func _move(_delta: float) -> void:
var dir := Input.get_vector("move_left", "move_right", "move_up", "move_down")
velocity = dir * move_speed
move_and_slide()

View File

@@ -0,0 +1,85 @@
# 📖 项目入门
> **适用人群**: 新加入项目的开发者
> **使用时机**: 项目开始前,环境搭建阶段
> **质量等级**: A级 ⭐⭐⭐⭐⭐
这个目录包含了新人入门必读的基础文档,帮助你快速了解项目并搭建开发环境。
## 📋 阅读顺序
### 第一步:了解项目 🏗️
**[项目结构说明.md](项目结构说明.md)**
- 项目整体架构设计
- 目录组织规则和命名规范
- 各层级职责说明
- 核心组件介绍
### 第二步:配置环境 ⚙️
**[项目设置指南.md](项目设置指南.md)**
- Godot编辑器配置
- AutoLoad单例设置
- 输入映射配置(已预配置)
- 开发环境验证
## ✅ 完成检查
阅读完本目录的文档后,你应该能够:
- [ ] 理解项目的整体架构和设计理念
- [ ] 成功配置Godot开发环境
- [ ] 了解核心组件的作用和使用方式
- [ ] 运行项目并进行基本测试
- [ ] 验证所有AutoLoad单例正常工作
- [ ] 确认游戏输入控制正常响应
## 🎮 输入控制说明
项目已预配置以下输入映射:
- **移动控制**: `move_left` (A/←), `move_right` (D/→), `move_up` (W/↑), `move_down` (S/↓)
- **交互控制**: `interact` (E键), `jump` (空格键)
这些输入映射已经在 `project.godot` 中配置完成,无需额外设置。
## 🚨 常见启动问题
### 问题1: 游戏无法响应输入
**原因**: 项目文件损坏或配置丢失
**解决**: 重新克隆项目,确保 `project.godot` 文件完整
### 问题2: 控制台出现"Invalid action"错误
**原因**: 输入映射配置丢失
**解决**: 检查 `project.godot` 文件中的 `[input]` 部分是否完整
### 问题3: AutoLoad单例报错
**原因**: AutoLoad配置不正确或文件路径错误
**解决**: 参考 [项目设置指南.md](项目设置指南.md) 验证配置
### 问题4: EventSystem相关错误
**原因**: 缺少 `_Core/EventNames.gd` 文件
**解决**: 确保项目包含完整的 `_Core` 目录结构
## 🔗 下一步
完成项目入门后,建议继续阅读:
- [02-开发规范](../02-开发规范/) - 学习编码标准和架构规范
- [03-技术实现](../03-技术实现/) - 开始具体功能开发
## 💡 小贴士
- **项目已预配置完成** - 输入映射和核心组件都已设置好
- 遇到问题时,先查看对应文档的"常见问题"部分
- 建议在实际操作中边读边做,加深理解
- 可以将重要的配置信息做笔记备用
- 完成每个步骤后,建议运行项目验证配置是否正确
- 重点关注 `_Core` 目录中的核心组件,它们是项目的基础
## 🛠️ 核心组件预览
项目包含以下核心组件,在后续开发中会频繁使用:
- **EventSystem** - 全局事件通信系统
- **GameManager** - 游戏状态管理
- **SceneManager** - 场景切换管理
- **NetworkManager** - 网络请求管理
- **ProjectPaths** - 统一路径管理
详细使用方法请参考 [架构与通信规范](../02-开发规范/架构与通信规范.md)。

View File

@@ -0,0 +1,157 @@
# 输入映射配置指南
本文档说明了WhaleTown项目的输入映射配置要求和设置方法。
## 🎮 必需的输入映射
### 基础移动控制
- **`move_left`** - 向左移动
- 推荐按键A键、左方向键
- **`move_right`** - 向右移动
- 推荐按键D键、右方向键
- **`move_up`** - 向上移动
- 推荐按键W键、上方向键
- **`move_down`** - 向下移动
- 推荐按键S键、下方向键
### 交互控制
- **`interact`** - 交互动作
- 推荐按键E键、空格键
- **`pause`** - 暂停游戏
- 推荐按键ESC键
## ⚙️ Godot编辑器配置步骤
### 1. 打开输入映射设置
1. 在Godot编辑器中打开 `Project``Project Settings`
2. 切换到 `Input Map` 标签
### 2. 添加输入动作
对于每个必需的输入动作:
1.`Action` 输入框中输入动作名称(如 `move_left`
2. 点击 `Add` 按钮
3. 点击新添加动作右侧的 `+` 按钮
4. 按下对应的按键进行绑定
5. 重复步骤3-4添加备用按键
### 3. 配置示例
```
move_left:
- Key: A
- Key: Left Arrow
move_right:
- Key: D
- Key: Right Arrow
move_up:
- Key: W
- Key: Up Arrow
move_down:
- Key: S
- Key: Down Arrow
interact:
- Key: E
- Key: Space
pause:
- Key: Escape
```
## 🔧 代码中的使用方法
### 移动输入检测
```gdscript
func _physics_process(delta: float) -> void:
# 获取移动向量
var direction := Input.get_vector(
"move_left", "move_right",
"move_up", "move_down"
)
# 应用移动
velocity = direction * move_speed
move_and_slide()
```
### 交互输入检测
```gdscript
func _input(event: InputEvent) -> void:
if event.is_action_pressed("interact"):
_handle_interaction()
if event.is_action_pressed("pause"):
_toggle_pause()
```
### 连续输入检测
```gdscript
func _process(delta: float) -> void:
# 检测持续按下的按键
if Input.is_action_pressed("interact"):
_continuous_interaction(delta)
```
## 📱 手柄支持(可选)
### 推荐手柄映射
- **左摇杆** - 移动控制
- **A按钮/X按钮** - 交互
- **Start按钮** - 暂停
### 配置方法
1. 在Input Map中为每个动作添加手柄输入
2. 使用 `Joypad Button``Joypad Axis` 进行绑定
## ✅ 验证配置
### 测试脚本
创建一个简单的测试脚本验证输入配置:
```gdscript
extends Node
func _ready() -> void:
print("输入映射测试开始...")
_test_input_actions()
func _test_input_actions() -> void:
var required_actions = [
"move_left", "move_right", "move_up", "move_down",
"interact", "pause"
]
for action in required_actions:
if InputMap.has_action(action):
print("", action, " - 已配置")
else:
print("", action, " - 未配置")
func _input(event: InputEvent) -> void:
# 实时显示输入事件
for action in InputMap.get_actions():
if event.is_action_pressed(action):
print("按下: ", action)
```
## 🚨 常见问题
### Q: 输入没有响应怎么办?
A: 检查以下几点:
1. 确认输入动作名称拼写正确
2. 验证按键是否正确绑定
3. 检查代码中是否正确使用了动作名称
### Q: 如何添加自定义输入?
A: 按照相同步骤在Input Map中添加新的动作并在代码中使用对应的动作名称。
### Q: 手柄不工作怎么办?
A: 确保手柄已连接并在Input Map中正确配置了手柄按钮映射。
---
**注意:输入映射配置是游戏正常运行的基础,请确保所有必需的输入动作都已正确配置!**

View File

@@ -0,0 +1,393 @@
# WhaleTown 项目结构说明
本文档详细说明了 WhaleTown 项目的文件结构设计,采用分层架构模式,确保团队协作高效且代码结构清晰。
## 🎯 设计理念
### 核心原则
- **分层架构**:框架层、游戏层、界面层明确分离
- **团队协作**:策划、美术、开发三类角色各司其职
- **高度解耦**:通过事件系统实现组件间通信
- **组件复用**:可复用组件统一管理
- **标准化**:统一的命名规范和目录结构
### 团队协作模式
- **🎮 开发团队** - 主要工作在 `_Core/``scenes/``UI/``Utils/`
- **🎨 美术团队** - 主要工作在 `assets/`
- **📋 策划团队** - 主要工作在 `Config/`
## 🏗️ 项目架构概览
```
WhaleTown/
├── 🔧 _Core/ # [核心层] 功能实现与组件实现,项目最基本的底层实现
├── 🎬 scenes/ # [场景层] 场景与视觉呈现,包含地图、人物等视觉部分
├── 🎨 assets/ # [资源层] 静态资源存储,包括图片、音乐、视频、贴图等
├── ⚙️ Config/ # [配置层] 配置文件管理,用于配置各类环境
├── 🧪 tests/ # [测试层] 测试文件系统,放置所有组件的测试代码
├── 🌐 web_assets/ # [发布层] Web导出资源专门用于Web平台导出
└── 📚 docs/ # [文档层] 项目文档
```
---
## 📁 详细目录结构
### 1. 🔧 核心层 (_Core/)
> **负责团队**: 开发团队
> **职责**: 功能实现与组件实现,项目最基本的底层实现
```
_Core/
├── managers/ # 全局管理器
│ ├── GameManager.gd # 游戏状态管理
│ ├── SceneManager.gd # 场景切换管理
│ ├── NetworkManager.gd # 网络通信管理
│ └── ResponseHandler.gd # API响应处理
├── systems/ # 核心系统
│ └── EventSystem.gd # 全局事件系统
├── components/ # 基础组件实现
│ ├── BaseCharacter.gd # 基础角色组件
│ ├── BaseItem.gd # 基础物品组件
│ └── BaseUI.gd # 基础UI组件
├── utils/ # 🔨 核心工具类
│ ├── StringUtils.gd # 字符串处理工具
│ ├── MathUtils.gd # 数学计算工具
│ └── PixelUtils.gd # 像素风游戏专用工具
├── EventNames.gd # 事件名称定义
└── ProjectPaths.gd # 路径统一管理
```
**特点**:
- 自动加载 (AutoLoad) 单例
- 全局可访问的核心功能
- 与具体游戏逻辑无关的底层实现
- 提供基础服务和组件框架
**使用示例**:
```gdscript
# 游戏状态管理
GameManager.change_state(GameManager.GameState.IN_GAME)
# 场景切换
SceneManager.change_scene("main")
# 事件通信
EventSystem.emit_event("player_moved", {"position": Vector2(100, 200)})
```
### 2. 🎬 场景层 (scenes/)
> **负责团队**: 开发团队
> **职责**: 场景与视觉呈现,包含地图场景、人物场景等一系列视觉呈现的部分
```
scenes/
├── MainScene.tscn # 🎯 主入口场景 - 所有图像显示的入口文件
├── MainScene.gd # 主场景控制器脚本
├── maps/ # 地图场景
│ ├── main_world.tscn # 主世界地图
│ ├── dungeon_01.tscn # 地牢场景
│ └── town_center.tscn # 城镇中心
├── characters/ # 人物场景
│ ├── player/ # 玩家角色
│ │ ├── Player.tscn # 玩家场景
│ │ └── Player.gd # 玩家脚本
│ ├── npcs/ # NPC角色
│ └── enemies/ # 敌人角色
├── ui/ # UI界面场景
│ ├── menus/ # 菜单界面
│ ├── hud/ # 游戏HUD
│ └── dialogs/ # 对话框
├── effects/ # 特效场景
│ ├── particles/ # 粒子效果
│ └── animations/ # 动画效果
└── prefabs/ # 预制体组件
├── items/ # 物品预制体
└── interactive/ # 交互对象预制体
```
**设计原则**:
- **场景内聚**: 脚本紧邻场景文件存放
- **分类明确**: 按功能类型地图、人物、UI、特效分类
- **模块化**: 可复用的预制体统一管理
- **视觉导向**: 主要负责游戏的视觉呈现和UI实现
### 3. 🎨 资源层 (assets/)
> **负责团队**: 美术团队
> **职责**: 所有静态资源的存储,包括图片、音乐、视频、贴图等素材
```
assets/
├── sprites/ # 精灵图片资源
│ ├── characters/ # 角色精灵玩家、NPC、敌人
│ ├── environment/ # 环境精灵(地形、建筑、装饰)
│ ├── items/ # 物品精灵(道具、装备、收集品)
│ ├── effects/ # 特效精灵(爆炸、魔法、粒子)
│ └── ui/ # UI精灵按钮、图标、边框
├── audio/ # 音频资源
│ ├── music/ # 背景音乐BGM
│ ├── sounds/ # 音效SFX
│ └── voice/ # 语音(对话、旁白)
├── fonts/ # 字体文件
│ ├── pixel_fonts/ # 像素风字体
│ └── ui_fonts/ # UI专用字体
├── materials/ # 材质资源
│ ├── pixel_materials/ # 像素风材质
│ └── shader_materials/ # 着色器材质
├── shaders/ # 着色器文件
│ ├── pixel_shaders/ # 像素风着色器
│ └── effect_shaders/ # 特效着色器
├── ui/ # UI专用资源
│ ├── themes/ # UI主题
│ ├── icons/ # 图标资源
│ └── backgrounds/ # 背景图片
└── icon/ # 应用图标
├── icon.svg # 矢量图标
└── icon.png # 位图图标
```
**像素风游戏资源特点**:
- **像素完美**: 所有精灵使用像素完美设置Filter: Off, Mipmaps: Off
- **统一风格**: 保持一致的像素密度和调色板
- **分辨率标准**: 建议使用16x16、32x32等标准像素尺寸
- **动画帧**: 角色动画使用精灵表Sprite Sheet组织
### 4. ⚙️ 配置层 (Config/)
> **负责团队**: 策划团队
> **职责**: 配置文件管理,主要用来配置各类环境
```
Config/
├── game_config.json # 游戏主配置
├── zh_CN.json # 中文本地化
├── environment/ # 环境配置
│ ├── development.json # 开发环境配置
│ ├── testing.json # 测试环境配置
│ └── production.json # 生产环境配置
├── gameplay/ # 游戏玩法配置
│ ├── character_stats.json # 角色属性配置
│ ├── item_database.json # 物品数据库
│ └── level_config.json # 关卡配置
└── localization/ # 本地化配置
├── en_US.json # 英文本地化
├── zh_CN.json # 中文本地化
└── ja_JP.json # 日文本地化
```
**配置文件特点**:
- **环境分离**: 开发、测试、生产环境配置分离
- **数据驱动**: 游戏数值通过配置文件控制
- **本地化支持**: 多语言文本管理
- **热更新**: 支持运行时配置更新
### 5. 🧪 测试层 (tests/)
> **负责团队**: 开发团队
> **职责**: 测试文件系统,放置所有对应组件的测试代码,方便快速进行功能性与性能测试
```
tests/
├── unit/ # 单元测试
│ ├── core/ # 核心组件测试
│ ├── characters/ # 角色组件测试
│ └── systems/ # 系统功能测试
├── integration/ # 集成测试
│ ├── scene_transitions/ # 场景切换测试
│ ├── save_load/ # 存档系统测试
│ └── network/ # 网络功能测试
├── performance/ # 性能测试
│ ├── framerate/ # 帧率测试
│ ├── memory/ # 内存使用测试
│ └── loading_times/ # 加载时间测试
├── api/ # API接口测试
│ ├── auth_tests.py # 认证接口测试
│ └── game_api_tests.py # 游戏API测试
└── ui/ # UI功能测试
├── menu_tests/ # 菜单测试
└── dialog_tests/ # 对话框测试
```
**测试类型说明**:
- **单元测试**: 测试单个组件的功能正确性
- **集成测试**: 测试组件间的交互和协作
- **性能测试**: 监控游戏性能指标,确保流畅运行
- **API测试**: 验证网络接口的正确性和稳定性
- **UI测试**: 测试用户界面的交互和响应
### 6. 🌐 Web导出层 (web_assets/)
> **负责团队**: 自动生成
> **职责**: Web导出资源专门用于Web平台导出的相关资源和配置文件
```
web_assets/
├── html/ # HTML模板文件
│ ├── index.html # Web版本入口页面
│ └── loading.html # 加载页面模板
├── css/ # 样式文件
│ ├── game.css # 游戏样式
│ └── loading.css # 加载样式
├── js/ # JavaScript脚本
│ ├── game_loader.js # 游戏加载器
│ └── utils.js # 工具函数
├── icons/ # Web应用图标
│ ├── favicon.ico # 网站图标
│ └── app_icons/ # PWA应用图标
└── config/ # Web配置文件
├── manifest.json # PWA清单文件
└── service-worker.js # 服务工作者
```
**Web导出特点**:
- **PWA支持**: 支持渐进式Web应用功能
- **响应式设计**: 适配不同屏幕尺寸
- **加载优化**: 优化资源加载和缓存策略
- **跨平台兼容**: 确保在各种浏览器中正常运行
### 7. 📚 文档层 (docs/)
> **负责团队**: 全体团队
> **职责**: 项目文档和开发指南
```
docs/
├── 01-项目入门/ # 新人必读文档
├── 02-开发规范/ # 编码标准文档
├── 03-技术实现/ # 开发指导文档
├── 04-高级开发/ # 进阶技巧文档
├── 05-部署运维/ # 发布部署文档
├── 06-功能模块/ # 功能文档
└── AI_docs/ # 🤖 AI专用文档
├── README.md # AI文档总览
├── architecture_guide.md # 架构执行指南
├── coding_standards.md # 代码风格规范
├── templates/ # 代码模板库
│ ├── components.md # 组件模板集合
│ ├── managers.md # 管理器模板集合
│ └── ui_templates.md # UI模板集合
├── workflows/ # 工作流程指南
│ ├── feature_development.md # 功能开发流程
│ ├── bug_fixing.md # Bug修复流程
│ └── testing_workflow.md # 测试执行流程
└── quick_reference/ # 快速参考手册
├── code_snippets.md # 常用代码片段
├── api_reference.md # API快速参考
└── troubleshooting.md # 故障排除指南
```
**AI_docs特点**:
- **结构化执行**: 每个文档都包含可直接执行的步骤和代码模板
- **标准化规范**: 为AI编程助手提供统一的开发标准和最佳实践
- **模板驱动**: 提供完整的代码模板,确保代码一致性和质量
- **工作流导向**: 包含详细的开发工作流程提升AI协作效率
```
docs/
├── 01-项目入门/ # 新人必读
├── 02-开发规范/ # 编码标准
├── 03-技术实现/ # 开发指导
├── 04-高级开发/ # 进阶技巧
├── 05-部署运维/ # 发布部署
└── 06-功能模块/ # 功能文档
```
---
## 🤝 团队协作指南
### 开发团队 🎮
**主要工作区域**: `_Core/`, `scenes/`, `tests/`
**日常工作流程**:
1.`_Core/` 中开发核心系统、管理器、基础组件和工具类
2.`scenes/` 中创建游戏场景、角色、UI界面和特效
3.`tests/` 中编写各类测试用例确保代码质量
**协作要点**:
- 遵循架构设计原则,使用事件系统进行模块通信
- 保持代码模块化和可复用性
- 将通用工具类放在 `_Core/utils/` 中统一管理
- 针对像素风游戏特点优化性能
- 及时编写测试和文档
### 美术团队 🎨
**主要工作区域**: `assets/`
**日常工作流程**:
1. 按分类整理美术资源到 `assets/` 对应目录
2. 确保像素艺术风格的一致性和像素完美
3. 配置正确的Godot导入设置关闭过滤、禁用Mipmaps
4. 与开发团队协作调整UI和游戏资源
**像素风游戏特殊要求**:
- 严格遵循像素完美原则
- 保持统一的像素密度和调色板
- 使用标准像素尺寸16x16、32x32等
- 精灵动画使用精灵表组织
### 策划团队 📋
**主要工作区域**: `Config/`
**日常工作流程**:
1.`Config/` 中维护游戏配置和数值平衡
2. 管理多环境配置(开发、测试、生产)
3. 负责本地化文本的翻译和维护
4. 设计游戏玩法和关卡数据
**协作要点**:
- 使用JSON格式编写配置文件
- 保持配置文件的结构清晰和可维护性
- 及时更新本地化文本
- 与开发团队协作实现数据驱动的游戏功能
---
## 🔄 开发工作流
### 新功能开发流程
1. **需求分析** - 明确功能需求和设计方案
2. **架构设计** - 确定涉及的模块和接口
3. **资源准备** - 美术团队准备相关资源
4. **配置设置** - 策划团队配置相关数据
5. **代码实现** - 开发团队实现功能逻辑
6. **测试验证** - 编写测试用例验证功能
7. **文档更新** - 更新相关文档说明
### 版本发布流程
1. **功能完成** - 所有计划功能开发完成
2. **测试通过** - 所有测试用例通过
3. **资源整理** - 美术资源整理完成
4. **配置确认** - 策划配置确认无误
5. **构建发布** - 使用 `tools/` 中的脚本构建
6. **部署上线** - 部署到目标环境
---
## 📋 最佳实践
### 目录命名规范
- **文件夹**: 使用 PascalCase (如: `Config/`, `Utils/`)
- **文件**: 使用 snake_case (如: `main_scene.tscn`, `game_config.json`)
- **脚本类**: 使用 PascalCase (如: `GameManager.gd`)
### 资源管理规范
- 所有资源必须放在 `assets/` 对应分类目录下
- 使用描述性的文件名,避免使用数字编号
- **像素艺术资源必须关闭过滤** (Filter: Off, Mipmaps: Off)
- 保持统一的像素密度和调色板
- 使用标准像素尺寸16x16、32x32、64x64等
- 及时清理不使用的资源文件
### 代码组织规范
- 脚本文件与场景文件放在同一目录
- 使用事件系统实现模块间通信,避免直接引用
- 保持单一职责原则,避免过度耦合
- 针对像素风游戏优化性能(避免浮点数位置、使用整数坐标)
- 及时编写注释和文档
### 像素风游戏特殊规范
- **像素完美**: 确保所有精灵在整数坐标上渲染
- **统一风格**: 保持一致的像素密度和艺术风格
- **性能优化**: 使用对象池管理频繁创建销毁的对象
- **分辨率适配**: 使用像素完美的缩放方式适配不同分辨率
---
**记住:良好的项目结构是团队协作成功的基础!**

View File

@@ -0,0 +1,142 @@
# 项目设置指南
本文档指导你完成WhaleTown项目的Godot编辑器配置确保开发环境正确设置。
## 🎯 AutoLoad 配置
项目已经预配置了以下AutoLoad单例你可以验证配置是否正确
### 1. 打开项目设置
1. 在Godot编辑器中打开 `Project``Project Settings`
2. 切换到 `AutoLoad` 标签
### 2. 验证AutoLoad配置
确认以下单例已正确配置:
| 名称 | 路径 | 单例 |
|------|------|------|
| GameManager | `res://_Core/managers/GameManager.gd` | ✅ |
| SceneManager | `res://_Core/managers/SceneManager.gd` | ✅ |
| EventSystem | `res://_Core/systems/EventSystem.gd` | ✅ |
| NetworkManager | `res://_Core/managers/NetworkManager.gd` | ✅ |
| ResponseHandler | `res://_Core/managers/ResponseHandler.gd` | ✅ |
### 3. 如果需要手动添加AutoLoad
如果某个AutoLoad缺失可以手动添加
1. 点击 `Add` 按钮
2. 设置以下信息:
- **Path**: 对应的脚本路径
- **Name**: 单例名称
- **Singleton**: ✅ 勾选
3. 点击 `Add` 确认
## ⚙️ 其他重要设置
### 主题配置
项目使用自定义中文主题:
- **路径**: `assets/ui/chinese_theme.tres`
- **字体**: 微软雅黑 (`assets/fonts/msyh.ttc`)
### 主场景设置
- **主场景**: `res://Scenes/Maps/main_scene.tscn`
- **窗口大小**: 1376x768
- **窗口模式**: 全屏模式
### 渲染设置
- **渲染器**: GL Compatibility (兼容性优先)
- **拉伸模式**: Canvas Items
- **拉伸比例**: Expand
## 🧪 验证设置
### 1. 测试AutoLoad单例
在任何脚本中可以直接使用:
```gdscript
func _ready():
# 测试GameManager
print("游戏状态: ", GameManager.get_current_state())
# 测试SceneManager
print("当前场景: ", SceneManager.get_current_scene_name())
# 测试EventSystem
EventSystem.emit_event("test_event", {"message": "Hello World"})
# 测试NetworkManager
var request_id = NetworkManager.login("test_user", "test_password")
print("网络请求ID: ", request_id)
```
### 2. 检查控制台输出
运行项目后,检查控制台是否有以下信息:
- ✅ 没有AutoLoad相关错误
- ✅ 各个管理器初始化成功
- ✅ 主题和字体加载正常
### 3. 测试场景切换
```gdscript
# 测试场景管理器
func test_scene_manager():
# 切换到主场景
SceneManager.change_scene("main")
```
## 🔧 常见问题排查
### 问题1: AutoLoad脚本找不到
**症状**: 控制台显示"Cannot load script"错误
**解决方案**:
1. 检查脚本文件是否存在于指定路径
2. 确认脚本文件没有语法错误
3. 重新导入项目 (`Project``Reload Current Project`)
### 问题2: 单例无法访问
**症状**: 代码中无法访问GameManager等单例
**解决方案**:
1. 确认AutoLoad配置中勾选了"Singleton"
2. 重启Godot编辑器
3. 检查脚本中是否有拼写错误
### 问题3: 主题显示异常
**症状**: 界面字体或样式显示不正确
**解决方案**:
1. 检查 `assets/ui/chinese_theme.tres` 文件是否存在
2. 确认字体文件 `assets/fonts/msyh.ttc` 已正确导入
3. 在项目设置中重新设置自定义主题
### 问题4: 网络请求失败
**症状**: NetworkManager调用失败
**解决方案**:
1. 检查网络连接
2. 确认API地址配置正确
3. 查看ResponseHandler是否正常工作
## 📋 配置检查清单
完成设置后,请检查以下项目:
- [ ] 所有AutoLoad单例配置正确
- [ ] 主场景可以正常启动
- [ ] 控制台没有错误信息
- [ ] 自定义主题加载正常
- [ ] 中文字体显示正确
- [ ] 网络管理器可以正常调用
- [ ] 事件系统工作正常
- [ ] 场景管理器可以切换场景
## 🚀 下一步
配置完成后,建议继续阅读:
- [输入映射配置](输入映射配置.md) - 设置游戏控制
- [命名规范](../02-开发规范/命名规范.md) - 学习编码规范
- [架构与通信规范](../02-开发规范/架构与通信规范.md) - 理解项目架构
---
**💡 提示**: 如果遇到问题,可以参考 [测试指南](../03-技术实现/测试指南.md) 进行更详细的功能验证。

View File

@@ -0,0 +1,105 @@
# 📋 开发规范
> **适用人群**: 所有开发者
> **使用时机**: 编码过程中,代码审查时
这个目录包含了项目的所有编码标准和开发规范,确保团队代码风格一致,架构设计统一。
## 📚 规范文档
### 基础规范 📝
**[命名规范.md](命名规范.md)**
- 文件、类、变量、函数命名标准
- 资源文件命名规则
- 目录结构命名约定
**[代码注释规范.md](代码注释规范.md)**
- 注释格式和标准
- 文档生成规范
- AI辅助开发指南
**[Git提交规范.md](Git提交规范.md)**
- 提交信息格式标准
- 分支管理策略
- 代码审查流程
### 架构规范 🏗️
**[架构与通信规范.md](架构与通信规范.md)**
- 分层架构设计原则
- EventSystem事件系统使用
- 组件间通信标准
- 单例管理规范
### 质量标准 ⭐
**[开发哲学与最佳实践.md](开发哲学与最佳实践.md)**
- 项目开发理念
- 代码质量标准
- 最佳实践指导
- 代码审查清单
## 🎯 使用指南
### 新人学习路径
1. **命名规范** - 学会正确命名
2. **架构与通信规范** - 理解项目架构
3. **开发哲学与最佳实践** - 掌握质量标准
4. **代码注释规范** - 学会写好注释
5. **Git提交规范** - 规范版本控制
### 日常开发参考
- 编码时参考 **命名规范****架构规范**
- 提交代码前检查 **最佳实践** 清单
- 写注释时遵循 **注释规范**
- 提交时遵循 **Git规范**
### 代码审查要点
- [ ] 命名是否符合规范
- [ ] 架构设计是否合理
- [ ] 代码质量是否达标
- [ ] 注释是否完整清晰
- [ ] 提交信息是否规范
## ⚠️ 重要提醒
### 强制性规范
以下规范是**强制性**的,必须严格遵守:
- 文件和目录命名规范
- EventSystem通信规范
- 类型安全要求
- Git提交格式
### 建议性规范
以下规范是**建议性**的,推荐遵循:
- 代码注释的详细程度
- 函数长度和复杂度
- 性能优化建议
## 🔄 规范更新
### 更新原则
- 规范变更需要团队讨论
- 重大变更需要文档化说明
- 保持向后兼容性
### 更新流程
1. 提出规范变更建议
2. 团队讨论和评审
3. 更新相关文档
4. 通知所有开发者
## 🤝 团队协作
### 规范执行
- 代码审查时严格检查规范遵循情况
- 定期进行规范培训和分享
- 鼓励团队成员提出改进建议
### 问题反馈
如果发现规范问题或有改进建议:
- 创建Issue讨论
- 在团队会议中提出
- 通过PR提交改进方案
---
**记住:规范不是束缚,而是团队协作的基础!**

View File

@@ -0,0 +1,406 @@
# 开发哲学与最佳实践
本文档阐述了WhaleTown项目的开发哲学和编程最佳实践旨在指导团队创造高质量、可维护的代码。
## 🧘 开发哲学
### 核心理念
- **用户体验至上** - 每个功能都要考虑用户感受
- **代码即文档** - 代码应该自解释,清晰易懂
- **简洁胜于复杂** - 优先选择简单直接的解决方案
- **质量重于速度** - 宁可慢一点,也要做对
### 设计原则
#### 1. 流畅体验 (Juice or Death)
每个用户交互都必须有视觉反馈和动画效果:
```gdscript
# ✅ 正确为UI交互添加动画
func show_dialog() -> void:
dialog.modulate.a = 0.0
dialog.scale = Vector2(0.8, 0.8)
dialog.visible = true
var tween = create_tween()
tween.parallel().tween_property(dialog, "modulate:a", 1.0, 0.3)
tween.parallel().tween_property(dialog, "scale", Vector2.ONE, 0.3)
tween.set_ease(Tween.EASE_OUT)
tween.set_trans(Tween.TRANS_BACK)
# ❌ 错误:没有动画的生硬切换
func show_dialog() -> void:
dialog.visible = true # 突然出现,体验差
```
#### 2. 零魔法数字 (Zero Magic Numbers)
所有数值都应该有明确的含义和来源:
```gdscript
# ✅ 正确:使用导出变量或配置文件
@export var move_speed: float = 200.0
@export var jump_height: float = 400.0
@export var health_max: int = 100
# 或从配置文件加载
const CONFIG_PATH = "res://data/player_config.json"
var config_data: Dictionary
func _ready() -> void:
config_data = load_config(CONFIG_PATH)
move_speed = config_data.get("move_speed", 200.0)
# ❌ 错误:硬编码的魔法数字
func _physics_process(delta: float) -> void:
velocity.x = input_direction.x * 200 # 200是什么
if position.y > 1000: # 1000代表什么
respawn()
```
#### 3. 函数单一职责
每个函数只做一件事,做好一件事:
```gdscript
# ✅ 正确:职责分离
func handle_player_input() -> void:
var input_direction = get_input_direction()
apply_movement(input_direction)
check_interaction_input()
func get_input_direction() -> Vector2:
return Input.get_vector("move_left", "move_right", "move_up", "move_down")
func apply_movement(direction: Vector2) -> void:
velocity = direction * move_speed
move_and_slide()
func check_interaction_input() -> void:
if Input.is_action_just_pressed("interact"):
try_interact()
# ❌ 错误:一个函数做太多事
func handle_everything() -> void:
# 处理输入
var direction = Input.get_vector("move_left", "move_right", "move_up", "move_down")
# 处理移动
velocity = direction * move_speed
move_and_slide()
# 处理交互
if Input.is_action_just_pressed("interact"):
# 检查交互对象
var interactables = get_nearby_interactables()
# 执行交互
for obj in interactables:
obj.interact()
# 更新UI
update_health_bar()
# 播放音效
play_footstep_sound()
```
#### 4. 隐藏复杂性
复杂的逻辑应该被封装,对外提供简洁的接口:
```gdscript
# ✅ 正确:封装复杂逻辑
class_name NetworkManager
func login(username: String, password: String, callback: Callable) -> int:
return _make_request("POST", "/auth/login", {
"username": username,
"password": password
}, callback)
func _make_request(method: String, endpoint: String, data: Dictionary, callback: Callable) -> int:
# 复杂的网络请求逻辑被隐藏
var request = HTTPRequest.new()
var request_id = _generate_request_id()
# 设置请求头、处理认证、错误重试等复杂逻辑
_setup_request_headers(request)
_handle_authentication(request)
_setup_retry_logic(request, callback)
return request_id
# 使用时非常简洁
func _on_login_button_pressed() -> void:
NetworkManager.login(username_input.text, password_input.text, _on_login_response)
```
## 📋 编码最佳实践
### 1. 类型安全
始终使用严格的类型声明:
```gdscript
# ✅ 正确:明确的类型声明
var player_health: int = 100
var move_speed: float = 200.0
var player_name: String = "Player"
var inventory_items: Array[Item] = []
var config_data: Dictionary = {}
func calculate_damage(base_damage: int, multiplier: float) -> int:
return int(base_damage * multiplier)
# ❌ 错误:缺少类型信息
var health = 100 # 类型不明确
var speed = 200 # 可能是int也可能是float
func calculate_damage(base, mult): # 参数类型不明确
return base * mult # 返回类型不明确
```
### 2. 错误处理
主动处理可能的错误情况:
```gdscript
# ✅ 正确:完善的错误处理
func load_save_file(file_path: String) -> Dictionary:
if not FileAccess.file_exists(file_path):
push_warning("存档文件不存在: " + file_path)
return {}
var file = FileAccess.open(file_path, FileAccess.READ)
if file == null:
push_error("无法打开存档文件: " + file_path)
return {}
var json_string = file.get_as_text()
file.close()
if json_string.is_empty():
push_warning("存档文件为空: " + file_path)
return {}
var json = JSON.new()
var parse_result = json.parse(json_string)
if parse_result != OK:
push_error("存档文件JSON格式错误: " + file_path)
return {}
return json.data
# ❌ 错误:没有错误处理
func load_save_file(file_path: String) -> Dictionary:
var file = FileAccess.open(file_path, FileAccess.READ)
var json_string = file.get_as_text()
file.close()
var json = JSON.new()
json.parse(json_string)
return json.data # 任何步骤出错都会崩溃
```
### 3. 资源管理
及时释放不需要的资源:
```gdscript
# ✅ 正确:资源管理
class_name AudioManager
var audio_players: Array[AudioStreamPlayer] = []
var max_concurrent_sounds: int = 10
func play_sound(sound: AudioStream, volume: float = 0.0) -> void:
# 清理已完成的音频播放器
_cleanup_finished_players()
# 限制并发音频数量
if audio_players.size() >= max_concurrent_sounds:
_stop_oldest_player()
var player = AudioStreamPlayer.new()
add_child(player)
player.stream = sound
player.volume_db = volume
player.finished.connect(_on_audio_finished.bind(player))
player.play()
audio_players.append(player)
func _cleanup_finished_players() -> void:
audio_players = audio_players.filter(func(player): return player.playing)
func _on_audio_finished(player: AudioStreamPlayer) -> void:
audio_players.erase(player)
player.queue_free()
```
### 4. 性能优化
编写高效的代码:
```gdscript
# ✅ 正确:性能优化的代码
class_name EnemyManager
var enemies: Array[Enemy] = []
var update_timer: float = 0.0
const UPDATE_INTERVAL: float = 0.1 # 每100ms更新一次
func _process(delta: float) -> void:
update_timer += delta
if update_timer >= UPDATE_INTERVAL:
_update_enemies(update_timer)
update_timer = 0.0
func _update_enemies(delta_time: float) -> void:
# 只更新屏幕附近的敌人
var camera_pos = get_viewport().get_camera_2d().global_position
var screen_size = get_viewport().get_visible_rect().size
for enemy in enemies:
if _is_enemy_near_screen(enemy, camera_pos, screen_size):
enemy.update_ai(delta_time)
func _is_enemy_near_screen(enemy: Enemy, camera_pos: Vector2, screen_size: Vector2) -> bool:
var distance = enemy.global_position.distance_to(camera_pos)
var max_distance = screen_size.length() * 0.6 # 屏幕对角线的60%
return distance <= max_distance
# ❌ 错误:性能问题
func _process(delta: float) -> void:
# 每帧更新所有敌人,无论是否可见
for enemy in enemies:
enemy.update_ai(delta) # 可能有数百个敌人
# 每帧进行复杂计算
var path = enemy.find_path_to_player()
enemy.follow_path(path)
```
## 🎯 代码审查标准
### 审查清单
在提交代码前,请检查以下项目:
#### 功能性
- [ ] 代码实现了预期功能
- [ ] 处理了边界情况和错误情况
- [ ] 添加了必要的测试用例
#### 可读性
- [ ] 变量和函数名称清晰明确
- [ ] 代码结构逻辑清晰
- [ ] 添加了必要的注释
#### 性能
- [ ] 避免了不必要的计算
- [ ] 正确管理了资源生命周期
- [ ] 使用了合适的数据结构
#### 规范性
- [ ] 遵循了项目命名规范
- [ ] 使用了正确的类型声明
- [ ] 符合架构设计原则
### 代码示例评分
#### 优秀代码示例 (A级)
```gdscript
extends CharacterBody2D
class_name Player
## 玩家角色控制器
##
## 负责处理玩家输入、移动和基础交互
## 使用事件系统与其他组件通信
@export_group("Movement")
@export var move_speed: float = 200.0
@export var acceleration: float = 1000.0
@export var friction: float = 800.0
@export_group("Interaction")
@export var interaction_range: float = 50.0
@onready var sprite: Sprite2D = %Sprite2D
@onready var animation_player: AnimationPlayer = %AnimationPlayer
@onready var interaction_area: Area2D = %InteractionArea
var _current_interactable: Interactable = null
func _ready() -> void:
_setup_interaction_area()
_connect_signals()
func _physics_process(delta: float) -> void:
_handle_movement(delta)
func _input(event: InputEvent) -> void:
if event.is_action_pressed("interact"):
_try_interact()
func _handle_movement(delta: float) -> void:
var input_direction := _get_movement_input()
_apply_movement(input_direction, delta)
_update_animation(input_direction)
func _get_movement_input() -> Vector2:
return Input.get_vector("move_left", "move_right", "move_up", "move_down")
func _apply_movement(direction: Vector2, delta: float) -> void:
if direction != Vector2.ZERO:
velocity = velocity.move_toward(direction * move_speed, acceleration * delta)
else:
velocity = velocity.move_toward(Vector2.ZERO, friction * delta)
move_and_slide()
func _update_animation(direction: Vector2) -> void:
if direction.length() > 0.1:
animation_player.play("walk")
sprite.flip_h = direction.x < 0
else:
animation_player.play("idle")
```
#### 需要改进的代码 (C级)
```gdscript
extends CharacterBody2D
var speed = 200
var player
var enemies = []
func _ready():
player = self
func _process(delta):
var dir = Vector2()
if Input.is_action_pressed("ui_left"):
dir.x -= 1
if Input.is_action_pressed("ui_right"):
dir.x += 1
if Input.is_action_pressed("ui_up"):
dir.y -= 1
if Input.is_action_pressed("ui_down"):
dir.y += 1
velocity = dir * speed
move_and_slide()
for enemy in enemies:
if position.distance_to(enemy.position) < 100:
print("near enemy")
```
## 🚀 持续改进
### 重构指导原则
1. **小步快跑** - 每次只重构一小部分
2. **测试保护** - 重构前确保有测试覆盖
3. **功能不变** - 重构不改变外部行为
4. **逐步优化** - 持续改进代码质量
### 技术债务管理
```gdscript
# 使用TODO注释标记技术债务
# TODO: 重构这个函数,职责过多
# FIXME: 这里有性能问题,需要优化
# HACK: 临时解决方案,需要找到更好的方法
# NOTE: 这里的逻辑比较复杂,需要详细注释
```
---
**记住:优秀的代码不仅能工作,更要易于理解、维护和扩展。追求代码质量是每个开发者的责任!**

View File

@@ -0,0 +1,280 @@
# 架构与通信规范
本文档定义了WhaleTown项目的架构设计原则和组件间通信规范。
## 🏛️ 架构设计原则
### 核心原则
- **"信号向上,调用向下"** - 父节点调用子节点方法,子节点发出信号通知父节点
- **高度解耦** - 通过事件系统实现组件间通信,避免直接依赖
- **分层架构** - 严格的三层架构:框架层、游戏层、界面层
- **单一职责** - 每个组件只负责一个明确的功能
### 分层架构详解
```
┌─────────────────────────────────────┐
│ UI Layer (界面层) │
│ UI/Windows/, UI/HUD/ │
├─────────────────────────────────────┤
│ Scenes Layer (游戏层) │
│ Scenes/Maps/, Scenes/Entities/ │
├─────────────────────────────────────┤
│ _Core Layer (框架层) │
│ _Core/managers/, _Core/systems/ │
└─────────────────────────────────────┘
```
## 🔄 事件系统 (EventSystem)
### 事件系统位置
- **文件路径**: `_Core/systems/EventSystem.gd`
- **自动加载**: 必须设置为AutoLoad单例
- **作用**: 全局事件总线,实现跨模块通信
### 事件命名规范
所有事件名称必须在 `_Core/EventNames.gd` 中定义:
```gdscript
# _Core/EventNames.gd
class_name EventNames
# 玩家相关事件
const PLAYER_MOVED = "player_moved"
const PLAYER_HEALTH_CHANGED = "player_health_changed"
const PLAYER_DIED = "player_died"
# 交互事件
const INTERACT_PRESSED = "interact_pressed"
const NPC_TALKED = "npc_talked"
const ITEM_COLLECTED = "item_collected"
# UI事件
const UI_BUTTON_CLICKED = "ui_button_clicked"
const DIALOG_OPENED = "dialog_opened"
const DIALOG_CLOSED = "dialog_closed"
# 游戏状态事件
const GAME_PAUSED = "game_paused"
const GAME_RESUMED = "game_resumed"
const SCENE_CHANGED = "scene_changed"
```
### 事件使用方法
#### 发送事件
```gdscript
# 发送简单事件
EventSystem.emit_event(EventNames.PLAYER_MOVED)
# 发送带数据的事件
EventSystem.emit_event(EventNames.PLAYER_HEALTH_CHANGED, {
"old_health": 80,
"new_health": 60,
"damage": 20
})
```
#### 监听事件
```gdscript
func _ready() -> void:
# 连接事件监听
EventSystem.connect_event(EventNames.PLAYER_DIED, _on_player_died)
EventSystem.connect_event(EventNames.ITEM_COLLECTED, _on_item_collected)
func _on_player_died(data: Dictionary = {}) -> void:
print("玩家死亡,游戏结束")
# 处理玩家死亡逻辑
func _on_item_collected(data: Dictionary) -> void:
var item_name = data.get("item_name", "未知物品")
print("收集到物品: ", item_name)
```
#### 断开事件监听
```gdscript
func _exit_tree() -> void:
# 节点销毁时断开事件监听
EventSystem.disconnect_event(EventNames.PLAYER_DIED, _on_player_died)
EventSystem.disconnect_event(EventNames.ITEM_COLLECTED, _on_item_collected)
```
## 🎯 单例管理器
### 允许的自动加载单例
项目中允许以下五个核心单例:
1. **GameManager** - 游戏状态管理
- 路径: `_Core/managers/GameManager.gd`
- 职责: 游戏状态、场景数据、全局配置
2. **SceneManager** - 场景管理
- 路径: `_Core/managers/SceneManager.gd`
- 职责: 场景切换、场景生命周期
3. **EventSystem** - 事件系统
- 路径: `_Core/systems/EventSystem.gd`
- 职责: 全局事件通信
4. **NetworkManager** - 网络管理
- 路径: `_Core/managers/NetworkManager.gd`
- 职责: HTTP请求、API调用、网络状态管理
5. **ResponseHandler** - 响应处理
- 路径: `_Core/managers/ResponseHandler.gd`
- 职责: 统一响应处理、错误处理、用户反馈
### 单例使用规范
```gdscript
# ✅ 正确:高层组件可以访问单例
func _ready() -> void:
var current_scene = SceneManager.get_current_scene()
var game_state = GameManager.get_game_state()
# ❌ 错误底层实体不应直接访问GameManager
# 在Player.gd或NPC.gd中避免这样做
func _ready() -> void:
GameManager.register_player(self) # 不推荐
# ✅ 正确:使用事件系统
func _ready() -> void:
EventSystem.emit_event(EventNames.PLAYER_SPAWNED, {"player": self})
```
## 🔗 组件通信模式
### 1. 父子通信
```gdscript
# 父节点调用子节点方法(向下调用)
func _on_button_pressed() -> void:
child_component.activate()
child_component.set_data(some_data)
# 子节点发出信号通知父节点(向上信号)
# 在子节点中:
signal component_activated(data: Dictionary)
signal component_finished()
func _some_action() -> void:
component_activated.emit({"status": "active"})
```
### 2. 兄弟组件通信
```gdscript
# 通过共同的父节点中转
# 或使用事件系统
func _notify_sibling() -> void:
EventSystem.emit_event(EventNames.COMPONENT_MESSAGE, {
"sender": self,
"message": "Hello sibling!"
})
```
### 3. 跨场景通信
```gdscript
# 使用事件系统进行跨场景通信
func _change_scene_with_data() -> void:
EventSystem.emit_event(EventNames.SCENE_DATA_TRANSFER, {
"target_scene": "battle_scene",
"player_data": player_data
})
```
## 🚫 禁止的通信模式
### 1. 直接节点引用
```gdscript
# ❌ 错误:直接获取其他场景的节点
func _bad_communication() -> void:
var other_scene = get_tree().get_first_node_in_group("other_scene")
other_scene.do_something() # 强耦合,难以维护
```
### 2. 全局变量传递
```gdscript
# ❌ 错误:使用全局变量传递状态
# 在autoload中
var global_player_data = {} # 避免这种做法
```
### 3. 循环依赖
```gdscript
# ❌ 错误A依赖BB又依赖A
# ComponentA.gd
var component_b: ComponentB
# ComponentB.gd
var component_a: ComponentA # 循环依赖
```
## 📋 通信最佳实践
### 1. 事件数据结构
```gdscript
# 使用结构化的事件数据
EventSystem.emit_event(EventNames.PLAYER_ATTACK, {
"attacker": self,
"target": target_enemy,
"damage": damage_amount,
"attack_type": "melee",
"timestamp": Time.get_time_dict_from_system()
})
```
### 2. 错误处理
```gdscript
func _on_event_received(data: Dictionary) -> void:
# 验证数据完整性
if not data.has("required_field"):
push_error("事件数据缺少必需字段: required_field")
return
# 安全地获取数据
var value = data.get("optional_field", default_value)
```
### 3. 性能考虑
```gdscript
# 避免在_process中频繁发送事件
var last_position: Vector2
func _process(delta: float) -> void:
if global_position.distance_to(last_position) > 10.0:
EventSystem.emit_event(EventNames.PLAYER_MOVED, {
"position": global_position
})
last_position = global_position
```
## 🧪 测试通信系统
### 单元测试示例
```gdscript
extends GutTest
func test_event_emission():
# 监听事件
watch_signals(EventSystem)
# 发送事件
EventSystem.emit_event(EventNames.PLAYER_MOVED, {"x": 100, "y": 200})
# 验证事件发送
assert_signal_emitted(EventSystem, "event_raised")
func test_event_data():
var received_data: Dictionary
# 连接事件监听
EventSystem.connect_event(EventNames.TEST_EVENT, func(data): received_data = data)
# 发送测试数据
var test_data = {"test": "value"}
EventSystem.emit_event(EventNames.TEST_EVENT, test_data)
# 验证数据传递
assert_eq(received_data, test_data)
```
---
**记住:良好的架构设计是项目成功的基石!遵循这些通信规范可以确保代码的可维护性和扩展性。**

View File

@@ -0,0 +1,120 @@
# 🔧 技术实现
> **适用人群**: 正在开发功能的程序员
> **使用时机**: 具体功能开发时
这个目录包含了具体的技术实现指导,帮助开发者快速实现各种游戏功能和系统集成。
## 📋 实现指南
### 核心实现 🎮
**[实现细节规范.md](实现细节规范.md)**
- 玩家角色实现标准
- NPC交互系统实现
- TileMap图层配置规范
- 交互物品实现模板
- 性能优化要求
### 网络集成 🌐
**[API接口文档.md](API接口文档.md)**
- 完整的后端API接口说明
- 请求格式和响应格式
- 错误码和处理方式
- 认证和权限管理
**[网络管理器设置.md](网络管理器设置.md)**
- NetworkManager配置方法
- 网络请求封装使用
- 错误处理机制
- 响应数据处理
### 质量保证 🧪
**[测试指南.md](测试指南.md)**
- API接口测试方法
- Python测试脚本使用
- Godot内置测试
- 测试用例编写
## 🎯 开发流程
### 功能开发标准流程
1. **需求分析** - 明确功能需求和技术方案
2. **架构设计** - 参考实现细节规范设计架构
3. **编码实现** - 按照规范编写代码
4. **接口集成** - 使用API文档进行后端集成
5. **功能测试** - 使用测试指南验证功能
6. **代码审查** - 检查规范遵循情况
### 常见开发场景
#### 🎮 实现新的游戏角色
1. 阅读 [实现细节规范.md](实现细节规范.md) 中的角色实现部分
2. 使用提供的代码模板创建角色
3. 配置相机和交互系统
4. 测试移动和交互功能
#### 🌐 集成新的API接口
1. 查看 [API接口文档.md](API接口文档.md) 了解接口规范
2. 使用 [网络管理器设置.md](网络管理器设置.md) 配置网络请求
3. 实现数据处理和错误处理
4. 使用 [测试指南.md](测试指南.md) 验证接口功能
#### 🗺️ 创建新的游戏场景
1. 参考 [实现细节规范.md](实现细节规范.md) 中的TileMap配置
2. 设置正确的图层结构和碰撞检测
3. 配置相机边界和Y排序
4. 添加交互物品和NPC
## 🔍 问题排查
### 常见问题类型
#### 网络相关问题
- **API调用失败** → 检查 [API接口文档.md](API接口文档.md) 中的接口格式
- **网络超时** → 参考 [网络管理器设置.md](网络管理器设置.md) 的超时配置
- **数据解析错误** → 查看响应格式和错误处理
#### 游戏对象问题
- **角色移动异常** → 检查 [实现细节规范.md](实现细节规范.md) 中的移动实现
- **交互不响应** → 验证InteractionArea配置和事件系统
- **相机边界错误** → 检查TileMap边界计算
#### 性能问题
- **帧率下降** → 参考性能优化要求
- **内存泄漏** → 检查资源管理和对象生命周期
### 调试技巧
1. **使用Godot调试器** - 设置断点调试代码逻辑
2. **查看控制台输出** - 关注错误和警告信息
3. **使用测试脚本** - 编写简单测试验证功能
4. **性能分析** - 使用Godot的性能分析工具
## 📚 参考资源
### 内部资源
- [02-开发规范](../02-开发规范/) - 编码规范和架构设计
- [04-高级开发](../04-高级开发/) - 进阶开发技巧
- [06-功能模块](../06-功能模块/) - 特定功能实现
### 外部资源
- [Godot官方文档](https://docs.godotengine.org/)
- [GDScript语言参考](https://docs.godotengine.org/en/stable/tutorials/scripting/gdscript/)
- [Godot最佳实践](https://docs.godotengine.org/en/stable/tutorials/best_practices/)
## 💡 开发建议
### 效率提升
- 使用代码模板快速创建标准结构
- 善用Godot的场景实例化功能
- 合理使用@export变量进行配置
- 充分利用事件系统解耦组件
### 质量保证
- 每个功能都要编写对应测试
- 定期进行代码审查
- 关注性能指标和内存使用
- 保持代码简洁和可读性
---
**记住:好的实现不仅要功能正确,更要易于维护和扩展!**

View File

@@ -0,0 +1,388 @@
# 实现细节规范
本文档详细说明了WhaleTown项目中各种游戏对象的具体实现要求和技术细节。
## 🎮 玩家实现规范
### 基础要求
- **节点类型**: 必须使用 `CharacterBody2D`
- **移动系统**: 使用 `move_and_slide()` 方法
- **相机集成**: 必须包含 `Camera2D` 子节点
### 玩家节点结构
```
Player (CharacterBody2D)
├── Sprite2D # 玩家精灵
├── CollisionShape2D # 碰撞形状
├── Camera2D # 玩家相机
│ └── [相机配置]
├── InteractionArea (Area2D) # 交互检测区域
│ └── CollisionShape2D
└── AnimationPlayer # 动画播放器
```
### 相机配置要求
```gdscript
# Player.gd 中的相机设置
@onready var camera: Camera2D = $Camera2D
func _ready() -> void:
# 必须启用位置平滑
camera.position_smoothing_enabled = true
camera.position_smoothing_speed = 5.0
# 设置相机边界基于TileMap
_setup_camera_limits()
func _setup_camera_limits() -> void:
# 获取当前场景的TileMap
var tilemap = get_tree().get_first_node_in_group("tilemap")
if tilemap and tilemap is TileMap:
var used_rect = tilemap.get_used_rect()
var tile_size = tilemap.tile_set.tile_size
# 计算世界坐标边界
camera.limit_left = used_rect.position.x * tile_size.x
camera.limit_top = used_rect.position.y * tile_size.y
camera.limit_right = used_rect.end.x * tile_size.x
camera.limit_bottom = used_rect.end.y * tile_size.y
```
### 移动实现模板
```gdscript
extends CharacterBody2D
class_name Player
@export var move_speed: float = 200.0
@export var acceleration: float = 1000.0
@export var friction: float = 1000.0
@onready var sprite: Sprite2D = $Sprite2D
@onready var camera: Camera2D = $Camera2D
func _ready() -> void:
# 设置相机
camera.position_smoothing_enabled = true
_setup_camera_limits()
func _physics_process(delta: float) -> void:
_handle_movement(delta)
func _handle_movement(delta: float) -> void:
# 获取输入方向
var input_direction := Input.get_vector(
"move_left", "move_right",
"move_up", "move_down"
)
# 应用移动
if input_direction != Vector2.ZERO:
velocity = velocity.move_toward(input_direction * move_speed, acceleration * delta)
else:
velocity = velocity.move_toward(Vector2.ZERO, friction * delta)
move_and_slide()
# 发送移动事件
if velocity.length() > 0:
EventSystem.emit_event(EventNames.PLAYER_MOVED, {
"position": global_position,
"velocity": velocity
})
```
## 🤖 NPC实现规范
### 基础要求
- **节点类型**: 使用 `CharacterBody2D``StaticBody2D`
- **交互区域**: 必须包含名为 `InteractionArea``Area2D`
- **事件通信**: 通过 `EventSystem` 触发交互
### NPC节点结构
```
NPC (CharacterBody2D)
├── Sprite2D # NPC精灵
├── CollisionShape2D # 物理碰撞
├── InteractionArea (Area2D) # 交互检测区域
│ └── CollisionShape2D # 交互碰撞形状
├── DialogueComponent # 对话组件
└── AnimationPlayer # 动画播放器
```
### NPC实现模板
```gdscript
extends CharacterBody2D
class_name NPC
@export var npc_name: String = "NPC"
@export var dialogue_resource: DialogueResource
@onready var interaction_area: Area2D = $InteractionArea
@onready var sprite: Sprite2D = $Sprite2D
signal interaction_available(npc: NPC)
signal interaction_unavailable(npc: NPC)
func _ready() -> void:
# 连接交互区域信号
interaction_area.body_entered.connect(_on_interaction_area_entered)
interaction_area.body_exited.connect(_on_interaction_area_exited)
# 监听交互事件
EventSystem.connect_event(EventNames.INTERACT_PRESSED, _on_interact_pressed)
func _on_interaction_area_entered(body: Node2D) -> void:
if body.is_in_group("player"):
interaction_available.emit(self)
# 显示交互提示
_show_interaction_hint()
func _on_interaction_area_exited(body: Node2D) -> void:
if body.is_in_group("player"):
interaction_unavailable.emit(self)
# 隐藏交互提示
_hide_interaction_hint()
func _on_interact_pressed(data: Dictionary = {}) -> void:
# 检查玩家是否在交互范围内
if _is_player_in_range():
start_dialogue()
func start_dialogue() -> void:
EventSystem.emit_event(EventNames.NPC_TALKED, {
"npc": self,
"npc_name": npc_name,
"dialogue": dialogue_resource
})
func _is_player_in_range() -> bool:
var bodies = interaction_area.get_overlapping_bodies()
for body in bodies:
if body.is_in_group("player"):
return true
return false
```
## 🗺️ TileMap图层规范
### 图层配置要求
TileMap必须按以下标准配置图层
#### 图层0地面层 (Ground)
- **用途**: 地面纹理、道路、草地等
- **碰撞**: 禁用物理层
- **渲染**: 最底层渲染
- **Y排序**: 禁用
```gdscript
# 设置地面层
var ground_layer = tilemap.get_layer(0)
tilemap.set_layer_name(0, "Ground")
tilemap.set_layer_enabled(0, true)
tilemap.set_layer_y_sort_enabled(0, false)
# 不设置物理层
```
#### 图层1障碍层 (Obstacles)
- **用途**: 墙壁、树木、建筑等不可通过的障碍
- **碰撞**: 启用物理层
- **渲染**: 中间层
- **Y排序**: 禁用
```gdscript
# 设置障碍层
tilemap.set_layer_name(1, "Obstacles")
tilemap.set_layer_enabled(1, true)
tilemap.set_layer_y_sort_enabled(1, false)
# 设置物理层用于碰撞检测
tilemap.set_layer_physics_enabled(1, true)
```
#### 图层2装饰层 (Decoration)
- **用途**: 装饰物、前景元素
- **碰撞**: 根据需要设置
- **渲染**: 最上层
- **Y排序**: 启用(重要!)
```gdscript
# 设置装饰层
tilemap.set_layer_name(2, "Decoration")
tilemap.set_layer_enabled(2, true)
tilemap.set_layer_y_sort_enabled(2, true) # 启用Y排序
tilemap.set_layer_y_sort_origin(2, 16) # 设置排序原点
```
### TileMap设置模板
```gdscript
extends TileMap
class_name GameTileMap
func _ready() -> void:
# 设置TileMap为tilemap组
add_to_group("tilemap")
# 配置图层
_setup_layers()
# 通知相机系统更新边界
EventSystem.emit_event(EventNames.TILEMAP_READY, {
"tilemap": self,
"used_rect": get_used_rect()
})
func _setup_layers() -> void:
# 确保有足够的图层
while get_layers_count() < 3:
add_layer(-1)
# 配置地面层 (0)
set_layer_name(0, "Ground")
set_layer_y_sort_enabled(0, false)
# 配置障碍层 (1)
set_layer_name(1, "Obstacles")
set_layer_y_sort_enabled(1, false)
set_layer_physics_enabled(1, true)
# 配置装饰层 (2)
set_layer_name(2, "Decoration")
set_layer_y_sort_enabled(2, true)
set_layer_y_sort_origin(2, tile_set.tile_size.y / 2)
```
## 🎯 交互物实现规范
### 可收集物品
```gdscript
extends Area2D
class_name CollectibleItem
@export var item_name: String = "Item"
@export var item_value: int = 1
@onready var sprite: Sprite2D = $Sprite2D
@onready var collision: CollisionShape2D = $CollisionShape2D
func _ready() -> void:
body_entered.connect(_on_body_entered)
func _on_body_entered(body: Node2D) -> void:
if body.is_in_group("player"):
collect_item(body)
func collect_item(collector: Node2D) -> void:
# 发送收集事件
EventSystem.emit_event(EventNames.ITEM_COLLECTED, {
"item_name": item_name,
"item_value": item_value,
"collector": collector,
"position": global_position
})
# 播放收集动画
_play_collect_animation()
func _play_collect_animation() -> void:
var tween = create_tween()
tween.parallel().tween_property(self, "scale", Vector2.ZERO, 0.3)
tween.parallel().tween_property(self, "modulate:a", 0.0, 0.3)
await tween.finished
queue_free()
```
### 可交互对象
```gdscript
extends StaticBody2D
class_name InteractableObject
@export var interaction_text: String = "按E交互"
@export var can_interact: bool = true
@onready var interaction_area: Area2D = $InteractionArea
@onready var sprite: Sprite2D = $Sprite2D
var player_in_range: bool = false
func _ready() -> void:
interaction_area.body_entered.connect(_on_interaction_area_entered)
interaction_area.body_exited.connect(_on_interaction_area_exited)
EventSystem.connect_event(EventNames.INTERACT_PRESSED, _on_interact_pressed)
func _on_interaction_area_entered(body: Node2D) -> void:
if body.is_in_group("player") and can_interact:
player_in_range = true
_show_interaction_prompt()
func _on_interaction_area_exited(body: Node2D) -> void:
if body.is_in_group("player"):
player_in_range = false
_hide_interaction_prompt()
func _on_interact_pressed(data: Dictionary = {}) -> void:
if player_in_range and can_interact:
interact()
func interact() -> void:
# 子类重写此方法实现具体交互逻辑
print("", name, " 交互")
EventSystem.emit_event(EventNames.OBJECT_INTERACTED, {
"object": self,
"interaction_type": "default"
})
```
## 🎨 资源过滤设置
### 纹理过滤规范
所有像素艺术资源必须使用最近邻过滤:
```gdscript
# 在导入设置中或代码中设置
func _setup_pixel_perfect_texture(texture: Texture2D) -> void:
if texture is ImageTexture:
var image = texture.get_image()
image.generate_mipmaps(false)
# 在导入设置中设置Filter为Off
```
### 导入设置模板
对于所有精灵资源,在导入设置中:
- **Filter**: Off (关闭)
- **Mipmaps**: Off (关闭)
- **Fix Alpha Border**: On (开启)
## 🔧 性能优化要求
### 节点缓存
```gdscript
# ✅ 正确:使用@onready缓存节点引用
@onready var sprite: Sprite2D = $Sprite2D
@onready var collision: CollisionShape2D = $CollisionShape2D
func _process(delta: float) -> void:
sprite.modulate.a = 0.5 # 使用缓存的引用
# ❌ 错误在_process中重复获取节点
func _process(delta: float) -> void:
$Sprite2D.modulate.a = 0.5 # 每帧都要查找节点
```
### 事件频率控制
```gdscript
# 控制事件发送频率
var last_event_time: float = 0.0
const EVENT_INTERVAL: float = 0.1 # 100ms间隔
func _process(delta: float) -> void:
var current_time = Time.get_time_dict_from_system()
if current_time - last_event_time >= EVENT_INTERVAL:
EventSystem.emit_event(EventNames.POSITION_UPDATE, {
"position": global_position
})
last_event_time = current_time
```
---
**记住:遵循这些实现细节规范可以确保游戏对象的一致性和性能!**

View File

@@ -13,7 +13,7 @@ NetworkManager 是一个统一的网络请求管理器提供了简洁的API
1. 打开 `Project``Project Settings`
2. 切换到 `AutoLoad` 标签
3. 添加新的AutoLoad
- **Path**: `res://core/managers/NetworkManager.gd`
- **Path**: `res://_Core/managers/NetworkManager.gd`
- **Name**: `NetworkManager`
- **Singleton**: ✅ 勾选
@@ -24,7 +24,7 @@ NetworkManager 是一个统一的网络请求管理器提供了简洁的API
```ini
[autoload]
NetworkManager="*res://core/managers/NetworkManager.gd"
NetworkManager="*res://_Core/managers/NetworkManager.gd"
```
### 3. 验证设置

View File

@@ -22,29 +22,29 @@
### 标准目录结构
```
scenes/
├── main_scene.tscn # 场景
├── auth_scene.tscn # 认证场景
── game_scene.tscn # 游戏场景
├── settings_scene.tscn # 设置场景
└── prefabs/ # 预制体组件
├── ui/ # UI组件
│ ├── button.tscn
── dialog.tscn
── menu.tscn
├── characters/ # 角色组件
── player.tscn
── npc.tscn
├── effects/ # 特效组件
── particle_effect.tscn
│ └── animation_effect.tscn
└── items/ # 物品组件
── collectible.tscn
└── interactive.tscn
├── Maps/ # 地图场景
│ ├── main_scene.tscn # 场景
│ └── game_scene.tscn # 游戏场景
├── Components/ # 组件预制体
│ ├── ui/ # UI组件
│ │ ├── button.tscn
│ ├── dialog.tscn
── menu.tscn
── characters/ # 角色组件
│ │ ├── player.tscn
── npc.tscn
── effects/ # 特效组件
│ │ ├── particle_effect.tscn
── animation_effect.tscn
│ └── items/ # 物品组件
├── collectible.tscn
── interactive.tscn
└── auth_scene.tscn # 认证场景
```
### 场景命名规范
- **主场景**: `scene_name.tscn` (snake_case)
- **预制体**: `component_name.tscn` (snake_case)
- **主场景**: `SceneName.tscn` (PascalCase)
- **组件预制体**: `ComponentName.tscn` (PascalCase)
- **脚本文件**: `SceneName.gd` (PascalCase)
- **节点名称**: `NodeName` (PascalCase) 或 `nodeName` (camelCase)
@@ -149,7 +149,7 @@ func initialize_scene():
func load_scene_data():
"""加载场景数据"""
# 从配置文件或网络加载场景数据
var data_path = "res://data/scenes/%s.json" % SCENE_NAME.to_lower()
var data_path = ProjectPaths.get_scene_data_path(SCENE_NAME)
if FileAccess.file_exists(data_path):
var file = FileAccess.open(data_path, FileAccess.READ)
if file:

View File

@@ -87,9 +87,9 @@ func return_object(obj: Node, type: String):
func _create_new_object(type: String) -> Node:
match type:
"Bullet":
return preload("res://prefabs/Bullet.tscn").instantiate()
return preload(ProjectPaths.get_component_path("effects", "Bullet")).instantiate()
"Enemy":
return preload("res://prefabs/Enemy.tscn").instantiate()
return preload(ProjectPaths.get_component_path("characters", "Enemy")).instantiate()
_:
return null
```

View File

@@ -129,7 +129,7 @@ func get_module_info() -> Dictionary:
# 私有方法
func _load_config() -> bool:
"""加载模块配置"""
var config_path = "res://module/%s/data/module_config.json" % MODULE_NAME
var config_path = ProjectPaths.get_module_config_path(MODULE_NAME)
if not FileAccess.file_exists(config_path):
print("警告: 模块配置文件不存在: ", config_path)
return true # 使用默认配置
@@ -270,7 +270,7 @@ func update_data(data_type: String, new_data: Dictionary):
```gdscript
# tests/test_your_module.gd
extends "res://addons/gut/test.gd"
extends GutTest
var module: YourModule

View File

@@ -66,13 +66,13 @@ Dedicated Server: ✗ 禁用
Variant: release
Vram Texture Compression: ✓ 启用
Export Type: Regular
Custom HTML Shell: res://assets/web/custom_shell.html
Custom HTML Shell: res://web_assets/custom_shell.html
Head Include: (留空,已在自定义模板中配置)
```
#### 高级选项
```
Custom HTML Shell: res://assets/web/custom_shell.html
Custom HTML Shell: res://web_assets/custom_shell.html
Progressive Web App: ✓ 启用(可选)
Icon 144x144: res://icon.svg
Icon 180x180: res://icon.svg

View File

@@ -0,0 +1,59 @@
# 网格瓦片系统
## 概述
网格瓦片系统提供32x32像素的标准化网格管理用于规范地图元素的位置和大小。
## 核心组件
### GridSystem (核心系统)
- **位置**: `_Core/systems/GridSystem.gd`
- **功能**: 提供网格坐标转换、位置计算等基础功能
- **类型**: 静态工具类
### GrassTile (瓦片组件)
- **脚本**: `scenes/prefabs/GrassTile.gd`
- **场景**: `scenes/prefabs/grass_tile_prefab.tscn`
- **功能**: 可视化的草地瓦片自动对齐32x32网格
## 使用方法
### 在编辑器中使用
1. 拖拽 `scenes/prefabs/grass_tile_prefab.tscn` 到场景中
2. 在Inspector中设置Texture和Grid Position
3. 瓦片会自动对齐到网格
### 通过代码使用
```gdscript
# 预加载场景
const GrassTileScene = preload("res://scenes/prefabs/grass_tile_prefab.tscn")
# 创建瓦片
var grass = GrassTileScene.instantiate()
add_child(grass)
grass.set_grid_position(Vector2i(0, 0))
```
## 网格规范
### 基础规格
- **网格大小**: 32x32像素
- **坐标系**: 左上角为原点(0,0)
- **对齐方式**: 瓦片中心对齐到网格中心
### 纹理要求
- 尺寸必须是32的倍数
- 推荐格式: PNG
- 推荐尺寸: 32x32, 64x64, 96x96
## API参考
### GridSystem 方法
- `world_to_grid(world_pos: Vector2) -> Vector2i`
- `grid_to_world_center(grid_pos: Vector2i) -> Vector2`
- `snap_to_grid(position: Vector2) -> Vector2`
### GrassTile 属性和方法
- `grid_position: Vector2i` - 网格坐标
- `set_grid_position(pos: Vector2i)` - 设置网格位置
- `snap_to_grid()` - 对齐到网格

0
docs/AI_docs/.gitkeep Normal file
View File

View File

@@ -0,0 +1,238 @@
# 🔧 故障排除指南
> AI编程助手专用常见问题的快速解决方案
## 🚨 常见错误及解决方案
### 1. UID无效警告
**错误信息**:
```
WARNING: scene/resources/resource_format_text.cpp:444 - res://path/to/file.tscn:X - ext_resource, invalid UID: uid://xxxxx - using text path instead: res://path/to/script.gd
```
**原因**: 文件移动后Godot的UID缓存没有更新导致UID引用失效。
**解决方案**:
```gdscript
# 方法1: 移除无效的UID使用文本路径
# 将这行:
[ext_resource type="Script" uid="uid://invalid_uid" path="res://path/to/script.gd" id="1_script"]
# 改为:
[ext_resource type="Script" path="res://path/to/script.gd" id="1_script"]
```
**预防措施**:
- 移动文件时使用Godot编辑器的文件系统面板
- 避免直接在文件系统中移动.gd和.tscn文件
- 移动文件后重新导入项目
### 2. 脚本路径错误
**错误信息**:
```
ERROR: Failed to load script "res://old/path/Script.gd" with error "File not found".
```
**解决方案**:
```gdscript
# 检查并更新所有.tscn文件中的脚本路径
# 使用搜索替换功能批量更新:
# 旧路径 → 新路径
"res://UI/Windows/" "res://scenes/ui/"
"res://Utils/" "res://_Core/utils/"
"res://Scenes/Maps/" "res://scenes/maps/"
```
### 3. AutoLoad路径错误
**错误信息**:
```
ERROR: Cannot load autoload: res://old/path/Manager.gd
```
**解决方案**:
```ini
# 在 project.godot 中更新 AutoLoad 路径
[autoload]
GameManager="*res://_Core/managers/GameManager.gd"
SceneManager="*res://_Core/managers/SceneManager.gd"
EventSystem="*res://_Core/systems/EventSystem.gd"
```
### 4. 资源加载失败
**错误信息**:
```
ERROR: Failed to load resource "res://old/path/resource.png".
```
**解决方案**:
```gdscript
# 检查资源路径是否正确
# 使用 ResourceLoader.exists() 验证路径
func load_resource_safely(path: String):
if not ResourceLoader.exists(path):
push_error("Resource not found: %s" % path)
return null
return load(path)
```
## 🔍 调试技巧
### 1. 路径验证
```gdscript
# 验证文件是否存在
func verify_file_exists(file_path: String) -> bool:
return FileAccess.file_exists(file_path)
# 验证资源是否存在
func verify_resource_exists(resource_path: String) -> bool:
return ResourceLoader.exists(resource_path)
# 打印当前工作目录
func print_current_directory():
print("Current directory: ", OS.get_executable_path().get_base_dir())
```
### 2. 场景加载调试
```gdscript
# 安全的场景加载
func load_scene_safely(scene_path: String) -> PackedScene:
if not ResourceLoader.exists(scene_path):
push_error("Scene file not found: %s" % scene_path)
return null
var scene = load(scene_path) as PackedScene
if scene == null:
push_error("Failed to load scene: %s" % scene_path)
return null
return scene
```
### 3. 节点引用调试
```gdscript
# 安全的节点获取
func get_node_safely(node_path: String) -> Node:
var node = get_node_or_null(node_path)
if node == null:
push_warning("Node not found: %s" % node_path)
return node
# 检查@onready变量是否正确初始化
func _ready():
# 验证所有@onready节点
if not some_button:
push_error("some_button not found - check node path")
if not some_label:
push_error("some_label not found - check node path")
```
## 🛠️ 项目结构问题
### 1. 文件移动后的检查清单
- [ ] 更新.tscn文件中的脚本路径
- [ ] 更新project.godot中的AutoLoad路径
- [ ] 更新代码中的硬编码路径
- [ ] 清理Godot缓存文件
- [ ] 重新导入项目
### 2. 缓存清理命令
```bash
# Windows PowerShell
Remove-Item -Recurse -Force ".godot\uid_cache.bin"
Remove-Item -Recurse -Force ".godot\global_script_class_cache.cfg"
# Linux/macOS
rm -rf .godot/uid_cache.bin
rm -rf .godot/global_script_class_cache.cfg
```
### 3. 路径常量管理
```gdscript
# 在 _Core/ProjectPaths.gd 中定义所有路径
class_name ProjectPaths
# 核心路径
const CORE_ROOT = "res://_Core/"
const MANAGERS_PATH = CORE_ROOT + "managers/"
const SYSTEMS_PATH = CORE_ROOT + "systems/"
const UTILS_PATH = CORE_ROOT + "utils/"
# 场景路径
const SCENES_ROOT = "res://scenes/"
const UI_PATH = SCENES_ROOT + "ui/"
const MAPS_PATH = SCENES_ROOT + "maps/"
# 使用示例
var scene_path = ProjectPaths.UI_PATH + "LoginWindow.tscn"
```
## 🎯 性能问题
### 1. 内存泄漏检测
```gdscript
# 监控节点数量
func _ready():
print("Initial node count: ", get_tree().get_node_count())
func _exit_tree():
print("Final node count: ", get_tree().get_node_count())
# 检查未释放的资源
func check_resource_leaks():
print("Resource count: ", ResourceLoader.get_resource_list().size())
```
### 2. 帧率监控
```gdscript
# 在 _Core/managers/PerformanceManager.gd
extends Node
var frame_count: int = 0
var fps_timer: float = 0.0
func _process(delta: float):
frame_count += 1
fps_timer += delta
if fps_timer >= 1.0:
var fps = frame_count / fps_timer
if fps < 30:
push_warning("Low FPS detected: %.1f" % fps)
frame_count = 0
fps_timer = 0.0
```
## 🔧 开发工具问题
### 1. Godot编辑器崩溃
**解决方案**:
1. 备份项目文件
2. 删除.godot文件夹
3. 重新打开项目
4. 重新导入所有资源
### 2. 脚本编辑器问题
**解决方案**:
```gdscript
# 检查脚本语法
# 使用 Godot 内置的语法检查器
# 或者在命令行中运行:
# godot --check-only script.gd
```
### 3. 场景编辑器问题
**解决方案**:
- 检查场景文件是否损坏
- 重新创建有问题的场景
- 使用版本控制恢复到工作版本
---
**💡 提示**: 遇到问题时首先检查Godot的输出面板和调试器它们通常会提供详细的错误信息和解决建议。

View File

@@ -0,0 +1,617 @@
# 🎯 管理器模板集合
> AI编程助手专用各类管理器的标准化代码模板
## 🎮 游戏管理器模板
### 基础游戏管理器
```gdscript
# _Core/managers/GameManager.gd
extends Node
## 游戏状态管理器
## 负责管理游戏的全局状态、玩家数据和游戏流程
# 信号定义
signal game_state_changed(old_state: GameState, new_state: GameState)
signal player_data_updated(data: Dictionary)
signal game_paused()
signal game_resumed()
# 游戏状态枚举
enum GameState {
LOADING,
MENU,
PLAYING,
PAUSED,
GAME_OVER,
SETTINGS
}
# 常量定义
const SAVE_FILE_PATH: String = "user://game_save.dat"
const CONFIG_FILE_PATH: String = "res://Config/game_config.json"
# 导出变量
@export var debug_mode: bool = false
@export var auto_save_interval: float = 30.0
# 公共变量
var current_state: GameState = GameState.LOADING
var is_paused: bool = false
var game_time: float = 0.0
# 玩家数据
var player_data: Dictionary = {
"level": 1,
"experience": 0,
"coins": 100,
"health": 100,
"max_health": 100,
"energy": 100,
"max_energy": 100
}
# 私有变量
var _auto_save_timer: Timer
var _game_config: Dictionary = {}
func _ready() -> void:
_initialize_manager()
_setup_auto_save()
_load_game_config()
change_state(GameState.MENU)
func _process(delta: float) -> void:
if current_state == GameState.PLAYING and not is_paused:
game_time += delta
## 改变游戏状态
func change_state(new_state: GameState) -> void:
if current_state == new_state:
return
var old_state = current_state
_exit_state(old_state)
current_state = new_state
_enter_state(new_state)
game_state_changed.emit(old_state, new_state)
if debug_mode:
print("[GameManager] State changed: %s -> %s" % [old_state, new_state])
## 暂停游戏
func pause_game() -> void:
if current_state != GameState.PLAYING:
return
is_paused = true
get_tree().paused = true
game_paused.emit()
## 恢复游戏
func resume_game() -> void:
if not is_paused:
return
is_paused = false
get_tree().paused = false
game_resumed.emit()
## 更新玩家数据
func update_player_data(key: String, value) -> void:
if not player_data.has(key):
push_warning("Unknown player data key: %s" % key)
return
player_data[key] = value
player_data_updated.emit(player_data)
if debug_mode:
print("[GameManager] Player data updated: %s = %s" % [key, value])
## 获取玩家数据
func get_player_data(key: String = ""):
if key.is_empty():
return player_data.duplicate()
return player_data.get(key, null)
## 保存游戏数据
func save_game() -> bool:
var save_data = {
"player_data": player_data,
"game_time": game_time,
"current_state": current_state,
"timestamp": Time.get_unix_time_from_system()
}
var file = FileAccess.open(SAVE_FILE_PATH, FileAccess.WRITE)
if file == null:
push_error("Failed to open save file for writing")
return false
file.store_string(JSON.stringify(save_data))
file.close()
if debug_mode:
print("[GameManager] Game saved successfully")
return true
## 加载游戏数据
func load_game() -> bool:
if not FileAccess.file_exists(SAVE_FILE_PATH):
if debug_mode:
print("[GameManager] No save file found")
return false
var file = FileAccess.open(SAVE_FILE_PATH, FileAccess.READ)
if file == null:
push_error("Failed to open save file for reading")
return false
var json_text = file.get_as_text()
file.close()
var json = JSON.new()
var parse_result = json.parse(json_text)
if parse_result != OK:
push_error("Failed to parse save file JSON")
return false
var save_data = json.data
# 恢复玩家数据
if save_data.has("player_data"):
player_data = save_data.player_data
player_data_updated.emit(player_data)
# 恢复游戏时间
if save_data.has("game_time"):
game_time = save_data.game_time
if debug_mode:
print("[GameManager] Game loaded successfully")
return true
# 私有方法
func _initialize_manager() -> void:
# 设置进程模式为总是处理(即使暂停时也能工作)
process_mode = Node.PROCESS_MODE_ALWAYS
func _setup_auto_save() -> void:
_auto_save_timer = Timer.new()
add_child(_auto_save_timer)
_auto_save_timer.wait_time = auto_save_interval
_auto_save_timer.timeout.connect(_on_auto_save_timeout)
_auto_save_timer.start()
func _load_game_config() -> void:
if not FileAccess.file_exists(CONFIG_FILE_PATH):
push_warning("Game config file not found")
return
var file = FileAccess.open(CONFIG_FILE_PATH, FileAccess.READ)
if file == null:
push_error("Failed to open game config file")
return
var json_text = file.get_as_text()
file.close()
var json = JSON.new()
var parse_result = json.parse(json_text)
if parse_result != OK:
push_error("Failed to parse game config JSON")
return
_game_config = json.data
func _enter_state(state: GameState) -> void:
match state:
GameState.LOADING:
# 加载游戏资源
pass
GameState.MENU:
# 显示主菜单
pass
GameState.PLAYING:
# 开始游戏逻辑
_auto_save_timer.start()
GameState.PAUSED:
# 暂停游戏
_auto_save_timer.stop()
GameState.GAME_OVER:
# 游戏结束处理
save_game()
GameState.SETTINGS:
# 显示设置界面
pass
func _exit_state(state: GameState) -> void:
match state:
GameState.PLAYING:
# 退出游戏时自动保存
save_game()
func _on_auto_save_timeout() -> void:
if current_state == GameState.PLAYING:
save_game()
```
## 🌐 网络管理器模板
### HTTP请求管理器
```gdscript
# _Core/managers/NetworkManager.gd
extends Node
## 网络请求管理器
## 负责处理所有HTTP请求和网络通信
# 信号定义
signal request_completed(request_id: String, success: bool, data: Dictionary)
signal connection_status_changed(is_connected: bool)
# 常量定义
const BASE_URL: String = "https://api.example.com"
const TIMEOUT_DURATION: float = 10.0
const MAX_RETRIES: int = 3
# 请求状态枚举
enum RequestStatus {
PENDING,
SUCCESS,
FAILED,
TIMEOUT,
CANCELLED
}
# 公共变量
var is_connected: bool = false
var active_requests: Dictionary = {}
# 私有变量
var _http_client: HTTPClient
var _request_counter: int = 0
func _ready() -> void:
_initialize_network()
_check_connection()
## 发送GET请求
func send_get_request(endpoint: String, headers: Dictionary = {}) -> String:
return _send_request(HTTPClient.METHOD_GET, endpoint, "", headers)
## 发送POST请求
func send_post_request(endpoint: String, data: Dictionary, headers: Dictionary = {}) -> String:
var json_data = JSON.stringify(data)
return _send_request(HTTPClient.METHOD_POST, endpoint, json_data, headers)
## 发送PUT请求
func send_put_request(endpoint: String, data: Dictionary, headers: Dictionary = {}) -> String:
var json_data = JSON.stringify(data)
return _send_request(HTTPClient.METHOD_PUT, endpoint, json_data, headers)
## 发送DELETE请求
func send_delete_request(endpoint: String, headers: Dictionary = {}) -> String:
return _send_request(HTTPClient.METHOD_DELETE, endpoint, "", headers)
## 取消请求
func cancel_request(request_id: String) -> bool:
if not active_requests.has(request_id):
return false
var request_data = active_requests[request_id]
if request_data.http_request:
request_data.http_request.cancel_request()
_cleanup_request(request_id, RequestStatus.CANCELLED)
return true
## 检查网络连接状态
func check_connection() -> void:
_check_connection()
# 私有方法
func _initialize_network() -> void:
_http_client = HTTPClient.new()
func _send_request(method: HTTPClient.Method, endpoint: String, data: String, headers: Dictionary) -> String:
var request_id = _generate_request_id()
var full_url = BASE_URL + endpoint
# 创建HTTP请求节点
var http_request = HTTPRequest.new()
add_child(http_request)
# 设置请求超时
http_request.timeout = TIMEOUT_DURATION
# 连接完成信号
http_request.request_completed.connect(_on_request_completed.bind(request_id))
# 准备请求头
var request_headers = ["Content-Type: application/json"]
for key in headers:
request_headers.append("%s: %s" % [key, headers[key]])
# 存储请求信息
active_requests[request_id] = {
"http_request": http_request,
"method": method,
"url": full_url,
"status": RequestStatus.PENDING,
"retry_count": 0,
"start_time": Time.get_time_dict_from_system()
}
# 发送请求
var error = http_request.request(full_url, request_headers, method, data)
if error != OK:
push_error("Failed to send HTTP request: %d" % error)
_cleanup_request(request_id, RequestStatus.FAILED)
return ""
return request_id
func _generate_request_id() -> String:
_request_counter += 1
return "req_%d_%d" % [Time.get_time_dict_from_system().hour * 3600 + Time.get_time_dict_from_system().minute * 60 + Time.get_time_dict_from_system().second, _request_counter]
func _on_request_completed(request_id: String, result: int, response_code: int, headers: PackedStringArray, body: PackedByteArray) -> void:
if not active_requests.has(request_id):
return
var request_data = active_requests[request_id]
var success = false
var response_data = {}
# 解析响应
if response_code >= 200 and response_code < 300:
success = true
var body_text = body.get_string_from_utf8()
if not body_text.is_empty():
var json = JSON.new()
var parse_result = json.parse(body_text)
if parse_result == OK:
response_data = json.data
else:
response_data = {"raw_response": body_text}
else:
# 处理错误响应
var body_text = body.get_string_from_utf8()
response_data = {
"error": "HTTP Error %d" % response_code,
"response_code": response_code,
"raw_response": body_text
}
# 发送完成信号
request_completed.emit(request_id, success, response_data)
# 清理请求
_cleanup_request(request_id, RequestStatus.SUCCESS if success else RequestStatus.FAILED)
func _cleanup_request(request_id: String, status: RequestStatus) -> void:
if not active_requests.has(request_id):
return
var request_data = active_requests[request_id]
# 移除HTTP请求节点
if request_data.http_request:
request_data.http_request.queue_free()
# 从活动请求中移除
active_requests.erase(request_id)
func _check_connection() -> void:
# 简单的连接检查可以改为ping服务器
var old_status = is_connected
is_connected = true # 这里可以实现实际的连接检查逻辑
if old_status != is_connected:
connection_status_changed.emit(is_connected)
```
## 🎵 音频管理器模板
### 音频系统管理器
```gdscript
# _Core/managers/AudioManager.gd
extends Node
## 音频管理器
## 负责管理游戏中的音乐和音效播放
# 信号定义
signal music_finished()
signal sound_effect_finished(sound_name: String)
# 音频类型枚举
enum AudioType {
MUSIC,
SOUND_EFFECT,
UI_SOUND,
VOICE
}
# 常量定义
const MUSIC_PATH: String = "res://assets/audio/music/"
const SOUND_PATH: String = "res://assets/audio/sounds/"
const VOICE_PATH: String = "res://assets/audio/voice/"
# 导出变量
@export var master_volume: float = 1.0
@export var music_volume: float = 0.7
@export var sfx_volume: float = 0.8
@export var voice_volume: float = 0.9
# 音频播放器
var music_player: AudioStreamPlayer
var sfx_players: Array[AudioStreamPlayer] = []
var voice_player: AudioStreamPlayer
# 当前播放状态
var current_music: String = ""
var is_music_playing: bool = false
var active_sounds: Dictionary = {}
func _ready() -> void:
_initialize_audio_players()
_load_audio_settings()
## 播放背景音乐
func play_music(music_name: String, fade_in: bool = true) -> void:
var music_path = MUSIC_PATH + music_name + ".ogg"
if not ResourceLoader.exists(music_path):
push_warning("Music file not found: %s" % music_path)
return
# 停止当前音乐
if is_music_playing:
stop_music(fade_in)
await get_tree().create_timer(0.5).timeout
# 加载并播放新音乐
var audio_stream = load(music_path)
music_player.stream = audio_stream
music_player.volume_db = linear_to_db(music_volume * master_volume)
if fade_in:
_fade_in_music()
else:
music_player.play()
current_music = music_name
is_music_playing = true
## 停止背景音乐
func stop_music(fade_out: bool = true) -> void:
if not is_music_playing:
return
if fade_out:
_fade_out_music()
else:
music_player.stop()
is_music_playing = false
current_music = ""
## 播放音效
func play_sound_effect(sound_name: String, volume_override: float = -1.0) -> void:
var sound_path = SOUND_PATH + sound_name + ".ogg"
if not ResourceLoader.exists(sound_path):
push_warning("Sound file not found: %s" % sound_path)
return
# 获取可用的音效播放器
var player = _get_available_sfx_player()
if player == null:
push_warning("No available sound effect player")
return
# 加载并播放音效
var audio_stream = load(sound_path)
player.stream = audio_stream
var final_volume = volume_override if volume_override > 0 else sfx_volume
player.volume_db = linear_to_db(final_volume * master_volume)
player.play()
active_sounds[sound_name] = player
## 设置主音量
func set_master_volume(volume: float) -> void:
master_volume = clamp(volume, 0.0, 1.0)
_update_all_volumes()
## 设置音乐音量
func set_music_volume(volume: float) -> void:
music_volume = clamp(volume, 0.0, 1.0)
if is_music_playing:
music_player.volume_db = linear_to_db(music_volume * master_volume)
## 设置音效音量
func set_sfx_volume(volume: float) -> void:
sfx_volume = clamp(volume, 0.0, 1.0)
_update_sfx_volumes()
# 私有方法
func _initialize_audio_players() -> void:
# 创建音乐播放器
music_player = AudioStreamPlayer.new()
add_child(music_player)
music_player.finished.connect(_on_music_finished)
# 创建多个音效播放器(支持同时播放多个音效)
for i in range(8):
var sfx_player = AudioStreamPlayer.new()
add_child(sfx_player)
sfx_players.append(sfx_player)
# 创建语音播放器
voice_player = AudioStreamPlayer.new()
add_child(voice_player)
func _get_available_sfx_player() -> AudioStreamPlayer:
for player in sfx_players:
if not player.playing:
return player
return null
func _fade_in_music() -> void:
music_player.volume_db = linear_to_db(0.01)
music_player.play()
var tween = create_tween()
tween.tween_method(_set_music_volume_db, 0.01, music_volume * master_volume, 1.0)
func _fade_out_music() -> void:
var tween = create_tween()
tween.tween_method(_set_music_volume_db, music_volume * master_volume, 0.01, 1.0)
tween.tween_callback(_stop_music_after_fade)
func _set_music_volume_db(volume: float) -> void:
music_player.volume_db = linear_to_db(volume)
func _stop_music_after_fade() -> void:
music_player.stop()
is_music_playing = false
current_music = ""
func _update_all_volumes() -> void:
if is_music_playing:
music_player.volume_db = linear_to_db(music_volume * master_volume)
_update_sfx_volumes()
func _update_sfx_volumes() -> void:
for player in sfx_players:
if player.playing:
player.volume_db = linear_to_db(sfx_volume * master_volume)
func _load_audio_settings() -> void:
# 从配置文件加载音频设置
pass
func _on_music_finished() -> void:
is_music_playing = false
current_music = ""
music_finished.emit()
```
---
**🎯 使用说明**:
1. 选择合适的管理器模板
2. 根据具体需求修改类名和功能
3. 确保在project.godot中配置为AutoLoad
4. 遵循项目的命名规范和代码风格
5. 添加必要的错误处理和日志记录

View File

@@ -0,0 +1,363 @@
# 🚀 功能开发流程
> AI编程助手专用新功能开发的标准化工作流程
## 🎯 开发流程概览
### 阶段1: 需求分析 → 阶段2: 架构设计 → 阶段3: 代码实现 → 阶段4: 测试验证 → 阶段5: 文档更新
---
## 📋 阶段1: 需求分析
### 1.1 理解需求
```markdown
**必须明确的问题:**
- 功能的具体作用是什么?
- 涉及哪些用户交互?
- 需要哪些数据和状态管理?
- 与现有功能的关系如何?
```
### 1.2 需求分类
```gdscript
# 功能类型分类
enum FeatureType {
CORE_SYSTEM, # 核心系统功能 → 放在 _Core/
GAME_SCENE, # 游戏场景功能 → 放在 scenes/
UI_COMPONENT, # UI组件功能 → 放在 scenes/ui/
ASSET_RELATED, # 资源相关功能 → 涉及 assets/
CONFIG_DRIVEN # 配置驱动功能 → 涉及 Config/
}
```
### 1.3 依赖分析
- 需要哪些现有管理器?
- 需要创建新的管理器吗?
- 需要新的事件定义吗?
- 需要新的配置文件吗?
---
## 🏗️ 阶段2: 架构设计
### 2.1 确定文件位置
```gdscript
# 根据功能类型确定文件位置
match feature_type:
FeatureType.CORE_SYSTEM:
# _Core/managers/ 或 _Core/systems/
var file_path = "_Core/managers/YourManager.gd"
FeatureType.GAME_SCENE:
# scenes/maps/, scenes/characters/, scenes/effects/
var file_path = "scenes/characters/YourCharacter.gd"
FeatureType.UI_COMPONENT:
# scenes/ui/
var file_path = "scenes/ui/YourWindow.gd"
```
### 2.2 设计接口
```gdscript
# 定义公共接口
class_name YourFeature
# 信号定义(对外通信)
signal feature_initialized()
signal feature_state_changed(new_state: String)
# 公共方法(供其他模块调用)
func initialize(config: Dictionary) -> bool
func get_state() -> String
func cleanup() -> void
```
### 2.3 事件设计
```gdscript
# 在 _Core/EventNames.gd 中添加新事件
const YOUR_FEATURE_STARTED: String = "your_feature_started"
const YOUR_FEATURE_COMPLETED: String = "your_feature_completed"
const YOUR_FEATURE_ERROR: String = "your_feature_error"
```
---
## 💻 阶段3: 代码实现
### 3.1 创建基础结构
```gdscript
# 使用标准模板创建文件
# 参考: docs/AI_docs/templates/components.md
extends Node # 或其他合适的基类
## [功能描述]
## 负责[具体职责]
# 信号定义
signal feature_ready()
# 枚举定义
enum FeatureState {
UNINITIALIZED,
INITIALIZING,
READY,
ERROR
}
# 常量定义
const CONFIG_PATH: String = "res://Config/your_feature_config.json"
# 导出变量
@export var debug_mode: bool = false
# 公共变量
var current_state: FeatureState = FeatureState.UNINITIALIZED
# 私有变量
var _config_data: Dictionary = {}
func _ready() -> void:
initialize()
```
### 3.2 实现核心逻辑
```gdscript
## 初始化功能
func initialize() -> bool:
if current_state != FeatureState.UNINITIALIZED:
push_warning("Feature already initialized")
return false
current_state = FeatureState.INITIALIZING
# 加载配置
if not _load_config():
current_state = FeatureState.ERROR
return false
# 连接事件
_connect_events()
# 执行初始化逻辑
_perform_initialization()
current_state = FeatureState.READY
feature_ready.emit()
return true
func _load_config() -> bool:
# 配置加载逻辑
return true
func _connect_events() -> void:
# 事件连接逻辑
EventSystem.connect_event("related_event", _on_related_event)
func _perform_initialization() -> void:
# 具体初始化逻辑
pass
```
### 3.3 错误处理
```gdscript
func _handle_error(error_message: String) -> void:
push_error("[YourFeature] %s" % error_message)
current_state = FeatureState.ERROR
# 发送错误事件
EventSystem.emit_event(EventNames.YOUR_FEATURE_ERROR, {
"message": error_message,
"timestamp": Time.get_unix_time_from_system()
})
```
---
## 🧪 阶段4: 测试验证
### 4.1 创建测试文件
```gdscript
# tests/unit/test_your_feature.gd
extends "res://addons/gut/test.gd"
## YourFeature 单元测试
var your_feature: YourFeature
func before_each():
your_feature = preload("res://_Core/managers/YourFeature.gd").new()
add_child(your_feature)
func after_each():
your_feature.queue_free()
func test_initialization():
# 测试初始化
var result = your_feature.initialize()
assert_true(result, "Feature should initialize successfully")
assert_eq(your_feature.current_state, YourFeature.FeatureState.READY)
func test_error_handling():
# 测试错误处理
# 模拟错误条件
pass
```
### 4.2 集成测试
```gdscript
# tests/integration/test_your_feature_integration.gd
extends "res://addons/gut/test.gd"
## YourFeature 集成测试
func test_feature_with_event_system():
# 测试与事件系统的集成
var event_received = false
EventSystem.connect_event("your_feature_started", func(data): event_received = true)
# 触发功能
# 验证事件是否正确发送
assert_true(event_received, "Event should be emitted")
```
### 4.3 性能测试
```gdscript
# tests/performance/test_your_feature_performance.gd
extends "res://addons/gut/test.gd"
## YourFeature 性能测试
func test_initialization_performance():
var start_time = Time.get_time_dict_from_system()
# 执行功能
your_feature.initialize()
var end_time = Time.get_time_dict_from_system()
var duration = _calculate_duration(start_time, end_time)
# 验证性能要求例如初始化应在100ms内完成
assert_lt(duration, 0.1, "Initialization should complete within 100ms")
```
---
## 📚 阶段5: 文档更新
### 5.1 更新API文档
```markdown
# 在 docs/AI_docs/quick_reference/api_reference.md 中添加
## YourFeature API
### 初始化
```gdscript
var feature = YourFeature.new()
feature.initialize(config_dict)
```
### 主要方法
- `initialize(config: Dictionary) -> bool` - 初始化功能
- `get_state() -> FeatureState` - 获取当前状态
- `cleanup() -> void` - 清理资源
### 事件
- `feature_ready` - 功能准备就绪
- `feature_state_changed(new_state)` - 状态改变
```
### 5.2 更新使用示例
```gdscript
# 在 docs/AI_docs/quick_reference/code_snippets.md 中添加
## YourFeature 使用示例
### 基本使用
```gdscript
# 创建和初始化
var feature = YourFeature.new()
add_child(feature)
# 连接信号
feature.feature_ready.connect(_on_feature_ready)
# 初始化
var config = {"setting1": "value1"}
feature.initialize(config)
func _on_feature_ready():
print("Feature is ready to use")
```
```
### 5.3 更新架构文档
```markdown
# 在 docs/AI_docs/architecture_guide.md 中更新
## 新增功能: YourFeature
### 位置
- 文件路径: `_Core/managers/YourFeature.gd`
- AutoLoad: 是/否
- 依赖: EventSystem, ConfigManager
### 职责
- 负责[具体职责描述]
- 管理[相关数据/状态]
- 提供[对外接口]
```
---
## ✅ 开发检查清单
### 代码质量检查
- [ ] 遵循命名规范PascalCase类名snake_case变量名
- [ ] 所有变量和函数都有类型注解
- [ ] 添加了适当的注释和文档字符串
- [ ] 实现了错误处理和边界检查
- [ ] 使用事件系统进行模块间通信
### 架构一致性检查
- [ ] 文件放在正确的目录中
- [ ] 如果是管理器已配置AutoLoad
- [ ] 事件名称已添加到EventNames.gd
- [ ] 配置文件已放在Config/目录
- [ ] 遵循项目的架构原则
### 测试覆盖检查
- [ ] 编写了单元测试
- [ ] 编写了集成测试(如果需要)
- [ ] 编写了性能测试(如果是核心功能)
- [ ] 所有测试都能通过
- [ ] 测试覆盖了主要功能和边界情况
### 文档更新检查
- [ ] 更新了API参考文档
- [ ] 添加了使用示例
- [ ] 更新了架构文档
- [ ] 更新了相关的工作流程文档
---
## 🔄 迭代优化
### 代码审查要点
1. **功能完整性**: 是否满足所有需求?
2. **性能表现**: 是否存在性能瓶颈?
3. **错误处理**: 是否处理了所有可能的错误情况?
4. **代码可读性**: 代码是否清晰易懂?
5. **测试覆盖**: 测试是否充分?
### 持续改进
- 收集用户反馈
- 监控性能指标
- 定期重构优化
- 更新文档和示例
---
**🎯 记住**: 这个流程确保了功能开发的质量和一致性。严格遵循每个阶段的要求,将大大提高开发效率和代码质量。

View File

@@ -0,0 +1,663 @@
# WhaleTown 标准开发工作流
> **AI 编程助手专用**:本文档定义了 WhaleTown 项目的标准化开发流程,确保所有开发者遵循统一的规范和质量标准。
---
## 🎯 工作流概览
```
┌─────────────────────────────────────────────────────────────────┐
│ WhaleTown 7步标准开发流程 │
└─────────────────────────────────────────────────────────────────┘
Step 1: 架构分析 → 读取架构规范,确定文件位置和通信方式
Step 2: 功能实现 → 按规范编码,遵循类型安全和事件驱动
Step 3: 注释规范检查 → 验证文件头、函数注释的完整性
Step 4: 命名规范检查 → 验证PascalCase/camelCase/UPPER_CASE
Step 5: 测试代码编写 → 创建GUT单元测试覆盖核心功能
Step 6: 测试验证 → 运行测试,确保所有测试通过
Step 7: Git 提交 → 生成符合规范的提交信息并提交
总耗时:约 20-40 分钟(根据功能复杂度)
```
---
## 📖 使用方式
### 方式一:使用 Skill推荐
最简单、最高效的方式是使用 `whaletown-developer` skill
```bash
/whaletown-developer 实现玩家二段跳功能
```
Skill 会自动执行全部 7 步流程,确保不遗漏任何步骤。
### 方式二:手动执行流程
如果需要手动控制流程,请按照以下步骤逐步执行,并参考本文档的详细说明。
---
## 📋 详细步骤说明
### Step 1: 架构分析5分钟
**目标**: 理解功能在项目中的位置和通信方式
**规范文档**: `docs/02-开发规范/架构与通信规范.md`
#### 执行清单
- [ ] 读取架构规范文档
- [ ] 确定文件位置_Core, scenes, UI
- [ ] 确定通信方式EventSystem
- [ ] 列出依赖的管理器/系统
- [ ] 设计事件定义(如需要)
#### 分层架构决策树
```
功能是核心系统(管理器/全局系统)?
├─ 是 → 放在 _Core/managers/ 或 _Core/systems/
└─ 否 → 功能是游戏场景相关?
├─ 是 → 放在 scenes/Maps/, scenes/Entities/, scenes/Components/
└─ 否 → 功能是UI界面
├─ 是 → 放在 scenes/ui/
└─ 否 → 重新分析功能定位
```
#### 通信方式决策
- **同模块内通信**: 父调用子方法(向下),子发出信号(向上)
- **跨模块通信**: MUST 使用 EventSystem
- **事件定义位置**: 所有事件名称定义在 `_Core/EventNames.gd`
#### 示例:玩家二段跳功能
```gdscript
# 架构分析结果
: scenes/Entities/Player/Player.gd # 游戏场景层
: EventSystem.emit_event() # 跨模块通信
: EventSystem, Input # 系统依赖
: PLAYER_DOUBLE_JUMPED # 需要在 EventNames.gd 中定义
```
---
### Step 2: 功能实现10-20分钟
**目标**: 按照规范实现功能代码
**规范文档**: `docs/02-开发规范/架构与通信规范.md`, `claude.md`
#### 执行清单
- [ ] 创建或修改文件在正确位置
- [ ] 所有变量和函数有类型注解
- [ ] 使用 Godot 4.2+ 语法await, @onready
- [ ] 通过 EventSystem 进行跨模块通信
- [ ] 如有新事件,添加到 EventNames.gd
- [ ] 使用 Nearest 滤镜Sprite2D/TileMap
#### 核心规范要点
**1. 严格类型安全**
```gdscript
# ✅ 正确
var speed: float = 200.0
var currentHealth: int = 100
func move(delta: float) -> void:
func getHealth() -> int:
# ❌ 错误
var speed = 200.0 # 缺少类型注解
func move(delta): # 缺少参数和返回值类型
```
**2. Godot 4.2+ 语法**
```gdscript
# ✅ 正确
await get_tree().create_timer(1.0).timeout
@onready var sprite: Sprite2D = $Sprite2D
# ❌ 错误
yield(get_tree().create_timer(1.0), "timeout") # Godot 3.x
var sprite = get_node("Sprite2D") # 应在 _ready 外缓存
```
**3. EventSystem 通信**
```gdscript
# 发送事件
EventSystem.emit_event(EventNames.PLAYER_DOUBLE_JUMPED, {
"position": global_position,
"direction": velocity.normalized()
})
# 监听事件
func _ready() -> void:
EventSystem.connect_event(EventNames.INTERACT_PRESSED, _on_interact_pressed)
func _on_interact_pressed(data: Dictionary = {}) -> void:
# 处理交互逻辑
pass
```
**4. 自动加载限制**
```gdscript
# ✅ 正确:在高层组件中访问
func _ready() -> void:
var current_state = GameManager.get_game_state()
# ❌ 错误在底层实体Player, NPC中直接访问
func _ready() -> void:
GameManager.register_player(self) # 不应该这样做
# ✅ 正确:底层实体使用事件
func _ready() -> void:
EventSystem.emit_event(EventNames.PLAYER_SPAWNED, {"player": self})
```
---
### Step 3: 注释规范检查3-5分钟
**目标**: 确保代码注释完整且符合规范
**规范文档**: `docs/02-开发规范/代码注释规范.md`
#### 执行清单
- [ ] 文件头注释完整
- [ ] 所有公共函数有完整注释
- [ ] 复杂逻辑有行内注释
- [ ] 使用 TODO/FIXME/NOTE 标记(如需要)
#### 文件头注释模板
```gdscript
# ============================================================================
# 文件名: PlayerController.gd
# 作用: 玩家角色控制器,处理玩家输入和移动逻辑
#
# 主要功能:
# - 处理键盘和手柄输入
# - 控制角色移动和跳跃
# - 管理角色状态切换
# - 实现二段跳功能
#
# 依赖: EventSystem, InputManager
# 作者: [开发者名称]
# 创建时间: 2025-01-03
# ============================================================================
extends CharacterBody2D
class_name PlayerController
```
#### 函数注释模板
```gdscript
# 执行二段跳
#
# 在玩家空中时允许执行一次额外的跳跃
# 二段跳的力度为普通跳跃的80%
#
# 参数: 无
#
# 返回值: 无
#
# 使用示例:
# if Input.is_action_just_pressed("jump") and canDoubleJump:
# performDoubleJump()
#
# 注意事项:
# - 只能在空中且 canDoubleJump 为 true 时调用
# - 执行后会将 canDoubleJump 设置为 false
# - 落地时会重置 canDoubleJump 为 true
func performDoubleJump() -> void:
velocity.y = JUMP_FORCE * 0.8
canDoubleJump = false
EventSystem.emit_event(EventNames.PLAYER_DOUBLE_JUMPED, {
"position": global_position
})
```
---
### Step 4: 命名规范检查2-3分钟
**目标**: 验证所有命名符合项目规范
**规范文档**: `docs/02-开发规范/命名规范.md`
#### 执行清单
- [ ] 类名使用 PascalCase
- [ ] 变量/函数使用 camelCase
- [ ] 常量使用 UPPER_CASE
- [ ] 私有成员使用下划线前缀
- [ ] 文件命名符合规范
#### 命名规范速查表
| 元素类型 | 命名规范 | 示例 |
|---------|---------|------|
| **类名** | PascalCase | `class_name PlayerController` |
| **变量** | camelCase | `var moveSpeed: float` |
| **私有变量** | _camelCase | `var _velocity: Vector2` |
| **函数** | camelCase | `func updateMovement()` |
| **私有函数** | _camelCase | `func _calculateDamage()` |
| **常量** | UPPER_CASE | `const MAX_HEALTH: int = 100` |
| **枚举类型** | PascalCase | `enum PlayerState` |
| **枚举值** | UPPER_CASE | `IDLE, WALKING, RUNNING` |
| **脚本文件** | PascalCase.gd | `PlayerController.gd` |
| **场景文件** | snake_case_scene.tscn | `main_scene.tscn` |
| **预制体** | snake_case_prefab.tscn | `player_prefab.tscn` |
#### 常见错误检查
```gdscript
# ✅ 正确
class_name PlayerController
const MAX_JUMPS: int = 2
var moveSpeed: float = 200.0
var canDoubleJump: bool = true
var _velocity: Vector2 = Vector2.ZERO
func performDoubleJump() -> void:
func _calculateJumpForce() -> float:
# ❌ 错误
class_name player_controller # 应使用 PascalCase
const maxJumps: int = 2 # 常量应使用 UPPER_CASE
var MoveSpeed: float = 200.0 # 变量应使用 camelCase
var can_double_jump: bool = true # 不要使用 snake_case
func PerformDoubleJump(): # 函数应使用 camelCase
```
---
### Step 5: 测试代码编写5-10分钟
**目标**: 为实现的功能创建单元测试
**规范文档**: `docs/03-技术实现/测试指南.md`
#### 执行清单
- [ ] 创建测试文件 `tests/unit/test_[name].gd`
- [ ] 测试文件继承自 GutTest
- [ ] 实现 before_each 和 after_each
- [ ] 编写核心功能测试
- [ ] 编写边界条件测试
#### 测试文件模板
```gdscript
# tests/unit/test_player_double_jump.gd
extends GutTest
## PlayerController 二段跳功能单元测试
var player: PlayerController
func before_each():
# 每个测试前创建新的 Player 实例
player = preload("res://scenes/Entities/Player/PlayerController.gd").new()
add_child(player)
player.initialize()
func after_each():
# 每个测试后清理
player.queue_free()
func test_can_double_jump_after_first_jump():
# 测试:第一次跳跃后可以二段跳
player.performJump()
assert_true(player.canDoubleJump, "Should be able to double jump after first jump")
func test_cannot_triple_jump():
# 测试:不能三段跳
player.performJump()
player.performDoubleJump()
assert_false(player.canDoubleJump, "Should not be able to triple jump")
func test_reset_double_jump_on_ground():
# 测试:落地后重置二段跳
player.performJump()
player.performDoubleJump()
player._on_landed() # 模拟落地
assert_true(player.canDoubleJump, "Double jump should reset when landing")
func test_double_jump_emits_event():
# 测试:二段跳发出事件
watch_signals(EventSystem)
player.performDoubleJump()
assert_signal_emitted(EventSystem, "event_raised")
```
#### 测试覆盖建议
1. **正常流程**: 功能的标准使用场景
2. **边界条件**: 极限值、特殊输入
3. **错误处理**: 异常情况、错误输入
4. **事件通信**: 验证事件正确发送和接收
5. **状态管理**: 状态转换的正确性
---
### Step 6: 测试验证2-3分钟
**目标**: 运行测试确保代码质量
**规范文档**: `docs/03-技术实现/测试指南.md`
#### 执行清单
- [ ] 运行 GUT 测试命令
- [ ] 所有测试通过
- [ ] 如有失败,修复并重新测试
- [ ] 确认测试覆盖核心功能
#### 运行测试
```bash
# 运行所有测试
godot --headless -s addons/gut/gut_cmdline.gd -gdir=res://tests/ -ginclude_subdirs
# 运行特定测试文件
godot --headless -s addons/gut/gut_cmdline.gd -gtest=res://tests/unit/test_player_double_jump.gd
```
#### 测试结果分析
**所有测试通过**
```
========================
= PASSED: 4 of 4 tests =
========================
```
✅ 进入下一步
**部分测试失败**
```
==========================
= FAILED: 1 of 4 tests =
==========================
FAILED: test_cannot_triple_jump
Expected: false
Got: true
```
❌ 修复问题后重新测试
---
### Step 7: Git 提交3-5分钟
**目标**: 生成符合规范的 Git 提交信息
**规范文档**: `docs/02-开发规范/Git提交规范.md`
#### 执行清单
- [ ] 确定提交类型feat/fix/docs/refactor等
- [ ] 生成规范的提交信息
- [ ] 使用中文冒号(:)
- [ ] 描述简洁明了
- [ ] 遵循"一次提交只做一件事"
#### 提交类型选择
| 改动类型 | 提交类型 | 示例 |
|---------|---------|------|
| 新功能 | `feat` | `feat实现玩家二段跳功能` |
| Bug修复 | `fix` | `fix修复跳跃碰撞检测问题` |
| 文档更新 | `docs` | `docs更新架构规范文档` |
| 代码重构 | `refactor` | `refactor重构移动系统逻辑` |
| 性能优化 | `perf` | `perf优化物理计算性能` |
| 测试相关 | `test` | `test添加二段跳单元测试` |
| 场景文件 | `scene` | `scene创建战斗场景` |
| UI界面 | `ui` | `ui设计暂停菜单界面` |
#### 提交示例
```bash
# 示例1新功能完整流程
git add scenes/Entities/Player/PlayerController.gd
git add _Core/EventNames.gd
git add tests/unit/test_player_double_jump.gd
git commit -m "feat实现玩家二段跳功能"
# 示例2Bug修复
git add scenes/Entities/Player/PlayerController.gd
git commit -m "fix修复二段跳状态未重置的问题"
# 示例3测试添加
git add tests/unit/test_player_movement.gd
git commit -m "test添加玩家移动系统单元测试"
# 示例4带详细描述的提交
git commit -m "feat实现玩家二段跳功能
- 添加二段跳核心逻辑
- 在空中允许执行一次额外跳跃
- 二段跳力度为普通跳跃的80%
- 发送 PLAYER_DOUBLE_JUMPED 事件
- 落地时重置二段跳能力"
```
#### 多类型改动处理
**⚠️ 如果同时有多种类型改动,必须拆分提交:**
```bash
# ❌ 错误:混合提交
git commit -m "fix + feat修复Bug并添加新功能"
# ✅ 正确:拆分提交
git add PlayerController.gd # 只暂存 Bug 修复部分
git commit -m "fix修复跳跃碰撞检测问题"
git add PlayerController.gd # 暂存新功能部分
git commit -m "feat实现玩家二段跳功能"
```
---
## ✅ 完整工作流检查清单
在完成开发任务后,使用此清单验证是否执行了全部流程:
### 总览检查
- [ ] ✅ Step 1: 架构分析完成
- [ ] ✅ Step 2: 功能实现完成
- [ ] ✅ Step 3: 注释规范检查通过
- [ ] ✅ Step 4: 命名规范检查通过
- [ ] ✅ Step 5: 测试代码编写完成
- [ ] ✅ Step 6: 测试验证通过
- [ ] ✅ Step 7: Git 提交完成
### 详细检查
- [ ] 文件位置符合分层架构_Core, scenes, UI
- [ ] 使用 EventSystem 进行跨模块通信
- [ ] 新事件已添加到 EventNames.gd
- [ ] 所有变量和函数有类型注解
- [ ] 使用 Godot 4.2+ 语法await, @onready
- [ ] 命名规范正确PascalCase/camelCase/UPPER_CASE
- [ ] 文件头注释完整
- [ ] 公共函数有完整文档注释
- [ ] 创建了单元测试文件
- [ ] 所有测试通过
- [ ] Git 提交信息符合规范
- [ ] Sprite2D/TileMap 使用 Nearest 滤镜
- [ ] 未违反自动加载限制
---
## 🚀 最佳实践
### 使用 TodoWrite 追踪进度
在执行工作流时,使用 TodoWrite 工具追踪每个步骤:
```gdscript
TodoWrite.create_todos([
"Step 1: 架构分析 - 读取架构规范",
"Step 2: 功能实现 - 按规范编码",
"Step 3: 注释规范检查",
"Step 4: 命名规范检查",
"Step 5: 测试代码编写",
"Step 6: 测试验证 - 运行测试",
"Step 7: Git 提交 - 生成提交信息"
])
```
每完成一步,立即标记为 `completed`
### 常见错误避免
1. **跳过测试**: 测试不是可选项,必须为核心功能编写测试
2. **混合提交**: 不要在一次提交中混合 fix 和 feat
3. **命名不一致**: 严格遵循 PascalCase/camelCase/UPPER_CASE
4. **缺少注释**: 公共函数必须有完整注释
5. **直接访问单例**: 底层实体使用事件,不直接访问 GameManager
### 提升效率技巧
1. **使用 Skill**: 调用 `/whaletown-developer` 自动执行全流程
2. **模板复用**: 参考现有代码的结构和注释模板
3. **增量提交**: 不要等所有功能完成才提交,完成一个逻辑单元就提交
4. **快速参考**: 使用 `.claude/skills/whaletown-developer/references/checklist.md` 快速自检
---
## 📚 相关文档索引
### 核心规范文档
- **架构与通信**: `docs/02-开发规范/架构与通信规范.md`
- **代码注释**: `docs/02-开发规范/代码注释规范.md`
- **命名规范**: `docs/02-开发规范/命名规范.md`
- **Git 提交**: `docs/02-开发规范/Git提交规范.md`
- **测试指南**: `docs/03-技术实现/测试指南.md`
- **项目指令**: `claude.md` (根目录)
### 辅助文档
- **Skill 指令**: `.claude/skills/whaletown-developer/SKILL.md`
- **快速检查清单**: `.claude/skills/whaletown-developer/references/checklist.md`
- **功能开发流程**: `docs/AI_docs/workflows/feature_development.md`
---
## 💡 示例:完整开发流程
### 任务:实现玩家二段跳功能
#### Step 1: 架构分析 (3分钟)
```
读取: docs/02-开发规范/架构与通信规范.md
分析结果:
- 文件位置: scenes/Entities/Player/PlayerController.gd
- 通信方式: EventSystem
- 依赖: EventSystem, Input
- 事件: PLAYER_DOUBLE_JUMPED (需添加到 EventNames.gd)
```
#### Step 2: 功能实现 (15分钟)
```gdscript
# scenes/Entities/Player/PlayerController.gd
extends CharacterBody2D
class_name PlayerController
const JUMP_FORCE: float = -400.0
const MAX_DOUBLE_JUMPS: int = 1
var canDoubleJump: bool = true
var doubleJumpCount: int = 0
func performDoubleJump() -> void:
if not canDoubleJump or doubleJumpCount >= MAX_DOUBLE_JUMPS:
return
velocity.y = JUMP_FORCE * 0.8
doubleJumpCount += 1
canDoubleJump = false
EventSystem.emit_event(EventNames.PLAYER_DOUBLE_JUMPED, {
"position": global_position
})
func _on_landed() -> void:
doubleJumpCount = 0
canDoubleJump = true
```
#### Step 3-4: 注释和命名检查 (5分钟)
```
✅ 文件头注释完整
✅ 函数注释完整
✅ 类名 PascalCase: PlayerController
✅ 变量 camelCase: canDoubleJump
✅ 常量 UPPER_CASE: MAX_DOUBLE_JUMPS
```
#### Step 5: 编写测试 (8分钟)
```gdscript
# tests/unit/test_player_double_jump.gd
extends GutTest
var player: PlayerController
func before_each():
player = PlayerController.new()
add_child(player)
func test_can_double_jump():
assert_true(player.canDoubleJump)
func test_double_jump_resets_on_landing():
player.performDoubleJump()
player._on_landed()
assert_true(player.canDoubleJump)
```
#### Step 6: 测试验证 (2分钟)
```bash
$ godot --headless -s addons/gut/gut_cmdline.gd
========================
= PASSED: 2 of 2 tests =
========================
```
#### Step 7: Git 提交 (3分钟)
```bash
git add scenes/Entities/Player/PlayerController.gd
git add _Core/EventNames.gd
git add tests/unit/test_player_double_jump.gd
git commit -m "feat实现玩家二段跳功能"
```
**总耗时**: 约 36 分钟
**结果**: ✅ 功能实现完整,符合所有规范
---
## 🎓 总结
遵循此 7 步标准开发工作流,可以确保:
1. **代码质量**: 符合项目的所有规范和标准
2. **团队一致**: 所有开发者使用相同的流程和规范
3. **可维护性**: 清晰的注释、规范的命名、完整的测试
4. **高效协作**: 规范的 Git 提交历史,便于追溯和回滚
5. **质量保证**: 测试驱动开发,确保功能正确性
**记住**: 使用 `/whaletown-developer` skill 可以自动化执行此流程!🚀

65
docs/CHANGELOG.md Normal file
View File

@@ -0,0 +1,65 @@
# 文档更新日志
本文档记录了WhaleTown项目文档的重要更新和修改。
## 版本 1.1.0 (2025-12-31)
### 🆕 新增内容
- **新增**: `_Core/EventNames.gd` - 统一管理所有事件名称常量
- **新增**: `_Core/ProjectPaths.gd` - 统一管理项目路径配置
- **新增**: 输入映射配置到 `project.godot`
- **新增**: 文档更新日志 `docs/CHANGELOG.md`
### 🔧 修复问题
- **修复**: 架构与通信规范中AutoLoad单例数量描述从3个更新为5个
- **修复**: 网络管理器设置文档中的路径错误(`core/``_Core/`
- **修复**: Web部署指南中的资源路径`assets/web/``web_assets/`
- **修复**: 场景设计规范中的目录结构(`prefabs/``Components/`
- **修复**: 性能优化指南中的预制体路径
- **修复**: 模块开发指南中的测试基类路径(使用 `GutTest` 而非完整路径)
### 📝 内容优化
- **优化**: 场景命名规范,与实际项目结构保持一致
- **优化**: 所有文档中的路径引用,使用 `ProjectPaths` 统一管理
- **优化**: 代码示例的准确性和可用性
### 🎯 质量提升
- **提升**: 文档与实际代码的匹配度
- **提升**: 路径配置的一致性和可维护性
- **提升**: 开发者体验和文档可用性
## 版本 1.0.0 (2025-12-24)
### 📚 初始文档结构
- **01-项目入门**: 项目介绍、结构说明、设置指南
- **02-开发规范**: 命名规范、注释规范、Git提交规范、架构规范、开发哲学
- **03-技术实现**: 实现细节、API文档、网络管理器、测试指南
- **04-高级开发**: 场景设计、模块开发、性能优化
- **05-部署运维**: Web部署指南
- **06-功能模块**: 认证模块相关文档
### 🏗️ 核心特性
- 完整的开发规范体系
- 详细的技术实现指导
- 全面的测试和部署流程
- 模块化的功能开发指南
---
## 维护说明
### 文档更新原则
1. **同步更新**: 代码变更时同步更新相关文档
2. **版本记录**: 重要更新需要在此日志中记录
3. **向后兼容**: 尽量保持API和配置的向后兼容性
4. **质量保证**: 确保文档内容的准确性和可用性
### 贡献指南
- 发现文档问题请及时反馈
- 提交文档更新时请更新此日志
- 重大变更需要团队讨论确认
### 相关链接
- [项目结构说明](01-项目入门/项目结构说明.md)
- [开发规范总览](02-开发规范/README.md)
- [技术实现指南](03-技术实现/README.md)

122
docs/CONTRIBUTORS.md Normal file
View File

@@ -0,0 +1,122 @@
# 🤝 项目贡献者
感谢所有为WhaleTown项目做出贡献的开发者
## 🏆 核心贡献者
### 主要开发者
#### 王浩
- **贡献数量**: 3+ commits
- **主要贡献**:
- 🏗️ 项目架构分层结构重构
- 📚 AI开发规范文档制定
- 📖 项目开发规范文档完善
#### moyin
- **贡献数量**: 35+ commits
- **主要贡献**:
- 🔧 项目功能开发和实现
- 📝 文档内容编写和维护
- 🧪 测试用例开发和验证
- 🌐 网络系统和部署配置
## 📊 贡献统计
### 按贡献类型
| 贡献类型 | 主要贡献者 | 说明 |
|----------|------------|------|
| **架构设计** | 王浩, moyin | 分层结构重构,模块化架构 |
| **开发规范** | 王浩 | AI开发规范、编码标准 |
| **文档建设** | moyin, 王浩 | 18个完整文档覆盖全开发流程 |
| **网络系统** | moyin | NetworkManager、API集成 |
| **测试框架** | moyin | API测试、UI测试、性能测试 |
| **认证系统** | moyin | 用户认证流程实现 |
| **部署系统** | moyin | Web部署、自动化脚本 |
### 按时间线
#### 2024年12月
- **架构重构**: 王浩 实施分层架构重构
- **规范制定**: 王浩 制定AI开发规范
- **项目开发**: moyin 完成主要功能开发
- **文档建设**: moyin, 王浩 建设文档系统
- **测试集成**: moyin 完成API集成和测试
## 🌟 贡献亮点
### 🏗️ 架构设计
- **分层结构**: 清晰的代码组织和职责分离
- **模块化架构**: 高度解耦的组件系统
- **事件驱动**: 基于EventSystem的通信机制
### 📚 文档建设
- **企业级文档**: 18个完整文档100%覆盖
- **分类组织**: 按开发阶段精心分类
- **实用导向**: 大量可直接使用的代码模板
### 🎯 开发规范
- **AI开发规范**: AI辅助开发的最佳实践
- **编码标准**: 统一的命名规范和代码风格
- **质量保证**: 完善的代码审查流程
### 🧪 测试体系
- **多层测试**: API、UI、单元、集成测试
- **自动化**: Python测试脚本和Godot测试场景
- **完整覆盖**: 17个API接口全覆盖
### 🌐 部署系统
- **一键部署**: 自动化Web部署脚本
- **跨平台**: 支持Windows、Linux、macOS
- **配置完善**: 详细的服务器配置指南
## 🎯 特别感谢
### 技术贡献
- **王浩**: 负责架构重构和开发规范制定
- **moyin**: 负责主要功能开发和文档编写
### 架构贡献
- **分层结构**: 提升了项目的代码组织和可维护性
- **模块化设计**: 为项目扩展奠定了良好基础
- **开发规范**: 统一了团队的开发标准
## 🚀 如何成为贡献者
### 贡献方式
1. **🐛 Bug修复** - 发现并修复问题
2. **✨ 新功能** - 添加有价值的功能
3. **📚 文档改进** - 完善项目文档
4. **🧪 测试用例** - 提高代码覆盖率
5. **🎨 UI/UX改进** - 提升用户体验
6. **⚡ 性能优化** - 优化游戏性能
### 贡献流程
1. Fork项目到你的账户
2. 创建功能分支:`git checkout -b feature/your-feature`
3. 遵循项目规范开发
4. 添加测试用例
5. 提交代码:`git commit -m "feat添加新功能"`
6. 创建Pull Request
### 规范要求
- 遵循[命名规范](02-开发规范/命名规范.md)
- 遵循[Git提交规范](02-开发规范/Git提交规范.md)
- 遵循[代码注释规范](02-开发规范/代码注释规范.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)
---
**感谢所有贡献者的辛勤付出每个人的贡献都让WhaleTown项目变得更好。** 🙏
*最后更新: 2025-12-31*

310
docs/README.md Normal file
View File

@@ -0,0 +1,310 @@
# 📚 WhaleTown 项目文档中心
欢迎来到WhaleTown项目文档中心这是一个完整的企业级文档系统按开发阶段精心组织帮助你快速找到所需的技术指导。
## 🎯 文档特色
- **📋 完整覆盖**: 从项目入门到部署运维的全生命周期
- **🎨 结构清晰**: 按开发阶段和角色需求分类组织
- **💻 实用导向**: 提供大量可直接使用的代码模板和配置示例
- **🔄 持续更新**: 与项目代码保持同步,确保文档准确性
- **🧪 测试完备**: 包含详细的测试指南和用例
## 🗂️ 文档结构
```
docs/
├── 📖 README.md # 本导航文档
├── 📋 CHANGELOG.md # 文档更新日志
├── 📁 01-项目入门/ # 新人必读,项目基础
├── 📁 02-开发规范/ # 编码标准和规范
├── 📁 03-技术实现/ # 具体开发指导
├── 📁 04-高级开发/ # 进阶开发技巧
├── 📁 05-部署运维/ # 发布和部署
└── 📁 06-功能模块/ # 特定功能文档
```
## 📊 文档质量等级
| 等级 | 说明 | 标识 |
|------|------|------|
| A级 | 企业级标准,内容完整准确 | ⭐⭐⭐⭐⭐ |
| B级 | 内容详实,偶有更新需求 | ⭐⭐⭐⭐ |
| C级 | 基础完备,持续完善中 | ⭐⭐⭐ |
**当前整体质量**: **A级**
---
## 🚀 快速开始指南
### 👋 我是新人,从哪里开始?
**推荐阅读顺序:**
1. [项目入门总览](01-项目入门/README.md) - 快速了解项目
2. [项目结构说明](01-项目入门/项目结构说明.md) - 深入了解项目架构
3. [项目设置指南](01-项目入门/项目设置指南.md) - 配置开发环境
4. [命名规范](02-开发规范/命名规范.md) - 学习编码规范
### 💻 我要开始编码了
**必读文档:**
- [架构与通信规范](02-开发规范/架构与通信规范.md) - 组件通信方式 ⭐⭐⭐⭐⭐
- [实现细节规范](03-技术实现/实现细节规范.md) - 具体实现要求 ⭐⭐⭐⭐⭐
- [开发哲学与最佳实践](02-开发规范/开发哲学与最佳实践.md) - 代码质量标准 ⭐⭐⭐⭐
### 🔧 我需要集成API
**相关文档:**
- [API接口文档](03-技术实现/API接口文档.md) - 完整的接口说明 ⭐⭐⭐⭐⭐
- [网络管理器设置](03-技术实现/网络管理器设置.md) - 网络配置指南 ⭐⭐⭐⭐
- [测试指南](03-技术实现/测试指南.md) - API测试方法 ⭐⭐⭐⭐
### 🚀 我要发布项目
**部署文档:**
- [Web部署指南](05-部署运维/Web部署指南.md) - 完整的Web版本发布流程 ⭐⭐⭐⭐
### 🔍 我需要调试和优化
**高级文档:**
- [性能优化指南](04-高级开发/性能优化指南.md) - 全面的性能优化策略 ⭐⭐⭐⭐⭐
- [场景设计规范](04-高级开发/场景设计规范.md) - 场景架构最佳实践 ⭐⭐⭐⭐
---
## 📁 详细目录
### 01-项目入门 📖
> **适用人群**: 新加入项目的开发者
> **使用时机**: 项目开始前,环境搭建阶段
> **质量等级**: A级 ⭐⭐⭐⭐⭐
| 文档 | 用途 | 重要程度 | 更新状态 |
|------|------|----------|----------|
| [README.md](01-项目入门/README.md) | 项目入门总览和快速导航 | ⭐⭐⭐⭐⭐ | ✅ 最新 |
| [项目结构说明.md](01-项目入门/项目结构说明.md) | 了解项目整体架构和目录组织 | ⭐⭐⭐⭐⭐ | ✅ 最新 |
| [项目设置指南.md](01-项目入门/项目设置指南.md) | Godot项目配置和AutoLoad设置 | ⭐⭐⭐⭐⭐ | ✅ 最新 |
### 02-开发规范 📋
> **适用人群**: 所有开发者
> **使用时机**: 编码过程中,代码审查时
> **质量等级**: A级 ⭐⭐⭐⭐⭐
| 文档 | 用途 | 重要程度 | 更新状态 |
|------|------|----------|----------|
| [命名规范.md](02-开发规范/命名规范.md) | 统一的命名标准,包含完整示例 | ⭐⭐⭐⭐⭐ | ✅ 最新 |
| [代码注释规范.md](02-开发规范/代码注释规范.md) | 注释格式和AI辅助注释指南 | ⭐⭐⭐⭐ | ✅ 最新 |
| [Git提交规范.md](02-开发规范/Git提交规范.md) | 版本控制规范和最佳实践 | ⭐⭐⭐⭐ | ✅ 最新 |
| [架构与通信规范.md](02-开发规范/架构与通信规范.md) | 事件系统和组件通信标准 | ⭐⭐⭐⭐⭐ | ✅ 最新 |
| [开发哲学与最佳实践.md](02-开发规范/开发哲学与最佳实践.md) | 代码质量和开发理念 | ⭐⭐⭐⭐ | ✅ 最新 |
### 03-技术实现 🔧
> **适用人群**: 正在开发功能的程序员
> **使用时机**: 具体功能开发时
> **质量等级**: A级 ⭐⭐⭐⭐⭐
| 文档 | 用途 | 重要程度 | 更新状态 |
|------|------|----------|----------|
| [实现细节规范.md](03-技术实现/实现细节规范.md) | 游戏对象具体实现要求和模板 | ⭐⭐⭐⭐⭐ | ✅ 最新 |
| [API接口文档.md](03-技术实现/API接口文档.md) | 完整的后端接口说明和测试用例 | ⭐⭐⭐⭐⭐ | ✅ 最新 |
| [网络管理器设置.md](03-技术实现/网络管理器设置.md) | 网络通信配置和使用指南 | ⭐⭐⭐⭐ | ✅ 最新 |
| [测试指南.md](03-技术实现/测试指南.md) | 多种测试方法和工具使用 | ⭐⭐⭐⭐ | ✅ 最新 |
### 04-高级开发 🚀
> **适用人群**: 有经验的开发者,架构师
> **使用时机**: 复杂功能开发,性能优化时
> **质量等级**: A级 ⭐⭐⭐⭐⭐
| 文档 | 用途 | 重要程度 | 更新状态 |
|------|------|----------|----------|
| [场景设计规范.md](04-高级开发/场景设计规范.md) | 场景架构和设计标准,包含完整模板 | ⭐⭐⭐⭐ | ✅ 最新 |
| [模块开发指南.md](04-高级开发/模块开发指南.md) | 创建可复用模块的完整流程 | ⭐⭐⭐⭐ | ✅ 最新 |
| [性能优化指南.md](04-高级开发/性能优化指南.md) | 全面的游戏性能优化策略 | ⭐⭐⭐⭐⭐ | ✅ 最新 |
### 05-部署运维 🌐
> **适用人群**: DevOps工程师项目负责人
> **使用时机**: 项目发布,部署配置时
> **质量等级**: A级 ⭐⭐⭐⭐⭐
| 文档 | 用途 | 重要程度 | 更新状态 |
|------|------|----------|----------|
| [Web部署指南.md](05-部署运维/Web部署指南.md) | 完整的Web版本导出和部署流程 | ⭐⭐⭐⭐⭐ | ✅ 最新 |
### 06-功能模块 🎮
> **适用人群**: 开发特定功能的程序员
> **使用时机**: 开发对应功能时
> **质量等级**: A级 ⭐⭐⭐⭐⭐
| 目录/文档 | 用途 | 重要程度 | 更新状态 |
|-----------|------|----------|----------|
| [auth/](06-功能模块/auth/) | 用户认证系统完整文档 | ⭐⭐⭐⭐⭐ | ✅ 最新 |
| └── [表单验证规范.md](06-功能模块/auth/表单验证规范.md) | 详细的表单验证规则和UI规范 | ⭐⭐⭐⭐ | ✅ 最新 |
| └── [认证测试指南.md](06-功能模块/auth/认证测试指南.md) | 完整的认证功能测试用例 | ⭐⭐⭐⭐ | ✅ 最新 |
---
## 🎯 按角色推荐
### 👨‍💻 前端开发者
**学习路径**: 01-项目入门 → 02-开发规范 → 03-技术实现 → 06-功能模块
**核心文档**:
- [架构与通信规范](02-开发规范/架构与通信规范.md) - 掌握事件系统 ⭐⭐⭐⭐⭐
- [实现细节规范](03-技术实现/实现细节规范.md) - 游戏对象实现 ⭐⭐⭐⭐⭐
- [API接口文档](03-技术实现/API接口文档.md) - 后端接口调用 ⭐⭐⭐⭐⭐
### 🏗️ 架构师/技术负责人
**学习路径**: 01-项目入门 → 02-开发规范 → 04-高级开发 → 05-部署运维
**核心文档**:
- [开发哲学与最佳实践](02-开发规范/开发哲学与最佳实践.md) - 代码质量标准 ⭐⭐⭐⭐⭐
- [场景设计规范](04-高级开发/场景设计规范.md) - 架构设计模式 ⭐⭐⭐⭐⭐
- [性能优化指南](04-高级开发/性能优化指南.md) - 性能优化策略 ⭐⭐⭐⭐⭐
### 🧪 测试工程师
**学习路径**: 01-项目入门 → 03-技术实现/测试指南 → 06-功能模块
**核心文档**:
- [测试指南](03-技术实现/测试指南.md) - 测试方法和工具 ⭐⭐⭐⭐⭐
- [认证测试指南](06-功能模块/auth/认证测试指南.md) - 功能测试用例 ⭐⭐⭐⭐
### 🚀 DevOps工程师
**学习路径**: 01-项目入门 → 05-部署运维 → 03-技术实现
**核心文档**:
- [Web部署指南](05-部署运维/Web部署指南.md) - 完整部署流程 ⭐⭐⭐⭐⭐
- [项目设置指南](01-项目入门/项目设置指南.md) - 环境配置 ⭐⭐⭐⭐
### 🎮 游戏设计师
**学习路径**: 01-项目入门 → 04-高级开发/场景设计规范 → 06-功能模块
**核心文档**:
- [场景设计规范](04-高级开发/场景设计规范.md) - 场景设计标准 ⭐⭐⭐⭐⭐
---
## 🔍 快速查找
### 按问题类型查找
**🤔 "我不知道项目是怎么组织的"**
→ [项目结构说明.md](01-项目入门/项目结构说明.md) - 完整的项目架构说明
**🤔 "我不知道怎么配置开发环境"**
→ [项目设置指南.md](01-项目入门/项目设置指南.md) - 详细的环境配置步骤
**🤔 "我不知道怎么命名变量/函数"**
→ [命名规范.md](02-开发规范/命名规范.md) - 统一的命名标准和示例
**🤔 "我不知道怎么让组件之间通信"**
→ [架构与通信规范.md](02-开发规范/架构与通信规范.md) - 事件系统使用指南
**🤔 "我不知道怎么实现玩家/NPC"**
→ [实现细节规范.md](03-技术实现/实现细节规范.md) - 游戏对象实现模板
**🤔 "我不知道怎么调用API"**
→ [API接口文档.md](03-技术实现/API接口文档.md) - 完整的接口说明和示例
**🤔 "我不知道怎么测试功能"**
→ [测试指南.md](03-技术实现/测试指南.md) - 多种测试方法和工具
**🤔 "我不知道怎么优化性能"**
→ [性能优化指南.md](04-高级开发/性能优化指南.md) - 全面的优化策略
**🤔 "我不知道怎么发布项目"**
→ [Web部署指南.md](05-部署运维/Web部署指南.md) - 完整的部署流程
**🤔 "我不知道怎么开发模块"**
→ [模块开发指南.md](04-高级开发/模块开发指南.md) - 模块化开发方法
### 按开发阶段查找
| 阶段 | 主要文档 | 说明 |
|------|----------|------|
| **项目启动** | 01-项目入门 | 环境搭建,项目了解 |
| **需求分析** | 02-开发规范 | 规范制定,架构设计 |
| **功能开发** | 03-技术实现 | 具体实现API集成 |
| **质量保证** | 03-技术实现/测试指南 | 测试验证,质量控制 |
| **性能优化** | 04-高级开发 | 性能调优,架构优化 |
| **项目发布** | 05-部署运维 | 部署配置,运维监控 |
## 🛠️ 核心工具和配置
### 已集成的核心组件
- **EventSystem** - 全局事件通信系统 ([EventNames.gd](_Core/EventNames.gd))
- **ProjectPaths** - 统一路径管理 ([ProjectPaths.gd](_Core/ProjectPaths.gd))
- **NetworkManager** - 网络请求管理器
- **ResponseHandler** - 统一响应处理器
- **StringUtils** - 字符串工具类
### 配置文件
- **project.godot** - 项目配置包含输入映射和AutoLoad设置
- **Config/game_config.json** - 游戏配置文件
- **web_assets/** - Web部署资源
## 📈 文档统计
| 类别 | 文档数量 | 完成度 | 质量等级 |
|------|----------|--------|----------|
| 项目入门 | 3 | 100% | A级 ⭐⭐⭐⭐⭐ |
| 开发规范 | 5 | 100% | A级 ⭐⭐⭐⭐⭐ |
| 技术实现 | 4 | 100% | A级 ⭐⭐⭐⭐⭐ |
| 高级开发 | 3 | 100% | A级 ⭐⭐⭐⭐⭐ |
| 部署运维 | 1 | 100% | A级 ⭐⭐⭐⭐⭐ |
| 功能模块 | 2 | 100% | A级 ⭐⭐⭐⭐⭐ |
| **总计** | **18** | **100%** | **A级** ⭐⭐⭐⭐⭐ |
---
## 📝 文档维护
### 更新机制
- **自动同步**: 代码变更时自动检查相关文档
- **版本控制**: 重要更新记录在 [CHANGELOG.md](CHANGELOG.md)
- **质量保证**: 定期校验文档与代码的一致性
- **持续改进**: 根据用户反馈持续优化文档质量
### 更新频率
| 文档类别 | 更新触发条件 | 更新频率 |
|----------|--------------|----------|
| **01-项目入门** | 项目架构变更 | 按需更新 |
| **02-开发规范** | 团队规范调整 | 季度评审 |
| **03-技术实现** | API变更/新功能 | 实时更新 |
| **04-高级开发** | 最佳实践演进 | 月度评审 |
| **05-部署运维** | 部署流程变更 | 按需更新 |
| **06-功能模块** | 功能开发完成 | 实时更新 |
### 贡献指南
如果你发现文档有问题或需要补充:
1. **报告问题**: 创建Issue描述具体问题
2. **提交改进**: 提交PR修改文档内容
3. **遵循规范**: 按照[Git提交规范](02-开发规范/Git提交规范.md)提交
4. **更新日志**: 重要变更需更新[CHANGELOG.md](CHANGELOG.md)
### 文档质量标准
- **准确性**: 与实际代码保持100%一致
- **完整性**: 覆盖功能的完整生命周期
- **实用性**: 提供可直接使用的代码示例
- **可读性**: 结构清晰,表达简洁明了
## 🎉 特别感谢
感谢所有为WhaleTown项目文档贡献的开发者
### 文档贡献者
- 项目架构设计和文档框架搭建
- 开发规范制定和最佳实践总结
- 技术实现指南和代码模板编写
- 测试用例设计和质量保证
### 持续改进
我们致力于打造最好用的游戏开发文档系统,欢迎提供反馈和建议!
---
## 📞 获取帮助
- **文档问题**: 查看 [CHANGELOG.md](CHANGELOG.md) 了解最新更新
- **技术问题**: 参考对应的技术实现文档
- **最佳实践**: 查阅开发规范和高级开发指南
- **部署问题**: 参考部署运维文档
**💡 提示**: 建议将本导航页面加入书签,方便随时查阅!
---
**文档版本**: v1.1.0
**最后更新**: 2025-12-31
**文档质量**: A级 ⭐⭐⭐⭐⭐

View File

@@ -1,251 +0,0 @@
# 最终更新总结
**完成日期**: 2025-12-25
**更新内容**: AuthScene文件修复 + Python API测试工具
---
## 🎯 完成的工作
### 1. ✅ AuthScene.gd 文件修复
#### 问题解决
- **修复Parser Error**: 删除了第1196行的语法错误"母和数字"
- **重构代码结构**: 完全重写了AuthScene.gd代码更清晰、更易维护
- **优化验证逻辑**: 使用StringUtils工具类统一处理表单验证
#### 文件状态
- **语法检查**: ✅ No diagnostics found
- **代码行数**: 约600行原来~1400行精简57%
- **功能完整性**: ✅ 保持所有原有功能
- **API兼容性**: ✅ 完全支持API v1.1.1
### 2. ✅ Python API测试工具
#### 创建的测试脚本
1. **`quick_test.py`** - 快速测试脚本(推荐日常使用)
2. **`api_client_test.py`** - 完整测试套件(全面功能验证)
3. **`requirements.txt`** - Python依赖配置
4. **`run_tests.bat`** - Windows批处理脚本
5. **`run_tests.sh`** - Linux/Mac Shell脚本
#### 测试覆盖范围
- ✅ 应用状态检查
- ✅ 用户认证流程(登录/注册)
- ✅ 邮箱验证流程
- ✅ 验证码功能(发送/验证)
- ✅ 密码重置流程
- ✅ 错误场景测试
- ✅ 频率限制测试
- ✅ API v1.1.1新特性测试
### 3. ✅ 文档更新
#### 新增文档
- **`docs/testing_guide.md`** - 完整的API测试指南
- **`docs/final_update_summary.md`** - 本总结文档
- **`tests/api/README.md`** - 更新了测试说明
#### 更新文档
- **`docs/api_update_log.md`** - API更新日志
- **`docs/cleanup_summary.md`** - 代码清理总结
---
## 🔧 技术改进
### AuthScene.gd 优化
```gdscript
# 优化前的问题
-
-
-
# 优化后的改进
-
- 使StringUtils统一验证
-
```
### API测试工具特性
```python
# 完整的API客户端
class APIClient:
- 统一的请求处理
- 详细的错误处理
- 支持所有API端点
- 自动状态码判断
# 智能测试结果
class TestResult:
- 成功/失败判断
- 执行时间统计
- 详细错误信息
- 特殊状态码处理
```
---
## 📊 测试验证
### 语法检查结果
```bash
✅ scripts/scenes/AuthScene.gd - No diagnostics found
✅ core/managers/NetworkManager.gd - No diagnostics found
✅ core/managers/ResponseHandler.gd - No diagnostics found
```
### Python测试工具验证
```bash
# 快速测试
python tests/api/quick_test.py
# 预期结果: 6个基础API测试通过
# 完整测试
python tests/api/api_client_test.py
# 预期结果: 完整业务流程测试通过
```
---
## 🎯 使用指南
### 开发者日常使用
#### 1. 快速API测试
```bash
cd tests/api
python quick_test.py
```
#### 2. 完整功能验证
```bash
cd tests/api
python api_client_test.py
```
#### 3. Windows用户
```bash
cd tests/api
run_tests.bat
```
#### 4. Linux/Mac用户
```bash
cd tests/api
./run_tests.sh
```
### Godot开发者使用
#### 1. 运行AuthScene
- 场景文件正常加载
- Toast系统正常工作
- 网络请求正常处理
#### 2. API测试脚本
```gdscript
# 在Godot中运行
var api_test = preload("res://scripts/network/ApiTestScript.gd").new()
add_child(api_test)
```
---
## 🔍 质量保证
### 代码质量指标
| 指标 | 修复前 | 修复后 | 改进 |
|------|--------|--------|------|
| 语法错误 | 1个 | 0个 | ✅ 完全修复 |
| 代码行数 | ~1400行 | ~600行 | ✅ 精简57% |
| 重复代码 | 多处 | 无 | ✅ 完全消除 |
| 可维护性 | 中等 | 高 | ✅ 显著提升 |
### 功能完整性
- ✅ 登录功能完整保留
- ✅ 注册功能完整保留
- ✅ 验证码功能完整保留
- ✅ Toast显示功能增强
- ✅ 错误处理功能增强
### API兼容性
- ✅ 支持409冲突检测
- ✅ 支持206测试模式
- ✅ 支持429频率限制
- ✅ 支持所有新增错误码
- ✅ 向后兼容旧版本
---
## 📈 项目收益
### 开发效率提升
1. **无需Godot引擎**: Python测试脚本可独立运行
2. **快速验证**: 30秒内完成基础API测试
3. **自动化支持**: 可集成到CI/CD流程
4. **跨平台支持**: Windows/Linux/Mac都可使用
### 代码质量提升
1. **消除语法错误**: AuthScene.gd现在完全可用
2. **减少代码重复**: 使用工具类统一处理
3. **提高可维护性**: 清晰的代码结构和注释
4. **增强错误处理**: 支持最新API规范
### 测试覆盖提升
1. **完整业务流程**: 覆盖所有用户操作场景
2. **错误场景测试**: 验证各种异常情况
3. **性能测试**: 包含频率限制测试
4. **兼容性测试**: 支持不同环境测试
---
## 🚀 后续建议
### 短期优化
1. **集成CI/CD**: 将Python测试脚本集成到自动化流程
2. **监控告警**: 设置API测试失败的通知机制
3. **性能基准**: 建立API响应时间基准线
### 长期规划
1. **测试扩展**: 添加更多边界条件测试
2. **压力测试**: 开发高并发场景测试
3. **安全测试**: 添加安全漏洞检测测试
---
## 📚 相关资源
### 文档链接
- [API文档](api-documentation.md) - 完整API接口说明
- [测试指南](testing_guide.md) - 详细测试使用指南
- [API更新日志](api_update_log.md) - 最新变更记录
### 代码文件
- `scripts/scenes/AuthScene.gd` - 修复后的认证场景
- `tests/api/quick_test.py` - 快速API测试脚本
- `tests/api/api_client_test.py` - 完整API测试套件
### 工具脚本
- `tests/api/run_tests.bat` - Windows测试启动器
- `tests/api/run_tests.sh` - Linux/Mac测试启动器
---
## 🎉 总结
通过这次更新,我们成功:
1. **修复了关键问题** - AuthScene.gd的Parser Error已完全解决
2. **提升了代码质量** - 代码更清晰、更易维护、更高效
3. **增强了测试能力** - 提供了完整的Python API测试工具
4. **改善了开发体验** - 无需Godot引擎即可测试API接口
5. **保证了向后兼容** - 所有原有功能都得到保留和增强
现在开发者可以:
- ✅ 正常使用AuthScene.gd进行认证界面开发
- ✅ 使用Python脚本快速验证API接口
- ✅ 在任何环境下进行API测试
- ✅ 享受更好的错误处理和用户体验
**项目现在处于完全可用状态支持最新的API v1.1.1规范!** 🚀

View File

@@ -1,505 +0,0 @@
# Godot 项目结构说明
本文档详细说明了 whaleTown 项目的文件结构设计,采用"场景+通用工具+其他"的架构模式,确保每个场景清晰独立且高度解耦。
## 设计理念
### 核心原则
- **场景独立性**:每个场景都是独立的功能模块,可以单独开发和测试
- **高度解耦**:场景之间通过事件系统和管理器进行通信,避免直接依赖
- **组件复用**:可复用的组件放在通用模块中,提高开发效率
- **资源管理**:统一的资源管理和命名规范,便于维护
## 项目架构概览
```
whaleTown/
├── 🎬 scenes/ # 场景层:独立的游戏场景
├── 🔧 core/ # 核心层:通用工具和系统
├── 🎨 assets/ # 资源层:静态资源文件
├── 📊 data/ # 数据层:配置和游戏数据
├── 📝 scripts/ # 脚本层:业务逻辑代码
├── 🧩 module/ # 模块层:可复用组件
├── 🧪 tests/ # 测试层:单元测试和集成测试
└── 📚 docs/ # 文档层:项目文档
```
## 1. 场景层 (scenes/)
场景层包含所有独立的游戏场景,每个场景都是完整的功能模块。
### 1.1 场景分类
#### 主要场景 (Main Scenes)
```
scenes/
├── main_scene.tscn # 主场景:游戏入口
├── auth_scene.tscn # 认证场景:登录注册
├── menu_scene.tscn # 菜单场景:主菜单界面
├── game_scene.tscn # 游戏场景:主要游戏玩法
├── battle_scene.tscn # 战斗场景:战斗系统
├── inventory_scene.tscn # 背包场景:物品管理
├── shop_scene.tscn # 商店场景:购买系统
└── settings_scene.tscn # 设置场景:游戏设置
```
#### 预制体场景 (Prefabs)
```
scenes/prefabs/
├── ui/
│ ├── dialog_prefab.tscn # 对话框预制体
│ ├── button_prefab.tscn # 按钮预制体
│ ├── health_bar_prefab.tscn # 血条预制体
│ └── notification_prefab.tscn # 通知预制体
├── characters/
│ ├── player_prefab.tscn # 玩家角色预制体
│ ├── npc_prefab.tscn # NPC预制体
│ └── enemy_prefab.tscn # 敌人预制体
├── items/
│ ├── weapon_prefab.tscn # 武器预制体
│ ├── consumable_prefab.tscn # 消耗品预制体
│ └── collectible_prefab.tscn # 收集品预制体
└── effects/
├── explosion_prefab.tscn # 爆炸特效预制体
├── particle_prefab.tscn # 粒子特效预制体
└── damage_text_prefab.tscn # 伤害数字预制体
```
### 1.2 场景设计原则
- **单一职责**:每个场景只负责一个主要功能
- **独立运行**:场景可以独立启动和测试
- **标准接口**:场景间通过标准化接口通信
- **资源隔离**:场景相关资源放在对应子目录
## 2. 核心层 (core/)
核心层提供通用的工具类、管理器和系统组件,为整个项目提供基础服务。
### 2.1 核心系统结构
```
core/
├── managers/ # 管理器系统
│ ├── GameManager.gd # 游戏管理器:全局游戏状态
│ ├── SceneManager.gd # 场景管理器:场景切换
│ ├── AudioManager.gd # 音频管理器:音效音乐
│ ├── InputManager.gd # 输入管理器:输入处理
│ ├── SaveManager.gd # 存档管理器:数据存储
│ ├── UIManager.gd # UI管理器界面管理
│ └── NetworkManager.gd # 网络管理器:网络通信
├── systems/ # 系统组件
│ ├── EventSystem.gd # 事件系统:全局事件
│ ├── StateMachine.gd # 状态机系统
│ ├── ObjectPool.gd # 对象池系统
│ ├── ResourceLoader.gd # 资源加载系统
│ └── LocalizationSystem.gd # 本地化系统
├── utils/ # 工具类
│ ├── MathUtils.gd # 数学工具
│ ├── StringUtils.gd # 字符串工具
│ ├── FileUtils.gd # 文件工具
│ ├── TimeUtils.gd # 时间工具
│ └── DebugUtils.gd # 调试工具
├── components/ # 通用组件
│ ├── HealthComponent.gd # 生命值组件
│ ├── MovementComponent.gd # 移动组件
│ ├── AnimationComponent.gd # 动画组件
│ └── CollisionComponent.gd # 碰撞组件
└── interfaces/ # 接口定义
├── IInteractable.gd # 可交互接口
├── IDamageable.gd # 可受伤接口
├── ICollectable.gd # 可收集接口
└── ISaveable.gd # 可存储接口
```
### 2.2 核心系统职责
#### 管理器 (Managers)
- **单例模式**:全局唯一实例
- **生命周期管理**:负责系统初始化和清理
- **状态维护**:维护全局状态信息
- **服务提供**:为其他模块提供服务
#### 系统组件 (Systems)
- **功能封装**:封装特定功能逻辑
- **可插拔设计**:可以独立启用或禁用
- **事件驱动**:通过事件系统通信
- **性能优化**:提供高效的实现方案
## 3. 模块层 (module/)
模块层包含可复用的功能模块,这些模块可以在不同场景中重复使用。
### 3.1 模块分类
```
module/
├── UI/ # UI模块
│ ├── components/ # UI组件
│ │ ├── Button/ # 按钮组件
│ │ │ ├── CustomButton.gd
│ │ │ └── custom_button.tscn
│ │ ├── Dialog/ # 对话框组件
│ │ │ ├── DialogBox.gd
│ │ │ └── dialog_box.tscn
│ │ ├── ProgressBar/ # 进度条组件
│ │ │ ├── CustomProgressBar.gd
│ │ │ └── custom_progress_bar.tscn
│ │ └── InputField/ # 输入框组件
│ │ ├── CustomInputField.gd
│ │ └── custom_input_field.tscn
│ ├── layouts/ # 布局组件
│ │ ├── GridLayout.gd
│ │ ├── FlexLayout.gd
│ │ └── ResponsiveLayout.gd
│ └── animations/ # UI动画
│ ├── FadeTransition.gd
│ ├── SlideTransition.gd
│ └── ScaleTransition.gd
├── Character/ # 角色模块
│ ├── Player/ # 玩家角色
│ │ ├── PlayerController.gd
│ │ ├── PlayerStats.gd
│ │ └── PlayerAnimator.gd
│ ├── NPC/ # NPC角色
│ │ ├── NPCController.gd
│ │ ├── NPCDialogue.gd
│ │ └── NPCBehavior.gd
│ └── Enemy/ # 敌人角色
│ ├── EnemyAI.gd
│ ├── EnemyStats.gd
│ └── EnemyBehavior.gd
├── Inventory/ # 背包模块
│ ├── InventorySystem.gd
│ ├── Item.gd
│ ├── ItemSlot.gd
│ └── ItemDatabase.gd
├── Combat/ # 战斗模块
│ ├── CombatSystem.gd
│ ├── Weapon.gd
│ ├── Skill.gd
│ └── DamageCalculator.gd
└── Dialogue/ # 对话模块
├── DialogueSystem.gd
├── DialogueNode.gd
├── DialogueParser.gd
└── DialogueUI.gd
```
### 3.2 模块设计原则
- **高内聚**:模块内部功能紧密相关
- **低耦合**:模块间依赖最小化
- **可配置**:通过配置文件自定义行为
- **可扩展**:支持功能扩展和定制
## 4. 资源层 (assets/)
资源层统一管理所有静态资源文件,采用分类存储和标准化命名。
### 4.1 资源目录结构
```
assets/
├── sprites/ # 精灵图资源
│ ├── characters/ # 角色精灵
│ │ ├── player/
│ │ │ ├── sprite_player_idle.png
│ │ │ ├── sprite_player_walk.png
│ │ │ └── sprite_player_attack.png
│ │ ├── enemies/
│ │ │ ├── sprite_enemy_goblin_idle.png
│ │ │ └── sprite_enemy_orc_walk.png
│ │ └── npcs/
│ │ ├── sprite_npc_merchant.png
│ │ └── sprite_npc_guard.png
│ ├── ui/ # UI精灵
│ │ ├── buttons/
│ │ │ ├── ui_button_normal.png
│ │ │ ├── ui_button_hover.png
│ │ │ └── ui_button_pressed.png
│ │ ├── icons/
│ │ │ ├── icon_sword.png
│ │ │ ├── icon_shield.png
│ │ │ └── icon_potion.png
│ │ └── panels/
│ │ ├── ui_panel_main.png
│ │ └── ui_panel_dialog.png
│ ├── environment/ # 环境精灵
│ │ ├── backgrounds/
│ │ │ ├── bg_forest.png
│ │ │ └── bg_dungeon.png
│ │ ├── tiles/
│ │ │ ├── tile_grass_01.png
│ │ │ └── tile_stone_01.png
│ │ └── objects/
│ │ ├── obj_tree.png
│ │ └── obj_rock.png
│ └── effects/ # 特效精灵
│ ├── fx_explosion.png
│ ├── fx_magic_circle.png
│ └── fx_damage_numbers.png
├── audio/ # 音频资源
│ ├── music/ # 背景音乐
│ │ ├── music_main_menu.ogg
│ │ ├── music_battle.ogg
│ │ └── music_peaceful.ogg
│ ├── sounds/ # 音效
│ │ ├── ui/
│ │ │ ├── sound_button_click.wav
│ │ │ └── sound_menu_open.wav
│ │ ├── combat/
│ │ │ ├── sound_sword_hit.wav
│ │ │ └── sound_explosion.wav
│ │ └── ambient/
│ │ ├── sound_footsteps.wav
│ │ └── sound_wind.wav
│ └── voice/ # 语音
│ ├── voice_npc_greeting.wav
│ └── voice_player_hurt.wav
├── fonts/ # 字体资源
│ ├── font_main.ttf # 主要字体
│ ├── font_title.ttf # 标题字体
│ └── font_ui.ttf # UI字体
├── materials/ # 材质资源
│ ├── material_metal.tres
│ ├── material_wood.tres
│ └── material_water.tres
└── shaders/ # 着色器资源
├── shader_water.gdshader
├── shader_fire.gdshader
└── shader_outline.gdshader
```
### 4.2 资源命名规范
#### 图片资源命名
- **精灵图**`sprite_[类别]_[名称]_[状态].png`
- 示例:`sprite_player_idle.png``sprite_enemy_goblin_walk.png`
- **UI图片**`ui_[类型]_[名称]_[状态].png`
- 示例:`ui_button_normal.png``ui_panel_main.png`
- **图标**`icon_[名称].png`
- 示例:`icon_sword.png``icon_health.png`
- **背景**`bg_[场景名称].png`
- 示例:`bg_forest.png``bg_dungeon.png`
- **瓦片**`tile_[材质]_[编号].png`
- 示例:`tile_grass_01.png``tile_stone_02.png`
#### 音频资源命名
- **音乐**`music_[场景/情境].ogg`
- 示例:`music_battle.ogg``music_peaceful.ogg`
- **音效**`sound_[动作/事件].wav`
- 示例:`sound_jump.wav``sound_explosion.wav`
- **语音**`voice_[角色]_[内容].wav`
- 示例:`voice_npc_greeting.wav``voice_player_hurt.wav`
#### 其他资源命名
- **字体**`font_[用途].ttf`
- 示例:`font_main.ttf``font_title.ttf`
- **材质**`material_[材质名].tres`
- 示例:`material_metal.tres``material_wood.tres`
- **着色器**`shader_[效果名].gdshader`
- 示例:`shader_water.gdshader``shader_fire.gdshader`
## 5. 脚本层 (scripts/)
脚本层包含所有业务逻辑代码,按功能模块组织。
### 5.1 脚本目录结构
```
scripts/
├── scenes/ # 场景脚本
│ ├── MainScene.gd # 主场景脚本
│ ├── AuthScene.gd # 认证场景脚本
│ ├── GameScene.gd # 游戏场景脚本
│ └── BattleScene.gd # 战斗场景脚本
├── ui/ # UI脚本
│ ├── MainMenu.gd # 主菜单脚本
│ ├── SettingsPanel.gd # 设置面板脚本
│ ├── InventoryUI.gd # 背包界面脚本
│ └── DialogueUI.gd # 对话界面脚本
├── characters/ # 角色脚本
│ ├── PlayerController.gd # 玩家控制器
│ ├── EnemyAI.gd # 敌人AI
│ └── NPCBehavior.gd # NPC行为
├── gameplay/ # 游戏玩法脚本
│ ├── CombatSystem.gd # 战斗系统
│ ├── QuestSystem.gd # 任务系统
│ ├── InventorySystem.gd # 背包系统
│ └── DialogueSystem.gd # 对话系统
├── network/ # 网络脚本
│ ├── NetworkClient.gd # 网络客户端
│ ├── NetworkServer.gd # 网络服务器
│ └── NetworkProtocol.gd # 网络协议
└── data/ # 数据脚本
├── GameData.gd # 游戏数据
├── PlayerData.gd # 玩家数据
├── ItemData.gd # 物品数据
└── ConfigData.gd # 配置数据
```
## 6. 数据层 (data/)
数据层存储游戏配置、关卡数据和其他静态数据文件。
### 6.1 数据目录结构
```
data/
├── configs/ # 配置文件
│ ├── game_config.json # 游戏配置
│ ├── audio_config.json # 音频配置
│ ├── input_config.json # 输入配置
│ └── graphics_config.json # 图形配置
├── levels/ # 关卡数据
│ ├── level_01.json # 第一关数据
│ ├── level_02.json # 第二关数据
│ └── level_boss.json # Boss关数据
├── items/ # 物品数据
│ ├── weapons.json # 武器数据
│ ├── armor.json # 装备数据
│ └── consumables.json # 消耗品数据
├── characters/ # 角色数据
│ ├── player_stats.json # 玩家属性
│ ├── enemy_stats.json # 敌人属性
│ └── npc_data.json # NPC数据
├── dialogues/ # 对话数据
│ ├── main_story.json # 主线对话
│ ├── side_quests.json # 支线对话
│ └── npc_dialogues.json # NPC对话
└── localization/ # 本地化数据
├── en.json # 英文文本
├── zh_CN.json # 简体中文文本
└── zh_TW.json # 繁体中文文本
```
## 7. 测试层 (tests/)
测试层包含单元测试、集成测试和功能测试。
### 7.1 测试目录结构
```
tests/
├── unit/ # 单元测试
│ ├── test_player_controller.gd
│ ├── test_inventory_system.gd
│ └── test_combat_system.gd
├── integration/ # 集成测试
│ ├── test_scene_transitions.gd
│ ├── test_save_load.gd
│ └── test_network_sync.gd
├── ui/ # UI测试
│ ├── test_main_menu.gd
│ ├── test_inventory_ui.gd
│ └── test_dialogue_ui.gd
└── performance/ # 性能测试
├── test_memory_usage.gd
├── test_frame_rate.gd
└── test_loading_times.gd
```
## 8. 场景间通信机制
### 8.1 事件系统
使用全局事件系统实现场景间的松耦合通信:
```gdscript
# 事件定义示例
signal player_health_changed(new_health: int)
signal scene_transition_requested(scene_name: String)
signal item_collected(item_id: String)
signal quest_completed(quest_id: String)
# 事件发送
EventSystem.emit_signal("player_health_changed", 80)
# 事件监听
EventSystem.connect("player_health_changed", _on_player_health_changed)
```
### 8.2 管理器模式
通过单例管理器实现全局状态管理:
```gdscript
# 场景切换
SceneManager.change_scene("battle_scene")
# 音频播放
AudioManager.play_sound("sound_button_click")
# 数据保存
SaveManager.save_game_data(player_data)
```
## 9. 开发工作流
### 9.1 新场景开发流程
1. **创建场景文件**:在 `scenes/` 目录创建 `.tscn` 文件
2. **编写场景脚本**:在 `scripts/scenes/` 创建对应脚本
3. **添加UI组件**:使用 `module/UI/` 中的可复用组件
4. **配置场景数据**:在 `data/` 目录添加相关配置
5. **编写测试用例**:在 `tests/` 目录添加测试
6. **更新文档**:更新相关文档说明
### 9.2 新功能模块开发流程
1. **设计模块接口**:定义模块的公共接口
2. **实现核心逻辑**:在 `module/` 目录实现功能
3. **添加管理器支持**:在 `core/managers/` 添加管理器
4. **创建测试场景**:创建独立的测试场景
5. **集成到主项目**:将模块集成到现有场景
6. **性能优化**:进行性能测试和优化
## 10. 最佳实践
### 10.1 代码组织
- **单一职责**:每个类只负责一个功能
- **依赖注入**:通过构造函数或属性注入依赖
- **接口隔离**:使用接口定义模块间的契约
- **配置外置**:将配置信息放在数据文件中
### 10.2 性能优化
- **对象池**:复用频繁创建的对象
- **延迟加载**:按需加载资源和场景
- **批量处理**:合并相似的操作
- **内存管理**:及时释放不需要的资源
### 10.3 调试和测试
- **单元测试**:为核心逻辑编写单元测试
- **集成测试**:测试模块间的交互
- **性能监控**监控内存和CPU使用情况
- **日志记录**:记录关键操作和错误信息
## 11. 扩展指南
### 11.1 添加新场景
1.`scenes/` 目录创建场景文件
2.`scripts/scenes/` 创建场景脚本
3.`SceneManager` 中注册新场景
4. 添加场景切换逻辑
### 11.2 添加新模块
1.`module/` 目录创建模块文件夹
2. 实现模块的核心功能
3. 创建模块管理器(如需要)
4. 编写模块文档和示例
### 11.3 添加新资源类型
1.`assets/` 目录创建对应分类
2. 更新命名规范文档
3. 在资源加载器中添加支持
4. 更新导入设置
---
## 总结
这个项目结构设计遵循了模块化、可扩展、易维护的原则。通过清晰的分层架构和标准化的命名规范,确保了项目的可读性和可维护性。每个开发者都应该遵循这个结构进行开发,以保持项目的一致性和质量。
如有任何疑问或建议,请参考相关文档或联系项目维护者。

View File

@@ -1,28 +0,0 @@
# 项目设置指南
## AutoLoad 配置
在 Godot 编辑器中设置 NetworkManager 为全局单例:
1. 打开 `Project``Project Settings`
2. 切换到 `AutoLoad` 标签
3. 添加新的 AutoLoad
- **Path**: `res://core/managers/NetworkManager.gd`
- **Name**: `NetworkManager`
- **Singleton**: ✅ 勾选
## 验证设置
在任何脚本中可以直接使用:
```gdscript
func _ready():
var request_id = NetworkManager.login("username", "password", callback)
print("请求ID: ", request_id)
```
## 注意事项
- 确保 NetworkManager.gd 和 ResponseHandler.gd 文件存在
- 重启 Godot 编辑器以确保 AutoLoad 生效
- 检查控制台是否有错误信息

View File

@@ -1,200 +0,0 @@
# Web部署更新日志
## v1.0.0 (2025-12-25)
### 🎉 初始版本
- 创建完整的Web导出解决方案
- 支持Windows、Linux、macOS平台
- 自动化构建和部署脚本
### 📁 文件结构
```
scripts/
├── build_web.bat # Windows导出脚本
├── build_web.sh # Linux/macOS导出脚本
├── serve_web.bat # Windows本地服务器
└── serve_web.sh # Linux/macOS本地服务器
docs/
├── web_deployment_guide.md # 完整部署指南
└── web_deployment_changelog.md # 更新日志
```
### ✨ 主要特性
#### 自动化导出
- 智能检测Godot安装路径
- 验证项目文件完整性
- 自动备份旧版本
- 生成部署配置文件
- 文件大小统计和优化建议
#### 本地测试服务器
- 自动端口检测和冲突处理
- 支持局域网访问
- 实时文件监控
- 自动打开浏览器
- 详细的调试信息
#### 服务器配置
- Apache .htaccess自动生成
- Nginx配置示例
- MIME类型配置
- CORS头设置
- 文件压缩优化
- 缓存策略配置
#### 部署优化
- 资源文件压缩
- 渐进式Web应用支持
- 性能监控
- 错误诊断工具
### 🔧 技术规格
#### 支持的平台
- **开发环境**: Windows 10+, macOS 10.15+, Ubuntu 18.04+
- **目标浏览器**: Chrome 80+, Firefox 75+, Safari 13+, Edge 80+
- **Godot版本**: 4.5+
#### 系统要求
- **Godot Engine**: 4.5或更高版本
- **Python**: 3.6+(用于本地测试)
- **磁盘空间**: 至少100MB可用空间
- **内存**: 建议4GB以上
#### 网络要求
- **带宽**: 建议10Mbps以上用于资源下载
- **端口**: 8000默认8080备用
- **协议**: HTTP/HTTPS
### 📋 配置选项
#### 导出设置
```
导出预设: Web
渲染方法: gl_compatibility
纹理压缩: 启用VRAM压缩
文件格式: WASM + PCK
```
#### 服务器设置
```
默认端口: 8000
备用端口: 8080
文档根目录: build/web/
索引文件: index.html
```
### 🚀 性能优化
#### 文件大小优化
- WASM文件压缩率: ~30%
- 纹理压缩: ETC2/ASTC格式
- 音频压缩: OGG Vorbis
- 脚本压缩: 移除调试信息
#### 加载速度优化
- 启用Gzip压缩
- 设置缓存策略
- 使用CDN加速
- 实现预加载机制
### 🛡️ 安全特性
#### 跨域安全
- CORS头配置
- CSP策略设置
- XSS防护
- 点击劫持防护
#### 文件安全
- MIME类型验证
- 文件大小限制
- 路径遍历防护
- 敏感文件隐藏
### 📊 监控和诊断
#### 构建监控
- 文件完整性检查
- 大小统计分析
- 构建时间记录
- 错误日志收集
#### 运行时监控
- 性能指标收集
- 错误报告系统
- 用户行为分析
- 网络请求监控
### 🔄 兼容性
#### 浏览器兼容性
| 浏览器 | 最低版本 | 推荐版本 | 支持特性 |
|--------|----------|----------|----------|
| Chrome | 80 | 最新 | 完整支持 |
| Firefox | 75 | 最新 | 完整支持 |
| Safari | 13 | 最新 | 基本支持 |
| Edge | 80 | 最新 | 完整支持 |
#### 移动端兼容性
- iOS Safari 13+
- Android Chrome 80+
- 响应式设计支持
- 触摸操作优化
### 📝 已知问题
#### 当前限制
1. **文件系统访问**: Web版本无法直接访问本地文件系统
2. **性能差异**: 相比原生版本可能有10-30%的性能损失
3. **内存限制**: 受浏览器内存限制影响
4. **网络依赖**: 需要稳定的网络连接
#### 解决方案
1. 使用IndexedDB存储本地数据
2. 优化资源和代码以提升性能
3. 实现内存管理和垃圾回收
4. 添加离线缓存支持
### 🔮 未来计划
#### v1.1.0 (计划中)
- [ ] PWA渐进式Web应用完整支持
- [ ] 离线模式实现
- [ ] 自动更新机制
- [ ] 性能分析工具
#### v1.2.0 (计划中)
- [ ] WebRTC多人游戏支持
- [ ] WebGL 2.0优化
- [ ] 移动端手势优化
- [ ] 云存档同步
#### v2.0.0 (远期计划)
- [ ] WebAssembly SIMD支持
- [ ] Web Workers多线程
- [ ] WebXR虚拟现实支持
- [ ] 边缘计算集成
### 📞 技术支持
#### 问题报告
如遇到问题,请提供以下信息:
1. 操作系统和版本
2. 浏览器类型和版本
3. Godot版本
4. 错误日志和截图
5. 复现步骤
#### 联系方式
- 项目文档: `docs/web_deployment_guide.md`
- 构建日志: `build/web/server.log`
- 部署信息: `build/web/deploy_info.json`
---
**维护者**: 鲸鱼镇开发团队
**最后更新**: 2025-12-25
**文档版本**: 1.0.0

View File

@@ -11,7 +11,7 @@ config_version=5
[application]
config/name="whaleTown"
run/main_scene="res://Scenes/Maps/main_scene.tscn"
run/main_scene="res://scenes/MainScene.tscn"
config/features=PackedStringArray("4.5", "Forward Plus")
config/icon="res://icon.svg"
@@ -39,6 +39,43 @@ window/stretch/aspect="expand"
theme/custom="uid://cp7t8tu7rmyad"
[input]
move_left={
"deadzone": 0.5,
"events": [Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":65,"key_label":0,"unicode":97,"location":0,"echo":false,"script":null)
, Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":4194319,"key_label":0,"unicode":0,"location":0,"echo":false,"script":null)
]
}
move_right={
"deadzone": 0.5,
"events": [Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":68,"key_label":0,"unicode":100,"location":0,"echo":false,"script":null)
, Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":4194321,"key_label":0,"unicode":0,"location":0,"echo":false,"script":null)
]
}
move_up={
"deadzone": 0.5,
"events": [Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":87,"key_label":0,"unicode":119,"location":0,"echo":false,"script":null)
, Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":4194320,"key_label":0,"unicode":0,"location":0,"echo":false,"script":null)
]
}
move_down={
"deadzone": 0.5,
"events": [Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":83,"key_label":0,"unicode":115,"location":0,"echo":false,"script":null)
, Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":4194322,"key_label":0,"unicode":0,"location":0,"echo":false,"script":null)
]
}
jump={
"deadzone": 0.5,
"events": [Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":32,"key_label":0,"unicode":32,"location":0,"echo":false,"script":null)
]
}
interact={
"deadzone": 0.5,
"events": [Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":69,"key_label":0,"unicode":101,"location":0,"echo":false,"script":null)
]
}
[internationalization]
locale/test="zh_CN"
@@ -49,3 +86,5 @@ renderer/rendering_method="gl_compatibility"
renderer/rendering_method.mobile="gl_compatibility"
textures/vram_compression/import_etc2_astc=true
fonts/dynamic_fonts/use_oversampling=true
debug/disable_vsync=false
debug/settings/stdout/print_fps=false

Some files were not shown because too many files have changed in this diff Show More