Plugin configuration
Most plugins in Zeppelin have configurable options. The values for these options come from 3 places:
-
Default options (from Zeppelin)
-
Custom options (set by you in config)
-
Overrides (conditional config values, see below)
Permissions are also just regular config options with a true/false value.
See the Permissions page for more info.
Information about each plugin's options can be found on the plugin's page, which can be accessed from the sidebar.
See the Configuration format page for an example of a full config.
Overrides
Overrides are the primary mechanism of changing options and permissions based on permission levels, roles,
channels, user ids, etc.
Click to see examples of different types of overrides
plugins:
example_plugin:
config:
can_kick: false
kick_message: "You have been kicked"
nested:
value: "Hello"
other_value: "Foo"
overrides:
# Simple permission level based override to allow kicking only for levels 50 and up
- level: '>=50'
config:
can_kick: true
nested:
# This only affects nested.other_value; nested.value is still "Hello"
other_value: "Bar"
# Channel override - don't allow kicking on the specified channel
- channel: "109672661671505920"
config:
can_kick: false
# Same as above, but for a full category
- category: "360735466737369109"
config:
can_kick: false
# Multiple channels. If any of them match, this override applies.
- channel: ["109672661671505920", "570714864285253677"]
config:
can_kick: false
# Match based on a role
- role: "172950000412655616"
config:
can_kick: false
# Match based on multiple roles. The user must have ALL roles mentioned here for this override to apply.
- role: ["172950000412655616", "172949857164722176"]
config:
can_kick: false
# Match on user id
- user: "106391128718245888"
config:
kick_message: "You have been kicked by Dragory"
# Match on multiple conditions
- channel: "109672661671505920"
role: "172950000412655616"
config:
can_kick: false
# Match on ANY of multiple conditions
- any:
- channel: "109672661671505920"
- role: "172950000412655616"
config:
can_kick: false
# Match on either of two complex conditions
- any:
- all:
- channel: "109672661671505920"
role: "172950000412655616"
- not:
role: "473085927053590538"
- channel: "534727637017559040"
role: "473086848831455234"
config:
can_kick: false
Default overrides
Many plugins have some overrides by default, usually for the default mod level (50) and/or the default admin level
(100). These are applied before any custom overrides in the config.
You can see the default overrides for each plugin by checking the Default configuration section
under the Configuration tab on the plugin's documentation page.
To replace a plugin's default overrides entirely, set replaceDefaultOverrides to true in
plugin options, on the same level as config and overrides. In the following example, any
default overrides the plugin had will no longer have an effect:
example_plugin:
config:
can_kick: false
replaceDefaultOverrides: true # <-- Here
overrides:
- level: ">=25"
config:
can_kick: true