|
@@ -1,13 +1,14 @@
|
|
|
# CompleteConfig
|
|
|
-CompleteConfig is a flexible, all-in-one configuration API for [Fabric](https://fabricmc.net/) mods.
|
|
|
+CompleteConfig is a flexible, all-in-one configuration library for [Fabric](https://fabricmc.net/) mods.
|
|
|
It takes care of creating and observing config entries, displaying them as GUI, and saving and loading the config.
|
|
|
|
|
|
## Goals
|
|
|
The main goal of this library is to provide a comprehensive configuration system solution.
|
|
|
This means:
|
|
|
+* Easy integration into existing code
|
|
|
* Great flexibility in API usage
|
|
|
* Full framework, no other libraries are required
|
|
|
-* Easy integration into existing code
|
|
|
+* Works in both client and server environment
|
|
|
|
|
|
## Setup
|
|
|
[](https://jitpack.io/#com.gitlab.Lortseam/completeconfig)
|
|
@@ -24,17 +25,18 @@ Then add CompleteConfig as dependency:
|
|
|
dependencies {
|
|
|
...
|
|
|
|
|
|
- //This adds CompleteConfig and includes it in your mod's jar, so users don't have to install it
|
|
|
- //Replace Tag with the current version you can find above
|
|
|
+ // This adds CompleteConfig and includes it in your mod's jar, so users don't have to install it
|
|
|
+ // Replace Tag with the current version you can find above
|
|
|
modApi 'com.gitlab.Lortseam:completeconfig:Tag'
|
|
|
include 'com.gitlab.Lortseam:completeconfig:Tag'
|
|
|
|
|
|
- //This bundles Cloth Config in your mod's jar which is required for CompleteConfig
|
|
|
- //Replace Version with current version
|
|
|
+ // This bundles Cloth Config in your mod's jar
|
|
|
+ // Only required if you want to display a GUI based on your mod's config and don't provide your own GUI generation
|
|
|
+ // Replace Version with the current version
|
|
|
include 'me.shedaniel.cloth:config-2:Version'
|
|
|
|
|
|
- //Recommended: Adds Mod Menu to your game, so you can easily open and check your config GUI (see the Mod Menu documentation for more information)
|
|
|
- //Replace Version with current version
|
|
|
+ // Recommended: Adds Mod Menu to your game, so you can easily open and check your config GUI (see the Mod Menu documentation for more information)
|
|
|
+ // Replace Version with current version
|
|
|
modImplementation 'io.github.prospector:modmenu:Version'
|
|
|
}
|
|
|
```
|