跳到主要内容
版本:v3

AI Agent Skills

重要 注意 提醒

Coding Style wiki


基本说明

OxGFrame 支持使用 AI 编码代理(Claude Code、OpenAI Codex CLI、Cursor、Copilot 等)辅助开发。框架内置「AI Agent Skills」示例——一份 Agent Skill(SKILL.md 入口 + 9 份经源码核实的 references/ 使用文档),教导 AI 代理正确使用 OxGFrame 各模块 API(AssetLoader 补丁与加载、CoreFrame UI/SR/US/CP、MediaFrame 影音、GSIFrame、NetFrame、CenterFrame、Hotfixer 热更)、编码风格与生产架构建议,并简要涵盖框架内部使用的 OxGKit API。

提醒 技能采用 Agent Skills 惯例格式(渐进式披露):代理先读取 SKILL.md,再按需加载 references/ 中需要的文档,不会一次占用大量上下文。

导入与安装

  1. 通过 Package Manager → OxGFrame → Samples → AI Agent Skills 导入,文件会复制到 Assets/Samples/OxGFrame/<version>/AI Agent Skills/
  2. oxgframe-unity-skill 文件夹复制(或建立符号链接)到你的 AI 代理读取技能的位置:
代理位置
Claude Code<project>/.claude/skills/oxgframe-unity-skill/(或 ~/.claude/skills/ 供所有项目共用)
OpenAI Codex CLI<project>/.agents/skills/oxgframe-unity-skill/(或 ~/.codex/skills/
其他代理(Cursor、Copilot 等)在代理的上下文文件(AGENTS.mdCLAUDE.md.cursorrules 等)引用该文件夹,例如:「使用 OxGFrame API 前先阅读 oxgframe-unity-skill/SKILL.md」。

注意 技能放入 skills 目录,代理才会自动发现,并在任务相关时自动触发(按需加载 references,无需每次对话提醒);若仅留在 Assets/Samples/ 内,代理不会知道它的存在,且该路径含版本号、升级后即失效。

提醒 建议将 skills 目录一并提交到版本控制,全团队即可自动生效。

  1. 复制完成后,Assets/Samples/ 下导入的副本可自行删除(技能文件为纯 Markdown,不需要留在 Unity 项目内;保留也无妨,会以 TextAsset 导入)。

搭配 OxGKit Skills

OxGFrame 内部使用了多个 OxGKit 工具 API(LoggingSystem、SaverSystem、TimeSystem、Utilities、ButtonSystem 等),本技能已简要涵盖;各 OxGKit 系统的完整独立 Skills 由 OxGKit 项目另行提供,可依需求一并安装。

备注

  • 技能内容以英文撰写(任何语系的代理皆可读取,回复会依你的语言)。
  • API 签名依 v3.7.0+ 核实;技能也会指示代理在有疑虑时,直接以安装的包源码再次核对。
  • references/source-map.md 列出了核实时所用的源码文件与查找指令。