Jump to content
Search In
  • More options...
Find results that contain...
Find results in...

Adding exception when config fails to load


Recommended Posts

Currently, there are three paths where a config is loaded and parsed: the FMLConfig class for fml.toml, the ConfigTracker class for the initial config load at startup, and the ConfigWatcher class for reloading the config when the file is changed on disk.


When a config fails to be parsed by Night Config, a ParsingException is thrown. Both FMLConfig and ConfigTracker propagate the exception and crash the game, while ConfigWatcher logs then silently discards the exception. The problem is that the ParsingException message is not user-readable. Parsing errors from invalid syntax give a syntax message ("[client]s" -> "Invalid character 's' after a table declaration."), but corrupted configs will result in "Not enough data available", which is not understandable at first glance to a user.


I first made a PR that overwrote any config that failed to load with their default values. LexManos then raised valid points: maybe it is caused by user error? Is something screwing with saving? Never overwrite user data, so they can fix it. I thought about it for a while, thinking of a few solutions (moving the non-parsable config before defaulting to new config) before closing the PR for a new idea.


My idea for the PR is this:

  • A new exception in `net.minecraftforge.fml.config`, `ConfigLoadingException`, that wraps around a given `ModConfig` and exception cause and gives a human-readable message:
    Failed loading config file " + config.getFileName() + " for modid " + config.getModId()
  • Having try-catch blocks in ConfigTracker and ConfigWatcher to wrap the ParsingException with a ConfigLoadingException, and re-throws it.
  • Having a try-catch block in FMLConfig to wrap any ParsingException with a RuntimeException with a more understandable message, like "FML config file {fml.toml} failed to load"

I'm thinking of putting something at the end of the messages as a suggestion to the user; something like "...; maybe it's corrupt?" or to that effect.


This way, it is immediately obvious with a look at the exception message that a particular config is erroring, and support advice can be tailored: "It seems that ____ config file is corrupted/invalid syntax. Could you delete/open the file?"

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.

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.


  • Recently Browsing

    No registered users viewing this page.

  • Posts

    • Please stop capitalizing every word... You need to call NetworkHooks.openGui on the server to open your GUI. You also need to register your ScreenFactory on the client.
    • 1.12 is no longer supported on this forum. Please update to a modern version of Minecraft to receive support.
    • Server Version: 1.17.1 Server IP: enhanced.snorkycraft.com Discord:http://discord.snorkycraft.com/ Snorky Craft World is a playground I have designed for myself and friends to enjoy minecraft, with just some difficult enhancing and extra Contents, i'm an active player on my own server, grinding side by side with players. I do have a TLDR down at the bottom, if you're too lazy to read ;P. Showcase:https://www.youtube.com/watch?v=is7JoucsK0s A short 6 minutes video we have showcasing someone fun time in 2 lairs! a mini-world boss and a world boss. Things we have! ● KeepInvetory - You keep inventory but whenever you die, all your tools and armours lose durability. ● GriefPrevention - Well just your good ol' land claiming area to protect base from griefers ● mcMMO - Well, most of you might know what plugin is this, it's the kind of plugin that help you grow stronger the more you play! ● EliteMobs - Enhancing the mobs around you the more stronger you grow! and also allowing us to replace, create contents for you to enjoy! ● PlaytimeRewards Some Fun Features! Ridable Certain Animals, 6-Rows Enderchest!, Bonus ClaimBlocks, and a very spicy rank! ● Some Funzies Feautures: Editable armor stands! want to decorate your home and make it more lovely? you can with editable armorstands!, 6-Rows barrels! just some extra storage for your home! ● Some...lore related features: Some kind of strange disease have infected the cows... they attack!, Chicken are very feisty! Gameplay Changes ● Disabled Spawners AI, what's the point of spawners, they just ruins the game and there's nothing fun about it, also spawners aren't very useful in my server due to how it's setup. ● Removed The End world exploration! replaced it with the final boss stage for a very long grinding journey, one of our grinder has exactly 60+ Hours of playtime and he only reached Prestige 2! there are 10 Prestiges in total in order to have the power to defeat the new Ender Dragon Boss ● Progression changes, The end goal is not just getting to the ender dragon, is ranking up a custom rank system and farming custom items in order to grow stronger, strong enough to challenge very hard bosses! ● Monsters grows stronger the better equipped you are! and the more stronger you grow they harder challenges/dungeons/lairs you can fight! TLDR: You Join, You Lookaround, You Mine, You Build a House, You farm and gear up, Realized Diamond gearset or netherite gearset full set is so weak!, you start to farm small low level dungeons, you gain great gear, you defeat low level boss, you rankup, you get stronger gear, you repeat this progress so many times you have to prestiges too!, it's pretty fun! i been grinding 10-12 hours a day because once you get going it's very enjoyable.
    • The inputs are just a template- in this case it's two strings, but they can be ints, chars, etc. or none at all, depending if you need to initially send info across sides. I'd suggest reading Forge's documentation on packets first if you haven't used them before:  Forge Docs Networking You usually send the packet by invoking handler methods: ModPacketHandler.sendToServer(new C2SPacketForContainer(input1, input2)); Where the handler class has packet registration and the methods: The register methods are called in common setup.
    • Yeah the VillagerUtil was used in conjunction with the POI Forge registry, but you're right it's superfluous and I should stick with the simpler way. Thank you Ash
  • Topics

  • Who's Online (See full list)

  • Create New...

Important Information

By using this site, you agree to our Privacy Policy.