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