Skip to content

HyperSkys/Configurator

Repository files navigation

Configurator Library

Java GitHub GitHub Discord

Configurator is a universal configuration library.

Download Instructions

You can download Configurator and use it on your projects by heading to the releases tab and downloading the latest release available, if you download a beta releasing you agree that any bugs that occur are expected.

API Introduction

Here is an example of making a configuration file for your plugin, it is really this simple.

public static Configuration configFile = new Configuration("config.yml");
public static String @GetValue(file = "config.yml", path = "Settings.prefix") prefix = "Default_Value";

@Override
public void onEnable() {
    Configurator.setupConfigurator(this);
    configFile.init();
}

Project Intergration

There are two major different types of ways of integrating this API into your project, below will list the way of integrating while using Maven and Gradle.

Maven

For maven please add these to your repositories and dependencies.

<repository>
  <id>jitpack.io</id>
  <url>https://jitpack.io</url>
</repository>
 <dependency>
    <groupId>com.github.HyperSkys</groupId>
    <artifactId>Configurator</artifactId>
    <version>LATEST_VERSION_HERE</version>
</dependency>

Gradle

For gradle add this to your repositories and dependencies.

maven { url 'https://jitpack.io' }
implementation 'com.github.HyperSkys:Configurator:LATEST_VERSION_HERE'

Discord

You can join my discord using this invite https://discord.gg/Y59DddqZZR please join the server if you have any issues or suggestions that you would like to make do not make random issues when you could just use the discord.

License

This project is licensed under Eclipse Public License