diff --git a/README.md b/README.md index 10e06ff..2afdc17 100644 --- a/README.md +++ b/README.md @@ -24,14 +24,18 @@ # 🔧 Configuration -The configuration is meant to be used by modpack developers, hence no in-game (client-side) settings are available. +The configuration is meant to be used by modpack developers, hence no in-game (client-side) settings are available. It is a server-side only configuration, can be found at `config/dungeon_difficulty_v2.json`. -Server side configuration can be found at `config/dungeon_difficulty.json`. +Regex fields in the configuration are interpreted as fully featured regex. If you are unfamiliar with regex, first make sure to learn about it (start for example [here](https://www.youtube.com/watch?v=sXQxhojSdZM)). It is recommended to test out your regex patterns using tool: [regex101.com](https://regex101.com) -Use the following command to refresh the config while in game: `/dungeon_difficulty_config_reload` +Editing the config usually involves the steps below: +1. Open the config file +2. Set `allow_customization` to `true`, so your config doesn't get overridden with defaults at launch +3. Define difficulty types (in `difficulty_types` array), which describe scaling of entities of looted items +4. Assign difficulty to locations referencing a difficulty type by its name, and an arbitrary level. These can be dimension by regex, biomes by regex and structures by specific structure ID. -Config file is parsed into `Config` object. You can find it [here](./src/main/java/net/dungeon_difficulty/config/Config.java). +Check out the default configuration to see specific examples. -Config file is **sanitized** upon reloading, meaning every non parsable data is removed. +Config file is parsed into `Config` object. You can find it [here](./src/main/java/net/dungeon_difficulty/config/Config.java). Config file is **sanitized** upon reloading, meaning every non-parsable data is removed. -Regex fields in the configuration are interpreted as fully featured regex. Suggested regex testing tool: [regex101.com](https://regex101.com) \ No newline at end of file +Use the following command to refresh the config while in game: `/dungeon_difficulty_config_reload` \ No newline at end of file