Docs

Core/PluginConfigHandler.cs

@@ -126,11 +126,12 @@ public void InitializeConfig()
             string section = "General";
 
             Entry(section, nameof(PluginConfig.DisableEnemyAI), false, v => PluginConfig.DisableEnemyAI = v);
+            Entry(section, nameof(PluginConfig.UnlockZoom), false, v => PluginConfig.UnlockZoom = v);
+            Entry(section, nameof(PluginConfig.TimeModifier), 1.0f, v => PluginConfig.TimeModifier = v);
             Entry(section, nameof(PluginConfig.RemoveMapObstacles), false, v => PluginConfig.RemoveMapObstacles = v);
             Entry(section, nameof(PluginConfig.SkillTreeCostMultiplier), 1.0f, v => PluginConfig.SkillTreeCostMultiplier = v);
             Entry(section, nameof(PluginConfig.CurseBonusMultiplier), 1.0f, v => PluginConfig.CurseBonusMultiplier = v);
             Entry(section, nameof(PluginConfig.CurseLevelStrengthMultiplier), 1.0f, v => PluginConfig.CurseLevelStrengthMultiplier = v);
-            Entry(section, nameof(PluginConfig.TimeModifier), 1.0f, v => PluginConfig.TimeModifier = v);
             Entry(section, nameof(PluginConfig.MinorSoulstoneMultiplier), 1.0f, v => PluginConfig.MinorSoulstoneMultiplier = v);
             Entry(section, nameof(PluginConfig.BossSoulstoneMultiplier), 1.0f, v => PluginConfig.BossSoulstoneMultiplier = v);
             Entry(section, nameof(PluginConfig.HealthPickupAmountMultiplier), 1.0f, v => PluginConfig.HealthPickupAmountMultiplier = v);
@@ -140,7 +141,6 @@ public void InitializeConfig()
             Entry(section, nameof(PluginConfig.SmallEnemyHealthMultiplier), 1.0f, v => PluginConfig.SmallEnemyHealthMultiplier = v);
             Entry(section, nameof(PluginConfig.EnemyObjectiveMultiplier), 1.0f, v => PluginConfig.EnemyObjectiveMultiplier = v);
             Entry(section, nameof(PluginConfig.ExtraMineralsSpawnDelay), -1.0f, v => PluginConfig.ExtraMineralsSpawnDelay = v);
-            Entry(section, nameof(PluginConfig.UnlockZoom), false, v => PluginConfig.UnlockZoom = v); 
             Entry(section, nameof(PluginConfig.AutoUnlockSpecialPortals), false, v => PluginConfig.AutoUnlockSpecialPortals = v); 
             Entry(section, nameof(PluginConfig.WeaponStrengthMultiplier), 1.0f, v => PluginConfig.WeaponStrengthMultiplier = v);
             Entry(section, nameof(PluginConfig.WeaponUnlockCostMultiplier), 1.0f, v => PluginConfig.WeaponUnlockCostMultiplier = v);

README.md

@@ -15,7 +15,51 @@ NOTE: Configs do not get applied while the game is running, changing the config
 
 ### Disable Enemy AI
 
-Config: `Disable_Enemy_A_I`
-When set to `true`, enemy AI is completely turned off. No attacks, no movement, just quietly waiting for their demise.
+|Config Entry|Default|Description|
+|:----:|:---:|:---:|
+|`Disable_Enemy_A_I`|`false`| When enabled, enemy AI is completely turned off. No attacks, no movement. |
 
-![DisableEnemyAI.gif](Img/DisableEnemyAI.gif)
+Note: Boss health bars do not properly disappear after their death if they have no AI.
+
+![DisableEnemyAI.gif](Img/DisableEnemyAI.gif)
+
+### Unlock Zoom
+
+|Config Entry|Default|Description|
+|:----:|:---:|:---:|
+|`Unlock_Zoom`|`false`| Allows you to zoom in / out using your scroll wheel |
+
+![UnlockZoom.png](Img/UnlockZoom.png)
+
+### Time Modifier
+
+|Config Entry|Default|Description|
+|:----:|:---:|:---:|
+|`Time_Modifier`|`1.0`| Modifies game speed (affects **everything**). E.g. `2.0` doubles it.|
+
+### Remove Map Obstacles
+
+|Config Entry|Default|Description|
+|:----:|:---:|:---:|
+|`Remove_Map_Obstacles`|`false`| Do you have trees? This option removes **ALL** obstacles from the map. Note: This may or may not work for future added maps.|
+
+![RemoveMapObstacles.png](Img/RemoveMapObstacles.png)
+
+### Skill Tree Cost Multiplier
+
+|Config Entry|Default|Description|
+|:----:|:---:|:---:|
+|`Skill_Tree_Cost_Multiplier`|`1.0`| Multiplier for all skill costs in the skill tree. Example: `2.0` doubles everything, `0` makes all skills free.|
+
+Examples with `1000` or `0`:
+
+<img src="Img/SkillTreeCostMultiplier1.png" width="250">
+<img src="Img/SkillTreeCostMultiplier2.png" width="250">
+
+### Curse Bonus Multiplier
+
+|Config Entry|Default|Description|
+|:----:|:---:|:---:|
+|`Curse_Bonus_Multiplier`|`1.0`| Multiplier for all curse level bonuses|
+
+<img src="Img/CurseBonusMultiplier.png" width="250">