[1.16.5] Creating a Config File

[Syric]

I'm attempting to add a config file to one of my mods. Currently, the code appears to be referencing the configured variables just fine, but the problem is the file itself: it's not printing all the variables and comments, and what it is printing is out of order.

My config is broken into three sections. Each has several 'groups', with each group governing one variable, and containing four copies of it: one for each of the four configurable items (basic, epic, legendary, and godly/mythic). For instance, in the "ping chance stats" section, there's a group for the "minPingChance" variable, with entries for basic_minPingChance, epic_minPingChance, and so on.

Here's my config file:

package syric.dragonseeker;

import net.minecraftforge.common.ForgeConfigSpec;
import org.apache.commons.lang3.tuple.Pair;

public class DragonseekerConfig {

    public static class Common {
        //Basic Dragonseeker
        public final ForgeConfigSpec.ConfigValue<Integer> basic_optimalDistance;
        public final ForgeConfigSpec.ConfigValue<Integer> basic_maxDistance;
        public final ForgeConfigSpec.ConfigValue<Double> basic_minPingChance;
        public final ForgeConfigSpec.ConfigValue<Double> basic_maxPingChance;

        public final ForgeConfigSpec.ConfigValue<Integer> basic_pingCapRadius;
        public final ForgeConfigSpec.ConfigValue<Double> basic_sigPower;
        public final ForgeConfigSpec.ConfigValue<Double> basic_minVol;
        public final ForgeConfigSpec.ConfigValue<Double> basic_maxVol;
        public final ForgeConfigSpec.ConfigValue<Double> basic_minPitch;
        public final ForgeConfigSpec.ConfigValue<Double> basic_maxPitch;

        public final ForgeConfigSpec.ConfigValue<Boolean> basic_detectsCorpses;
        public final ForgeConfigSpec.ConfigValue<Boolean> basic_detectsTame;
        public final ForgeConfigSpec.ConfigValue<Integer> basic_durability;


        //Epic Dragonseeker
        public final ForgeConfigSpec.ConfigValue<Integer> epic_optimalDistance;
        public final ForgeConfigSpec.ConfigValue<Integer> epic_maxDistance;
        public final ForgeConfigSpec.ConfigValue<Double> epic_minPingChance;
        public final ForgeConfigSpec.ConfigValue<Double> epic_maxPingChance;

        public final ForgeConfigSpec.ConfigValue<Integer> epic_pingCapRadius;
        public final ForgeConfigSpec.ConfigValue<Double> epic_sigPower;
        public final ForgeConfigSpec.ConfigValue<Double> epic_minVol;
        public final ForgeConfigSpec.ConfigValue<Double> epic_maxVol;
        public final ForgeConfigSpec.ConfigValue<Double> epic_minPitch;
        public final ForgeConfigSpec.ConfigValue<Double> epic_maxPitch;

        public final ForgeConfigSpec.ConfigValue<Boolean> epic_detectsCorpses;
        public final ForgeConfigSpec.ConfigValue<Boolean> epic_detectsTame;
        public final ForgeConfigSpec.ConfigValue<Integer> epic_durability;


        //Legendary Dragonseeker
        public final ForgeConfigSpec.ConfigValue<Integer> legendary_optimalDistance;
        public final ForgeConfigSpec.ConfigValue<Integer> legendary_maxDistance;
        public final ForgeConfigSpec.ConfigValue<Double> legendary_minPingChance;
        public final ForgeConfigSpec.ConfigValue<Double> legendary_maxPingChance;

        public final ForgeConfigSpec.ConfigValue<Integer> legendary_pingCapRadius;
        public final ForgeConfigSpec.ConfigValue<Double> legendary_sigPower;
        public final ForgeConfigSpec.ConfigValue<Double> legendary_minVol;
        public final ForgeConfigSpec.ConfigValue<Double> legendary_maxVol;
        public final ForgeConfigSpec.ConfigValue<Double> legendary_minPitch;
        public final ForgeConfigSpec.ConfigValue<Double> legendary_maxPitch;

        public final ForgeConfigSpec.ConfigValue<Boolean> legendary_detectsCorpses;
        public final ForgeConfigSpec.ConfigValue<Boolean> legendary_detectsTame;
        public final ForgeConfigSpec.ConfigValue<Integer> legendary_durability;


        //Mythic Dragonseeker
        public final ForgeConfigSpec.ConfigValue<Integer> mythic_optimalDistance;
        public final ForgeConfigSpec.ConfigValue<Integer> mythic_maxDistance;
        public final ForgeConfigSpec.ConfigValue<Double> mythic_minPingChance;
        public final ForgeConfigSpec.ConfigValue<Double> mythic_maxPingChance;

