+ Moderation in Zeppelin is multi-layered. On top of typical actions such + as warning, muting, kicking, and banning, Zeppelin allows moderators to + utilise flags; create alerts; set thresholds; and act as others. +
+
+ This guide explains the options available in the
+
+ Please ensure you understand how
+
- Moderation in Zeppelin is multi-layered, with 'typical' actions such as warning, muting, kicking, banning,
- etc. Featuring flags, moderation advances to allow for alerts, thresholds, acting as others, and the creation of
- cases for context (right-click) actions.
+ So that your moderators may use Zeppelin moderation, you must define the
+ moderator role Id in the config and assign it a level (50).
+
- This guide will be expanded in the future. For now it covers how to setup the
-
These first config options define how Zeppelin will interact with the users sanctioned.
+These config options define how Zeppelin will interact with the + members it sanctions (warns, kicks, bans).
- The values `dm_on_warn`, `dm_on_kick`, and `dm_on_ban` determine whether a user will be notified of their sanctions
- through DMs. Ignoring privacy settings, setting these to `true` will notify the user, and `false` keeps them in the
- dark. Note: `tempban` actions take the `ban` configuration.
+ The values dm_on_warn, dm_on_kick, and
+ dm_on_ban determine whether a member will be notified of
+ their sanctions through DMs. Ignoring privacy settings, setting these to
+ true will notify the member. Temporary banning uses the
+ ban configuration.
- The other set of notifying options `message_on_warn`, `message_on_kick`, and `message_on_ban` are similar to their
- `DM` counterparts, but, taking the value of `message_channel` they notify a channel instead. Note: `tempban` actions
- take the `ban` configuration.
+ An alternative way to notify members about sanctions is through
+ mentioning them in a message sent in a channel. To enable this feature,
+ set message_on_warn, message_on_kick, and
+ and message_on_ban to true (enabling them), then assign a
+ message_channel.
- Both of these notifying options take the same message templates defined in `warn_message`, `kick_message`, and
- `ban_message`. In the official documentation, you will see these written as one line, you can make the messages
- multi-line like so:
- warn_message, kick_message, and
+ ban_message. Please remember that YAML supports mutli-line
+ strings, this is how you can write newlines in your messages. Notably,
+ temporarily banning a member permits the inclusion of the
+ banTime variable through tempban_message.
- Alerts are a nifty way for your mod-team to be notified of actors trying to evade sanctions by leaving and
- re-joining your server. Define the channel in `alert_channel` and set `alert_on_rejoin` to `true`.
+ Alerts are a nifty way for moderators to be notified of members trying to
+ evade sanctions by promptly leaving and rejoining your server. To enable
+ this feature, assign a channel in alert_channel and enable
+ alert_on_rejoin.
- Thresholds are useful for alerting moderators if a user is about to exceed a pre-determined number of cases.
- This can be used to make your mod team consider whether harsher action is necessary. Define the threshold in
- `warn_notify_threshold`, adjust the message under `warn_notify_message`, and enable `warn_notify_enabled`.
+ Thresholds alert moderators if a member is about to exceed a
+ predetermined number of cases, prompting moderators to consider whether
+ alternative (harsher) action could be taken. To enable thresholds,
+ assign the threshold as warn_notify_threshold, adjust the
+ message under warn_notify_message, and enable
+ warn_notify_enabled.
+
+ Write your config cleverly, check the default values for
+ warn_notify_threshold and warn_notify_message,
+ if these are acceptable then all you need to do is enable
+ warn_notify_enabled.
- You can adjust the day's worth of messages Zeppelin deletes under the `ban_delete_message_days` option. Do not - append your input with 'd'. -
- -
- Before reading this, you should read the
- ban_delete_message_days option.