Skip to content

Latest commit

 

History

History
58 lines (43 loc) · 1.82 KB

README.md

File metadata and controls

58 lines (43 loc) · 1.82 KB

ConfigKeys Build Status

ConfigKeys is a simple wrapper for zml's Configurate, providing a more stream-lined way to access configuration on-the-fly.

Using ConfigKeys

Using ConfigKeys is simple.

private static final ConfigKey<String> VERSION = ConfigKey.of("version");
private static final HoconConfigFile CONFIG = HoconConfigFile.load(Paths.get("").resolve("config.conf"));

public static String getVersion() {
    return VERSION.get(CONFIG);
}

Download

Latest Version: Maven Central

Replace VERSION key below with latest version shown in button above.

Maven

<dependency>
    <groupId>tech.ferus.util</groupId>
    <artifactId>ConfigKeys</artifactId>
    <version>VERSION</version>
</dependency>

Gradle

repositories {
    mavenCentral()
}

dependencies {
    compile 'tech.ferus.util:ConfigKeys:VERSION'
}

Builds are distributed using JCenter's Bintray ConfigKeys JCenter Bintray

Javadocs

Can be located here.

Discord

If you need assistance with or have any questions about ConfigKeys, join FerusTech's Discord server.

Dependencies

ConfigKeys requires Java 8.

Dependencies are managed automatically via Gradle. For a detailed list, view below.

Name Version Website Repository
FindBugs 3.0.2 http://findbugs.sourceforge.net/ https://github.com/findbugsproject/findbugs
Configurate 3.2 http://zml2008.github.io/ https://github.com/zml2008/configurate