# Message Counter

## What is message counter?

> This module of apollo lets users track messages on their discord server. Apollo has a very customisable and advanced message tracking system. This module in any way does not track or store your messages in a database. You can also disable this command for yourself if you wish your messages not be counted by apollo.&#x20;

<figure><img src="https://1529724062-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMamhYDlJn583lofv3ZTW%2Fuploads%2FAWmPucHD0HZLazI64uBm%2Fimaaaaaaaaaaaaaaaae.png?alt=media&#x26;token=f4e4ce4d-106a-46bf-aa81-f67d89ae4c6c" alt=""><figcaption></figcaption></figure>

{% hint style="warning" %}
Message Counter is disabled by default for your server, use **a!messages enable** to start counting messages in the server.
{% endhint %}

## Subcommands for the Message Counter Module

### `a!messages (/messages)`

> This command shows the number of messages that has been sent by the user. You can also use this command to check the message sent by other users in the server too by using **a!messages {@user}** or by using **a!messages {userID}.**&#x20;

<figure><img src="https://1529724062-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMamhYDlJn583lofv3ZTW%2Fuploads%2FTrovW8n9sVsRYNyHXo7j%2Fimaaaaaaaaaaaaaaaae.png?alt=media&#x26;token=14ff6763-0453-408f-930a-d08667256a3a" alt=""><figcaption></figcaption></figure>

### Admin commands for the Claimtime Module

### `a!messages-admin <enable [or] disable>` / `/messages-admin <enable`` ``[or] disable>`

> This command helps to enable or disable the message counting feature in your server, and as mentioned above by default the message counter is off for the given server.

<figure><img src="https://1529724062-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMamhYDlJn583lofv3ZTW%2Fuploads%2Fr0ZtCnP30KafxfXuk1xS%2Fimage%20(8).webp?alt=media&#x26;token=a0c88a51-e4f0-4429-be3e-4d8910e21e04" alt=""><figcaption><p>command to enable the counter</p></figcaption></figure>

<figure><img src="https://1529724062-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMamhYDlJn583lofv3ZTW%2Fuploads%2FvErKSTemjwHeOHnebtSE%2Fimage%20(9).webp?alt=media&#x26;token=2badb7ee-0aa5-40f5-8ae3-11169830edc0" alt=""><figcaption><p>command to disable the counter</p></figcaption></figure>

### `a!messages-admin settings` / `/messages-admin settings`

#### *Blacklist Mode*

> In this mode, Apollo will blacklist the given channels where the messages will not be counted. But the messages in all the other channels will be counted as usual.

<figure><img src="https://1529724062-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMamhYDlJn583lofv3ZTW%2Fuploads%2FZUYBrNQosFpHJbEXUd0r%2Fimage.webp?alt=media&#x26;token=b81ce5e0-e34c-4582-a8f3-ef2a237f289a" alt=""><figcaption><p>select the dropdown and choose blacklist to enter blacklist mode</p></figcaption></figure>

<figure><img src="https://1529724062-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMamhYDlJn583lofv3ZTW%2Fuploads%2FvVK3T3SEuEy9ie97nmNU%2Fimage%20(1).webp?alt=media&#x26;token=42b0d2b5-270a-441f-984f-05013cbef6bb" alt=""><figcaption></figcaption></figure>

In the example shown above, we have set Apollo to ignore (blacklist) the **#rules** channel and any messages sent in that channel will not be counted. To add a channel to blacklist, just use the dropdown menu to select it.

#### *Whitelist Mode*

> In this mode, Apollo will whitelist the given channels where the messages will be counted. But the messages in all the other channels will not be counted.

<figure><img src="https://1529724062-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMamhYDlJn583lofv3ZTW%2Fuploads%2FZUYBrNQosFpHJbEXUd0r%2Fimage.webp?alt=media&#x26;token=b81ce5e0-e34c-4582-a8f3-ef2a237f289a" alt=""><figcaption><p>select the dropdown and choose blacklist to enter blacklist mode</p></figcaption></figure>

<figure><img src="https://1529724062-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMamhYDlJn583lofv3ZTW%2Fuploads%2FtI2b99FtBMKepdz6zg9P%2Fimage%20(2).webp?alt=media&#x26;token=e149085d-6acc-4f2b-9c36-814a93bffe4e" alt=""><figcaption></figcaption></figure>

In the example shown above, we have set Apollo to only count from the **#general** channel and any messages sent in that channel **only** be counted. To add a channel to whitelist, just use the dropdown menu to select it.

{% hint style="info" %}
You can add multiple channels to the blacklist or the whitelist.
{% endhint %}

### `a!messages-admin add` / `a!messages-admin remove`

> This command lets you add or removes messages for a particular user or yourself. Note that this feature can only used by administrators of a server.&#x20;

<figure><img src="https://1529724062-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMamhYDlJn583lofv3ZTW%2Fuploads%2FeOMOnHhjarjEf21vHWp2%2Fimage%20(3).webp?alt=media&#x26;token=6de84a6e-772c-4e99-9e6e-9e8d660363f2" alt=""><figcaption><p>bot has added 40 messages to user</p></figcaption></figure>

<figure><img src="https://1529724062-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMamhYDlJn583lofv3ZTW%2Fuploads%2FJcX5q9zmwR5b2thefj6K%2Fimage%20(4).webp?alt=media&#x26;token=00270ea7-813d-4be0-9d50-7d8f16df12c3" alt=""><figcaption><p>bot has removed 30 messages from the user</p></figcaption></figure>

{% hint style="warning" %}
Removing messages greater than the messages a user has will reset their message count back to **zero** and not any negative integer.
{% endhint %}

### `a!messages-admin reset`

This command allows you to reset the messages of a particular user in your server.

<figure><img src="https://1529724062-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMamhYDlJn583lofv3ZTW%2Fuploads%2FDuXKqSGPudbuqtzNLz0g%2Fimage%20(5).webp?alt=media&#x26;token=046bee8d-973e-4353-ab21-bedd0e7c3086" alt=""><figcaption><p>bot has successfully reset message count</p></figcaption></figure>

#### `a!messages-admin reset-all`

This command allows you to reset the messages of everyone in your server to **0**. The bot will ask for a confirmation before proceeding.

<figure><img src="https://1529724062-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMamhYDlJn583lofv3ZTW%2Fuploads%2Fafl6TAuSQIDfi69Ya8fy%2Fimage%20(6).webp?alt=media&#x26;token=f79983a7-05ee-4f43-95f3-602884f7ac78" alt="" width="357"><figcaption></figcaption></figure>

### `a!leaderboard` / `a!lb` / `/leaderboard`

This command shows the messages sent by everyone from greatest to the least. This command uses pagination so you can scroll through through multiple pages to check the message counts.

<figure><img src="https://1529724062-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMamhYDlJn583lofv3ZTW%2Fuploads%2Fvravt05nwqsFcZwuCG74%2Fimage%20(7).webp?alt=media&#x26;token=11062f93-7b57-4423-adff-e5d79c8e28e0" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
**Syntax usage:**

`<>` = Required argument (mandatory and must be included)

`[]` = Optional argument (not necessary to be included)
{% endhint %}
