ez-cfg's Introduction

EZ-Cfg [Minecraft]

A Minecraft dev-Library for making work with configuration files easier and faster

Usage

The following example gives an example of usage (uses Lombok)

@Data
public class MySetting implements YamlConfigData<MySetting, MyPlugin> {
    // Required
    @NonNull private final MyPlugin plugin;

    @CfgField private String myString = "foo";
    @CfgField("IsSomeOptionEnabled") private boolean optionEnabled = true;

    // Complex objects
    @CfgField("holograms.Vector") private Vector hologramsVector = new Vector(0.0, 1.25, 0.0);
    @CfgField("holograms.IDs") private List<Integer> hologramsIds = Collections.emptyList();
}

Then load the values using any available method

MySetting setting = new MySetting().load();
// OR
MySetting setting = new MySetting().load(new File("path/to/File.yml"));
// OR
MySetting setting = new MySetting().load("path/to/File.yml");

Maven:

Due to this library using custom repositories it cannot be deployed to Maven Central so in order to use it you can use JitPack's repo:

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

<dependencies>
  ...
  <dependency>
    <groupId>com.github.JarvisCraft.EZ-Cfg</groupId>
    <artifactId>ez-cfg-spigot<!-- or ez-cfg-bungee --></artifactId>
    <version>-SNAPSHOT</version>
  </dependency>
  ...
<dependencies>

Recommend Projects