Package net.mezzdev.config.api.migration

@NullMarked package net.mezzdev.config.api.migration

Import settings and persistent sort orders from files that a mod used before adopting MezzConfig.

Declare the destination values, then register the old file locations and a parser on the schema builder:

 IConfigRegistration registration = Configs.forMod("example");
 IConfigSchemaBuilder schema = registration.createClientSchemaBuilder("example.ini", "config.example");
 IConfigValue<Boolean> enabled = schema.addCategory("general")
     .addBoolean("enabled", true)
     .build();

 schema.setLegacyMigration(List.of(oldConfigPath), (path, migration) -> {
     List<String> oldLines = Files.readAllLines(path);
     migration.set(enabled, oldLines.contains("enabled=true"));
 });
 schema.build();
 

The parser only needs to understand the old format. MezzConfig backs up the source, validates all migrated values, and writes its current format without exposing that format to the mod.

To load a MezzConfig file from an older location, use IConfigSchemaBuilder.setLegacySources(List). To rename, move, or convert a value while importing that legacy source, use the legacy methods on IConfigValueBuilder.

Related Packages

Package	Description
net.mezzdev.config.api	Register and discover configs managed by MezzConfig.
net.mezzdev.config.api.schema	Inspect and atomically update config schemas.
net.mezzdev.config.api.sorting	Persist user-defined ordering for values that a mod discovers at runtime.
net.mezzdev.config.api.value	Read and update individual config values.

Class	Description
ConfigMigrationStatus	Describes the outcome of a registered legacy config migration.
IConfigMigrationContext	Imports converted legacy settings without exposing MezzConfig's file format.
IConfigMigrationResult	Reports the final outcome of a registered legacy migration.
IConfigMigrator	Imports a config file from the format a mod used before adopting MezzConfig.
ISortingConfigMigrationContext<T>	Supplies a converted legacy order to a sorting config.
ISortingConfigMigrator<T>	Imports a saved order from the format a mod used before adopting a MezzConfig sorting config.