Skip to content

Data and config

These types keep a mod’s state and settings: per-dimension saved data, values saved on single entities, handlers that rerun when data packs load, a strict JSON settings file, a settings screen for it, and a player guide copied to the config folder.

Type Summary Status Since Side Thread
ConfigFile A mod’s JSON settings file. Experimental 2.0.0 both any
ConfigKey One setting of a ConfigSpec. Experimental 2.0.0 both any
ConfigScreens Registers a mod’s config screen with the loader’s mod list. Experimental 2.0.0 client setup
ConfigSpec The keys of one config file, in the order the file lists them. Experimental 2.0.0 both any
ConfigValues One value for every key of a ConfigSpec. Experimental 2.0.0 both any
DataFile A file found by DataReloaders#registerFiles. Experimental 2.0.0 server any
DataReloaders Server data-pack reload handlers. Experimental 1.0.0 both setup
EntityData Small int values a mod stores on an entity under its own key, saved with the entity. Experimental 2.6.0 server server
PlayerGuide A player guide shipped inside a mod’s jar and copied to the config folder on each launch. Experimental 1.2.0 both setup
SettingsScreen A settings screen: a scrolling list of labeled toggles and number fields, with Done and Cancel. Experimental 1.2.0 client render
StopeSavedData Per-dimension saved data without the version-specific vanilla signature. Experimental 1.0.0 server server
UnsavedChangesScreen Asks whether to save a SettingsScreen’s changes before leaving it. Experimental 1.2.0 client render