3. Addon Configurations

Configuration files in addons

Addons support configuration files using Okaeri config, which is a powerful and easy-to-use configuration library.

Lombok is recommended for Java developers to reduce boilerplate code.

Java

MyConfig.java

@OkaeriConfigFile(fileName = "addon-config.yml")
@Getter @Setter
public class MyConfig extends AddonConfigFile {
    private String message = "Hello, from MyConfig!";
}

@Override
public void onAddonEnable() {
    MyConfig config = getAddonConfigManager().getConfig(MyConfig.class);
    getLogger().info(config.getMessage());
}

Kotlin

MyConfig.kt

@OkaeriConfigFile(fileName = "addon-config.yml")
class MyConfig : AddonConfigFile() {
    // Do not use 'val' for config keys!
    var message = "Hello, from MyConfig!"
}

override fun onAddonEnable() {
    val config = addonConfigManager.getConfig(MyConfig::class.java)
    logger.info(config.message)
}