Conversation
There was a problem hiding this comment.
Pull request overview
Adds a new top-level CLAUDE.md to provide coding agents and new developers with a concise orientation to the Carbon Trinity rendering engine repo, including layout, build workflows, Python/Blue exposure considerations, and common “gotchas”.
Changes:
- Introduces
CLAUDE.mdwith repository structure and naming conventions. - Documents recommended build presets/targets and common build “tripwires”.
- Describes the Blue exposure layer and practical verification expectations.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
CCP-Aporia
left a comment
CCP-Aporia
left a comment
There was a problem hiding this comment.
Interesting to see what others are putting into their CLAUDE.md files. 😄
Aside from the inline comments, there are two things that stand out to me:
- It might be beneficial to simply use
@AGENTS.mdin here, and move the contents otherwise intoAGENTS.md. That way, other AI agents than Claude can benefit from these instructions. - The build instructions should probably be a skill instead.
|
|
||
| Match the style of nearby `_Blue.cpp` files when adding entries. | ||
|
|
||
| ## Reaching the game |
There was a problem hiding this comment.
While I'm aware that there's still a lot of reliance on any game branch, I would refrain from tying the component even closer to a branch. That's only going to increase the work when the eventual decoupling has to happen. After all, people outside Fenris Creations don't have access to these branches, but they may well use Claude. 🙂
| backend; if your dx targets are missing, this is why. | ||
| - The Windows generator is Visual Studio (multi-config). `--config` is mandatory on every build | ||
| and must match the preset's flavor, or you silently build the wrong configuration. | ||
| - CMake writes status messages and warnings to stderr. PowerShell 5.1 with |
There was a problem hiding this comment.
CMake writes most message categories to stderr, but STATUS messages are not part of those. As per documentation:
The CMake command-line tool displays STATUS to TRACE messages on stdout with the message preceded by two hyphens and a space. All other message types are sent to stderr and are not prefixed with hyphens.
|
|
||
| Carbon Trinity: Fenris Creations' rendering engine for the Carbon game engine. C++, built per graphics | ||
| API as Python extension modules named `_trinity_<api>[_<flavor>]` (for example | ||
| `_trinity_dx12_trinitydev`; on Windows the extension suffix is `.pyd`, while on macOS/Linux it's typically `.so`). The engine is scripted from Python through the "Blue" exposure |
There was a problem hiding this comment.
I think it's good to differentiate between blue and blue-exposure and point Claude at the relevant component, e.g. something along the lines of:
"The engine's functionality is exposed to Python using blue-exposure".
The motivation here is that blue potentially adds a lot of stuff to the agent's context window that is not truly relevant to the exposure part.
I think this is a minimum required for the agents to read and understand the engine better but it can be hard to tell if this is a net positive