Setup

This page shows in steps what to do once you add Wick to your server. Keep in mind that some things are not accessible to free Wick users.

TLDR;

Before anything, this won't setup everything, so you should continue checking out the setup below this hint if you want to ensure proper setup (especially if you value your server a lot)!

  1. Save the Rescue Key sent to you in dms somewhere safe.

  2. Place Wick's role properly. Put it above roles you want monitored (preferably, at the top to avoid any problems)

  3. Send w!setup and let Wick automatically setup it's things automatically (if you had previous data, it will consider it).

  4. Place Quarantine role right below Wick's role. Place Muted role above your members and under your admins.

  5. Whitelist users, roles, channels, categories, webhooks and invites using the w!whitelist command [Command Documentation]

  6. Enable/Disable Systems you want, Wick's Systems Setup

Welcoming Message

As soon as you add Wick to your server, it will send you a DM containing important information. The welcoming message refers to many things you should be aware of, the most important being the Rescue Key.

Rescue Key:

The rescue key is used when you no longer have access to the owner account and you can no longer control Wick. This is a new feature to help you recover your server from Wick. Keep the rescue key safe and do NOT share it!

You'll recieve a very detailed message! You should really give it a read :)

MIGRATING FROM V2 TO V3

A notice will be sent out containing the new version release information. There will also be a Rescue Key attached to it. Everything else above will also be included.

Sort Wick's role

Adding Wick will also add a new role specifically made for him. If you do not find such a role, it's advised that you kick and re-add the bot without removing all permissions from it. This role is exclusive and essential for Wick's functioning. Please place Wick's role above the roles you want monitored, we suggest at the top.

You can place it above the roles you want to keep an eye on (this may not be the top). The roles above are immune from all actions of Wick. This may defeat Wick's purpose of security.

If Wick is not properly placed, it is your responsibility if it fails to take action during an unwanted incident.

Launch Wick's Quick Setup

Wick comes with a very simple setup command that will help you easily setup the main things Wick needs. Simply type in w!setup in your server It will setup the roles and channels and will also point out any missing requirements. Once fixed, Rerun the command and Wick will complete setup.

It'll inform you once it completes its setup

If you manually set up the muted role, quarantine role and logging channels using the w!statics command, you can run the w!setup commands afterwards to help you fully set it up. A note to PRE-V3 Wick users: Wick will not create new roles/channels unless there is no way to identify them. If you have a role named Muted or another role named Unverified/Quarantine, Wick will consider it instead of creating a new one, same for logging channels.

Sort Essential Roles

Once the setup is done, you'll notice that Wick has created two roles in your server. Muted and Quarantine.

  • Muted: This is the role Wick uses to punish regular users that trigger Wick in your server. This role makes them unable to send messages in your server until that role is gone. This role does nothing to your admins as they have higher permissions. Please place this role above all regular roles!

  • Quarantine: This is the most important role Wick uses. This role is used by Wick to combat nukes, malicious bot additions, self-bots and other manipulations. Please place this role right under Wick.

This is the ideal working scenario for Wick

Wick will not work at all without these two roles setup!!!

Statics Setup

The statics command is used to define important variables for Wick such as the admin role, the muted and quarantine channel etc. These are the components that stay static in your server for a while. It's mostly a one time setup if you are using custom roles and channel names.

The setup command does this for us by making the channels and roles with the adequate permissions. A user can do this themselves manually through this statics command. The command comes with 3 pages that cover Roles, Channels and Users.

Executing w!statics will show your current server's settings:

Example of statics info of a server

How do I change something?

This command and all other setting commands come with a format of: w!command ELEMENT-TO-SET PARAMETERS

In the statics command output shown above, you can notice each element associated with a number next to it, For example, The mute role part has number [1] next to it. That's called the target number.

ELEMENT is what you plan on setting/adding/deleting and PARAMETER is one of the ?set/?add/?del methods to use.

Example:

w!statics @mute-role ?set 1 statics: the actual command. @mute-role/mute-role: the ELEMENT you want to modify. In the case, a role. ?set: the PARAMETER you want. Since we want to set @mute-role as the mute role. 1: the TARGET number which refers to the Mute Role part.

