org.spongepowered.api.config

Interface ConfigManager

public interface ConfigManager

Provides configuration for plugins.

Plugins can choose between two places to store their configuration:

• A shared configuration folder, which is preferred for plugins with little configuration. These plugins can simply use plugin_id.conf.
• A configuration folder specific for the plugin, which is preferred for plugins with a lot of configuration data.

In either case, a "default configuration file" is provided in both scenarios. It is not required that plugins use this, but it does ensure consistency.

Call either getSharedConfig(Object) or getPluginConfig(Object) to get an object that represents one of the two outlined choices.

Method Summary

Modifier and Type	Method and Description
ConfigRoot	getPluginConfig(Object instance) Gets the configuration root for a plugin that utilizes a configuration folder specific to the plugin, which may also be a su-directory of the shared configuration folder.
ConfigRoot	getSharedConfig(Object instance) Gets the configuration root for a plugin that utilizes the shared configuration folder.

Method Detail

getSharedConfig

ConfigRoot getSharedConfig(Object instance)

Gets the configuration root for a plugin that utilizes the shared configuration folder.

The shared configuration folder may refer to "config/" but this may vary between implementations and configurations.

The plugin parameter is used to determine the filename for ConfigRoot.getConfigPath().

Parameters:

instance - The plugin instance

Returns:

A shared configuration root

getPluginConfig

ConfigRoot getPluginConfig(Object instance)

Gets the configuration root for a plugin that utilizes a configuration folder specific to the plugin, which may also be a su-directory of the shared configuration folder.

The provided plugin is used to determine the folder name.

Parameters:

instance - The plugin instance

Returns:

A plugin-specific configuration root