Merge remote-tracking branch 'origin/community' into community

docs/game-world-settings.md

@@ -1,81 +1,76 @@
 # Game World Settings
 
-The parameters of the world can be easily altered using the configuration file located within `config.ini`.
+The parameters of the world can be easily altered using the configuration file located within `config.maps.json`, which is built on server initialization.
+
+For older configs, it will be migrated from `config.ini` automatically.
 
 ## Configuration
 
-The parameters specified in the `config.ini` file will be saved to the server folder, overwriting the default settings. For example, all values below use their default settings.
+The parameters specified in the `config.mods.json` file will be created on the server folder, migrating from config.ini, to overwrite the default settings. For example, all values below use their default settings.
 
-```ini
+The default configuration can be found at [config.mods.json](https://github.com/blizzless/blizzless-diiis/blob/community/configs/config.mods.json)
-[Game-Server]
-; rates
-RateExp = 1
-RateMoney = 1
-RateDrop = 1
-RateChangeDrop = 1
-RateMonsterHP = 1
-RateMonsterDMG = 1
-; items
-ChanceHighQualityUnidentified = 30
-ChanceNormalUnidentified = 5
-; bosses
-BossHealthMultiplier = 6
-BossDamageMultiplier = 3
-; nephalem
-NephalemRiftProgressMultiplier = 1
-NephalemRiftAutoFinish = false
-NephalemRiftAutoFinishThreshold = 2
-NephalemRiftOrbsChance = 0
-; health
-HealthPotionRestorePercentage = 60
-HealthPotionCooldown = 30
-ResurrectionCharges = 3
-; waypoints
-UnlockAllWaypoints = false
-; player attribute modifier
-StrengthMultiplier = 1
-StrengthParagonMultiplier = 1
-DexterityMultiplier = 1
-DexterityParagonMultiplier = 1
-IntelligenceMultiplier = 1
-IntelligenceParagonMultiplier = 1
-VitalityMultiplier = 1
-VitalityParagonMultiplier = 1
-; quests
-AutoSaveQuests = false
-; minimap
-ForceMinimapVisibility = false
-```
 
 ## Description
 
-| Key              | Description               |
+```json
-| ---------------- | ------------------------- |
+{
-| `RateExp`        | Experience multiplier     |
+  "Rate": {
-| `RateMoney`      | Currency multiplier       |
+    "Experience": 1.0, // Experience Rate
-| `RateDrop`       | Drop quantity multiplier  |
+    "Money": 1.0, // money rate
-| `RateChangeDrop` | Drop quality multiplier   |
+    "Drop": 1.0, // drop rate
-| `RateMonsterHP`  | Monsters HP multiplier    |
+    "ChangeDrop": 1.0 // change drop rate
-| `RateMonsterDMG` | Monster damage multiplier |
+  },
-| `ChanceHighQualityUnidentified` | Percentage that a unique, legendary, set or special item created is unidentified |
+  "Health": {
-| `ChanceNormalUnidentified` | Percentage that normal item created is unidentified |
+    "PotionRestorePercentage": 60.0, // how many in percent will a potion restore
-| `ResurrectionCharges` | Amount of times user can resurrect at corpse |
+    "PotionCooldown": 30.0, // how many seconds for a full potion recharge
-| `BossHealthMultiplier` | Boss Health Multiplier |
+    "ResurrectionCharges": 3 // how many times can you revive at corpse
-| `BossDamageMultiplier` | Boss Damage Multiplier |
+  },
-| `HealthPotionRestorePercentage` | How much (from 1-100) a health potion will heal. |
+  "Monster": {
-| `HealthPotionCooldown` | How much (in seconds) to use a health potion again. |
+    "HealthMultiplier": 1.0, // monster health multiplier
-| `UnlockAllWaypoints` | Unlocks all waypoints in campaign |
+    "DamageMultiplier": 1.0 // monster damage multiplier
-| `StrengthMultiplier` | Player's strength multiplier |
+  },
-| `StrengthParagonMultiplier` | Player's strength multiplier **for paragons** |
+  "Boss": {
-| `DexterityMultiplier` | Player's dexterity multiplier |
+    "HealthMultiplier": 6.0, // boss health multiplier
-| `DexterityParagonMultiplier` | Player's dexterity multiplier **for paragons** |
+    "DamageMultiplier": 3.0 // boss damage multiplier
-| `IntelligenceMultiplier` | Player's intelligence multiplier |
+  },
-| `IntelligenceParagonMultiplier` | Player's intelligence multiplier **for paragons** |
+  "Quest": {
-| `VitalityMultiplier` | Player's vitality multiplier |
+    "AutoSave": false, // auto save at every quest
-| `VitalityParagonMultiplier` | Player's vitality multiplier **for paragons** |
+    "UnlockAllWaypoints": false // unlocks all waypoints in-game
-| `AutoSaveQuests` *in tests* | Force Save Quests/Step, even if Act's quest setup marked as Saveable = FALSE. Doesn't apply to OpenWorld games. |
+  },
-| `NephalemRiftProgressMultiplier` | Nephalem Rift Progress Modifier |
+  "Player": {
-| `NephalemRiftAutoFinish` | Nephalem Auto-Finish when there's still `NephalemRiftAutoFinishThreshold` monsters or less are alive on the rift |
+    "Multipliers": { // multipliers for the player (e.g. a paragon might need twice these values for fairer gameplay)
-| `NephalemRiftAutoFinishThreshold` | Nephalem Rift Progress Modifier |
+      "Strength": {
-| `NephalemRiftOrbsChance` | Nephalem Rifts chance of spawning a orb. |
+        "Normal": 1.0,
-| `ForceMinimapVisibility` | Forces the minimap visibility |
+        "Paragon": 1.0
+      },
+      "Dexterity": {
+        "Normal": 1.0,
+        "Paragon": 1.0
+      },
+      "Intelligence": {
+        "Normal": 1.0,
+        "Paragon": 1.0
+      },
+      "Vitality": {
+        "Normal": 1.0,
+        "Paragon": 1.0
+      }
+    }
+  },
+  "Items": {
+    "UnidentifiedDropChances": { // chances in % of a dropped item to be unidentified
+      "HighQuality": 30.0,
+      "NormalQuality": 5.0
+    }
+  },
+  "Minimap": {
+    "ForceVisibility": false // forces in-game minimap to be always visible
+  },
+  "NephalemRift": { // improves overall nephalem rift experience
+    "ProgressMultiplier": 1.0,
+    "AutoFinish": false,
+    "AutoFinishThreshold": 2,
+    "OrbsChance": 2.0 // chances of spawning an orb
+  }
+}
+```