commit 22116608252aa4f5fa6d520f23515fc552f3f4ae
parent 9a2276b0c9c9e94710a5652113441636223c28f3
Author: ThunderE75 <[email protected]>
Date: Tue, 27 Jul 2021 03:34:08 +0530
Merge pull request #3 from ThunderE75/main
Update Readme for clarity & added the trello badge
Diffstat:
2 files changed, 21 insertions(+), 15 deletions(-)
diff --git a/.env.example b/.env.example
@@ -1,5 +1,5 @@
TOKEN =
-MONGO = mongodb://127.0.0.1:27017/test
+MONGO =
CLIENT_SECRET =
CLIENT_ID =
SPOTIFY_ID =
diff --git a/README.md b/README.md
@@ -1,7 +1,9 @@
<img src = "https://media.discordapp.net/attachments/842014909264953354/867806346593042483/Cath-temp-banner.png?width=1244&height=415">
-<h1 align="center"> CATH.EXE TEMPLATE</h1>
+<h1 align="center"> CATH.EXE</h1>
-> <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 invite the main instance using the **INVITE ME** badge.
+> <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.
**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>
@@ -11,6 +13,7 @@ If you like this bot, feel free to <img src = "https://discord.com/assets/141d49
[ ](https://discord.gg/SR7TeNJG67)
[](https://github.com/night0721/cath.exe/blob/main/CODE_OF_CONDUCT.md)
+[](https://trello.com/b/dIgR0QNm)
<!-- Build with badges -->
@@ -35,7 +38,6 @@ Download all these programs on your local machine by clicking on the badge & fol
[](https://git-scm.com/downloads)
[](https://code.visualstudio.com/Download)
[](https://nodejs.org/en/download/)
-<!-- [](https://www.mongodb.com/cloud/atlas/lp/try2) -->
### Step by Step Walkthrough
@@ -46,16 +48,16 @@ Download all these programs on your local machine by clicking on the badge & fol
git clone https://github.com/night0721/cath.exe
```
-2. Make a new file & name it ``.env`` then copy-paste all the contents from [`.env.example`<span>➚</span>
-](https://github.com/night0721/cath.exe/blob/main/.env.example) into the `.env` file <br>
+2. Rename the [`.env.example`<span>➚</span>
+](https://github.com/night0721/cath.exe/blob/main/.env.example) file into `.env`. <br>
3. Create an application from Discord Developer's Portal then copy these things into the `.env` file.<br>
[](https://discord.com/developers/applications)
- - **Bot Token**<br>
- - **Application ID** (Client ID)<br>
- - **Client Secret**<br>
+ - **Bot Token** (TOKEN)<br>
+ - **Application ID** (CLIENT_ID)<br>
+ - **Client Secret** (CLIENT_SECRET) <br>
-4. To view the logs, Create 5 Channels & 5 Webhooks in *your* **Discord Server** corresponding to these logs.
+4. To view the logs, Create 5 Channels & 5 Webhooks in a **Discord Server** corresponding to these logs.
- **Server Log** (Log new Server Added/Premium Server)<br>
- **Error Log** (Log Unhandled Rejection Error)<br>
- **Ready Log** (Log when bot online)<br>
@@ -68,20 +70,24 @@ git clone https://github.com/night0721/cath.exe
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>
-6. After this, you need to install all dependencies by using this command. This will takes a few minutes.
+6. Setup the **MongoDB Database** as [instructed](https://github.com/night0721/cath.exe#mongo-db-setup) below.
+
+7. Setup a **Spotify Application** as [instructed](https://github.com/night0721/cath.exe#spotify-setup) below.
+
+8. After this, you need to install all dependencies by using this command. This will takes a few minutes.
```cmd
npm i
```
-7. Now, to start the bot use this command in your terminal.
+9. Now, to start the bot use this command in the terminal.
```cmd
node .
```
# Additional Steps
-## Economy Commands [MongoDB]
-To enable the Economy Commands, you need to Setup a MongoDB Database. You can also watch a video guide [here](https://youtu.be/dQw4w9WgXcQ).
+## Mongo DB Setup
+To use the Economy Commands, you need to Setup a MongoDB Database.
1. Create a Free [MongoDB Account](https://www.mongodb.com/cloud/atlas/register)
2. Click on the `Create a New Database`.
@@ -99,7 +105,7 @@ To enable the Economy Commands, you need to Setup a MongoDB Database. You can al
- Replace `myFirstDatabase` with the name of the Database that you named in **Step 5**.
13. That's it.
-## Music (Spotify)
+## Spotify Setup
To use spotify urls to play music follow these steps.
1. Go to the [**Spotify's Developer Dashboard**](https://developer.spotify.com/dashboard/).
