Configuration Files

Supported MCreator versions
2022.3
2023.1
2023.2
2023.3
2023.4
2024.1
2024.2
2024.3
Tags / plugin type
Java plugin
Procedures
Templates
configs
Downloads:
5437
Upvotes: 77
About the plugin

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.

config

Once created, you can make a configuration category and add variable types to it. Note that registry name types are considered texts.


You can then use the variables in procedures by following the example below.

example

 

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.3.1
-Fixed the plugin breaking all blockly panels in some cases (thanks javascript)

v2.3
-Reworked the UI to use a blockly panel (old elements are automatically converted)
-Ported to MCreator 2024.3 and neoforge 1.21.1

v2.2
-Support for MCreator 2024.2 and neoforge 1.20.6

v2.1.1
-Fixed text lists causing the config to regenerate every time the game is launched

v2.1
-Added text list variables to configs
-Added new procedure block: for each entry in config text list
-Added new procedure block: text list iterator

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

Archived versions:
-1.2 for 2022.4 and below https://www.mediafire.com/file/ot4dafj51ilrpws/configuration_files_2022.4-1.2.zip/file
License
MIT License

Plugin downloads
Configuration Files v1.6.1 (MCreator 2023.1 ONLY) - configuration_files_0.zip Uploaded on: 03/08/2023 - 12:15   File size: 38.79 KB
Configuration Files v1.7 (MCreator 2023.1, 2023.2 ONLY) - configuration_files.zip Uploaded on: 04/28/2023 - 22:53   File size: 43.32 KB
Configuration Files v1.8 (MCreator 2023.1, 2023.2, 2023.3 ONLY) - configuration_files.zip Uploaded on: 12/01/2023 - 11:44   File size: 47.9 KB
Configuration Files v2.0 (MCreator 2023.4 ONLY) - configuration_files.zip Uploaded on: 04/12/2024 - 17:27   File size: 40.01 KB
Configuration Files v2.1.1 (MCreator 2024.1 ONLY) - configuration_files_0.zip Uploaded on: 06/17/2024 - 20:30   File size: 47.08 KB
Configuration Files v2.2 (MCreator 2024.2 ONLY) - configuration_files.zip Uploaded on: 07/18/2024 - 18:54   File size: 51.03 KB
Configuration Files v2.3.1 (MCreator 2024.3 ONLY) - configuration_files_0.zip Uploaded on: 11/19/2024 - 09:45   File size: 38.66 KB

Comments

Hi, amzing that you guys write useful addon. My goal is to create a cnfig file with a spcific text ({ "professionName":"test", "blockPOIkey": "minecraft:rail" }) and nothin else. Is that possible?

The configs are confined per world, how do I make it available in the mod's config menu?

Hey just so you know if you have the configuration type set to Common it causes the game to crash every time you try to launch the game

It would be nice if you could manipulate the configuration file directly from the procedure.

Is it possible to generate folders? like naming it "/config-name" would put it in a folder or something.

this plugin ddnt work it shows me this message
https://cdn.discordapp.com/attachments/1033957949586022461/1085886107905949707/image.png

um...
...got an error:
when i boot up mcreator: i get the following message:
some plugins failed to load:
configuration_fuiles - reason: internal error: ClassNotFoundException: net.nerdypuzzle.configurationfiles.element.types.Config$PoolBeanInfo

I've been having issues where, if a config's already generated, it forces me to delete it in order to test or play the mod. I've already disabled all the Comments, so it's not those. What do I do?

I've been using this to make an update for my mod to add a config file and everything seemed to be going very smoothly until i deleted the config file, i thought it would just recreate it but it didn't, that's my problem, the config file just wont come back, i tried reinstalling the plugin. Do you have any fixes or is this a bug?