Kuromi Bot

A bot to have fun with your friends!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

KuromiBot is a bot designed specifically for friend servers just to have fun and stuff.

(back to top)

Built With

• discord.js

(back to top)

Getting Started

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

Prerequisites

• NodeJS
• Dependencies
• A will to live

Installation

1. Clone the repo

   git clone https://github.com/KuromiBot/KuromiBot.git

2. Install NPM packages

    npm install

3. Create a .env file with th following code:

   TOKEN= <TOKEN>
   GUILD_ID= <GUILD ID if in Development>
   STATUS=DEVELOPMENT <Change to PRODUCTION to load commands on every guild>
   STATUSBOT= <The status for your bot>
   DISCORDSTATUS=dnd <Change to whatever you want>

(back to top)

Usage

This discord bot uses slash commands to do the stuff.

(back to top)

Roadmap

• Minigames
• Full rewrite

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

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)

Contact

Dani - @EpicF3X - totallynotafed@fbi.ac.com

Project Link: https://github.com/KuromiBot/KuromiBot

(back to top)

Acknowledgments

This project couldn't have been made without the following people:

• You - Checking this repository out, really appreciated!
• @mezotv - The author of the amazing discord.js template that actually helped me get this thing here
• discord.js - discord.js API wrapper
• Contributors

And many, many more package authors, Stack Overflow members, Discord users, and Neovim.

(back to top)