Skip to content

Latest commit

 

History

3 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Unity AI Instructions

AI coding standards for Unity 6 projects, as used at Bitforge. Two files you drop into a Unity project so Claude Code (or any agent that reads CLAUDE.md) writes C# the way the rest of the team does.

  • CLAUDE.md — the entry point. Loaded automatically every session: the critical rules digest, tooling, and pointers to the other two files.
  • AI_GUIDE.md — the architecture guide. Naming and formatting, the manager/event tiers, singletons, Awaitable, additive scenes, localization, performance, the build wizard, testable editor logic, and Unity-specific git rules.
  • PROJECT_GUIDE.template.md — a skeleton for the third, optional file: whatever is true of your project only.

Install

Say this to Claude Code, in your Unity project:

Copy the two standards files from https://github.com/bitforge/unity-ai-instructions into this project: CLAUDE.md at the root, AI_GUIDE.md into .ai/. Then create PROJECT_GUIDE.md from PROJECT_GUIDE.template.md and fill it in for this project.

That's it. Commit all three.

Updating later is the same sentence, minus the last part:

Re-copy CLAUDE.md and AI_GUIDE.md from https://github.com/bitforge/unity-ai-instructions, leave my PROJECT_GUIDE.md alone.

Why three files

File Scope Who owns it
CLAUDE.md generic Unity this repo — replace on update
.ai/AI_GUIDE.md generic Unity this repo — replace on update
PROJECT_GUIDE.md one project you — never overwritten

The first two are meant to be thrown away and re-copied, so everything specific to a project belongs in PROJECT_GUIDE.md: the target device, the domain contract, release steps, what is deliberately out of scope. Put a project detail in the other two and the next update loses it.

CLAUDE.md tells the agent to read AI_GUIDE.md first, then PROJECT_GUIDE.md if it exists, and that the project file wins where the two disagree.

Contributing back

Before adding a rule, ask whether it is true of every Unity project you would apply this to. If it is only true of one, it belongs in that project's PROJECT_GUIDE.md.

A rule nobody follows is worse than no rule — an agent will cite it while the codebase contradicts it. When a convention changes in practice, change it here too.

License

MIT. Take it, fork it, rewrite the rules you disagree with.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors