diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..bdfeaff --- /dev/null +++ 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 new file mode 100644 index 0000000..a27d7f4 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,5 @@ +

Contributing

+ +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 index cdc76e7..3263c21 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,7 @@ -# CATH.EXE TEMPLATE - - +

CATH.EXE TEMPLATE

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

@@ -12,6 +10,8 @@ If you like this bot, feel free to
-# Deployment +

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) @@ -46,23 +46,23 @@ 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 to `.env`
+2. Make a new file & name it ``.env`` then copy-paste all the contents from [`.env.example`➚ +](https://github.com/night0721/cath.exe/blob/main/.env.example) into the `.env` file
-3. Create an application from Discord Developer's Portal then copy these things into the `.env` file.
+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**
- **Application ID** (Client ID)
- **Client Secret**
-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 *your* **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.* + >You can also just use one Channel & one Webhook for everything but it will be really inconvenient.
@@ -74,13 +74,13 @@ git clone https://github.com/night0721/cath.exe npm i ``` -7. Now, to start the bot use this command. +7. Now, to start the bot use this command in your 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). 1. Create a Free [MongoDB Account](https://www.mongodb.com/cloud/atlas/register) @@ -97,7 +97,18 @@ To enable the Economy Commands, you need to Setup a MongoDB Database. You can al 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! +13. That's it. + +## Music (Spotify) +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 @@ -109,3 +120,11 @@ 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. [![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) + +

CONTRIBUTORS

+ +Contributions are always welcomed, but make sure to read [Contributing.md](/CONTRIBUTING.md) first. + + + +