kraftlin-config-core/io.github.kraftlin.config

Package-level declarations

io.github.kraftlin.config.AbstractConfig: Base class for type-safe config declarations.
io.github.kraftlin.config.wrapConfig: Creates a config wrapper for a given file path.

Types

abstract class AbstractConfig

Base class for any plugin configuration to extend. It provides the config methods to create property delegates. Example usage:

ConfigException

class ConfigException(val path: Path, message: String, cause: Throwable? = null) : RuntimeException

Thrown when a configuration file cannot be loaded, parsed, or saved.

SqlConfiguration

data class SqlConfiguration(val url: String, val user: String, val password: String)

Access configuration for a database.

Functions

loadSqlConfiguration

fun loadSqlConfiguration(dataFolder: Path, saveDefault: Boolean = true): SqlConfiguration

Loads a SqlConfiguration from file, optionally storing a default example configuration if none exists.

fun wrapConfig(configPath: Path): AbstractConfig.ConfigWrapper

fun wrapConfig(configPath: Path, logger: Logger): AbstractConfig.ConfigWrapper

Wraps an arbitrary YAML file for use in AbstractConfig.