Skip to main content

AI Agent Skills

Important Attention Reminder

Coding Style wiki​

Basic Instructions​

OxGKit supports development assisted by AI coding agents (Claude Code, OpenAI Codex CLI, Cursor, Copilot, etc.). Every system module ships a built-in "AI Agent Skills" sample — an Agent Skill (a SKILL.md entry file: YAML frontmatter + instructions) that teaches the agent how to use that module's API, coding style, and common pitfalls. API usage is verified against the source of that package version.

Attention All modules share the same skill folder/name oxgkit-unity-skill, while the content is module-specific (so each module can ship one independently). If your project uses several OxGKit modules, merge them into ONE skill (see Merging skills from multiple modules).

Import & Install​

  1. Import through Package Manager -> select an OxGKit module -> Samples -> AI Agent Skills. The files are copied to Assets/Samples/OxGKit.[ModuleName]/<version>/AI Agent Skills/.
  2. Copy (or symlink) the oxgkit-unity-skill folder to wherever your AI agent discovers skills:
AgentLocation
Claude Code<project>/.claude/skills/oxgkit-unity-skill/ (or ~/.claude/skills/ for all projects)
OpenAI Codex CLI<project>/.agents/skills/oxgkit-unity-skill/ (or ~/.codex/skills/)
Other agents (Cursor, Copilot, etc.)Reference the folder from your agent context file (AGENTS.md, CLAUDE.md, .cursorrules, ...), e.g. "Read oxgkit-unity-skill/SKILL.md before working with OxGKit.ActionSystem APIs."

Attention The skill must live in the skills directory for the agent to discover it automatically and trigger it when the task is relevant (loaded on demand — no need to mention it every conversation). If it only stays under Assets/Samples/, the agent will not know it exists, and that path contains a version number that breaks after upgrades.

Reminder Committing the skills directory to version control is recommended so the whole team benefits automatically.

  1. After copying, you may delete the imported copy under Assets/Samples/ (the skill files are plain Markdown and don't need to live inside the Unity project; keeping them is harmless — they import as TextAssets).

Merging Skills from Multiple Modules​

All OxGKit module skills share the folder/skill name oxgkit-unity-skill. If your project uses several modules, merge them into ONE skill folder:

  1. Keep a single SKILL.md frontmatter block (name: oxgkit-unity-skill, with a combined description: covering the systems you use).
  2. Concatenate the bodies — each module's body starts at its own # OxGKit.[ModuleName] Unity Skill heading, so bodies can be appended as-is.
.claude/skills/oxgkit-unity-skill/
└── SKILL.md   <- single frontmatter + concatenated module bodies

Notes​

Reminder The skill content is written in English (readable by agents in any locale; replies follow your language). API signatures are verified per package version, and the skill also instructs the agent to re-verify against the installed package source when in doubt.

Attention The OxGFrame framework provides its own oxgframe-unity-skill separately — both can coexist in the skills directory.