Add some documentation to default balance config files

Explained how non-default ones work in conjunction with the default balance files.
Provided some examples to make it easier to understand.

diff --git a/bal-wep-xonotic.cfg b/bal-wep-xonotic.cfg
index 347dc420d2c7e1fc9fa88c30b891920861ef7a5f..9a6bee493317df21f7d0c63700b3d1edf31e66e9 100644 (file)
--- a/bal-wep-xonotic.cfg
+++ b/bal-wep-xonotic.cfg
@@ -1,3 +1,10 @@
+// These are the default weapon-related balance config settings.
+// Settings are categorized by weapon.
+// Other default settings are in balance-xonotic.cfg, which executes this file.
+// Other wep balance configs like bal-wep-nexuiz25.cfg first execute this, then override some settings.
+// Therefore any changes made to the default balance here will affect all bal-wep-*.cfg files,
+// ... unless you override it in such files.
+
 // {{{ #1: Blaster
 set g_balance_blaster_primary_animtime 0.2
 set g_balance_blaster_primary_damage 20

diff --git a/balance-xonotic.cfg b/balance-xonotic.cfg
index 858a8a4f4fa7df6da6aedb5c3ec1083116e513c8..0983fe905c2299a303d0a5946e4b6e06b5c1f563 100644 (file)
--- a/balance-xonotic.cfg
+++ b/balance-xonotic.cfg
@@ -1,3 +1,12 @@
+// These are the default balance config settings, excluding weapon-related settings.
+// The default weapon-related settings are in bal-wep-xonotic.cfg.
+// Other balance configs like balance-overkill.cfg first execute this, then override some settings.
+// Therefore any changes made to the default balance here will affect all balance-*.cfg files,
+// ... unless you override it in such files.
+// Generally balance config files execute their wep balance config file, if one exists.
+// The name of the current balance set is stored in g_mod_balance, which is read by some parts of the code,
+// ... e.g. the Overkill mutator can only be enabled if g_mod_balance is Overkill.
+
 g_mod_balance Xonotic
 testing_disable