# ALPH4 Documentation

ALPH4 - A multi-purpose Discord Bot

#### Please select a module:

{% content-ref url="/pages/-McoxERSX6qbtGBnktNG" %}
[Moderation](/modules/moderation)
{% endcontent-ref %}

{% content-ref url="/pages/-McoxERTz48KMJJ9CbuO" %}
[Utility](/modules/utility)
{% endcontent-ref %}

{% content-ref url="/pages/-McoxERVy6XZfKNc3jEd" %}
[ModMail](/modules/modmail)
{% endcontent-ref %}

{% content-ref url="/pages/-McoxERUoBcrUS7YA-yr" %}
[Economy](/modules/economy)
{% endcontent-ref %}

{% content-ref url="/pages/-McoxERWOkeAu3iRHzK5" %}
[Welcome](/modules/welcome)
{% endcontent-ref %}

{% content-ref url="/pages/-McoxERXyzR-6809gQLz" %}
[Game](/modules/game)
{% endcontent-ref %}

{% hint style="info" %}
How to read arguments

* \<argument> - Required argument
* \[argument] - Optional argument
* \<choice1|choice2> - Required choice
* \[choice1|choice2] - Optional choice

**Do not include <> or \[] when typing your arguments**
{% endhint %}

### [Website](https://alph4.xyz)

### [Invite the bot](https://alph4.xyz/invite)


# Moderation

Secure your server with ALPH4's top level moderation features

