From 714e38aa1c6f545b29f1480a790c8d07c1f565c8 Mon Sep 17 00:00:00 2001
From: Kevin Trogant <greenfoxlight.42@gmail.com>
Date: Wed, 31 Jul 2024 21:34:40 +0200
Subject: [PATCH] Add CVar system

---
 CVar-system.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
 create mode 100644 CVar-system.md

diff --git a/CVar-system.md b/CVar-system.md
new file mode 100644
index 0000000..9b848e1
--- /dev/null
+++ b/CVar-system.md
@@ -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 |