        public final ForgeConfigSpec.ConfigValue<Integer> mythic_pingCapRadius;
        public final ForgeConfigSpec.ConfigValue<Double> mythic_sigPower;
        public final ForgeConfigSpec.ConfigValue<Double> mythic_minVol;
        public final ForgeConfigSpec.ConfigValue<Double> mythic_maxVol;
        public final ForgeConfigSpec.ConfigValue<Double> mythic_minPitch;
        public final ForgeConfigSpec.ConfigValue<Double> mythic_maxPitch;

        public final ForgeConfigSpec.ConfigValue<Boolean> mythic_detectsCorpses;
        public final ForgeConfigSpec.ConfigValue<Boolean> mythic_detectsTame;
        public final ForgeConfigSpec.ConfigValue<Integer> mythic_durability;



        public Common(ForgeConfigSpec.Builder builder){

            builder.comment("Ping Chance Stats").push("ping_chance_stats");

            builder.comment("Inside this distance, getting closer to the dragon will not increase the ping chance.");
            builder.comment("Defaults: 100, 150, 200, 500");
            basic_optimalDistance = builder.defineInRange("basic", 100, 1, 500);
            epic_optimalDistance = builder.defineInRange("epic", 150, 1, 500);
            legendary_optimalDistance = builder.defineInRange("legendary", 200, 1, 500);
            mythic_optimalDistance = builder.defineInRange("godly", 500, 1, 500);

            builder.comment("Maximum distance at which a dragon will be detected. Should be larger than the optimalDistance, but not larger than your render distance.");
            builder.comment("Defaults: 200, 225, 250, 500");
            basic_maxDistance = builder.defineInRange("basic", 200, 1, 500);
            epic_maxDistance = builder.defineInRange("epic", 225, 1, 500);
            legendary_maxDistance = builder.defineInRange("legendary", 250, 1, 500);
            mythic_maxDistance = builder.defineInRange("godly", 500, 1, 500);

            builder.comment("Minimum chance of a ping. This is the chance of a positive ping when no dragons are detected, i.e. the false positive rate.");
            builder.comment("Defaults: 0.12, 0.08, 0.04, 0");
            basic_minPingChance = builder.defineInRange("basic", 0.12, 0, 1);
            epic_minPingChance = builder.defineInRange("epic", 0.08, 0, 1);
            legendary_minPingChance = builder.defineInRange("legendary", 0.04, 0, 1);
            mythic_minPingChance = builder.defineInRange("godly", 0D, 0, 1);

            builder.comment("Maximum chance of a ping. This is the chance of a positive ping when there is a dragon within the optimalDistance.");
            builder.comment("Defaults: 0.8, 0.9, 0.95, 1");
            basic_maxPingChance =builder.defineInRange("basic", 0.8, 0, 1);
            epic_maxPingChance = builder.defineInRange("epic", 0.9, 0, 1);
            legendary_maxPingChance = builder.defineInRange("legendary", 0.95, 0, 1);
            mythic_maxPingChance = builder.defineInRange("godly", 1D, 0, 1);



            builder.pop();
            builder.comment("Ping Property Stats").push("ping_property_stats");

            builder.comment("Inside this radius, ping properties will not change. The smaller it is, the easier it will be to narrow down a dragon's location.");
            builder.comment("Defaults: 125, 125, 100, 0");
            basic_pingCapRadius = builder.defineInRange("basic", 125, 1, 500);
            epic_pingCapRadius = builder.defineInRange("epic", 125, 1, 500);
            legendary_pingCapRadius = builder.defineInRange("legendary", 100, 1, 500);
            mythic_pingCapRadius = builder.defineInRange("godly", 0, 1, 500);

            builder.comment("Mathematical property governing the relationship between distance and ping properties. The higher this is, the easier it will be to narrow down a dragon's location.");
            builder.comment("Defaults: 1.5, 1.5, 2.5, 3.5");
            basic_sigPower = builder.defineInRange("basic", 1.5, 1, 5);
            epic_sigPower = builder.defineInRange("epic", 1.5, 1, 5);
            legendary_sigPower = builder.defineInRange("legendary", 2.5, 1, 5);
            mythic_sigPower = builder.defineInRange("godly", 3.5, 1, 5);

            builder.comment("Minimum volume of a ping, for when there are no dragons in range.");
            builder.comment("Defaults: 0.05");
            basic_minVol = builder.defineInRange("basic", 0.05, 0, 1);
            epic_minVol = builder.defineInRange("epic", 0.05, 0, 1);
            legendary_minVol = builder.defineInRange("legendary", 0.05, 0, 1);
            mythic_minVol = builder.defineInRange("godly", 0.05, 0, 1);

            builder.comment("Maximum volume of a ping, for when you're inside the ping cap radius.");
            builder.comment("Defaults: 0.05, 0.4, 0.7, 1");
            basic_maxVol = builder.defineInRange("basic", 0.05, 0, 1);
            epic_maxVol = builder.defineInRange("epic", 0.4, 0, 1);
            legendary_maxVol = builder.defineInRange("legendary", 0.7, 0, 1);
            mythic_maxVol = builder.defineInRange("godly", 1D, 0, 1);

            builder.comment("Pitch of a negative result, i.e. no dragon detected.");
            builder.comment("Defaults: 0.5");
            basic_minPitch = builder.defineInRange("basic", 0.5, 0, 1);
            epic_minPitch = builder.defineInRange("epic", 0.5, 0, 1);
            legendary_minPitch = builder.defineInRange("legendary", 0.5, 0, 1);
            mythic_minPitch = builder.defineInRange("godly", 0.5, 0, 1);

            builder.comment("Pitch of a positive result, i.e. there is a dragon detected.");
            builder.comment("Defaults: 0.8, 0.8, 0.8, 1");
            basic_maxPitch = builder.defineInRange("basic", 0.8, 0, 1);
            epic_maxPitch = builder.defineInRange("epic", 0.8, 0, 1);
            legendary_maxPitch = builder.defineInRange("legendary", 0.8, 0, 1);
            mythic_maxPitch = builder.defineInRange("godly", 1D, 0, 1);



            builder.pop();
            builder.comment("Other Stats").push("other_stats");

            builder.comment("Whether or not the dragonseeker detects dead dragons.");
            builder.comment("Defaults: true, false, false, false");
            basic_detectsCorpses = builder.define("basic", true);
            epic_detectsCorpses = builder.define("epic", false);
            legendary_detectsCorpses = builder.define("legendary", false);
            mythic_detectsCorpses = builder.define("godly", false);

            builder.comment("Whether or not the dragonseeker detects tame dragons.");
            builder.comment("Defaults: true, true, false, false");
            basic_detectsTame = builder.define("basic", true);
            epic_detectsTame = builder.define("epic", true);
            legendary_detectsTame = builder.define("legendary", false);
            mythic_detectsTame = builder.define("godly", false);

            builder.comment("Durability of the item. Set to -1 to make it unbreakable.");
            builder.comment("Defaults: 128, 256, 512, -1");
            basic_durability = builder.defineInRange("basic", 128, -1, 2048);
            epic_durability = builder.defineInRange("epic", 256, -1, 2048);
            legendary_durability = builder.defineInRange("legendary", 512, -1, 2048);
            mythic_durability = builder.defineInRange("godly", -1, -1, 2048);
            builder.pop();
        }

    }

