ggj26_heron/AGENTS.md

AGENTS.md

本文档为 AI 编码助手提供项目上下文。

项目概述

ggj26_heron 是一个 Global Game Jam 2026 的 2D 动作游戏项目，使用 Unreal Engine 5.7 开发。

技术栈

• Unreal Engine 5.7
• PaperZD - 2D 动画插件
• Enhanced Input System - UE5 输入系统

项目结构

Source/ggj26_heron/
├── ggj26_heron.h          # 模块头文件
├── ggj26_heron.cpp        # 模块实现
└── ggj26_heron.Build.cs   # 构建配置

Content/
├── Sprites/               # 2D 精灵资源
├── PaperZD/              # 动画蓝图和序列
├── Input/                # 输入配置
└── NewMap.umap           # 主关卡

编码规范

• 遵循 Unreal Engine 编码标准
• 类名使用 A (Actor)、U (UObject)、F (结构体) 等 UE 前缀
• 使用 Enhanced Input System 处理输入，不要使用旧的输入系统
• 2D 动画使用 PaperZD 框架

构建和运行

本项目需要 Unreal Engine 5.7。

Clangd 配置

开发前需生成编译数据库以启用代码补全：

# Mac / Linux
./setup_clangd.sh <引擎路径>

# Windows PowerShell
.\setup_clangd.ps1 <引擎路径>