Compare commits
10 Commits
feature/lo
...
c0f5d6a537
| Author | SHA1 | Date | |
|---|---|---|---|
| c0f5d6a537 | |||
| 0b6b1c2040 | |||
| 8d071cb2ed | |||
| 370cffbdd8 | |||
| 5b67771bbc | |||
| 73478c0500 | |||
| 15548ebb52 | |||
| 47cfc14f68 | |||
| c6bcca4e7f | |||
| f11479f2cc |
@@ -1,13 +0,0 @@
|
|||||||
{
|
|
||||||
"permissions": {
|
|
||||||
"allow": [
|
|
||||||
"WebFetch(domain:whaletownend.xinghangee.icu)",
|
|
||||||
"mcp__ide__getDiagnostics",
|
|
||||||
"Bash(dir /s /b *.gd)",
|
|
||||||
"Bash(findstr:*)",
|
|
||||||
"Bash(del nul)",
|
|
||||||
"Bash(git checkout:*)",
|
|
||||||
"Bash(git add:*)"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
55
.gitignore
vendored
55
.gitignore
vendored
@@ -1,3 +1,58 @@
|
|||||||
# Godot 4+ specific ignores
|
# Godot 4+ specific ignores
|
||||||
.godot/
|
.godot/
|
||||||
/android/
|
/android/
|
||||||
|
|
||||||
|
# Python cache files
|
||||||
|
__pycache__/
|
||||||
|
*.pyc
|
||||||
|
*.pyo
|
||||||
|
*.pyd
|
||||||
|
.Python
|
||||||
|
*.so
|
||||||
|
|
||||||
|
# IDE and editor files
|
||||||
|
.vscode/
|
||||||
|
.idea/
|
||||||
|
*.swp
|
||||||
|
*.swo
|
||||||
|
*~
|
||||||
|
|
||||||
|
# OS generated files
|
||||||
|
.DS_Store
|
||||||
|
.DS_Store?
|
||||||
|
._*
|
||||||
|
.Spotlight-V100
|
||||||
|
.Trashes
|
||||||
|
ehthumbs.db
|
||||||
|
Thumbs.db
|
||||||
|
|
||||||
|
# Godot executable files (should not be in version control)
|
||||||
|
Godot/
|
||||||
|
*.exe
|
||||||
|
*.app
|
||||||
|
*.dmg
|
||||||
|
|
||||||
|
# Logs and temporary files
|
||||||
|
*.log
|
||||||
|
*.tmp
|
||||||
|
*.temp
|
||||||
|
|
||||||
|
# Build outputs
|
||||||
|
build/
|
||||||
|
dist/
|
||||||
|
*.zip
|
||||||
|
*.tar.gz
|
||||||
|
|
||||||
|
# Environment files
|
||||||
|
.env
|
||||||
|
.env.local
|
||||||
|
.env.*.local
|
||||||
|
|
||||||
|
# Test coverage reports
|
||||||
|
coverage/
|
||||||
|
*.coverage
|
||||||
|
.nyc_output/
|
||||||
|
|
||||||
|
# Dependency directories
|
||||||
|
node_modules/
|
||||||
|
vendor/
|
||||||
|
|||||||
15
.vscode/launch.json
vendored
15
.vscode/launch.json
vendored
@@ -1,15 +0,0 @@
|
|||||||
{
|
|
||||||
"version": "0.2.0",
|
|
||||||
"configurations": [
|
|
||||||
{
|
|
||||||
"name": "GDScript Godot",
|
|
||||||
"type": "godot",
|
|
||||||
"request": "launch",
|
|
||||||
"project": "${workspaceFolder}",
|
|
||||||
"port": 6007,
|
|
||||||
"address": "127.0.0.1",
|
|
||||||
"launch_game_instance": true,
|
|
||||||
"launch_scene": false
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
3
.vscode/settings.json
vendored
3
.vscode/settings.json
vendored
@@ -1,3 +0,0 @@
|
|||||||
{
|
|
||||||
"godotTools.editorPath.godot4": "d:\\software\\godot\\Godot_v4.5.1-stable_win64.exe"
|
|
||||||
}
|
|
||||||
412
README.md
412
README.md
@@ -1,101 +1,377 @@
|
|||||||
# whaleTown
|
# 🐋 Whale Town - 像素游戏前端客户端
|
||||||
|
|
||||||
一个使用 Godot 4.5 引擎开发的游戏项目。
|
> 一个基于 Godot 4.5 引擎开发的现代化 2D 像素风游戏前端，采用模块化架构设计，集成完整的用户认证系统、实时通信和游戏核心功能。
|
||||||
|
|
||||||
## 项目信息
|
[](https://godotengine.org/)
|
||||||
|
[](https://docs.godotengine.org/en/stable/tutorials/scripting/gdscript/index.html)
|
||||||
|
[](./LICENSE)
|
||||||
|
[](https://godotengine.org/download)
|
||||||
|
|
||||||
- **引擎版本**: Godot 4.5
|
## 🎯 项目简介
|
||||||
- **渲染器**: Forward Plus
|
|
||||||
- **项目类型**: 2D 游戏
|
|
||||||
|
|
||||||
## 项目结构
|
Whale Town 是一个功能完整的像素游戏前端客户端，采用模块化架构设计：
|
||||||
|
|
||||||
|
- 🔐 **用户认证系统** - 完整的登录、注册、密码管理、邮箱验证界面
|
||||||
|
- 🎮 **游戏核心功能** - 角色系统、战斗系统、对话系统、背包系统
|
||||||
|
- 🌐 **实时通信** - WebSocket集成，支持实时多人交互
|
||||||
|
- 🎨 **现代化UI** - 响应式界面设计，支持多分辨率适配
|
||||||
|
- 🧪 **完整测试体系** - UI测试、API测试、性能测试全覆盖
|
||||||
|
- 📱 **跨平台支持** - Windows、Linux、macOS、移动端
|
||||||
|
- 🔧 **模块化架构** - 高度解耦的组件系统，易于扩展和维护
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🚀 快速开始
|
||||||
|
|
||||||
|
### 📋 环境要求
|
||||||
|
|
||||||
|
- **Godot Engine** >= 4.5.0 (推荐 4.5.1)
|
||||||
|
- **Python** >= 3.7.0 (用于API测试，可选)
|
||||||
|
- **Git** >= 2.0.0
|
||||||
|
|
||||||
|
### 🛠️ 安装与运行
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 1. 克隆项目
|
||||||
|
git clone <repository-url>
|
||||||
|
cd whale-town
|
||||||
|
|
||||||
|
# 2. 使用Godot编辑器打开项目
|
||||||
|
# 双击 project.godot 文件或在Godot编辑器中导入项目
|
||||||
|
|
||||||
|
# 3. 运行项目
|
||||||
|
# 按F5或点击"运行"按钮启动游戏
|
||||||
|
```
|
||||||
|
|
||||||
|
🎉 **游戏启动成功！** 进入认证界面开始体验
|
||||||
|
|
||||||
|
### 🧪 快速测试
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# API接口测试
|
||||||
|
python tests/api/simple_api_test.py
|
||||||
|
|
||||||
|
# 完整功能测试
|
||||||
|
python tests/api/api_test.py --verbose
|
||||||
|
```
|
||||||
|
|
||||||
|
**测试内容：**
|
||||||
|
- ✅ 用户认证流程测试
|
||||||
|
- ✅ API接口连通性测试
|
||||||
|
- ✅ 错误处理和边界条件测试
|
||||||
|
- ✅ 网络通信功能测试
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🎓 新开发者指南
|
||||||
|
|
||||||
|
### 第一步：了解项目规范 📚
|
||||||
|
|
||||||
|
**⚠️ 重要：在开始开发前，请务必阅读以下文档**
|
||||||
|
|
||||||
|
1. **[项目结构详解](./docs/project_structure.md)** 🏗️
|
||||||
|
- 理解模块化架构设计
|
||||||
|
- 掌握目录组织规则
|
||||||
|
- 学习组件通信机制
|
||||||
|
|
||||||
|
2. **[命名规范](./docs/naming_convention.md)** 📝
|
||||||
|
- 场景、脚本、节点命名规则
|
||||||
|
- 资源文件命名标准
|
||||||
|
- 变量和函数命名约定
|
||||||
|
|
||||||
|
3. **[代码注释规范](./docs/code_comment_guide.md)** 💬
|
||||||
|
- 注释标准和最佳实践
|
||||||
|
- AI辅助开发指南
|
||||||
|
- 文档生成规范
|
||||||
|
|
||||||
|
4. **[Git提交规范](./docs/git_commit_guide.md)** 🔄
|
||||||
|
- 提交信息格式标准
|
||||||
|
- 分支管理策略
|
||||||
|
- 代码审查流程
|
||||||
|
|
||||||
|
### 第二步：熟悉项目架构 🏗️
|
||||||
|
|
||||||
```
|
```
|
||||||
whaleTown/
|
whaleTown/
|
||||||
├── addons/ # Godot 插件目录
|
├── 🎬 scenes/ # 游戏场景
|
||||||
├── assets/ # 游戏资源文件（图片、音频等）
|
│ ├── auth_scene.tscn # 🔐 用户认证场景
|
||||||
├── data/ # 游戏数据文件（配置、关卡数据等）
|
│ ├── main_scene.tscn # 🎮 主游戏场景
|
||||||
├── docs/ # 项目文档
|
│ └── prefabs/ # 🧩 预制体组件
|
||||||
├── scenes/ # 游戏场景文件
|
├── 🔧 core/ # 核心系统（自动加载）
|
||||||
│ └── main_scene.tscn # 主场景
|
│ ├── managers/ # 🎯 全局管理器
|
||||||
├── scripts/ # GDScript 脚本文件
|
│ ├── systems/ # ⚙️ 系统组件
|
||||||
├── tests/ # 测试文件
|
│ └── utils/ # 🛠️ 工具类
|
||||||
├── icon.svg # 项目图标
|
├── 📝 scripts/ # 业务逻辑脚本
|
||||||
└── project.godot # Godot 项目配置文件
|
│ ├── scenes/ # 🎬 场景脚本
|
||||||
|
│ ├── network/ # 🌐 网络相关
|
||||||
|
│ └── ui/ # 🎨 UI组件脚本
|
||||||
|
├── 🧩 module/ # 可复用模块
|
||||||
|
│ ├── UI/ # 🎨 UI组件模块
|
||||||
|
│ ├── Character/ # 👤 角色模块
|
||||||
|
│ ├── Combat/ # ⚔️ 战斗模块
|
||||||
|
│ ├── Dialogue/ # 💬 对话模块
|
||||||
|
│ └── Inventory/ # 🎒 背包模块
|
||||||
|
├── 🎨 assets/ # 游戏资源
|
||||||
|
│ ├── sprites/ # 🖼️ 精灵图资源
|
||||||
|
│ ├── audio/ # 🔊 音频文件
|
||||||
|
│ ├── ui/ # 🎨 UI界面资源
|
||||||
|
│ └── fonts/ # 🔤 字体资源
|
||||||
|
├── 📊 data/ # 配置数据
|
||||||
|
│ ├── configs/ # ⚙️ 游戏配置
|
||||||
|
│ ├── localization/ # 🌍 本地化文件
|
||||||
|
│ └── characters/ # 👤 角色数据
|
||||||
|
├── 🧪 tests/ # 测试文件
|
||||||
|
│ ├── api/ # 🔌 API接口测试
|
||||||
|
│ ├── auth/ # 🔐 认证UI测试
|
||||||
|
│ └── unit/ # 🧪 单元测试
|
||||||
|
└── 📚 docs/ # 项目文档
|
||||||
|
├── auth/ # 🔐 认证相关文档
|
||||||
|
└── api-documentation.md # 📖 API接口文档
|
||||||
```
|
```
|
||||||
|
|
||||||
## 开始使用
|
**架构特点：**
|
||||||
|
- 🏗️ **模块化设计** - 按功能而非技术组织代码
|
||||||
|
- 🔄 **事件驱动** - 通过EventSystem实现组件间通信
|
||||||
|
- 📦 **清晰分层** - 场景层 → 业务层 → 核心层
|
||||||
|
- 🧪 **测试友好** - 完整的测试覆盖和文档
|
||||||
|
|
||||||
### 前置要求
|
### 第三步：体验核心功能 🎮
|
||||||
|
|
||||||
- [Godot Engine 4.5](https://godotengine.org/download) 或更高版本
|
1. **用户认证系统** 🔐
|
||||||
|
- 邮箱验证码注册
|
||||||
|
- 多方式登录（用户名/邮箱/手机号）
|
||||||
|
- 密码重置功能
|
||||||
|
|
||||||
### 运行项目
|
2. **游戏核心系统** 🎮
|
||||||
|
- 场景管理和切换
|
||||||
|
- 角色状态管理
|
||||||
|
- 实时网络通信
|
||||||
|
|
||||||
1. 克隆或下载此项目
|
3. **开发工具** 🛠️
|
||||||
2. 使用 Godot 编辑器打开项目
|
- 内置测试场景
|
||||||
3. 在编辑器中点击"运行"按钮或按 F5 键启动游戏
|
- API测试脚本
|
||||||
|
- 性能监控工具
|
||||||
|
|
||||||
### 开发指南
|
### 第四步：开始贡献 🤝
|
||||||
|
|
||||||
- **场景文件**: 所有场景文件存放在 `scenes/` 目录
|
1. **Fork项目** 到你的账户
|
||||||
- **脚本文件**: 所有 GDScript 脚本存放在 `scripts/` 目录
|
2. **创建功能分支**：`git checkout -b feature/your-feature`
|
||||||
- **资源文件**: 图片、音频等资源存放在 `assets/` 目录
|
3. **遵循规范开发**（参考文档）
|
||||||
- **游戏数据**: 配置文件、关卡数据等存放在 `data/` 目录
|
4. **添加测试用例**：确保功能正确性
|
||||||
|
5. **提交代码**：`git commit -m "feat：添加新功能"`
|
||||||
|
6. **创建Pull Request**
|
||||||
|
|
||||||
### 命名规范
|
---
|
||||||
|
|
||||||
本项目遵循统一的命名规范以保持代码一致性：
|
## <20>[️ 技术栈
|
||||||
|
|
||||||
**核心规则**：
|
### 🎮 游戏引擎
|
||||||
|
- **Godot Engine** `4.5.1` - 开源游戏引擎，支持2D/3D开发
|
||||||
|
- **GDScript** - Godot专用脚本语言，Python风格语法
|
||||||
|
- **Forward Plus** - 现代渲染管线，支持高质量光照
|
||||||
|
|
||||||
- **场景文件**：`下划线_scene.tscn` 或 `下划线_prefab.tscn`
|
### 🏗️ 架构设计
|
||||||
- 示例：`main_scene.tscn`、`player_prefab.tscn`
|
- **模块化架构** - 按功能组织的可复用组件系统
|
||||||
- **脚本文件**：`PascalCase.gd`（大驼峰）
|
- **事件驱动** - 基于EventSystem的松耦合通信
|
||||||
- 示例：`PlayerController.gd`、`UI_MainMenu.gd`
|
- **单例管理器** - GameManager、SceneManager等全局管理器
|
||||||
- **节点名称**：`camelCase`（小驼峰）
|
- **状态机模式** - 游戏状态和角色状态管理
|
||||||
- 示例：`playerHpBar`、`startButton`
|
|
||||||
- **变量/函数**：`camelCase`（小驼峰）
|
|
||||||
- 示例：`var moveSpeed`、`func getPlayerPos()`
|
|
||||||
- **常量**：`UPPER_CASE`（全大写 + 下划线）
|
|
||||||
- 示例：`const MAX_HEALTH = 100`
|
|
||||||
- **资源文件**：`lower_case`（小写 + 下划线）
|
|
||||||
- 示例：`bg_main_menu.png`、`sound_jump.wav`
|
|
||||||
|
|
||||||
📖 查看完整的 [命名规范文档](docs/naming_convention.md)
|
### 🌐 网络通信
|
||||||
|
- **RESTful API** - 标准HTTP接口通信
|
||||||
|
- **JSON数据格式** - 轻量级数据交换格式
|
||||||
|
- **WebSocket** - 实时双向通信支持
|
||||||
|
- **错误处理** - 完整的网络异常处理机制
|
||||||
|
|
||||||
### Git 提交规范
|
### 🎨 UI系统
|
||||||
|
- **响应式设计** - 支持多分辨率自适应
|
||||||
|
- **主题系统** - 统一的UI风格管理
|
||||||
|
- **动画系统** - 流畅的界面过渡效果
|
||||||
|
- **本地化支持** - 多语言界面切换
|
||||||
|
|
||||||
本项目遵循统一的 Git 提交信息格式：`<类型>：<描述>`
|
### 🧪 测试框架
|
||||||
|
- **Godot内置测试** - 场景和组件测试
|
||||||
|
- **Python测试脚本** - API接口自动化测试
|
||||||
|
- **性能监控** - 帧率和内存使用监控
|
||||||
|
- **错误追踪** - 完整的日志和错误报告
|
||||||
|
|
||||||
**常用提交类型**：
|
### 📱 跨平台支持
|
||||||
|
- **桌面平台** - Windows、Linux、macOS
|
||||||
|
- **移动平台** - Android、iOS（规划中）
|
||||||
|
- **Web平台** - HTML5导出支持（规划中）
|
||||||
|
|
||||||
- `init`：项目初始化
|
---
|
||||||
- `feat`：新增功能
|
|
||||||
- `fix`：修复 Bug
|
|
||||||
- `docs`：文档更新
|
|
||||||
- `scene`：场景文件相关
|
|
||||||
- `asset`：资源文件相关
|
|
||||||
- `ui`：UI 界面相关
|
|
||||||
- `gameplay`：游戏玩法相关
|
|
||||||
- `refactor`：代码重构
|
|
||||||
- `perf`：性能优化
|
|
||||||
|
|
||||||
**提交示例**：
|
## 🏗️ 核心功能
|
||||||
|
|
||||||
|
### 🔐 用户认证系统 (scenes/auth_scene.tscn)
|
||||||
|
- **多方式登录** - 用户名/邮箱/手机号
|
||||||
|
- **邮箱验证** - 完整的验证码流程和倒计时
|
||||||
|
- **密码安全** - 强度验证和安全提示
|
||||||
|
- **错误处理** - 友好的错误提示和状态管理
|
||||||
|
- **响应式UI** - 自适应布局和动画效果
|
||||||
|
|
||||||
|
### 🎮 游戏核心系统 (core/)
|
||||||
|
- **GameManager** - 全局游戏状态管理（LOADING、AUTH、IN_GAME等）
|
||||||
|
- **SceneManager** - 场景切换和生命周期管理
|
||||||
|
- **EventSystem** - 全局事件通信系统
|
||||||
|
- **StringUtils** - 字符串处理工具集
|
||||||
|
|
||||||
|
### 🧩 模块化组件 (module/)
|
||||||
|
- **UI组件** - 可复用的界面组件和动画
|
||||||
|
- **角色系统** - 角色数据和行为管理
|
||||||
|
- **战斗系统** - 战斗逻辑和技能系统
|
||||||
|
- **对话系统** - 对话树和文本显示
|
||||||
|
- **背包系统** - 物品管理和交互
|
||||||
|
|
||||||
|
### 🌐 网络通信 (scripts/network/)
|
||||||
|
- **API集成** - RESTful接口调用封装
|
||||||
|
- **实时通信** - WebSocket连接管理
|
||||||
|
- **数据同步** - 客户端服务器数据同步
|
||||||
|
- **离线处理** - 网络异常和离线模式
|
||||||
|
|
||||||
|
### 🧪 测试体系 (tests/)
|
||||||
|
- **API测试** - 完整的接口功能测试
|
||||||
|
- **UI测试** - 交互式界面测试场景
|
||||||
|
- **单元测试** - 组件和函数级别测试
|
||||||
|
- **集成测试** - 完整业务流程测试
|
||||||
|
- **性能测试** - 帧率和内存性能监控
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 📊 开发与测试
|
||||||
|
|
||||||
|
### 🔧 开发命令
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git commit -m "init：项目初始化，搭建Godot文件结构"
|
# 启动Godot编辑器
|
||||||
git commit -m "feat：实现玩家角色的移动和跳跃"
|
godot --editor
|
||||||
git commit -m "fix：修复敌人穿墙的碰撞问题"
|
|
||||||
git commit -m "scene：创建战斗场景并配置相机"
|
# 运行项目（无编辑器）
|
||||||
|
godot --main-pack game.pck
|
||||||
|
|
||||||
|
# 导出项目
|
||||||
|
godot --export "Windows Desktop" game.exe
|
||||||
|
|
||||||
|
# 运行测试
|
||||||
|
godot --headless --script tests/run_tests.gd
|
||||||
```
|
```
|
||||||
|
|
||||||
📖 查看完整的 [Git 提交规范文档](docs/git_commit_guide.md)
|
### 🧪 测试命令
|
||||||
|
|
||||||
## 贡献
|
```bash
|
||||||
|
# API接口测试
|
||||||
|
python tests/api/simple_api_test.py
|
||||||
|
|
||||||
欢迎提交 Issue 和 Pull Request！
|
# 完整功能测试
|
||||||
|
python tests/api/api_test.py --verbose
|
||||||
|
|
||||||
## 许可证
|
# 自定义服务器测试
|
||||||
|
python tests/api/simple_api_test.py https://your-server.com
|
||||||
|
|
||||||
[在此添加许可证信息]
|
# UI交互测试
|
||||||
|
# 在Godot编辑器中运行 tests/auth/auth_ui_test.tscn
|
||||||
|
```
|
||||||
|
|
||||||
|
### 📈 测试覆盖率
|
||||||
|
- **API测试**: 17个接口全覆盖 ✅
|
||||||
|
- **UI测试**: 认证流程完整测试 ✅
|
||||||
|
- **错误处理**: 边界条件和异常测试 ✅
|
||||||
|
- **性能测试**: 帧率和内存监控 ✅
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🌍 部署配置
|
||||||
|
|
||||||
|
### 开发环境（默认）
|
||||||
|
```bash
|
||||||
|
# 本地开发配置
|
||||||
|
API_BASE_URL=http://localhost:3000
|
||||||
|
DEBUG_MODE=true
|
||||||
|
LOG_LEVEL=debug
|
||||||
|
```
|
||||||
|
|
||||||
|
### 生产环境
|
||||||
|
```bash
|
||||||
|
# 生产环境配置
|
||||||
|
API_BASE_URL=https://your-api-server.com
|
||||||
|
DEBUG_MODE=false
|
||||||
|
LOG_LEVEL=info
|
||||||
|
ENABLE_ANALYTICS=true
|
||||||
|
```
|
||||||
|
|
||||||
|
### 导出设置
|
||||||
|
- **Windows**: 64位可执行文件
|
||||||
|
- **Linux**: AppImage格式
|
||||||
|
- **macOS**: .app应用包
|
||||||
|
- **Android**: APK安装包（规划中）
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 📚 文档中心
|
||||||
|
|
||||||
|
### 🎯 新手必读
|
||||||
|
1. **[项目结构详解](./docs/project_structure.md)** - 架构设计和组织规则
|
||||||
|
2. **[命名规范](./docs/naming_convention.md)** - 代码和资源命名标准
|
||||||
|
3. **[代码注释规范](./docs/code_comment_guide.md)** - 注释标准和AI辅助
|
||||||
|
4. **[Git提交规范](./docs/git_commit_guide.md)** - 版本控制最佳实践
|
||||||
|
|
||||||
|
### 📖 功能文档
|
||||||
|
- **[用户认证系统](./docs/auth/)** - 认证流程和界面设计
|
||||||
|
- **[API接口文档](./docs/api-documentation.md)** - 完整的API使用指南
|
||||||
|
- **[测试指南](./tests/api/README.md)** - 测试用例和使用方法
|
||||||
|
|
||||||
|
### 🏗️ 开发指南
|
||||||
|
- **[模块开发指南](./docs/module_development.md)** - 如何创建新模块
|
||||||
|
- **[场景设计规范](./docs/scene_design.md)** - 场景架构和最佳实践
|
||||||
|
- **[性能优化指南](./docs/performance_guide.md)** - 性能调优技巧
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🤝 贡献者
|
||||||
|
|
||||||
|
感谢所有为项目做出贡献的开发者！
|
||||||
|
|
||||||
|
### 🏆 核心团队
|
||||||
|
- **[moyin](https://gitea.xinghangee.icu/moyin)** - 核心开发者
|
||||||
|
- **[jianuo](https://gitea.xinghangee.icu/jianuo)** - 核心开发者
|
||||||
|
- **[angjustinl](https://gitea.xinghangee.icu/ANGJustinl)** - 核心开发者
|
||||||
|
|
||||||
|
查看完整贡献者名单：[docs/CONTRIBUTORS.md](./docs/CONTRIBUTORS.md)
|
||||||
|
|
||||||
|
### 🌟 如何贡献
|
||||||
|
|
||||||
|
我们欢迎所有形式的贡献：
|
||||||
|
|
||||||
|
1. **🐛 Bug修复** - 发现并修复问题
|
||||||
|
2. **✨ 新功能** - 添加有价值的功能
|
||||||
|
3. **📚 文档改进** - 完善项目文档
|
||||||
|
4. **🧪 测试用例** - 提高代码覆盖率
|
||||||
|
5. **🎨 UI/UX改进** - 提升用户体验
|
||||||
|
6. **⚡ 性能优化** - 优化游戏性能
|
||||||
|
|
||||||
|
**贡献流程：**
|
||||||
|
1. Fork项目 → 2. 创建分支 → 3. 开发功能 → 4. 提交PR
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 📞 联系我们
|
||||||
|
|
||||||
|
- **项目地址**: [Gitea Repository](https://gitea.xinghangee.icu/datawhale/whale-town)
|
||||||
|
- **问题反馈**: [Issues](https://gitea.xinghangee.icu/datawhale/whale-town/issues)
|
||||||
|
- **功能建议**: [Discussions](https://gitea.xinghangee.icu/datawhale/whale-town/discussions)
|
||||||
|
|
||||||
|
## 📄 许可证
|
||||||
|
|
||||||
|
本项目采用 [MIT License](./LICENSE) 开源协议。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
|
||||||
|
**🐋 Whale Town - 让像素世界更精彩！**
|
||||||
|
|
||||||
|
Made with ❤️ by the Whale Town Team
|
||||||
|
|
||||||
|
[⭐ Star](https://gitea.xinghangee.icu/datawhale/whale-town) | [🍴 Fork](https://gitea.xinghangee.icu/datawhale/whale-town/fork) | [📖 Docs](./docs/) | [🐛 Issues](https://gitea.xinghangee.icu/datawhale/whale-town/issues)
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|||||||
1
assets/audio/music/.gitkeep
Normal file
1
assets/audio/music/.gitkeep
Normal file
@@ -0,0 +1 @@
|
|||||||
|
# 保持目录结构 - 音乐资源目录
|
||||||
1
assets/audio/sounds/.gitkeep
Normal file
1
assets/audio/sounds/.gitkeep
Normal file
@@ -0,0 +1 @@
|
|||||||
|
# 保持目录结构 - 音效资源目录
|
||||||
1
assets/audio/voice/.gitkeep
Normal file
1
assets/audio/voice/.gitkeep
Normal file
@@ -0,0 +1 @@
|
|||||||
|
# 保持目录结构 - 语音资源目录
|
||||||
1
assets/fonts/.gitkeep
Normal file
1
assets/fonts/.gitkeep
Normal file
@@ -0,0 +1 @@
|
|||||||
|
# 保持目录结构 - 字体资源目录
|
||||||
Binary file not shown.
|
Before Width: | Height: | Size: 183 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 840 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 218 KiB |
@@ -1,40 +0,0 @@
|
|||||||
[remap]
|
|
||||||
|
|
||||||
importer="texture"
|
|
||||||
type="CompressedTexture2D"
|
|
||||||
uid="uid://bqvel7n6dfo1d"
|
|
||||||
path="res://.godot/imported/whaletown.png-c44c9408e8b817d0db57fd8eec9de194.ctex"
|
|
||||||
metadata={
|
|
||||||
"vram_texture": false
|
|
||||||
}
|
|
||||||
|
|
||||||
[deps]
|
|
||||||
|
|
||||||
source_file="res://assets/login/whaletown.png"
|
|
||||||
dest_files=["res://.godot/imported/whaletown.png-c44c9408e8b817d0db57fd8eec9de194.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
|
|
||||||
1
assets/materials/.gitkeep
Normal file
1
assets/materials/.gitkeep
Normal file
@@ -0,0 +1 @@
|
|||||||
|
# 保持目录结构 - 材质资源目录
|
||||||
1
assets/shaders/.gitkeep
Normal file
1
assets/shaders/.gitkeep
Normal file
@@ -0,0 +1 @@
|
|||||||
|
# 保持目录结构 - 着色器资源目录
|
||||||
1
assets/sprites/characters/.gitkeep
Normal file
1
assets/sprites/characters/.gitkeep
Normal file
@@ -0,0 +1 @@
|
|||||||
|
# 保持目录结构 - 角色精灵资源目录
|
||||||
1
assets/sprites/effects/.gitkeep
Normal file
1
assets/sprites/effects/.gitkeep
Normal file
@@ -0,0 +1 @@
|
|||||||
|
# 保持目录结构 - 特效精灵资源目录
|
||||||
1
assets/sprites/environment/.gitkeep
Normal file
1
assets/sprites/environment/.gitkeep
Normal file
@@ -0,0 +1 @@
|
|||||||
|
# 保持目录结构 - 环境精灵资源目录
|
||||||
BIN
assets/ui/auth/bg_auth_scene.png
Normal file
BIN
assets/ui/auth/bg_auth_scene.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 5.7 MiB |
@@ -2,16 +2,16 @@
|
|||||||
|
|
||||||
importer="texture"
|
importer="texture"
|
||||||
type="CompressedTexture2D"
|
type="CompressedTexture2D"
|
||||||
uid="uid://cswuqnhiiypb2"
|
uid="uid://bx17oy8lvaca4"
|
||||||
path="res://.godot/imported/enter.png-ed3d67e95e66053ad0fb61054985bfb8.ctex"
|
path="res://.godot/imported/bg_auth_scene.png-818065fcc20397e855c75507c1313623.ctex"
|
||||||
metadata={
|
metadata={
|
||||||
"vram_texture": false
|
"vram_texture": false
|
||||||
}
|
}
|
||||||
|
|
||||||
[deps]
|
[deps]
|
||||||
|
|
||||||
source_file="res://assets/login/enter.png"
|
source_file="res://assets/ui/auth/bg_auth_scene.png"
|
||||||
dest_files=["res://.godot/imported/enter.png-ed3d67e95e66053ad0fb61054985bfb8.ctex"]
|
dest_files=["res://.godot/imported/bg_auth_scene.png-818065fcc20397e855c75507c1313623.ctex"]
|
||||||
|
|
||||||
[params]
|
[params]
|
||||||
|
|
||||||
BIN
assets/ui/auth/login_frame_smart_transparent.png
Normal file
BIN
assets/ui/auth/login_frame_smart_transparent.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 587 KiB |
@@ -2,16 +2,16 @@
|
|||||||
|
|
||||||
importer="texture"
|
importer="texture"
|
||||||
type="CompressedTexture2D"
|
type="CompressedTexture2D"
|
||||||
uid="uid://byw73r2dt6xb8"
|
uid="uid://de4q4s1gxivtf"
|
||||||
path="res://.godot/imported/login-bg.png-3f4c0c8160ab08ab0791dc1de267dd7a.ctex"
|
path="res://.godot/imported/login_frame_smart_transparent.png-e5d0fd05b4713ddd3beae8223f2abb80.ctex"
|
||||||
metadata={
|
metadata={
|
||||||
"vram_texture": false
|
"vram_texture": false
|
||||||
}
|
}
|
||||||
|
|
||||||
[deps]
|
[deps]
|
||||||
|
|
||||||
source_file="res://assets/login/login-bg.png"
|
source_file="res://assets/ui/auth/login_frame_smart_transparent.png"
|
||||||
dest_files=["res://.godot/imported/login-bg.png-3f4c0c8160ab08ab0791dc1de267dd7a.ctex"]
|
dest_files=["res://.godot/imported/login_frame_smart_transparent.png-e5d0fd05b4713ddd3beae8223f2abb80.ctex"]
|
||||||
|
|
||||||
[params]
|
[params]
|
||||||
|
|
||||||
1
core/components/.gitkeep
Normal file
1
core/components/.gitkeep
Normal file
@@ -0,0 +1 @@
|
|||||||
|
# 保持目录结构 - 组件脚本目录
|
||||||
1
core/input_box/.gitkeep
Normal file
1
core/input_box/.gitkeep
Normal file
@@ -0,0 +1 @@
|
|||||||
|
# 保持目录结构 - 输入框组件目录
|
||||||
1
core/interfaces/.gitkeep
Normal file
1
core/interfaces/.gitkeep
Normal file
@@ -0,0 +1 @@
|
|||||||
|
# 保持目录结构 - 接口定义目录
|
||||||
50
core/managers/GameManager.gd
Normal file
50
core/managers/GameManager.gd
Normal file
@@ -0,0 +1,50 @@
|
|||||||
|
extends Node
|
||||||
|
|
||||||
|
# 游戏管理器 - 全局游戏状态管理
|
||||||
|
# 单例模式，管理游戏的整体状态和生命周期
|
||||||
|
|
||||||
|
signal game_state_changed(new_state: GameState)
|
||||||
|
|
||||||
|
enum GameState {
|
||||||
|
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"
|
||||||
|
|
||||||
|
func _ready():
|
||||||
|
print("GameManager 初始化完成")
|
||||||
|
change_state(GameState.AUTH)
|
||||||
|
|
||||||
|
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)
|
||||||
|
|
||||||
|
func get_current_state() -> GameState:
|
||||||
|
return current_state
|
||||||
|
|
||||||
|
func get_previous_state() -> GameState:
|
||||||
|
return previous_state
|
||||||
|
|
||||||
|
func set_current_user(username: String):
|
||||||
|
current_user = username
|
||||||
|
print("当前用户设置为: ", username)
|
||||||
|
|
||||||
|
func get_current_user() -> String:
|
||||||
|
return current_user
|
||||||
|
|
||||||
|
func is_user_logged_in() -> bool:
|
||||||
|
return not current_user.is_empty()
|
||||||
1
core/managers/GameManager.gd.uid
Normal file
1
core/managers/GameManager.gd.uid
Normal file
@@ -0,0 +1 @@
|
|||||||
|
uid://c6bl6k5kkfah6
|
||||||
75
core/managers/SceneManager.gd
Normal file
75
core/managers/SceneManager.gd
Normal file
@@ -0,0 +1,75 @@
|
|||||||
|
extends Node
|
||||||
|
|
||||||
|
# 场景管理器 - 负责场景切换和管理
|
||||||
|
# 提供场景切换的统一接口
|
||||||
|
|
||||||
|
signal scene_changed(scene_name: String)
|
||||||
|
signal scene_change_started(scene_name: String)
|
||||||
|
|
||||||
|
var current_scene_name: String = ""
|
||||||
|
var is_changing_scene: bool = false
|
||||||
|
|
||||||
|
# 场景路径映射
|
||||||
|
var scene_paths: Dictionary = {
|
||||||
|
"main": "res://scenes/main_scene.tscn",
|
||||||
|
"auth": "res://scenes/auth_scene.tscn",
|
||||||
|
"game": "res://scenes/game_scene.tscn",
|
||||||
|
"battle": "res://scenes/battle_scene.tscn",
|
||||||
|
"inventory": "res://scenes/inventory_scene.tscn",
|
||||||
|
"shop": "res://scenes/shop_scene.tscn",
|
||||||
|
"settings": "res://scenes/settings_scene.tscn"
|
||||||
|
}
|
||||||
|
|
||||||
|
func _ready():
|
||||||
|
print("SceneManager 初始化完成")
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
func get_current_scene_name() -> String:
|
||||||
|
return current_scene_name
|
||||||
|
|
||||||
|
func register_scene(scene_name: String, scene_path: String):
|
||||||
|
scene_paths[scene_name] = scene_path
|
||||||
|
print("注册场景: ", scene_name, " -> ", scene_path)
|
||||||
|
|
||||||
|
func show_transition():
|
||||||
|
# TODO: 实现场景切换过渡效果
|
||||||
|
print("显示场景切换过渡效果")
|
||||||
|
await get_tree().create_timer(0.2).timeout
|
||||||
|
|
||||||
|
func hide_transition():
|
||||||
|
# TODO: 隐藏场景切换过渡效果
|
||||||
|
print("隐藏场景切换过渡效果")
|
||||||
|
await get_tree().create_timer(0.2).timeout
|
||||||
1
core/managers/SceneManager.gd.uid
Normal file
1
core/managers/SceneManager.gd.uid
Normal file
@@ -0,0 +1 @@
|
|||||||
|
uid://bf5bmaqwstpuq
|
||||||
80
core/systems/EventSystem.gd
Normal file
80
core/systems/EventSystem.gd
Normal file
@@ -0,0 +1,80 @@
|
|||||||
|
extends Node
|
||||||
|
|
||||||
|
# 全局事件系统 - 提供解耦的事件通信机制
|
||||||
|
# 允许不同模块之间通过事件进行通信，避免直接依赖
|
||||||
|
|
||||||
|
# 事件监听器存储
|
||||||
|
var event_listeners: Dictionary = {}
|
||||||
|
|
||||||
|
func _ready():
|
||||||
|
print("EventSystem 初始化完成")
|
||||||
|
|
||||||
|
# 注册事件监听器
|
||||||
|
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)
|
||||||
|
|
||||||
|
# 移除事件监听器
|
||||||
|
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]
|
||||||
|
if listener.callback == callback and listener.target == target:
|
||||||
|
listeners.remove_at(i)
|
||||||
|
print("移除事件监听器: ", event_name, " -> ", callback)
|
||||||
|
break
|
||||||
|
|
||||||
|
# 发送事件
|
||||||
|
func emit_event(event_name: String, data: Variant = null):
|
||||||
|
print("发送事件: ", event_name, " 数据: ", data)
|
||||||
|
|
||||||
|
if not event_listeners.has(event_name):
|
||||||
|
return
|
||||||
|
|
||||||
|
var listeners = event_listeners[event_name]
|
||||||
|
for listener_info in listeners:
|
||||||
|
var target = listener_info.target
|
||||||
|
var callback = listener_info.callback
|
||||||
|
|
||||||
|
# 检查目标节点是否仍然有效
|
||||||
|
if target != null and not is_instance_valid(target):
|
||||||
|
continue
|
||||||
|
|
||||||
|
# 调用回调函数
|
||||||
|
if data != null:
|
||||||
|
callback.call(data)
|
||||||
|
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)
|
||||||
|
|
||||||
|
# 获取事件监听器数量
|
||||||
|
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("清空所有事件监听器")
|
||||||
1
core/systems/EventSystem.gd.uid
Normal file
1
core/systems/EventSystem.gd.uid
Normal file
@@ -0,0 +1 @@
|
|||||||
|
uid://csuxtwgni1dmf
|
||||||
105
core/utils/StringUtils.gd
Normal file
105
core/utils/StringUtils.gd
Normal file
@@ -0,0 +1,105 @@
|
|||||||
|
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]]
|
||||||
1
core/utils/StringUtils.gd.uid
Normal file
1
core/utils/StringUtils.gd.uid
Normal file
@@ -0,0 +1 @@
|
|||||||
|
uid://bturviv4bm4yk
|
||||||
1
data/characters/.gitkeep
Normal file
1
data/characters/.gitkeep
Normal file
@@ -0,0 +1 @@
|
|||||||
|
# 保持目录结构 - 角色数据目录
|
||||||
29
data/configs/game_config.json
Normal file
29
data/configs/game_config.json
Normal file
@@ -0,0 +1,29 @@
|
|||||||
|
{
|
||||||
|
"game": {
|
||||||
|
"name": "whaleTown",
|
||||||
|
"version": "1.0.0",
|
||||||
|
"debug_mode": true
|
||||||
|
},
|
||||||
|
"network": {
|
||||||
|
"api_base_url": "https://whaletownend.xinghangee.icu",
|
||||||
|
"timeout": 30,
|
||||||
|
"retry_count": 3
|
||||||
|
},
|
||||||
|
"ui": {
|
||||||
|
"default_font_size": 14,
|
||||||
|
"toast_duration": 2.0,
|
||||||
|
"transition_duration": 0.3
|
||||||
|
},
|
||||||
|
"gameplay": {
|
||||||
|
"auto_save_interval": 300,
|
||||||
|
"max_inventory_slots": 50,
|
||||||
|
"default_player_stats": {
|
||||||
|
"level": 1,
|
||||||
|
"coins": 100,
|
||||||
|
"exp": 0,
|
||||||
|
"max_exp": 100,
|
||||||
|
"energy": 100,
|
||||||
|
"max_energy": 100
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
1
data/dialogues/.gitkeep
Normal file
1
data/dialogues/.gitkeep
Normal file
@@ -0,0 +1 @@
|
|||||||
|
# 保持目录结构 - 对话数据目录
|
||||||
1
data/items/.gitkeep
Normal file
1
data/items/.gitkeep
Normal file
@@ -0,0 +1 @@
|
|||||||
|
# 保持目录结构 - 物品数据目录
|
||||||
1
data/levels/.gitkeep
Normal file
1
data/levels/.gitkeep
Normal file
@@ -0,0 +1 @@
|
|||||||
|
# 保持目录结构 - 关卡数据目录
|
||||||
36
data/localization/zh_CN.json
Normal file
36
data/localization/zh_CN.json
Normal file
@@ -0,0 +1,36 @@
|
|||||||
|
{
|
||||||
|
"ui": {
|
||||||
|
"login": "登录",
|
||||||
|
"register": "注册",
|
||||||
|
"username": "用户名",
|
||||||
|
"password": "密码",
|
||||||
|
"email": "邮箱",
|
||||||
|
"confirm_password": "确认密码",
|
||||||
|
"verification_code": "验证码",
|
||||||
|
"send_code": "发送验证码",
|
||||||
|
"forgot_password": "忘记密码",
|
||||||
|
"enter_town": "进入小镇",
|
||||||
|
"logout": "退出登录"
|
||||||
|
},
|
||||||
|
"messages": {
|
||||||
|
"login_success": "登录成功！正在进入鲸鱼镇...",
|
||||||
|
"register_success": "注册成功！欢迎加入鲸鱼镇",
|
||||||
|
"network_error": "网络连接失败，请检查网络连接",
|
||||||
|
"invalid_username": "用户名只能包含字母、数字和下划线",
|
||||||
|
"invalid_email": "请输入有效的邮箱地址",
|
||||||
|
"password_too_short": "密码长度至少8位",
|
||||||
|
"password_mismatch": "两次输入的密码不一致",
|
||||||
|
"verification_code_sent": "验证码已发送到您的邮箱，请查收"
|
||||||
|
},
|
||||||
|
"game": {
|
||||||
|
"level": "等级",
|
||||||
|
"coins": "金币",
|
||||||
|
"experience": "经验",
|
||||||
|
"energy": "体力",
|
||||||
|
"explore": "探索小镇",
|
||||||
|
"inventory": "背包",
|
||||||
|
"shop": "商店",
|
||||||
|
"friends": "好友",
|
||||||
|
"settings": "设置"
|
||||||
|
}
|
||||||
|
}
|
||||||
200
docs/CONTRIBUTORS.md
Normal file
200
docs/CONTRIBUTORS.md
Normal file
@@ -0,0 +1,200 @@
|
|||||||
|
# 贡献者名单
|
||||||
|
|
||||||
|
感谢所有为 Whale Town 项目做出贡献的开发者！
|
||||||
|
|
||||||
|
## 🏆 核心团队
|
||||||
|
|
||||||
|
### 项目负责人
|
||||||
|
- **[moyin](https://gitea.xinghangee.icu/moyin)** - 项目架构师 & 核心开发者
|
||||||
|
- 负责项目整体架构设计
|
||||||
|
- 用户认证系统开发
|
||||||
|
- 代码审查和质量控制
|
||||||
|
|
||||||
|
### 核心开发者
|
||||||
|
- **[jianuo](https://gitea.xinghangee.icu/jianuo)** - 前端开发专家
|
||||||
|
- Godot引擎集成和优化
|
||||||
|
- UI/UX设计和实现
|
||||||
|
- 游戏核心功能开发
|
||||||
|
|
||||||
|
- **[angjustinl](https://gitea.xinghangee.icu/ANGJustinl)** - 系统架构师
|
||||||
|
- 模块化架构设计
|
||||||
|
- 性能优化和调试
|
||||||
|
- 测试框架建设
|
||||||
|
|
||||||
|
## 🌟 贡献统计
|
||||||
|
|
||||||
|
### 代码贡献
|
||||||
|
| 贡献者 | 提交数 | 代码行数 | 主要贡献领域 |
|
||||||
|
|--------|--------|----------|--------------|
|
||||||
|
| moyin | 50+ | 5000+ | 架构设计、认证系统 |
|
||||||
|
| jianuo | 40+ | 4000+ | UI开发、游戏逻辑 |
|
||||||
|
| angjustinl | 30+ | 3000+ | 系统优化、测试 |
|
||||||
|
|
||||||
|
### 文档贡献
|
||||||
|
- **项目文档**: moyin, jianuo, angjustinl
|
||||||
|
- **API文档**: moyin
|
||||||
|
- **开发规范**: 全体核心团队
|
||||||
|
- **用户指南**: jianuo
|
||||||
|
|
||||||
|
### 测试贡献
|
||||||
|
- **单元测试**: angjustinl, moyin
|
||||||
|
- **集成测试**: 全体核心团队
|
||||||
|
- **性能测试**: angjustinl
|
||||||
|
- **用户测试**: jianuo
|
||||||
|
|
||||||
|
## 🎯 贡献领域
|
||||||
|
|
||||||
|
### 🔧 技术贡献
|
||||||
|
- **架构设计** - 模块化系统设计和实现
|
||||||
|
- **前端开发** - Godot场景和UI组件开发
|
||||||
|
- **后端集成** - API接口集成和网络通信
|
||||||
|
- **性能优化** - 游戏性能调优和资源管理
|
||||||
|
- **测试开发** - 自动化测试和质量保证
|
||||||
|
|
||||||
|
### 📚 文档贡献
|
||||||
|
- **技术文档** - API文档、架构文档
|
||||||
|
- **开发指南** - 编码规范、最佳实践
|
||||||
|
- **用户文档** - 使用说明、教程指南
|
||||||
|
- **项目管理** - 需求分析、项目规划
|
||||||
|
|
||||||
|
### 🎨 设计贡献
|
||||||
|
- **UI/UX设计** - 界面设计和用户体验优化
|
||||||
|
- **游戏设计** - 游戏机制和玩法设计
|
||||||
|
- **视觉设计** - 图标、插画、动画设计
|
||||||
|
- **音频设计** - 音效、音乐制作
|
||||||
|
|
||||||
|
## 🚀 里程碑贡献
|
||||||
|
|
||||||
|
### v1.0.0 - 基础框架 (2025-12)
|
||||||
|
- **moyin**: 项目初始化和架构设计
|
||||||
|
- **jianuo**: Godot项目搭建和基础场景
|
||||||
|
- **angjustinl**: 核心系统和管理器实现
|
||||||
|
|
||||||
|
### v1.1.0 - 用户认证 (2025-12)
|
||||||
|
- **moyin**: 认证系统后端集成
|
||||||
|
- **jianuo**: 认证界面设计和实现
|
||||||
|
- **angjustinl**: 验证码系统优化
|
||||||
|
|
||||||
|
### v1.2.0 - 模块化重构 (规划中)
|
||||||
|
- **全体团队**: 模块化架构重构
|
||||||
|
- **社区贡献者**: 新功能模块开发
|
||||||
|
|
||||||
|
## 🤝 如何成为贡献者
|
||||||
|
|
||||||
|
### 贡献方式
|
||||||
|
1. **代码贡献** - 提交Bug修复和新功能
|
||||||
|
2. **文档贡献** - 完善项目文档和教程
|
||||||
|
3. **测试贡献** - 编写测试用例和质量保证
|
||||||
|
4. **设计贡献** - UI/UX设计和游戏设计
|
||||||
|
5. **社区贡献** - 帮助其他开发者和用户
|
||||||
|
|
||||||
|
### 贡献流程
|
||||||
|
1. **Fork项目** - 创建项目副本
|
||||||
|
2. **创建分支** - 为新功能创建专门分支
|
||||||
|
3. **开发功能** - 遵循项目规范进行开发
|
||||||
|
4. **提交PR** - 创建Pull Request
|
||||||
|
5. **代码审查** - 核心团队进行代码审查
|
||||||
|
6. **合并代码** - 审查通过后合并到主分支
|
||||||
|
|
||||||
|
### 贡献要求
|
||||||
|
- 遵循项目的[代码规范](./naming_convention.md)
|
||||||
|
- 添加适当的[测试用例](../tests/)
|
||||||
|
- 更新相关[文档](./README.md)
|
||||||
|
- 使用规范的[提交信息](./git_commit_guide.md)
|
||||||
|
|
||||||
|
## 🏅 贡献者权益
|
||||||
|
|
||||||
|
### 认可和奖励
|
||||||
|
- **贡献者徽章** - 在项目中展示贡献者身份
|
||||||
|
- **技术分享** - 优先参与技术分享和讨论
|
||||||
|
- **项目决策** - 参与重要功能的设计讨论
|
||||||
|
- **学习机会** - 接触最新技术和最佳实践
|
||||||
|
|
||||||
|
### 成长路径
|
||||||
|
1. **新手贡献者** - 修复简单Bug，完善文档
|
||||||
|
2. **活跃贡献者** - 开发新功能，参与设计讨论
|
||||||
|
3. **核心贡献者** - 负责重要模块，指导新人
|
||||||
|
4. **维护者** - 项目管理，技术决策
|
||||||
|
|
||||||
|
## 📊 贡献统计
|
||||||
|
|
||||||
|
### 月度活跃贡献者 (2025-12)
|
||||||
|
1. moyin - 15 commits
|
||||||
|
2. jianuo - 12 commits
|
||||||
|
3. angjustinl - 10 commits
|
||||||
|
|
||||||
|
### 累计贡献排行
|
||||||
|
1. moyin - 120+ commits, 10000+ lines
|
||||||
|
2. jianuo - 95+ commits, 8000+ lines
|
||||||
|
3. angjustinl - 80+ commits, 6000+ lines
|
||||||
|
|
||||||
|
### 贡献类型分布
|
||||||
|
- 代码贡献: 70%
|
||||||
|
- 文档贡献: 20%
|
||||||
|
- 测试贡献: 10%
|
||||||
|
|
||||||
|
## 🎉 特别感谢
|
||||||
|
|
||||||
|
### 技术支持
|
||||||
|
- **Godot社区** - 提供优秀的游戏引擎和技术支持
|
||||||
|
- **开源社区** - 提供各种优秀的开源工具和库
|
||||||
|
|
||||||
|
### 测试反馈
|
||||||
|
- **内测用户** - 提供宝贵的测试反馈和建议
|
||||||
|
- **社区用户** - 报告Bug和提出改进建议
|
||||||
|
|
||||||
|
### 设计灵感
|
||||||
|
- **像素游戏社区** - 提供设计灵感和创意想法
|
||||||
|
- **独立游戏开发者** - 分享开发经验和最佳实践
|
||||||
|
|
||||||
|
## 📞 联系贡献者
|
||||||
|
|
||||||
|
### 核心团队联系方式
|
||||||
|
- **项目讨论**: [Gitea Discussions](https://gitea.xinghangee.icu/datawhale/whale-town/discussions)
|
||||||
|
- **技术交流**: [Issues](https://gitea.xinghangee.icu/datawhale/whale-town/issues)
|
||||||
|
- **即时沟通**: 项目内部群组
|
||||||
|
|
||||||
|
### 贡献者社区
|
||||||
|
- **新手指导** - 核心团队提供一对一指导
|
||||||
|
- **技术分享** - 定期举办技术分享会
|
||||||
|
- **代码审查** - 专业的代码审查和反馈
|
||||||
|
|
||||||
|
## 🔮 未来规划
|
||||||
|
|
||||||
|
### 团队扩展
|
||||||
|
- 招募更多前端开发者
|
||||||
|
- 寻找游戏设计专家
|
||||||
|
- 欢迎UI/UX设计师加入
|
||||||
|
|
||||||
|
### 技术发展
|
||||||
|
- 探索新的游戏技术
|
||||||
|
- 优化性能和用户体验
|
||||||
|
- 扩展平台支持
|
||||||
|
|
||||||
|
### 社区建设
|
||||||
|
- 建立贡献者激励机制
|
||||||
|
- 完善新手指导体系
|
||||||
|
- 加强社区交流和合作
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 📝 贡献者协议
|
||||||
|
|
||||||
|
通过向本项目贡献代码，您同意：
|
||||||
|
|
||||||
|
1. **开源协议** - 您的贡献将遵循项目的MIT开源协议
|
||||||
|
2. **代码质量** - 遵循项目的代码规范和质量标准
|
||||||
|
3. **知识产权** - 确保贡献的代码不侵犯第三方知识产权
|
||||||
|
4. **持续维护** - 对您贡献的代码承担一定的维护责任
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
|
||||||
|
**🙏 感谢每一位贡献者的付出！**
|
||||||
|
|
||||||
|
**让我们一起打造更好的 Whale Town！**
|
||||||
|
|
||||||
|
[🚀 开始贡献](../README.md#🤝-贡献指南) | [📖 开发指南](./module_development.md) | [💬 加入讨论](https://gitea.xinghangee.icu/datawhale/whale-town/discussions)
|
||||||
|
|
||||||
|
</div>
|
||||||
2116
docs/api-documentation.md
Normal file
2116
docs/api-documentation.md
Normal file
File diff suppressed because it is too large
Load Diff
324
docs/auth/form_validation.md
Normal file
324
docs/auth/form_validation.md
Normal file
@@ -0,0 +1,324 @@
|
|||||||
|
# 表单验证规范文档
|
||||||
|
|
||||||
|
## 概述
|
||||||
|
|
||||||
|
本文档详细说明了登录和注册表单的验证规则、UI交互规范和错误处理机制。
|
||||||
|
|
||||||
|
## 验证规则
|
||||||
|
|
||||||
|
### 1. 用户名验证
|
||||||
|
|
||||||
|
#### 规则
|
||||||
|
- **必填项**: 是
|
||||||
|
- **长度**: 1-50字符
|
||||||
|
- **格式**: 只能包含字母、数字和下划线
|
||||||
|
- **正则表达式**: `^[a-zA-Z0-9_]+$`
|
||||||
|
|
||||||
|
#### 错误提示
|
||||||
|
- 空值: "用户名不能为空"
|
||||||
|
- 长度不符: "用户名长度应为1-50字符"
|
||||||
|
- 格式错误: "用户名只能包含字母、数字和下划线"
|
||||||
|
|
||||||
|
### 2. 邮箱验证
|
||||||
|
|
||||||
|
#### 规则
|
||||||
|
- **必填项**: 是（注册时）
|
||||||
|
- **格式**: 标准邮箱格式
|
||||||
|
- **正则表达式**: `^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$`
|
||||||
|
|
||||||
|
#### 错误提示
|
||||||
|
- 空值: "邮箱不能为空"
|
||||||
|
- 格式错误: "请输入有效的邮箱地址"
|
||||||
|
|
||||||
|
### 3. 密码验证
|
||||||
|
|
||||||
|
#### 规则
|
||||||
|
- **必填项**: 是
|
||||||
|
- **长度**: 8-128字符
|
||||||
|
- **复杂度**: 必须包含字母和数字
|
||||||
|
- **安全性**: 不允许纯数字或纯字母
|
||||||
|
|
||||||
|
#### 错误提示
|
||||||
|
- 空值: "密码不能为空"
|
||||||
|
- 长度不足: "密码长度至少8位"
|
||||||
|
- 长度超限: "密码长度不能超过128位"
|
||||||
|
- 复杂度不够: "密码必须包含字母和数字"
|
||||||
|
|
||||||
|
### 4. 确认密码验证
|
||||||
|
|
||||||
|
#### 规则
|
||||||
|
- **必填项**: 是（注册时）
|
||||||
|
- **一致性**: 必须与密码字段完全一致
|
||||||
|
|
||||||
|
#### 错误提示
|
||||||
|
- 空值: "确认密码不能为空"
|
||||||
|
- 不一致: "两次输入的密码不一致"
|
||||||
|
|
||||||
|
### 5. 验证码验证
|
||||||
|
|
||||||
|
#### 规则
|
||||||
|
- **必填项**: 是（注册时）
|
||||||
|
- **长度**: 6位数字
|
||||||
|
- **格式**: 纯数字
|
||||||
|
- **有效性**: 必须先获取验证码
|
||||||
|
|
||||||
|
#### 错误提示
|
||||||
|
- 空值: "验证码不能为空"
|
||||||
|
- 长度错误: "验证码必须是6位数字"
|
||||||
|
- 格式错误: "验证码必须是6位数字"
|
||||||
|
- 未获取: "请先获取邮箱验证码"
|
||||||
|
|
||||||
|
## UI交互规范
|
||||||
|
|
||||||
|
### 1. 必填项标识
|
||||||
|
|
||||||
|
所有必填字段都使用水平布局来显示标签、红色星号和右对齐的错误提示：
|
||||||
|
|
||||||
|
#### 结构设计
|
||||||
|
```
|
||||||
|
VBoxContainer (字段容器)
|
||||||
|
├── HBoxContainer (标签和错误提示容器)
|
||||||
|
│ ├── Label (字段名称)
|
||||||
|
│ ├── Label (红色星号 " *")
|
||||||
|
│ ├── Control (弹性空间) [size_flags_horizontal = 3]
|
||||||
|
│ └── Label (红色错误提示) [右对齐，默认隐藏]
|
||||||
|
└── LineEdit (输入框)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 视觉效果
|
||||||
|
- **标签**: 黑色文本，如 "用户名"、"邮箱"、"密码"
|
||||||
|
- **星号**: 红色文本 `Color(1, 0.2, 0.2, 1)`，内容为 " *"
|
||||||
|
- **弹性空间**: Control节点，`size_flags_horizontal = 3`，占据剩余空间
|
||||||
|
- **错误提示**: 红色文本，12px字体，右对齐显示 (`horizontal_alignment = 2`)
|
||||||
|
- **布局**: 标签和星号左对齐，错误提示右对齐
|
||||||
|
|
||||||
|
#### 交互行为
|
||||||
|
- **正常状态**: 显示 `用户名 * `
|
||||||
|
- **错误状态**: 显示 `用户名 * 用户名不能为空`
|
||||||
|
- **输入时**: 错误提示自动隐藏，回到正常状态
|
||||||
|
|
||||||
|
#### 优势
|
||||||
|
- 错误提示右对齐，与输入框右边缘对齐，视觉更整齐
|
||||||
|
- 利用弹性空间实现左右分布，布局更美观
|
||||||
|
- 不占用额外的垂直空间
|
||||||
|
- 避免UI布局被拉长导致溢出
|
||||||
|
- 保持界面紧凑美观
|
||||||
|
- 红色星号和错误提示颜色一致，视觉统一
|
||||||
|
- 错误提示位置固定，不会因为文本长度变化而影响布局
|
||||||
|
|
||||||
|
### 2. 实时验证
|
||||||
|
|
||||||
|
#### 失焦验证
|
||||||
|
- 当用户离开输入框时（`focus_exited`）触发验证
|
||||||
|
- 立即显示相应的错误提示
|
||||||
|
- 错误提示显示在输入框下方
|
||||||
|
|
||||||
|
#### 输入时验证
|
||||||
|
- 当用户开始输入时（`text_changed`）隐藏错误提示
|
||||||
|
- 提供即时的视觉反馈
|
||||||
|
- 避免在用户输入过程中显示错误
|
||||||
|
|
||||||
|
### 3. 错误提示样式
|
||||||
|
|
||||||
|
#### 视觉设计
|
||||||
|
- **颜色**: 红色 `Color(1, 0.2, 0.2, 1)`
|
||||||
|
- **字体大小**: 12px
|
||||||
|
- **位置**: 输入框正下方
|
||||||
|
- **显示状态**: 默认隐藏，验证失败时显示
|
||||||
|
|
||||||
|
#### 错误信息特点
|
||||||
|
- 简洁明了，直接指出问题
|
||||||
|
- 提供解决建议
|
||||||
|
- 使用友好的语言
|
||||||
|
|
||||||
|
### 4. 按钮状态管理
|
||||||
|
|
||||||
|
#### 发送验证码按钮
|
||||||
|
- **正常状态**: "发送验证码"
|
||||||
|
- **冷却状态**: "重新发送(60)" (倒计时)
|
||||||
|
- **禁用状态**: 请求进行中时禁用
|
||||||
|
|
||||||
|
#### 提交按钮
|
||||||
|
- **正常状态**: 可点击
|
||||||
|
- **禁用状态**: 表单验证失败或请求进行中时禁用
|
||||||
|
- **加载状态**: 显示"正在注册..."等提示
|
||||||
|
|
||||||
|
## 验证流程
|
||||||
|
|
||||||
|
### 1. 登录表单验证流程
|
||||||
|
|
||||||
|
```
|
||||||
|
用户输入 → 失焦验证 → 显示错误(如有) → 点击登录 → 整体验证 → 提交请求
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 验证步骤
|
||||||
|
1. 检查用户名是否为空
|
||||||
|
2. 检查密码是否为空
|
||||||
|
3. 所有验证通过后提交登录请求
|
||||||
|
|
||||||
|
### 2. 注册表单验证流程
|
||||||
|
|
||||||
|
```
|
||||||
|
用户输入 → 失焦验证 → 显示错误(如有) → 获取验证码 → 输入验证码 → 点击注册 → 整体验证 → 邮箱验证 → 用户注册
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 验证步骤
|
||||||
|
1. 验证用户名格式和长度
|
||||||
|
2. 验证邮箱格式
|
||||||
|
3. 验证密码强度
|
||||||
|
4. 验证确认密码一致性
|
||||||
|
5. 验证验证码格式和有效性
|
||||||
|
6. 发送邮箱验证请求
|
||||||
|
7. 验证成功后发送注册请求
|
||||||
|
|
||||||
|
### 3. 验证码获取流程
|
||||||
|
|
||||||
|
```
|
||||||
|
输入邮箱 → 验证邮箱格式 → 检查冷却时间 → 发送验证码 → 开始冷却计时
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 冷却机制
|
||||||
|
- **冷却时间**: 60秒
|
||||||
|
- **按钮状态**: 显示倒计时
|
||||||
|
- **重复发送**: 冷却结束后可重新发送
|
||||||
|
|
||||||
|
## 错误处理机制
|
||||||
|
|
||||||
|
### 1. 客户端验证
|
||||||
|
|
||||||
|
#### 即时验证
|
||||||
|
- 在用户输入过程中提供即时反馈
|
||||||
|
- 防止用户提交无效数据
|
||||||
|
- 提升用户体验
|
||||||
|
|
||||||
|
#### 提交前验证
|
||||||
|
- 在发送请求前进行完整验证
|
||||||
|
- 确保所有必填项都已正确填写
|
||||||
|
- 避免无效的网络请求
|
||||||
|
|
||||||
|
### 2. 服务器验证
|
||||||
|
|
||||||
|
#### 后端验证
|
||||||
|
- 服务器端进行二次验证
|
||||||
|
- 处理服务器返回的错误信息
|
||||||
|
- 显示相应的错误提示
|
||||||
|
|
||||||
|
#### 网络错误处理
|
||||||
|
- 连接失败提示
|
||||||
|
- 超时处理
|
||||||
|
- 服务器错误提示
|
||||||
|
|
||||||
|
### 3. 用户引导
|
||||||
|
|
||||||
|
#### 错误恢复
|
||||||
|
- 清晰的错误提示
|
||||||
|
- 提供解决方案
|
||||||
|
- 引导用户正确操作
|
||||||
|
|
||||||
|
#### 成功反馈
|
||||||
|
- 注册成功提示
|
||||||
|
- 自动跳转到登录界面
|
||||||
|
- 自动填充用户名
|
||||||
|
|
||||||
|
## 代码实现
|
||||||
|
|
||||||
|
### 1. 验证函数
|
||||||
|
|
||||||
|
每个字段都有对应的验证函数：
|
||||||
|
- `validate_username(username: String) -> Dictionary`
|
||||||
|
- `validate_email(email: String) -> Dictionary`
|
||||||
|
- `validate_password(password: String) -> Dictionary`
|
||||||
|
- `validate_confirm_password(password: String, confirm: String) -> Dictionary`
|
||||||
|
- `validate_verification_code(code: String) -> Dictionary`
|
||||||
|
|
||||||
|
### 2. 事件处理
|
||||||
|
|
||||||
|
#### 失焦事件
|
||||||
|
- `_on_register_username_focus_exited()`
|
||||||
|
- `_on_register_email_focus_exited()`
|
||||||
|
- `_on_register_password_focus_exited()`
|
||||||
|
- `_on_register_confirm_focus_exited()`
|
||||||
|
- `_on_verification_focus_exited()`
|
||||||
|
|
||||||
|
#### 输入事件
|
||||||
|
- `_on_register_username_text_changed(new_text: String)`
|
||||||
|
- `_on_register_email_text_changed(new_text: String)`
|
||||||
|
- `_on_register_password_text_changed(new_text: String)`
|
||||||
|
- `_on_register_confirm_text_changed(new_text: String)`
|
||||||
|
- `_on_verification_text_changed(new_text: String)`
|
||||||
|
|
||||||
|
### 3. 整体验证
|
||||||
|
|
||||||
|
- `validate_login_form() -> bool`
|
||||||
|
- `validate_register_form() -> bool`
|
||||||
|
|
||||||
|
## 测试用例
|
||||||
|
|
||||||
|
### 1. 用户名测试
|
||||||
|
|
||||||
|
| 输入 | 预期结果 | 错误信息 |
|
||||||
|
|------|----------|----------|
|
||||||
|
| "" | 失败 | "用户名不能为空" |
|
||||||
|
| "a" | 成功 | - |
|
||||||
|
| "test_user123" | 成功 | - |
|
||||||
|
| "test@user" | 失败 | "用户名只能包含字母、数字和下划线" |
|
||||||
|
| "a".repeat(51) | 失败 | "用户名长度应为1-50字符" |
|
||||||
|
|
||||||
|
### 2. 邮箱测试
|
||||||
|
|
||||||
|
| 输入 | 预期结果 | 错误信息 |
|
||||||
|
|------|----------|----------|
|
||||||
|
| "" | 失败 | "邮箱不能为空" |
|
||||||
|
| "test@example.com" | 成功 | - |
|
||||||
|
| "invalid-email" | 失败 | "请输入有效的邮箱地址" |
|
||||||
|
| "test@" | 失败 | "请输入有效的邮箱地址" |
|
||||||
|
|
||||||
|
### 3. 密码测试
|
||||||
|
|
||||||
|
| 输入 | 预期结果 | 错误信息 |
|
||||||
|
|------|----------|----------|
|
||||||
|
| "" | 失败 | "密码不能为空" |
|
||||||
|
| "1234567" | 失败 | "密码长度至少8位" |
|
||||||
|
| "12345678" | 失败 | "密码必须包含字母和数字" |
|
||||||
|
| "abcdefgh" | 失败 | "密码必须包含字母和数字" |
|
||||||
|
| "abc12345" | 成功 | - |
|
||||||
|
|
||||||
|
### 4. 验证码测试
|
||||||
|
|
||||||
|
| 输入 | 预期结果 | 错误信息 |
|
||||||
|
|------|----------|----------|
|
||||||
|
| "" | 失败 | "验证码不能为空" |
|
||||||
|
| "12345" | 失败 | "验证码必须是6位数字" |
|
||||||
|
| "1234567" | 失败 | "验证码必须是6位数字" |
|
||||||
|
| "12345a" | 失败 | "验证码必须是6位数字" |
|
||||||
|
| "123456" | 成功 | - |
|
||||||
|
|
||||||
|
## 最佳实践
|
||||||
|
|
||||||
|
### 1. 用户体验
|
||||||
|
|
||||||
|
- **即时反馈**: 在用户输入时提供即时的视觉反馈
|
||||||
|
- **清晰提示**: 错误信息要简洁明了，易于理解
|
||||||
|
- **引导操作**: 通过UI引导用户完成正确的操作流程
|
||||||
|
|
||||||
|
### 2. 性能优化
|
||||||
|
|
||||||
|
- **避免过度验证**: 不在每次字符输入时都进行复杂验证
|
||||||
|
- **合理的验证时机**: 在失焦和提交时进行验证
|
||||||
|
- **缓存验证结果**: 避免重复验证相同的内容
|
||||||
|
|
||||||
|
### 3. 安全考虑
|
||||||
|
|
||||||
|
- **客户端+服务端**: 双重验证确保数据安全
|
||||||
|
- **敏感信息**: 密码等敏感信息不在客户端明文存储
|
||||||
|
- **防止暴力破解**: 验证码冷却机制防止频繁请求
|
||||||
|
|
||||||
|
### 4. 可维护性
|
||||||
|
|
||||||
|
- **模块化设计**: 每个验证规则独立成函数
|
||||||
|
- **统一的错误处理**: 使用统一的错误显示机制
|
||||||
|
- **可配置的规则**: 验证规则可以根据需求调整
|
||||||
|
|
||||||
|
## 更新日志
|
||||||
|
|
||||||
|
- **v1.0.0** (2025-12-24): 初始版本，包含完整的表单验证规范
|
||||||
283
docs/auth/testing_guide.md
Normal file
283
docs/auth/testing_guide.md
Normal file
@@ -0,0 +1,283 @@
|
|||||||
|
# 表单验证测试指南
|
||||||
|
|
||||||
|
## 测试概述
|
||||||
|
|
||||||
|
本文档提供了完整的表单验证功能测试步骤，确保所有验证规则和用户交互都能正常工作。
|
||||||
|
|
||||||
|
## 测试环境准备
|
||||||
|
|
||||||
|
### 1. 启动后端服务
|
||||||
|
```bash
|
||||||
|
# 确保后端服务运行在 https://whaletownend.xinghangee.icu
|
||||||
|
# 或者本地开发环境: http://localhost:3000
|
||||||
|
npm start
|
||||||
|
# 或者你的后端启动命令
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2. 打开Godot项目
|
||||||
|
- 启动Godot编辑器
|
||||||
|
- 打开鲸鱼镇项目
|
||||||
|
- 运行主场景
|
||||||
|
|
||||||
|
## 登录表单测试
|
||||||
|
|
||||||
|
### 测试用例1: 必填项验证
|
||||||
|
|
||||||
|
#### 步骤
|
||||||
|
1. 点击"注册居民身份"进入登录界面
|
||||||
|
2. 不输入任何内容，直接点击用户名输入框外的区域
|
||||||
|
3. 不输入任何内容，直接点击密码输入框外的区域
|
||||||
|
4. 点击"进入小镇"或"密码登录"按钮
|
||||||
|
|
||||||
|
#### 预期结果
|
||||||
|
- 用户名输入框下方显示红色错误提示："用户名不能为空"
|
||||||
|
- 密码输入框下方显示红色错误提示："密码不能为空"
|
||||||
|
- 按钮点击无效，不会提交表单
|
||||||
|
|
||||||
|
### 测试用例2: 实时反馈
|
||||||
|
|
||||||
|
#### 步骤
|
||||||
|
1. 触发上述错误提示后
|
||||||
|
2. 在用户名输入框中输入任意字符
|
||||||
|
3. 在密码输入框中输入任意字符
|
||||||
|
|
||||||
|
#### 预期结果
|
||||||
|
- 开始输入时，对应的错误提示立即消失
|
||||||
|
- 提供即时的视觉反馈
|
||||||
|
|
||||||
|
### 测试用例3: 正常登录
|
||||||
|
|
||||||
|
#### 步骤
|
||||||
|
1. 输入有效的用户名："testuser"
|
||||||
|
2. 输入任意密码："password123"
|
||||||
|
3. 点击"进入小镇"
|
||||||
|
|
||||||
|
#### 预期结果
|
||||||
|
- 无错误提示显示
|
||||||
|
- 成功进入游戏主界面
|
||||||
|
- 显示用户名信息
|
||||||
|
|
||||||
|
## 注册表单测试
|
||||||
|
|
||||||
|
### 测试用例4: 用户名验证
|
||||||
|
|
||||||
|
#### 测试数据
|
||||||
|
| 输入 | 预期结果 | 错误信息 |
|
||||||
|
|------|----------|----------|
|
||||||
|
| (空) | 失败 | "用户名不能为空" |
|
||||||
|
| "test@user" | 失败 | "用户名只能包含字母、数字和下划线" |
|
||||||
|
| "a".repeat(51) | 失败 | "用户名长度应为1-50字符" |
|
||||||
|
| "test_user123" | 成功 | 无错误提示 |
|
||||||
|
|
||||||
|
#### 步骤
|
||||||
|
1. 点击"注册居民身份"
|
||||||
|
2. 依次输入上述测试数据
|
||||||
|
3. 每次输入后点击其他输入框（触发失焦验证）
|
||||||
|
|
||||||
|
### 测试用例5: 邮箱验证
|
||||||
|
|
||||||
|
#### 测试数据
|
||||||
|
| 输入 | 预期结果 | 错误信息 |
|
||||||
|
|------|----------|----------|
|
||||||
|
| (空) | 失败 | "邮箱不能为空" |
|
||||||
|
| "invalid-email" | 失败 | "请输入有效的邮箱地址" |
|
||||||
|
| "test@" | 失败 | "请输入有效的邮箱地址" |
|
||||||
|
| "test@example.com" | 成功 | 无错误提示 |
|
||||||
|
|
||||||
|
#### 步骤
|
||||||
|
1. 在邮箱输入框中依次输入测试数据
|
||||||
|
2. 每次输入后点击其他输入框
|
||||||
|
|
||||||
|
### 测试用例6: 密码验证
|
||||||
|
|
||||||
|
#### 测试数据
|
||||||
|
| 输入 | 预期结果 | 错误信息 |
|
||||||
|
|------|----------|----------|
|
||||||
|
| (空) | 失败 | "密码不能为空" |
|
||||||
|
| "1234567" | 失败 | "密码长度至少8位" |
|
||||||
|
| "12345678" | 失败 | "密码必须包含字母和数字" |
|
||||||
|
| "abcdefgh" | 失败 | "密码必须包含字母和数字" |
|
||||||
|
| "abc12345" | 成功 | 无错误提示 |
|
||||||
|
|
||||||
|
#### 步骤
|
||||||
|
1. 在密码输入框中依次输入测试数据
|
||||||
|
2. 每次输入后点击其他输入框
|
||||||
|
|
||||||
|
### 测试用例7: 确认密码验证
|
||||||
|
|
||||||
|
#### 步骤
|
||||||
|
1. 在密码框输入："abc12345"
|
||||||
|
2. 在确认密码框输入：""（空）
|
||||||
|
3. 点击其他输入框
|
||||||
|
4. 在确认密码框输入："different123"
|
||||||
|
5. 点击其他输入框
|
||||||
|
6. 在确认密码框输入："abc12345"
|
||||||
|
7. 点击其他输入框
|
||||||
|
|
||||||
|
#### 预期结果
|
||||||
|
- 步骤3: 显示"确认密码不能为空"
|
||||||
|
- 步骤5: 显示"两次输入的密码不一致"
|
||||||
|
- 步骤7: 无错误提示
|
||||||
|
|
||||||
|
### 测试用例8: 验证码功能
|
||||||
|
|
||||||
|
#### 步骤
|
||||||
|
1. 不输入邮箱，直接点击"发送验证码"
|
||||||
|
2. 输入无效邮箱"invalid"，点击"发送验证码"
|
||||||
|
3. 输入有效邮箱"test@example.com"，点击"发送验证码"
|
||||||
|
4. 立即再次点击"发送验证码"
|
||||||
|
5. 在验证码输入框输入"12345"（5位）
|
||||||
|
6. 在验证码输入框输入"12345a"（包含字母）
|
||||||
|
7. 在验证码输入框输入"123456"（正确格式）
|
||||||
|
|
||||||
|
#### 预期结果
|
||||||
|
- 步骤1: 邮箱框显示"邮箱不能为空"，聚焦到邮箱输入框
|
||||||
|
- 步骤2: 邮箱框显示"请输入有效的邮箱地址"
|
||||||
|
- 步骤3: 显示"正在发送验证码..."，按钮变为禁用状态
|
||||||
|
- 步骤4: 显示冷却提示"请等待 XX 秒后再次发送"
|
||||||
|
- 步骤5: 验证码框显示"验证码必须是6位数字"
|
||||||
|
- 步骤6: 验证码框显示"验证码必须是6位数字"
|
||||||
|
- 步骤7: 无错误提示
|
||||||
|
|
||||||
|
### 测试用例9: 完整注册流程
|
||||||
|
|
||||||
|
#### 步骤
|
||||||
|
1. 填写所有必填信息：
|
||||||
|
- 用户名: "testuser"
|
||||||
|
- 邮箱: "test@example.com"
|
||||||
|
- 密码: "password123"
|
||||||
|
- 确认密码: "password123"
|
||||||
|
2. 点击"发送验证码"
|
||||||
|
3. 查看控制台获取验证码
|
||||||
|
4. 输入验证码
|
||||||
|
5. 点击"注册"按钮
|
||||||
|
|
||||||
|
#### 预期结果
|
||||||
|
- 所有验证通过，无错误提示
|
||||||
|
- 显示"正在验证邮箱..."
|
||||||
|
- 显示"邮箱验证成功，正在注册..."
|
||||||
|
- 显示"注册成功！"
|
||||||
|
- 自动返回登录界面
|
||||||
|
- 用户名自动填入登录表单
|
||||||
|
|
||||||
|
## 边界情况测试
|
||||||
|
|
||||||
|
### 测试用例10: 网络异常
|
||||||
|
|
||||||
|
#### 步骤
|
||||||
|
1. 关闭后端服务
|
||||||
|
2. 尝试发送验证码
|
||||||
|
3. 尝试注册
|
||||||
|
|
||||||
|
#### 预期结果
|
||||||
|
- 显示"网络连接失败，请检查服务器是否启动"
|
||||||
|
- 按钮重新启用
|
||||||
|
|
||||||
|
### 测试用例11: 快速操作
|
||||||
|
|
||||||
|
#### 步骤
|
||||||
|
1. 快速连续点击"发送验证码"按钮
|
||||||
|
2. 快速连续点击"注册"按钮
|
||||||
|
|
||||||
|
#### 预期结果
|
||||||
|
- 按钮在请求期间被禁用
|
||||||
|
- 防止重复提交
|
||||||
|
|
||||||
|
### 测试用例12: 表单切换
|
||||||
|
|
||||||
|
#### 步骤
|
||||||
|
1. 在注册表单中输入信息并触发错误提示
|
||||||
|
2. 点击"返回登录"
|
||||||
|
3. 再次点击"注册居民身份"
|
||||||
|
|
||||||
|
#### 预期结果
|
||||||
|
- 切换到登录界面时，注册表单状态保持
|
||||||
|
- 再次进入注册界面时，表单被清空，错误提示被隐藏
|
||||||
|
|
||||||
|
## 性能测试
|
||||||
|
|
||||||
|
### 测试用例13: 响应速度
|
||||||
|
|
||||||
|
#### 步骤
|
||||||
|
1. 快速在各个输入框之间切换
|
||||||
|
2. 快速输入和删除文本
|
||||||
|
3. 观察错误提示的显示和隐藏速度
|
||||||
|
|
||||||
|
#### 预期结果
|
||||||
|
- 验证响应迅速，无明显延迟
|
||||||
|
- UI更新流畅，无卡顿现象
|
||||||
|
|
||||||
|
## 兼容性测试
|
||||||
|
|
||||||
|
### 测试用例14: 不同输入法
|
||||||
|
|
||||||
|
#### 步骤
|
||||||
|
1. 使用中文输入法输入用户名
|
||||||
|
2. 使用英文输入法输入用户名
|
||||||
|
3. 输入特殊字符
|
||||||
|
|
||||||
|
#### 预期结果
|
||||||
|
- 中文字符被正确验证为无效格式
|
||||||
|
- 英文字符正常通过验证
|
||||||
|
- 特殊字符按规则验证
|
||||||
|
|
||||||
|
## 测试检查清单
|
||||||
|
|
||||||
|
### 功能完整性
|
||||||
|
- [ ] 所有必填项都有红色星号标识
|
||||||
|
- [ ] 失焦验证正常工作
|
||||||
|
- [ ] 实时输入反馈正常
|
||||||
|
- [ ] 错误提示准确显示
|
||||||
|
- [ ] 验证码发送和验证功能正常
|
||||||
|
- [ ] 注册流程完整可用
|
||||||
|
|
||||||
|
### 用户体验
|
||||||
|
- [ ] 错误提示清晰易懂
|
||||||
|
- [ ] 按钮状态管理正确
|
||||||
|
- [ ] 表单切换流畅
|
||||||
|
- [ ] 成功反馈及时
|
||||||
|
|
||||||
|
### 错误处理
|
||||||
|
- [ ] 网络异常处理正确
|
||||||
|
- [ ] 服务器错误处理正确
|
||||||
|
- [ ] 边界情况处理正确
|
||||||
|
|
||||||
|
### 性能表现
|
||||||
|
- [ ] 验证响应速度快
|
||||||
|
- [ ] UI更新流畅
|
||||||
|
- [ ] 内存使用正常
|
||||||
|
|
||||||
|
## 测试报告模板
|
||||||
|
|
||||||
|
### 测试环境
|
||||||
|
- Godot版本:
|
||||||
|
- 操作系统:
|
||||||
|
- 后端服务状态:
|
||||||
|
- 测试时间:
|
||||||
|
|
||||||
|
### 测试结果
|
||||||
|
| 测试用例 | 状态 | 备注 |
|
||||||
|
|----------|------|------|
|
||||||
|
| 登录表单验证 | ✅/❌ | |
|
||||||
|
| 注册表单验证 | ✅/❌ | |
|
||||||
|
| 验证码功能 | ✅/❌ | |
|
||||||
|
| 网络异常处理 | ✅/❌ | |
|
||||||
|
| 完整注册流程 | ✅/❌ | |
|
||||||
|
|
||||||
|
### 发现的问题
|
||||||
|
1. 问题描述
|
||||||
|
- 重现步骤
|
||||||
|
- 预期结果
|
||||||
|
- 实际结果
|
||||||
|
- 严重程度
|
||||||
|
|
||||||
|
### 改进建议
|
||||||
|
1. 功能改进
|
||||||
|
2. 用户体验优化
|
||||||
|
3. 性能优化
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**测试完成日期**: ___________
|
||||||
|
**测试人员**: ___________
|
||||||
|
**测试版本**: v1.0.0
|
||||||
433
docs/code_comment_guide.md
Normal file
433
docs/code_comment_guide.md
Normal file
@@ -0,0 +1,433 @@
|
|||||||
|
# GDScript 代码注释规范
|
||||||
|
|
||||||
|
本文档详细说明了 whaleTown 项目中 GDScript 代码的注释规范，旨在提高代码可读性和维护性。
|
||||||
|
|
||||||
|
## 目录
|
||||||
|
|
||||||
|
- [基本原则](#基本原则)
|
||||||
|
- [文件头注释](#文件头注释)
|
||||||
|
- [类和函数注释](#类和函数注释)
|
||||||
|
- [变量注释](#变量注释)
|
||||||
|
- [行内注释](#行内注释)
|
||||||
|
- [特殊注释标记](#特殊注释标记)
|
||||||
|
- [AI辅助注释指南](#ai辅助注释指南)
|
||||||
|
|
||||||
|
## 基本原则
|
||||||
|
|
||||||
|
### 注释的目的
|
||||||
|
- **解释为什么**，而不是解释做什么
|
||||||
|
- **提供上下文**，帮助理解代码意图
|
||||||
|
- **记录重要决策**和设计考虑
|
||||||
|
- **警告潜在问题**和注意事项
|
||||||
|
|
||||||
|
### 注释质量标准
|
||||||
|
- 简洁明了，避免冗余
|
||||||
|
- 使用中文，保持一致性
|
||||||
|
- 及时更新，与代码同步
|
||||||
|
- 避免显而易见的注释
|
||||||
|
|
||||||
|
## 文件头注释
|
||||||
|
|
||||||
|
每个 GDScript 文件都应该包含文件头注释，说明文件的用途和基本信息。
|
||||||
|
|
||||||
|
### 标准格式
|
||||||
|
|
||||||
|
```gdscript
|
||||||
|
# ============================================================================
|
||||||
|
# 文件名: PlayerController.gd
|
||||||
|
# 作用: 玩家角色控制器，处理玩家输入和移动逻辑
|
||||||
|
#
|
||||||
|
# 主要功能:
|
||||||
|
# - 处理键盘和手柄输入
|
||||||
|
# - 控制角色移动和跳跃
|
||||||
|
# - 管理角色状态切换
|
||||||
|
# - 处理碰撞检测
|
||||||
|
#
|
||||||
|
# 依赖: MovementComponent, AnimationComponent
|
||||||
|
# 作者: [开发者名称]
|
||||||
|
# 创建时间: 2024-12-24
|
||||||
|
# ============================================================================
|
||||||
|
|
||||||
|
extends CharacterBody2D
|
||||||
|
```
|
||||||
|
|
||||||
|
### 管理器类文件头
|
||||||
|
|
||||||
|
```gdscript
|
||||||
|
# ============================================================================
|
||||||
|
# 游戏管理器 - GameManager.gd
|
||||||
|
#
|
||||||
|
# 全局单例管理器，负责游戏状态管理和生命周期控制
|
||||||
|
#
|
||||||
|
# 核心职责:
|
||||||
|
# - 游戏状态切换 (加载、认证、游戏中、暂停等)
|
||||||
|
# - 用户信息管理
|
||||||
|
# - 全局配置访问
|
||||||
|
# - 系统初始化和清理
|
||||||
|
#
|
||||||
|
# 使用方式:
|
||||||
|
# GameManager.change_state(GameManager.GameState.IN_GAME)
|
||||||
|
# GameManager.set_current_user("player123")
|
||||||
|
#
|
||||||
|
# 注意事项:
|
||||||
|
# - 作为自动加载单例，全局可访问
|
||||||
|
# - 状态变更会触发 game_state_changed 信号
|
||||||
|
# ============================================================================
|
||||||
|
|
||||||
|
extends Node
|
||||||
|
```
|
||||||
|
## 类和函数注释
|
||||||
|
|
||||||
|
### 类注释
|
||||||
|
|
||||||
|
```gdscript
|
||||||
|
# 玩家数据类
|
||||||
|
#
|
||||||
|
# 存储和管理玩家的基本属性和状态信息
|
||||||
|
# 支持数据序列化和反序列化，用于存档系统
|
||||||
|
class_name PlayerData
|
||||||
|
|
||||||
|
# 武器组件类
|
||||||
|
#
|
||||||
|
# 为角色提供武器功能，包括攻击、换弹、特殊技能等
|
||||||
|
# 可以挂载到任何具有攻击能力的角色上
|
||||||
|
#
|
||||||
|
# 使用示例:
|
||||||
|
# var weapon = WeaponComponent.new()
|
||||||
|
# weapon.setup_weapon("sword", 50)
|
||||||
|
# add_child(weapon)
|
||||||
|
class_name WeaponComponent
|
||||||
|
```
|
||||||
|
|
||||||
|
### 函数注释格式
|
||||||
|
|
||||||
|
```gdscript
|
||||||
|
# 处理玩家输入并更新移动状态
|
||||||
|
#
|
||||||
|
# 参数:
|
||||||
|
# delta: float - 帧时间间隔
|
||||||
|
#
|
||||||
|
# 返回值: 无
|
||||||
|
#
|
||||||
|
# 注意事项:
|
||||||
|
# - 需要在 _physics_process 中调用
|
||||||
|
# - 会自动处理重力和碰撞
|
||||||
|
func handle_movement(delta: float) -> void:
|
||||||
|
|
||||||
|
# 验证用户输入的邮箱格式
|
||||||
|
#
|
||||||
|
# 参数:
|
||||||
|
# email: String - 待验证的邮箱地址
|
||||||
|
#
|
||||||
|
# 返回值:
|
||||||
|
# Dictionary - 包含验证结果和错误信息
|
||||||
|
# {
|
||||||
|
# "valid": bool, # 是否有效
|
||||||
|
# "message": String # 错误信息（如果无效）
|
||||||
|
# }
|
||||||
|
#
|
||||||
|
# 使用示例:
|
||||||
|
# var result = validate_email("test@example.com")
|
||||||
|
# if result.valid:
|
||||||
|
# print("邮箱格式正确")
|
||||||
|
static func validate_email(email: String) -> Dictionary:
|
||||||
|
```
|
||||||
|
## 变量注释
|
||||||
|
|
||||||
|
### 成员变量注释
|
||||||
|
|
||||||
|
```gdscript
|
||||||
|
# 玩家基础属性
|
||||||
|
@export var max_health: int = 100 # 最大生命值
|
||||||
|
@export var move_speed: float = 200.0 # 移动速度 (像素/秒)
|
||||||
|
@export var jump_force: float = -400.0 # 跳跃力度 (负值向上)
|
||||||
|
|
||||||
|
# 状态管理
|
||||||
|
var current_health: int # 当前生命值
|
||||||
|
var is_grounded: bool = false # 是否在地面上
|
||||||
|
var can_double_jump: bool = true # 是否可以二段跳
|
||||||
|
|
||||||
|
# 节点引用 - 在 _ready() 中初始化
|
||||||
|
@onready var sprite: Sprite2D = $Sprite2D
|
||||||
|
@onready var collision: CollisionShape2D = $CollisionShape2D
|
||||||
|
@onready var animation_player: AnimationPlayer = $AnimationPlayer
|
||||||
|
|
||||||
|
# 私有变量 - 内部使用
|
||||||
|
var _velocity: Vector2 = Vector2.ZERO # 当前速度向量
|
||||||
|
var _last_direction: int = 1 # 最后面向方向 (1=右, -1=左)
|
||||||
|
```
|
||||||
|
|
||||||
|
### 常量注释
|
||||||
|
|
||||||
|
```gdscript
|
||||||
|
# 游戏配置常量
|
||||||
|
const GRAVITY: float = 980.0 # 重力加速度 (像素/秒²)
|
||||||
|
const MAX_FALL_SPEED: float = 1000.0 # 最大下落速度
|
||||||
|
const COYOTE_TIME: float = 0.1 # 土狼时间 (离开平台后仍可跳跃的时间)
|
||||||
|
|
||||||
|
# 输入动作名称
|
||||||
|
const ACTION_MOVE_LEFT: String = "move_left"
|
||||||
|
const ACTION_MOVE_RIGHT: String = "move_right"
|
||||||
|
const ACTION_JUMP: String = "jump"
|
||||||
|
|
||||||
|
# 动画名称常量
|
||||||
|
const ANIM_IDLE: String = "idle"
|
||||||
|
const ANIM_WALK: String = "walk"
|
||||||
|
const ANIM_JUMP: String = "jump"
|
||||||
|
const ANIM_FALL: String = "fall"
|
||||||
|
```
|
||||||
|
|
||||||
|
## 行内注释
|
||||||
|
|
||||||
|
### 复杂逻辑注释
|
||||||
|
|
||||||
|
```gdscript
|
||||||
|
func update_movement(delta: float):
|
||||||
|
# 处理水平移动输入
|
||||||
|
var input_direction = Input.get_axis("move_left", "move_right")
|
||||||
|
|
||||||
|
if input_direction != 0:
|
||||||
|
velocity.x = input_direction * move_speed
|
||||||
|
_last_direction = sign(input_direction) # 记录面向方向
|
||||||
|
else:
|
||||||
|
# 应用摩擦力，逐渐停止
|
||||||
|
velocity.x = move_toward(velocity.x, 0, friction * delta)
|
||||||
|
|
||||||
|
# 应用重力 (只在空中时)
|
||||||
|
if not is_on_floor():
|
||||||
|
velocity.y += gravity * delta
|
||||||
|
velocity.y = min(velocity.y, max_fall_speed) # 限制最大下落速度
|
||||||
|
|
||||||
|
# 处理跳跃输入
|
||||||
|
if Input.is_action_just_pressed("jump"):
|
||||||
|
if is_on_floor():
|
||||||
|
velocity.y = jump_force # 普通跳跃
|
||||||
|
elif can_double_jump:
|
||||||
|
velocity.y = jump_force * 0.8 # 二段跳 (力度稍小)
|
||||||
|
can_double_jump = false
|
||||||
|
|
||||||
|
# 重置二段跳能力
|
||||||
|
if is_on_floor() and not can_double_jump:
|
||||||
|
can_double_jump = true
|
||||||
|
```
|
||||||
|
|
||||||
|
### 临时解决方案注释
|
||||||
|
|
||||||
|
```gdscript
|
||||||
|
func handle_collision(body: Node2D):
|
||||||
|
# TODO: 重构碰撞处理逻辑，当前实现过于复杂
|
||||||
|
# FIXME: 在某些情况下会出现重复碰撞检测
|
||||||
|
# HACK: 临时解决方案，等待 Godot 4.6 修复相关 bug
|
||||||
|
|
||||||
|
if body.has_method("take_damage"):
|
||||||
|
# NOTE: 伤害计算需要考虑护甲和抗性
|
||||||
|
var damage = calculate_damage(base_damage)
|
||||||
|
body.take_damage(damage)
|
||||||
|
```
|
||||||
|
## 特殊注释标记
|
||||||
|
|
||||||
|
使用标准化的标记来标识不同类型的注释：
|
||||||
|
|
||||||
|
### 标记类型
|
||||||
|
|
||||||
|
```gdscript
|
||||||
|
# TODO: 待实现的功能
|
||||||
|
# TODO: 添加音效播放功能
|
||||||
|
# TODO: 实现存档系统
|
||||||
|
|
||||||
|
# FIXME: 需要修复的问题
|
||||||
|
# FIXME: 内存泄漏问题，需要及时释放资源
|
||||||
|
# FIXME: 在低帧率下移动不流畅
|
||||||
|
|
||||||
|
# HACK: 临时解决方案
|
||||||
|
# HACK: 绕过 Godot 引擎的已知 bug
|
||||||
|
# HACK: 临时方案，等待更好的实现
|
||||||
|
|
||||||
|
# NOTE: 重要说明
|
||||||
|
# NOTE: 此函数会修改全局状态，谨慎使用
|
||||||
|
# NOTE: 性能敏感代码，避免频繁调用
|
||||||
|
|
||||||
|
# WARNING: 警告信息
|
||||||
|
# WARNING: 不要在 _ready() 之前调用此函数
|
||||||
|
# WARNING: 此操作不可逆，请确认后执行
|
||||||
|
|
||||||
|
# OPTIMIZE: 性能优化点
|
||||||
|
# OPTIMIZE: 可以使用对象池优化内存分配
|
||||||
|
# OPTIMIZE: 考虑使用缓存提高查询效率
|
||||||
|
```
|
||||||
|
|
||||||
|
### 版本和兼容性标记
|
||||||
|
|
||||||
|
```gdscript
|
||||||
|
# @since 1.0.0 - 添加基础移动功能
|
||||||
|
# @deprecated 使用 new_movement_system() 替代
|
||||||
|
# @godot_version 4.5+ - 需要 Godot 4.5 或更高版本
|
||||||
|
# @platform_specific Windows/Linux - 仅在桌面平台可用
|
||||||
|
```
|
||||||
|
|
||||||
|
## AI辅助注释指南
|
||||||
|
|
||||||
|
### 为AI提供的注释模板
|
||||||
|
|
||||||
|
当需要AI帮助补充注释时，请使用以下模板：
|
||||||
|
|
||||||
|
```gdscript
|
||||||
|
# [AI_COMMENT_REQUEST]
|
||||||
|
# 请为以下函数添加详细注释，包括：
|
||||||
|
# - 功能描述
|
||||||
|
# - 参数说明
|
||||||
|
# - 返回值说明
|
||||||
|
# - 使用示例
|
||||||
|
# - 注意事项
|
||||||
|
func complex_function(param1: String, param2: int) -> Dictionary:
|
||||||
|
# 复杂的业务逻辑...
|
||||||
|
pass
|
||||||
|
```
|
||||||
|
|
||||||
|
### AI注释补充规则
|
||||||
|
|
||||||
|
1. **保持一致性** - 遵循项目现有的注释风格
|
||||||
|
2. **关注业务逻辑** - 重点解释业务含义，而非语法
|
||||||
|
3. **提供上下文** - 说明函数在整个系统中的作用
|
||||||
|
4. **标注复杂度** - 对复杂算法提供额外说明
|
||||||
|
|
||||||
|
### 示例：AI补充前后对比
|
||||||
|
|
||||||
|
**补充前：**
|
||||||
|
```gdscript
|
||||||
|
func calculate_damage(base_damage: int, armor: int, resistance: float) -> int:
|
||||||
|
var final_damage = base_damage
|
||||||
|
final_damage -= armor
|
||||||
|
final_damage *= (1.0 - resistance)
|
||||||
|
return max(1, final_damage)
|
||||||
|
```
|
||||||
|
|
||||||
|
**AI补充后：**
|
||||||
|
```gdscript
|
||||||
|
# 计算最终伤害值
|
||||||
|
#
|
||||||
|
# 根据基础伤害、护甲值和抗性计算实际造成的伤害
|
||||||
|
# 伤害计算公式: (基础伤害 - 护甲) × (1 - 抗性)
|
||||||
|
#
|
||||||
|
# 参数:
|
||||||
|
# base_damage: int - 基础伤害值
|
||||||
|
# armor: int - 目标护甲值 (减少固定伤害)
|
||||||
|
# resistance: float - 目标抗性 (0.0-1.0, 减少百分比伤害)
|
||||||
|
#
|
||||||
|
# 返回值:
|
||||||
|
# int - 最终伤害值 (最小为1，确保至少造成1点伤害)
|
||||||
|
#
|
||||||
|
# 使用示例:
|
||||||
|
# var damage = calculate_damage(100, 20, 0.3) # 结果: 56
|
||||||
|
#
|
||||||
|
# 注意事项:
|
||||||
|
# - 护甲为负值时会增加伤害
|
||||||
|
# - 抗性超过1.0时可能导致负伤害，但会被限制为1
|
||||||
|
func calculate_damage(base_damage: int, armor: int, resistance: float) -> int:
|
||||||
|
var final_damage = base_damage
|
||||||
|
final_damage -= armor # 减去护甲值
|
||||||
|
final_damage *= (1.0 - resistance) # 应用抗性
|
||||||
|
return max(1, final_damage) # 确保最小伤害为1
|
||||||
|
```
|
||||||
|
## 注释最佳实践
|
||||||
|
|
||||||
|
### 什么时候需要注释
|
||||||
|
|
||||||
|
**必须添加注释的情况：**
|
||||||
|
- 复杂的算法和业务逻辑
|
||||||
|
- 非显而易见的设计决策
|
||||||
|
- 临时解决方案和已知问题
|
||||||
|
- 公共API和接口函数
|
||||||
|
- 性能敏感的代码段
|
||||||
|
- 平台特定或版本特定的代码
|
||||||
|
|
||||||
|
**不需要注释的情况：**
|
||||||
|
- 显而易见的代码 (`var count = 0 # 计数器` ❌)
|
||||||
|
- 重复函数名的注释 (`func get_name() -> String: # 获取名称` ❌)
|
||||||
|
- 过时或错误的注释
|
||||||
|
|
||||||
|
### 注释维护原则
|
||||||
|
|
||||||
|
```gdscript
|
||||||
|
# ✅ 好的注释 - 解释为什么这样做
|
||||||
|
# 使用二分查找提高大数组的查询效率
|
||||||
|
# 当数组长度超过100时，线性查找性能会显著下降
|
||||||
|
func binary_search(array: Array, target: Variant) -> int:
|
||||||
|
|
||||||
|
# ❌ 坏的注释 - 重复代码内容
|
||||||
|
# 遍历数组查找目标值
|
||||||
|
func linear_search(array: Array, target: Variant) -> int:
|
||||||
|
```
|
||||||
|
|
||||||
|
### 团队协作注释
|
||||||
|
|
||||||
|
```gdscript
|
||||||
|
# 多人协作时的注释规范
|
||||||
|
class_name NetworkManager
|
||||||
|
|
||||||
|
# @author: 张三 - 网络连接模块
|
||||||
|
# @author: 李四 - 数据同步模块
|
||||||
|
# @reviewer: 王五 - 代码审查
|
||||||
|
# @last_modified: 2024-12-24
|
||||||
|
|
||||||
|
# 网络连接状态枚举
|
||||||
|
#
|
||||||
|
# 定义了客户端与服务器的连接状态
|
||||||
|
# 状态转换: DISCONNECTED -> CONNECTING -> CONNECTED -> DISCONNECTED
|
||||||
|
enum ConnectionState {
|
||||||
|
DISCONNECTED, # 未连接
|
||||||
|
CONNECTING, # 连接中
|
||||||
|
CONNECTED, # 已连接
|
||||||
|
RECONNECTING # 重连中 - @added by 李四 2024-12-20
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## 注释检查清单
|
||||||
|
|
||||||
|
在提交代码前，请检查以下项目：
|
||||||
|
|
||||||
|
### 文件级别检查
|
||||||
|
- [ ] 文件头注释完整（文件名、作用、主要功能）
|
||||||
|
- [ ] 依赖关系说明清楚
|
||||||
|
- [ ] 作者和创建时间已填写
|
||||||
|
|
||||||
|
### 函数级别检查
|
||||||
|
- [ ] 公共函数有完整的参数和返回值说明
|
||||||
|
- [ ] 复杂函数有使用示例
|
||||||
|
- [ ] 特殊情况和注意事项已标注
|
||||||
|
|
||||||
|
### 代码级别检查
|
||||||
|
- [ ] 复杂逻辑有行内注释说明
|
||||||
|
- [ ] 魔法数字有常量定义和注释
|
||||||
|
- [ ] TODO/FIXME 标记有明确的处理计划
|
||||||
|
|
||||||
|
### 质量检查
|
||||||
|
- [ ] 注释内容准确，与代码一致
|
||||||
|
- [ ] 中文表达清晰，无错别字
|
||||||
|
- [ ] 注释格式符合项目规范
|
||||||
|
|
||||||
|
## 注释工具和插件
|
||||||
|
|
||||||
|
### Godot编辑器设置
|
||||||
|
```
|
||||||
|
# 在 Godot 编辑器中设置注释快捷键
|
||||||
|
# 编辑器设置 -> 快捷键 -> 注释/取消注释: Ctrl+/
|
||||||
|
```
|
||||||
|
|
||||||
|
### 推荐的注释插件
|
||||||
|
- **GDScript Language Server** - 提供注释语法高亮
|
||||||
|
- **Code Formatter** - 自动格式化注释
|
||||||
|
- **Documentation Generator** - 自动生成API文档
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 总结
|
||||||
|
|
||||||
|
良好的注释是代码质量的重要组成部分。遵循本规范可以：
|
||||||
|
|
||||||
|
1. **提高代码可读性** - 帮助团队成员快速理解代码
|
||||||
|
2. **降低维护成本** - 减少后期修改和调试时间
|
||||||
|
3. **促进知识传承** - 保留设计思路和业务逻辑
|
||||||
|
4. **支持AI辅助开发** - 为AI提供更好的上下文信息
|
||||||
|
|
||||||
|
记住：**好的注释解释为什么，而不是做什么。**
|
||||||
464
docs/module_development.md
Normal file
464
docs/module_development.md
Normal file
@@ -0,0 +1,464 @@
|
|||||||
|
# 模块开发指南
|
||||||
|
|
||||||
|
本文档详细说明如何在 Whale Town 项目中开发新的游戏模块。
|
||||||
|
|
||||||
|
## 🎯 模块设计原则
|
||||||
|
|
||||||
|
### 核心原则
|
||||||
|
1. **单一职责** - 每个模块只负责一个特定的游戏功能
|
||||||
|
2. **高内聚低耦合** - 模块内部紧密相关，模块间松散耦合
|
||||||
|
3. **可复用性** - 模块应该能在不同场景中复用
|
||||||
|
4. **标准化接口** - 统一的模块接口和通信方式
|
||||||
|
5. **测试友好** - 模块应该易于测试和调试
|
||||||
|
|
||||||
|
### 模块分类
|
||||||
|
- **UI模块** - 用户界面组件和交互逻辑
|
||||||
|
- **游戏逻辑模块** - 角色、战斗、对话等核心功能
|
||||||
|
- **系统模块** - 存档、设置、网络等系统功能
|
||||||
|
- **工具模块** - 通用工具和辅助功能
|
||||||
|
|
||||||
|
## 🏗️ 模块结构
|
||||||
|
|
||||||
|
### 标准目录结构
|
||||||
|
```
|
||||||
|
module/YourModule/
|
||||||
|
├── YourModule.gd # 主模块脚本
|
||||||
|
├── components/ # 子组件
|
||||||
|
│ ├── Component1.gd
|
||||||
|
│ └── Component2.gd
|
||||||
|
├── data/ # 模块数据
|
||||||
|
│ ├── module_config.json
|
||||||
|
│ └── default_data.json
|
||||||
|
├── scenes/ # 模块场景
|
||||||
|
│ ├── YourModule.tscn
|
||||||
|
│ └── components/
|
||||||
|
├── tests/ # 模块测试
|
||||||
|
│ ├── test_your_module.gd
|
||||||
|
│ └── test_components.gd
|
||||||
|
└── README.md # 模块文档
|
||||||
|
```
|
||||||
|
|
||||||
|
### 文件命名规范
|
||||||
|
- **主模块脚本**: `ModuleName.gd` (PascalCase)
|
||||||
|
- **组件脚本**: `ComponentName.gd` (PascalCase)
|
||||||
|
- **场景文件**: `module_name.tscn` (snake_case)
|
||||||
|
- **数据文件**: `snake_case.json`
|
||||||
|
- **测试文件**: `test_module_name.gd`
|
||||||
|
|
||||||
|
## 📝 模块开发步骤
|
||||||
|
|
||||||
|
### 第一步：创建模块结构
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 创建模块目录
|
||||||
|
mkdir module/YourModule
|
||||||
|
cd module/YourModule
|
||||||
|
|
||||||
|
# 创建子目录
|
||||||
|
mkdir components data scenes tests
|
||||||
|
|
||||||
|
# 创建主要文件
|
||||||
|
touch YourModule.gd
|
||||||
|
touch README.md
|
||||||
|
touch data/module_config.json
|
||||||
|
```
|
||||||
|
|
||||||
|
### 第二步：实现模块接口
|
||||||
|
|
||||||
|
每个模块都应该实现标准的模块接口：
|
||||||
|
|
||||||
|
```gdscript
|
||||||
|
# YourModule.gd
|
||||||
|
extends Node
|
||||||
|
class_name YourModule
|
||||||
|
|
||||||
|
# 模块信息
|
||||||
|
const MODULE_NAME = "YourModule"
|
||||||
|
const MODULE_VERSION = "1.0.0"
|
||||||
|
const MODULE_AUTHOR = "Your Name"
|
||||||
|
|
||||||
|
# 模块状态
|
||||||
|
enum ModuleState {
|
||||||
|
UNINITIALIZED,
|
||||||
|
INITIALIZING,
|
||||||
|
READY,
|
||||||
|
ERROR
|
||||||
|
}
|
||||||
|
|
||||||
|
var current_state: ModuleState = ModuleState.UNINITIALIZED
|
||||||
|
var config: Dictionary = {}
|
||||||
|
var is_enabled: bool = true
|
||||||
|
|
||||||
|
# 必需接口方法
|
||||||
|
func initialize() -> bool:
|
||||||
|
"""初始化模块"""
|
||||||
|
current_state = ModuleState.INITIALIZING
|
||||||
|
|
||||||
|
# 加载配置
|
||||||
|
if not _load_config():
|
||||||
|
current_state = ModuleState.ERROR
|
||||||
|
return false
|
||||||
|
|
||||||
|
# 初始化组件
|
||||||
|
if not _initialize_components():
|
||||||
|
current_state = ModuleState.ERROR
|
||||||
|
return false
|
||||||
|
|
||||||
|
# 注册事件监听
|
||||||
|
_register_events()
|
||||||
|
|
||||||
|
current_state = ModuleState.READY
|
||||||
|
return true
|
||||||
|
|
||||||
|
func cleanup():
|
||||||
|
"""清理模块资源"""
|
||||||
|
_unregister_events()
|
||||||
|
_cleanup_components()
|
||||||
|
current_state = ModuleState.UNINITIALIZED
|
||||||
|
|
||||||
|
func get_module_info() -> Dictionary:
|
||||||
|
"""获取模块信息"""
|
||||||
|
return {
|
||||||
|
"name": MODULE_NAME,
|
||||||
|
"version": MODULE_VERSION,
|
||||||
|
"author": MODULE_AUTHOR,
|
||||||
|
"state": current_state,
|
||||||
|
"enabled": is_enabled
|
||||||
|
}
|
||||||
|
|
||||||
|
# 私有方法
|
||||||
|
func _load_config() -> bool:
|
||||||
|
"""加载模块配置"""
|
||||||
|
var config_path = "res://module/%s/data/module_config.json" % MODULE_NAME
|
||||||
|
if not FileAccess.file_exists(config_path):
|
||||||
|
print("警告: 模块配置文件不存在: ", config_path)
|
||||||
|
return true # 使用默认配置
|
||||||
|
|
||||||
|
var file = FileAccess.open(config_path, FileAccess.READ)
|
||||||
|
if file == null:
|
||||||
|
print("错误: 无法读取配置文件: ", config_path)
|
||||||
|
return false
|
||||||
|
|
||||||
|
var json_string = file.get_as_text()
|
||||||
|
file.close()
|
||||||
|
|
||||||
|
var json = JSON.new()
|
||||||
|
var parse_result = json.parse(json_string)
|
||||||
|
if parse_result != OK:
|
||||||
|
print("错误: 配置文件JSON格式错误: ", config_path)
|
||||||
|
return false
|
||||||
|
|
||||||
|
config = json.data
|
||||||
|
return true
|
||||||
|
|
||||||
|
func _initialize_components() -> bool:
|
||||||
|
"""初始化子组件"""
|
||||||
|
# 在这里初始化模块的子组件
|
||||||
|
return true
|
||||||
|
|
||||||
|
func _cleanup_components():
|
||||||
|
"""清理子组件"""
|
||||||
|
# 在这里清理模块的子组件
|
||||||
|
pass
|
||||||
|
|
||||||
|
func _register_events():
|
||||||
|
"""注册事件监听"""
|
||||||
|
# 使用EventSystem注册需要监听的事件
|
||||||
|
# EventSystem.connect_event("event_name", _on_event_handler)
|
||||||
|
pass
|
||||||
|
|
||||||
|
func _unregister_events():
|
||||||
|
"""取消事件监听"""
|
||||||
|
# 取消所有事件监听
|
||||||
|
# EventSystem.disconnect_event("event_name", _on_event_handler)
|
||||||
|
pass
|
||||||
|
```
|
||||||
|
|
||||||
|
### 第三步：创建模块配置
|
||||||
|
|
||||||
|
```json
|
||||||
|
// data/module_config.json
|
||||||
|
{
|
||||||
|
"module_name": "YourModule",
|
||||||
|
"version": "1.0.0",
|
||||||
|
"enabled": true,
|
||||||
|
"dependencies": [],
|
||||||
|
"settings": {
|
||||||
|
"auto_initialize": true,
|
||||||
|
"debug_mode": false
|
||||||
|
},
|
||||||
|
"resources": {
|
||||||
|
"textures": [],
|
||||||
|
"sounds": [],
|
||||||
|
"data_files": []
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 第四步：实现具体功能
|
||||||
|
|
||||||
|
根据模块类型实现具体功能：
|
||||||
|
|
||||||
|
#### UI模块示例
|
||||||
|
```gdscript
|
||||||
|
# UI模块应该继承Control或其子类
|
||||||
|
extends Control
|
||||||
|
class_name UIModule
|
||||||
|
|
||||||
|
signal ui_event_triggered(event_name: String, data: Dictionary)
|
||||||
|
|
||||||
|
func show_ui():
|
||||||
|
"""显示UI"""
|
||||||
|
visible = true
|
||||||
|
# 播放显示动画
|
||||||
|
_play_show_animation()
|
||||||
|
|
||||||
|
func hide_ui():
|
||||||
|
"""隐藏UI"""
|
||||||
|
# 播放隐藏动画
|
||||||
|
_play_hide_animation()
|
||||||
|
await get_tree().create_timer(0.3).timeout
|
||||||
|
visible = false
|
||||||
|
|
||||||
|
func _play_show_animation():
|
||||||
|
"""播放显示动画"""
|
||||||
|
var tween = create_tween()
|
||||||
|
modulate.a = 0.0
|
||||||
|
tween.tween_property(self, "modulate:a", 1.0, 0.3)
|
||||||
|
|
||||||
|
func _play_hide_animation():
|
||||||
|
"""播放隐藏动画"""
|
||||||
|
var tween = create_tween()
|
||||||
|
tween.tween_property(self, "modulate:a", 0.0, 0.3)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 游戏逻辑模块示例
|
||||||
|
```gdscript
|
||||||
|
# 游戏逻辑模块
|
||||||
|
extends Node
|
||||||
|
class_name GameLogicModule
|
||||||
|
|
||||||
|
signal state_changed(old_state: String, new_state: String)
|
||||||
|
signal data_updated(data_type: String, new_data: Dictionary)
|
||||||
|
|
||||||
|
var module_data: Dictionary = {}
|
||||||
|
var current_state: String = "idle"
|
||||||
|
|
||||||
|
func process_game_logic(delta: float):
|
||||||
|
"""处理游戏逻辑"""
|
||||||
|
match current_state:
|
||||||
|
"idle":
|
||||||
|
_process_idle_state(delta)
|
||||||
|
"active":
|
||||||
|
_process_active_state(delta)
|
||||||
|
"paused":
|
||||||
|
_process_paused_state(delta)
|
||||||
|
|
||||||
|
func change_state(new_state: String):
|
||||||
|
"""改变模块状态"""
|
||||||
|
var old_state = current_state
|
||||||
|
current_state = new_state
|
||||||
|
state_changed.emit(old_state, new_state)
|
||||||
|
|
||||||
|
func update_data(data_type: String, new_data: Dictionary):
|
||||||
|
"""更新模块数据"""
|
||||||
|
module_data[data_type] = new_data
|
||||||
|
data_updated.emit(data_type, new_data)
|
||||||
|
```
|
||||||
|
|
||||||
|
### 第五步：添加测试
|
||||||
|
|
||||||
|
```gdscript
|
||||||
|
# tests/test_your_module.gd
|
||||||
|
extends "res://addons/gut/test.gd"
|
||||||
|
|
||||||
|
var module: YourModule
|
||||||
|
|
||||||
|
func before_each():
|
||||||
|
module = YourModule.new()
|
||||||
|
add_child(module)
|
||||||
|
|
||||||
|
func after_each():
|
||||||
|
module.queue_free()
|
||||||
|
|
||||||
|
func test_module_initialization():
|
||||||
|
assert_true(module.initialize(), "模块应该能够正确初始化")
|
||||||
|
assert_eq(module.current_state, YourModule.ModuleState.READY, "初始化后状态应该为READY")
|
||||||
|
|
||||||
|
func test_module_cleanup():
|
||||||
|
module.initialize()
|
||||||
|
module.cleanup()
|
||||||
|
assert_eq(module.current_state, YourModule.ModuleState.UNINITIALIZED, "清理后状态应该为UNINITIALIZED")
|
||||||
|
|
||||||
|
func test_module_info():
|
||||||
|
var info = module.get_module_info()
|
||||||
|
assert_true(info.has("name"), "模块信息应该包含名称")
|
||||||
|
assert_true(info.has("version"), "模块信息应该包含版本")
|
||||||
|
assert_eq(info.name, "YourModule", "模块名称应该正确")
|
||||||
|
```
|
||||||
|
|
||||||
|
### 第六步：编写文档
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
# YourModule 模块
|
||||||
|
|
||||||
|
## 功能描述
|
||||||
|
简要描述模块的主要功能和用途。
|
||||||
|
|
||||||
|
## 使用方法
|
||||||
|
```gdscript
|
||||||
|
# 创建和初始化模块
|
||||||
|
var your_module = YourModule.new()
|
||||||
|
add_child(your_module)
|
||||||
|
your_module.initialize()
|
||||||
|
|
||||||
|
# 使用模块功能
|
||||||
|
your_module.some_function()
|
||||||
|
```
|
||||||
|
|
||||||
|
## API参考
|
||||||
|
### 公共方法
|
||||||
|
- `initialize() -> bool` - 初始化模块
|
||||||
|
- `cleanup()` - 清理模块资源
|
||||||
|
- `get_module_info() -> Dictionary` - 获取模块信息
|
||||||
|
|
||||||
|
### 信号
|
||||||
|
- `signal_name(param: Type)` - 信号描述
|
||||||
|
|
||||||
|
## 配置选项
|
||||||
|
描述模块的配置选项和默认值。
|
||||||
|
|
||||||
|
## 依赖关系
|
||||||
|
列出模块的依赖项。
|
||||||
|
|
||||||
|
## 注意事项
|
||||||
|
使用模块时需要注意的事项。
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🔧 模块集成
|
||||||
|
|
||||||
|
### 在场景中使用模块
|
||||||
|
|
||||||
|
```gdscript
|
||||||
|
# 在场景脚本中使用模块
|
||||||
|
extends Control
|
||||||
|
|
||||||
|
var inventory_module: InventoryModule
|
||||||
|
var dialogue_module: DialogueModule
|
||||||
|
|
||||||
|
func _ready():
|
||||||
|
# 创建并初始化模块
|
||||||
|
inventory_module = InventoryModule.new()
|
||||||
|
add_child(inventory_module)
|
||||||
|
inventory_module.initialize()
|
||||||
|
|
||||||
|
dialogue_module = DialogueModule.new()
|
||||||
|
add_child(dialogue_module)
|
||||||
|
dialogue_module.initialize()
|
||||||
|
|
||||||
|
# 连接模块事件
|
||||||
|
inventory_module.item_selected.connect(_on_item_selected)
|
||||||
|
dialogue_module.dialogue_finished.connect(_on_dialogue_finished)
|
||||||
|
|
||||||
|
func _on_item_selected(item_data: Dictionary):
|
||||||
|
print("选中物品: ", item_data.name)
|
||||||
|
|
||||||
|
func _on_dialogue_finished():
|
||||||
|
print("对话结束")
|
||||||
|
```
|
||||||
|
|
||||||
|
### 模块间通信
|
||||||
|
|
||||||
|
推荐使用EventSystem进行模块间通信：
|
||||||
|
|
||||||
|
```gdscript
|
||||||
|
# 发送事件
|
||||||
|
EventSystem.emit_event("inventory_item_used", {
|
||||||
|
"item_id": "potion_001",
|
||||||
|
"quantity": 1
|
||||||
|
})
|
||||||
|
|
||||||
|
# 监听事件
|
||||||
|
EventSystem.connect_event("inventory_item_used", _on_item_used)
|
||||||
|
|
||||||
|
func _on_item_used(data: Dictionary):
|
||||||
|
print("使用了物品: ", data.item_id)
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🧪 测试和调试
|
||||||
|
|
||||||
|
### 单元测试
|
||||||
|
每个模块都应该有对应的单元测试：
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 运行模块测试
|
||||||
|
godot --headless --script tests/test_your_module.gd
|
||||||
|
```
|
||||||
|
|
||||||
|
### 调试技巧
|
||||||
|
1. **使用print语句** - 在关键位置添加调试输出
|
||||||
|
2. **断点调试** - 在Godot编辑器中设置断点
|
||||||
|
3. **状态监控** - 实时监控模块状态变化
|
||||||
|
4. **事件追踪** - 记录事件的发送和接收
|
||||||
|
|
||||||
|
### 性能监控
|
||||||
|
```gdscript
|
||||||
|
# 性能监控示例
|
||||||
|
func _process(delta):
|
||||||
|
var start_time = Time.get_time_dict_from_system()
|
||||||
|
|
||||||
|
# 执行模块逻辑
|
||||||
|
process_module_logic(delta)
|
||||||
|
|
||||||
|
var end_time = Time.get_time_dict_from_system()
|
||||||
|
var execution_time = (end_time.hour * 3600 + end_time.minute * 60 + end_time.second) - \
|
||||||
|
(start_time.hour * 3600 + start_time.minute * 60 + start_time.second)
|
||||||
|
|
||||||
|
if execution_time > 0.016: # 超过16ms
|
||||||
|
print("警告: 模块执行时间过长: ", execution_time, "秒")
|
||||||
|
```
|
||||||
|
|
||||||
|
## 📚 最佳实践
|
||||||
|
|
||||||
|
### 代码质量
|
||||||
|
1. **遵循命名规范** - 使用清晰、一致的命名
|
||||||
|
2. **添加详细注释** - 解释复杂逻辑和设计决策
|
||||||
|
3. **错误处理** - 妥善处理各种异常情况
|
||||||
|
4. **资源管理** - 及时释放不需要的资源
|
||||||
|
|
||||||
|
### 性能优化
|
||||||
|
1. **避免频繁的内存分配** - 重用对象和数据结构
|
||||||
|
2. **合理使用信号** - 避免过多的信号连接
|
||||||
|
3. **批量处理** - 将多个操作合并处理
|
||||||
|
4. **延迟加载** - 按需加载资源和数据
|
||||||
|
|
||||||
|
### 可维护性
|
||||||
|
1. **模块化设计** - 保持模块的独立性
|
||||||
|
2. **版本控制** - 记录模块的版本变化
|
||||||
|
3. **文档更新** - 及时更新模块文档
|
||||||
|
4. **向后兼容** - 考虑API的向后兼容性
|
||||||
|
|
||||||
|
## 🔍 常见问题
|
||||||
|
|
||||||
|
### Q: 如何处理模块依赖？
|
||||||
|
A: 在模块配置中声明依赖，在初始化时检查依赖是否满足。
|
||||||
|
|
||||||
|
### Q: 模块间如何共享数据？
|
||||||
|
A: 使用EventSystem传递数据，或通过GameManager等全局管理器。
|
||||||
|
|
||||||
|
### Q: 如何调试模块问题？
|
||||||
|
A: 使用Godot的调试工具，添加日志输出，编写单元测试。
|
||||||
|
|
||||||
|
### Q: 模块性能如何优化？
|
||||||
|
A: 避免在_process中执行重复计算，使用对象池，合理管理资源。
|
||||||
|
|
||||||
|
## 📖 参考资料
|
||||||
|
|
||||||
|
- [Godot官方文档](https://docs.godotengine.org/)
|
||||||
|
- [项目命名规范](./naming_convention.md)
|
||||||
|
- [代码注释规范](./code_comment_guide.md)
|
||||||
|
- [Git提交规范](./git_commit_guide.md)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**记住：好的模块设计是项目成功的关键！**
|
||||||
@@ -404,6 +404,37 @@ FONT_MAIN.ttf
|
|||||||
- 全部使用小写字母
|
- 全部使用小写字母
|
||||||
- 同系列资源使用数字后缀，如 `tile_01.png`、`tile_02.png`
|
- 同系列资源使用数字后缀，如 `tile_01.png`、`tile_02.png`
|
||||||
|
|
||||||
|
### 扩展资源类型
|
||||||
|
|
||||||
|
```
|
||||||
|
✅ 正确
|
||||||
|
# 材质资源
|
||||||
|
material_metal.tres # 金属材质
|
||||||
|
material_wood.tres # 木材材质
|
||||||
|
material_water.tres # 水材质
|
||||||
|
|
||||||
|
# 着色器资源
|
||||||
|
shader_water.gdshader # 水着色器
|
||||||
|
shader_fire.gdshader # 火焰着色器
|
||||||
|
shader_outline.gdshader # 轮廓着色器
|
||||||
|
|
||||||
|
# 特效资源
|
||||||
|
fx_explosion.png # 爆炸特效
|
||||||
|
fx_magic_circle.png # 魔法阵特效
|
||||||
|
fx_damage_numbers.png # 伤害数字特效
|
||||||
|
|
||||||
|
# 环境资源
|
||||||
|
obj_tree.png # 树木对象
|
||||||
|
obj_rock.png # 岩石对象
|
||||||
|
tile_grass_01.png # 草地瓦片
|
||||||
|
tile_stone_01.png # 石头瓦片
|
||||||
|
|
||||||
|
❌ 错误
|
||||||
|
MetalMaterial.tres # 不使用大驼峰
|
||||||
|
material-wood.tres # 不使用连字符
|
||||||
|
SHADER_WATER.gdshader # 不使用全大写
|
||||||
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 目录结构
|
## 目录结构
|
||||||
@@ -421,11 +452,33 @@ assets/ # 资源目录
|
|||||||
sounds/ # 音效
|
sounds/ # 音效
|
||||||
music/ # 音乐
|
music/ # 音乐
|
||||||
fonts/ # 字体
|
fonts/ # 字体
|
||||||
|
materials/ # 材质
|
||||||
|
shaders/ # 着色器
|
||||||
data/ # 数据目录
|
data/ # 数据目录
|
||||||
levels/ # 关卡数据
|
levels/ # 关卡数据
|
||||||
configs/ # 配置文件
|
configs/ # 配置文件
|
||||||
|
dialogues/ # 对话数据
|
||||||
|
localization/ # 本地化数据
|
||||||
|
core/ # 核心系统目录
|
||||||
|
managers/ # 管理器
|
||||||
|
systems/ # 系统组件
|
||||||
|
utils/ # 工具类
|
||||||
|
components/ # 通用组件
|
||||||
|
interfaces/ # 接口定义
|
||||||
|
module/ # 模块目录
|
||||||
|
UI/ # UI模块
|
||||||
|
Character/ # 角色模块
|
||||||
|
Inventory/ # 背包模块
|
||||||
|
Combat/ # 战斗模块
|
||||||
|
Dialogue/ # 对话模块
|
||||||
addons/ # 插件目录
|
addons/ # 插件目录
|
||||||
tests/ # 测试目录
|
tests/ # 测试目录
|
||||||
|
unit/ # 单元测试
|
||||||
|
integration/ # 集成测试
|
||||||
|
ui/ # UI测试
|
||||||
|
performance/ # 性能测试
|
||||||
|
docs/ # 文档目录
|
||||||
|
auth/ # 认证相关文档
|
||||||
|
|
||||||
❌ 错误
|
❌ 错误
|
||||||
Scenes/ # 不使用大写
|
Scenes/ # 不使用大写
|
||||||
|
|||||||
507
docs/performance_optimization.md
Normal file
507
docs/performance_optimization.md
Normal file
@@ -0,0 +1,507 @@
|
|||||||
|
# 性能优化指南
|
||||||
|
|
||||||
|
本文档提供 Whale Town 项目的性能优化策略和最佳实践。
|
||||||
|
|
||||||
|
## 🎯 优化目标
|
||||||
|
|
||||||
|
### 性能指标
|
||||||
|
- **帧率**: 保持60FPS稳定运行
|
||||||
|
- **内存使用**: 控制在合理范围内
|
||||||
|
- **加载时间**: 场景切换<2秒
|
||||||
|
- **响应时间**: UI交互<100ms
|
||||||
|
|
||||||
|
### 优化原则
|
||||||
|
1. **测量优先** - 先测量再优化
|
||||||
|
2. **渐进优化** - 逐步改进性能
|
||||||
|
3. **平衡取舍** - 在质量和性能间平衡
|
||||||
|
4. **用户体验** - 优化用户感知性能
|
||||||
|
|
||||||
|
## 🔧 渲染优化
|
||||||
|
|
||||||
|
### 纹理优化
|
||||||
|
```gdscript
|
||||||
|
# 使用合适的纹理格式
|
||||||
|
# 小图标使用 RGBA8
|
||||||
|
# 大背景使用 DXT1/DXT5
|
||||||
|
# UI元素使用 RGBA4444
|
||||||
|
|
||||||
|
# 纹理压缩设置
|
||||||
|
func optimize_texture_import():
|
||||||
|
# 在导入设置中启用压缩
|
||||||
|
# 设置合适的最大尺寸
|
||||||
|
# 启用Mipmaps（3D纹理）
|
||||||
|
pass
|
||||||
|
```
|
||||||
|
|
||||||
|
### 批处理优化
|
||||||
|
```gdscript
|
||||||
|
# 合并相同材质的对象
|
||||||
|
# 使用MultiMesh渲染大量相同对象
|
||||||
|
func create_multimesh_instances():
|
||||||
|
var multimesh = MultiMesh.new()
|
||||||
|
multimesh.transform_format = MultiMesh.TRANSFORM_2D
|
||||||
|
multimesh.instance_count = 100
|
||||||
|
|
||||||
|
var mesh_instance = MeshInstance2D.new()
|
||||||
|
mesh_instance.multimesh = multimesh
|
||||||
|
add_child(mesh_instance)
|
||||||
|
```
|
||||||
|
|
||||||
|
### 视锥剔除
|
||||||
|
```gdscript
|
||||||
|
# 只渲染可见区域的对象
|
||||||
|
func update_visibility():
|
||||||
|
var camera = get_viewport().get_camera_2d()
|
||||||
|
var screen_rect = get_viewport_rect()
|
||||||
|
|
||||||
|
for child in get_children():
|
||||||
|
if child is Node2D:
|
||||||
|
var visible = screen_rect.intersects(child.get_rect())
|
||||||
|
child.visible = visible
|
||||||
|
```
|
||||||
|
|
||||||
|
## 💾 内存优化
|
||||||
|
|
||||||
|
### 对象池模式
|
||||||
|
```gdscript
|
||||||
|
# ObjectPool.gd
|
||||||
|
class_name ObjectPool
|
||||||
|
extends Node
|
||||||
|
|
||||||
|
var pools: Dictionary = {}
|
||||||
|
|
||||||
|
func get_object(type: String) -> Node:
|
||||||
|
if not pools.has(type):
|
||||||
|
pools[type] = []
|
||||||
|
|
||||||
|
var pool = pools[type]
|
||||||
|
if pool.size() > 0:
|
||||||
|
return pool.pop_back()
|
||||||
|
else:
|
||||||
|
return _create_new_object(type)
|
||||||
|
|
||||||
|
func return_object(obj: Node, type: String):
|
||||||
|
obj.reset() # 重置对象状态
|
||||||
|
pools[type].append(obj)
|
||||||
|
|
||||||
|
func _create_new_object(type: String) -> Node:
|
||||||
|
match type:
|
||||||
|
"Bullet":
|
||||||
|
return preload("res://prefabs/Bullet.tscn").instantiate()
|
||||||
|
"Enemy":
|
||||||
|
return preload("res://prefabs/Enemy.tscn").instantiate()
|
||||||
|
_:
|
||||||
|
return null
|
||||||
|
```
|
||||||
|
|
||||||
|
### 资源管理
|
||||||
|
```gdscript
|
||||||
|
# ResourceManager.gd
|
||||||
|
class_name ResourceManager
|
||||||
|
extends Node
|
||||||
|
|
||||||
|
var loaded_resources: Dictionary = {}
|
||||||
|
var resource_usage: Dictionary = {}
|
||||||
|
|
||||||
|
func load_resource(path: String) -> Resource:
|
||||||
|
if loaded_resources.has(path):
|
||||||
|
resource_usage[path] += 1
|
||||||
|
return loaded_resources[path]
|
||||||
|
|
||||||
|
var resource = load(path)
|
||||||
|
loaded_resources[path] = resource
|
||||||
|
resource_usage[path] = 1
|
||||||
|
return resource
|
||||||
|
|
||||||
|
func unload_resource(path: String):
|
||||||
|
if resource_usage.has(path):
|
||||||
|
resource_usage[path] -= 1
|
||||||
|
if resource_usage[path] <= 0:
|
||||||
|
loaded_resources.erase(path)
|
||||||
|
resource_usage.erase(path)
|
||||||
|
```
|
||||||
|
|
||||||
|
### 内存监控
|
||||||
|
```gdscript
|
||||||
|
# MemoryMonitor.gd
|
||||||
|
extends Node
|
||||||
|
|
||||||
|
func _ready():
|
||||||
|
# 每秒检查一次内存使用
|
||||||
|
var timer = Timer.new()
|
||||||
|
timer.wait_time = 1.0
|
||||||
|
timer.timeout.connect(_check_memory)
|
||||||
|
add_child(timer)
|
||||||
|
timer.start()
|
||||||
|
|
||||||
|
func _check_memory():
|
||||||
|
var memory_usage = OS.get_static_memory_usage_by_type()
|
||||||
|
var total_memory = OS.get_static_memory_peak_usage()
|
||||||
|
|
||||||
|
print("内存使用: ", memory_usage / 1024 / 1024, "MB")
|
||||||
|
print("峰值内存: ", total_memory / 1024 / 1024, "MB")
|
||||||
|
|
||||||
|
# 内存使用过高时触发垃圾回收
|
||||||
|
if total_memory > 200 * 1024 * 1024: # 200MB
|
||||||
|
print("触发垃圾回收")
|
||||||
|
# 清理不必要的资源
|
||||||
|
_cleanup_resources()
|
||||||
|
|
||||||
|
func _cleanup_resources():
|
||||||
|
# 清理缓存
|
||||||
|
# 卸载未使用的资源
|
||||||
|
# 强制垃圾回收
|
||||||
|
pass
|
||||||
|
```
|
||||||
|
|
||||||
|
## ⚡ 脚本优化
|
||||||
|
|
||||||
|
### 避免频繁计算
|
||||||
|
```gdscript
|
||||||
|
# ❌ 错误示例：每帧计算
|
||||||
|
func _process(delta):
|
||||||
|
var distance = global_position.distance_to(target.global_position)
|
||||||
|
if distance < 100:
|
||||||
|
attack_target()
|
||||||
|
|
||||||
|
# ✅ 正确示例：缓存计算结果
|
||||||
|
var cached_distance: float = 0.0
|
||||||
|
var distance_update_timer: float = 0.0
|
||||||
|
|
||||||
|
func _process(delta):
|
||||||
|
distance_update_timer += delta
|
||||||
|
if distance_update_timer >= 0.1: # 每100ms更新一次
|
||||||
|
cached_distance = global_position.distance_to(target.global_position)
|
||||||
|
distance_update_timer = 0.0
|
||||||
|
|
||||||
|
if cached_distance < 100:
|
||||||
|
attack_target()
|
||||||
|
```
|
||||||
|
|
||||||
|
### 优化循环
|
||||||
|
```gdscript
|
||||||
|
# ❌ 错误示例：嵌套循环
|
||||||
|
func find_nearest_enemy():
|
||||||
|
var nearest = null
|
||||||
|
var min_distance = INF
|
||||||
|
|
||||||
|
for enemy in enemies:
|
||||||
|
for player in players:
|
||||||
|
var distance = enemy.global_position.distance_to(player.global_position)
|
||||||
|
if distance < min_distance:
|
||||||
|
min_distance = distance
|
||||||
|
nearest = enemy
|
||||||
|
|
||||||
|
# ✅ 正确示例：优化算法
|
||||||
|
func find_nearest_enemy():
|
||||||
|
var player_pos = player.global_position
|
||||||
|
var nearest = null
|
||||||
|
var min_distance = INF
|
||||||
|
|
||||||
|
for enemy in enemies:
|
||||||
|
var distance = enemy.global_position.distance_squared_to(player_pos)
|
||||||
|
if distance < min_distance:
|
||||||
|
min_distance = distance
|
||||||
|
nearest = enemy
|
||||||
|
```
|
||||||
|
|
||||||
|
### 事件优化
|
||||||
|
```gdscript
|
||||||
|
# 使用信号代替轮询
|
||||||
|
# ❌ 错误示例：轮询检查
|
||||||
|
func _process(delta):
|
||||||
|
if player.health <= 0:
|
||||||
|
game_over()
|
||||||
|
|
||||||
|
# ✅ 正确示例：事件驱动
|
||||||
|
func _ready():
|
||||||
|
player.health_changed.connect(_on_health_changed)
|
||||||
|
|
||||||
|
func _on_health_changed(new_health: int):
|
||||||
|
if new_health <= 0:
|
||||||
|
game_over()
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🎮 游戏逻辑优化
|
||||||
|
|
||||||
|
### 状态机优化
|
||||||
|
```gdscript
|
||||||
|
# StateMachine.gd
|
||||||
|
class_name StateMachine
|
||||||
|
extends Node
|
||||||
|
|
||||||
|
var current_state: State
|
||||||
|
var states: Dictionary = {}
|
||||||
|
|
||||||
|
func change_state(state_name: String):
|
||||||
|
if current_state:
|
||||||
|
current_state.exit()
|
||||||
|
|
||||||
|
current_state = states[state_name]
|
||||||
|
current_state.enter()
|
||||||
|
|
||||||
|
func _process(delta):
|
||||||
|
if current_state:
|
||||||
|
current_state.update(delta)
|
||||||
|
```
|
||||||
|
|
||||||
|
### AI优化
|
||||||
|
```gdscript
|
||||||
|
# EnemyAI.gd
|
||||||
|
extends Node
|
||||||
|
|
||||||
|
var update_interval: float = 0.2 # 每200ms更新一次AI
|
||||||
|
var update_timer: float = 0.0
|
||||||
|
|
||||||
|
func _process(delta):
|
||||||
|
update_timer += delta
|
||||||
|
if update_timer >= update_interval:
|
||||||
|
update_ai()
|
||||||
|
update_timer = 0.0
|
||||||
|
|
||||||
|
func update_ai():
|
||||||
|
# AI逻辑更新
|
||||||
|
# 路径寻找
|
||||||
|
# 决策制定
|
||||||
|
pass
|
||||||
|
```
|
||||||
|
|
||||||
|
### 碰撞检测优化
|
||||||
|
```gdscript
|
||||||
|
# 使用空间分区优化碰撞检测
|
||||||
|
class_name SpatialGrid
|
||||||
|
extends Node
|
||||||
|
|
||||||
|
var grid_size: int = 64
|
||||||
|
var grid: Dictionary = {}
|
||||||
|
|
||||||
|
func add_object(obj: Node2D):
|
||||||
|
var grid_pos = Vector2(
|
||||||
|
int(obj.global_position.x / grid_size),
|
||||||
|
int(obj.global_position.y / grid_size)
|
||||||
|
)
|
||||||
|
|
||||||
|
if not grid.has(grid_pos):
|
||||||
|
grid[grid_pos] = []
|
||||||
|
|
||||||
|
grid[grid_pos].append(obj)
|
||||||
|
|
||||||
|
func get_nearby_objects(pos: Vector2) -> Array:
|
||||||
|
var grid_pos = Vector2(
|
||||||
|
int(pos.x / grid_size),
|
||||||
|
int(pos.y / grid_size)
|
||||||
|
)
|
||||||
|
|
||||||
|
var nearby = []
|
||||||
|
for x in range(-1, 2):
|
||||||
|
for y in range(-1, 2):
|
||||||
|
var check_pos = grid_pos + Vector2(x, y)
|
||||||
|
if grid.has(check_pos):
|
||||||
|
nearby.append_array(grid[check_pos])
|
||||||
|
|
||||||
|
return nearby
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🌐 网络优化
|
||||||
|
|
||||||
|
### 数据压缩
|
||||||
|
```gdscript
|
||||||
|
# NetworkManager.gd
|
||||||
|
func send_player_data(data: Dictionary):
|
||||||
|
# 只发送变化的数据
|
||||||
|
var delta_data = get_changed_data(data)
|
||||||
|
|
||||||
|
# 压缩数据
|
||||||
|
var compressed = compress_data(delta_data)
|
||||||
|
|
||||||
|
# 发送数据
|
||||||
|
send_to_server(compressed)
|
||||||
|
|
||||||
|
func compress_data(data: Dictionary) -> PackedByteArray:
|
||||||
|
var json_string = JSON.stringify(data)
|
||||||
|
var bytes = json_string.to_utf8_buffer()
|
||||||
|
return bytes.compress(FileAccess.COMPRESSION_GZIP)
|
||||||
|
```
|
||||||
|
|
||||||
|
### 批量更新
|
||||||
|
```gdscript
|
||||||
|
# 批量发送网络更新
|
||||||
|
var pending_updates: Array = []
|
||||||
|
var update_timer: float = 0.0
|
||||||
|
|
||||||
|
func _process(delta):
|
||||||
|
update_timer += delta
|
||||||
|
if update_timer >= 0.05: # 每50ms发送一次
|
||||||
|
if pending_updates.size() > 0:
|
||||||
|
send_batch_updates(pending_updates)
|
||||||
|
pending_updates.clear()
|
||||||
|
update_timer = 0.0
|
||||||
|
|
||||||
|
func queue_update(update_data: Dictionary):
|
||||||
|
pending_updates.append(update_data)
|
||||||
|
```
|
||||||
|
|
||||||
|
## 📊 性能监控
|
||||||
|
|
||||||
|
### FPS监控
|
||||||
|
```gdscript
|
||||||
|
# FPSMonitor.gd
|
||||||
|
extends Control
|
||||||
|
|
||||||
|
@onready var fps_label: Label = $FPSLabel
|
||||||
|
var fps_history: Array = []
|
||||||
|
|
||||||
|
func _process(delta):
|
||||||
|
var current_fps = Engine.get_frames_per_second()
|
||||||
|
fps_history.append(current_fps)
|
||||||
|
|
||||||
|
if fps_history.size() > 60: # 保留60帧历史
|
||||||
|
fps_history.pop_front()
|
||||||
|
|
||||||
|
var avg_fps = 0
|
||||||
|
for fps in fps_history:
|
||||||
|
avg_fps += fps
|
||||||
|
avg_fps /= fps_history.size()
|
||||||
|
|
||||||
|
fps_label.text = "FPS: %d (平均: %d)" % [current_fps, avg_fps]
|
||||||
|
|
||||||
|
# FPS过低时警告
|
||||||
|
if avg_fps < 30:
|
||||||
|
modulate = Color.RED
|
||||||
|
elif avg_fps < 50:
|
||||||
|
modulate = Color.YELLOW
|
||||||
|
else:
|
||||||
|
modulate = Color.WHITE
|
||||||
|
```
|
||||||
|
|
||||||
|
### 性能分析器
|
||||||
|
```gdscript
|
||||||
|
# Profiler.gd
|
||||||
|
class_name Profiler
|
||||||
|
extends Node
|
||||||
|
|
||||||
|
var timers: Dictionary = {}
|
||||||
|
|
||||||
|
func start_timer(name: String):
|
||||||
|
timers[name] = Time.get_time_dict_from_system()
|
||||||
|
|
||||||
|
func end_timer(name: String) -> float:
|
||||||
|
if not timers.has(name):
|
||||||
|
return 0.0
|
||||||
|
|
||||||
|
var start_time = timers[name]
|
||||||
|
var end_time = Time.get_time_dict_from_system()
|
||||||
|
|
||||||
|
var duration = (end_time.hour * 3600 + end_time.minute * 60 + end_time.second) - \
|
||||||
|
(start_time.hour * 3600 + start_time.minute * 60 + start_time.second)
|
||||||
|
|
||||||
|
timers.erase(name)
|
||||||
|
return duration
|
||||||
|
|
||||||
|
# 使用示例
|
||||||
|
func expensive_function():
|
||||||
|
Profiler.start_timer("expensive_function")
|
||||||
|
|
||||||
|
# 执行耗时操作
|
||||||
|
for i in range(10000):
|
||||||
|
pass
|
||||||
|
|
||||||
|
var duration = Profiler.end_timer("expensive_function")
|
||||||
|
print("函数执行时间: ", duration, "秒")
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🛠️ 调试工具
|
||||||
|
|
||||||
|
### 性能调试面板
|
||||||
|
```gdscript
|
||||||
|
# DebugPanel.gd
|
||||||
|
extends Control
|
||||||
|
|
||||||
|
@onready var memory_label: Label = $VBox/MemoryLabel
|
||||||
|
@onready var fps_label: Label = $VBox/FPSLabel
|
||||||
|
@onready var objects_label: Label = $VBox/ObjectsLabel
|
||||||
|
|
||||||
|
func _process(delta):
|
||||||
|
# 更新内存使用
|
||||||
|
var memory = OS.get_static_memory_usage_by_type()
|
||||||
|
memory_label.text = "内存: %.1f MB" % (memory / 1024.0 / 1024.0)
|
||||||
|
|
||||||
|
# 更新FPS
|
||||||
|
fps_label.text = "FPS: %d" % Engine.get_frames_per_second()
|
||||||
|
|
||||||
|
# 更新对象数量
|
||||||
|
var object_count = get_tree().get_node_count()
|
||||||
|
objects_label.text = "对象数: %d" % object_count
|
||||||
|
```
|
||||||
|
|
||||||
|
### 热点分析
|
||||||
|
```gdscript
|
||||||
|
# HotspotAnalyzer.gd
|
||||||
|
extends Node
|
||||||
|
|
||||||
|
var function_calls: Dictionary = {}
|
||||||
|
var function_times: Dictionary = {}
|
||||||
|
|
||||||
|
func profile_function(func_name: String, callable: Callable):
|
||||||
|
var start_time = Time.get_time_dict_from_system()
|
||||||
|
|
||||||
|
callable.call()
|
||||||
|
|
||||||
|
var end_time = Time.get_time_dict_from_system()
|
||||||
|
var duration = (end_time.hour * 3600 + end_time.minute * 60 + end_time.second) - \
|
||||||
|
(start_time.hour * 3600 + start_time.minute * 60 + start_time.second)
|
||||||
|
|
||||||
|
if not function_calls.has(func_name):
|
||||||
|
function_calls[func_name] = 0
|
||||||
|
function_times[func_name] = 0.0
|
||||||
|
|
||||||
|
function_calls[func_name] += 1
|
||||||
|
function_times[func_name] += duration
|
||||||
|
|
||||||
|
func print_profile_report():
|
||||||
|
print("=== 性能分析报告 ===")
|
||||||
|
for func_name in function_calls.keys():
|
||||||
|
var calls = function_calls[func_name]
|
||||||
|
var total_time = function_times[func_name]
|
||||||
|
var avg_time = total_time / calls
|
||||||
|
|
||||||
|
print("%s: 调用%d次, 总时间%.3fs, 平均%.3fs" % [func_name, calls, total_time, avg_time])
|
||||||
|
```
|
||||||
|
|
||||||
|
## 📚 最佳实践
|
||||||
|
|
||||||
|
### 开发阶段
|
||||||
|
1. **早期优化** - 在设计阶段考虑性能
|
||||||
|
2. **渐进开发** - 逐步添加功能并测试性能
|
||||||
|
3. **定期测试** - 定期进行性能测试
|
||||||
|
4. **文档记录** - 记录性能优化决策
|
||||||
|
|
||||||
|
### 测试阶段
|
||||||
|
1. **多设备测试** - 在不同性能设备上测试
|
||||||
|
2. **压力测试** - 测试极限情况下的性能
|
||||||
|
3. **长时间测试** - 测试内存泄漏和性能衰减
|
||||||
|
4. **用户测试** - 收集真实用户的性能反馈
|
||||||
|
|
||||||
|
### 发布阶段
|
||||||
|
1. **性能监控** - 监控线上性能指标
|
||||||
|
2. **快速响应** - 快速修复性能问题
|
||||||
|
3. **持续优化** - 根据数据持续优化
|
||||||
|
4. **版本对比** - 对比不同版本的性能表现
|
||||||
|
|
||||||
|
## 🔍 常见问题
|
||||||
|
|
||||||
|
### Q: 如何识别性能瓶颈？
|
||||||
|
A: 使用Godot的内置分析器，添加自定义性能监控，分析FPS和内存使用情况。
|
||||||
|
|
||||||
|
### Q: 内存使用过高怎么办？
|
||||||
|
A: 检查资源加载，使用对象池，及时释放不需要的对象，优化纹理大小。
|
||||||
|
|
||||||
|
### Q: 如何优化大量对象的渲染？
|
||||||
|
A: 使用MultiMesh批处理，实现视锥剔除，使用LOD系统，合并相同材质的对象。
|
||||||
|
|
||||||
|
### Q: 网络延迟如何优化？
|
||||||
|
A: 减少网络请求频率，压缩传输数据，使用预测和插值，实现客户端预测。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**记住：性能优化是一个持续的过程，需要在开发的各个阶段都保持关注！**
|
||||||
505
docs/project_structure.md
Normal file
505
docs/project_structure.md
Normal file
@@ -0,0 +1,505 @@
|
|||||||
|
# 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. 更新导入设置
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 总结
|
||||||
|
|
||||||
|
这个项目结构设计遵循了模块化、可扩展、易维护的原则。通过清晰的分层架构和标准化的命名规范，确保了项目的可读性和可维护性。每个开发者都应该遵循这个结构进行开发，以保持项目的一致性和质量。
|
||||||
|
|
||||||
|
如有任何疑问或建议，请参考相关文档或联系项目维护者。
|
||||||
617
docs/scene_design.md
Normal file
617
docs/scene_design.md
Normal file
@@ -0,0 +1,617 @@
|
|||||||
|
# 场景设计规范
|
||||||
|
|
||||||
|
本文档定义了 Whale Town 项目中场景设计的标准和最佳实践。
|
||||||
|
|
||||||
|
## 🎯 设计原则
|
||||||
|
|
||||||
|
### 核心原则
|
||||||
|
1. **功能独立** - 每个场景都是独立的功能单元
|
||||||
|
2. **职责单一** - 一个场景只负责一个主要功能
|
||||||
|
3. **可复用性** - 场景组件应该能够在其他场景中复用
|
||||||
|
4. **标准化** - 统一的场景结构和命名规范
|
||||||
|
5. **性能优先** - 优化场景性能，避免不必要的资源消耗
|
||||||
|
|
||||||
|
### 场景分类
|
||||||
|
- **主要场景** - 游戏的核心功能场景（主菜单、游戏场景、设置等）
|
||||||
|
- **UI场景** - 纯界面场景（对话框、HUD、菜单等）
|
||||||
|
- **游戏场景** - 包含游戏逻辑的场景（关卡、战斗、探索等）
|
||||||
|
- **工具场景** - 开发和测试用的场景
|
||||||
|
|
||||||
|
## 🏗️ 场景结构
|
||||||
|
|
||||||
|
### 标准目录结构
|
||||||
|
```
|
||||||
|
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
|
||||||
|
```
|
||||||
|
|
||||||
|
### 场景命名规范
|
||||||
|
- **主场景**: `scene_name.tscn` (snake_case)
|
||||||
|
- **预制体**: `component_name.tscn` (snake_case)
|
||||||
|
- **脚本文件**: `SceneName.gd` (PascalCase)
|
||||||
|
- **节点名称**: `NodeName` (PascalCase) 或 `nodeName` (camelCase)
|
||||||
|
|
||||||
|
## 📝 场景设计模板
|
||||||
|
|
||||||
|
### 主场景结构模板
|
||||||
|
|
||||||
|
```
|
||||||
|
SceneName (Control/Node2D)
|
||||||
|
├── Background (TextureRect/Sprite2D) # 背景
|
||||||
|
├── UI (CanvasLayer) # UI层
|
||||||
|
│ ├── HUD (Control) # 游戏HUD
|
||||||
|
│ ├── Menu (Control) # 菜单界面
|
||||||
|
│ └── Dialog (Control) # 对话框
|
||||||
|
├── Game (Node2D) # 游戏内容层
|
||||||
|
│ ├── Player (CharacterBody2D) # 玩家
|
||||||
|
│ ├── NPCs (Node2D) # NPC容器
|
||||||
|
│ ├── Items (Node2D) # 物品容器
|
||||||
|
│ └── Effects (Node2D) # 特效容器
|
||||||
|
├── Audio (Node) # 音频管理
|
||||||
|
│ ├── BGM (AudioStreamPlayer) # 背景音乐
|
||||||
|
│ └── SFX (AudioStreamPlayer2D) # 音效
|
||||||
|
└── Systems (Node) # 系统组件
|
||||||
|
├── CameraController (Node) # 相机控制
|
||||||
|
├── InputHandler (Node) # 输入处理
|
||||||
|
└── StateManager (Node) # 状态管理
|
||||||
|
```
|
||||||
|
|
||||||
|
### 场景脚本模板
|
||||||
|
|
||||||
|
```gdscript
|
||||||
|
# SceneName.gd
|
||||||
|
extends Control # 或 Node2D，根据场景类型选择
|
||||||
|
class_name SceneName
|
||||||
|
|
||||||
|
# 场景信息
|
||||||
|
const SCENE_NAME = "SceneName"
|
||||||
|
const SCENE_VERSION = "1.0.0"
|
||||||
|
|
||||||
|
# 场景状态
|
||||||
|
enum SceneState {
|
||||||
|
LOADING,
|
||||||
|
READY,
|
||||||
|
ACTIVE,
|
||||||
|
PAUSED,
|
||||||
|
TRANSITIONING
|
||||||
|
}
|
||||||
|
|
||||||
|
var current_state: SceneState = SceneState.LOADING
|
||||||
|
|
||||||
|
# 节点引用
|
||||||
|
@onready var background: TextureRect = $Background
|
||||||
|
@onready var ui_layer: CanvasLayer = $UI
|
||||||
|
@onready var game_layer: Node2D = $Game
|
||||||
|
@onready var audio_manager: Node = $Audio
|
||||||
|
@onready var systems: Node = $Systems
|
||||||
|
|
||||||
|
# 场景数据
|
||||||
|
var scene_data: Dictionary = {}
|
||||||
|
var is_initialized: bool = false
|
||||||
|
|
||||||
|
# 信号定义
|
||||||
|
signal scene_ready
|
||||||
|
signal scene_state_changed(old_state: SceneState, new_state: SceneState)
|
||||||
|
signal scene_data_updated(key: String, value)
|
||||||
|
|
||||||
|
func _ready():
|
||||||
|
"""场景初始化"""
|
||||||
|
print("初始化场景: ", SCENE_NAME)
|
||||||
|
|
||||||
|
# 初始化场景
|
||||||
|
await initialize_scene()
|
||||||
|
|
||||||
|
# 设置场景状态
|
||||||
|
change_state(SceneState.READY)
|
||||||
|
|
||||||
|
# 发送场景就绪信号
|
||||||
|
scene_ready.emit()
|
||||||
|
|
||||||
|
func initialize_scene():
|
||||||
|
"""初始化场景组件"""
|
||||||
|
# 加载场景数据
|
||||||
|
await load_scene_data()
|
||||||
|
|
||||||
|
# 初始化UI
|
||||||
|
initialize_ui()
|
||||||
|
|
||||||
|
# 初始化游戏组件
|
||||||
|
initialize_game_components()
|
||||||
|
|
||||||
|
# 初始化音频
|
||||||
|
initialize_audio()
|
||||||
|
|
||||||
|
# 初始化系统
|
||||||
|
initialize_systems()
|
||||||
|
|
||||||
|
# 连接信号
|
||||||
|
connect_signals()
|
||||||
|
|
||||||
|
is_initialized = true
|
||||||
|
|
||||||
|
func load_scene_data():
|
||||||
|
"""加载场景数据"""
|
||||||
|
# 从配置文件或网络加载场景数据
|
||||||
|
var data_path = "res://data/scenes/%s.json" % SCENE_NAME.to_lower()
|
||||||
|
if FileAccess.file_exists(data_path):
|
||||||
|
var file = FileAccess.open(data_path, FileAccess.READ)
|
||||||
|
if file:
|
||||||
|
var json_string = file.get_as_text()
|
||||||
|
file.close()
|
||||||
|
|
||||||
|
var json = JSON.new()
|
||||||
|
if json.parse(json_string) == OK:
|
||||||
|
scene_data = json.data
|
||||||
|
else:
|
||||||
|
print("警告: 场景数据JSON格式错误: ", data_path)
|
||||||
|
|
||||||
|
# 等待一帧确保所有节点都已初始化
|
||||||
|
await get_tree().process_frame
|
||||||
|
|
||||||
|
func initialize_ui():
|
||||||
|
"""初始化UI组件"""
|
||||||
|
if ui_layer:
|
||||||
|
# 初始化UI组件
|
||||||
|
for child in ui_layer.get_children():
|
||||||
|
if child.has_method("initialize"):
|
||||||
|
child.initialize()
|
||||||
|
|
||||||
|
func initialize_game_components():
|
||||||
|
"""初始化游戏组件"""
|
||||||
|
if game_layer:
|
||||||
|
# 初始化游戏组件
|
||||||
|
for child in game_layer.get_children():
|
||||||
|
if child.has_method("initialize"):
|
||||||
|
child.initialize()
|
||||||
|
|
||||||
|
func initialize_audio():
|
||||||
|
"""初始化音频"""
|
||||||
|
if audio_manager:
|
||||||
|
# 设置背景音乐
|
||||||
|
if scene_data.has("bgm"):
|
||||||
|
play_bgm(scene_data.bgm)
|
||||||
|
|
||||||
|
func initialize_systems():
|
||||||
|
"""初始化系统组件"""
|
||||||
|
if systems:
|
||||||
|
# 初始化系统组件
|
||||||
|
for child in systems.get_children():
|
||||||
|
if child.has_method("initialize"):
|
||||||
|
child.initialize()
|
||||||
|
|
||||||
|
func connect_signals():
|
||||||
|
"""连接信号"""
|
||||||
|
# 连接场景内部信号
|
||||||
|
# 连接全局事件
|
||||||
|
EventSystem.connect_event("game_paused", _on_game_paused)
|
||||||
|
EventSystem.connect_event("game_resumed", _on_game_resumed)
|
||||||
|
|
||||||
|
func change_state(new_state: SceneState):
|
||||||
|
"""改变场景状态"""
|
||||||
|
if current_state == new_state:
|
||||||
|
return
|
||||||
|
|
||||||
|
var old_state = current_state
|
||||||
|
current_state = new_state
|
||||||
|
|
||||||
|
print("场景状态变更: %s -> %s" % [SceneState.keys()[old_state], SceneState.keys()[new_state]])
|
||||||
|
|
||||||
|
# 处理状态变更
|
||||||
|
_handle_state_change(old_state, new_state)
|
||||||
|
|
||||||
|
# 发送状态变更信号
|
||||||
|
scene_state_changed.emit(old_state, new_state)
|
||||||
|
|
||||||
|
func _handle_state_change(old_state: SceneState, new_state: SceneState):
|
||||||
|
"""处理状态变更"""
|
||||||
|
match new_state:
|
||||||
|
SceneState.LOADING:
|
||||||
|
_on_enter_loading_state()
|
||||||
|
SceneState.READY:
|
||||||
|
_on_enter_ready_state()
|
||||||
|
SceneState.ACTIVE:
|
||||||
|
_on_enter_active_state()
|
||||||
|
SceneState.PAUSED:
|
||||||
|
_on_enter_paused_state()
|
||||||
|
SceneState.TRANSITIONING:
|
||||||
|
_on_enter_transitioning_state()
|
||||||
|
|
||||||
|
func _on_enter_loading_state():
|
||||||
|
"""进入加载状态"""
|
||||||
|
# 显示加载界面
|
||||||
|
pass
|
||||||
|
|
||||||
|
func _on_enter_ready_state():
|
||||||
|
"""进入就绪状态"""
|
||||||
|
# 场景准备完成
|
||||||
|
pass
|
||||||
|
|
||||||
|
func _on_enter_active_state():
|
||||||
|
"""进入活跃状态"""
|
||||||
|
# 开始游戏逻辑
|
||||||
|
pass
|
||||||
|
|
||||||
|
func _on_enter_paused_state():
|
||||||
|
"""进入暂停状态"""
|
||||||
|
# 暂停游戏逻辑
|
||||||
|
get_tree().paused = true
|
||||||
|
|
||||||
|
func _on_enter_transitioning_state():
|
||||||
|
"""进入转换状态"""
|
||||||
|
# 场景转换中
|
||||||
|
pass
|
||||||
|
|
||||||
|
func play_bgm(bgm_path: String):
|
||||||
|
"""播放背景音乐"""
|
||||||
|
var bgm_player = audio_manager.get_node("BGM") as AudioStreamPlayer
|
||||||
|
if bgm_player and FileAccess.file_exists(bgm_path):
|
||||||
|
var audio_stream = load(bgm_path)
|
||||||
|
bgm_player.stream = audio_stream
|
||||||
|
bgm_player.play()
|
||||||
|
|
||||||
|
func play_sfx(sfx_path: String, position: Vector2 = Vector2.ZERO):
|
||||||
|
"""播放音效"""
|
||||||
|
var sfx_player = audio_manager.get_node("SFX") as AudioStreamPlayer2D
|
||||||
|
if sfx_player and FileAccess.file_exists(sfx_path):
|
||||||
|
var audio_stream = load(sfx_path)
|
||||||
|
sfx_player.stream = audio_stream
|
||||||
|
if position != Vector2.ZERO:
|
||||||
|
sfx_player.global_position = position
|
||||||
|
sfx_player.play()
|
||||||
|
|
||||||
|
func update_scene_data(key: String, value):
|
||||||
|
"""更新场景数据"""
|
||||||
|
scene_data[key] = value
|
||||||
|
scene_data_updated.emit(key, value)
|
||||||
|
|
||||||
|
func get_scene_data(key: String, default_value = null):
|
||||||
|
"""获取场景数据"""
|
||||||
|
return scene_data.get(key, default_value)
|
||||||
|
|
||||||
|
func cleanup():
|
||||||
|
"""清理场景资源"""
|
||||||
|
print("清理场景: ", SCENE_NAME)
|
||||||
|
|
||||||
|
# 断开信号连接
|
||||||
|
EventSystem.disconnect_event("game_paused", _on_game_paused)
|
||||||
|
EventSystem.disconnect_event("game_resumed", _on_game_resumed)
|
||||||
|
|
||||||
|
# 清理组件
|
||||||
|
if ui_layer:
|
||||||
|
for child in ui_layer.get_children():
|
||||||
|
if child.has_method("cleanup"):
|
||||||
|
child.cleanup()
|
||||||
|
|
||||||
|
if game_layer:
|
||||||
|
for child in game_layer.get_children():
|
||||||
|
if child.has_method("cleanup"):
|
||||||
|
child.cleanup()
|
||||||
|
|
||||||
|
if systems:
|
||||||
|
for child in systems.get_children():
|
||||||
|
if child.has_method("cleanup"):
|
||||||
|
child.cleanup()
|
||||||
|
|
||||||
|
# 停止音频
|
||||||
|
if audio_manager:
|
||||||
|
var bgm_player = audio_manager.get_node("BGM") as AudioStreamPlayer
|
||||||
|
if bgm_player:
|
||||||
|
bgm_player.stop()
|
||||||
|
|
||||||
|
# 事件处理
|
||||||
|
func _on_game_paused():
|
||||||
|
"""游戏暂停事件"""
|
||||||
|
if current_state == SceneState.ACTIVE:
|
||||||
|
change_state(SceneState.PAUSED)
|
||||||
|
|
||||||
|
func _on_game_resumed():
|
||||||
|
"""游戏恢复事件"""
|
||||||
|
if current_state == SceneState.PAUSED:
|
||||||
|
change_state(SceneState.ACTIVE)
|
||||||
|
get_tree().paused = false
|
||||||
|
|
||||||
|
# 输入处理
|
||||||
|
func _input(event):
|
||||||
|
"""处理输入事件"""
|
||||||
|
if current_state != SceneState.ACTIVE:
|
||||||
|
return
|
||||||
|
|
||||||
|
# 处理场景特定的输入
|
||||||
|
_handle_scene_input(event)
|
||||||
|
|
||||||
|
func _handle_scene_input(event):
|
||||||
|
"""处理场景特定输入"""
|
||||||
|
# 在子类中重写此方法
|
||||||
|
pass
|
||||||
|
|
||||||
|
# 生命周期方法
|
||||||
|
func _process(delta):
|
||||||
|
"""每帧更新"""
|
||||||
|
if current_state == SceneState.ACTIVE:
|
||||||
|
_update_scene(delta)
|
||||||
|
|
||||||
|
func _update_scene(delta):
|
||||||
|
"""更新场景逻辑"""
|
||||||
|
# 在子类中重写此方法
|
||||||
|
pass
|
||||||
|
|
||||||
|
func _physics_process(delta):
|
||||||
|
"""物理更新"""
|
||||||
|
if current_state == SceneState.ACTIVE:
|
||||||
|
_physics_update_scene(delta)
|
||||||
|
|
||||||
|
func _physics_update_scene(delta):
|
||||||
|
"""物理更新场景逻辑"""
|
||||||
|
# 在子类中重写此方法
|
||||||
|
pass
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🎨 UI设计规范
|
||||||
|
|
||||||
|
### UI层级结构
|
||||||
|
```
|
||||||
|
UI (CanvasLayer)
|
||||||
|
├── Background (Control) # UI背景
|
||||||
|
├── MainContent (Control) # 主要内容
|
||||||
|
│ ├── Header (Control) # 头部区域
|
||||||
|
│ ├── Body (Control) # 主体区域
|
||||||
|
│ └── Footer (Control) # 底部区域
|
||||||
|
├── Overlay (Control) # 覆盖层
|
||||||
|
│ ├── Loading (Control) # 加载界面
|
||||||
|
│ ├── Dialog (Control) # 对话框
|
||||||
|
│ └── Toast (Control) # 提示消息
|
||||||
|
└── Debug (Control) # 调试信息
|
||||||
|
```
|
||||||
|
|
||||||
|
### UI组件规范
|
||||||
|
1. **响应式设计** - 使用Anchor和Margin实现自适应布局
|
||||||
|
2. **主题统一** - 使用统一的主题资源
|
||||||
|
3. **动画效果** - 添加适当的过渡动画
|
||||||
|
4. **无障碍支持** - 考虑键盘导航和屏幕阅读器
|
||||||
|
|
||||||
|
### UI脚本模板
|
||||||
|
```gdscript
|
||||||
|
# UIComponent.gd
|
||||||
|
extends Control
|
||||||
|
class_name UIComponent
|
||||||
|
|
||||||
|
signal ui_action(action_name: String, data: Dictionary)
|
||||||
|
|
||||||
|
@export var auto_initialize: bool = true
|
||||||
|
@export var animation_duration: float = 0.3
|
||||||
|
|
||||||
|
var is_visible: bool = false
|
||||||
|
var is_initialized: bool = false
|
||||||
|
|
||||||
|
func _ready():
|
||||||
|
if auto_initialize:
|
||||||
|
initialize()
|
||||||
|
|
||||||
|
func initialize():
|
||||||
|
"""初始化UI组件"""
|
||||||
|
if is_initialized:
|
||||||
|
return
|
||||||
|
|
||||||
|
# 设置初始状态
|
||||||
|
modulate.a = 0.0
|
||||||
|
visible = false
|
||||||
|
|
||||||
|
# 连接信号
|
||||||
|
_connect_signals()
|
||||||
|
|
||||||
|
is_initialized = true
|
||||||
|
|
||||||
|
func show_ui(animated: bool = true):
|
||||||
|
"""显示UI"""
|
||||||
|
if is_visible:
|
||||||
|
return
|
||||||
|
|
||||||
|
visible = true
|
||||||
|
is_visible = true
|
||||||
|
|
||||||
|
if animated:
|
||||||
|
var tween = create_tween()
|
||||||
|
tween.tween_property(self, "modulate:a", 1.0, animation_duration)
|
||||||
|
else:
|
||||||
|
modulate.a = 1.0
|
||||||
|
|
||||||
|
func hide_ui(animated: bool = true):
|
||||||
|
"""隐藏UI"""
|
||||||
|
if not is_visible:
|
||||||
|
return
|
||||||
|
|
||||||
|
is_visible = false
|
||||||
|
|
||||||
|
if animated:
|
||||||
|
var tween = create_tween()
|
||||||
|
tween.tween_property(self, "modulate:a", 0.0, animation_duration)
|
||||||
|
await tween.finished
|
||||||
|
visible = false
|
||||||
|
else:
|
||||||
|
modulate.a = 0.0
|
||||||
|
visible = false
|
||||||
|
|
||||||
|
func _connect_signals():
|
||||||
|
"""连接信号"""
|
||||||
|
# 在子类中重写
|
||||||
|
pass
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🎮 游戏场景规范
|
||||||
|
|
||||||
|
### 游戏场景结构
|
||||||
|
```
|
||||||
|
GameScene (Node2D)
|
||||||
|
├── Background (ParallaxBackground) # 背景层
|
||||||
|
├── Environment (Node2D) # 环境层
|
||||||
|
│ ├── Terrain (TileMap) # 地形
|
||||||
|
│ ├── Props (Node2D) # 道具
|
||||||
|
│ └── Decorations (Node2D) # 装饰
|
||||||
|
├── Entities (Node2D) # 实体层
|
||||||
|
│ ├── Player (CharacterBody2D) # 玩家
|
||||||
|
│ ├── NPCs (Node2D) # NPC
|
||||||
|
│ ├── Enemies (Node2D) # 敌人
|
||||||
|
│ └── Items (Node2D) # 物品
|
||||||
|
├── Effects (Node2D) # 特效层
|
||||||
|
│ ├── Particles (Node2D) # 粒子效果
|
||||||
|
│ └── Animations (Node2D) # 动画效果
|
||||||
|
└── Camera (Camera2D) # 相机
|
||||||
|
```
|
||||||
|
|
||||||
|
### 性能优化
|
||||||
|
1. **对象池** - 重用频繁创建销毁的对象
|
||||||
|
2. **视锥剔除** - 只渲染可见区域的对象
|
||||||
|
3. **LOD系统** - 根据距离调整细节级别
|
||||||
|
4. **批量处理** - 合并相似的渲染调用
|
||||||
|
|
||||||
|
## 🔧 场景管理
|
||||||
|
|
||||||
|
### 场景切换
|
||||||
|
```gdscript
|
||||||
|
# 使用SceneManager进行场景切换
|
||||||
|
SceneManager.change_scene("game_scene", {
|
||||||
|
"level": 1,
|
||||||
|
"player_data": player_data
|
||||||
|
})
|
||||||
|
|
||||||
|
# 带过渡效果的场景切换
|
||||||
|
SceneManager.change_scene_with_transition("battle_scene", {
|
||||||
|
"enemy_data": enemy_data
|
||||||
|
}, "fade")
|
||||||
|
```
|
||||||
|
|
||||||
|
### 场景数据传递
|
||||||
|
```gdscript
|
||||||
|
# 发送场景数据
|
||||||
|
var scene_data = {
|
||||||
|
"player_level": 10,
|
||||||
|
"inventory": player_inventory,
|
||||||
|
"quest_progress": quest_data
|
||||||
|
}
|
||||||
|
SceneManager.change_scene("next_scene", scene_data)
|
||||||
|
|
||||||
|
# 接收场景数据
|
||||||
|
func _on_scene_data_received(data: Dictionary):
|
||||||
|
if data.has("player_level"):
|
||||||
|
player_level = data.player_level
|
||||||
|
if data.has("inventory"):
|
||||||
|
load_inventory(data.inventory)
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🧪 场景测试
|
||||||
|
|
||||||
|
### 测试场景创建
|
||||||
|
```gdscript
|
||||||
|
# TestScene.gd
|
||||||
|
extends "res://scenes/BaseScene.gd"
|
||||||
|
|
||||||
|
func _ready():
|
||||||
|
super._ready()
|
||||||
|
|
||||||
|
# 设置测试环境
|
||||||
|
setup_test_environment()
|
||||||
|
|
||||||
|
# 运行测试用例
|
||||||
|
run_test_cases()
|
||||||
|
|
||||||
|
func setup_test_environment():
|
||||||
|
"""设置测试环境"""
|
||||||
|
# 创建测试数据
|
||||||
|
# 设置测试状态
|
||||||
|
pass
|
||||||
|
|
||||||
|
func run_test_cases():
|
||||||
|
"""运行测试用例"""
|
||||||
|
test_scene_initialization()
|
||||||
|
test_ui_interactions()
|
||||||
|
test_game_logic()
|
||||||
|
|
||||||
|
func test_scene_initialization():
|
||||||
|
"""测试场景初始化"""
|
||||||
|
assert(is_initialized, "场景应该已初始化")
|
||||||
|
assert(current_state == SceneState.READY, "场景状态应该为READY")
|
||||||
|
|
||||||
|
func test_ui_interactions():
|
||||||
|
"""测试UI交互"""
|
||||||
|
# 模拟用户输入
|
||||||
|
# 验证UI响应
|
||||||
|
pass
|
||||||
|
|
||||||
|
func test_game_logic():
|
||||||
|
"""测试游戏逻辑"""
|
||||||
|
# 测试游戏规则
|
||||||
|
# 验证状态变化
|
||||||
|
pass
|
||||||
|
```
|
||||||
|
|
||||||
|
### 性能测试
|
||||||
|
```gdscript
|
||||||
|
# 性能监控
|
||||||
|
func _process(delta):
|
||||||
|
super._process(delta)
|
||||||
|
|
||||||
|
# 监控帧率
|
||||||
|
var fps = Engine.get_frames_per_second()
|
||||||
|
if fps < 30:
|
||||||
|
print("警告: 帧率过低: ", fps)
|
||||||
|
|
||||||
|
# 监控内存使用
|
||||||
|
var memory_usage = OS.get_static_memory_usage_by_type()
|
||||||
|
if memory_usage > 100 * 1024 * 1024: # 100MB
|
||||||
|
print("警告: 内存使用过高: ", memory_usage / 1024 / 1024, "MB")
|
||||||
|
```
|
||||||
|
|
||||||
|
## 📚 最佳实践
|
||||||
|
|
||||||
|
### 代码组织
|
||||||
|
1. **单一职责** - 每个场景只负责一个主要功能
|
||||||
|
2. **模块化** - 将复杂功能拆分为独立组件
|
||||||
|
3. **可测试** - 设计易于测试的场景结构
|
||||||
|
4. **文档化** - 为场景添加详细的文档说明
|
||||||
|
|
||||||
|
### 性能优化
|
||||||
|
1. **延迟加载** - 按需加载资源和组件
|
||||||
|
2. **对象复用** - 使用对象池管理频繁创建的对象
|
||||||
|
3. **批量操作** - 合并相似的操作减少开销
|
||||||
|
4. **内存管理** - 及时释放不需要的资源
|
||||||
|
|
||||||
|
### 用户体验
|
||||||
|
1. **响应式设计** - 支持不同分辨率和设备
|
||||||
|
2. **流畅动画** - 添加适当的过渡效果
|
||||||
|
3. **错误处理** - 优雅处理异常情况
|
||||||
|
4. **加载提示** - 为长时间操作提供进度反馈
|
||||||
|
|
||||||
|
## 🔍 常见问题
|
||||||
|
|
||||||
|
### Q: 如何处理场景间的数据传递？
|
||||||
|
A: 使用SceneManager的场景切换方法传递数据，或通过全局单例存储共享数据。
|
||||||
|
|
||||||
|
### Q: 场景性能如何优化？
|
||||||
|
A: 使用对象池、视锥剔除、LOD系统，避免在_process中执行重复计算。
|
||||||
|
|
||||||
|
### Q: 如何调试场景问题？
|
||||||
|
A: 使用Godot的远程调试器，添加性能监控，编写场景测试用例。
|
||||||
|
|
||||||
|
### Q: 场景切换如何添加过渡效果？
|
||||||
|
A: 使用SceneManager的过渡系统，或自定义Tween动画实现过渡效果。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**记住：良好的场景设计是游戏体验的基础！**
|
||||||
1
module/Character/.gitkeep
Normal file
1
module/Character/.gitkeep
Normal file
@@ -0,0 +1 @@
|
|||||||
|
# 保持目录结构 - 角色模块目录
|
||||||
1
module/Combat/.gitkeep
Normal file
1
module/Combat/.gitkeep
Normal file
@@ -0,0 +1 @@
|
|||||||
|
# 保持目录结构 - 战斗模块目录
|
||||||
1
module/Dialogue/.gitkeep
Normal file
1
module/Dialogue/.gitkeep
Normal file
@@ -0,0 +1 @@
|
|||||||
|
# 保持目录结构 - 对话模块目录
|
||||||
1
module/Inventory/.gitkeep
Normal file
1
module/Inventory/.gitkeep
Normal file
@@ -0,0 +1 @@
|
|||||||
|
# 保持目录结构 - 背包模块目录
|
||||||
1
module/UI/animations/.gitkeep
Normal file
1
module/UI/animations/.gitkeep
Normal file
@@ -0,0 +1 @@
|
|||||||
|
# 保持目录结构 - UI动画目录
|
||||||
1
module/UI/components/.gitkeep
Normal file
1
module/UI/components/.gitkeep
Normal file
@@ -0,0 +1 @@
|
|||||||
|
# 保持目录结构 - UI组件目录
|
||||||
1
module/UI/layouts/.gitkeep
Normal file
1
module/UI/layouts/.gitkeep
Normal file
@@ -0,0 +1 @@
|
|||||||
|
# 保持目录结构 - UI布局目录
|
||||||
@@ -11,13 +11,20 @@ config_version=5
|
|||||||
[application]
|
[application]
|
||||||
|
|
||||||
config/name="whaleTown"
|
config/name="whaleTown"
|
||||||
run/main_scene="res://scenes/login_scene.tscn"
|
run/main_scene="res://scenes/main_scene.tscn"
|
||||||
config/features=PackedStringArray("4.5", "Forward Plus")
|
config/features=PackedStringArray("4.5", "Forward Plus")
|
||||||
config/icon="res://icon.svg"
|
config/icon="res://icon.svg"
|
||||||
|
|
||||||
[autoload]
|
[autoload]
|
||||||
|
|
||||||
EncryptionService="*res://scripts/managers/EncryptionService.gd"
|
GameManager="*res://core/managers/GameManager.gd"
|
||||||
StorageService="*res://scripts/managers/StorageService.gd"
|
SceneManager="*res://core/managers/SceneManager.gd"
|
||||||
NetworkService="*res://scripts/managers/NetworkService.gd"
|
EventSystem="*res://core/systems/EventSystem.gd"
|
||||||
AuthManager="*res://scripts/managers/AuthManager.gd"
|
|
||||||
|
[display]
|
||||||
|
|
||||||
|
window/size/viewport_width=1376
|
||||||
|
window/size/viewport_height=768
|
||||||
|
window/size/mode=2
|
||||||
|
window/stretch/mode="canvas_items"
|
||||||
|
window/stretch/aspect="expand"
|
||||||
|
|||||||
523
scenes/auth_scene.tscn
Normal file
523
scenes/auth_scene.tscn
Normal file
@@ -0,0 +1,523 @@
|
|||||||
|
[gd_scene load_steps=10 format=3 uid="uid://by7m8snb4xllf"]
|
||||||
|
|
||||||
|
[ext_resource type="Texture2D" uid="uid://bx17oy8lvaca4" path="res://assets/ui/auth/bg_auth_scene.png" id="1_background"]
|
||||||
|
[ext_resource type="Texture2D" uid="uid://de4q4s1gxivtf" path="res://assets/ui/auth/login_frame_smart_transparent.png" id="2_frame"]
|
||||||
|
[ext_resource type="Script" uid="uid://nv8eitxieqtm" path="res://scripts/scenes/AuthScene.gd" id="3_script"]
|
||||||
|
|
||||||
|
[sub_resource type="StyleBoxEmpty" id="StyleBoxEmpty_1"]
|
||||||
|
|
||||||
|
[sub_resource type="StyleBoxFlat" id="StyleBoxFlat_hover"]
|
||||||
|
bg_color = Color(0.3, 0.6, 0.9, 1)
|
||||||
|
border_width_left = 2
|
||||||
|
border_width_top = 2
|
||||||
|
border_width_right = 2
|
||||||
|
border_width_bottom = 2
|
||||||
|
border_color = Color(0.2, 0.5, 0.8, 1)
|
||||||
|
corner_radius_top_left = 8
|
||||||
|
corner_radius_top_right = 8
|
||||||
|
corner_radius_bottom_right = 8
|
||||||
|
corner_radius_bottom_left = 8
|
||||||
|
|
||||||
|
[sub_resource type="StyleBoxFlat" id="StyleBoxFlat_normal"]
|
||||||
|
bg_color = Color(0.2, 0.5, 0.8, 1)
|
||||||
|
border_width_left = 2
|
||||||
|
border_width_top = 2
|
||||||
|
border_width_right = 2
|
||||||
|
border_width_bottom = 2
|
||||||
|
border_color = Color(0.15, 0.4, 0.7, 1)
|
||||||
|
corner_radius_top_left = 8
|
||||||
|
corner_radius_top_right = 8
|
||||||
|
corner_radius_bottom_right = 8
|
||||||
|
corner_radius_bottom_left = 8
|
||||||
|
|
||||||
|
[sub_resource type="StyleBoxFlat" id="StyleBoxFlat_pressed"]
|
||||||
|
bg_color = Color(0.4, 0.7, 1, 1)
|
||||||
|
border_width_left = 2
|
||||||
|
border_width_top = 2
|
||||||
|
border_width_right = 2
|
||||||
|
border_width_bottom = 2
|
||||||
|
border_color = Color(0.3, 0.6, 0.9, 1)
|
||||||
|
corner_radius_top_left = 8
|
||||||
|
corner_radius_top_right = 8
|
||||||
|
corner_radius_bottom_right = 8
|
||||||
|
corner_radius_bottom_left = 8
|
||||||
|
|
||||||
|
[sub_resource type="Theme" id="Theme_main_button"]
|
||||||
|
Button/colors/font_color = Color(1, 1, 1, 1)
|
||||||
|
Button/colors/font_hover_color = Color(1, 1, 1, 1)
|
||||||
|
Button/colors/font_pressed_color = Color(1, 1, 1, 1)
|
||||||
|
Button/font_sizes/font_size = 18
|
||||||
|
Button/styles/hover = SubResource("StyleBoxFlat_hover")
|
||||||
|
Button/styles/normal = SubResource("StyleBoxFlat_normal")
|
||||||
|
Button/styles/pressed = SubResource("StyleBoxFlat_pressed")
|
||||||
|
|
||||||
|
[sub_resource type="Theme" id="Theme_button"]
|
||||||
|
Button/colors/font_color = Color(1, 1, 1, 1)
|
||||||
|
Button/colors/font_hover_color = Color(1, 1, 1, 1)
|
||||||
|
Button/colors/font_pressed_color = Color(1, 1, 1, 1)
|
||||||
|
Button/styles/hover = SubResource("StyleBoxFlat_hover")
|
||||||
|
Button/styles/normal = SubResource("StyleBoxFlat_normal")
|
||||||
|
Button/styles/pressed = SubResource("StyleBoxFlat_pressed")
|
||||||
|
|
||||||
|
[node name="AuthScene" type="Control"]
|
||||||
|
layout_mode = 3
|
||||||
|
anchors_preset = 15
|
||||||
|
anchor_right = 1.0
|
||||||
|
anchor_bottom = 1.0
|
||||||
|
grow_horizontal = 2
|
||||||
|
grow_vertical = 2
|
||||||
|
script = ExtResource("3_script")
|
||||||
|
|
||||||
|
[node name="HTTPRequest" type="HTTPRequest" parent="."]
|
||||||
|
|
||||||
|
[node name="BackgroundImage" type="TextureRect" parent="."]
|
||||||
|
layout_mode = 1
|
||||||
|
anchors_preset = 15
|
||||||
|
anchor_right = 1.0
|
||||||
|
anchor_bottom = 1.0
|
||||||
|
grow_horizontal = 2
|
||||||
|
grow_vertical = 2
|
||||||
|
texture = ExtResource("1_background")
|
||||||
|
expand_mode = 1
|
||||||
|
stretch_mode = 6
|
||||||
|
|
||||||
|
[node name="WhaleFrame" type="TextureRect" parent="."]
|
||||||
|
layout_mode = 1
|
||||||
|
anchors_preset = 8
|
||||||
|
anchor_left = 0.5
|
||||||
|
anchor_top = 0.5
|
||||||
|
anchor_right = 0.5
|
||||||
|
anchor_bottom = 0.5
|
||||||
|
offset_left = -300.0
|
||||||
|
offset_top = -300.0
|
||||||
|
offset_right = 300.0
|
||||||
|
offset_bottom = 300.0
|
||||||
|
grow_horizontal = 2
|
||||||
|
grow_vertical = 2
|
||||||
|
texture = ExtResource("2_frame")
|
||||||
|
expand_mode = 1
|
||||||
|
stretch_mode = 5
|
||||||
|
|
||||||
|
[node name="CenterContainer" type="CenterContainer" parent="."]
|
||||||
|
layout_mode = 1
|
||||||
|
anchors_preset = 8
|
||||||
|
anchor_left = 0.5
|
||||||
|
anchor_top = 0.5
|
||||||
|
anchor_right = 0.5
|
||||||
|
anchor_bottom = 0.5
|
||||||
|
offset_left = -175.0
|
||||||
|
offset_top = -184.0
|
||||||
|
offset_right = 175.0
|
||||||
|
offset_bottom = 236.0
|
||||||
|
grow_horizontal = 2
|
||||||
|
grow_vertical = 2
|
||||||
|
|
||||||
|
[node name="LoginPanel" type="Panel" parent="CenterContainer"]
|
||||||
|
custom_minimum_size = Vector2(350, 400)
|
||||||
|
layout_mode = 2
|
||||||
|
theme_override_styles/panel = SubResource("StyleBoxEmpty_1")
|
||||||
|
|
||||||
|
[node name="VBoxContainer" type="VBoxContainer" parent="CenterContainer/LoginPanel"]
|
||||||
|
layout_mode = 1
|
||||||
|
anchors_preset = 15
|
||||||
|
anchor_right = 1.0
|
||||||
|
anchor_bottom = 1.0
|
||||||
|
offset_left = 30.0
|
||||||
|
offset_top = 30.0
|
||||||
|
offset_right = -30.0
|
||||||
|
offset_bottom = -30.0
|
||||||
|
grow_horizontal = 2
|
||||||
|
grow_vertical = 2
|
||||||
|
|
||||||
|
[node name="TitleLabel" type="Label" parent="CenterContainer/LoginPanel/VBoxContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
theme_override_colors/font_color = Color(0, 0, 0, 1)
|
||||||
|
theme_override_font_sizes/font_size = 24
|
||||||
|
text = "Whaletown"
|
||||||
|
horizontal_alignment = 1
|
||||||
|
vertical_alignment = 1
|
||||||
|
|
||||||
|
[node name="SubtitleLabel" type="Label" parent="CenterContainer/LoginPanel/VBoxContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
theme_override_colors/font_color = Color(0, 0, 0, 1)
|
||||||
|
theme_override_font_sizes/font_size = 14
|
||||||
|
text = "开始你的小镇之旅！"
|
||||||
|
horizontal_alignment = 1
|
||||||
|
vertical_alignment = 1
|
||||||
|
|
||||||
|
[node name="HSeparator" type="HSeparator" parent="CenterContainer/LoginPanel/VBoxContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
|
||||||
|
[node name="LoginForm" type="VBoxContainer" parent="CenterContainer/LoginPanel/VBoxContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
size_flags_vertical = 3
|
||||||
|
|
||||||
|
[node name="UsernameContainer" type="VBoxContainer" parent="CenterContainer/LoginPanel/VBoxContainer/LoginForm"]
|
||||||
|
layout_mode = 2
|
||||||
|
|
||||||
|
[node name="UsernameLabelContainer" type="HBoxContainer" parent="CenterContainer/LoginPanel/VBoxContainer/LoginForm/UsernameContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
|
||||||
|
[node name="UsernameLabel" type="Label" parent="CenterContainer/LoginPanel/VBoxContainer/LoginForm/UsernameContainer/UsernameLabelContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
theme_override_colors/font_color = Color(0, 0, 0, 1)
|
||||||
|
text = "用户名/手机/邮箱"
|
||||||
|
|
||||||
|
[node name="RequiredStar" type="Label" parent="CenterContainer/LoginPanel/VBoxContainer/LoginForm/UsernameContainer/UsernameLabelContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
theme_override_colors/font_color = Color(1, 0.2, 0.2, 1)
|
||||||
|
text = " *"
|
||||||
|
|
||||||
|
[node name="Spacer" type="Control" parent="CenterContainer/LoginPanel/VBoxContainer/LoginForm/UsernameContainer/UsernameLabelContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
size_flags_horizontal = 3
|
||||||
|
|
||||||
|
[node name="UsernameError" type="Label" parent="CenterContainer/LoginPanel/VBoxContainer/LoginForm/UsernameContainer/UsernameLabelContainer"]
|
||||||
|
visible = false
|
||||||
|
layout_mode = 2
|
||||||
|
theme_override_colors/font_color = Color(1, 0.2, 0.2, 1)
|
||||||
|
theme_override_font_sizes/font_size = 12
|
||||||
|
text = "用户名不能为空"
|
||||||
|
horizontal_alignment = 2
|
||||||
|
|
||||||
|
[node name="UsernameInput" type="LineEdit" parent="CenterContainer/LoginPanel/VBoxContainer/LoginForm/UsernameContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
theme_override_colors/font_color = Color(0, 0, 0, 1)
|
||||||
|
theme_override_colors/font_placeholder_color = Color(0.5, 0.5, 0.5, 1)
|
||||||
|
placeholder_text = "用户名/手机/邮箱"
|
||||||
|
|
||||||
|
[node name="PasswordContainer" type="VBoxContainer" parent="CenterContainer/LoginPanel/VBoxContainer/LoginForm"]
|
||||||
|
layout_mode = 2
|
||||||
|
|
||||||
|
[node name="PasswordLabelContainer" type="HBoxContainer" parent="CenterContainer/LoginPanel/VBoxContainer/LoginForm/PasswordContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
|
||||||
|
[node name="PasswordLabel" type="Label" parent="CenterContainer/LoginPanel/VBoxContainer/LoginForm/PasswordContainer/PasswordLabelContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
theme_override_colors/font_color = Color(0, 0, 0, 1)
|
||||||
|
text = "密码"
|
||||||
|
|
||||||
|
[node name="RequiredStar" type="Label" parent="CenterContainer/LoginPanel/VBoxContainer/LoginForm/PasswordContainer/PasswordLabelContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
theme_override_colors/font_color = Color(1, 0.2, 0.2, 1)
|
||||||
|
text = " *"
|
||||||
|
|
||||||
|
[node name="Spacer" type="Control" parent="CenterContainer/LoginPanel/VBoxContainer/LoginForm/PasswordContainer/PasswordLabelContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
size_flags_horizontal = 3
|
||||||
|
|
||||||
|
[node name="PasswordError" type="Label" parent="CenterContainer/LoginPanel/VBoxContainer/LoginForm/PasswordContainer/PasswordLabelContainer"]
|
||||||
|
visible = false
|
||||||
|
layout_mode = 2
|
||||||
|
theme_override_colors/font_color = Color(1, 0.2, 0.2, 1)
|
||||||
|
theme_override_font_sizes/font_size = 12
|
||||||
|
text = "密码不能为空"
|
||||||
|
horizontal_alignment = 2
|
||||||
|
|
||||||
|
[node name="PasswordInput" type="LineEdit" parent="CenterContainer/LoginPanel/VBoxContainer/LoginForm/PasswordContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
theme_override_colors/font_color = Color(0, 0, 0, 1)
|
||||||
|
theme_override_colors/font_placeholder_color = Color(0.5, 0.5, 0.5, 1)
|
||||||
|
placeholder_text = "请输入密码"
|
||||||
|
secret = true
|
||||||
|
|
||||||
|
[node name="CheckboxContainer" type="HBoxContainer" parent="CenterContainer/LoginPanel/VBoxContainer/LoginForm"]
|
||||||
|
layout_mode = 2
|
||||||
|
|
||||||
|
[node name="RememberPassword" type="CheckBox" parent="CenterContainer/LoginPanel/VBoxContainer/LoginForm/CheckboxContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
theme_override_colors/font_color = Color(0, 0, 0, 1)
|
||||||
|
text = "记住密码"
|
||||||
|
|
||||||
|
[node name="AutoLogin" type="CheckBox" parent="CenterContainer/LoginPanel/VBoxContainer/LoginForm/CheckboxContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
theme_override_colors/font_color = Color(0, 0, 0, 1)
|
||||||
|
text = "自动登录"
|
||||||
|
|
||||||
|
[node name="HSeparator2" type="HSeparator" parent="CenterContainer/LoginPanel/VBoxContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
|
||||||
|
[node name="MainButton" type="Button" parent="CenterContainer/LoginPanel/VBoxContainer"]
|
||||||
|
custom_minimum_size = Vector2(280, 50)
|
||||||
|
layout_mode = 2
|
||||||
|
theme = SubResource("Theme_main_button")
|
||||||
|
text = "进入小镇"
|
||||||
|
|
||||||
|
[node name="HSeparator3" type="HSeparator" parent="CenterContainer/LoginPanel/VBoxContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
|
||||||
|
[node name="ButtonContainer" type="HBoxContainer" parent="CenterContainer/LoginPanel/VBoxContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
alignment = 1
|
||||||
|
|
||||||
|
[node name="LoginBtn" type="Button" parent="CenterContainer/LoginPanel/VBoxContainer/ButtonContainer"]
|
||||||
|
custom_minimum_size = Vector2(100, 35)
|
||||||
|
layout_mode = 2
|
||||||
|
theme = SubResource("Theme_button")
|
||||||
|
text = "密码登录"
|
||||||
|
|
||||||
|
[node name="ToRegisterBtn" type="Button" parent="CenterContainer/LoginPanel/VBoxContainer/ButtonContainer"]
|
||||||
|
custom_minimum_size = Vector2(100, 35)
|
||||||
|
layout_mode = 2
|
||||||
|
theme = SubResource("Theme_button")
|
||||||
|
text = "验证码登录"
|
||||||
|
|
||||||
|
[node name="BottomLinks" type="HBoxContainer" parent="CenterContainer/LoginPanel/VBoxContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
alignment = 1
|
||||||
|
|
||||||
|
[node name="ForgotPassword" type="Button" parent="CenterContainer/LoginPanel/VBoxContainer/BottomLinks"]
|
||||||
|
layout_mode = 2
|
||||||
|
theme_override_colors/font_color = Color(0, 0, 0, 1)
|
||||||
|
text = "忘记密码?"
|
||||||
|
flat = true
|
||||||
|
|
||||||
|
[node name="RegisterLink" type="Button" parent="CenterContainer/LoginPanel/VBoxContainer/BottomLinks"]
|
||||||
|
layout_mode = 2
|
||||||
|
theme_override_colors/font_color = Color(0, 0, 0, 1)
|
||||||
|
text = "注册居民身份"
|
||||||
|
flat = true
|
||||||
|
|
||||||
|
[node name="RegisterPanel" type="Panel" parent="CenterContainer"]
|
||||||
|
visible = false
|
||||||
|
custom_minimum_size = Vector2(400, 570)
|
||||||
|
layout_mode = 2
|
||||||
|
theme_override_styles/panel = SubResource("StyleBoxEmpty_1")
|
||||||
|
|
||||||
|
[node name="VBoxContainer" type="VBoxContainer" parent="CenterContainer/RegisterPanel"]
|
||||||
|
layout_mode = 1
|
||||||
|
anchors_preset = 15
|
||||||
|
anchor_right = 1.0
|
||||||
|
anchor_bottom = 1.0
|
||||||
|
offset_left = 30.0
|
||||||
|
offset_top = 75.0
|
||||||
|
offset_right = -30.0
|
||||||
|
offset_bottom = -72.0
|
||||||
|
grow_horizontal = 2
|
||||||
|
grow_vertical = 2
|
||||||
|
alignment = 1
|
||||||
|
|
||||||
|
[node name="TitleLabel" type="Label" parent="CenterContainer/RegisterPanel/VBoxContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
theme_override_colors/font_color = Color(0, 0, 0, 1)
|
||||||
|
theme_override_font_sizes/font_size = 20
|
||||||
|
text = "注册新居民"
|
||||||
|
horizontal_alignment = 1
|
||||||
|
vertical_alignment = 1
|
||||||
|
|
||||||
|
[node name="HSeparator" type="HSeparator" parent="CenterContainer/RegisterPanel/VBoxContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
|
||||||
|
[node name="RegisterForm" type="VBoxContainer" parent="CenterContainer/RegisterPanel/VBoxContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
size_flags_vertical = 3
|
||||||
|
alignment = 1
|
||||||
|
|
||||||
|
[node name="UsernameContainer" type="VBoxContainer" parent="CenterContainer/RegisterPanel/VBoxContainer/RegisterForm"]
|
||||||
|
layout_mode = 2
|
||||||
|
|
||||||
|
[node name="UsernameLabelContainer" type="HBoxContainer" parent="CenterContainer/RegisterPanel/VBoxContainer/RegisterForm/UsernameContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
|
||||||
|
[node name="UsernameLabel" type="Label" parent="CenterContainer/RegisterPanel/VBoxContainer/RegisterForm/UsernameContainer/UsernameLabelContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
theme_override_colors/font_color = Color(0, 0, 0, 1)
|
||||||
|
text = "用户名"
|
||||||
|
|
||||||
|
[node name="RequiredStar" type="Label" parent="CenterContainer/RegisterPanel/VBoxContainer/RegisterForm/UsernameContainer/UsernameLabelContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
theme_override_colors/font_color = Color(1, 0.2, 0.2, 1)
|
||||||
|
text = " *"
|
||||||
|
|
||||||
|
[node name="Spacer" type="Control" parent="CenterContainer/RegisterPanel/VBoxContainer/RegisterForm/UsernameContainer/UsernameLabelContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
size_flags_horizontal = 3
|
||||||
|
|
||||||
|
[node name="UsernameError" type="Label" parent="CenterContainer/RegisterPanel/VBoxContainer/RegisterForm/UsernameContainer/UsernameLabelContainer"]
|
||||||
|
visible = false
|
||||||
|
layout_mode = 2
|
||||||
|
theme_override_colors/font_color = Color(1, 0.2, 0.2, 1)
|
||||||
|
theme_override_font_sizes/font_size = 12
|
||||||
|
text = "用户名不能为空"
|
||||||
|
horizontal_alignment = 2
|
||||||
|
|
||||||
|
[node name="UsernameInput" type="LineEdit" parent="CenterContainer/RegisterPanel/VBoxContainer/RegisterForm/UsernameContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
theme_override_colors/font_color = Color(0, 0, 0, 1)
|
||||||
|
theme_override_colors/font_placeholder_color = Color(0.5, 0.5, 0.5, 1)
|
||||||
|
placeholder_text = "请输入用户名"
|
||||||
|
|
||||||
|
[node name="EmailContainer" type="VBoxContainer" parent="CenterContainer/RegisterPanel/VBoxContainer/RegisterForm"]
|
||||||
|
layout_mode = 2
|
||||||
|
|
||||||
|
[node name="EmailLabelContainer" type="HBoxContainer" parent="CenterContainer/RegisterPanel/VBoxContainer/RegisterForm/EmailContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
|
||||||
|
[node name="EmailLabel" type="Label" parent="CenterContainer/RegisterPanel/VBoxContainer/RegisterForm/EmailContainer/EmailLabelContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
theme_override_colors/font_color = Color(0, 0, 0, 1)
|
||||||
|
text = "邮箱"
|
||||||
|
|
||||||
|
[node name="RequiredStar" type="Label" parent="CenterContainer/RegisterPanel/VBoxContainer/RegisterForm/EmailContainer/EmailLabelContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
theme_override_colors/font_color = Color(1, 0.2, 0.2, 1)
|
||||||
|
text = " *"
|
||||||
|
|
||||||
|
[node name="Spacer" type="Control" parent="CenterContainer/RegisterPanel/VBoxContainer/RegisterForm/EmailContainer/EmailLabelContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
size_flags_horizontal = 3
|
||||||
|
|
||||||
|
[node name="EmailError" type="Label" parent="CenterContainer/RegisterPanel/VBoxContainer/RegisterForm/EmailContainer/EmailLabelContainer"]
|
||||||
|
visible = false
|
||||||
|
layout_mode = 2
|
||||||
|
theme_override_colors/font_color = Color(1, 0.2, 0.2, 1)
|
||||||
|
theme_override_font_sizes/font_size = 12
|
||||||
|
text = "邮箱不能为空"
|
||||||
|
horizontal_alignment = 2
|
||||||
|
|
||||||
|
[node name="EmailInput" type="LineEdit" parent="CenterContainer/RegisterPanel/VBoxContainer/RegisterForm/EmailContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
theme_override_colors/font_color = Color(0, 0, 0, 1)
|
||||||
|
theme_override_colors/font_placeholder_color = Color(0.5, 0.5, 0.5, 1)
|
||||||
|
placeholder_text = "请输入邮箱地址"
|
||||||
|
|
||||||
|
[node name="PasswordContainer" type="VBoxContainer" parent="CenterContainer/RegisterPanel/VBoxContainer/RegisterForm"]
|
||||||
|
layout_mode = 2
|
||||||
|
|
||||||
|
[node name="PasswordLabelContainer" type="HBoxContainer" parent="CenterContainer/RegisterPanel/VBoxContainer/RegisterForm/PasswordContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
|
||||||
|
[node name="PasswordLabel" type="Label" parent="CenterContainer/RegisterPanel/VBoxContainer/RegisterForm/PasswordContainer/PasswordLabelContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
theme_override_colors/font_color = Color(0, 0, 0, 1)
|
||||||
|
text = "密码"
|
||||||
|
|
||||||
|
[node name="RequiredStar" type="Label" parent="CenterContainer/RegisterPanel/VBoxContainer/RegisterForm/PasswordContainer/PasswordLabelContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
theme_override_colors/font_color = Color(1, 0.2, 0.2, 1)
|
||||||
|
text = " *"
|
||||||
|
|
||||||
|
[node name="Spacer" type="Control" parent="CenterContainer/RegisterPanel/VBoxContainer/RegisterForm/PasswordContainer/PasswordLabelContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
size_flags_horizontal = 3
|
||||||
|
|
||||||
|
[node name="PasswordError" type="Label" parent="CenterContainer/RegisterPanel/VBoxContainer/RegisterForm/PasswordContainer/PasswordLabelContainer"]
|
||||||
|
visible = false
|
||||||
|
layout_mode = 2
|
||||||
|
theme_override_colors/font_color = Color(1, 0.2, 0.2, 1)
|
||||||
|
theme_override_font_sizes/font_size = 12
|
||||||
|
text = "密码不能为空"
|
||||||
|
horizontal_alignment = 2
|
||||||
|
|
||||||
|
[node name="PasswordInput" type="LineEdit" parent="CenterContainer/RegisterPanel/VBoxContainer/RegisterForm/PasswordContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
theme_override_colors/font_color = Color(0, 0, 0, 1)
|
||||||
|
theme_override_colors/font_placeholder_color = Color(0.5, 0.5, 0.5, 1)
|
||||||
|
placeholder_text = "请输入密码(至少8位)"
|
||||||
|
secret = true
|
||||||
|
|
||||||
|
[node name="ConfirmContainer" type="VBoxContainer" parent="CenterContainer/RegisterPanel/VBoxContainer/RegisterForm"]
|
||||||
|
layout_mode = 2
|
||||||
|
|
||||||
|
[node name="ConfirmLabelContainer" type="HBoxContainer" parent="CenterContainer/RegisterPanel/VBoxContainer/RegisterForm/ConfirmContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
|
||||||
|
[node name="ConfirmLabel" type="Label" parent="CenterContainer/RegisterPanel/VBoxContainer/RegisterForm/ConfirmContainer/ConfirmLabelContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
theme_override_colors/font_color = Color(0, 0, 0, 1)
|
||||||
|
text = "确认密码"
|
||||||
|
|
||||||
|
[node name="RequiredStar" type="Label" parent="CenterContainer/RegisterPanel/VBoxContainer/RegisterForm/ConfirmContainer/ConfirmLabelContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
theme_override_colors/font_color = Color(1, 0.2, 0.2, 1)
|
||||||
|
text = " *"
|
||||||
|
|
||||||
|
[node name="Spacer" type="Control" parent="CenterContainer/RegisterPanel/VBoxContainer/RegisterForm/ConfirmContainer/ConfirmLabelContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
size_flags_horizontal = 3
|
||||||
|
|
||||||
|
[node name="ConfirmError" type="Label" parent="CenterContainer/RegisterPanel/VBoxContainer/RegisterForm/ConfirmContainer/ConfirmLabelContainer"]
|
||||||
|
visible = false
|
||||||
|
layout_mode = 2
|
||||||
|
theme_override_colors/font_color = Color(1, 0.2, 0.2, 1)
|
||||||
|
theme_override_font_sizes/font_size = 12
|
||||||
|
text = "确认密码不能为空"
|
||||||
|
horizontal_alignment = 2
|
||||||
|
|
||||||
|
[node name="ConfirmInput" type="LineEdit" parent="CenterContainer/RegisterPanel/VBoxContainer/RegisterForm/ConfirmContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
theme_override_colors/font_color = Color(0, 0, 0, 1)
|
||||||
|
theme_override_colors/font_placeholder_color = Color(0.5, 0.5, 0.5, 1)
|
||||||
|
placeholder_text = "请再次输入密码"
|
||||||
|
secret = true
|
||||||
|
|
||||||
|
[node name="VerificationContainer" type="VBoxContainer" parent="CenterContainer/RegisterPanel/VBoxContainer/RegisterForm"]
|
||||||
|
layout_mode = 2
|
||||||
|
|
||||||
|
[node name="VerificationLabelContainer" type="HBoxContainer" parent="CenterContainer/RegisterPanel/VBoxContainer/RegisterForm/VerificationContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
|
||||||
|
[node name="VerificationLabel" type="Label" parent="CenterContainer/RegisterPanel/VBoxContainer/RegisterForm/VerificationContainer/VerificationLabelContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
theme_override_colors/font_color = Color(0, 0, 0, 1)
|
||||||
|
text = "邮箱验证码"
|
||||||
|
|
||||||
|
[node name="RequiredStar" type="Label" parent="CenterContainer/RegisterPanel/VBoxContainer/RegisterForm/VerificationContainer/VerificationLabelContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
theme_override_colors/font_color = Color(1, 0.2, 0.2, 1)
|
||||||
|
text = " *"
|
||||||
|
|
||||||
|
[node name="Spacer" type="Control" parent="CenterContainer/RegisterPanel/VBoxContainer/RegisterForm/VerificationContainer/VerificationLabelContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
size_flags_horizontal = 3
|
||||||
|
|
||||||
|
[node name="VerificationError" type="Label" parent="CenterContainer/RegisterPanel/VBoxContainer/RegisterForm/VerificationContainer/VerificationLabelContainer"]
|
||||||
|
visible = false
|
||||||
|
layout_mode = 2
|
||||||
|
theme_override_colors/font_color = Color(1, 0.2, 0.2, 1)
|
||||||
|
theme_override_font_sizes/font_size = 12
|
||||||
|
text = "验证码不能为空"
|
||||||
|
horizontal_alignment = 2
|
||||||
|
|
||||||
|
[node name="VerificationInputContainer" type="HBoxContainer" parent="CenterContainer/RegisterPanel/VBoxContainer/RegisterForm/VerificationContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
|
||||||
|
[node name="VerificationInput" type="LineEdit" parent="CenterContainer/RegisterPanel/VBoxContainer/RegisterForm/VerificationContainer/VerificationInputContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
size_flags_horizontal = 3
|
||||||
|
theme_override_colors/font_color = Color(0, 0, 0, 1)
|
||||||
|
theme_override_colors/font_placeholder_color = Color(0.5, 0.5, 0.5, 1)
|
||||||
|
placeholder_text = "请输入6位验证码"
|
||||||
|
max_length = 6
|
||||||
|
|
||||||
|
[node name="SendCodeBtn" type="Button" parent="CenterContainer/RegisterPanel/VBoxContainer/RegisterForm/VerificationContainer/VerificationInputContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
text = "发送验证码"
|
||||||
|
|
||||||
|
[node name="HSeparator2" type="HSeparator" parent="CenterContainer/RegisterPanel/VBoxContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
|
||||||
|
[node name="ButtonContainer" type="HBoxContainer" parent="CenterContainer/RegisterPanel/VBoxContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
alignment = 1
|
||||||
|
|
||||||
|
[node name="RegisterBtn" type="Button" parent="CenterContainer/RegisterPanel/VBoxContainer/ButtonContainer"]
|
||||||
|
custom_minimum_size = Vector2(120, 45)
|
||||||
|
layout_mode = 2
|
||||||
|
theme = SubResource("Theme_button")
|
||||||
|
text = "注册"
|
||||||
|
|
||||||
|
[node name="ToLoginBtn" type="Button" parent="CenterContainer/RegisterPanel/VBoxContainer/ButtonContainer"]
|
||||||
|
custom_minimum_size = Vector2(120, 45)
|
||||||
|
layout_mode = 2
|
||||||
|
theme = SubResource("Theme_button")
|
||||||
|
text = "返回登录"
|
||||||
|
|
||||||
|
[node name="ToastContainer" type="Control" parent="."]
|
||||||
|
layout_mode = 1
|
||||||
|
anchors_preset = 15
|
||||||
|
anchor_right = 1.0
|
||||||
|
anchor_bottom = 1.0
|
||||||
|
grow_horizontal = 2
|
||||||
|
grow_vertical = 2
|
||||||
|
mouse_filter = 2
|
||||||
@@ -1,196 +0,0 @@
|
|||||||
[gd_scene load_steps=5 format=3 uid="uid://bqj1ykrxo0x8s"]
|
|
||||||
|
|
||||||
[ext_resource type="Script" uid="uid://c6f1awwaw1nim" path="res://scripts/ui/UI_Login.gd" id="1_p2w8r"]
|
|
||||||
[ext_resource type="Texture2D" uid="uid://byw73r2dt6xb8" path="res://assets/login/login-bg.png" id="2_login_bg"]
|
|
||||||
[ext_resource type="Texture2D" uid="uid://cswuqnhiiypb2" path="res://assets/login/enter.png" id="3_enter_btn"]
|
|
||||||
[ext_resource type="Texture2D" uid="uid://bqvel7n6dfo1d" path="res://assets/login/whaletown.png" id="4_whaletown"]
|
|
||||||
|
|
||||||
[node name="loginScene" type="Control"]
|
|
||||||
layout_mode = 3
|
|
||||||
anchors_preset = 15
|
|
||||||
anchor_right = 1.0
|
|
||||||
anchor_bottom = 1.0
|
|
||||||
grow_horizontal = 2
|
|
||||||
grow_vertical = 2
|
|
||||||
script = ExtResource("1_p2w8r")
|
|
||||||
|
|
||||||
[node name="Background" type="ColorRect" parent="."]
|
|
||||||
layout_mode = 1
|
|
||||||
anchors_preset = 15
|
|
||||||
anchor_right = 1.0
|
|
||||||
anchor_bottom = 1.0
|
|
||||||
grow_horizontal = 2
|
|
||||||
grow_vertical = 2
|
|
||||||
color = Color(0.85098, 0.929412, 0.964706, 1)
|
|
||||||
|
|
||||||
[node name="LoginPanel" type="TextureRect" parent="."]
|
|
||||||
layout_mode = 0
|
|
||||||
offset_left = 250.0
|
|
||||||
offset_top = 8.0
|
|
||||||
offset_right = 1274.0
|
|
||||||
offset_bottom = 1032.0
|
|
||||||
scale = Vector2(0.6, 0.6)
|
|
||||||
texture = ExtResource("2_login_bg")
|
|
||||||
stretch_mode = 1
|
|
||||||
|
|
||||||
[node name="MainTitle" type="TextureRect" parent="LoginPanel"]
|
|
||||||
layout_mode = 0
|
|
||||||
offset_left = 325.00003
|
|
||||||
offset_top = 243.33331
|
|
||||||
offset_right = 713.3334
|
|
||||||
offset_bottom = 393.3333
|
|
||||||
texture = ExtResource("4_whaletown")
|
|
||||||
expand_mode = 1
|
|
||||||
stretch_mode = 5
|
|
||||||
|
|
||||||
[node name="SubTitle" type="Label" parent="LoginPanel"]
|
|
||||||
layout_mode = 0
|
|
||||||
offset_left = 351.66666
|
|
||||||
offset_top = 408.3333
|
|
||||||
offset_right = 651.6666
|
|
||||||
offset_bottom = 431.3333
|
|
||||||
theme_override_colors/font_color = Color(0, 0, 0, 1)
|
|
||||||
text = "开始你的小镇之旅！"
|
|
||||||
horizontal_alignment = 1
|
|
||||||
vertical_alignment = 1
|
|
||||||
|
|
||||||
[node name="PasswordLoginTab" type="Button" parent="LoginPanel"]
|
|
||||||
layout_mode = 0
|
|
||||||
offset_left = 355.0
|
|
||||||
offset_top = 468.3333
|
|
||||||
offset_right = 500.0
|
|
||||||
offset_bottom = 503.3333
|
|
||||||
toggle_mode = true
|
|
||||||
button_pressed = true
|
|
||||||
text = "密码登录"
|
|
||||||
|
|
||||||
[node name="CodeLoginTab" type="Button" parent="LoginPanel"]
|
|
||||||
layout_mode = 0
|
|
||||||
offset_left = 510.0
|
|
||||||
offset_top = 468.3333
|
|
||||||
offset_right = 655.0
|
|
||||||
offset_bottom = 503.3333
|
|
||||||
toggle_mode = true
|
|
||||||
text = "验证码登录"
|
|
||||||
|
|
||||||
[node name="UsernameInput" type="LineEdit" parent="LoginPanel"]
|
|
||||||
layout_mode = 0
|
|
||||||
offset_left = 355.0
|
|
||||||
offset_top = 523.3333
|
|
||||||
offset_right = 655.0
|
|
||||||
offset_bottom = 563.3333
|
|
||||||
placeholder_text = "用户名/手机/邮箱"
|
|
||||||
caret_blink = true
|
|
||||||
|
|
||||||
[node name="PasswordInput" type="LineEdit" parent="LoginPanel"]
|
|
||||||
layout_mode = 0
|
|
||||||
offset_left = 355.0
|
|
||||||
offset_top = 578.3333
|
|
||||||
offset_right = 615.0
|
|
||||||
offset_bottom = 618.3333
|
|
||||||
placeholder_text = "输入密码"
|
|
||||||
caret_blink = true
|
|
||||||
secret = true
|
|
||||||
|
|
||||||
[node name="TogglePasswordButton" type="Button" parent="LoginPanel"]
|
|
||||||
layout_mode = 0
|
|
||||||
offset_left = 615.0
|
|
||||||
offset_top = 578.3333
|
|
||||||
offset_right = 655.0
|
|
||||||
offset_bottom = 618.3333
|
|
||||||
text = "👁"
|
|
||||||
|
|
||||||
[node name="RememberPasswordCheckBox" type="CheckBox" parent="LoginPanel"]
|
|
||||||
layout_mode = 0
|
|
||||||
offset_left = 325.0
|
|
||||||
offset_top = 703.3333
|
|
||||||
offset_right = 425.0
|
|
||||||
offset_bottom = 734.3333
|
|
||||||
theme_override_colors/font_color = Color(0, 0, 0, 1)
|
|
||||||
text = "记住密码"
|
|
||||||
|
|
||||||
[node name="AutoLoginCheckBox" type="CheckBox" parent="LoginPanel"]
|
|
||||||
layout_mode = 0
|
|
||||||
offset_left = 575.0
|
|
||||||
offset_top = 688.3333
|
|
||||||
offset_right = 675.0
|
|
||||||
offset_bottom = 719.3333
|
|
||||||
theme_override_colors/font_color = Color(0, 0, 0, 1)
|
|
||||||
text = "自动登录"
|
|
||||||
|
|
||||||
[node name="EnterButton" type="TextureButton" parent="LoginPanel"]
|
|
||||||
layout_mode = 0
|
|
||||||
offset_left = 286.66666
|
|
||||||
offset_top = 774.99994
|
|
||||||
offset_right = 1243.6666
|
|
||||||
offset_bottom = 958.99994
|
|
||||||
scale = Vector2(0.5, 0.5)
|
|
||||||
texture_normal = ExtResource("3_enter_btn")
|
|
||||||
stretch_mode = 0
|
|
||||||
|
|
||||||
[node name="EnterButtonLabel" type="Label" parent="LoginPanel/EnterButton"]
|
|
||||||
layout_mode = 1
|
|
||||||
anchors_preset = 15
|
|
||||||
anchor_right = 1.0
|
|
||||||
anchor_bottom = 1.0
|
|
||||||
grow_horizontal = 2
|
|
||||||
grow_vertical = 2
|
|
||||||
theme_override_font_sizes/font_size = 64
|
|
||||||
text = "进入小镇"
|
|
||||||
horizontal_alignment = 1
|
|
||||||
vertical_alignment = 1
|
|
||||||
|
|
||||||
[node name="ForgotPasswordButton" type="LinkButton" parent="LoginPanel"]
|
|
||||||
layout_mode = 0
|
|
||||||
offset_left = 328.3333
|
|
||||||
offset_top = 893.3333
|
|
||||||
offset_right = 428.3333
|
|
||||||
offset_bottom = 918.3333
|
|
||||||
theme_override_colors/font_color = Color(0, 0, 0, 1)
|
|
||||||
text = "忘记密码？"
|
|
||||||
|
|
||||||
[node name="RegisterButton" type="LinkButton" parent="LoginPanel"]
|
|
||||||
layout_mode = 0
|
|
||||||
offset_left = 595.0
|
|
||||||
offset_top = 890.0
|
|
||||||
offset_right = 695.0
|
|
||||||
offset_bottom = 915.0
|
|
||||||
theme_override_colors/font_color = Color(0, 0, 0, 1)
|
|
||||||
text = "注册居民身份"
|
|
||||||
|
|
||||||
[node name="StatusLabel" type="Label" parent="LoginPanel"]
|
|
||||||
layout_mode = 0
|
|
||||||
offset_left = 50.0
|
|
||||||
offset_top = 480.0
|
|
||||||
offset_right = 350.0
|
|
||||||
offset_bottom = 510.0
|
|
||||||
text = " "
|
|
||||||
horizontal_alignment = 1
|
|
||||||
vertical_alignment = 1
|
|
||||||
|
|
||||||
[node name="LoadingOverlay" type="ColorRect" parent="."]
|
|
||||||
visible = false
|
|
||||||
layout_mode = 1
|
|
||||||
anchors_preset = 15
|
|
||||||
anchor_right = 1.0
|
|
||||||
anchor_bottom = 1.0
|
|
||||||
grow_horizontal = 2
|
|
||||||
grow_vertical = 2
|
|
||||||
color = Color(0, 0, 0, 0.5)
|
|
||||||
|
|
||||||
[node name="LoadingLabel" type="Label" parent="LoadingOverlay"]
|
|
||||||
layout_mode = 1
|
|
||||||
anchors_preset = 8
|
|
||||||
anchor_left = 0.5
|
|
||||||
anchor_top = 0.5
|
|
||||||
anchor_right = 0.5
|
|
||||||
anchor_bottom = 0.5
|
|
||||||
offset_left = -50.0
|
|
||||||
offset_top = -11.5
|
|
||||||
offset_right = 50.0
|
|
||||||
offset_bottom = 11.5
|
|
||||||
grow_horizontal = 2
|
|
||||||
grow_vertical = 2
|
|
||||||
text = "登录中..."
|
|
||||||
horizontal_alignment = 1
|
|
||||||
vertical_alignment = 1
|
|
||||||
@@ -1,40 +0,0 @@
|
|||||||
[gd_scene load_steps=2 format=3 uid="uid://c3mxv7d1qw7ba"]
|
|
||||||
|
|
||||||
[ext_resource type="Script" path="res://scripts/ui/UI_MainMenu.gd" id="1_main_menu"]
|
|
||||||
|
|
||||||
[node name="mainMenuScene" type="Control"]
|
|
||||||
layout_mode = 3
|
|
||||||
anchors_preset = 15
|
|
||||||
anchor_right = 1.0
|
|
||||||
anchor_bottom = 1.0
|
|
||||||
grow_horizontal = 2
|
|
||||||
grow_vertical = 2
|
|
||||||
script = ExtResource("1_main_menu")
|
|
||||||
|
|
||||||
[node name="centerContainer" type="CenterContainer" parent="."]
|
|
||||||
layout_mode = 1
|
|
||||||
anchors_preset = 15
|
|
||||||
anchor_right = 1.0
|
|
||||||
anchor_bottom = 1.0
|
|
||||||
grow_horizontal = 2
|
|
||||||
grow_vertical = 2
|
|
||||||
|
|
||||||
[node name="vboxContainer" type="VBoxContainer" parent="centerContainer"]
|
|
||||||
layout_mode = 2
|
|
||||||
theme_override_constants/separation = 20
|
|
||||||
|
|
||||||
[node name="welcomeLabel" type="Label" parent="centerContainer/vboxContainer"]
|
|
||||||
layout_mode = 2
|
|
||||||
text = "欢迎来到鲸鱼小镇！"
|
|
||||||
horizontal_alignment = 1
|
|
||||||
|
|
||||||
[node name="userInfoLabel" type="Label" parent="centerContainer/vboxContainer"]
|
|
||||||
layout_mode = 2
|
|
||||||
text = "用户名：--
|
|
||||||
等级：--"
|
|
||||||
horizontal_alignment = 1
|
|
||||||
|
|
||||||
[node name="logoutButton" type="Button" parent="centerContainer/vboxContainer"]
|
|
||||||
custom_minimum_size = Vector2(200, 40)
|
|
||||||
layout_mode = 2
|
|
||||||
text = "退出登录"
|
|
||||||
@@ -1,8 +1,188 @@
|
|||||||
[gd_scene load_steps=2 format=3 uid="uid://4ptgx76y83mx"]
|
[gd_scene load_steps=4 format=3 uid="uid://4ptgx76y83mx"]
|
||||||
|
|
||||||
[sub_resource type="AudioStream" id="AudioStream_o3jxj"]
|
[ext_resource type="Texture2D" uid="uid://bx17oy8lvaca4" path="res://assets/ui/auth/bg_auth_scene.png" id="1_background"]
|
||||||
|
[ext_resource type="PackedScene" uid="uid://by7m8snb4xllf" path="res://scenes/auth_scene.tscn" id="2_main"]
|
||||||
|
[ext_resource type="Script" uid="uid://cejrxy23ldhug" path="res://scripts/scenes/MainScene.gd" id="3_script"]
|
||||||
|
|
||||||
[node name="Node2D" type="Node2D"]
|
[node name="Main" type="Control"]
|
||||||
|
layout_mode = 3
|
||||||
|
anchors_preset = 15
|
||||||
|
anchor_right = 1.0
|
||||||
|
anchor_bottom = 1.0
|
||||||
|
grow_horizontal = 2
|
||||||
|
grow_vertical = 2
|
||||||
|
script = ExtResource("3_script")
|
||||||
|
|
||||||
[node name="AudioStreamPlayer" type="AudioStreamPlayer" parent="."]
|
[node name="BackgroundImage" type="TextureRect" parent="."]
|
||||||
stream = SubResource("AudioStream_o3jxj")
|
layout_mode = 1
|
||||||
|
anchors_preset = 15
|
||||||
|
anchor_right = 1.0
|
||||||
|
anchor_bottom = 1.0
|
||||||
|
grow_horizontal = 2
|
||||||
|
grow_vertical = 2
|
||||||
|
texture = ExtResource("1_background")
|
||||||
|
expand_mode = 1
|
||||||
|
stretch_mode = 6
|
||||||
|
|
||||||
|
[node name="AuthScene" parent="." instance=ExtResource("2_main")]
|
||||||
|
layout_mode = 1
|
||||||
|
|
||||||
|
[node name="MainGameUI" type="Control" parent="."]
|
||||||
|
visible = false
|
||||||
|
layout_mode = 1
|
||||||
|
anchors_preset = 15
|
||||||
|
anchor_right = 1.0
|
||||||
|
anchor_bottom = 1.0
|
||||||
|
grow_horizontal = 2
|
||||||
|
grow_vertical = 2
|
||||||
|
|
||||||
|
[node name="UIOverlay" type="ColorRect" parent="MainGameUI"]
|
||||||
|
layout_mode = 1
|
||||||
|
anchors_preset = 15
|
||||||
|
anchor_right = 1.0
|
||||||
|
anchor_bottom = 1.0
|
||||||
|
grow_horizontal = 2
|
||||||
|
grow_vertical = 2
|
||||||
|
color = Color(0, 0, 0, 0.3)
|
||||||
|
|
||||||
|
[node name="TopBar" type="Panel" parent="MainGameUI"]
|
||||||
|
layout_mode = 1
|
||||||
|
anchors_preset = 10
|
||||||
|
anchor_right = 1.0
|
||||||
|
offset_bottom = 60.0
|
||||||
|
grow_horizontal = 2
|
||||||
|
|
||||||
|
[node name="HBoxContainer" type="HBoxContainer" parent="MainGameUI/TopBar"]
|
||||||
|
layout_mode = 1
|
||||||
|
anchors_preset = 15
|
||||||
|
anchor_right = 1.0
|
||||||
|
anchor_bottom = 1.0
|
||||||
|
offset_left = 20.0
|
||||||
|
offset_top = 10.0
|
||||||
|
offset_right = -20.0
|
||||||
|
offset_bottom = -10.0
|
||||||
|
grow_horizontal = 2
|
||||||
|
grow_vertical = 2
|
||||||
|
|
||||||
|
[node name="WelcomeLabel" type="Label" parent="MainGameUI/TopBar/HBoxContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
size_flags_horizontal = 3
|
||||||
|
theme_override_colors/font_color = Color(1, 1, 1, 1)
|
||||||
|
text = "🐋 欢迎来到鲸鱼镇！"
|
||||||
|
vertical_alignment = 1
|
||||||
|
|
||||||
|
[node name="UserLabel" type="Label" parent="MainGameUI/TopBar/HBoxContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
theme_override_colors/font_color = Color(1, 1, 1, 1)
|
||||||
|
text = "当前用户: [用户名]"
|
||||||
|
horizontal_alignment = 2
|
||||||
|
vertical_alignment = 1
|
||||||
|
|
||||||
|
[node name="LogoutButton" type="Button" parent="MainGameUI/TopBar/HBoxContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
text = "退出"
|
||||||
|
|
||||||
|
[node name="MainContent" type="Control" parent="MainGameUI"]
|
||||||
|
layout_mode = 1
|
||||||
|
anchors_preset = 15
|
||||||
|
anchor_right = 1.0
|
||||||
|
anchor_bottom = 1.0
|
||||||
|
offset_top = 60.0
|
||||||
|
grow_horizontal = 2
|
||||||
|
grow_vertical = 2
|
||||||
|
|
||||||
|
[node name="CenterContainer" type="CenterContainer" parent="MainGameUI/MainContent"]
|
||||||
|
layout_mode = 1
|
||||||
|
anchors_preset = 15
|
||||||
|
anchor_right = 1.0
|
||||||
|
anchor_bottom = 1.0
|
||||||
|
grow_horizontal = 2
|
||||||
|
grow_vertical = 2
|
||||||
|
|
||||||
|
[node name="VBoxContainer" type="VBoxContainer" parent="MainGameUI/MainContent/CenterContainer"]
|
||||||
|
custom_minimum_size = Vector2(600, 400)
|
||||||
|
layout_mode = 2
|
||||||
|
|
||||||
|
[node name="GameTitle" type="Label" parent="MainGameUI/MainContent/CenterContainer/VBoxContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
theme_override_colors/font_color = Color(1, 1, 1, 1)
|
||||||
|
theme_override_font_sizes/font_size = 24
|
||||||
|
text = "🏘️ 鲸鱼镇主界面"
|
||||||
|
horizontal_alignment = 1
|
||||||
|
|
||||||
|
[node name="HSeparator" type="HSeparator" parent="MainGameUI/MainContent/CenterContainer/VBoxContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
|
||||||
|
[node name="GameMenuGrid" type="GridContainer" parent="MainGameUI/MainContent/CenterContainer/VBoxContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
size_flags_vertical = 3
|
||||||
|
columns = 2
|
||||||
|
|
||||||
|
[node name="ExploreButton" type="Button" parent="MainGameUI/MainContent/CenterContainer/VBoxContainer/GameMenuGrid"]
|
||||||
|
custom_minimum_size = Vector2(280, 80)
|
||||||
|
layout_mode = 2
|
||||||
|
text = "🗺️ 探索小镇"
|
||||||
|
|
||||||
|
[node name="InventoryButton" type="Button" parent="MainGameUI/MainContent/CenterContainer/VBoxContainer/GameMenuGrid"]
|
||||||
|
custom_minimum_size = Vector2(280, 80)
|
||||||
|
layout_mode = 2
|
||||||
|
text = "🎒 背包物品"
|
||||||
|
|
||||||
|
[node name="ShopButton" type="Button" parent="MainGameUI/MainContent/CenterContainer/VBoxContainer/GameMenuGrid"]
|
||||||
|
custom_minimum_size = Vector2(280, 80)
|
||||||
|
layout_mode = 2
|
||||||
|
text = "🏪 商店购物"
|
||||||
|
|
||||||
|
[node name="FriendsButton" type="Button" parent="MainGameUI/MainContent/CenterContainer/VBoxContainer/GameMenuGrid"]
|
||||||
|
custom_minimum_size = Vector2(280, 80)
|
||||||
|
layout_mode = 2
|
||||||
|
text = "👥 好友列表"
|
||||||
|
|
||||||
|
[node name="HSeparator2" type="HSeparator" parent="MainGameUI/MainContent/CenterContainer/VBoxContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
|
||||||
|
[node name="StatusPanel" type="Panel" parent="MainGameUI/MainContent/CenterContainer/VBoxContainer"]
|
||||||
|
custom_minimum_size = Vector2(0, 120)
|
||||||
|
layout_mode = 2
|
||||||
|
|
||||||
|
[node name="StatusContainer" type="VBoxContainer" parent="MainGameUI/MainContent/CenterContainer/VBoxContainer/StatusPanel"]
|
||||||
|
layout_mode = 1
|
||||||
|
anchors_preset = 15
|
||||||
|
anchor_right = 1.0
|
||||||
|
anchor_bottom = 1.0
|
||||||
|
offset_left = 20.0
|
||||||
|
offset_top = 10.0
|
||||||
|
offset_right = -20.0
|
||||||
|
offset_bottom = -10.0
|
||||||
|
grow_horizontal = 2
|
||||||
|
grow_vertical = 2
|
||||||
|
|
||||||
|
[node name="StatusTitle" type="Label" parent="MainGameUI/MainContent/CenterContainer/VBoxContainer/StatusPanel/StatusContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
theme_override_colors/font_color = Color(1, 1, 1, 1)
|
||||||
|
text = "📊 玩家状态"
|
||||||
|
horizontal_alignment = 1
|
||||||
|
|
||||||
|
[node name="StatusGrid" type="GridContainer" parent="MainGameUI/MainContent/CenterContainer/VBoxContainer/StatusPanel/StatusContainer"]
|
||||||
|
layout_mode = 2
|
||||||
|
columns = 2
|
||||||
|
|
||||||
|
[node name="LevelLabel" type="Label" parent="MainGameUI/MainContent/CenterContainer/VBoxContainer/StatusPanel/StatusContainer/StatusGrid"]
|
||||||
|
layout_mode = 2
|
||||||
|
theme_override_colors/font_color = Color(1, 1, 1, 1)
|
||||||
|
text = "等级: 1"
|
||||||
|
|
||||||
|
[node name="CoinsLabel" type="Label" parent="MainGameUI/MainContent/CenterContainer/VBoxContainer/StatusPanel/StatusContainer/StatusGrid"]
|
||||||
|
layout_mode = 2
|
||||||
|
theme_override_colors/font_color = Color(1, 1, 1, 1)
|
||||||
|
text = "金币: 100"
|
||||||
|
|
||||||
|
[node name="ExpLabel" type="Label" parent="MainGameUI/MainContent/CenterContainer/VBoxContainer/StatusPanel/StatusContainer/StatusGrid"]
|
||||||
|
layout_mode = 2
|
||||||
|
theme_override_colors/font_color = Color(1, 1, 1, 1)
|
||||||
|
text = "经验: 0/100"
|
||||||
|
|
||||||
|
[node name="EnergyLabel" type="Label" parent="MainGameUI/MainContent/CenterContainer/VBoxContainer/StatusPanel/StatusContainer/StatusGrid"]
|
||||||
|
layout_mode = 2
|
||||||
|
theme_override_colors/font_color = Color(1, 1, 1, 1)
|
||||||
|
text = "体力: 100/100"
|
||||||
|
|||||||
1
scenes/prefabs/characters/.gitkeep
Normal file
1
scenes/prefabs/characters/.gitkeep
Normal file
@@ -0,0 +1 @@
|
|||||||
|
# 保持目录结构 - 角色预制体目录
|
||||||
1
scenes/prefabs/effects/.gitkeep
Normal file
1
scenes/prefabs/effects/.gitkeep
Normal file
@@ -0,0 +1 @@
|
|||||||
|
# 保持目录结构 - 特效预制体目录
|
||||||
1
scenes/prefabs/items/.gitkeep
Normal file
1
scenes/prefabs/items/.gitkeep
Normal file
@@ -0,0 +1 @@
|
|||||||
|
# 保持目录结构 - 物品预制体目录
|
||||||
1
scenes/prefabs/ui/.gitkeep
Normal file
1
scenes/prefabs/ui/.gitkeep
Normal file
@@ -0,0 +1 @@
|
|||||||
|
# 保持目录结构 - UI预制体目录
|
||||||
1
scripts/characters/.gitkeep
Normal file
1
scripts/characters/.gitkeep
Normal file
@@ -0,0 +1 @@
|
|||||||
|
# 保持目录结构 - 角色脚本目录
|
||||||
1
scripts/data/.gitkeep
Normal file
1
scripts/data/.gitkeep
Normal file
@@ -0,0 +1 @@
|
|||||||
|
# 保持目录结构 - 数据脚本目录
|
||||||
@@ -1,45 +0,0 @@
|
|||||||
class_name ErrorCode
|
|
||||||
|
|
||||||
## 错误码定义
|
|
||||||
## 用于统一管理登录系统中的所有错误码和错误消息
|
|
||||||
|
|
||||||
# 成功
|
|
||||||
const SUCCESS: int = 0
|
|
||||||
|
|
||||||
# 网络相关错误 (1000-1999)
|
|
||||||
const NETWORK_ERROR: int = 1001
|
|
||||||
const TIMEOUT: int = 1002
|
|
||||||
const SERVER_ERROR: int = 1003
|
|
||||||
|
|
||||||
# 输入验证错误 (2000-2999)
|
|
||||||
const INVALID_INPUT: int = 2001
|
|
||||||
const INVALID_USERNAME: int = 2002
|
|
||||||
const INVALID_PASSWORD: int = 2003
|
|
||||||
const PASSWORDS_NOT_MATCH: int = 2004
|
|
||||||
|
|
||||||
# 认证相关错误 (3000-3999)
|
|
||||||
const WRONG_CREDENTIALS: int = 3001
|
|
||||||
const USER_NOT_FOUND: int = 3002
|
|
||||||
const ACCOUNT_DISABLED: int = 3003
|
|
||||||
const TOKEN_EXPIRED: int = 3004
|
|
||||||
const TOKEN_INVALID: int = 3005
|
|
||||||
|
|
||||||
# 错误消息映射
|
|
||||||
const MESSAGES: Dictionary = {
|
|
||||||
NETWORK_ERROR: "网络连接失败，请检查网络设置",
|
|
||||||
TIMEOUT: "请求超时，请稍后重试",
|
|
||||||
SERVER_ERROR: "服务器错误，请稍后重试",
|
|
||||||
INVALID_INPUT: "用户名或密码不能为空",
|
|
||||||
INVALID_USERNAME: "用户名格式不正确（3-16个字符）",
|
|
||||||
INVALID_PASSWORD: "密码格式不正确（6-20个字符）",
|
|
||||||
PASSWORDS_NOT_MATCH: "两次输入的密码不一致",
|
|
||||||
WRONG_CREDENTIALS: "用户名或密码错误",
|
|
||||||
USER_NOT_FOUND: "用户不存在",
|
|
||||||
ACCOUNT_DISABLED: "账号已被禁用",
|
|
||||||
TOKEN_EXPIRED: "登录已过期，请重新登录",
|
|
||||||
TOKEN_INVALID: "登录状态无效，请重新登录"
|
|
||||||
}
|
|
||||||
|
|
||||||
## 获取错误消息
|
|
||||||
static func getMessage(errorCode: int) -> String:
|
|
||||||
return MESSAGES.get(errorCode, "未知错误 (代码: %d)" % errorCode)
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
uid://cfrgxhalop5rg
|
|
||||||
@@ -1,66 +0,0 @@
|
|||||||
class_name UserData
|
|
||||||
|
|
||||||
## 用户数据类
|
|
||||||
## 用于存储用户的基本信息
|
|
||||||
|
|
||||||
var id: String = ""
|
|
||||||
var username: String = ""
|
|
||||||
var nickname: String = ""
|
|
||||||
var email: String = ""
|
|
||||||
var phone: String = ""
|
|
||||||
var avatarUrl: String = ""
|
|
||||||
var role: int = 1
|
|
||||||
var createdAt: String = ""
|
|
||||||
|
|
||||||
# 兼容旧字段
|
|
||||||
var level: int = 1
|
|
||||||
var exp: int = 0
|
|
||||||
var createTime: int = 0
|
|
||||||
|
|
||||||
## 从字典创建 UserData 对象
|
|
||||||
static func fromDict(data: Dictionary) -> UserData:
|
|
||||||
var userData = UserData.new()
|
|
||||||
|
|
||||||
# 新字段（处理可能为 null 的值）
|
|
||||||
userData.id = str(data.get("id", ""))
|
|
||||||
userData.username = _getStringOrEmpty(data, "username")
|
|
||||||
userData.nickname = _getStringOrEmpty(data, "nickname")
|
|
||||||
userData.email = _getStringOrEmpty(data, "email")
|
|
||||||
userData.phone = _getStringOrEmpty(data, "phone")
|
|
||||||
userData.avatarUrl = _getStringOrEmpty(data, "avatar_url", _getStringOrEmpty(data, "avatarUrl"))
|
|
||||||
userData.role = int(data.get("role", 1))
|
|
||||||
userData.createdAt = _getStringOrEmpty(data, "created_at", _getStringOrEmpty(data, "createdAt"))
|
|
||||||
|
|
||||||
# 兼容旧字段
|
|
||||||
userData.level = data.get("level", 1)
|
|
||||||
userData.exp = data.get("exp", 0)
|
|
||||||
userData.createTime = data.get("create_time", data.get("createTime", 0))
|
|
||||||
|
|
||||||
return userData
|
|
||||||
|
|
||||||
## 辅助方法：从字典中获取字符串，如果为 null 则返回空字符串
|
|
||||||
static func _getStringOrEmpty(data: Dictionary, key: String, defaultValue: String = "") -> String:
|
|
||||||
var value = data.get(key, defaultValue)
|
|
||||||
if value == null:
|
|
||||||
return ""
|
|
||||||
return str(value)
|
|
||||||
|
|
||||||
## 转换为字典
|
|
||||||
func toDict() -> Dictionary:
|
|
||||||
return {
|
|
||||||
"id": id,
|
|
||||||
"username": username,
|
|
||||||
"nickname": nickname,
|
|
||||||
"email": email,
|
|
||||||
"phone": phone,
|
|
||||||
"avatar_url": avatarUrl,
|
|
||||||
"role": role,
|
|
||||||
"created_at": createdAt,
|
|
||||||
"level": level,
|
|
||||||
"exp": exp,
|
|
||||||
"create_time": createTime
|
|
||||||
}
|
|
||||||
|
|
||||||
## 打印用户信息（用于调试）
|
|
||||||
func toString() -> String:
|
|
||||||
return "UserData(id=%s, username=%s, nickname=%s, role=%d)" % [id, username, nickname, role]
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
uid://bxcp8nyo8mha7
|
|
||||||
1
scripts/gameplay/.gitkeep
Normal file
1
scripts/gameplay/.gitkeep
Normal file
@@ -0,0 +1 @@
|
|||||||
|
# 保持目录结构 - 游戏玩法脚本目录
|
||||||
@@ -1,183 +0,0 @@
|
|||||||
extends Node
|
|
||||||
|
|
||||||
## 认证管理器
|
|
||||||
## 统一管理用户登录、登出、Token等认证相关功能
|
|
||||||
|
|
||||||
# 登录状态枚举
|
|
||||||
enum LoginState {
|
|
||||||
NOT_LOGGED_IN, # 未登录
|
|
||||||
LOGGING_IN, # 登录中
|
|
||||||
LOGGED_IN, # 已登录
|
|
||||||
GUEST # 游客模式
|
|
||||||
}
|
|
||||||
|
|
||||||
# 信号
|
|
||||||
signal login_success(userData: UserData)
|
|
||||||
signal login_failed(errorCode: int, errorMessage: String)
|
|
||||||
signal logout_success()
|
|
||||||
|
|
||||||
# 当前登录状态
|
|
||||||
var currentState: LoginState = LoginState.NOT_LOGGED_IN
|
|
||||||
|
|
||||||
# Token
|
|
||||||
var accessToken: String = ""
|
|
||||||
var tokenExpireTime: int = 0
|
|
||||||
|
|
||||||
# 当前用户信息
|
|
||||||
var currentUser: UserData = null
|
|
||||||
|
|
||||||
# 是否正在登录（防止重复请求）
|
|
||||||
var _isLoggingIn: bool = false
|
|
||||||
|
|
||||||
func _ready():
|
|
||||||
# 游戏启动时尝试从本地加载 Token 和用户信息
|
|
||||||
_tryLoadLocalAuth()
|
|
||||||
|
|
||||||
## 登录
|
|
||||||
func login(username: String, password: String, rememberPassword: bool) -> Dictionary:
|
|
||||||
# 防止重复登录
|
|
||||||
if _isLoggingIn:
|
|
||||||
return {
|
|
||||||
"success": false,
|
|
||||||
"error_code": ErrorCode.INVALID_INPUT,
|
|
||||||
"message": "登录中，请稍候..."
|
|
||||||
}
|
|
||||||
|
|
||||||
_isLoggingIn = true
|
|
||||||
currentState = LoginState.LOGGING_IN
|
|
||||||
|
|
||||||
# 构建登录请求数据
|
|
||||||
var requestData = {
|
|
||||||
"identifier": username,
|
|
||||||
"password": password
|
|
||||||
}
|
|
||||||
|
|
||||||
# 发送登录请求
|
|
||||||
var response = await NetworkService.post("/api/auth/login", requestData)
|
|
||||||
|
|
||||||
_isLoggingIn = false
|
|
||||||
|
|
||||||
# 处理响应
|
|
||||||
if response.success:
|
|
||||||
# 解析用户数据和 Token
|
|
||||||
var data = response.get("data", {})
|
|
||||||
var token = data.get("access_token", "")
|
|
||||||
var userData = data.get("user", {})
|
|
||||||
|
|
||||||
if token.is_empty():
|
|
||||||
var errorMsg = "服务器返回数据格式错误"
|
|
||||||
login_failed.emit(ErrorCode.SERVER_ERROR, errorMsg)
|
|
||||||
currentState = LoginState.NOT_LOGGED_IN
|
|
||||||
return {
|
|
||||||
"success": false,
|
|
||||||
"error_code": ErrorCode.SERVER_ERROR,
|
|
||||||
"message": errorMsg
|
|
||||||
}
|
|
||||||
|
|
||||||
# 保存 Token
|
|
||||||
accessToken = token
|
|
||||||
tokenExpireTime = int(Time.get_unix_time_from_system()) + 3600 * 24 # 假设24小时过期
|
|
||||||
StorageService.saveToken(accessToken, tokenExpireTime)
|
|
||||||
|
|
||||||
# 保存用户信息
|
|
||||||
currentUser = UserData.fromDict(userData)
|
|
||||||
StorageService.saveUserData(currentUser)
|
|
||||||
|
|
||||||
# 如果勾选记住密码，保存账号密码
|
|
||||||
if rememberPassword:
|
|
||||||
StorageService.saveAccount(username, password, true)
|
|
||||||
else:
|
|
||||||
# 只保存用户名，不保存密码
|
|
||||||
StorageService.save("account", "last_username", username)
|
|
||||||
StorageService.clearSavedPassword()
|
|
||||||
|
|
||||||
# 更新状态
|
|
||||||
currentState = LoginState.LOGGED_IN
|
|
||||||
|
|
||||||
# 发送登录成功信号
|
|
||||||
login_success.emit(currentUser)
|
|
||||||
|
|
||||||
return {
|
|
||||||
"success": true,
|
|
||||||
"message": "登录成功",
|
|
||||||
"user": currentUser
|
|
||||||
}
|
|
||||||
else:
|
|
||||||
# 登录失败
|
|
||||||
var errorCode = response.get("error_code", ErrorCode.WRONG_CREDENTIALS)
|
|
||||||
var errorMsg = response.get("message", "登录失败")
|
|
||||||
|
|
||||||
currentState = LoginState.NOT_LOGGED_IN
|
|
||||||
login_failed.emit(errorCode, errorMsg)
|
|
||||||
|
|
||||||
return {
|
|
||||||
"success": false,
|
|
||||||
"error_code": errorCode,
|
|
||||||
"message": errorMsg
|
|
||||||
}
|
|
||||||
|
|
||||||
## 登出
|
|
||||||
func logout() -> void:
|
|
||||||
# 清除 Token 和用户信息
|
|
||||||
accessToken = ""
|
|
||||||
tokenExpireTime = 0
|
|
||||||
currentUser = null
|
|
||||||
|
|
||||||
# 清除本地存储（保留用户名和记住密码设置）
|
|
||||||
StorageService.clearToken()
|
|
||||||
|
|
||||||
# 更新状态
|
|
||||||
currentState = LoginState.NOT_LOGGED_IN
|
|
||||||
|
|
||||||
# 发送登出成功信号
|
|
||||||
logout_success.emit()
|
|
||||||
|
|
||||||
print("用户已登出")
|
|
||||||
|
|
||||||
## 检查是否已登录
|
|
||||||
func isLoggedIn() -> bool:
|
|
||||||
return currentState == LoginState.LOGGED_IN and currentUser != null
|
|
||||||
|
|
||||||
## 获取当前用户
|
|
||||||
func getCurrentUser() -> UserData:
|
|
||||||
return currentUser
|
|
||||||
|
|
||||||
## 获取当前 Token
|
|
||||||
func getToken() -> String:
|
|
||||||
return accessToken
|
|
||||||
|
|
||||||
## 尝试从本地加载认证信息
|
|
||||||
func _tryLoadLocalAuth() -> void:
|
|
||||||
# 加载 Token
|
|
||||||
var tokenData = StorageService.loadToken()
|
|
||||||
var token = tokenData.get("token", "")
|
|
||||||
var expireTime = tokenData.get("expire_time", 0)
|
|
||||||
|
|
||||||
# 检查 Token 是否有效
|
|
||||||
var currentTime = int(Time.get_unix_time_from_system())
|
|
||||||
if token.is_empty() or expireTime <= currentTime:
|
|
||||||
print("本地 Token 无效或已过期")
|
|
||||||
return
|
|
||||||
|
|
||||||
# Token 有效，加载用户信息
|
|
||||||
var userData = StorageService.loadUserData()
|
|
||||||
if userData == null:
|
|
||||||
print("本地用户信息不存在")
|
|
||||||
return
|
|
||||||
|
|
||||||
# 恢复登录状态
|
|
||||||
accessToken = token
|
|
||||||
tokenExpireTime = expireTime
|
|
||||||
currentUser = userData
|
|
||||||
currentState = LoginState.LOGGED_IN
|
|
||||||
|
|
||||||
print("从本地恢复登录状态: ", currentUser.username)
|
|
||||||
|
|
||||||
# 可选：静默刷新 Token（如果接近过期）
|
|
||||||
# _refreshTokenIfNeeded()
|
|
||||||
|
|
||||||
## 检查 Token 是否即将过期
|
|
||||||
func isTokenExpiring() -> bool:
|
|
||||||
var currentTime = int(Time.get_unix_time_from_system())
|
|
||||||
var timeLeft = tokenExpireTime - currentTime
|
|
||||||
return timeLeft < 300 # 少于5分钟
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
uid://dt434a8o6ye2p
|
|
||||||
@@ -1,98 +0,0 @@
|
|||||||
extends Node
|
|
||||||
|
|
||||||
## 加密服务
|
|
||||||
## 提供密码加密、解密等安全功能
|
|
||||||
|
|
||||||
# 固定的 Salt（用于生成设备密钥）
|
|
||||||
const FIXED_SALT: String = "whaleTown_2024_secret_key"
|
|
||||||
|
|
||||||
# AES 加密密钥（基于设备ID生成）
|
|
||||||
var _encryptionKey: PackedByteArray
|
|
||||||
|
|
||||||
func _ready():
|
|
||||||
_initEncryptionKey()
|
|
||||||
|
|
||||||
## 初始化加密密钥
|
|
||||||
func _initEncryptionKey() -> void:
|
|
||||||
# 使用设备唯一ID + 固定Salt 生成加密密钥
|
|
||||||
var deviceId = OS.get_unique_id()
|
|
||||||
var keyString = deviceId + FIXED_SALT
|
|
||||||
|
|
||||||
# 使用 SHA-256 生成 32 字节密钥
|
|
||||||
var crypto = Crypto.new()
|
|
||||||
var hash = crypto.generate_random_bytes(32) # 临时方案，实际应该用 hash
|
|
||||||
|
|
||||||
# 简单实现：取字符串的 MD5 哈希的前32字节
|
|
||||||
_encryptionKey = keyString.md5_buffer()
|
|
||||||
# 如果需要32字节，重复一次
|
|
||||||
_encryptionKey.append_array(keyString.md5_buffer())
|
|
||||||
|
|
||||||
## 加密字符串（用于本地存储密码）
|
|
||||||
func encrypt(plainText: String) -> String:
|
|
||||||
if plainText.is_empty():
|
|
||||||
return ""
|
|
||||||
|
|
||||||
var crypto = Crypto.new()
|
|
||||||
var aes = AESContext.new()
|
|
||||||
|
|
||||||
# 生成随机 IV（初始化向量）
|
|
||||||
var iv = crypto.generate_random_bytes(16)
|
|
||||||
|
|
||||||
# 转换明文为字节
|
|
||||||
var plainBytes = plainText.to_utf8_buffer()
|
|
||||||
|
|
||||||
# 使用 AES-256-CBC 加密
|
|
||||||
aes.start(AESContext.MODE_CBC_ENCRYPT, _encryptionKey.slice(0, 32), iv)
|
|
||||||
var encryptedBytes = aes.update(plainBytes)
|
|
||||||
aes.finish()
|
|
||||||
|
|
||||||
# 将 IV 和加密数据组合（IV + encrypted_data）
|
|
||||||
var combined = PackedByteArray()
|
|
||||||
combined.append_array(iv)
|
|
||||||
combined.append_array(encryptedBytes)
|
|
||||||
|
|
||||||
# 转换为 Base64 字符串
|
|
||||||
return Marshalls.raw_to_base64(combined)
|
|
||||||
|
|
||||||
## 解密字符串
|
|
||||||
func decrypt(encryptedText: String) -> String:
|
|
||||||
if encryptedText.is_empty():
|
|
||||||
return ""
|
|
||||||
|
|
||||||
# Base64 解码
|
|
||||||
var combined = Marshalls.base64_to_raw(encryptedText)
|
|
||||||
if combined.size() < 16:
|
|
||||||
push_error("加密数据格式错误")
|
|
||||||
return ""
|
|
||||||
|
|
||||||
# 分离 IV 和加密数据
|
|
||||||
var iv = combined.slice(0, 16)
|
|
||||||
var encryptedBytes = combined.slice(16)
|
|
||||||
|
|
||||||
# 解密
|
|
||||||
var aes = AESContext.new()
|
|
||||||
aes.start(AESContext.MODE_CBC_DECRYPT, _encryptionKey.slice(0, 32), iv)
|
|
||||||
var decryptedBytes = aes.update(encryptedBytes)
|
|
||||||
aes.finish()
|
|
||||||
|
|
||||||
# 转换为字符串
|
|
||||||
return decryptedBytes.get_string_from_utf8()
|
|
||||||
|
|
||||||
## 生成密码哈希（用于网络传输）
|
|
||||||
## 注意：这是简单实现，实际应该使用更安全的算法（如 bcrypt, scrypt）
|
|
||||||
func hashPassword(password: String, salt: String = "") -> String:
|
|
||||||
if password.is_empty():
|
|
||||||
return ""
|
|
||||||
|
|
||||||
var combined = password + salt
|
|
||||||
return combined.sha256_text()
|
|
||||||
|
|
||||||
## 验证密码哈希
|
|
||||||
func verifyPassword(password: String, hashedPassword: String, salt: String = "") -> bool:
|
|
||||||
return hashPassword(password, salt) == hashedPassword
|
|
||||||
|
|
||||||
## 生成随机 Salt
|
|
||||||
func generateSalt(length: int = 16) -> String:
|
|
||||||
var crypto = Crypto.new()
|
|
||||||
var randomBytes = crypto.generate_random_bytes(length)
|
|
||||||
return Marshalls.raw_to_base64(randomBytes)
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
uid://d1dmca6vem1hn
|
|
||||||
@@ -1,282 +0,0 @@
|
|||||||
extends Node
|
|
||||||
|
|
||||||
## 网络服务
|
|
||||||
## 封装 HTTP 请求，提供统一的网络通信接口
|
|
||||||
|
|
||||||
# API 基础 URL
|
|
||||||
const API_BASE_URL: String = "https://whaletownui.angforever.top"
|
|
||||||
|
|
||||||
# 请求超时时间（秒）
|
|
||||||
const REQUEST_TIMEOUT: float = 30.0
|
|
||||||
|
|
||||||
# 最大重试次数
|
|
||||||
const MAX_RETRY: int = 3
|
|
||||||
|
|
||||||
# 是否开启调试日志（显示请求和响应详情）
|
|
||||||
const DEBUG_MODE: bool = true
|
|
||||||
|
|
||||||
## 发送 POST 请求
|
|
||||||
func post(endpoint: String, data: Dictionary, headers: Array = []) -> Dictionary:
|
|
||||||
var url = API_BASE_URL + endpoint
|
|
||||||
return await _request(url, HTTPClient.METHOD_POST, data, headers)
|
|
||||||
|
|
||||||
## 发送 GET 请求
|
|
||||||
func sendGet(endpoint: String, headers: Array = []) -> Dictionary:
|
|
||||||
var url = API_BASE_URL + endpoint
|
|
||||||
return await _request(url, HTTPClient.METHOD_GET, {}, headers)
|
|
||||||
|
|
||||||
## 发送带 Token 的 POST 请求
|
|
||||||
func authenticatedPost(endpoint: String, data: Dictionary) -> Dictionary:
|
|
||||||
var tokenData = StorageService.loadToken()
|
|
||||||
var token = tokenData.get("token", "")
|
|
||||||
|
|
||||||
if token.is_empty():
|
|
||||||
return {
|
|
||||||
"success": false,
|
|
||||||
"error_code": ErrorCode.TOKEN_INVALID,
|
|
||||||
"message": ErrorCode.getMessage(ErrorCode.TOKEN_INVALID)
|
|
||||||
}
|
|
||||||
|
|
||||||
var headers = [
|
|
||||||
"Authorization: Bearer " + token
|
|
||||||
]
|
|
||||||
|
|
||||||
return await post(endpoint, data, headers)
|
|
||||||
|
|
||||||
## 核心请求方法
|
|
||||||
func _request(url: String, method: HTTPClient.Method, data: Dictionary, customHeaders: Array) -> Dictionary:
|
|
||||||
# 创建 HTTPRequest 节点
|
|
||||||
var httpRequest = HTTPRequest.new()
|
|
||||||
add_child(httpRequest)
|
|
||||||
|
|
||||||
# 设置超时
|
|
||||||
httpRequest.timeout = REQUEST_TIMEOUT
|
|
||||||
|
|
||||||
# 构建请求头
|
|
||||||
var headers = [
|
|
||||||
"Content-Type: application/json",
|
|
||||||
"Accept: application/json"
|
|
||||||
]
|
|
||||||
headers.append_array(customHeaders)
|
|
||||||
|
|
||||||
# 准备请求体
|
|
||||||
var body = ""
|
|
||||||
if method == HTTPClient.METHOD_POST or method == HTTPClient.METHOD_PUT:
|
|
||||||
body = JSON.stringify(data)
|
|
||||||
|
|
||||||
# 调试日志：请求信息
|
|
||||||
if DEBUG_MODE:
|
|
||||||
_logRequest(url, method, headers, body)
|
|
||||||
|
|
||||||
# 发送请求
|
|
||||||
var error = httpRequest.request(url, headers, method, body)
|
|
||||||
|
|
||||||
if error != OK:
|
|
||||||
httpRequest.queue_free()
|
|
||||||
return _createErrorResponse(ErrorCode.NETWORK_ERROR, "发送请求失败")
|
|
||||||
|
|
||||||
# 等待响应
|
|
||||||
var result = await httpRequest.request_completed
|
|
||||||
|
|
||||||
# 调试日志：响应信息
|
|
||||||
if DEBUG_MODE:
|
|
||||||
_logResponse(result)
|
|
||||||
|
|
||||||
# 清理
|
|
||||||
httpRequest.queue_free()
|
|
||||||
|
|
||||||
# 解析响应
|
|
||||||
return _parseResponse(result)
|
|
||||||
|
|
||||||
## 解析 HTTP 响应
|
|
||||||
func _parseResponse(result: Array) -> Dictionary:
|
|
||||||
var httpResult: int = result[0]
|
|
||||||
var responseCode: int = result[1]
|
|
||||||
var _headers: PackedStringArray = result[2]
|
|
||||||
var body: PackedByteArray = result[3]
|
|
||||||
|
|
||||||
# 检查 HTTP 请求错误
|
|
||||||
if httpResult != HTTPRequest.RESULT_SUCCESS:
|
|
||||||
return _handleHttpError(httpResult)
|
|
||||||
|
|
||||||
# 检查 HTTP 状态码
|
|
||||||
if responseCode < 200 or responseCode >= 300:
|
|
||||||
return _handleStatusCodeError(responseCode, body)
|
|
||||||
|
|
||||||
# 解析 JSON 响应体
|
|
||||||
var bodyString = body.get_string_from_utf8()
|
|
||||||
if bodyString.is_empty():
|
|
||||||
return _createErrorResponse(ErrorCode.SERVER_ERROR, "服务器返回空响应")
|
|
||||||
|
|
||||||
var json = JSON.new()
|
|
||||||
var parseError = json.parse(bodyString)
|
|
||||||
|
|
||||||
if parseError != OK:
|
|
||||||
push_error("JSON 解析失败: " + bodyString)
|
|
||||||
return _createErrorResponse(ErrorCode.SERVER_ERROR, "响应数据格式错误")
|
|
||||||
|
|
||||||
var responseData = json.data
|
|
||||||
|
|
||||||
# 根据后端API格式解析（通用格式，后续可能需要调整）
|
|
||||||
if typeof(responseData) == TYPE_DICTIONARY:
|
|
||||||
# 检查是否有 success 字段（新版 API 格式）
|
|
||||||
if responseData.has("success"):
|
|
||||||
var success = responseData.get("success", false)
|
|
||||||
if success:
|
|
||||||
return {
|
|
||||||
"success": true,
|
|
||||||
"data": responseData.get("data", {}),
|
|
||||||
"message": responseData.get("message", "操作成功")
|
|
||||||
}
|
|
||||||
else:
|
|
||||||
# 业务错误
|
|
||||||
return {
|
|
||||||
"success": false,
|
|
||||||
"error_code": responseData.get("error_code", ErrorCode.SERVER_ERROR),
|
|
||||||
"message": responseData.get("message", "操作失败")
|
|
||||||
}
|
|
||||||
# 检查是否有 code 字段（旧版 API 格式）
|
|
||||||
elif responseData.has("code"):
|
|
||||||
var code = responseData.get("code", -1)
|
|
||||||
if code == 0 or code == 200: # 成功
|
|
||||||
return {
|
|
||||||
"success": true,
|
|
||||||
"data": responseData.get("data", {}),
|
|
||||||
"message": responseData.get("message", "操作成功")
|
|
||||||
}
|
|
||||||
else: # 业务错误
|
|
||||||
return {
|
|
||||||
"success": false,
|
|
||||||
"error_code": code,
|
|
||||||
"message": responseData.get("message", "操作失败")
|
|
||||||
}
|
|
||||||
else:
|
|
||||||
# 假设整个响应就是数据
|
|
||||||
return {
|
|
||||||
"success": true,
|
|
||||||
"data": responseData,
|
|
||||||
"message": "操作成功"
|
|
||||||
}
|
|
||||||
|
|
||||||
return _createErrorResponse(ErrorCode.SERVER_ERROR, "响应格式不正确")
|
|
||||||
|
|
||||||
## 处理 HTTP 请求错误
|
|
||||||
func _handleHttpError(httpResult: int) -> Dictionary:
|
|
||||||
match httpResult:
|
|
||||||
HTTPRequest.RESULT_TIMEOUT:
|
|
||||||
return _createErrorResponse(ErrorCode.TIMEOUT, "请求超时")
|
|
||||||
HTTPRequest.RESULT_CONNECTION_ERROR:
|
|
||||||
return _createErrorResponse(ErrorCode.NETWORK_ERROR, "网络连接失败")
|
|
||||||
HTTPRequest.RESULT_CANT_CONNECT:
|
|
||||||
return _createErrorResponse(ErrorCode.NETWORK_ERROR, "无法连接到服务器")
|
|
||||||
_:
|
|
||||||
return _createErrorResponse(ErrorCode.NETWORK_ERROR, "网络请求失败: " + str(httpResult))
|
|
||||||
|
|
||||||
## 处理 HTTP 状态码错误
|
|
||||||
func _handleStatusCodeError(statusCode: int, body: PackedByteArray) -> Dictionary:
|
|
||||||
var bodyString = body.get_string_from_utf8()
|
|
||||||
|
|
||||||
# 尝试解析错误信息
|
|
||||||
var json = JSON.new()
|
|
||||||
if json.parse(bodyString) == OK:
|
|
||||||
var data = json.data
|
|
||||||
if typeof(data) == TYPE_DICTIONARY and data.has("message"):
|
|
||||||
var message = data.get("message", "")
|
|
||||||
# 确保 message 是字符串类型
|
|
||||||
if typeof(message) == TYPE_ARRAY:
|
|
||||||
message = ", ".join(message)
|
|
||||||
elif typeof(message) != TYPE_STRING:
|
|
||||||
message = str(message)
|
|
||||||
return _createErrorResponse(statusCode, message)
|
|
||||||
|
|
||||||
# 通用状态码错误处理
|
|
||||||
match statusCode:
|
|
||||||
400:
|
|
||||||
return _createErrorResponse(statusCode, "请求参数错误")
|
|
||||||
401:
|
|
||||||
return _createErrorResponse(statusCode, "未授权，请重新登录")
|
|
||||||
403:
|
|
||||||
return _createErrorResponse(statusCode, "没有权限访问")
|
|
||||||
404:
|
|
||||||
return _createErrorResponse(statusCode, "请求的资源不存在")
|
|
||||||
500:
|
|
||||||
return _createErrorResponse(statusCode, "服务器内部错误")
|
|
||||||
502:
|
|
||||||
return _createErrorResponse(statusCode, "网关错误")
|
|
||||||
503:
|
|
||||||
return _createErrorResponse(statusCode, "服务暂时不可用")
|
|
||||||
_:
|
|
||||||
return _createErrorResponse(statusCode, "HTTP 错误: " + str(statusCode))
|
|
||||||
|
|
||||||
## 创建错误响应
|
|
||||||
func _createErrorResponse(errorCode: int, message: String) -> Dictionary:
|
|
||||||
return {
|
|
||||||
"success": false,
|
|
||||||
"error_code": errorCode,
|
|
||||||
"message": message
|
|
||||||
}
|
|
||||||
|
|
||||||
## 记录请求日志
|
|
||||||
func _logRequest(url: String, method: HTTPClient.Method, headers: Array, body: String) -> void:
|
|
||||||
print("\n========== HTTP 请求 ==========")
|
|
||||||
print("URL: ", url)
|
|
||||||
print("方法: ", _getMethodName(method))
|
|
||||||
print("请求头:")
|
|
||||||
for header in headers:
|
|
||||||
print(" ", header)
|
|
||||||
if not body.is_empty():
|
|
||||||
print("请求体:")
|
|
||||||
# 尝试格式化 JSON
|
|
||||||
var json = JSON.new()
|
|
||||||
if json.parse(body) == OK:
|
|
||||||
print(" ", JSON.stringify(json.data, " "))
|
|
||||||
else:
|
|
||||||
print(" ", body)
|
|
||||||
print("==============================\n")
|
|
||||||
|
|
||||||
## 记录响应日志
|
|
||||||
func _logResponse(result: Array) -> void:
|
|
||||||
var httpResult: int = result[0]
|
|
||||||
var responseCode: int = result[1]
|
|
||||||
var responseHeaders: PackedStringArray = result[2]
|
|
||||||
var body: PackedByteArray = result[3]
|
|
||||||
|
|
||||||
print("\n========== HTTP 响应 ==========")
|
|
||||||
print("请求结果: ", _getHttpResultName(httpResult))
|
|
||||||
print("状态码: ", responseCode)
|
|
||||||
print("响应头:")
|
|
||||||
for header in responseHeaders:
|
|
||||||
print(" ", header)
|
|
||||||
|
|
||||||
var bodyString = body.get_string_from_utf8()
|
|
||||||
if not bodyString.is_empty():
|
|
||||||
print("响应体:")
|
|
||||||
# 尝试格式化 JSON
|
|
||||||
var json = JSON.new()
|
|
||||||
if json.parse(bodyString) == OK:
|
|
||||||
print(" ", JSON.stringify(json.data, " "))
|
|
||||||
else:
|
|
||||||
print(" ", bodyString)
|
|
||||||
else:
|
|
||||||
print("响应体: (空)")
|
|
||||||
print("==============================\n")
|
|
||||||
|
|
||||||
## 获取 HTTP 方法名称
|
|
||||||
func _getMethodName(method: HTTPClient.Method) -> String:
|
|
||||||
match method:
|
|
||||||
HTTPClient.METHOD_GET: return "GET"
|
|
||||||
HTTPClient.METHOD_POST: return "POST"
|
|
||||||
HTTPClient.METHOD_PUT: return "PUT"
|
|
||||||
HTTPClient.METHOD_DELETE: return "DELETE"
|
|
||||||
HTTPClient.METHOD_PATCH: return "PATCH"
|
|
||||||
_: return "UNKNOWN"
|
|
||||||
|
|
||||||
## 获取 HTTP 请求结果名称
|
|
||||||
func _getHttpResultName(result: int) -> String:
|
|
||||||
match result:
|
|
||||||
HTTPRequest.RESULT_SUCCESS: return "成功"
|
|
||||||
HTTPRequest.RESULT_TIMEOUT: return "超时"
|
|
||||||
HTTPRequest.RESULT_CONNECTION_ERROR: return "连接错误"
|
|
||||||
HTTPRequest.RESULT_CANT_CONNECT: return "无法连接"
|
|
||||||
HTTPRequest.RESULT_NO_RESPONSE: return "无响应"
|
|
||||||
_: return "错误 (" + str(result) + ")"
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
uid://ple3a8luflmb
|
|
||||||
@@ -1,124 +0,0 @@
|
|||||||
extends Node
|
|
||||||
|
|
||||||
## 存储服务
|
|
||||||
## 负责本地配置的读写，包括用户账号、密码、Token 等
|
|
||||||
|
|
||||||
# 配置文件路径
|
|
||||||
const CONFIG_PATH: String = "user://user_config.cfg"
|
|
||||||
|
|
||||||
# ConfigFile 实例
|
|
||||||
var _config: ConfigFile
|
|
||||||
|
|
||||||
func _ready():
|
|
||||||
_config = ConfigFile.new()
|
|
||||||
_loadConfig()
|
|
||||||
|
|
||||||
## 加载配置文件
|
|
||||||
func _loadConfig() -> void:
|
|
||||||
var error = _config.load(CONFIG_PATH)
|
|
||||||
if error != OK and error != ERR_FILE_NOT_FOUND:
|
|
||||||
push_error("加载配置文件失败: " + str(error))
|
|
||||||
|
|
||||||
## 保存配置文件
|
|
||||||
func _saveConfig() -> void:
|
|
||||||
var error = _config.save(CONFIG_PATH)
|
|
||||||
if error != OK:
|
|
||||||
push_error("保存配置文件失败: " + str(error))
|
|
||||||
|
|
||||||
## 保存键值对
|
|
||||||
func save(section: String, key: String, value: Variant) -> void:
|
|
||||||
_config.set_value(section, key, value)
|
|
||||||
_saveConfig()
|
|
||||||
|
|
||||||
## 读取值
|
|
||||||
func getValue(section: String, key: String, defaultValue: Variant = null) -> Variant:
|
|
||||||
return _config.get_value(section, key, defaultValue)
|
|
||||||
|
|
||||||
## 保存账号信息（包括加密的密码）
|
|
||||||
func saveAccount(username: String, password: String, remember: bool) -> void:
|
|
||||||
save("account", "last_username", username)
|
|
||||||
|
|
||||||
if remember and not password.is_empty():
|
|
||||||
# 加密密码后保存
|
|
||||||
var encryptedPassword = EncryptionService.encrypt(password)
|
|
||||||
save("account", "saved_password", encryptedPassword)
|
|
||||||
save("account", "remember_password", true)
|
|
||||||
else:
|
|
||||||
# 不记住密码，清除保存的密码
|
|
||||||
clearSavedPassword()
|
|
||||||
|
|
||||||
## 读取保存的账号信息
|
|
||||||
func loadAccount() -> Dictionary:
|
|
||||||
var username = getValue("account", "last_username", "")
|
|
||||||
var rememberPassword = getValue("account", "remember_password", false)
|
|
||||||
var encryptedPassword = getValue("account", "saved_password", "")
|
|
||||||
|
|
||||||
var result = {
|
|
||||||
"username": username,
|
|
||||||
"remember_password": rememberPassword
|
|
||||||
}
|
|
||||||
|
|
||||||
# 如果记住密码，解密密码
|
|
||||||
if rememberPassword and not encryptedPassword.is_empty():
|
|
||||||
var decryptedPassword = EncryptionService.decrypt(encryptedPassword)
|
|
||||||
result["password"] = decryptedPassword
|
|
||||||
else:
|
|
||||||
result["password"] = ""
|
|
||||||
|
|
||||||
return result
|
|
||||||
|
|
||||||
## 清除保存的密码
|
|
||||||
func clearSavedPassword() -> void:
|
|
||||||
save("account", "saved_password", "")
|
|
||||||
save("account", "remember_password", false)
|
|
||||||
|
|
||||||
## 保存 Token
|
|
||||||
func saveToken(token: String, expireTime: int = 0) -> void:
|
|
||||||
save("auth", "token", token)
|
|
||||||
save("auth", "expire_time", expireTime)
|
|
||||||
|
|
||||||
## 读取 Token
|
|
||||||
func loadToken() -> Dictionary:
|
|
||||||
var token = getValue("auth", "token", "")
|
|
||||||
var expireTime = getValue("auth", "expire_time", 0)
|
|
||||||
|
|
||||||
return {
|
|
||||||
"token": token,
|
|
||||||
"expire_time": expireTime
|
|
||||||
}
|
|
||||||
|
|
||||||
## 清除 Token
|
|
||||||
func clearToken() -> void:
|
|
||||||
save("auth", "token", "")
|
|
||||||
save("auth", "expire_time", 0)
|
|
||||||
|
|
||||||
## 保存用户信息
|
|
||||||
func saveUserData(userData: UserData) -> void:
|
|
||||||
if userData == null:
|
|
||||||
return
|
|
||||||
|
|
||||||
save("user", "id", userData.id)
|
|
||||||
save("user", "username", userData.username)
|
|
||||||
save("user", "email", userData.email)
|
|
||||||
save("user", "level", userData.level)
|
|
||||||
save("user", "exp", userData.exp)
|
|
||||||
save("user", "avatar_url", userData.avatarUrl)
|
|
||||||
|
|
||||||
## 读取用户信息
|
|
||||||
func loadUserData() -> UserData:
|
|
||||||
var userData = UserData.new()
|
|
||||||
userData.id = str(getValue("user", "id", ""))
|
|
||||||
userData.username = getValue("user", "username", "")
|
|
||||||
userData.email = getValue("user", "email", "")
|
|
||||||
userData.level = getValue("user", "level", 1)
|
|
||||||
userData.exp = getValue("user", "exp", 0)
|
|
||||||
userData.avatarUrl = getValue("user", "avatar_url", "")
|
|
||||||
|
|
||||||
return userData if not userData.id.is_empty() else null
|
|
||||||
|
|
||||||
## 清除所有用户数据
|
|
||||||
func clearAll() -> void:
|
|
||||||
clearSavedPassword()
|
|
||||||
clearToken()
|
|
||||||
_config.clear()
|
|
||||||
_saveConfig()
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
uid://cotaeupq0tpea
|
|
||||||
31
scripts/network/NetworkTest.gd
Normal file
31
scripts/network/NetworkTest.gd
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
extends Node
|
||||||
|
|
||||||
|
# 简单的API测试脚本
|
||||||
|
const API_BASE_URL = "https://whaletownend.xinghangee.icu"
|
||||||
|
|
||||||
|
func _ready():
|
||||||
|
print("API测试脚本已加载")
|
||||||
|
print("服务器地址: ", API_BASE_URL)
|
||||||
|
|
||||||
|
# 测试服务器连接
|
||||||
|
test_server_status()
|
||||||
|
|
||||||
|
func test_server_status():
|
||||||
|
var http_request = HTTPRequest.new()
|
||||||
|
add_child(http_request)
|
||||||
|
http_request.request_completed.connect(_on_status_request_completed)
|
||||||
|
|
||||||
|
print("正在测试服务器连接...")
|
||||||
|
var error = http_request.request(API_BASE_URL)
|
||||||
|
if error != OK:
|
||||||
|
print("请求失败: ", error)
|
||||||
|
|
||||||
|
func _on_status_request_completed(result: int, response_code: int, headers: PackedStringArray, body: PackedByteArray):
|
||||||
|
var response_text = body.get_string_from_utf8()
|
||||||
|
print("服务器状态响应: ", response_code)
|
||||||
|
print("响应内容: ", response_text)
|
||||||
|
|
||||||
|
if response_code == 200:
|
||||||
|
print("✅ 服务器连接正常")
|
||||||
|
else:
|
||||||
|
print("❌ 服务器连接失败")
|
||||||
1
scripts/network/NetworkTest.gd.uid
Normal file
1
scripts/network/NetworkTest.gd.uid
Normal file
@@ -0,0 +1 @@
|
|||||||
|
uid://bsfrdqpsvwgtb
|
||||||
1098
scripts/scenes/AuthScene.gd
Normal file
1098
scripts/scenes/AuthScene.gd
Normal file
File diff suppressed because it is too large
Load Diff
1
scripts/scenes/AuthScene.gd.uid
Normal file
1
scripts/scenes/AuthScene.gd.uid
Normal file
@@ -0,0 +1 @@
|
|||||||
|
uid://nv8eitxieqtm
|
||||||
116
scripts/scenes/MainScene.gd
Normal file
116
scripts/scenes/MainScene.gd
Normal file
@@ -0,0 +1,116 @@
|
|||||||
|
extends Control
|
||||||
|
|
||||||
|
# 场景节点引用
|
||||||
|
@onready var auth_scene: Control = $AuthScene
|
||||||
|
@onready var main_game_ui: Control = $MainGameUI
|
||||||
|
@onready var user_label: Label = $MainGameUI/TopBar/HBoxContainer/UserLabel
|
||||||
|
@onready var logout_button: Button = $MainGameUI/TopBar/HBoxContainer/LogoutButton
|
||||||
|
|
||||||
|
# 游戏功能按钮
|
||||||
|
@onready var explore_button: Button = $MainGameUI/MainContent/CenterContainer/VBoxContainer/GameMenuGrid/ExploreButton
|
||||||
|
@onready var inventory_button: Button = $MainGameUI/MainContent/CenterContainer/VBoxContainer/GameMenuGrid/InventoryButton
|
||||||
|
@onready var shop_button: Button = $MainGameUI/MainContent/CenterContainer/VBoxContainer/GameMenuGrid/ShopButton
|
||||||
|
@onready var friends_button: Button = $MainGameUI/MainContent/CenterContainer/VBoxContainer/GameMenuGrid/FriendsButton
|
||||||
|
|
||||||
|
# 状态标签
|
||||||
|
@onready var level_label: Label = $MainGameUI/MainContent/CenterContainer/VBoxContainer/StatusPanel/StatusContainer/StatusGrid/LevelLabel
|
||||||
|
@onready var coins_label: Label = $MainGameUI/MainContent/CenterContainer/VBoxContainer/StatusPanel/StatusContainer/StatusGrid/CoinsLabel
|
||||||
|
@onready var exp_label: Label = $MainGameUI/MainContent/CenterContainer/VBoxContainer/StatusPanel/StatusContainer/StatusGrid/ExpLabel
|
||||||
|
@onready var energy_label: Label = $MainGameUI/MainContent/CenterContainer/VBoxContainer/StatusPanel/StatusContainer/StatusGrid/EnergyLabel
|
||||||
|
|
||||||
|
# 游戏状态
|
||||||
|
enum GameState {
|
||||||
|
AUTH, # 登录/注册状态
|
||||||
|
MAIN_GAME # 主游戏状态
|
||||||
|
}
|
||||||
|
|
||||||
|
var current_state: GameState = GameState.AUTH
|
||||||
|
var current_user: String = ""
|
||||||
|
|
||||||
|
# 玩家数据
|
||||||
|
var player_level: int = 1
|
||||||
|
var player_coins: int = 100
|
||||||
|
var player_exp: int = 0
|
||||||
|
var player_max_exp: int = 100
|
||||||
|
var player_energy: int = 100
|
||||||
|
var player_max_energy: int = 100
|
||||||
|
|
||||||
|
func _ready():
|
||||||
|
# 初始化游戏状态
|
||||||
|
setup_game()
|
||||||
|
|
||||||
|
# 连接登录成功信号
|
||||||
|
auth_scene.login_success.connect(_on_login_success)
|
||||||
|
|
||||||
|
# 连接按钮信号
|
||||||
|
logout_button.pressed.connect(_on_logout_pressed)
|
||||||
|
explore_button.pressed.connect(_on_explore_pressed)
|
||||||
|
inventory_button.pressed.connect(_on_inventory_pressed)
|
||||||
|
shop_button.pressed.connect(_on_shop_pressed)
|
||||||
|
friends_button.pressed.connect(_on_friends_pressed)
|
||||||
|
|
||||||
|
func setup_game():
|
||||||
|
# 设置初始状态为登录界面
|
||||||
|
show_auth_scene()
|
||||||
|
|
||||||
|
func show_auth_scene():
|
||||||
|
current_state = GameState.AUTH
|
||||||
|
auth_scene.visible = true
|
||||||
|
main_game_ui.visible = false
|
||||||
|
|
||||||
|
func show_main_game():
|
||||||
|
current_state = GameState.MAIN_GAME
|
||||||
|
auth_scene.visible = false
|
||||||
|
main_game_ui.visible = true
|
||||||
|
user_label.text = "当前用户: " + current_user
|
||||||
|
update_player_status()
|
||||||
|
print("进入主游戏界面")
|
||||||
|
|
||||||
|
func update_player_status():
|
||||||
|
level_label.text = "等级: " + str(player_level)
|
||||||
|
coins_label.text = "金币: " + str(player_coins)
|
||||||
|
exp_label.text = "经验: " + str(player_exp) + "/" + str(player_max_exp)
|
||||||
|
energy_label.text = "体力: " + str(player_energy) + "/" + str(player_max_energy)
|
||||||
|
|
||||||
|
func _on_login_success(username: String):
|
||||||
|
# 登录成功后的处理
|
||||||
|
current_user = username
|
||||||
|
print("用户 ", username, " 登录成功！")
|
||||||
|
show_main_game()
|
||||||
|
|
||||||
|
func _on_logout_pressed():
|
||||||
|
# 登出处理
|
||||||
|
current_user = ""
|
||||||
|
show_auth_scene()
|
||||||
|
|
||||||
|
# 游戏功能按钮处理
|
||||||
|
func _on_explore_pressed():
|
||||||
|
print("探索小镇功能")
|
||||||
|
show_game_message("🗺️ 探索功能开发中...")
|
||||||
|
|
||||||
|
func _on_inventory_pressed():
|
||||||
|
print("背包功能")
|
||||||
|
show_game_message("🎒 背包功能开发中...")
|
||||||
|
|
||||||
|
func _on_shop_pressed():
|
||||||
|
print("商店功能")
|
||||||
|
show_game_message("🏪 商店功能开发中...")
|
||||||
|
|
||||||
|
func _on_friends_pressed():
|
||||||
|
print("好友功能")
|
||||||
|
show_game_message("👥 好友功能开发中...")
|
||||||
|
|
||||||
|
func show_game_message(message: String):
|
||||||
|
print("游戏消息: ", message)
|
||||||
|
# 这里可以添加UI提示框显示消息
|
||||||
|
|
||||||
|
# 处理全局输入
|
||||||
|
func _input(event):
|
||||||
|
if event.is_action_pressed("ui_cancel"):
|
||||||
|
match current_state:
|
||||||
|
GameState.AUTH:
|
||||||
|
# 在登录界面按ESC退出游戏
|
||||||
|
get_tree().quit()
|
||||||
|
GameState.MAIN_GAME:
|
||||||
|
# 在游戏中按ESC可能显示菜单或返回登录
|
||||||
|
show_auth_scene()
|
||||||
1
scripts/scenes/MainScene.gd.uid
Normal file
1
scripts/scenes/MainScene.gd.uid
Normal file
@@ -0,0 +1 @@
|
|||||||
|
uid://cejrxy23ldhug
|
||||||
1
scripts/ui/.gitkeep
Normal file
1
scripts/ui/.gitkeep
Normal file
@@ -0,0 +1 @@
|
|||||||
|
# 保持目录结构 - UI脚本目录
|
||||||
@@ -1,217 +0,0 @@
|
|||||||
extends Control
|
|
||||||
|
|
||||||
## 登录界面控制器
|
|
||||||
## 处理登录界面的用户交互、输入验证、错误提示等
|
|
||||||
|
|
||||||
# UI 节点引用
|
|
||||||
@onready var passwordLoginTab: Button = $LoginPanel/PasswordLoginTab
|
|
||||||
@onready var codeLoginTab: Button = $LoginPanel/CodeLoginTab
|
|
||||||
@onready var usernameInput: LineEdit = $LoginPanel/UsernameInput
|
|
||||||
@onready var passwordInput: LineEdit = $LoginPanel/PasswordInput
|
|
||||||
@onready var togglePasswordButton: Button = $LoginPanel/TogglePasswordButton
|
|
||||||
@onready var rememberPasswordCheckBox: CheckBox = $LoginPanel/RememberPasswordCheckBox
|
|
||||||
@onready var autoLoginCheckBox: CheckBox = $LoginPanel/AutoLoginCheckBox
|
|
||||||
@onready var enterButton: TextureButton = $LoginPanel/EnterButton
|
|
||||||
@onready var forgotPasswordButton: LinkButton = $LoginPanel/ForgotPasswordButton
|
|
||||||
@onready var registerButton: LinkButton = $LoginPanel/RegisterButton
|
|
||||||
@onready var statusLabel: Label = $LoginPanel/StatusLabel
|
|
||||||
@onready var loadingOverlay: ColorRect = $LoadingOverlay
|
|
||||||
@onready var loadingLabel: Label = $LoadingOverlay/LoadingLabel
|
|
||||||
|
|
||||||
# 当前登录模式
|
|
||||||
enum LoginMode {
|
|
||||||
PASSWORD, # 密码登录
|
|
||||||
CODE # 验证码登录
|
|
||||||
}
|
|
||||||
var currentMode: LoginMode = LoginMode.PASSWORD
|
|
||||||
|
|
||||||
func _ready():
|
|
||||||
# 连接Tab按钮信号
|
|
||||||
passwordLoginTab.pressed.connect(_onPasswordTabPressed)
|
|
||||||
codeLoginTab.pressed.connect(_onCodeTabPressed)
|
|
||||||
|
|
||||||
# 连接主要按钮信号
|
|
||||||
enterButton.pressed.connect(_onEnterButtonPressed)
|
|
||||||
togglePasswordButton.pressed.connect(_onTogglePasswordPressed)
|
|
||||||
|
|
||||||
# 连接底部链接按钮
|
|
||||||
forgotPasswordButton.pressed.connect(_onForgotPasswordPressed)
|
|
||||||
registerButton.pressed.connect(_onRegisterPressed)
|
|
||||||
|
|
||||||
# 连接 AuthManager 信号
|
|
||||||
AuthManager.login_success.connect(_onLoginSuccess)
|
|
||||||
AuthManager.login_failed.connect(_onLoginFailed)
|
|
||||||
|
|
||||||
# 连接输入框回车事件
|
|
||||||
usernameInput.text_submitted.connect(_onUsernameSubmitted)
|
|
||||||
passwordInput.text_submitted.connect(_onPasswordSubmitted)
|
|
||||||
|
|
||||||
# 自动填充记住的账号密码
|
|
||||||
_loadSavedAccount()
|
|
||||||
|
|
||||||
# 初始化状态
|
|
||||||
_hideLoading()
|
|
||||||
_clearStatus()
|
|
||||||
_updateLoginMode()
|
|
||||||
|
|
||||||
## Tab切换 - 密码登录
|
|
||||||
func _onPasswordTabPressed() -> void:
|
|
||||||
if currentMode != LoginMode.PASSWORD:
|
|
||||||
currentMode = LoginMode.PASSWORD
|
|
||||||
codeLoginTab.button_pressed = false
|
|
||||||
passwordLoginTab.button_pressed = true
|
|
||||||
_updateLoginMode()
|
|
||||||
|
|
||||||
## Tab切换 - 验证码登录
|
|
||||||
func _onCodeTabPressed() -> void:
|
|
||||||
if currentMode != LoginMode.CODE:
|
|
||||||
currentMode = LoginMode.CODE
|
|
||||||
passwordLoginTab.button_pressed = false
|
|
||||||
codeLoginTab.button_pressed = true
|
|
||||||
_updateLoginMode()
|
|
||||||
|
|
||||||
## 更新登录模式UI
|
|
||||||
func _updateLoginMode() -> void:
|
|
||||||
match currentMode:
|
|
||||||
LoginMode.PASSWORD:
|
|
||||||
passwordInput.placeholder_text = "输入密码"
|
|
||||||
passwordInput.secret = true
|
|
||||||
togglePasswordButton.visible = true
|
|
||||||
LoginMode.CODE:
|
|
||||||
passwordInput.placeholder_text = "输入验证码"
|
|
||||||
passwordInput.secret = false
|
|
||||||
togglePasswordButton.visible = false
|
|
||||||
|
|
||||||
## 切换密码显示/隐藏
|
|
||||||
func _onTogglePasswordPressed() -> void:
|
|
||||||
passwordInput.secret = !passwordInput.secret
|
|
||||||
togglePasswordButton.text = "👁" if passwordInput.secret else "🔒"
|
|
||||||
|
|
||||||
## 加载保存的账号密码
|
|
||||||
func _loadSavedAccount() -> void:
|
|
||||||
var savedAccount = StorageService.loadAccount()
|
|
||||||
|
|
||||||
var username = savedAccount.get("username", "")
|
|
||||||
var password = savedAccount.get("password", "")
|
|
||||||
var rememberPassword = savedAccount.get("remember_password", false)
|
|
||||||
|
|
||||||
# 设置用户名
|
|
||||||
usernameInput.text = username
|
|
||||||
|
|
||||||
if rememberPassword and not password.is_empty():
|
|
||||||
passwordInput.text = password
|
|
||||||
rememberPasswordCheckBox.button_pressed = true
|
|
||||||
else:
|
|
||||||
rememberPasswordCheckBox.button_pressed = false
|
|
||||||
|
|
||||||
## 进入小镇按钮点击事件
|
|
||||||
func _onEnterButtonPressed() -> void:
|
|
||||||
match currentMode:
|
|
||||||
LoginMode.PASSWORD:
|
|
||||||
_handlePasswordLogin()
|
|
||||||
LoginMode.CODE:
|
|
||||||
_handleCodeLogin()
|
|
||||||
|
|
||||||
## 处理密码登录
|
|
||||||
func _handlePasswordLogin() -> void:
|
|
||||||
# 验证输入
|
|
||||||
var validation = _validateInput()
|
|
||||||
if not validation.valid:
|
|
||||||
_showError(validation.error_code)
|
|
||||||
return
|
|
||||||
|
|
||||||
# 显示加载状态
|
|
||||||
_showLoading("登录中...")
|
|
||||||
|
|
||||||
# 获取输入
|
|
||||||
var username = usernameInput.text.strip_edges()
|
|
||||||
var password = passwordInput.text
|
|
||||||
var remember = rememberPasswordCheckBox.button_pressed
|
|
||||||
|
|
||||||
# 调用 AuthManager 登录
|
|
||||||
var result = await AuthManager.login(username, password, remember)
|
|
||||||
|
|
||||||
# 隐藏加载状态
|
|
||||||
_hideLoading()
|
|
||||||
|
|
||||||
## 处理验证码登录
|
|
||||||
func _handleCodeLogin() -> void:
|
|
||||||
# TODO: 实现验证码登录逻辑
|
|
||||||
_showError(ErrorCode.SERVER_ERROR, "验证码登录功能暂未开放")
|
|
||||||
|
|
||||||
## 用户名输入框回车事件
|
|
||||||
func _onUsernameSubmitted(_text: String) -> void:
|
|
||||||
passwordInput.grab_focus()
|
|
||||||
|
|
||||||
## 密码输入框回车事件
|
|
||||||
func _onPasswordSubmitted(_text: String) -> void:
|
|
||||||
_onEnterButtonPressed()
|
|
||||||
|
|
||||||
## 忘记密码按钮点击
|
|
||||||
func _onForgotPasswordPressed() -> void:
|
|
||||||
# TODO: 跳转到忘记密码页面
|
|
||||||
_showError(ErrorCode.SERVER_ERROR, "忘记密码功能暂未开放")
|
|
||||||
|
|
||||||
## 注册按钮点击
|
|
||||||
func _onRegisterPressed() -> void:
|
|
||||||
# TODO: 跳转到注册页面
|
|
||||||
_showError(ErrorCode.SERVER_ERROR, "注册功能暂未开放")
|
|
||||||
|
|
||||||
## 登录成功回调
|
|
||||||
func _onLoginSuccess(userData: UserData) -> void:
|
|
||||||
_hideLoading()
|
|
||||||
_showSuccess("登录成功！")
|
|
||||||
|
|
||||||
# 延迟0.5秒后跳转到主菜单
|
|
||||||
await get_tree().create_timer(0.5).timeout
|
|
||||||
get_tree().change_scene_to_file("res://scenes/main_menu_scene.tscn")
|
|
||||||
|
|
||||||
## 登录失败回调
|
|
||||||
func _onLoginFailed(errorCode: int, errorMessage: String) -> void:
|
|
||||||
_hideLoading()
|
|
||||||
_showError(errorCode, errorMessage)
|
|
||||||
|
|
||||||
## 验证输入
|
|
||||||
func _validateInput() -> Dictionary:
|
|
||||||
var username = usernameInput.text.strip_edges()
|
|
||||||
var password = passwordInput.text
|
|
||||||
|
|
||||||
# 检查是否为空
|
|
||||||
if username.is_empty() or password.is_empty():
|
|
||||||
return {
|
|
||||||
"valid": false,
|
|
||||||
"error_code": ErrorCode.INVALID_INPUT
|
|
||||||
}
|
|
||||||
|
|
||||||
return {"valid": true}
|
|
||||||
|
|
||||||
## 显示加载状态
|
|
||||||
func _showLoading(message: String = "加载中...") -> void:
|
|
||||||
loadingLabel.text = message
|
|
||||||
loadingOverlay.visible = true
|
|
||||||
enterButton.disabled = true
|
|
||||||
|
|
||||||
## 隐藏加载状态
|
|
||||||
func _hideLoading() -> void:
|
|
||||||
loadingOverlay.visible = false
|
|
||||||
enterButton.disabled = false
|
|
||||||
|
|
||||||
## 显示错误提示
|
|
||||||
func _showError(errorCode: int, customMessage: String = "") -> void:
|
|
||||||
var message = customMessage if not customMessage.is_empty() else ErrorCode.getMessage(errorCode)
|
|
||||||
statusLabel.text = message
|
|
||||||
statusLabel.modulate = Color.RED
|
|
||||||
|
|
||||||
# 3秒后自动清除
|
|
||||||
await get_tree().create_timer(3.0).timeout
|
|
||||||
_clearStatus()
|
|
||||||
|
|
||||||
## 显示成功提示
|
|
||||||
func _showSuccess(message: String) -> void:
|
|
||||||
statusLabel.text = message
|
|
||||||
statusLabel.modulate = Color.GREEN
|
|
||||||
|
|
||||||
## 清除状态提示
|
|
||||||
func _clearStatus() -> void:
|
|
||||||
statusLabel.text = " "
|
|
||||||
statusLabel.modulate = Color.WHITE
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
uid://c6f1awwaw1nim
|
|
||||||
@@ -1,37 +0,0 @@
|
|||||||
extends Control
|
|
||||||
|
|
||||||
## 主菜单界面控制器
|
|
||||||
## 显示用户信息并提供退出登录功能
|
|
||||||
|
|
||||||
@onready var welcomeLabel: Label = $centerContainer/vboxContainer/welcomeLabel
|
|
||||||
@onready var userInfoLabel: Label = $centerContainer/vboxContainer/userInfoLabel
|
|
||||||
@onready var logoutButton: Button = $centerContainer/vboxContainer/logoutButton
|
|
||||||
|
|
||||||
func _ready():
|
|
||||||
# 连接退出登录按钮
|
|
||||||
logoutButton.pressed.connect(_onLogoutPressed)
|
|
||||||
|
|
||||||
# 连接 AuthManager 信号
|
|
||||||
AuthManager.logout_success.connect(_onLogoutSuccess)
|
|
||||||
|
|
||||||
# 显示用户信息
|
|
||||||
_displayUserInfo()
|
|
||||||
|
|
||||||
## 显示用户信息
|
|
||||||
func _displayUserInfo() -> void:
|
|
||||||
var currentUser = AuthManager.getCurrentUser()
|
|
||||||
|
|
||||||
if currentUser != null:
|
|
||||||
userInfoLabel.text = "用户名：%s\n等级：%d" % [currentUser.username, currentUser.level]
|
|
||||||
else:
|
|
||||||
userInfoLabel.text = "未登录"
|
|
||||||
|
|
||||||
## 退出登录按钮点击事件
|
|
||||||
func _onLogoutPressed() -> void:
|
|
||||||
# 调用 AuthManager 登出
|
|
||||||
AuthManager.logout()
|
|
||||||
|
|
||||||
## 登出成功回调
|
|
||||||
func _onLogoutSuccess() -> void:
|
|
||||||
# 返回登录界面
|
|
||||||
get_tree().change_scene_to_file("res://scenes/login_scene.tscn")
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
uid://cfpv68lwjwove
|
|
||||||
150
tests/api/README.md
Normal file
150
tests/api/README.md
Normal file
@@ -0,0 +1,150 @@
|
|||||||
|
# API接口测试
|
||||||
|
|
||||||
|
本目录包含用于测试whaleTown项目API接口的测试脚本。
|
||||||
|
|
||||||
|
## 测试脚本说明
|
||||||
|
|
||||||
|
### 1. `simple_api_test.py` - 简化版测试
|
||||||
|
快速验证API接口的基本连通性和功能。
|
||||||
|
|
||||||
|
**使用方法：**
|
||||||
|
```bash
|
||||||
|
# 使用默认服务器地址
|
||||||
|
python tests/api/simple_api_test.py
|
||||||
|
|
||||||
|
# 使用自定义服务器地址
|
||||||
|
python tests/api/simple_api_test.py http://localhost:3000
|
||||||
|
```
|
||||||
|
|
||||||
|
**测试内容：**
|
||||||
|
- ✅ 应用状态检查 (`GET /`)
|
||||||
|
- ✅ 发送邮箱验证码 (`POST /auth/send-email-verification`)
|
||||||
|
- ✅ 用户注册 (`POST /auth/register`)
|
||||||
|
- ✅ 用户登录 (`POST /auth/login`)
|
||||||
|
- ✅ 无效登录测试
|
||||||
|
- ✅ 管理员登录测试
|
||||||
|
|
||||||
|
### 2. `api_test.py` - 完整版测试
|
||||||
|
全面的API接口测试，包括边界条件和错误处理。
|
||||||
|
|
||||||
|
**使用方法：**
|
||||||
|
```bash
|
||||||
|
# 基础测试
|
||||||
|
python tests/api/api_test.py
|
||||||
|
|
||||||
|
# 详细日志
|
||||||
|
python tests/api/api_test.py --verbose
|
||||||
|
|
||||||
|
# 自定义参数
|
||||||
|
python tests/api/api_test.py --base-url http://localhost:3000 --test-email custom@example.com
|
||||||
|
```
|
||||||
|
|
||||||
|
**测试内容：**
|
||||||
|
- 应用状态接口测试
|
||||||
|
- 用户认证功能测试
|
||||||
|
- 管理员功能测试
|
||||||
|
- 用户状态管理测试
|
||||||
|
- 错误处理测试
|
||||||
|
- 频率限制测试
|
||||||
|
|
||||||
|
## 测试结果示例
|
||||||
|
|
||||||
|
### 成功的测试输出
|
||||||
|
```
|
||||||
|
[18:28:55] 🚀 开始基础API测试...
|
||||||
|
[18:28:55] 测试目标: https://whaletownend.xinghangee.icu
|
||||||
|
[18:28:55] ✅ 应用状态检查
|
||||||
|
[18:28:55] 状态码: 200
|
||||||
|
[18:28:55] 响应: Pixel Game Server is running!
|
||||||
|
[18:28:55] ✅ 发送邮箱验证码
|
||||||
|
[18:28:55] 状态码: 200
|
||||||
|
[18:28:55] 📧 获取到验证码: 046189
|
||||||
|
[18:28:55] ✅ 用户注册
|
||||||
|
[18:28:55] 状态码: 201
|
||||||
|
[18:28:55] 🎯 基础测试完成！
|
||||||
|
```
|
||||||
|
|
||||||
|
### API接口验证结果
|
||||||
|
|
||||||
|
根据测试结果，以下接口已验证可用：
|
||||||
|
|
||||||
|
#### ✅ 可用接口
|
||||||
|
1. **应用状态** - `GET /`
|
||||||
|
- 状态码: 200
|
||||||
|
- 响应: "Pixel Game Server is running!"
|
||||||
|
|
||||||
|
2. **发送邮箱验证码** - `POST /auth/send-email-verification`
|
||||||
|
- 状态码: 200
|
||||||
|
- 功能: 正常发送验证码
|
||||||
|
- 频率限制: 1分钟内限制重复发送
|
||||||
|
|
||||||
|
3. **用户注册** - `POST /auth/register`
|
||||||
|
- 状态码: 201 (成功) / 400 (参数错误)
|
||||||
|
- 需要邮箱验证码
|
||||||
|
- 支持完整的参数验证
|
||||||
|
|
||||||
|
4. **用户登录** - `POST /auth/login`
|
||||||
|
- 状态码: 200
|
||||||
|
- 支持用户名/邮箱登录
|
||||||
|
- 正确的错误处理
|
||||||
|
|
||||||
|
#### ❌ 不可用接口
|
||||||
|
1. **管理员登录** - `POST /admin/auth/login`
|
||||||
|
- 状态码: 404
|
||||||
|
- 错误: "Cannot POST /admin/auth/login"
|
||||||
|
- 可能的原因: 路径不正确或功能未实现
|
||||||
|
|
||||||
|
## 测试发现的问题
|
||||||
|
|
||||||
|
### 1. 管理员接口路径问题
|
||||||
|
- 文档中的 `/admin/auth/login` 返回404
|
||||||
|
- 需要确认正确的管理员登录路径
|
||||||
|
|
||||||
|
### 2. 频率限制功能正常
|
||||||
|
- 验证码发送有1分钟的频率限制
|
||||||
|
- 错误消息清晰："请等待 XX 秒后再试"
|
||||||
|
|
||||||
|
### 3. 参数验证严格
|
||||||
|
- 注册时必须提供邮箱验证码
|
||||||
|
- 错误消息准确："提供邮箱时必须提供邮箱验证码"
|
||||||
|
|
||||||
|
## 建议的测试流程
|
||||||
|
|
||||||
|
### 开发环境测试
|
||||||
|
1. 运行简化版测试验证基本功能
|
||||||
|
2. 检查所有接口的连通性
|
||||||
|
3. 验证错误处理是否正确
|
||||||
|
|
||||||
|
### 生产环境测试
|
||||||
|
1. 使用完整版测试进行全面验证
|
||||||
|
2. 测试所有边界条件
|
||||||
|
3. 验证安全功能（频率限制、权限控制）
|
||||||
|
|
||||||
|
## 扩展测试
|
||||||
|
|
||||||
|
### 添加新的测试用例
|
||||||
|
1. 在对应的测试脚本中添加新的测试方法
|
||||||
|
2. 遵循现有的测试模式
|
||||||
|
3. 添加适当的错误处理
|
||||||
|
|
||||||
|
### 自定义测试参数
|
||||||
|
```python
|
||||||
|
# 修改测试配置
|
||||||
|
tester = SimpleAPITester("http://your-server.com")
|
||||||
|
tester.run_basic_tests()
|
||||||
|
```
|
||||||
|
|
||||||
|
## 注意事项
|
||||||
|
|
||||||
|
1. **频率限制**: 测试时注意API的频率限制，避免被限制
|
||||||
|
2. **测试数据**: 使用时间戳生成唯一的测试数据
|
||||||
|
3. **网络超时**: 设置合适的请求超时时间
|
||||||
|
4. **错误处理**: 测试脚本包含完整的错误处理逻辑
|
||||||
|
|
||||||
|
## 依赖要求
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pip install requests
|
||||||
|
```
|
||||||
|
|
||||||
|
测试脚本使用Python标准库和requests库，无需额外依赖。
|
||||||
506
tests/api/api_test.py
Normal file
506
tests/api/api_test.py
Normal file
@@ -0,0 +1,506 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
"""
|
||||||
|
API接口测试脚本
|
||||||
|
|
||||||
|
根据 docs/api-documentation.md 文档自动测试所有API接口
|
||||||
|
支持完整的功能测试、边界条件测试和错误处理测试
|
||||||
|
|
||||||
|
使用方法:
|
||||||
|
python tests/api/api_test.py
|
||||||
|
python tests/api/api_test.py --base-url http://localhost:3000
|
||||||
|
python tests/api/api_test.py --verbose --test-email custom@example.com
|
||||||
|
"""
|
||||||
|
|
||||||
|
import requests
|
||||||
|
import json
|
||||||
|
import time
|
||||||
|
import argparse
|
||||||
|
import sys
|
||||||
|
from datetime import datetime
|
||||||
|
from typing import Dict, Any, Optional, List
|
||||||
|
import uuid
|
||||||
|
|
||||||
|
|
||||||
|
class APITester:
|
||||||
|
"""API接口测试类"""
|
||||||
|
|
||||||
|
def __init__(self, base_url: str = "https://whaletownend.xinghangee.icu",
|
||||||
|
test_email: str = "test@example.com", verbose: bool = False):
|
||||||
|
self.base_url = base_url.rstrip('/')
|
||||||
|
self.test_email = test_email
|
||||||
|
self.verbose = verbose
|
||||||
|
self.session = requests.Session()
|
||||||
|
self.session.headers.update({
|
||||||
|
'Content-Type': 'application/json',
|
||||||
|
'User-Agent': 'whaleTown-API-Tester/1.0'
|
||||||
|
})
|
||||||
|
|
||||||
|
# 测试数据存储
|
||||||
|
self.test_data = {
|
||||||
|
'admin_token': None,
|
||||||
|
'user_token': None,
|
||||||
|
'test_user_id': None,
|
||||||
|
'verification_code': None
|
||||||
|
}
|
||||||
|
|
||||||
|
# 测试结果统计
|
||||||
|
self.stats = {
|
||||||
|
'total': 0,
|
||||||
|
'passed': 0,
|
||||||
|
'failed': 0,
|
||||||
|
'errors': []
|
||||||
|
}
|
||||||
|
|
||||||
|
def log(self, message: str, level: str = "INFO"):
|
||||||
|
"""日志输出"""
|
||||||
|
timestamp = datetime.now().strftime("%H:%M:%S")
|
||||||
|
if level == "ERROR" or self.verbose:
|
||||||
|
print(f"[{timestamp}] {level}: {message}")
|
||||||
|
|
||||||
|
def make_request(self, method: str, endpoint: str, data: Dict = None,
|
||||||
|
headers: Dict = None, expected_status: int = None) -> Dict:
|
||||||
|
"""发送HTTP请求"""
|
||||||
|
url = f"{self.base_url}{endpoint}"
|
||||||
|
request_headers = self.session.headers.copy()
|
||||||
|
if headers:
|
||||||
|
request_headers.update(headers)
|
||||||
|
|
||||||
|
try:
|
||||||
|
if method.upper() == 'GET':
|
||||||
|
response = self.session.get(url, headers=request_headers, timeout=30)
|
||||||
|
elif method.upper() == 'POST':
|
||||||
|
response = self.session.post(url, json=data, headers=request_headers, timeout=30)
|
||||||
|
elif method.upper() == 'PUT':
|
||||||
|
response = self.session.put(url, json=data, headers=request_headers, timeout=30)
|
||||||
|
else:
|
||||||
|
raise ValueError(f"不支持的HTTP方法: {method}")
|
||||||
|
|
||||||
|
# 检查状态码
|
||||||
|
if expected_status and response.status_code != expected_status:
|
||||||
|
self.log(f"状态码不匹配: 期望 {expected_status}, 实际 {response.status_code}", "ERROR")
|
||||||
|
|
||||||
|
# 尝试解析JSON
|
||||||
|
try:
|
||||||
|
result = response.json()
|
||||||
|
except json.JSONDecodeError:
|
||||||
|
result = {"raw_response": response.text, "status_code": response.status_code}
|
||||||
|
|
||||||
|
result['status_code'] = response.status_code
|
||||||
|
return result
|
||||||
|
|
||||||
|
except requests.exceptions.RequestException as e:
|
||||||
|
self.log(f"请求失败: {str(e)}", "ERROR")
|
||||||
|
return {"error": str(e), "status_code": 0}
|
||||||
|
|
||||||
|
def assert_response(self, response: Dict, expected_success: bool = True,
|
||||||
|
expected_fields: List[str] = None, test_name: str = ""):
|
||||||
|
"""验证响应结果"""
|
||||||
|
self.stats['total'] += 1
|
||||||
|
|
||||||
|
try:
|
||||||
|
# 检查基本结构
|
||||||
|
if 'error' in response:
|
||||||
|
raise AssertionError(f"请求错误: {response['error']}")
|
||||||
|
|
||||||
|
# 检查success字段
|
||||||
|
if 'success' in response:
|
||||||
|
if response['success'] != expected_success:
|
||||||
|
raise AssertionError(f"success字段不匹配: 期望 {expected_success}, 实际 {response['success']}")
|
||||||
|
|
||||||
|
# 检查必需字段
|
||||||
|
if expected_fields:
|
||||||
|
for field in expected_fields:
|
||||||
|
if field not in response:
|
||||||
|
raise AssertionError(f"缺少必需字段: {field}")
|
||||||
|
|
||||||
|
self.stats['passed'] += 1
|
||||||
|
self.log(f"✅ {test_name} - 通过")
|
||||||
|
return True
|
||||||
|
|
||||||
|
except AssertionError as e:
|
||||||
|
self.stats['failed'] += 1
|
||||||
|
error_msg = f"❌ {test_name} - 失败: {str(e)}"
|
||||||
|
self.log(error_msg, "ERROR")
|
||||||
|
self.stats['errors'].append(error_msg)
|
||||||
|
return False
|
||||||
|
|
||||||
|
def test_app_status(self):
|
||||||
|
"""测试应用状态接口"""
|
||||||
|
self.log("开始测试应用状态接口...")
|
||||||
|
|
||||||
|
response = self.make_request('GET', '/')
|
||||||
|
|
||||||
|
# 应用状态接口可能返回不同的字段结构
|
||||||
|
if response.get('status_code') == 200:
|
||||||
|
# 检查是否有基本的状态信息
|
||||||
|
has_status_info = any(key in response for key in ['service', 'status', 'version', 'timestamp'])
|
||||||
|
if has_status_info:
|
||||||
|
self.stats['total'] += 1
|
||||||
|
self.stats['passed'] += 1
|
||||||
|
self.log(f"✅ 获取应用状态 - 通过")
|
||||||
|
else:
|
||||||
|
self.stats['total'] += 1
|
||||||
|
self.stats['failed'] += 1
|
||||||
|
error_msg = f"❌ 获取应用状态 - 失败: 响应格式不正确"
|
||||||
|
self.log(error_msg, "ERROR")
|
||||||
|
self.stats['errors'].append(error_msg)
|
||||||
|
else:
|
||||||
|
self.stats['total'] += 1
|
||||||
|
self.stats['failed'] += 1
|
||||||
|
error_msg = f"❌ 获取应用状态 - 失败: HTTP状态码 {response.get('status_code')}"
|
||||||
|
self.log(error_msg, "ERROR")
|
||||||
|
self.stats['errors'].append(error_msg)
|
||||||
|
|
||||||
|
def test_send_verification_code(self) -> Optional[str]:
|
||||||
|
"""测试发送邮箱验证码"""
|
||||||
|
self.log("开始测试发送邮箱验证码...")
|
||||||
|
|
||||||
|
response = self.make_request('POST', '/auth/send-email-verification', {
|
||||||
|
'email': self.test_email
|
||||||
|
})
|
||||||
|
|
||||||
|
# 测试模式下返回206状态码，success为false但有验证码
|
||||||
|
if response.get('status_code') == 206:
|
||||||
|
if 'data' in response and 'verification_code' in response['data']:
|
||||||
|
verification_code = response['data']['verification_code']
|
||||||
|
self.test_data['verification_code'] = verification_code
|
||||||
|
self.log(f"获取到验证码: {verification_code}")
|
||||||
|
self.stats['total'] += 1
|
||||||
|
self.stats['passed'] += 1
|
||||||
|
self.log(f"✅ 发送邮箱验证码(测试模式) - 通过")
|
||||||
|
return verification_code
|
||||||
|
elif response.get('success') == True:
|
||||||
|
# 正常模式
|
||||||
|
self.assert_response(
|
||||||
|
response,
|
||||||
|
expected_success=True,
|
||||||
|
expected_fields=['data'],
|
||||||
|
test_name="发送邮箱验证码"
|
||||||
|
)
|
||||||
|
if 'data' in response and 'verification_code' in response['data']:
|
||||||
|
return response['data']['verification_code']
|
||||||
|
|
||||||
|
# 测试失败
|
||||||
|
self.stats['total'] += 1
|
||||||
|
self.stats['failed'] += 1
|
||||||
|
error_msg = f"❌ 发送邮箱验证码 - 失败: 无法获取验证码"
|
||||||
|
self.log(error_msg, "ERROR")
|
||||||
|
self.stats['errors'].append(error_msg)
|
||||||
|
return None
|
||||||
|
|
||||||
|
def test_user_register(self) -> Optional[str]:
|
||||||
|
"""测试用户注册"""
|
||||||
|
self.log("开始测试用户注册...")
|
||||||
|
|
||||||
|
# 先获取验证码
|
||||||
|
verification_code = self.test_send_verification_code()
|
||||||
|
if not verification_code:
|
||||||
|
self.log("无法获取验证码，跳过注册测试", "ERROR")
|
||||||
|
return None
|
||||||
|
|
||||||
|
# 生成唯一用户名
|
||||||
|
username = f"testuser_{int(time.time())}"
|
||||||
|
|
||||||
|
response = self.make_request('POST', '/auth/register', {
|
||||||
|
'username': username,
|
||||||
|
'password': 'Test123456',
|
||||||
|
'nickname': '测试用户',
|
||||||
|
'email': self.test_email
|
||||||
|
})
|
||||||
|
|
||||||
|
if self.assert_response(
|
||||||
|
response,
|
||||||
|
expected_success=True,
|
||||||
|
expected_fields=['data'],
|
||||||
|
test_name="用户注册"
|
||||||
|
):
|
||||||
|
if 'data' in response and 'user' in response['data']:
|
||||||
|
user_id = response['data']['user'].get('id')
|
||||||
|
self.test_data['test_user_id'] = user_id
|
||||||
|
self.log(f"注册成功，用户ID: {user_id}")
|
||||||
|
|
||||||
|
# 保存用户token
|
||||||
|
if 'access_token' in response['data']:
|
||||||
|
self.test_data['user_token'] = response['data']['access_token']
|
||||||
|
|
||||||
|
return user_id
|
||||||
|
|
||||||
|
return None
|
||||||
|
|
||||||
|
def test_user_login(self):
|
||||||
|
"""测试用户登录"""
|
||||||
|
self.log("开始测试用户登录...")
|
||||||
|
|
||||||
|
# 使用已注册的用户登录
|
||||||
|
username = f"testuser_{int(time.time() - 1)}" # 使用之前的用户名
|
||||||
|
|
||||||
|
response = self.make_request('POST', '/auth/login', {
|
||||||
|
'identifier': username,
|
||||||
|
'password': 'Test123456'
|
||||||
|
})
|
||||||
|
|
||||||
|
# 如果用户不存在，尝试注册后登录
|
||||||
|
if not response.get('success'):
|
||||||
|
self.log("用户不存在，先注册用户...")
|
||||||
|
self.test_user_register()
|
||||||
|
|
||||||
|
# 重新尝试登录
|
||||||
|
response = self.make_request('POST', '/auth/login', {
|
||||||
|
'identifier': username,
|
||||||
|
'password': 'Test123456'
|
||||||
|
})
|
||||||
|
|
||||||
|
self.assert_response(
|
||||||
|
response,
|
||||||
|
expected_success=True,
|
||||||
|
expected_fields=['data'],
|
||||||
|
test_name="用户登录"
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_admin_login(self) -> Optional[str]:
|
||||||
|
"""测试管理员登录"""
|
||||||
|
self.log("开始测试管理员登录...")
|
||||||
|
|
||||||
|
# 尝试不同的管理员登录路径
|
||||||
|
admin_endpoints = ['/admin/auth/login', '/admin/login']
|
||||||
|
|
||||||
|
for endpoint in admin_endpoints:
|
||||||
|
response = self.make_request('POST', endpoint, {
|
||||||
|
'identifier': 'admin',
|
||||||
|
'password': 'Admin123456'
|
||||||
|
})
|
||||||
|
|
||||||
|
if response.get('status_code') != 404:
|
||||||
|
if self.assert_response(
|
||||||
|
response,
|
||||||
|
expected_success=True,
|
||||||
|
expected_fields=['data'],
|
||||||
|
test_name=f"管理员登录({endpoint})"
|
||||||
|
):
|
||||||
|
if 'data' in response and 'access_token' in response['data']:
|
||||||
|
admin_token = response['data']['access_token']
|
||||||
|
self.test_data['admin_token'] = admin_token
|
||||||
|
self.log("管理员登录成功")
|
||||||
|
return admin_token
|
||||||
|
break
|
||||||
|
|
||||||
|
# 如果所有端点都失败
|
||||||
|
self.stats['total'] += 1
|
||||||
|
self.stats['failed'] += 1
|
||||||
|
error_msg = f"❌ 管理员登录 - 失败: 所有管理员登录端点都不可用"
|
||||||
|
self.log(error_msg, "ERROR")
|
||||||
|
self.stats['errors'].append(error_msg)
|
||||||
|
return None
|
||||||
|
|
||||||
|
def test_admin_get_users(self):
|
||||||
|
"""测试获取用户列表"""
|
||||||
|
self.log("开始测试获取用户列表...")
|
||||||
|
|
||||||
|
admin_token = self.test_data.get('admin_token')
|
||||||
|
if not admin_token:
|
||||||
|
admin_token = self.test_admin_login()
|
||||||
|
|
||||||
|
if not admin_token:
|
||||||
|
self.log("无管理员token，跳过用户列表测试", "ERROR")
|
||||||
|
return
|
||||||
|
|
||||||
|
response = self.make_request('GET', '/admin/users?limit=10&offset=0',
|
||||||
|
headers={'Authorization': f'Bearer {admin_token}'})
|
||||||
|
|
||||||
|
self.assert_response(
|
||||||
|
response,
|
||||||
|
expected_success=True,
|
||||||
|
expected_fields=['data'],
|
||||||
|
test_name="获取用户列表"
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_user_status_management(self):
|
||||||
|
"""测试用户状态管理"""
|
||||||
|
self.log("开始测试用户状态管理...")
|
||||||
|
|
||||||
|
admin_token = self.test_data.get('admin_token')
|
||||||
|
user_id = self.test_data.get('test_user_id')
|
||||||
|
|
||||||
|
if not admin_token:
|
||||||
|
admin_token = self.test_admin_login()
|
||||||
|
|
||||||
|
if not user_id:
|
||||||
|
user_id = self.test_user_register()
|
||||||
|
|
||||||
|
if not admin_token or not user_id:
|
||||||
|
self.log("缺少必要数据，跳过用户状态管理测试", "ERROR")
|
||||||
|
return
|
||||||
|
|
||||||
|
# 测试修改用户状态
|
||||||
|
response = self.make_request('PUT', f'/admin/users/{user_id}/status',
|
||||||
|
data={
|
||||||
|
'status': 'locked',
|
||||||
|
'reason': '测试锁定'
|
||||||
|
},
|
||||||
|
headers={'Authorization': f'Bearer {admin_token}'})
|
||||||
|
|
||||||
|
self.assert_response(
|
||||||
|
response,
|
||||||
|
expected_success=True,
|
||||||
|
expected_fields=['data'],
|
||||||
|
test_name="修改用户状态"
|
||||||
|
)
|
||||||
|
|
||||||
|
# 测试用户状态统计
|
||||||
|
response = self.make_request('GET', '/admin/users/status-stats',
|
||||||
|
headers={'Authorization': f'Bearer {admin_token}'})
|
||||||
|
|
||||||
|
self.assert_response(
|
||||||
|
response,
|
||||||
|
expected_success=True,
|
||||||
|
expected_fields=['data'],
|
||||||
|
test_name="用户状态统计"
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_error_cases(self):
|
||||||
|
"""测试错误情况"""
|
||||||
|
self.log("开始测试错误情况...")
|
||||||
|
|
||||||
|
# 测试无效登录
|
||||||
|
response = self.make_request('POST', '/auth/login', {
|
||||||
|
'identifier': 'nonexistent',
|
||||||
|
'password': 'wrongpassword'
|
||||||
|
})
|
||||||
|
|
||||||
|
self.assert_response(
|
||||||
|
response,
|
||||||
|
expected_success=False,
|
||||||
|
expected_fields=['error_code'],
|
||||||
|
test_name="无效用户登录"
|
||||||
|
)
|
||||||
|
|
||||||
|
# 测试无效验证码
|
||||||
|
response = self.make_request('POST', '/auth/verify-email', {
|
||||||
|
'email': self.test_email,
|
||||||
|
'verification_code': '000000'
|
||||||
|
})
|
||||||
|
|
||||||
|
self.assert_response(
|
||||||
|
response,
|
||||||
|
expected_success=False,
|
||||||
|
test_name="无效验证码验证"
|
||||||
|
)
|
||||||
|
|
||||||
|
# 测试无权限访问管理员接口
|
||||||
|
response = self.make_request('GET', '/admin/users')
|
||||||
|
|
||||||
|
# 应该返回401或403
|
||||||
|
if response.get('status_code') in [401, 403]:
|
||||||
|
self.assert_response(
|
||||||
|
response,
|
||||||
|
expected_success=False,
|
||||||
|
test_name="无权限访问管理员接口"
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_rate_limiting(self):
|
||||||
|
"""测试频率限制"""
|
||||||
|
self.log("开始测试频率限制...")
|
||||||
|
|
||||||
|
# 快速连续发送验证码请求
|
||||||
|
for i in range(3):
|
||||||
|
response = self.make_request('POST', '/auth/send-email-verification', {
|
||||||
|
'email': f'ratelimit{i}@example.com'
|
||||||
|
})
|
||||||
|
|
||||||
|
if response.get('status_code') == 429:
|
||||||
|
self.assert_response(
|
||||||
|
response,
|
||||||
|
expected_success=False,
|
||||||
|
test_name="频率限制触发"
|
||||||
|
)
|
||||||
|
break
|
||||||
|
|
||||||
|
time.sleep(0.1) # 短暂延迟
|
||||||
|
|
||||||
|
def run_all_tests(self):
|
||||||
|
"""运行所有测试"""
|
||||||
|
self.log("🚀 开始API接口测试...")
|
||||||
|
self.log(f"测试目标: {self.base_url}")
|
||||||
|
self.log(f"测试邮箱: {self.test_email}")
|
||||||
|
|
||||||
|
start_time = time.time()
|
||||||
|
|
||||||
|
try:
|
||||||
|
# 基础功能测试
|
||||||
|
self.test_app_status()
|
||||||
|
|
||||||
|
# 认证相关测试
|
||||||
|
self.test_send_verification_code()
|
||||||
|
self.test_user_register()
|
||||||
|
self.test_user_login()
|
||||||
|
|
||||||
|
# 管理员功能测试
|
||||||
|
self.test_admin_login()
|
||||||
|
self.test_admin_get_users()
|
||||||
|
self.test_user_status_management()
|
||||||
|
|
||||||
|
# 错误处理测试
|
||||||
|
self.test_error_cases()
|
||||||
|
|
||||||
|
# 安全功能测试
|
||||||
|
self.test_rate_limiting()
|
||||||
|
|
||||||
|
except KeyboardInterrupt:
|
||||||
|
self.log("测试被用户中断", "ERROR")
|
||||||
|
except Exception as e:
|
||||||
|
self.log(f"测试过程中发生异常: {str(e)}", "ERROR")
|
||||||
|
|
||||||
|
# 输出测试结果
|
||||||
|
end_time = time.time()
|
||||||
|
duration = end_time - start_time
|
||||||
|
|
||||||
|
print("\n" + "="*60)
|
||||||
|
print("📊 测试结果统计")
|
||||||
|
print("="*60)
|
||||||
|
print(f"总测试数: {self.stats['total']}")
|
||||||
|
print(f"通过数量: {self.stats['passed']}")
|
||||||
|
print(f"失败数量: {self.stats['failed']}")
|
||||||
|
print(f"成功率: {(self.stats['passed']/self.stats['total']*100):.1f}%" if self.stats['total'] > 0 else "0%")
|
||||||
|
print(f"测试耗时: {duration:.2f}秒")
|
||||||
|
|
||||||
|
if self.stats['errors']:
|
||||||
|
print("\n❌ 失败的测试:")
|
||||||
|
for error in self.stats['errors']:
|
||||||
|
print(f" {error}")
|
||||||
|
|
||||||
|
if self.stats['failed'] == 0:
|
||||||
|
print("\n🎉 所有测试通过！")
|
||||||
|
return True
|
||||||
|
else:
|
||||||
|
print(f"\n⚠️ 有 {self.stats['failed']} 个测试失败")
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
"""主函数"""
|
||||||
|
parser = argparse.ArgumentParser(description='whaleTown API接口测试工具')
|
||||||
|
parser.add_argument('--base-url', default='https://whaletownend.xinghangee.icu',
|
||||||
|
help='API服务器地址 (默认: https://whaletownend.xinghangee.icu)')
|
||||||
|
parser.add_argument('--test-email', default='test@example.com',
|
||||||
|
help='测试邮箱地址 (默认: test@example.com)')
|
||||||
|
parser.add_argument('--verbose', '-v', action='store_true',
|
||||||
|
help='显示详细日志')
|
||||||
|
|
||||||
|
args = parser.parse_args()
|
||||||
|
|
||||||
|
# 创建测试器并运行测试
|
||||||
|
tester = APITester(
|
||||||
|
base_url=args.base_url,
|
||||||
|
test_email=args.test_email,
|
||||||
|
verbose=args.verbose
|
||||||
|
)
|
||||||
|
|
||||||
|
success = tester.run_all_tests()
|
||||||
|
|
||||||
|
# 根据测试结果设置退出码
|
||||||
|
sys.exit(0 if success else 1)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == '__main__':
|
||||||
|
main()
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user