night0721/nyx
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
nyx/README.md
ThunderE75 047da29f25 Updated README
2021-07-22 22:12:08 +05:30

7.1 KiB
Raw Blame History

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.

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.

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

inviteme Support Server Repo Stars

Build with:

JavaScript node npm MongoDB

Deploy Your Own Instance 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.

git Open in Visual Studio Code node

Step by Step Walkthrough

YouTube Tutorial

  1. Clone this repository
git clone https://github.com/night0721/cath.exe

  1. Rename the .env.example➚ file to .env

  2. Create an application from Discord Developer's Portal then copy these things into the .env file.
    Open Discord Developer Portal

    • Bot Token
    • Application ID (Client ID)
    • Client Secret

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


  4. 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. After this, you need to install all dependencies by using this command. This will takes a few minutes.

    npm i

  6. Now, to start the bot use this command in the Terminal.

    node .

Additional Steps

To enable the Economy Commands, you need to Setup a MongoDB Database. You can also watch a video guide here.

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

Support, Feature Request & Bug Reports

Support & Feature Request

Join the official Support Server on Discord & we will be happy to assist you.
To Request new features 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