Let's set up the Admins role in Wick so that they can use Wick's moderation commands. Type out w!statics @admins-role ?set 3 to set @admins-role as the Admin Role (3).

Note : The role can be mentioned with @ or it can also be used without mentioning it.

A component can take in multiple elements such as the Trusted Admins, this is where you use the ?add and ?del parameters. For example, [10] Trusted Admins part accepts 3 users. Using the ?set parameter will overwrite the current set admins with the new values, using ?add, will add the element to that component.

Example:

w!statics fnaki ?add 10 > This will add fnaki to [10] Trusted Admins! w!statics fnaki, katemoon ?del 11 -> This will delete both fnaki and katemoon from [11] Extra Owners! w!statics @AnotherModRole ?add 4 -> This will add role AnotherModRole to [4] Moderator Role! and so on...

WARNING! WARNING! WARNING!

  1. Trusted Admins: Trusted Admins are totally immune from Wick. Wick will never punish nor track what they do. They are able to change most of Wick's settings like the owner. We do not recommend adding Trusted Admins. Add them at your own risk.

  2. Extra Owners: Extra owners are treated as the owner. They can pretty much use all of Wick, modify all settings that can be changed, and are totally immune. Please do not add Extra Owners unless absolutely necessary!

Whitelist Setup

It is important to whitelist key roles and channels during the Wick setup phase. Wick's whitelist is split into 5 categories: Note : The number beside them refer to their parameter.

  • [1] Spam Whitelist: Elements whitelisted regarding spam will make them immune from Wick's anti-spam filters.

  • [2] Ping Whitelist: Elements whitelisted regarding mention-spamming will make Wick completely ignore them if they make mentions.

  • [3] Advertising Whitelist: Elements whitelisted regarding Advertising are safe when they post Discord Invite Links. You can also whitelist Invite Links you want. These are helpful for partner roles and channels.

  • [4] Quarantine Whitelist: Users that are whitelisted here can mess around with users that have the Quarantine Role without facing any punishments from Wick.

  • [5] Public Roles Mentioning Whitelist: Elements whitelisted can mention @everyone or @here or any other public roles without any reprimand.

Notice that here Elements mean:

  • Whitelisted User/Webhook

  • A user/webhook with a Whitelisted Role

  • A user/webhook in a Whitelisted Channel

  • A user/webhook in a Whitelisted Category

  • Whitelisted Invite Link posted somewhere. (only related to the Advertising Whitelist)

Whitelist & Whitelist-Remove

Whitelisting follows the same format as the other commands w!whitelist ELEMENT PARAMETER For an example, I'm going to whitelist user Mobilfan regarding spamming because I trust him. I'll send w!whitelist mobilfan ?add 1and that's it!

Here are some more examples on how to use the whitelist commands:

Example:

w!whitelist mobilfan ?add 2 -> This will add mobilfan to [2] Ping Whitelist making him safe when mentioning or spam-mentioning. w!whitelist #general ?add 1 -> This will add the channel general to [1] Spam Whitelist w!whitelist SpookyHook ?del 5 -> This will delete the webhook that comes with the name SpookyHook from the [5] Public Roles Mentioning Whitelist w!whitelist 8C972nY ?add 3 -> This will add the Invite Link 8C972nY to [3] Advertising Whitelist. and so on..

In case you didn't notice, you do not have to specify the element name or type of element while whitelisting. This will allow you to whitelist stuff faster and easier. you don't have to specify the type of the element you are whitelisting. Wick will automatically figure it out on it's own. This way, you can whitelist stuff faster and easily.

Whitelisting users give them the ability to freely perform some action which may include Spamming, advertising, pinging etc. For example, Spam-Whitelisted Users are capable of spamming wherever they want and whenever they want.

Quarantine Whitelist Warning:

We do NOT recommend whitelisting users when it comes to the quarantine. These whitelisted users can actually bypass Wick's anti nuke and verification or allow others to bypass it.

