KomorebiBot

A multipurpose Discord bot

Report Bug · Request Feature

Table of Contents

• Table of Contents
• About The Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

This is a Discord bot just made for fun and I will be adding to it as many ideas I get so it will have a lot of commands in the future. You can propose features as well as add commands to it yourself.

Built With

• NodeJs
• Discord.Js
• MongoDB

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

First we will need to have NodeJs and npm installed, npm is installed automatically when you install NodeJs but you can ensure you have the last version installed running:

npm install npm@latest -g

And you will also need to have mongodb installed, we recommend the version 4.4.1 since is the one this project is using.

Installation

1. Clone the repo

git clone https://github.com/ElaxDev/KomorebiBot.git

2. Install NPM packages

npm install

3. Create a .env file

NODE_ENV=development
TOKEN=YOUR TOKEN GOES HERE
PREFIX=YOUR BOT PREFIX GOES HERE
MONGO_PATH=mongodb://localhost:27017

Usage

Use the help command to see how to use the commands.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Any contribution to the code will be greatly appreciated be it new commands or code optimization.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License.

Contact

Discord - Elax#7777

Project Link: https://github.com/ElaxDev/KomorebiBot

Acknowledgements

• Canvacord
• cli-progress
• colors
• discord.js
• mongoose
• nekos.life