kraftlin-config-paper/io.github.kraftlin.config.paper

Package-level declarations

io.github.kraftlin.config.paper.wrapConfig: Wraps a Paper plugin's data folder config.
io.github.kraftlin.config.paper.loadSqlConfiguration: Loads database settings from database.yml.
io.github.kraftlin.config.paper.AbstractBukkitConfig: Extends config with Paper-specific types like Material sets.

Types

AbstractBukkitConfig

abstract class AbstractBukkitConfig(configWrapper: AbstractConfig.ConfigWrapper) : AbstractConfig

Functions

loadSqlConfiguration

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

Loads a SqlConfiguration from database.yml in dataFolder.

fun loadSqlConfiguration(plugin: Plugin, saveDefault: Boolean = true): SqlConfiguration

Loads a SqlConfiguration from database.yml in the plugin data folder.

fun ~~wrapConfig~~(configPath: Path): AbstractConfig.ConfigWrapper

Wraps an arbitrary YAML file for use in AbstractConfig. This way, a plugin can support multiple configurations.

fun wrapConfig(plugin: Plugin, logger: Logger = Logger.getLogger("io.github.kraftlin.config")): AbstractConfig.ConfigWrapper

Wraps the default plugin config config.yml for use in AbstractConfig. This is the recommended approach when using a single configuration file only.