![](https://604774950-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M4Yjoz58iWYeSizXRb5%2F-MRfm7QYGo-GyQ8tbpDd%2F-MRfmc10MalOLeUVe7Yo%2FModeration.png?alt=media\&token=24cd6931-cf13-4629-8ef7-650568490949)

## Main Commands

| Command                  | Description                                            |
| ------------------------ | ------------------------------------------------------ |
| /logs                    | Sets a log channel in your server                      |
| /ban \<user>             | Bans a user from your server                           |
| /unban \<user>           | Unbans a user from your server                         |
| /kick \<user>            | Kicks a user from your server                          |
| /mute \<user> \<time>    | Mutes the user in your server for a set amount of time |
| /clear \<amount> \[user] | Clears messages in a channel                           |

## AutoMod

| Command          | Description                 |
| ---------------- | --------------------------- |
| /automod         | Sets up AutoMod             |
| /automod status  | Check the status of AutoMod |
| /disable-automod | Disables AutoMod            |

{% hint style="info" %}
AutoMod consists of:

* Sending general links
* Sending Discord links
* Swearing
* Mass tagging
* Emoji spam
* Duplicate text
* Mass Capitals
* Anti Raid
* Decancer
* Anti Bad Name
  {% endhint %}

## Warning System

| Command                        | Description                                       |
| ------------------------------ | ------------------------------------------------- |
| /warn \<user> \<reason>        | Warns a user in your server                       |
| /warns \<user>                 | Checks the warnings for a specified user          |
| /clear-warning \<user> \<warn> | Clears the specified warns from the selected user |

{% hint style="info" %}
The warning message will be sent to the user in DMs
{% endhint %}

## Role Management

| Command                                 | Description                                 |
| --------------------------------------- | ------------------------------------------- |
| /roles add \<user> \<role>              | Adds a role to the specified user           |
| /roles remove \<user> \<role>           | Removes a role from the specified user      |
| /roles add-temp \<user> \<role> \<time> | Adds a temp role to the specified user      |
| /roles remove-temp \<user> \<role>      | Removes a temp role from the specified user |

## Other Commands

| Command                   | Description                                                  |
| ------------------------- | ------------------------------------------------------------ |
| /slowmode \<time>         | Sets a channel slowmode                                      |
| /lock \[time]             | Locks a channel preventing users from sending messages there |
| /unlock channel           | Unlocks a channel allowing users to send messages again      |
| /server-lockdown \[time]  | Locks down the entire server                                 |
| /unlock server            | Unlocks a server from lockdown                               |
| /nuke \<channel>          | Deletes a channel then recreates it with the same perms/name |
| /report \<user> \<reason> | Reports the specified user to the bot owners                 |
| /block                    | Blocks a channel from bot commands                           |
| /block-category           | Blocks a category from bot commands                          |


# Utility

Add some spice to your server with ALPH4's utilities

![](https://604774950-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M4Yjoz58iWYeSizXRb5%2Fuploads%2Fgit-blob-20bb96675bde175ca78ed3a09c4f39d5a6458acf%2Futility.png?alt=media)

## Featured

| Command                     | Description                               |
| --------------------------- | ----------------------------------------- |
| /remind \<time> \<reminder> | Sets a reminder for yourself              |
| /add-emoji \<emoji>         | Add emojis from other servers to your own |

{% hint style="warning" %}
The prefix can only be up to 3 characters long
{% endhint %}

## Reaction Roles

| Command                                         | Description                            |
| ----------------------------------------------- | -------------------------------------- |
| /reaction-roles create                          | Creates the reaction role panel        |
| /reaction-roles remove                          | Removes the reaction role panel        |
| /reaction-roles add \<message> \<emoji> \<role> | Adds a reaction role to a message      |
| /reaction-roles remove \<message> \<emoji>      | Removes a reaction role from a message |
| /reaction-roles list                            | Lists reaction roles for a message     |

## Giveaways

| Command                              | Description                       |
| ------------------------------------ | --------------------------------- |
| /giveaway \[winners] \[time] \[gift] | Sets up a giveaway in your server |
| /reroll \[message]                   | Rerolls the winner for a giveaway |
| /end-giveaway \[message]             | Ends a giveaway in your server    |

{% hint style="warning" %}
The maximum number of days a giveaway can last is 24 days due to Discord limits
{% endhint %}

## Youtube Feeds

| Command                         | Description                                  |
| ------------------------------- | -------------------------------------------- |
| /youtube add-feed \<channel>    | Sets automated Youtube feeds in your channel |
| /youtube remove-feed \<channel> | Stops a Youtube feed in your server          |

{% hint style="warning" %}
You can only set 2 Youtube feeds per server and 1 per channel
{% endhint %}

## Suggestion Commands

| Command                           | Description                                |
| --------------------------------- | ------------------------------------------ |
| /suggestion-channel \<channel>    | Sets the suggestion channel in your server |
| /suggest \<suggestion>            | Suggest something                          |
| /suggestion \<accept\|deny> \<id> | Accept or deny a suggestion by ID          |

{% hint style="info" %}
Suggestion IDs can be found on the suggestion message itself
{% endhint %}

## Search Commands

| Command           | Description                     |
| ----------------- | ------------------------------- |
| /google \<query>  | Searches Google                 |
| /youtube \<query> | Searches Youtube for a video    |
| /wiki \<query>    | Searches Wikipedia              |
| /giphy \<query>   | Searches for a GIF              |
| /github \<query>  | Searches for a Github account   |
| /discord \<query> | Searches Discord for support    |
| /twitter \<query> | Searches Twitter for an account |

## Server Commands

| Command               | Description                                        |
| --------------------- | -------------------------------------------------- |
| /invites leaderboard  | Invite leaderboard                                 |
| /ticket-system        | Sets up the ticketing system in your server        |
| /close-ticket         | Closes a ticket for the ticketing system           |
| /stop                 | Remove the ticket system                           |
| /invites bot          | Provides the bot invite                            |
| /nick \<user> \<name> | Sets the nickname of a user                        |
| /members              | Displays the total members in your server          |
| /info-roles           | Lists all the roles in your discord server         |
| /support              | Need any assistance with the bot? Use this command |

## Information Commands

| Command                  | Description                                  |
| ------------------------ | -------------------------------------------- |
| /info covid              | Displays the latest COVID19 Stats            |
| /weather \<city>         | Displays the weather in a specified location |
| /lyrics \<song>          | Provides the lyrics of a song                |
| /info boosters           | Lists all the boosters in your server        |
| /info channel \<channel> | Displays information about a channel         |
| /info role \<role>       | Displays information about a role            |
| /info user \<user>       | Provides information about a user profile    |
| /info server             | Displays information about your server       |
| /info emoji \<emoji>     | Displays information about an emoji          |
| /avatar \<user>          | Provides the avatar of a user                |

## Custom Commands

| Command                 | Description                |
| ----------------------- | -------------------------- |
| /custom-commands add    | Adds a custom command      |
| /custom-commands remove | Edits a custom command     |
| /custom-commands edit   | Removes a custom command   |
| /custom-commands list   | Lists your custom commands |

## Message Commands

| Command       | Description                |
| ------------- | -------------------------- |
| /send message | Sends a message as the bot |
| /send image   | Sends an image as the bot  |
| /send edit    | Edits the bots message     |


# Economy

Take part in the ALPH4 economy system and earn and compete with others across the world

![](https://604774950-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M4Yjoz58iWYeSizXRb5%2F-MRfm7QYGo-GyQ8tbpDd%2F-MRfmqrU5qBnOjQzWF8T%2FEconomy.png?alt=media\&token=88c726e2-179c-4e0a-9d6a-70b200fdc522)

## Main Commands

| Command                             | Description                     |
| ----------------------------------- | ------------------------------- |
| /economy leaderboard                | Displays the global leaderboard |
| /economy transfer \<user> \<amount> | Transfer coins to your friends  |
| /economy shop                       | Views the economy show          |

## Earn Coins

| Command                   | Description                       |
| ------------------------- | --------------------------------- |
| /economy work             | Work every 2 hours and earn coins |
| /economy collect          | Collect every hour and earn       |
| /economy roll             | Roll a die every 5 seconds        |
| /economy crime            | Take a risk and commit a crime    |
| /economy gamble \<amount> | Take your chances and gamble      |
| /economy rob \<user>      | Rob someone's bank                |
| /economy daily            | Earn every day                    |
| /economy weekly           | Earn every week                   |
| /economy monthly          | Earn every month                  |
| /economy beg              | Beg someone for money             |

## Manage Your Balance

| Command                     | Description                                |
| --------------------------- | ------------------------------------------ |
| /economy balance            | View your current balance                  |
| /economy withdraw \<amount> | Withdraw a specified amount from your bank |
| /economy deposit \<amount>  | Deposit a specified amount                 |


# ModMail

Provide support with poeple in your server

![](https://604774950-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M4Yjoz58iWYeSizXRb5%2Fuploads%2Fgit-blob-daf07c7841be5c261c35ac3dd147e9d6ff718e1d%2Fmodmail.png?alt=media)

## Commands

| Command                      | Description                                    |
| ---------------------------- | ---------------------------------------------- |
| /modmail enable              | Enables ModMail in your server                 |
| /modmail close \[duration]   | Closes a ModMail thread                        |
| /modmail open-thread \<user> | Opens a ModMail thread with the specified user |
| /modmail alert               | Alerts you when the user replies               |

{% hint style="info" %}
The Modmail process is simple, when typing /modmail in your server, your server will be added to the bot's database and will appear on the list when a user DMs the bot. DMing the bot the user will have the opportunity to select the server they would like to contact, each number corresponds to a server. Once they have selected a number the bot will create a channel in the selected server where a server admin can change the permissions of the category to who can view the modmail channels.
{% endhint %}

{% hint style="info" %}
When replying to a user you would just type your message in the thread channel and it will automatically send to the user, no prefix is needed when sending messages. Please note that every message you send in that channel will be sen
{% endhint %}


# Welcome

The welcome module allows you to setup the most advanced welcome features on Discord

![](https://604774950-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M4Yjoz58iWYeSizXRb5%2Fuploads%2Fgit-blob-85cf4f9212f8f7ba5d219f7056f7415a2d55667b%2Fwelcome.png?alt=media)

## Commands

| Command         | Description                               |
| --------------- | ----------------------------------------- |
| /welcome-help   | Provides the welcome help command         |
| /welcome-setup  | Sets up the welcome module in your server |
| /welcome-status | View your welcome configuration           |

{% hint style="info" %}
Placeholders:

* Type `{user}` for where you would like to ping the user
* Type `{server}` for the name of your server
* Type `{count}` for the server member count
  {% endhint %}

{% hint style="warning" %}
If you are setting auto-roles then the bots role must be higher than the auto role
{% endhint %}

{% hint style="warning" %}
You must have the `MANAGE_SERVER` permission to run these commands.
{% endhint %}


# Game

Get stats on games you play

![](https://604774950-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M4Yjoz58iWYeSizXRb5%2F-MRfm7QYGo-GyQ8tbpDd%2F-MRfmLMv-ycmN2_aFkXG%2FGame.png?alt=media\&token=7bd87e40-17d4-49c1-a466-929a4f543089)

## Clash of Clans

| Command                                | Description                                 |
| -------------------------------------- | ------------------------------------------- |
| /clash-of-clans clan \<tag>            | Provides stats about a clan                 |
| /clash-of-clans player \<tag>          | Provides stats about a player               |
| /clash-of-clans clan-members \<tag>    | Lists all the members in the specified clan |
| /clash-of-clans war \<tag>             | Displays war results in a clan              |
| /clash-of-clans troops \<tag>          | Displays all the troops levels for a player |
| /clash-of-clans cwl-leaderboard \<tag> | Displays the CWL leaderboard                |
| /clash-of-clans cwl-stats \<tag>       | Displays CWL stats for a clan               |
| /clash-of-clans cwl-roster \<tag>      | Displays the CWL roster in a clan           |

## Clash Royale

| Command                      | Description                                         |
| ---------------------------- | --------------------------------------------------- |
| /clash-royale clan \<tag>    | Displays information about a clan                   |
| /clash-royale player \<tag>  | Displays information about a player                 |
| /clash-royale members \<tag> | Displays all the clan members in the specified clan |

## Brawl Stars

| Command                    | Description                         |
| -------------------------- | ----------------------------------- |
| /brawl-stars player \<tag> | Displays information about a player |
| /brawl-stars club \<tag>   | Displays information about a club   |