Eskobot

Discord Moderation Bot built with discord.js

Local Development

• git clone, git fork, etc this repository
• npm install to get required packages
• reference env.example and add the following to a .env file
• create a discord server for local testing and follow this guide
• reference configs/GuildTemplate.json and create one for your guild
• run npm run dev for a nodemon instance to start the bot
• run npm run start for production

Contributing

Fork this repository. Using the above local development changes, set up your own discord bot token here If you are new to creating bots there's a great guide to reference here

Make a new branch for your changes and add it to the forked repository you created. Name it related to your fix / refactor eg. hotfix-modmail-feature. Then, make a pull request with your changes and our team will review it.

Motivation

As this originally was my first Javascript project, it was important to find something to maintain and get feedback from users. Looking at old code is embarrassing for anyone, but the skill of refactoring and changing the mold of existing software is important bar none.

Since 2.0.0 I've decided to change the direction of the application:

• Support for multiple servers
• Application needs to be accessible for server specific functions
• Easier to contribute and clone for local and collaborative use

TODO

Planned Major Changes:

General:

• Migrating from Sequelize to MongoDB
• Guild init command / static form - Migrate from configs/*.json

Modmail

• Staff Auto-Ticket command
• Ticket Reason / Close Logging
• Ticket Tagging

Staff Logging:

• Staff Log Filtering
• Custom Role Handler
• Multiple Channel Option

Minor Changes:

• Unit Testing
• Refactor event listeners to /events/*.js
• Adding attachments to user punishments