readme.md

EZConf4j

What is it ?

It's the simplest way to create configs files !

Usage:

First create a new package. You are going to place all your config class inside the package. For this example, we are going to use xyz.tbvns.Example.configs.

Warning

Every class implementing Config inside this package will be registered as config files.

Then create a config class inside this new package:

public class Conf implements Config {
    static String wowAString = "OMG a string";
    public static List<Integer> omgAnIntList = new ArrayList<>(){{
        add(1);
        add(2);
        add(3);
    }};
    public static HashMap<String, Integer> HelloWorld = new HashMap<>(){{
       put("Hello", 1);
       put("World", 2);
    }};
}

then register the class and load the config file:

public class Test {
    public static void main(String[] args) throws Exception {
        //You should create a package with only configs
        EZConfig.registerClassPath("xyz.tbvns.Example.configs");
        
        EZConfig.load(); //Load the config files
     // EZConfig.save(); //Save the config files
        
        System.out.println(Conf.HelloWorld.get("Hello"));
    }
}

And that's it ! You have a fully working config file. It should look like this:

{
  "wowAString": "OMG a string",
  "omgAnIntList": [
    1,
    2,
    3
  ],
  "HelloWorld": {
    "Hello": 1,
    "World": 2
  }
}

If you need you can change the config folder name using EZConfig.setConfigFolderName("<Insert name here>");

Use it in your project:

First, add JitPack to your repo:

Maven

<repository>
    <id>jitpack.io</id>
    <url>https://jitpack.io</url>
</repository>

Gradle

dependencyResolutionManagement {
	repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
	repositories {
		mavenCentral()
		maven { url 'https://jitpack.io' }
	}
}

---

then add the dependency:

Maven

<dependency>
    <groupId>com.github.tbvns</groupId>
    <artifactId>EZConf4j</artifactId>
    <version>-SNAPSHOT</version>
</dependency>

Gradle

dependencies {
        implementation 'com.github.tbvns:EZConf4j:-SNAPSHOT'
}

Support me: