https://github.com/hyperskys/configurator

A universal configuration library.
https://github.com/hyperskys/configurator

configuration minecraft plugin yaml yaml-configuration

Last synced: about 16 hours ago
JSON representation

A universal configuration library.

• Host: GitHub
• URL: https://github.com/hyperskys/configurator
• Owner: HyperSkys
• License: epl-2.0
• Created: 2022-07-10T21:21:21.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-02-27T18:13:40.000Z (almost 2 years ago)
• Last Synced: 2025-01-29T19:53:57.466Z (7 days ago)
• Topics: configuration, minecraft, plugin, yaml, yaml-configuration
• Language: Java
• Homepage:
• Size: 60.5 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Configurator Library

![Java](https://img.shields.io/badge/java-%23ED8B00.svg?style=for-the-badge&logo=java&logoColor=white)

![GitHub](https://img.shields.io/github/languages/code-size/HyperSkys/Configurator?color=cyan&label=Size&labelColor=000000&logo=GitHub&style=for-the-badge)

![GitHub](https://img.shields.io/github/license/HyperSkys/Configurator?color=violet&logo=GitHub&labelColor=000000&style=for-the-badge)

![Discord](https://img.shields.io/discord/898154272636678196?color=5865F2&label=Discord&logo=Discord&labelColor=23272a&style=for-the-badge)

**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.

```java

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.

```

  jitpack.io

  https://jitpack.io

``` 

```

 

    com.github.HyperSkys

    Configurator

    LATEST_VERSION_HERE

```

-----------------------

#### 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](https://github.com/HyperSkys/Configurator/blob/main/LICENSE)