Add CVar system

Kevin Trogant 2024-07-31 21:34:40 +02:00
parent 7594cbd756
commit 714e38aa1c

15
CVar-system.md Normal file

@ -0,0 +1,15 @@
The engine provides a CVar (configuration variable) system in <runtime/config.h>, that is used heavily in the engine to configure its various features.
**TODO: In depth description**
## CVar naming convention
CVar names follow the pattern "systemCode_NameInPascalCase".
The system code is one of:
| System | Code | Example |
|---------|------|----------|
| runtime | rt | rt_AsssetEnabled |
| renderer | r | r_MaxRenderResources |
| launcher | l | l_WindowTitle |