commit 842d303093d46290250ccf8ffbc4fdc624f24249
parent cbf63eb210fbce87191df0c332d729e3af813bbf
Author: night0721 <[email protected]>
Date: Mon, 6 Sep 2021 19:51:11 +0800
README
Diffstat:
| M | README.md | | | 167 | +++++++++++++++++++++++++++---------------------------------------------------- |
1 file changed, 57 insertions(+), 110 deletions(-)
diff --git a/README.md b/README.md
@@ -1,93 +1,48 @@
-<<<<<<< HEAD
-
-# CATH.EXE
-
-<!-- header -->
-
-`<img src = "https://media.discordapp.net/attachments/789642309632786434/867156734795055173/Cath-banner.png?width=1298&height=433">`
-===
-
-`<img src = "https://media.discordapp.net/attachments/842014909264953354/867806346593042483/Cath-temp-banner.png?width=1244&height=415">`
-
+<img src = "https://media.discordapp.net/attachments/842014909264953354/867806346593042483/Cath-temp-banner.png?width=1244&height=415">
<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.
+> <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.
->
->>>>>>> d51d7231dc51c21c66d0e920fcb6bb12d652c143
->>>>>>>
->>>>>>
->>>>>
->>>>
->>>
->>
+>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>`
+**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>
<!-- Main Badges -->
-
-
+[](https://discord.com/oauth2/authorize?client_id=800966959268364288&permissions=4231314550&scope=bot%20applications.commands)
[ ](https://discord.gg/SR7TeNJG67)
-<<<<<<< HEAD
-
-
-
-===
-
+[](https://github.com/night0721/cath.exe/blob/main/CODE_OF_CONDUCT.md)
+<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>
+[](https://ko-fi.com/I2I35XISJ)
-`<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>`
-
->>>>>>> d51d7231dc51c21c66d0e920fcb6bb12d652c143
->>>>>>>
->>>>>>
->>>>>
->>>>
->>>
->>
<!-- Build with badges -->
-
## Build with:
-
-
-
-
-
-`<img src ="https://forthebadge.com/images/badges/built-with-love.svg" width = "122"><br>`
+[](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>
<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>
## Deploy Online
+[](https://repl.it/github/night0721/cath.exe)
+[](https://heroku.com/deploy?template=https://github.com/night0721/cath.exe)
+## Deploy Locally
+### Prerequisite
+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.
-## Deployment Locally
-
-### Prerequisite
-
-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.
-
-
-
-<<<<<<< HEAD
-
-===
-
-
->>>>>>> d51d7231dc51c21c66d0e920fcb6bb12d652c143
->>>>>>>
->>>>>>
->>>>>
->>>>
->>>
->>
+[](https://git-scm.com/downloads)
+[](https://code.visualstudio.com/Download)
+[](https://nodejs.org/en/download/)
### Step by Step Walkthrough
-### `<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>`
+### <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>
1. Clone this repository
@@ -95,55 +50,49 @@ Download all these programs on your local machine by clicking on the badge & fol
git clone https://github.com/night0721/cath.exe
```
-2. Rename the [`.env.example<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>`
+2. Rename the [`.env.example`<span>➚</span>
+](https://github.com/night0721/cath.exe/blob/main/.env.example) file into `.env`. <br>
- - **Bot Token** (TOKEN)`<br>`
- - **Application ID** (CLIENT_ID)`<br>`
- - **Client Secret** (CLIENT_SECRET) `<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** (TOKEN)<br>
+ - **Application ID** (CLIENT_ID)<br>
+ - **Client Secret** (CLIENT_SECRET) <br>
+
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>
+ - **Command Log** (Log command usage)<br>
+ - **DM Log** (Log when someone send DM to Bot)<br>
+
+ >You can also just use one Channel & one Webhook for everything but it will be really inconvenient.
- - **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>`
+ <img src = "https://media.discordapp.net/attachments/540218400413188116/867797464169709661/unknown.png" width="640"> <br>
- > You can also just use one Channel & one Webhook for everything but it will be really inconvenient.
- >
+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>
- `<img src = "https://media.discordapp.net/attachments/540218400413188116/867797464169709661/unknown.png" width="640">` `<br>`
-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. 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. 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.
+
+7. Setup a **Spotify Application** as [instructed](https://github.com/night0721/cath.exe#spotify-setup) below.
+
+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.
```cmd
npm i
```
-<<<<<<< HEAD
-7. Now, to start the bot use this command in the terminal.
-==========================================================
-
11. Now, to start the bot use this command in the terminal.
-
->>>>>>> d51d7231dc51c21c66d0e920fcb6bb12d652c143
->>>>>>> ``cmd node . ``
->>>>>>>
->>>>>>
->>>>>
->>>>
->>>
->>
+ ```cmd
+ node .
+ ```
# Additional Steps
-
## 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)
@@ -157,13 +106,12 @@ To use the Economy Commands, you need to Setup a MongoDB Database.
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,
+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**.
13. That's it.
## 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/).
@@ -176,14 +124,12 @@ To use spotify urls to play music follow these steps.
# Support, Feature Request & Bug Reports
-## `<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.
-
-## `<img src = "https://cdn.discordapp.com/emojis/867093601962950666.png?v=1" width = "18">` Report Bugs
+## <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.
-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.
+## <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.
[ ](https://discord.gg/SR7TeNJG67)
@@ -193,4 +139,4 @@ Contributions are always welcomed, but make sure to read [Contributing.md](/CONT
<a href="https://github.com/night0721/cath.exe/graphs/contributors">
<img src="https://contrib.rocks/image?repo=night0721/cath.exe" />
-</a>
+</a>
+\ No newline at end of file
