-
-
Notifications
You must be signed in to change notification settings - Fork 44
Expand file tree
/
Copy pathCLAUDE.md.example
More file actions
22 lines (14 loc) · 1.18 KB
/
Copy pathCLAUDE.md.example
File metadata and controls
22 lines (14 loc) · 1.18 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
## Project Overview
Overthrow is a dynamic and persistent revolution mod for Arma Reforger. It's built using EnforceScript and the Enfusion engine's entity-component-based architecture.
## Coding Conventions
- **Class prefix:** `OVT_`
- **Member variables:** `m_` prefix
- **Type prefixes:** `m_i` (int), `m_f` (float), `m_s` (string), `m_b` (bool), `m_a` (array), `m_m` (map)
- **Static instances:** `s_Instance`
- **Documentation:** Doxygen style with `//!` comments
**For complete coding standards, activate the `overthrow-architecture` skill.**
## Code Style
- **Keep comments sparse.** Do not write long essay-style comment blocks — no rationale narratives, bug forensics, investigation history, or "why this is correct" arguments in code (recent code has been up to 3/4 comments by volume). Comment only what the code cannot say: a non-obvious constraint, a trap, or load-bearing ordering — and keep it to a line or two. Detailed reasoning belongs in `docs/bugs/` and the feature docs under `docs/features/`, not in comments.
### Arma Reforger
- All base game scripts, configs and UI layouts: `/mnt/n/Projects/Arma 4/ArmaReforger`
- Reference for understanding game mechanics and mod patterns