-
Notifications
You must be signed in to change notification settings - Fork 1
Configuration
Chunksmith has three config files. Which ones you have depends on what you are running.
| File | Who writes it | Covered by |
|---|---|---|
config/chunksmith/config.json |
the mod, on a server or in single-player | Server settings |
plugins/Chunksmith/config.yml |
the Paper/Spigot plugin | Server settings |
config/chunksmith-lod.properties |
the client, on the player's machine | Client LOD settings |
The first two hold the same settings under two spellings. The mod uses camelCase
(lodBackchannelPort); the plugin uses kebab-case (lod-backchannel-port). Both pages
below list both names for every key.
Note the mod's path is a directory: config/chunksmith/config.json, not
config/chunksmith.json.
Everything can also be set in-game. Every setting in every file has a command that
changes it -- /cs set <name> <value> for the server files, /cslod set <name> <value>
for the client one. That is a deliberate rule, not a coincidence: a setting you can only
change by editing a file and restarting is not a setting you can use on a running server.
The command applies the value immediately and rewrites the file, so the two can never
drift apart.
Editing by hand works too. The file is read at startup, and /cs reload re-reads it
without a restart.
Values are checked on the way in and on the way out. If a file holds a number outside a setting's range, Chunksmith uses the documented default and says so in the log rather than silently honouring something it will not actually do. The file is what you inspect when something is wrong, so it must never claim to be in force when it is not.
A missing key is not an error. Anything absent falls back to its default.
An existing config file is never rewritten to add new keys. When you upgrade Chunksmith, keys added in the new version do not appear in your file -- they are simply absent, and the new defaults apply. This is on purpose: rewriting your file behind your back would reformat it, drop your comments, and reorder your settings.
So if you want to see a new setting in your file, either run its /cs set command once
(which writes the whole file), or delete the file and let Chunksmith regenerate it. Both
pages below say which release each key arrived in.