2021-07-22 18:42:08 +02:00
< img src = "https://media.discordapp.net/attachments/842014909264953354/867806346593042483/Cath-temp-banner.png?width=1244&height=415" >
2021-07-26 23:57:01 +02:00
< h1 align = "center" > CATH.EXE< / h1 >
2021-06-12 13:37:13 +02:00
2021-07-27 00:01:43 +02:00
> <img src="https://upload.wikimedia.org/wikipedia/commons/b/b2/Warning-icon.png" width = "16"> This is a Bot Template based on Cath.exe, This templated **does not** conatain any data from Project Lighthouse.
>For Call of duty mobile stats, Please invite the main instance using the **INVITE ME** badge.
2021-07-13 05:17:39 +02:00
2021-07-22 18:42:08 +02:00
**Cath.exe** is a Multipurpose Discord Bot with many features that include but are not limited to Moderation, Music and Economy. The Call of Duty Stats are courtesy of [**Project Lighthouse** ](https://discord.gg/ARNFCu9NxK ) by [**Path.exe** ](https://www.youtube.com/channel/UC0hvUWYhyx_DOEBzLWEJxsw ).< br >< br >
If you like this bot, feel free to < img src = "https://discord.com/assets/141d49436743034a59dec6bd5618675d.svg" width = "16" > **Star** and **fork** this repository.< br >< br >
2021-06-12 13:37:13 +02:00
2021-07-22 18:42:08 +02:00
<!-- Main Badges -->
[](https://discord.com/oauth2/authorize?client_id=800966959268364288& permissions=4231314550& scope=bot%20applications.commands)
[ ](https://discord.gg/SR7TeNJG67)

2021-07-26 17:46:33 +02:00
[](https://github.com/night0721/cath.exe/blob/main/CODE_OF_CONDUCT.md)
2021-07-31 14:09:27 +02:00
< a href = "https://trello.com/b/dIgR0QNm" target = "_blank" > < img src = "https://img.shields.io/badge/Trello-5865F2?style=for-the-badge&logo=trello&logoColor=white&scale=1.4" alt = "Trello Board" > < / a >
2021-07-26 17:44:19 +02:00
2021-07-22 18:42:08 +02:00
<!-- Build with badges -->
## Build with:
[](https://developer.mozilla.org/en-US/docs/Web/JavaScript)
[](https://nodejs.org/en/)
[](https://www.npmjs.com/)
[](https://mongodb.com/)
< img src = "https://forthebadge.com/images/badges/built-with-love.svg" width = "122" > < br >
2021-07-26 16:52:28 +02:00
< h1 align = "center" > < img src = "https://discord.com/assets/a6d05968d7706183143518d96c9f066e.svg" width = "20" > Deployment < img src = "https://discord.com/assets/a6d05968d7706183143518d96c9f066e.svg" width = "20" > < / h1 >
2021-07-22 18:42:08 +02:00
2021-07-24 11:54:25 +02:00
## Deploy Online
[](https://repl.it/github/night0721/cath.exe)
[](https://heroku.com/deploy?template=https://github.com/night0721/cath.exe)
2021-07-22 18:42:08 +02:00
2021-07-24 11:54:25 +02:00
## Deploy Locally
2021-07-22 18:42:08 +02:00
2021-07-24 11:54:25 +02:00
### Prerequisite
2021-07-22 18:42:08 +02:00
Download all these programs on your local machine by clicking on the badge & following the standard installing procedure. You can use any IDE but we recommand VS Code.
[](https://git-scm.com/downloads)
[](https://code.visualstudio.com/Download)
[](https://nodejs.org/en/download/)
2021-07-24 11:54:25 +02:00
### Step by Step Walkthrough
2021-07-22 18:42:08 +02:00
2021-07-31 14:09:27 +02:00
### <a href="https://youtu.be/ureUEQCAGic" target="_blank"><img src="https://img.shields.io/badge/YouTube-FF0000?style=for-the-badge&logo=youtube&logoColor=white&scale=1.4" alt="Youtube Walkthrough"></a><br>
2021-07-22 18:42:08 +02:00
1. Clone this repository
2021-07-13 05:17:39 +02:00
2021-06-12 13:37:13 +02:00
```cmd
git clone https://github.com/night0721/cath.exe
```
2021-07-13 05:17:39 +02:00
2021-07-26 23:57:01 +02:00
2. Rename the [`.env.example`< span > ➚ </ span >
2021-07-27 00:01:43 +02:00
](https://github.com/night0721/cath.exe/blob/main/.env.example) file into `.env` . < br >
2021-07-13 05:17:39 +02:00
2021-07-26 16:52:28 +02:00
3. Create an application from Discord Developer's Portal then copy these things into the `.env` file.< br >
2021-07-22 18:42:08 +02:00
[](https://discord.com/developers/applications)
2021-07-26 23:57:01 +02:00
- **Bot Token** (TOKEN)< br >
- **Application ID** (CLIENT_ID)< br >
- **Client Secret** (CLIENT_SECRET) < br >
2021-07-22 18:42:08 +02:00
2021-07-26 23:57:01 +02:00
4. To view the logs, Create 5 Channels & 5 Webhooks in a **Discord Server** corresponding to these logs.
2021-07-22 18:42:08 +02:00
- **Server Log** (Log new Server Added/Premium Server)< br >
- **Error Log** (Log Unhandled Rejection Error)< br >
- **Ready Log** (Log when bot online)< br >
- **Command Log** (Log command usage)< br >
- **DM Log** (Log when someone send DM to Bot)< br >
2021-07-13 05:17:39 +02:00
2021-07-26 18:05:45 +02:00
>You can also just use one Channel & one Webhook for everything but it will be really inconvenient.
2021-07-13 05:17:39 +02:00
2021-07-22 18:42:08 +02:00
< img src = "https://media.discordapp.net/attachments/540218400413188116/867797464169709661/unknown.png" width = "640" > < br >
2021-07-13 05:17:39 +02:00
2021-07-22 18:42:08 +02:00
5. One by one paste the webhook url in a web browser & copy the **ID** & the **TOKEN** and paste it in the corresponding feilds in the `.env` file. < br >
2021-07-13 05:17:39 +02:00
2021-07-27 00:01:43 +02:00
6. Setup the **MongoDB Database** as [instructed ](https://github.com/night0721/cath.exe#mongo-db-setup ) below.
2021-07-26 23:57:01 +02:00
2021-07-27 00:01:43 +02:00
7. Setup a **Spotify Application** as [instructed ](https://github.com/night0721/cath.exe#spotify-setup ) below.
2021-07-26 23:57:01 +02:00
2021-07-27 00:42:30 +02:00
8. Go back to the Discord Developer's Portal in the OAuth2 tab, Select `BOT` in the **Scopes Section** & Select `ADMINSTRATOR` from the **BOT PERMISSIONS** Section.
9. Copy the URL and by using the URL invite the bot to a server.
10. After this, you need to install all dependencies by using this command. This will takes a few minutes.
2021-07-13 05:17:39 +02:00
2021-07-22 18:42:08 +02:00
```cmd
npm i
```
2021-07-27 00:42:30 +02:00
11. Now, to start the bot use this command in the terminal.
2021-07-22 18:42:08 +02:00
```cmd
node .
```
2021-07-24 11:54:25 +02:00
# Additional Steps
2021-07-26 23:57:01 +02:00
## Mongo DB Setup
2021-07-27 00:01:43 +02:00
To use the Economy Commands, you need to Setup a MongoDB Database.
2021-07-22 18:42:08 +02:00
1. Create a Free [MongoDB Account ](https://www.mongodb.com/cloud/atlas/register )
2. Click on the `Create a New Database` .
3. Selct the `CREATE` option in the **Shared** Teir.
4. Select a `Cloud Provider & Region` that is geographically closer to the average user that will use the bot. *This will effect the responce time of the bot.*
2021-07-31 14:09:27 +02:00
5. Then you can Name your Cluster, after that click on `Create Cluster` . *This should take a couple of minutes.*
2021-07-22 18:42:08 +02:00
6. Then click on `Database Access` from the sidebar & then click on `Add New Database User` .
7. Under the `Password - Authentication Method` . Enter a username & password. then click on `Add User` .
2021-07-27 00:42:30 +02:00
8. After that, click on `Network Access` from the sidebar & then click on `Add IP Address` . & click on the `Allow Access from Anywhere` Then click on `Confirm` .
2021-07-22 18:42:08 +02:00
9. now, Click on `Database` from the sidebar & then click on `Connect` .
10. Then on click on `Connect your Application` . & Copy the link.
11. The paste that link in the `MONGODB` feild in the `.env` file.
12. Now you need to modify that link,
- Replace `<password>` with the password for the user that you created in **Step 7** .
- Replace `myFirstDatabase` with the name of the Database that you named in **Step 5** .
2021-07-26 18:31:32 +02:00
13. That's it.
2021-07-22 18:42:08 +02:00
2021-07-26 23:57:01 +02:00
## Spotify Setup
2021-07-26 18:31:32 +02:00
To use spotify urls to play music follow these steps.
1. Go to the [**Spotify's Developer Dashboard** ](https://developer.spotify.com/dashboard/ ).
2. Click on **Create an app** .
3. Fill out the required info, then click on **CREATE** .
4. Copy the **Client ID** & paste it in the `SPOTIFY_ID` feild in the `.env` file.
5. Back in the Dashboard, Click on **SHOW CLIENT SECRET**
6. Copy the **Client Secret** & paste it in the `SPOTIFY_SECRET` feild in the `.env` file.
7. That's it.
2021-07-26 17:44:19 +02:00
2021-07-22 18:42:08 +02:00
# Support, Feature Request & Bug Reports
2021-06-12 13:37:13 +02:00
2021-07-22 18:42:08 +02:00
## <img src = "https://cdn.discordapp.com/emojis/867093614403256350.png?v=1" width = 18> Support & Feature Request
Join the official [Support Server ](https://discord.gg/SbQHChmGcp ) on Discord & we will be happy to assist you. < br >
To Request new features contact us on Discord using the support server.
2021-06-12 13:37:13 +02:00
2021-07-22 18:42:08 +02:00
## <img src = "https://cdn.discordapp.com/emojis/867093601962950666.png?v=1" width = "18"> Report Bugs
You can report bugs or issues by opening a issue in this repository. Alternatevely you can also contact us on Discord using the support server.
2021-06-12 13:37:13 +02:00
2021-07-22 18:42:08 +02:00
[ ](https://discord.gg/SR7TeNJG67)
2021-07-26 17:44:19 +02:00
< h1 align = "center" > CONTRIBUTORS< / h1 >
2021-07-26 17:47:19 +02:00
Contributions are always welcomed, but make sure to read [Contributing.md ](/CONTRIBUTING.md ) first.
2021-07-26 17:44:19 +02:00
< a href = "https://github.com/night0721/cath.exe/graphs/contributors" >
< img src = "https://contrib.rocks/image?repo=night0721/cath.exe" / >
< / a >