Configuration 🛠

You can specify a .yml config and register its options like this:

public static final Config CONFIG =
        Config.of("config.yml") // Format inferred from the file extension
                .version(1)
                .header("""
                        Example configuration file
                        Generated using Configured!
                        """);

public static final ConfigOption<String> NAME =
        CONFIG.optionOf("name", "John Smith")
                .description("Name of the user")
                .appendDefaultValue();

public static final ConfigOption<Integer> AGE =
        CONFIG.optionOf("age", 18)
                .description("Age of the user")
                .appendDefaultValue();

public static final ConfigOption<Boolean> STUDENT =
        CONFIG.optionOf("student", true)
                .description("Whether the user is a student or not")
                .appendDefaultValue();

public static void main(String[] args) {
    CONFIG.load();
}

Which will generate a config.yml file like this:

# Example configuration file
# Using "Configured"!

_version: 1

# Name of the user
# Default: John Smith
name: John Smith

# Age of the user
# Default: 18
age: 18

# Whether the user is a student or not
# Default: false
student: false

You can change the config format to JSONC (JSON with comments) just by changing the file extension to .jsonc:

Config.of("config.jsonc")
...

Which will generate a config.jsonc file like this:

{
  // Example configuration file
  // Using "Configured"!

  "_version": 1,

  // Name of the user
  // Default: John Smith
  "name": "John Smith",

  // Age of the user
  // Default: 18
  "age": 18,

  // Whether the user is a student or not
  // Default: false
  "student": false
}

You can then access/overwrite config values like this:

public static void main(String[] args) {
    CONFIG.load();
    String name = CONFIG.get(NAME);
    int age = CONFIG.get(AGE);
    boolean student = CONFIG.get(STUDENT);
    // Or overwrite them like:
    CONFIG.set(NAME, "Jane Doe");
    CONFIG.set(AGE, 20);
    CONFIG.reset(STUDENT);
    CONFIG.save(); // Don't forget to save afterward
}