   ____                _____          ____                    __  _
  / __/__ ____ __ __  / ___/__  ___  / _(_)__ ___ _________ _/ /_(_)__  ___
 / _// _ `(_-</ // / / /__/ _ \/ _ \/ _/ / _ `/ // / __/ _ `/ __/ / _ \/ _ \
/___/\_,_/___/\_, /  \___/\___/_//_/_//_/\_, /\_,_/_/  \_,_/\__/_/\___/_//_/
             /___/                      /___/

README LANGUAGES [ English | 中文 ]

EasyConfiguration

CodeSize

Easy (to make) Configurations!

A simple, easy-to-use and universal solution for managing configuration files. Enjoy the ease of use with customizable formats for loading, reading, and updating your configuration files.

Features & Advantages

Supported YAML, JSON, HOCON and SQL based configuration files format.

Class-based mechanism for initializing, loading, retrieving, and updating configuration files, ensuring convenience and efficiency.
Supports manual serialization and deserialization of complex configurations.
Offers multiple builder forms for rapid construction of ConfigValue<?> objects.
Enables specification of configuration paths, comments, and more via annotations.

Development

For the latest JavaDoc release, CLICK HERE.

For a detailed development guide, CLICK HERE.

Code Samples

To quickly demonstrate the applicability of the project, here are a few practical demonstrations:

Check out all code demonstrations HERE. For more examples, see the Development Guide.

@HeaderComment("Configurations for sample")
interface SampleConfig extends Configuration {

    @InlineComment("Enabled?") // Inline comment
    ConfiguredValue<Boolean> ENABLED = ConfiguredValue.of(true);

    ConfiguredList<UUID> UUIDS = ConfiguredList.builderOf(UUID.class).fromString()
            .parseValue(UUID::fromString).serializeValue(UUID::toString)
            .defaults(
                    UUID.fromString("00000000-0000-0000-0000-000000000000"),
                    UUID.fromString("00000000-0000-0000-0000-000000000001")
            ).build();

    interface INFO extends Configuration {

        @HeaderComment("Configure your name!") // Header comment
        ConfiguredValue<String> NAME = ConfiguredValue.of("Joker");

        @ConfigPath("year") // Custom path
        ConfiguredValue<Integer> AGE = ConfiguredValue.of(24);

    }
}

public class Sample {
  public static void main(String[] args) {
    // 1. Make a configuration provider from a file.
    ConfigurationProvider<?> provider = EasyConfiguration.from("config.yml");
    // 2. Initialize the configuration classes or instances.
    provider.initialize(SampleConfig.class);
    // 3. Enjoy using the configuration!
    SampleConfig.ENABLED.set(false);
    System.out.println("Your name is " + SampleConfig.INFO.NAME.getNotNull() + " !");
  }
}

# Configurations for sample

enabled: true # Enabled?

uuids:
  - 00000000-0000-0000-0000-000000000000
  - 00000000-0000-0000-0000-000000000001

info:
  # Configure your name!
  name: Joker
  year: 24

Dependencies

Maven Dependency

Remote Repository Configuration

```xml maven Maven Central https://repo1.maven.org/maven2 EasyConfiguration GitHub Packages https://maven.pkg.github.com/CarmJos/EasyConfiguration ```

Generic Native Dependency

```xml cc.carm.lib easyconfiguration-core [LATEST RELEASE] compile cc.carm.lib easyconfiguration-yaml [LATEST RELEASE] compile cc.carm.lib easyconfiguration-json [LATEST RELEASE] compile ```

Gradle Dependency

Remote Repository Configuration

```groovy repositories { // Using Maven Central Repository for secure and stable updates, though synchronization might be needed. mavenCentral() // Using GitHub dependencies for real-time updates, configuration required (recommended). maven { url 'https://maven.pkg.github.com/CarmJos/EasyConfiguration' } } ```

Generic Native Dependency

```groovy dependencies { // Basic implementation part, requiring custom implementation of “Provider” and “Wrapper”. api "cc.carm.lib:easyconfiguration-core:[LATEST RELEASE]" // YAML file-based implementation, compatible with all Java environments. api "cc.carm.lib:easyconfiguration-yaml:[LATEST RELEASE]" // JSON file-based implementation, compatible with all Java environments. Note: JSON does not support file comments. api "cc.carm.lib:easyconfiguration-json:[LATEST RELEASE]" } ```

Derived Projects

MineConfiguration (by @CarmJos)

EasyConfiguration for MineCraft! Easily manage configurations on MineCraft-related server platforms.

Currently supports BungeeCord, Bukkit (Spigot) servers, with more platforms to be supported soon.

Support and Donation

If you appreciate this plugin, consider supporting me with a donation!

Thank you for supporting open-source projects!

Many thanks to Jetbrains for kindly providing a license for us to work on this and other open-source projects.

Open Source License

This project's source code is licensed under the GNU LESSER GENERAL PUBLIC LICENSE.

CarmJos / EasyConfiguration

readme