Jump to content

Using custom types or Lists of custom types for ConfigValue (ForgeConfigSpec)


Dutchs

Recommended Posts

Hey

I'm attempting to store interdependent config data using ForgeConfigSpec API, ie a (variable size) List<MyClass> with MyClass having a String field and a List<String> field.

I'd imagine this would involve implementing a serializer/deserializer, but i'm not entirely sure how to go about it, or if its even possible.

Using the overload for ForgeConfigSpec.Builder.defineList and define that takes a List<String> for the path works somewhat but the number of config values that can be stored this way are hard-coded which is undesirable;

[myClass1]
    name = "a"
    values = ["a", "b", "c"]

[myClass2]
    name = "b"
    values = ["c", "b", "a"]

 

This is what i've tried;

@Mod.EventBusSubscriber(modid = Constants.MODID, bus = Mod.EventBusSubscriber.Bus.MOD)
public class ConfigHandler {
    static public final CommonConfig COMMON_CONFIG;
    static public final ForgeConfigSpec COMMON_SPEC;

    static {
        final Pair<CommonConfig, ForgeConfigSpec> serverSpecPair = new ForgeConfigSpec.Builder().configure(CommonConfig::new);
        COMMON_CONFIG = serverSpecPair.getLeft();
        COMMON_SPEC = serverSpecPair.getRight();
    }

    @SubscribeEvent
    public static void onModConfigEvent(final ModConfigEvent configEvent) {
        if (configEvent.getConfig().getSpec() == ConfigHandler.COMMON_SPEC) {
            bakeCommonConfig();
        }
    }

    //Common
    public static List<MyClass> myClasses;

    public static void bakeCommonConfig() {
        myClasses = COMMON_CONFIG.myClasses.get()
    }

    public static class CommonConfig {
        public final ForgeConfigSpec.ConfigValue<List<MyClass>> myClasses;
        List<MyClass> defaults = Arrays.asList(new MyClass("a", new ArrayList()));

        public CommonConfig(ForgeConfigSpec.Builder builder) {
            Predicate<Object> validator = o -> o instanceof MyClass;
            myClasses = builder.defineList("myClasses", defaults, validator);
        }
    }
}

public class MyClass {
    public String name;
    public List<String> values;
    
    public MyClass(String name, List<String> values)
    {
        this.name = name;
        this.values = values;
    }
}

 

Edited by Dutchs
Link to comment
Share on other sites

the config which Forge is using allows only primitive values (int, double, String, ...),
if you want to use custom values in the config you need to serialize/deserialize this value to a primitive value

here is a simple example:

Spoiler
public class Config {
	
	public static final ForgeConfigSpec CONFIG = buildConfig();
	
	protected static ConfigValue<String> SOME_VALUE;
	
	
	public static ForgeConfigSpec buildConfig() {
		ForgeConfigSpec.Builder builder = new ForgeConfigSpec.Builder();
		SOME_VALUE = builder.define("someValue", "dummy");
		return builder.build();
	}
	
	public static SomeClass getSomeValue() {
		return SomeClass.deserialize(SOME_VALUE.get());
	}
	
	public static void setSomeValue(SomeClass someClass) {
		SOME_VALUE.set(someClass.serialize());
	}
	
	public static class SomeClass {
		
		protected final String s;
		
		public SomeClass(String s) {
			this.s = s;
		}
		
		public void foo() {
			System.out.println(this.s);
		}
		
		public String serialize() {
			return this.s;
		}
		
		public static SomeClass deserialize(String s) {
			return new SomeClass(s);
		}
		
	}
	
}

 

Link to comment
Share on other sites

1 hour ago, Dutchs said:

I'd imagine this would involve implementing a serializer/deserializer, but i'm not entirely sure how to go about it, or if its even possible.

possible? sure.    should you? probably not.

what is it you are trying to do? (do not repeat the implementation plan, tell us what you are planning to get to - i.e. what the mod really does)

