Skip to content

Configuration File

JellySquid edited this page Oct 3, 2024 · 2 revisions

Sodium makes use of multiple configuration files, each of which is described below. For the most part, it should not be necessary to modify any of these files.

sodium-options.json

This file stores all the configuration options which are normally accessible from the in-game settings. There is really no reason to edit this file by hand, unless you are experiencing crashes due to incompatible options being configured.

The file will be regenerated with default settings at the next game's launch if deleted.

sodium-mixins.properties

This file is used to control the patches ("mixins") that Sodium applies to the game at runtime. For the most part, this is only intended for debugging and other advanced use cases. For some situations, it can be used to resolve mod compatibility issues, but often it requires advanced skills to understand what patches are conflicting, and it may not always be possible to disable the conflicting patches.

Right now, we do not provide documentation for which patches can be configured, but you can look at the source code to see how the patches are grouped together. The configuration file makes use of the Java properties format and does not have any special syntax.

To add an override to the configuration file, specify the package of the mixin class like so, with a value of true (to force-enable it) or false (to force-disable it).

For example, to disable the features.render.world.clouds package (which includes the set of patches used to replace the rendering of the sky's clouds), specify it like so:

mixin.features.render.world.clouds=false

Please note: This really is only intended for advanced users, and many patches either have dependencies between each other, or otherwise are required for the base mod to work correctly.

sodium-fingerprint.json

The fingerprint file stores information about the user's installation of the mod, and is used to identify when configuration files have been copied to another computer. This allows for certain options which shouldn't be transferred between computers to be reset in a reliable manner, and avoids common situations where modpacks accidentally disable things like our messages asking the user for financial support.

If you are a modpack author, you may not want to include this file (as it will immediately be regenerated when copied to a different computer), but it will do no harm.