All Mods Resource Packs Data Packs Shaders Modpacks Plugins
Config API

Config API

by Craftjakob • Downloads: 0 • Followers: 0
Description
Gallery
Changelog
Versions

This is a Config API for Fabric, Forge, NeoForge and Quilt.

It has a Config Screen, which is automatically added, if the specific mod uses this as config system.

This is a "core" mod, specifically designed for multiloader projects. It allows you to create easily new configs, for Client, Common and Server, in the style of Forge's and NeoForge's Config System.

Why you should use this instead of Forge's and NeoForge's Config System?

  • Automatically adds a fully functional Config Screen
  • You can use more methods like getComments(), getKey(), getRange(), etc.
  • It's cross-platform for Fabric, Forge, NeoForge and Quilt

For developer
  1. Open your build.gradle
  2. Add this plugin to your other plugins
    • plugins {
          id 'io.github.0ffz.github-packages' version '1.2.+'
      }
  3. Next step is, to add this repository:
    • repositories {
        maven githubPackage.invoke("Craftjakob/Config-API")
      }
  4. After that, you can add a dependency and choose one of these implementations for your project. (If you can not use 'modImplementation' use '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. Finally, you can reload your build.gradle.

For more information, visit the GitHub page.

Changelog

CONFIG API VERSION 2.4.0


  • Added support for 1.21.2 and 1.21.3
  • Removed support of background configs, due to many changes from Minecraft
  • Changed the parameter order in the registerConfig method
  • Cleaned-Up code and performance improvements
  • Reworked the ConfigTracking for increasing efficient
  • Changed the Position of the Reset All Server Config Button

CONFIG API VERSION 2.3.2


  • Fixed a crash, when opening the screen
  • Added HolderHelper that's a utility class

CONFIG API VERSION 2.3.1


  • Added SimpleResourceLocation, because the new system is unnecessary

CONFIG API VERSION 2.3.0


  • Updated to 1.21 for Fabric and NeoForge

CONFIG API VERSION 2.2.1


Thanks to xLuPo, ornithoptercat

  • Removed license from quilt.mod.json, to prevent a crash
  • Added back the support for NeoForge 1.20.4
  • Fixed Forge crash on 1.20.4, because of the Logo
  • Fixed Server Compatibility, the ServiceLoader had tried to load Client methods on Server

CONFIG API VERSION 2.0.0


  • Made the ConfigTracker more efficient
    • added a method to stop tracked configs
  • Added Server support for Config with the type SERVER
    • These configs are only loaded on the server
    • The server configs are saved inside the worlds folder
      • That allows you to set specific things only in the World
  • Added ConfigWorldSelectionScreen
    • If you want to open a Server config, and you are not in a world, you can choose which config do you want to modify
    • If you are inside a world, you can directly modify it
  • Added an example config for the Config Screen
  • fixed quilt mixin

CONFIG API VERSION 1.2.0


  • Added CheckboxButton
  • Added Deep Search
    • If your in a folder, and then enabling it, all configs in and after the folder will be displayed
  • Now you need to type an '#' to search for tooltips
  • Added new mechanics to the SearchBox
    • A search suggestion
    • It's now displayed with a search lupe
    • If you had searched something, you can click on a delete button
  • Fixed client config, does not tracked on fabric
  • Optimized load & track methode
  • Rewritten the ConfigFileWriter for better performance
  • Optimized some other things

CONFIG API VERSION 1.1.1


  • Fixed server compatibility
  • Added ConfigEditBox for friendlier usability
    • Now you can press Enter to get out of the EditBox/Searchbox
    • And some other things
  • Fixed Enum & ListScreen's reset button, does not set correctly

CONFIG API VERSION 1.1.0


Critical Changes: new file format is .cfg, moved directories, now it's not compatible with v1.0.0

  • added navigation buttons
  • the displayed config names have now a space after a capital letter
  • fixed reset button, do not reset all configs
  • removed reset all button in Config Screen
  • rework of Config Type Selection Screen
    • Added Icons for the specific config type
    • Added reset button, to reset the file
    • Added Open Config File Button
  • Added SearchBox as extra Widget
  • Added ImageTextButton as extra Widget
  • Added Services for getConfigDirectory, isModLoaded & getEnvironment

CONFIG API VERSION 1.0.0


  • Supported Modloaders Fabric, Forge, NeoForge and Quilt
  • Fabric requires Fabric API
  • Config Screen features:
    • Automatically added
    • Organized with categories
    • Currently available only for Forge and NeoForge
  • Config files are saved and tracked only when you are in the specific environment
    • Common Configs are always tracked and directly loaded, they are the safest to use
  • For usage instructions, please refer to the README.md file on Github
    • Access is currently not possible, due to the requirement of a password key

All Versions

+ Add Version
Name Game version Platforms Published Downloads Actions
26.2
Forge
2mo ago 1
26.2
Neoforge
2mo ago 1
26.2
Forge
2mo ago 1
26.2
Fabric
2mo ago 1
26.1.x
Fabric
4mo ago 1
26.1.x
Neoforge
4mo ago 1
26.1.x
Forge
4mo ago 1
26.1.x
Neoforge
5mo ago 1
26.1.x
Forge
5mo ago 1
26.1.x
Fabric
5mo ago 1
26.1.x
Fabric
7mo ago 1
1.21.11
Neoforge
7mo ago 1
1.21.11
Forge
7mo ago 1
1.21.11
Fabric
7mo ago 1
1.21.11
Neoforge
9mo ago 1
1.21.11
Forge
9mo ago 1
1.21.11
Fabric
9mo ago 1
1.21.11
Neoforge
9mo ago 1
1.21.11
Forge
9mo ago 1
1.21.11
Fabric
9mo ago 1
1.21.11
Neoforge
10mo ago 1
1.21.11
Forge
10mo ago 1
1.21.11
Fabric
10mo ago 1
1.21.x
Fabric
last yr. 1
1.21.x
Neoforge
last yr. 1
1.21.x
Forge
last yr. 1
1.21.x
Fabric
last yr. 1
1.21.x
Neoforge
last yr. 1
1.21.x
Forge
last yr. 1
1.21.6
Fabric
last yr. 1
1.21.6
Neoforge
last yr. 1
1.21.6
Forge
last yr. 1
1.21.5
Neoforge
last yr. 1
1.21.5
Fabric
last yr. 1
1.21.5
Forge
last yr. 1
1.21.6
Fabric
last yr. 1
1.21.5
Fabric
last yr. 1
1.21.6
Neoforge
last yr. 1
1.21.6
Forge
last yr. 1
1.21.6
Fabric
last yr. 1
1.21.5
Forge
last yr. 1
1.21.5
Neoforge
last yr. 1
1.21.5
Fabric
last yr. 1
1.21.5
Neoforge
last yr. 1
1.21.5
Fabric
last yr. 1
1.21.4
Neoforge
last yr. 1
1.21.4
Fabric
last yr. 1
1.21.x
Neoforge
last yr. 1
1.21.x
Fabric
last yr. 1
1.20.2
Forge
last yr. 1
1.20.2
Quilt
last yr. 1
1.20.2
Neoforge
last yr. 1
1.20.2
Forge
last yr. 1
1.20.2
Fabric
last yr. 1
1.20.x
Quilt
last yr. 1
1.20.x
Forge
last yr. 1
1.20.x
Fabric
last yr. 1
1.20.2
Quilt
last yr. 1
1.20.2
Neoforge
last yr. 1
1.20.2
Forge
last yr. 1
1.20.2
Fabric
last yr. 1
# CONFIG API VERSION 3.3.1

  • Fixed** a Networking issue where it tries to call a method that does not exist
# CONFIG API VERSION 3.3.0

  • Updated** to Minecraft 26.2
# CONFIG API VERSION 3.3.0

  • Updated** to Minecraft 26.2
# CONFIG API VERSION 3.3.0

  • Updated** to Minecraft 26.2
# CONFIG API VERSION 3.2.2

  • Fixed** modify fov event crashes, when using FreeCam, the cast no longer happens #thanks to creativedude10
  • Fixed** not able to zoom with Spyglass Improvements #thanks to Cha0Byt3
  • Fixed** Server freezes while shutting down #thanks to RybaStefek
# CONFIG API VERSION 3.2.2

  • Fixed** modify fov event crashes, when using FreeCam, the cast no longer happens #thanks to creativedude10
  • Fixed** not able to zoom with Spyglass Improvements #thanks to Cha0Byt3
  • Fixed** Server freezes while shutting down #thanks to RybaStefek
# CONFIG API VERSION 3.2.2

  • Fixed** modify fov event crashes, when using FreeCam, the cast no longer happens #thanks to creativedude10
  • Fixed** not able to zoom with Spyglass Improvements #thanks to Cha0Byt3
  • Fixed** Server freezes while shutting down #thanks to RybaStefek
# CONFIG API VERSION 3.2.1

  • Updated to 26.1
# CONFIG API VERSION 3.2.1

  • Updated to 26.1
# CONFIG API VERSION 3.2.1

  • Updated to 26.1
# CONFIG API VERSION 3.2.1

  • Updated to 26.1
# CONFIG API VERSION 3.2.0

  • Fixed** PlayNetworking sendToServer
  • Added** KeyMappingBuilder
# CONFIG API VERSION 3.2.0

  • Fixed** PlayNetworking sendToServer
  • Added** KeyMappingBuilder
# CONFIG API VERSION 3.2.0

  • Fixed** PlayNetworking sendToServer
  • Added** KeyMappingBuilder
# CONFIG API VERSION 3.1.2

  • Fixed** the mixin that should match up with Fabric. It no longer matches the same, to fix a crash
# CONFIG API VERSION 3.1.2

  • Fixed** the mixin that should match up with Fabric. It no longer matches the same, to fix a crash
# CONFIG API VERSION 3.1.2

  • Fixed** the mixin that should match up with Fabric. It no longer matches the same, to fix a crash
# CONFIG API VERSION 3.1.1

  • Added** for each register a method without ResourceKey in the function
  • Removed** on NeoForge the @OnlyIn annotations
  • Changed** where the Client Started Event is invoked to match fabric
# CONFIG API VERSION 3.1.1

  • Added** for each register a method without ResourceKey in the function
  • Removed** on NeoForge the @OnlyIn annotations
  • Changed** where the Client Started Event is invoked to match fabric
# CONFIG API VERSION 3.1.1

  • Added** for each register a method without ResourceKey in the function
  • Removed** on NeoForge the @OnlyIn annotations
  • Changed** where the Client Started Event is invoked to match fabric
# CONFIG API VERSION 3.1.0

  • Updated** to minecraft 1.21.11
  • Fixed** MenuRegistry.of method was not found
  • Fixed** Forge and NeoForge screen registering does not work
# CONFIG API VERSION 3.1.0

  • Updated** to minecraft 1.21.11
  • Fixed** MenuRegistry.of method was not found
  • Fixed** Forge and NeoForge screen registering does not work
# CONFIG API VERSION 3.1.0

  • Updated** to minecraft 1.21.11
  • Fixed** MenuRegistry.of method was not found
  • Fixed** Forge and NeoForge screen registering does not work
# CONFIG API VERSION 3.0.4

  • Fixed** multiple mods which try to register new objects, like items crashes due to duplicate registration
# CONFIG API VERSION 3.0.4

  • Fixed** multiple mods which try to register new objects, like items crashes due to duplicate registration
# CONFIG API VERSION 3.0.4

  • Fixed** multiple mods which try to register new objects, like items crashes due to duplicate registration
# CONFIG API VERSION 3.0.3

  • Improved** event priority listeners, to prevent crashes
  • Added** a registry method, which allows to create different types of DataComponents
  • Fixed** an issue where Forge had a problem registering objects
  • Added** ability to set onlyOpCanSetNbt in BlockEntityTypes
# CONFIG API VERSION 3.0.3

  • Improved** event priority listeners, to prevent crashes
  • Added** a registry method, which allows to create different types of DataComponents
  • Fixed** an issue where Forge had a problem registering objects
  • Added** ability to set onlyOpCanSetNbt in BlockEntityTypes
# CONFIG API VERSION 3.0.3

  • Improved** event priority listeners, to prevent crashes
  • Added** a registry method, which allows to create different types of DataComponents
  • Fixed** an issue where Forge had a problem registering objects
  • Added** ability to set onlyOpCanSetNbt in BlockEntityTypes
# CONFIG API VERSION 3.0.2

  • Fixed** wrong parameter for render types, only 1.21.6
  • Fixed** registered objects, like blocks are registered in the wrong order
Config API Icon
Download Config API
Select game version
Select platform