Link to comment
Share on other sites

39 minutes ago, MFMods said:

possible? sure.    should you? probably not.

what is it you are trying to do? (do not repeat the implementation plan, tell us what you are planning to get to - i.e. what the mod really does)

https://www.curseforge.com/minecraft/mc-mods/infernal-stages

The mod allows you to configure a set of Modifiers, to be associated with a stage which a player can have or not have, and by that it decides which special abilities a mob can spawn with around said player.

Edited by Dutchs
Link to comment
Share on other sites

ok, there is no elegant way to do that.
and i/we can't give you a detailed recommendation because i/we don't know details (for example is the list of these stages fixed and known at runtime, etc.).

but it's very important to review the idea of having objects in config file.

difficulty level? super-easy. serialize our object into a string, deserialize from it, no problem.
"StringOption" = "{ 'field1': 'value1', 'field2': [listt], 'field3': {object inside the big object} }"

when should you do it?
never. ever.
user will load the game with a newer version of your mod than last time (they are expected to, occasionally) and if the class you store is different, deserialization will crash the game (or you will catch that but you don't know how to load data). and sometimes, user will load the game with an older version of your mod than last time (they're not supposed to, but it can happen) - and crash - you don't know how to load data.

also - and this is just as important - configs exist for the sake of users/players. but whey they see a bunch of serialized objects (which to many look like some programming), they'll say "umm, nope!" and close the editor.

anyway, just hardcode your structure and don't feel bad.
and if you can't fit your config structure into the usual system (too dynamic?), just write it into a file yourself. that is okay too, if you need to. but see that editable parts are all simple data types.

 

Edited by MFMods
Link to comment
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.
Note: Your post will require moderator approval before it will be visible.

Guest
Unfortunately, your content contains terms that we do not allow. Please edit your content to remove the highlighted words below.
Reply to this topic...

×   Pasted as rich text.   Restore formatting

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.

