nyx/README.md

<<<<<<< HEAD

CATH.EXE

<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">

CATH.EXE

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

d51d7231dc

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 by Path.exe.<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>

<<<<<<< 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>

d51d7231dc

Build with:

<img src ="https://forthebadge.com/images/badges/built-with-love.svg" width = "122"><br>

Deployment

Deploy Online

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

===

d51d7231dc

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>

1. Clone this repository

git clone https://github.com/night0721/cath.exe

2. Rename the .env.example<span>➚ file into .env. <br>

3. Create an application from Discord Developer's Portal then copy these things into the .env file.<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.

   • 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.

   <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 below.

7. Setup a Spotify Application as instructed below.

8. Go back to the Discord Developer's Portal in the OAuth2 tab, Select BOT in the Scopes Section & Select ADMINSTRATORfrom 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.

    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.

d51d7231dc 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
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 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 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,
    • 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.
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 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.

CONTRIBUTORS

Contributions are always welcomed, but make sure to read Contributing.md first.