Help Center

Menu

Defining plugin configuration files

This section describes how to define configuration files for your plugin, allowing for more complicated configuration such as rules to be defined.

For simple key-value pair configuration keys see: Defining plugin configuration keys.

The PluginConfigFile.builder() method is used to define a configuration file in your PluginUtils.java.

...
    public final PluginConfigFile PLUGIN_CONFIG_FILE = PluginConfigFile.builder()
            .name("rules.json")
            .format("json")
            .label("Rules for configuring the plugin")
            .description("Use this configuration file to define rules that apply to specific URLs.")
            .build();
...