    public static final ForgeConfigSpec COMMON_SPEC;
    public static final Common COMMON;

    static {
        final Pair<Common, ForgeConfigSpec> commonSpecPair = new ForgeConfigSpec.Builder().configure(Common::new);
        COMMON_SPEC = commonSpecPair.getRight();
        COMMON = commonSpecPair.getLeft();
    }
}

And here's what currently happens in the .txt file:

Quote

#Ping Chance Stats
[ping_chance_stats]
    #Range: 0.0 ~ 1.0
    legendary = 0.95
    #Range: 0.0 ~ 1.0
    godly = 1.0
    #Range: 0.0 ~ 1.0
    epic = 0.9
    #Defaults: 0.8, 0.9, 0.95, 1
    #Range: 0.0 ~ 1.0
    basic = 0.8

#Ping Property Stats
[ping_property_stats]
    #Range: 0.0 ~ 1.0
    legendary = 0.8
    #Range: 0.0 ~ 1.0
    godly = 1.0
    #Range: 0.0 ~ 1.0
    epic = 0.8
    #Defaults: 0.8, 0.8, 0.8, 1
    #Range: 0.0 ~ 1.0
    basic = 1.0

#Other Stats
[other_stats]
    #Range: -1 ~ 2048
    legendary = 512
    #Range: -1 ~ 2048
    godly = -1
    #Range: -1 ~ 2048
    epic = 256
    #Defaults: 128, 256, 512, -1
    #Range: -1 ~ 2048
    basic = 128

As you can see, only the last 'group' of variables in each of the three sections is printing, and they're doing it out of order. (It should be basic, epic, legendary, godly.) The Defaults comment prints in the middle of the group instead of before it, and the explanatory comment doesn't print at all.

What am I doing wrong? Thanks for the help!

[ZigTheHedge]

The same question.

The only thing I could find is CommentedFileConfig.preserveInsertionOrder(), but either it doesn't work, or I'm doing something wrong...

Edited July 23, 2021 by ZigTheHedge