Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ZsoltMolnarrr committed Jul 17, 2023
1 parent 11daa2b commit b1230c7
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Use the following command to refresh the config while in game: `/dungeon_difficulty_config_reload`

0 comments on commit b1230c7

Please sign in to comment.