diff --git a/README.md b/README.md index 9c8137f..091da93 100644 --- a/README.md +++ b/README.md @@ -1,93 +1,48 @@ -<<<<<<< HEAD - -# CATH.EXE - - - -`` -=== - -`` - +

CATH.EXE

-> `` This is a Bot Template based on Cath.exe, This templated **does not** conatain any data from Project Lighthouse. +> 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).`

` -If you like this bot, feel free to `` **Star** and **fork** this repository.`

` +**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).

+If you like this bot, feel free to **Star** and **fork** this repository.

- - +[![inviteme](https://badgen.net/badge/Invite%20Me/Online/5865F2?icon=discord&color=5865F2&style=for-the-badge&scale=1.4)](https://discord.com/oauth2/authorize?client_id=800966959268364288&permissions=4231314550&scope=bot%20applications.commands) [![Support Server](https://img.shields.io/discord/718762019586572341?label=Support%20Server&logo=Discord&colorB=5865F2&style=for-the-badge&logoColor=white) ](https://discord.gg/SR7TeNJG67) -<<<<<<< HEAD -![Repo Stars](https://img.shields.io/github/stars/night0721/cath.exe?logo=github&color=5865F2&style=for-the-badge) - - -=== - ![Repo Stars](https://img.shields.io/github/stars/night0721/cath.exe?logo=github&color=5865F2&style=for-the-badge) +[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.0-4baaaa.svg?colorB=5865F2&style=for-the-badge)](https://github.com/night0721/cath.exe/blob/main/CODE_OF_CONDUCT.md) +Trello Board +[![ko-fi](https://img.shields.io/static/v1?label=Support%20Us%20On&message=KO.FI&color=ff5e5b&logo=kofi&logoColor=white&style=for-the-badge&scale=1.4)](https://ko-fi.com/I2I35XISJ) -`Trello Board``` - ->>>>>>> d51d7231dc51c21c66d0e920fcb6bb12d652c143 ->>>>>>> ->>>>>> ->>>>> ->>>> ->>> ->> - ## Build with: - - - - - -`
` +[![JavaScript](https://img.shields.io/badge/JavaScript-F7DF1E?style=for-the-badge&logo=javascript&logoColor=black)](https://developer.mozilla.org/en-US/docs/Web/JavaScript) +[![node](https://img.shields.io/badge/Node.js-43853D?style=for-the-badge&logo=node.js&logoColor=white)](https://nodejs.org/en/) +[![npm](https://img.shields.io/badge/npm-CB3837?style=for-the-badge&logo=npm&logoColor=white)](https://www.npmjs.com/) +[![MongoDB](https://img.shields.io/badge/MongoDB-4EA94B?style=for-the-badge&logo=mongodb&logoColor=white)](https://mongodb.com/) +

Deployment

## Deploy Online +[![Run On Replit](https://img.shields.io/static/v1?label=Run%20On&message=Repl.it&color=5865F2&logo=replit&logoColor=white&style=for-the-badge&scale=1.4)](https://repl.it/github/night0721/cath.exe) +[![Deploy On Heroku](https://img.shields.io/static/v1?label=Deploy%20On&message=Heroku&color=5865F2&logo=heroku&logoColor=white&style=for-the-badge&scale=1.4)](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 ->>>>>>> ->>>>>> ->>>>> ->>>> ->>> ->> +[![git](https://badgen.net/badge/icon/git?icon=git&label&color=5865F2&style=for-the-badge&scale=1.4)](https://git-scm.com/downloads) +[![Open in Visual Studio Code](https://img.shields.io/badge/Visual_Studio_Code-5865F2?style=for-the-badge&logo=visual%20studio%20code&logoColor=white)](https://code.visualstudio.com/Download) +[![node](https://img.shields.io/badge/Node.js-43853D?style=for-the-badge&logo=node.js&logoColor=white)](https://nodejs.org/en/download/) ### Step by Step Walkthrough -### `Youtube Walkthrough``
` +### Youtube Walkthrough
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`➚ - ](https://github.com/night0721/cath.exe/blob/main/.env.example) file into `.env`. `
` -3. Create an application from Discord Developer's Portal then copy these things into the `.env` file.`
` +2. Rename the [`.env.example` +](https://github.com/night0721/cath.exe/blob/main/.env.example) file into `.env`.
- - **Bot Token** (TOKEN)`
` - - **Application ID** (CLIENT_ID)`
` - - **Client Secret** (CLIENT_SECRET) `
` +3. Create an application from Discord Developer's Portal then copy these things into the `.env` file.
+[![Open Discord Developer Portal](https://badgen.net/badge/icon/discord?icon=discord&label=Developer%20Portal&color=5865F2&style=for-the-badge)](https://discord.com/developers/applications) + - **Bot Token** (TOKEN)
+ - **Application ID** (CLIENT_ID)
+ - **Client Secret** (CLIENT_SECRET)
+ 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)
+ - **Error Log** (Log Unhandled Rejection Error)
+ - **Ready Log** (Log when bot online)
+ - **Command Log** (Log command usage)
+ - **DM Log** (Log when someone send DM to Bot)
+ + >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)`
` - - **Error Log** (Log Unhandled Rejection Error)`
` - - **Ready Log** (Log when bot online)`
` - - **Command Log** (Log command usage)`
` - - **DM Log** (Log when someone send DM to Bot)`
` +
- > 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.
- `` `
` -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. `
` 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 `` 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 -## `` Support & Feature Request - -Join the official [Support Server](https://discord.gg/SbQHChmGcp) on Discord & we will be happy to assist you. `
` -To Request new features contact us on Discord using the support server. - -## `` Report Bugs +## Support & Feature Request +Join the official [Support Server](https://discord.gg/SbQHChmGcp) on Discord & we will be happy to assist you.
+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. +## 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. [![Support Server](https://img.shields.io/discord/718762019586572341?label=Support%20Server&logo=Discord&colorB=5865F2&style=for-the-badge&logoColor=white) ](https://discord.gg/SR7TeNJG67) @@ -193,4 +139,4 @@ Contributions are always welcomed, but make sure to read [Contributing.md](/CONT - + \ No newline at end of file