# MT Status Bot

## What can the bot do

In brief the bot can do the following;

* Get MotorTown server status.
* Get player count for servers.
* Get total players playing MotorTown.

## Quick setup

{% stepper %}
{% step %}

#### Invite the bot

Open a ticket on our discord server and request access to this bot
{% endstep %}

{% step %}
Use the <mark style="color:$warning;">/mt servers add</mark> <mark style="color:$warning;">`server:`</mark><mark style="color:purple;">`server-name`</mark> command and select a server from the list.

<div align="left"><figure><img src="https://3240897265-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCMf8TjcRclW7vjlT5xle%2Fuploads%2FffDCUnl8ndvV9lN7LaZQ%2Fmtstatusbot1.png?alt=media&#x26;token=b760fae3-4283-4497-9645-dc3c8a1bb1e2" alt="" width="309"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Set the channel which the status embed will be sent and updated\
To set the channel: <mark style="color:$warning;">/mt channel</mark> <mark style="color:$warning;">`channel:`</mark><mark style="color:purple;">`#channel`</mark>

<div align="left"><figure><img src="https://3240897265-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCMf8TjcRclW7vjlT5xle%2Fuploads%2FpqnJPMf9gLDlMmTsBQD8%2Fmtstatusbot2.png?alt=media&#x26;token=5827b1c9-f41e-4b72-955e-15b49c1ad20c" alt=""><figcaption></figcaption></figure></div>
{% endstep %}
{% endstepper %}

## Configuring the bot

{% hint style="warning" %}
DEFAULT PERMISSIONS

These commands by default will only be accessible by users with the administrator permission.
{% endhint %}

### Title

<mark style="color:blue;">Title</mark> - The title of the embed.\
To set the title: <mark style="color:$warning;">/mt embed title</mark><mark style="color:$warning;">`title:`</mark><mark style="color:purple;">`title-here`</mark>

<div align="left"><figure><img src="https://3240897265-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCMf8TjcRclW7vjlT5xle%2Fuploads%2Fq6F1dctzFggoJCBPmKrf%2Fmtstatusbottitle.png?alt=media&#x26;token=7762b06f-537b-4b7b-850a-c966d6d50031" alt=""><figcaption></figcaption></figure></div>

### Colour

<mark style="color:blue;">Colour</mark> - The color of the embed.\
To set the color: <mark style="color:$warning;">/mt embed colour</mark><mark style="color:$warning;">`colour:`</mark><mark style="color:purple;">`Hex-colour`</mark>

<div align="left"><figure><img src="https://3240897265-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCMf8TjcRclW7vjlT5xle%2Fuploads%2FQVRwrr7WCFbN4QhNfSxS%2Fmtstatusbotcolour.png?alt=media&#x26;token=2d5e0148-e1c2-4e48-b8ba-187b77f24174" alt=""><figcaption></figcaption></figure></div>

### Set channel

<mark style="color:blue;">Channel</mark> - Set the channel where you want the embed to be\
To set the channel: <mark style="color:$warning;">/mt channel</mark> <mark style="color:$warning;">`channel:`</mark><mark style="color:purple;">`#channel`</mark>

<div align="left"><figure><img src="https://3240897265-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCMf8TjcRclW7vjlT5xle%2Fuploads%2Fr2va9zj8581gxWcwfzYE%2Fmtstatusbot2.png?alt=media&#x26;token=10c1d9e3-6d98-48a0-9056-bf3c592e59b4" alt=""><figcaption></figcaption></figure></div>

### Set embed info

<mark style="color:blue;">Set Embed Info</mark> - Icon, Global Players, Game Logo In Title.\
To show the embed settings: <mark style="color:$warning;">/mt info</mark>

<div align="left"><figure><img src="https://3240897265-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCMf8TjcRclW7vjlT5xle%2Fuploads%2Fs3GdPH3lHyC4sv7AjhRT%2Fmtstatusbotinfotypes.png?alt=media&#x26;token=c7de37a9-0e54-4c3b-95f4-ea16c99ede1b" alt=""><figcaption></figcaption></figure> <figure><img src="https://3240897265-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCMf8TjcRclW7vjlT5xle%2Fuploads%2FpijmUIoQ0C8O3SnvKAwR%2Fmtstatusbotinfo.png?alt=media&#x26;token=b92dbdb0-41d7-4230-9aac-55d18d9b1814" alt=""><figcaption></figcaption></figure></div>

<table><thead><tr><th width="68.050048828125">No.</th><th width="185">Info Type</th><th>Description</th></tr></thead><tbody><tr><td>1</td><td>Icon</td><td>Shows server icon in embed.</td></tr><tr><td>2</td><td>Global Players</td><td>Shows the number of players on MotorTown.</td></tr><tr><td>3</td><td>Game Logo In Title</td><td>Shows title in embed.</td></tr></tbody></table>

### Manage servers

<mark style="color:blue;">Add Server</mark> - Add a server to the embed.\
To add a server use: <mark style="color:$warning;">/mt servers add</mark> <mark style="color:$warning;">`server:`</mark><mark style="color:purple;">`server-name`</mark>

<div align="left"><figure><img src="https://3240897265-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCMf8TjcRclW7vjlT5xle%2Fuploads%2FR476MX8aPGSus2onQgW7%2Fmtstatusbotaddserver.png?alt=media&#x26;token=e6f92dfb-4c6c-4db4-b07d-def4bdb8ad47" alt=""><figcaption></figcaption></figure></div>

<mark style="color:blue;">Remove Server</mark> - Remove a server from the embed.\
To remove a server use: <mark style="color:$warning;">/mt servers remove</mark> <mark style="color:$warning;">`displayedserver:`</mark><mark style="color:purple;">`server-name`</mark>

<div align="left"><figure><img src="https://3240897265-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCMf8TjcRclW7vjlT5xle%2Fuploads%2FZfgG5zXCvJlvO3GIJayK%2Fmtstatusbotremoveserver.png?alt=media&#x26;token=9abcca13-42c4-4e21-815c-bcfc97788e21" alt=""><figcaption></figcaption></figure></div>

<mark style="color:blue;">List Servers</mark> - Shows current servers on embed.\
To show current servers use: <mark style="color:$warning;">/mt servers list</mark>

<div align="left"><figure><img src="https://3240897265-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCMf8TjcRclW7vjlT5xle%2Fuploads%2FW9dBG0voYNQZwSqceGzE%2Fmtstatusbotlistservers.png?alt=media&#x26;token=981cc901-5215-4a0d-8d4f-3ae7ad207b2b" alt=""><figcaption></figcaption></figure></div>

## Bot permissions

These are the bot's permissions:

* Read Messages/View Channels - Needed to read messages & view channels in server.
* Send Messages - Needed to send messages in server.
* Read Message History - Needed to read message history.