# AGENTS.md

Godot Engine – Multi-platform 2D and 3D game engine

## Setup

```
# TODO: the install command. No lockfile was found, so this could not be inferred.
```

## Commands

```
ruff check .   # lint
```

## Layout

- `thirdparty/` 4264 source files
- `modules/`    1288 source files
- `scene/`      686 source files
- `editor/`     633 source files
- `platform/`   598 source files
- `core/`       425 source files

## Conventions

- Tests live alongside the code they cover, following `modules/csg/tests/test_csg.h`.
- CI defines what passing means. See `.github/workflows/android_builds.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `thirdparty/vulkan/include/vulkan/vulkan_structs.hpp` is 7076KB. It will not fit comfortably in context, so read it in parts.
- No lockfile is committed, so an install here may not match what CI produced.

---

Drafted by agentreadme.com from what is in this repository. Everything marked TODO
needs a human. Check it in as AGENTS.md at the root.