Config API - Universal Configuration System for Minecraft

Config API is a multifunctional library for handling mod settings, compatible with Fabric, Forge, NeoForge, and Quilt. This core mod is specifically designed for projects supporting multiple loaders, allowing easy creation of configuration files for client, server, and common parameters in the style of Forge and NeoForge configuration systems.

Key Advantages

Why choose this configuration system over standard Forge and NeoForge solutions:

• Automatic creation of a fully functional settings screen
• Extended set of methods including getComments(), getKey(), getRange(), and others
• Cross-platform support for all popular loaders

Developer Guide

To integrate Config API into your project, follow these steps:

1. Open the build.gradle file
2. Add the plugin to existing plugins:

plugins {
    id 'io.github.0ffz.github-packages' version '1.2.+'
}

3. Add the repository:

repositories {
  maven githubPackage.invoke("Craftjakob/Config-API")
}

4. Add the dependency, choosing the appropriate implementation for your project (if 'modImplementation' cannot be used, apply 'compileOnly' and 'runtimeOnly'):

dependencies {
  modImplementation "com.craftjakob:configapi-common:${mc_version}-${configapi_version}"
  modImplementation "com.craftjakob:configapi-fabric:${mc_version}-${configapi_version}"
  modImplementation "com.craftjakob:configapi-forge:${mc_version}-${configapi_version}"
  modImplementation "com.craftjakob:configapi-neoforge:${mc_version}-${configapi_version}"
  modImplementation "com.craftjakob:configapi-quilt:${mc_version}-${configapi_version}"
}

5. Reload the build.gradle file

Change History

Version 2.4.0

• Added support for versions 1.21.2 and 1.21.3
• Removed background configuration support due to changes in Minecraft
• Changed parameter order in the registerConfig method
• Code optimization and performance improvements
• Reworked configuration tracking system for increased efficiency
• Changed position of the reset all server config button

Version 2.3.2

• Fixed crash when opening the screen
• Added HolderHelper utility class

Version 2.3.1

• Added SimpleResourceLocation as a simpler alternative to the new system

Version 2.3.0

• Updated to version 1.21 for Fabric and NeoForge

Version 2.2.1

• Removed license from quilt.mod.json to prevent crashes
• Restored support for NeoForge 1.20.4
• Fixed Forge crash on 1.20.4 due to logo
• Resolved server compatibility issues

Version 2.0.0

• Improved ConfigTracker efficiency
• Added server support for SERVER type configurations
• Created world selection screen for server configurations
• Added configuration example for demonstration
• Fixed quilt mixin issues

Version 1.2.0

• Added checkbox button
• Implemented deep search
• Improved search system with suggestions
• Optimized loading and tracking methods
• Rewrote ConfigFileWriter for better performance

Version 1.1.1

• Improved server compatibility
• Added ConfigEditBox for user convenience
• Fixed reset button issues

Version 1.1.0

• Changed file format to .cfg
• Added navigation buttons
• Improved configuration type selection interface
• Added additional widgets

Version 1.0.0

• Initial version with support for all major loaders
• Automatic settings screen creation
• Organization of settings by categories
• Configuration file tracking system