Wick's Systems Setup

Now that you are done with Statics and whitelist. Here comes the juicy stuff.

Anti-Nuke Settings

One of Wick's main features is its anti nuke. This component can also be customized according to user preferences i.e. you can set up the anti-nuke specifically for your server. To view and edit the anti nuke main settings, use the command w!antinuke

This introduces two things. Enabled/Disabled and also letters.

  1. Letters are basically the sub-options. The numbers are the main categories while the letters depict the sub categories. You can't have a letter without having a number before it! In the picture above, to change the "Interval: Every 1d" part, we will first need the category identifier which is 3 then we need the letter representing that particular setting which is C making the target look like 3C.

  2. We talked about the ?set/?add/?del keys before. But what do we use to enable and disable parts? To enable and disable specific settings, we use the ?on and ?off parameters. These are additional parameters like ?set/?add/?del.

    Anything that can be disabled/enabled has a slightly different format to use!

Example:

w!antinuke 5d ?set 3c -> This would set [C] Interval of [3] Imaging (Backups) to 5 days!

w!antinuke 1 ?off -> This would disable [1] Status

w!antinuke 2b ?off -> This would disable [B] Restore System of [2] Panic Mode

w!antinuke 5b ?on -> This would enable [B] Strict Mode of [5] Quarantine Hold

and so on..

Anti-Nuke CAP

The anti nuke comes with certain filters (triggers) that have an hour and minute cap. This implies that Wick will keep track of their per minute and per hour activity. If an admin tries to bypass the minute filter by staying just under the limit, the hour filter will trigger. This prevents any form of bypassing the system. To view and edit the anti nuke caps, use the command w!ancaps

These are all of the Anti-Nuke Caps that you can change.

The format of changing the CAP limits work the same as the previous commands

Example:

w!ancaps 2 ?set 5b -> This would set [B] Minute Cap of [5] Channel Deletions to 2

w!ancaps 6a ?off -> This would disable [A] Status of [6] Webhook Creations

w!ancaps 6 ?set 3c -> This would set [C] Hour Cap of [3] Role Deletions to 6

and so on.. [notice that ?add/?del parameters are unneeded here]

Panic Mode's Restore System

The anti nuke system has a restore component which works like the Windows \ System Restore or Restore Point. Wick will take a snippet/backup of your server and store it persistently. When a nuke attempt happens, Wick resorts to loading the latest Image that was stored. Wick will wipe out all traces of the nuke attempt and will restore all things lost -except messages and role assignments- You can use w!anrestore's command to view the restore filters and also enable/disable them:

Note : Role assignments are different from the actual roles in your server.

Same format applies when try to enable/disable these filters!

Example:

w!anrestore 1 ?off -> This would disable [1] Dangerous-Permissions Role Stripping

and so on...

Heat System Settings

The concept of the heat system works like overheating guns due to rapid firing..

Everything message-wise is heat related. Each filter produces a certain percentage of heat. 100% total heat is what triggers Wick. Heat drops with time. The working and concept of heat system is further discussed in the overview section of the docs

To view the main settings of the heat system, use the command w!heat

Main Page of the heat system
Heat System Filters with pages!

The commands follow the same structure here as well, the categories and sub categories are labelled with identifiers.

Verification Settings

Wick comes with a verification system that are tough on scripts to bypass. Use the command w!verification to change everything about the verification system.

The command also uses the same format shown above! Pretty convenient I know.

Join Gate Settings

Join Gate is an essential system made for filtering out users when they join your server. It helps to deal with users that have no avatars, have advertising usernames or have new accounts. Use the command w!joingate

Join Raid Settings

Join Raid is another essential system made for users that join your server. It will monitor the behavior of joins and their frequency. If it notices any raid-like behavior, it will trigger. Use the command w!joinraid

The End

This will conclude the full setup for Wick. The major commands such as moderation commands are fully explained with all of their parameters in the commands section.

If you are still facing any problems or have any misunderstandings or doubts regarding Wick, feel free to join the Wick discord support server and ask your queries. We would be glad to help.