night0721/nyx
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
The first CODM discrod bot -- cath.exe Template
44 commits 8 branches 8 tags 1.9 MiB
JavaScript 99.8%
Dockerfile 0.2%
Find a file
dependabot[bot] 1f5c59a474
Bump reconlx from 1.4.511 to 2.4.3 
Bumps [reconlx](https://github.com/reconlx/reconlx-api) from 1.4.511 to 2.4.3.
- [Release notes](https://github.com/reconlx/reconlx-api/releases)
- [Commits](https://github.com/reconlx/reconlx-api/commits)

---
updated-dependencies:
- dependency-name: reconlx
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2021-09-07 13:24:33 +00:00
.github npm 2021-09-06 20:00:31 +08:00
cat cath v3.0.0 2021-09-06 18:38:25 +08:00
command cath v3.0.0 2021-09-06 18:38:25 +08:00
commands cath v3.0.0 2021-09-06 18:38:25 +08:00
events cath v3.0.0 2021-09-06 18:38:25 +08:00
models update 2021-07-13 11:17:39 +08:00
util cath v3.0.0 2021-09-06 18:38:25 +08:00
.env.example cath v3.0.0 2021-09-06 18:38:25 +08:00
.eslintrc.js update 2021-07-13 11:17:39 +08:00
.gitattributes Updated configs and added api 2021-06-24 15:53:19 +08:00
.gitignore cath v3.0.0 2021-09-06 18:38:25 +08:00
.jshintrc update 2021-07-13 11:17:39 +08:00
.replit cath v3.0.0 2021-09-06 18:38:25 +08:00
app.js update 2021-07-13 11:17:39 +08:00
app.json Good 2021-06-12 19:16:08 +08:00
bot.js cath v3.0.0 2021-09-06 18:38:25 +08:00
CODE_OF_CONDUCT.md Added Code of Conduct & Contributing.md 2021-07-26 21:14:19 +05:30
config.json cath v3.0.0 2021-09-06 18:38:25 +08:00
CONTRIBUTING.md Added Code of Conduct & Contributing.md 2021-07-26 21:14:19 +05:30
index.js cath v3.0.0 2021-09-06 18:38:25 +08:00
inlinereply.js Bot 2021-06-12 18:53:51 +08:00
LICENSE Added Missing Info 2021-07-23 12:44:10 +05:30
package-lock.json Bump reconlx from 1.4.511 to 2.4.3 2021-09-07 13:24:33 +00:00
package.json Bump reconlx from 1.4.511 to 2.4.3 2021-09-07 13:24:33 +00:00
Procfile Bot 2021-06-12 18:53:51 +08:00
README.md README 2021-09-06 19:51:11 +08:00

README.md

CATH.EXE

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.

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 Contributor Covenant Trello Board ko-fi

Build with:

JavaScript node npm MongoDB

Deployment

Deploy Online

Run On Replit Deploy On Heroku

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.

git Open in Visual Studio Code node

Step by Step Walkthrough

Youtube Walkthrough

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

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

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

    • Bot Token (TOKEN)
    • Application ID (CLIENT_ID)
    • Client Secret (CLIENT_SECRET)

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


  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. Setup the MongoDB Database as instructed below.

  6. Setup a Spotify Application as instructed below.

  7. Go back to the Discord Developer's Portal in the OAuth2 tab, Select BOT in the Scopes Section & Select ADMINSTRATORfrom the BOT PERMISSIONS Section.

  8. Copy the URL and by using the URL invite the bot to a server.

  9. After this, you need to install all dependencies by using this command. This will takes a few minutes.

    npm i

  10. Now, to start the bot use this command in the terminal.

    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

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

CONTRIBUTORS

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