Announcements



  • Recently Browsing

    • No registered users viewing this page.
  • Posts

    • I'm creating a custom staff, that can be used like a bow, meaning i can use it and it should "load" the staff.   As far as i can see the interaction is pretty simple: activate the "draw" stage via overriding use and then when the mouse is released the "releaseUsing" and "useOnRelease" methods are called.    What i want to achieve is between the activation and the release: I want to do stuff while it is drawn. For example i want to create particles and i want to stop the "drawn" stage in certain conditions. Is something like this possible and if so, where can i look? I'm also happy with examples from other mods. (For example i think that mana and artifice has something like that with the beam spells, but that mod is not open source).
    • Minecraft Version: 1.8-1.20.X Forge Version: All (Tested on 49.0.27, 11.14.4.1577 and some others) Steps to Reproduce: Setup a server with IPV6 only Setup a docker container with forge Try to connect to the Forge Server Description of issue: Hello, I am reaching out to seek your expertise within this forum to clarify a technical situation I am encountering, suspecting a potential issue related to Forge in a Docker environment, specifically in an IPv6 context. Initial Configuration: Debian 12 server, configured exclusively for IPv6, with Docker installed. Using the Docker image ghcr.io/pterodactyl/yolks:java_17, launching a Minecraft Vanilla server version 1.20.4 proceeds without any issues. Problem: The issue arises when deploying a Minecraft Forge server version 1.20.4 with the same Docker image (ghcr.io/pterodactyl/yolks:java_17), where connecting to the server becomes impossible. Notably, this issue does not occur when launching outside of Docker, where the server functions as expected. Hypothesis: This situation leads me to question the interaction between Forge and Docker, particularly in an IPv6-only configuration, despite several resolution attempts (testing with different versions of Forge, adjusting container network configurations (0.0.0.0, ::/0, and the server's ipv6), trials with various network settings, and modifications of Java options). Further testing was conducted with and without the use of the Pterodactyl game panel, unsuccessfully. The parameter -Djava.net.preferIPv4Stack=false also did not provide a solution. I tried to do the same things on multiple Minecraft server (include vanilla,spigot,fabric,sponge) and this work fine. The problem only happend with Forge. This issue seem to happend on all forge versions.   I appreciate your time and assistance in advance.
    • The game crashed whilst exception ticking world Error: java.lang.NullPointerException: Cannot invoke "net.minecraft.resources.ResourceLocation.equals(Object)" because "this.lootTableId" is null Error given is above. I was already playing for around 15 minutes and wasn't doing anything specific or even breaking anything when the crashed happened. This is update 1.19.2 forge: 43.2.23 Mod list: ESSENTIAL Mod (by SparkUniverse_) Traveler's Titles (Forge) (by YUNGNICKYOUNG) Resourceful Config (by ThatGravyBoat) Dynamic Lights (by atomicstrykergrumpy) TenzinLib (by CommodoreThrawn) Nature's Compass (by Chaosyr) Library Ferret - Forge (by jtl_elisa) Cold Sweat (by Mikul) Simple Voice Chat (by henkelmax) Waystones (by BlayTheNinth) Carry On (by Tschipp) [Let's Do] Meadow (by satisfy) Creeper Overhaul (by joosh_7889) AutoRegLib (by Vazkii) Moonlight Lib (by MehVahdJukaar) AppleSkin (by squeek502) Xaero's World Map (by xaero96) Rotten Creatures (by fusionstudiomc) YUNG's API (Forge) (by YUNGNICKYOUNG) Village Artifacts (by Lothrazar) Right Click, Get Crops (by TeamCoFH) Supplementaries (by MehVahdJukaar) Automatic Tool Swap (by MelanX) Better Third Person (by Socolio) Supplementaries Squared (by plantspookable) Traveler's Backpack (by Tiviacz1337) Caelus API (Forge/NeoForge) (by TheIllusiveC4) Creatures and Beasts (by joosh_7889) Architectury API (Fabric/Forge/NeoForge) (by shedaniel) Quark Oddities (by Vazkii) Origins (Forge) (by EdwinMindcraft) Villager Names (by Serilum) GeckoLib (by Gecko) Realistic Bees (by Serilum) Illuminations Forge 🔥 (by dimadencep) Serene Seasons (by TheAdubbz) Critters and Companions (by joosh_7889) [Let's Do] Bakery (by satisfy) Falling Leaves (Forge) (by Cheaterpaul) Jade 🔍 (by Snownee) Collective (by Serilum) TerraBlender (Forge) (by TheAdubbz) [Let's Do] API (by Cristelknight) Towns and Towers (by Biban_Auriu) More Villagers (by SameDifferent) Biomes O' Plenty (by Forstride) Goblin Traders (by MrCrayfish) Corpse (by henkelmax) Tree Harvester (by Serilum) Balm (Forge Edition) (by BlayTheNinth) Mouse Tweaks (by YaLTeR) Sound Physics Remastered (by henkelmax) Xaero's Minimap (by xaero96) Just Enough Items (JEI) (by mezz) Terralith (by Starmute) Quark (by Vazkii) [Let's Do] Vinery (by satisfy) [Let's Do] Candlelight (by satisfy) Repurposed Structures (Neoforge/Forge) (by telepathicgrunt) Dusty Decorations (by flint_mischiff) Immersive Armors [Fabric/Forge] (by Conczin) Serene Seasons Fix (by Or_OS) Shutup Experimental Settings! (by Corgi_Taco) Skin Layers 3D (Fabric/Forge) (by tr7zw)
    • Make sure Java is running via Nvidia GPU https://windowsreport.com/minecraft-not-using-gpu/  
    • Also make a test with other Custom Launchers like AT Launcher, MultiMC or Technic Launcher
  • Topics

×
×
  • Create New...

Important Information

By using this site, you agree to our Terms of Use.