Skip to main content

Module: Antinuke

Configure your server’s antinuke protections
To fully protect your server, we urge you to read this whole page thoroughly

​
How does it work?

    The antinuke works via threshold. If the perpetrator crosses x in a certain time frame, x being the threshold you set, they will be punished. Custom punishments may be set for every trigger, in which you can ban, kick, stripstaff or jail the user attemping to harm your server.

    ​
    Protection Guides

      You may prevent bot joins inside your server with the following command
      To add a bot to the server, the inviter and bot must be antinuke whitelisted
      ,antinuke botadd (on/off) (parameters)

      To prevent mass banning, execute the following command
      ,antinuke ban (on/off) (parameters)

      To prevent mass member kicking, execute the following command
      ,antinuke kick (on/off) (parameters)

      You may prevent mass role deletion inside your server with the following command
      ,antinuke roledeletion (on/off) (parameters)

      To prevent dangerous roles or permissions being given, execute the following command
      This will prevent dangerous roles and dangerous permissions being given out.
      ,antinuke permissions (on/off) (parameters)

      To prevent channels being mass deleted, execute the following command
      ,antinuke channeldeletion (on/off) (parameters)

      To prevent malicious webhooks, execute the following command
      This will watch for mass creations and deletions
      ,antinuke webhooks (on/off) (parameters)

      You may prevent mass role creation inside your server with the following command
      ,antinuke rolecreation (on/off) (parameters)

      To prevent mass channel creation, execute the following command
      ,antinuke channelcreation (on/off) (parameters)

      To prevent malicious server changes, execute the following command
      kyos will revert most server changes, however, things such as vanity and icons cannot be reverted automatically
      ,antinuke server (on/off) (parameters)

      To punish those mass pinging, execute the following command
      To block it before even being sent, we recommend your configure your server’s built-in Discord automod
      ,antinuke mention (on/off) (parameters)

      ​
      User Management Guide

      To add antinuke admins, or whitelist users, follow this guide.

      ​
      Adding an antinuke admin

        To add a user as an antinuke admin, execute the antinuke admin command
        To remove an antinuke admin, re-execute the command.
        ,antinuke admin (member)

        ​
        Whitelisting a user from the antinuke

          To whitelist a user from the antinuke, execute the antinuke unwhitelist command
          To unwhitelist a user, do antinuke unwhitelist (user)
          ,antinuke whitelist (user)

          ​
          Viewing the antinuke admins

            View the antinuke admins
            Only the server owner may use this command
            ,antinuke admins

            ​
            Viewing the antinuke whitelisted users

              View the antinuke whitelisted users 
              ,antinuke whitelisted

              ​
              Parameters

                You may use the following flags across the antinuke to configure each module
                NOTE: Some modules may not support the --threshold or --command parameter. However, we urge you to use the --command on flag where applicable.
                A threshold is the number of times somebody can do an action before triggering the antinuke.
                --threshold (digit)
                The punishment kyos will initiate once a user triggers the antinuke.

                ​
                Available punishments

                • ban - Bans the user from the server
                • kick - Kicks the user from the server
                • stripstaff - Removes a users roles
                • jail - Jails the user
                --do (punishment)
                Dictates whether commands should contribute towards the threshold (eg. kick)
                --command (on/off)

                ​
                Antinuke admins

                  Only give this to trusted administrators
                  Ensure you trust your antinuke admins as a server owner, kyos will not take action on them.
                  Antinuke admins may do the following:
                  1. Edit thresholds
                  2. Configure triggers (such as disabling massban protection)
                  3. Hardban users (visit help hardban)
                  4. View your antinuke Configuration
                  5. Whitelist users from the antinuke (resulting in kyos not taking action against them)
                  They may not do the following:
                  1. Disable or enable your antinuke
                  2. Add other antinuke admins
                  3. View the antinuke admins