ConfigurationAPI

  • Standalone library (only SnakeYAML is required, this is already available for Spigot and BungeeCord plugins however)
  • Supports multiple storage types: JSON & YAML
  • Similar to the Bukkit Configuration API, no need to learn a complete new API
  • Support for Section Lists
  • Support for custom objects (see "Object Serialization")
For more information on how to use this library, see our README on GitHub.

ConfigurationAPI Logo

Maven

Add the following repository to your repositories:

<repository>
    <id>dieterblancke</id>
    <url>https://repo.dieterblancke.xyz/artifactory/dieterblancke-public/</url>
</repository>

After that, you can add the following dependency to your dependencies:

<dependency>
    <groupId>be.dieterblancke.configuration</groupId>
    <artifactId>ConfigurationAPI</artifactId>
    <version>2.0.3</version>
    <scope>compile</scope>
</dependency>

If you are going to compile the code in your JAR, it is heavily recommended to relocate it to avoid conflicts with other plugins:

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-shade-plugin</artifactId>
            <version>3.1.0</version>
            <configuration>
                <relocations>
                    <relocation>
                        <pattern>be.dieterblancke.configuration</pattern>
                        <!-- Replace the package below with your package -->
                        <shadedPattern>example.package.configuration</shadedPattern>
                    </relocation>
                </relocations>
            </configuration>
            <executions>
                <execution>
                    <phase>package</phase>
                    <goals>
                        <goal>shade</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>