# Configuring ScrimBot

## Preparing your server for ScrimBot:

{% hint style="warning" %}
In order for ScrimBot to function correctly, it is imperative that you follow these instructions. 

Failure to do so will result in certain commands not working as intended, if at all.
{% endhint %}

ScrimBot requires the following:

1. Team Roles **must** be at the bottom of the role-list, under *any other roles given to users* (bot roles are fine). \<insert image><br>
2. The Captain role (if you have one) **must** be above all of the Team Roles.<br>
3. You *must* have at least one specific channel for GameID collection.

## The configuration process:

To begin, simply type the following command into a channel (preferably a hidden one, so users don't get spammed with messages).

```
-configure
```

This will bring up a message from ScrimBot informing you that you have started the configuration process.

### **Step 1: Confirm you have set the server up correctly.**

You will be prompted with a similar message to the one above, explaining the requirements of ScrimBot. If you have followed the instructions, respond with:

```
Yes
```

### **Step 2: Give the name of the "Captain" role.**

Most servers have a "Captain" role for team captains. The captain gathering command (described later) gathers all players with this role.&#x20;

If you have a Captain role, enter the **full name** of it. For example, if you had a role called *Captain*, you would respond like so:

```
Captain
```

{% hint style="info" %}
You do not need to @mention the role, so long as you respond with the full name.
{% endhint %}

### **Step 3: List the channels that the -gameID command is allowed in.**

In this step, you need to list the channels that the "-gameID" command is allowed in. It can be more than one channel, but you must have **at least** 1 channel for this purpose.

{% hint style="warning" %}
This channel will be dedicated purely for GameID collection, and all messages sent to this channel will automatically be deleted, even if they are not related to ScrimBot.
{% endhint %}

Simply enter the *full name* of the channels, one at a time, pressing enter after every channel. Once you have finished typing all the channels, type "finish".

For example, if you had the channels `solo-gamecodes`, `duo-gamecodes` and `squad-gamecodes`, you would enter the following:

```python
solo-gamecodes  ## press enter
duo-gamecodes   ## press enter
squad-gamecodes ## press enter
finish          ## press enter
```

{% hint style="info" %}
Like when adding the Captain Role, you do not need to #mention the channels, but you can if you wish.
{% endhint %}

## Finished!

{% hint style="success" %}
At this point, ScrimBot should inform you that the server has been properly configured.&#x20;

You are now able to use ScrimBot!
{% endhint %}