Update gmc-cfg.md

Added note on comments being removed by Godot editor
missionpinball · Jan 22, 2025 · 8a49c35 · 8a49c35
1 parent 2cf8fc5
commit 8a49c35
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/docs/gmc/reference/gmc-cfg.md b/docs/gmc/reference/gmc-cfg.md
@@ -6,6 +6,10 @@ title: GMC Configuration File
 
 The *gmc.cfg* configuration file in your Godot project root contains options for customizing GMC behavior. It uses INI formatting and its supported features are documented here.
 
+!!! note
+
+    Currently the Godot engine will remove comments from this file when it chooses to rewrite it.
+
 ### Local Overrides
 
 Any configuration options in *gmc.cfg* can be overridden with a local file *gmc.local.cfg* in the Godot User Data folder. This allows you to commit the primary configuration to version control while still having platform-specific configurations (e.g. MPF executable path and logging levels) on each machine.