commit cbf63eb210fbce87191df0c332d729e3af813bbf
parent 236d19953388dd64ddd6bbff4397e6e957e4bf78
Author: night0721 <[email protected]>
Date: Mon, 6 Sep 2021 18:43:50 +0800
cath v3.0
Diffstat:
| A | CODE_OF_CONDUCT.md | | | 117 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
| A | CONTRIBUTING.md | | | 6 | ++++++ |
| M | README.md | | | 192 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++---------------------- |
3 files changed, 261 insertions(+), 54 deletions(-)
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,117 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+ and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+ overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+ advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+ address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at our [Discord Server](https://discord.com/invite/SR7TeNJG67) to **Night** or **Thunder**.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/),
+version 2.0, available at [v2.0](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html).
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,5 @@
+<h1 align="center">Contributing</h1>
+
+When contributing to this repository, please first discuss the change you wish to make via issue or on our [discord server](https://discord.com/invite/SR7TeNJG67).
+
+Please note we have a [code of conduct](/CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
+\ No newline at end of file
diff --git a/README.md b/README.md
@@ -1,112 +1,196 @@
-# CATH.EXE [](https://discord.com/oauth2/authorize?client_id=800966959268364288&permissions=4231314550&scope=bot%20applications.commands)
+<<<<<<< HEAD
+
+# CATH.EXE
<!-- header -->
-<img src = "https://media.discordapp.net/attachments/789642309632786434/867156734795055173/Cath-banner.png?width=1298&height=433">
-**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>
+`<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">`
+
+<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, Please invite the main instance using the **INVITE ME** badge.
+>
+>>>>>>> d51d7231dc51c21c66d0e920fcb6bb12d652c143
+>>>>>>>
+>>>>>>
+>>>>>
+>>>>
+>>>
+>>
+
+**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)
-
-[](https://open.vscode.dev/night0721/cath/)
-[](https://trello.com/b/dIgR0QNm)
+<<<<<<< HEAD
+
+
+
+===
+
+
+
+`<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:
-[](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>
-# <img src = "https://discord.com/assets/a6d05968d7706183143518d96c9f066e.svg" width = "26"> Deployment
+
+
+
+
+`<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)
+
+
## 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.
+### 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
-[](https://git-scm.com/downloads)
-[](https://code.visualstudio.com/Download)
-[]()
+===
+
+
+>>>>>>> d51d7231dc51c21c66d0e920fcb6bb12d652c143
+>>>>>>>
+>>>>>>
+>>>>>
+>>>>
+>>>
+>>
### Step by Step Walkthrough
-### [](https://youtu.be/_D5xG7XoF88)
+### `<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
```cmd
git clone https://github.com/night0721/cath.exe
```
-2. Rename the [`.env.example`<span>➚</span>
-](https://github.com/night0721/cath.exe/blob/main/.env.example) file to `.env`<br>
+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>`
-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>
-
-4. To view the logs, Create 5 Channels & 5 Webhooks in *your* **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>
+ - **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.
- *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>
-
-6. After this, you need to install all dependencies by using this command. This will takes a few minutes.
+ `<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.
+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.
- ```cmd
- node .
- ```
+==========================================================
+
+11. Now, to start the bot use this command in the terminal.
+
+>>>>>>> d51d7231dc51c21c66d0e920fcb6bb12d652c143
+>>>>>>> ``cmd node . ``
+>>>>>>>
+>>>>>>
+>>>>>
+>>>>
+>>>
+>>
# Additional Steps
-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`.
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.*
-5. Then you can Name your Cluster, after that click on `Create Cluster`. *This will take a couple of minutes.*
+5. Then you can Name your Cluster, after that click on `Create Cluster`. *This should take a couple of minutes.*
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`.
-8. After that, click on `Network Access` from the sidebar & then click on `Add IP Address`. & click on the `Add Current IP Address` Then click on `Confirm`.
+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`.
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!
+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/).
+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.
# 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/867093614403256350.png?v=1" width = 18>` Support & Feature Request
-## <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.
+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
+
+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)
+
+<h1 align = "center">CONTRIBUTORS</h1>
+
+Contributions are always welcomed, but make sure to read [Contributing.md](/CONTRIBUTING.md) first.
+
+<a href="https://github.com/night0721/cath.exe/graphs/contributors">
+ <img src="https://contrib.rocks/image?repo=night0721/cath.exe" />
+</a>
