Skip to content

warn_module.md

Latest commit

 

History

History
64 lines (43 loc) · 2.3 KB

warn_module.md

File metadata and controls

64 lines (43 loc) · 2.3 KB

Warn Module

Back to the Summary.

Sources of the module

The warn module is used to give members warnings about their behaviour in the guild.

After a given amount of warns, the member gets muted if the mute module is enabled

Config

  • Sanctions (Boolean) (default = true)

    • Enables sanctions (mute and ban alert) when a member receives a warning.

  • MinimalWarnRole (Role) (default = nothing)

    • Minimal role to be able to warn members and see their histories
    • Unlocks warn and warnlist

  • MinimalUnwarnRole (Role) (default = nothing)

    • Minimal role to be able to unwarn a member.
    • Unlocks popwarn and clearwarn

  • WarnAmountToMute (Integer) (default = 3)

    • Number of warns needed to mute a member.

  • WarnAmountToBan (Integer) (default = 9)

    • Numbed of warns needed to send the ban alert to the moderators.

  • DefaultMuteDuration (Duration) (default = 1 hour)

    • Default mute duration when a member gets enough warnings.
    • The duration increases as the warning amount increases: duration = default_duration * (warnings / WarnAmountToMute)

  • BanInformationChannel (Channel) (default = nothing)

    • Channel where all the ban notifications are sent when a player has enough warnings
    • This setting is required to enable the module
    • You still have to manually ban the member, the last choice remains to the moderation team.

  • WarnLogChannel (Channel) (default = nothing)

    • Channel where all the notifications about warns and unwarns are logged.

  • SendPrivateMessage (Boolean) (default = true)

    • Enable private messages to inform the member of his warning.

Commands

Assuming the bot prefix is !

  • !warn <target> [reason]

    • This command gives a warning to the target with the given reason. It also checks if the member should receive a mute or more (only if the option is enabled).
    • If enabled, the member will receive a private message resuming the warning and where it comes from.
    • Example : !warn @SomePlayer You are a terrible liar

  • !warnlist <target>

    • Shows all the warnings that the given user received.
    • Example : !warnlist @SomePlayer

  • !clearwarns <target>

    • Clears all the history of the given member.
    • Example : !clearwarns @SomePlayer

  • !popwarns <target>

    • Removes the last warn of the targeted member