Configuration FIles is a plugin that allows for the creation of mod configuration files, through which parts of your mod can be enabled, disabled or modified using variable values stored inside it. Those values can then be changed by the mod's users, allowing for more control over your mod's features.
How to use?
Configurations are very simple to use. You will first need to create a configuration element.
Once created, you can make a configuration category and add variable types to it. Note that registry name types are considered texts. (and entities are not supported yet, but you can manually write the registry name as a text variable)
You can then use the variables in procedures by following the example below.
And that's it! The Configuration Files will generate once the game is loaded.
The plugin supports versions 1.16.5-1.19.2, but doesn't support 2022.2. Therefore you will need to install the forge generator 1.16.5 plugin for 2022.3 if you plan on using this with 1.16.5
This is a Java Plugin and therefore requires the Java Plugins feature to be enabled.
Changelog
v2.0.1
-Updated to work with MCreator 2024.1.15821
v2.0
-Major UI code refactor
-Configs now have proper validation
-Removed duplicate registry name procedure blocks (If you're using them, get rid of them before updating)
-Cleaned up config template code
-Support for 2024.1
-Support for neoforge 1.20.4
v1.9
-Added 2023.4 support
v1.8
-Ported to 1.20.1
-Disabled standalone comments as they sometimes caused the game to not launch and I have no bloody clue why
v1.7
-Support for 1.19.4 and 2023.2 EAP
v1.6.1
-Removed the version MCreator limit so I dont need to constantly update the plugin
v1.6
-Support for 2023.1 release
v1.5
-Dropped support for 2023.1 snapshot 2
-Support for 2023.1 snapshot 3
v1.4
-Deleted the 1.16.5 templates as that version is now unsupported in 2023.1
-Changed the variable getter procedures to use a datalist for selecting the configuration element
(You will need to select the element again in existing procedures)
v1.3
-Dropped support for 2022.4 snapshot 1 and below due to incompatibilities in the code
-Updated to the 2023.1 snapshot 2
v1.2
-Number variables can now have negative values
-Added the convert registry name to item procedure
-Added the convert registry name to block procedure
v1.1
-Fixed number variables causing build errors
-Fixed number variable procedure causing build errors
-Fixed configurations being part of the items list
-Fixed block and item registry name variables sometimes causing build errors
-Fixed configuration categories generating inside of each other
-Deleted some useless code in the configuration template
(File size is the same but I swear that's just a coincidence)Comments
> Task :compileJava FAILED
C:\Users\*****\MCreatorWorkspaces\sakes_weapons\src\main\java\sakeplays\sakesweapons\configuration\SakesWeaponsCfgConfiguration.java:11: error: incompatible types: int cannot be converted to java.lang.Double
THUNDERCLAP_DAMAGE = BUILDER.comment("How much damage should thunderclap deal.").define("Thunderclap's Damage", (Double) 40);
^
1 error
FAILURE: Build failed with an exception.
* What went wrong:
Execution failed for task ':compileJava'.
> Compilation failed; see the compiler error output for details.
* Try:
Run with --stacktrace option to get the stack trace. Run with --info or --debug option to get more log output. Run with --scan to get full insights.
* Get more help at https://help.gradle.org
BUILD FAILED in 8s
1 actionable task: 1 executed
BUILD FAILED
Task completed in 16 seconds
another error when i want to get a variable:
> Task :compileJava FAILED
C:\Users\*****\MCreatorWorkspaces\sakes_weapons\src\main\java\sakeplays\sakesweapons\procedures\ThunderclapProjectileHitsLivingEntityProcedure.java:21: error: incompatible types: java.lang.Double cannot be converted to float
entity.attackEntityFrom(DamageSource.LIGHTNING_BOLT, (float) SakesWeaponsCfgConfiguration.THUNDERCLAP_DAMAGE.get());
^
1 error
FAILURE: Build failed with an exception.
* What went wrong:
Execution failed for task ':compileJava'.
> Compilation failed; see the compiler error output for details.
* Try:
Run with --stacktrace option to get the stack trace. Run with --info or --debug option to get more log output. Run with --scan to get full insights.
* Get more help at https://help.gradle.org
BUILD FAILED in 8s
1 actionable task: 1 executed
Well I'll test it out and see if there's anything I can do about that, if it's a forge bug then I will update the generator's forge version and check if it gives a different result.