SuperAPI AI 工具集

project-foundations

编程与开发

查看项目

更新于 10-16 23:43

技能介绍

用途

Project Foundations 是面向 Godot 4 项目的组织规范与脚手架技能,目标是在项目初期建立一致的目录结构、命名约定和版本控制习惯,降低随着场景增长带来的维护与协作成本。

主要能力

技能包含四个可用脚本:

  • project_bootstrapper.gd:新项目启动前必读,自动生成功能文件夹与 .gitignore。
  • scene_naming_validator.gd:扫描整个项目,检测 snake_case / PascalCase 命名违规,建议在提交 PR 前运行。
  • dependency_auditor.gd:检测循环场景依赖与耦合问题,面向超过 50 个场景的项目。资料提示:除非排查加载错误或审计大型项目,否则不要加载该脚本。
  • feature_scaffolder.gd:生成完整的功能文件夹,包含基础场景、脚本与子目录。

组织原则

采用按功能(What)分组,而不是按文件类型(How)分组。推荐结构示例:

/project.godot
/common/           # 全局资源、主题、共享脚本
/entities/
    /player/       # 与玩家相关的全部内容
        player.tscn
        player.gd
        player_sprite.png
    /enemy/
/ui/
    /main_menu/
/levels/
/addons/           # 第三方插件

命名约定

  • 文件与文件夹:统一使用 snake_case,例如 player_controller.gd、main_menu.tscn。例外:C# 脚本使用 PascalCase 以匹配类名。
  • 节点名:统一使用 PascalCase,例如 PlayerSprite、CollisionShape2D。
  • 唯一名称:高频访问的节点使用 %SceneUniqueNames,避免脆弱的 get_node() 路径。

版本控制

  • 始终包含面向 Godot 的 .gitignore,忽略 .godot/ 目录与导入产物。
  • 在 Godot 不应扫描或导入的文件夹中使用 .gdignore,例如原始设计源文件。

使用方式:搭建新项目

当被要求“Setup a project”或“Start a new game”时:

  1. 初始化根目录:确保 project.godot 存在。
  2. 创建核心文件夹:entities/、ui/、levels/、common/。
  3. 配置 Git:创建完整的 .gitignore。
  4. 文档:创建 README.md,说明基于功能的结构。

明确禁止事项

  • 绝不按文件类型分组,例如 /scripts、/sprites、/sounds。
  • 绝不在同项目混用 snake_case 与 PascalCase 文件名,官方标准是文件 snake_case、节点 PascalCase。
  • 绝不遗漏 .gitignore,提交 .godot/ 会造成 100MB+ 体积膨胀与合并冲突。
  • 绝不使用硬编码 get_node() 路径,例如 get_node("../../../Player/Sprite2D"),场景重新挂载父节点时会失效。
  • 绝不为原始素材跳过 .gdignore,放在项目根目录的 .psd、.blend 等设计源文件会被 Godot 导入。

适用场景与限制

适用于 Godot 4 新项目的工程初始化、命名规范检查与大型项目的依赖审计。参考资料仅涉及 Godot 4 与上述脚本行为;关于收费、价格、平台支持或效果保证等信息,资料暂未提供。