# Overview

## TL;DR:

Need to quickly understand the ScrimBot commands? Here is a summary:

The use of **<>** details a required field, and the user of **\[]** details an optional field.

**ScrimBot:**

| Command                            | Usage                                                                                                                                                                     |
| ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **USER COMMANDS:**                 |                                                                                                                                                                           |
| -gameid <4 digit gameid>           | <p>Adds your GameID to the current game.</p><p>To fix your GameID if you get it wrong, simply retype the command with the correct GameID!</p>                             |
|                                    |                                                                                                                                                                           |
| **SCRIM HOST COMMANDS:**           |                                                                                                                                                                           |
| -newscrim \<game type> \<scored>   | Starts a new scrim. Valid types are **solo**, **duo** or **squad**. Unless you are on Scrimbot Premium, you must respond with "no" when asked if you want a scored scrim. |
| -newgame                           | Starts a new game in the current scrim.                                                                                                                                   |
| -endscrim                          | Ends the current scrim (stops data collection).                                                                                                                           |
|                                    |                                                                                                                                                                           |
| **ADMIN COMMANDS:**                |                                                                                                                                                                           |
| -gather                            | Moves all members with the captain role (if specified) to your voice channel.                                                                                             |
| -purge \<number between 1 and 100> | Purges all non-pinned messages up to the specified amount.-                                                                                                               |

**ScrimBot Premium:**\
(Check the ScrimBot Premium section of the wiki for more info on these commands).\
All commands here are in addition to the commands listed above.

| Command                                      | Usage                                                                                                                                                                    |
| -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **USER (GENERAL) COMMANDS:**                 |                                                                                                                                                                          |
| -placement \<placement> \[kills]             | <p>Adds your placement info for the current game.</p><p>To fix your placement if you get it wrong, simply retype the command with the correct placement information!</p> |
|                                              |                                                                                                                                                                          |
| **USER (DUO TEAM MANAGEMENT) COMMANDS:**     | Commands with an **\*** indicate you must be captain of your duo team.                                                                                                   |
| -createduo \<team name>                      | Creates a new duo team with the given name (do not include the <>).                                                                                                      |
| -inviteduo \<player name>                    | Adds a player to your duo team (if they are not already in a duo team). **\***                                                                                           |
| -kickduo \<player name>                      | Kicks a player from your duo team. **\***                                                                                                                                |
| -leaveduo                                    | Removes you from your current duo team.                                                                                                                                  |
| -changeduoname \<new name>                   | Changes the name of your duo team. **\***                                                                                                                                |
| -transfercaptainduo \<new captain>           | Transfers captain from you to the specified player. **\***                                                                                                               |
| -duoinfo \[team name]                        | Shows who is in your duo team (or optionally, who is in the team you specified).                                                                                         |
|                                              |                                                                                                                                                                          |
| **SCRIM HOST COMMANDS:**                     |                                                                                                                                                                          |
| -leaderboard \<type>                         | Shows an up-to-date leaderboard of the specified type.                                                                                                                   |
|                                              |                                                                                                                                                                          |
| **ADMIN COMMANDS:**                          |                                                                                                                                                                          |
| -changesoloscore \<player name> \<new score> | Changes the score of the specified player to the specified value.                                                                                                        |
| -changeduoscore \<team name> \<new score>    | Changes the score of the specified duo team to the specified value.                                                                                                      |
| -changesquadscore \<team name> \<new score>  | Changes the score of the specified squad team to the specified value.                                                                                                    |
| -deleteundefined                             | (Experimental): deletes all undefined players from all the leaderboards.                                                                                                 |
| -resetleaderboard \<type>                    | Completely resets the specified leaderboard. **Irreversible.**                                                                                                           |
| -showallduoinfo                              | (Experimental): displays all duo teams and members.                                                                                                                      |

## User Commands:

These commands can be used by anyone.

* To add your GameID, use the **-GameID** command:

{% content-ref url="adding-your-gameid" %}
[adding-your-gameid](https://scrimbot.gitbook.io/project/using-scrimbot/adding-your-gameid)
{% endcontent-ref %}

* To fix your GameID, use the **-FixGameID** command:

{% content-ref url="broken-reference" %}
[Broken link](https://scrimbot.gitbook.io/project/using-scrimbot/broken-reference)
{% endcontent-ref %}

* To add your placement, use the **-Placement** command:\
  \&#xNAN;*The placement command is a Premium feature!*

{% content-ref url="../scrimbot-premium/adding-your-placement" %}
[adding-your-placement](https://scrimbot.gitbook.io/project/scrimbot-premium/adding-your-placement)
{% endcontent-ref %}

## Scrim Host Commands:

These commands can be used by anyone with the "Manage Server" permission or those who have a role that includes the words "Scrim Host".

* If this is your first time using ScrimBot, you should read the following page which outlines how Scrims operate:

{% content-ref url="scrim-structure" %}
[scrim-structure](https://scrimbot.gitbook.io/project/using-scrimbot/scrim-structure)
{% endcontent-ref %}

* To start a new scrim, use the **-NewScrim** command:

{% content-ref url="starting-a-new-scrim" %}
[starting-a-new-scrim](https://scrimbot.gitbook.io/project/using-scrimbot/starting-a-new-scrim)
{% endcontent-ref %}

* To start a new game, use the **-NewGame** command:

{% content-ref url="starting-a-new-game" %}
[starting-a-new-game](https://scrimbot.gitbook.io/project/using-scrimbot/starting-a-new-game)
{% endcontent-ref %}

* To end a scrim, use the **-EndScrim** command:

{% content-ref url="ending-a-scrim" %}
[ending-a-scrim](https://scrimbot.gitbook.io/project/using-scrimbot/ending-a-scrim)
{% endcontent-ref %}

* To generate the most up-to-date leaderboard, use the **-Leaderboard** command:\
  \&#xNAN;*The leaderboard command is a Premium feature!*

{% content-ref url="../scrimbot-premium/generating-the-leaderboard" %}
[generating-the-leaderboard](https://scrimbot.gitbook.io/project/scrimbot-premium/generating-the-leaderboard)
{% endcontent-ref %}