Minecraft Config tagged materials

Forge Config API Port [Fabric] is an unofficial port of Minecraft Forge’s Config API for fabric. MC Forge has a well-known API for doing configs. MC Forge commonly recommends you use their Config API for making mods for the sake of being easier to support for them. This can make it harder for those who want to want to port their mod to Fabric/Quilt or other loaders. So this mod ports the MC Forge Config API to Fabric.The MC Forge Config API is actually quite simple, with just a few parsers and Java Interfaces and hardly makes any calls to Minecraft itself or other parts of Minecraft Forge. When it does refer to other parts of MC Forge, the unofficial port has an abstraction layer and general API. It is unknown how much work went into this, as it is not a cleanroom rewrite with many of the comments still in place. It is also important to note, that there are a few files missing such as ForgeConfig.java. So this is something that may need to be considered.The mod is built as a drop-in replacement for the Minecraft Forge Config API and has all the same package names and everything. The mod is supposed to be used in an environment with multiple loaders and itself is in a gradle project that has MC Forge, FabricMC, QuiltMC, and Common(shared code) as separate that is possibly based on MultiLoader Template. It is unknown why they chose this development configuration, both the Quilt and MC Forge projects are likely dummy projects possibly for testing and not something you can actually download (though the main version, for Fabric, does work on Quilt officially). The mod in general is useful for people who do not want to use a 3rd party config API on MC Forge and still work on Fabric.Mods can also be configured in the game if the mod Configured is installed, however many configs require this to be explicitly enabled so you may not have as much luck with the GUI as you would with the files. The author is behind many other mods also, and many of them use this, there are also many other mods which use this.

modristore March 01, 2023

Configured is a configuration GUI mod by MrCrayfish to help you make your config in a GUI format, similar to Cloth Config. The configs are very nice and give you lots of details and information about the name and description and if the game needs to be restarted, reset configs to default and more. For players Configured is in many ways better than Cloth Config.In order to access the configs you need to have either Mod Menu (if on Fabric, the default mod menu in MC Forge also works) or Catalogue installed. Once you have these installed you can click the config button and then start configuring. There is also a search bar to help you search for fields. You can divide the config into client, server and common, and categorise different parts of the config if you are a developer. In many cases, you would still need some kind of a backend for the config such as Minecraft Forge’s Config API or Forge Config API for Fabric.Configured is also very easy to use for developers. An example of a mod which uses it is Goblin Traders. You only need a few lines of code to configure this mod to work with your existing config in many cases.For server owners and modpack makers, you can easily sync the Server config to the client which means the client may be able to have the same config as the server making the playing better and possibly stopping cheating.The developer, MrCrayFish is a big name in modding and is behind many big mods (such as MrCrayFish Furniture) and modding tutorials and has a discord channel where you can go to get help integrating this with your mod.

modristore March 01, 2023

Cloth Config API (also Auto Config) is a config API that allows the player to change the config of the game from Within the Game’s GUI. It is one of the most popular config APIs, and it is made by shedaniel, the author of Architectury API and Roughly Enough Items, and other big names. They have excellent documentation for Developers and are lightweight for players. There are also similar APIs, such as Cloth API, a general-purpose API for Fabric (distinct from Cloth Config/Cloth Config API) and Cloth Math, a Maths API that is not dependent on Minecraft.There are multiple versions of Cloth Config, each of which has its API and Features. Each version of Cloth Config is linked to a specific version family of Minecraft.Here is the Table:V1 1.14.x (No Longer Developed)v2 1.14.x-1.15.x (No Longer Developed)v3 1.16 Snapshots before 20w17a (No Longer Developed)v4 1.16.x 20w17a and newer (Supported)v5 1.17.x (Supported)v6 1.18.x (Supported)v7 1.19 (No Longer Developed)v8 1.19.x (Supported)All stable versions of Minecraft have been supported since 1.16. It is important to note that Cloth API is not a fully functional config library; it is just a screen for setting the config, which shedaniel claims the others suck. Since Cloth is just a screen, it can work with existing APIs such as Forge Config API. It is also supposed to be primarily used with the client; however, some server features do exist, but it is suggested server mods do not use Cloth Config.Cloth was initially designed with Fabric in mind because, at the time, Fabric was very lightweight and did not have much in the way of config, but it eventually got popular and was ported to Minecraft Forge.For Players, install the mod like any other mod. Some mods may need Mod Menu to show configs where you edit the config from the Mod Menu entry.For Developers, Cloth Config has many features such as Drop Down Menus, Integration with Mod Menu, Categories, and more.Creating a Screen in your mod is easy and can be done with a single line of code.```ConfigBuilder builder = ConfigBuilder.create().setParentScreen(parent).setTitle(new TranslatableText("title.examplemod.config"));```The Config Builder can be used to set the attributes of the Config Screen, such as the background, and is automatically localised with a translation key.Note: a new builder is created every time the screen is opened.```builder.setSavingRunnable(() -> {// Serialise the config into the config file. This will be called last after all variables are updated.});```It saves the config to a file and requires custom parsing.Entries are each different, and it is recommended you read the documentation for more details on creating entries and setup Cloth Config.Another prominent feature of Cloth Config is Auto Config, which makes configuring your mod much easier with Annotations. Auto Config Annotations are flexible; they are put on top of Config files and have their annotations for fields, which can easily be set to whatever entry. e.g. @ConfigEntry.Gui.CollapsibleObject and can also be excluded @ConfigEntry.Gui.Excluded. The supported Field types by default are boolean, int, long, double, float, String, and enum.Cloth Config is one of the most common Config Screens in Minecraft, so making your mod require it will not be a significant burden for most modpack devs, as many big mods, including many by Yung use it (such as Yung’s Better Dungeons).

mchoarder January 13, 2023