Files
whale-town-front/docs/01-项目入门/README.md
moyin a85a7b4d0e docs: 完善项目入门README,强调输入映射配置的重要性
发现的关键问题:
- 项目代码中使用了输入映射,但project.godot中未配置
- 缺少输入映射会导致游戏无法正常运行

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

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

 确保新人成功:
- 明确标注必需步骤的优先级
- 提供具体的错误解决方案
- 强调验证配置的重要性
2025-12-31 18:17:58 +08:00

2.3 KiB
Raw Blame History

📖 项目入门

适用人群: 新加入项目的开发者
使用时机: 项目开始前,环境搭建阶段

这个目录包含了新人入门必读的基础文档,帮助你快速了解项目并搭建开发环境。

📋 阅读顺序

第一步:了解项目 🏗️

项目结构说明.md

  • 项目整体架构设计
  • 目录组织规则
  • 各层级职责说明
  • 团队协作方式

第二步:配置环境 ⚙️

项目设置指南.md

  • Godot编辑器配置
  • AutoLoad单例设置
  • 开发环境验证

第三步:设置控制 🎮 [必需]

输入映射配置.md

  • 游戏输入控制配置
  • 键盘和手柄映射
  • 输入系统测试

⚠️ 重要提醒: 输入映射配置是必需的!项目代码中使用了 move_leftmove_rightmove_upmove_downinteractpause 等输入动作必须在Godot编辑器中正确配置否则游戏无法正常运行。

完成检查

阅读完本目录的文档后,你应该能够:

  • 理解项目的整体架构
  • 成功配置Godot开发环境
  • 正确设置游戏输入映射 ⚠️ 必需
  • 运行项目并进行基本测试
  • 验证所有AutoLoad单例正常工作

🚨 常见启动问题

问题1: 游戏无法响应输入

原因: 输入映射未配置
解决: 必须完成 输入映射配置.md 中的所有步骤

问题2: 控制台出现"Invalid action"错误

原因: 缺少必需的输入动作
解决: 确保配置了以下6个输入动作

  • move_left, move_right, move_up, move_down
  • interact, pause

问题3: AutoLoad单例报错

原因: AutoLoad配置不正确
解决: 参考 项目设置指南.md 验证配置

🔗 下一步

完成项目入门后,建议继续阅读:

💡 小贴士

  • 输入映射是第一优先级 - 不配置输入映射,游戏无法正常运行
  • 遇到问题时,先查看对应文档的"常见问题"部分
  • 建议在实际操作中边读边做,加深理解
  • 可以将重要的配置信息做笔记备用
  • 完成每个步骤后,建议运行项目验证配置是否正确