Add claude md

[JiepengTan]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello @JiepengTan, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces a new CLAUDE.md file, which serves as a comprehensive guide for AI assistants like Claude Code when interacting with the spx project. This document details the project's architecture, build processes, core modules/spx/ functionalities (including a manager-based system, FFI, and sprite types), and critical aspects like the SpxLayerSorter system. It also provides practical guidance on common development tasks, debugging segfaults, memory management, and testing procedures, aiming to streamline AI-assisted development within the spx Godot Engine fork.

Highlights

• New AI Guidance Document: Introduced CLAUDE.md, a comprehensive guide specifically designed for AI assistants like Claude Code to understand and interact with the spx project's codebase.
• Project Architecture Overview: Detailed the spx project as a customized Godot Engine fork, emphasizing the modules/spx/ directory as the core integration layer with a manager-based system for functionality.
• Build Process and Commands: Provided SCons build commands for various platforms and targets, including common optimization flags, to compile the Godot Engine with the spx module enabled.
• Core modules/spx/ Functionality: Explained key entry points, the manager-based architecture (e.g., SpxSpriteMgr, SpxPhysicMgr), FFI (Go ↔ C++) communication, callback systems, and the three distinct sprite types (SpxSprite, SpxRenderSprite, SpxStaticSprite).
• Critical Layer Sorting System: Documented the SpxLayerSorter system, which manages sprite render order for pseudo-3D depth sorting, highlighting common bug patterns (dangling pointers) and the crucial need to call reset() before sprite destruction.
• Development Workflow and Debugging: Outlined common development tasks such as adding new manager functionality or callbacks, provided steps for debugging segfaults, and detailed memory management rules within the Godot/spx context.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request introduces a CLAUDE.md file, which serves as a detailed guide for AI-assisted development within the repository. The document is comprehensive, covering project overview, build commands, architecture, common bug patterns, and development workflows. My review focuses on improving the clarity and reusability of this documentation by removing user-specific paths.

[gemini-code-assist]

The file path /Users/tjp/projects/spx is user-specific. To make this documentation applicable to all developers, it's better to use a placeholder.

Suggested change

	cd /Users/tjp/projects/spx # Root of spx project
	cd <path_to_spx_project> # Root of spx project

[gemini-code-assist]

This path is user-specific. It should be replaced with a generic placeholder to ensure the instructions are clear for any developer working on this project.

Suggested change

	cd /Users/tjp/projects/spx
	cd <path_to_spx_project>

[gemini-code-assist]

This is an absolute, user-specific path. It would be more robust to use a placeholder or a relative path from the project root.

Suggested change

	- Main spx project: `/Users/tjp/projects/spx/CLAUDE.md`
	- Main spx project: `<path_to_spx_project>/CLAUDE.md`