/Kobayashi

A tournament management Discord bot for Esports team managers.

Primary LanguageJavaScriptGNU General Public License v3.0GPL-3.0

Contributors Forks Stargazers Issues MIT License twitter-follow


Logo

Kobayashi

A tournament management Discord bot for Esports team managers
Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Local Installation
  3. Heroku Deployment
  4. Usage
  5. Contributing
  6. License
  7. Contact

About The Project

A Discord bot made specifically for Esports team managers to use on their team server to schedule tournaments. This bot takes all the information regarding a match, formats it and publish it on a channel specified by the managers, it also has the option to tag a role.

Built With

Local Installation

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

Prerequisites

  1. Make sure you've latest version of npm installed
npm install npm@latest -g
  1. Follow the instruction here to a create a bot application and get your token(It'll be required on step 4): https://discordjs.guide/preparations/setting-up-a-bot-application.html#creating-your-bot

Installation

  1. Clone the repo

    git clone https://github.com/m4hd1bd/Kobayashi.git

  2. Go to project folder

    cd Kobayashi

  3. Install NPM packages

    npm install

  4. Open .env file in a text ediotor and fill up the require info (Bot token, Channel ID and Role ID)

  5. Start the bot

    node index.js

Heroku Deployment

To deploy the bot on Heroku and make sure it is always online follow below instructions

Prerequisites

  1. Create an account on Heroku

  2. Follow the instruction here to a create a bot application and get your token(It'll be required on step 3): https://discordjs.guide/preparations/setting-up-a-bot-application.html#creating-your-bot

Installation

  1. Clone the repo 
    git clone https://github.com/m4hd1bd/Kobayashi.git
  2. Go to project folder 
    cd Kobayashi
  3. Install heroku cli 
    npm install -g heroku
  4. Login to heroku
heorku login
  1. Create a heroku application and add heroku remote
heroku create
  1. Deploy the bot on heroku
git push heroku main
  1. Login to your Heroku Dashboard and select the applicaton.
  2. Go to Resources tab, click one edit button beside web npm start and disable it. Then Click on edit button beside worker npm start and Enable it.
  3. Go to the Settings tab and then Click on Reveal Config Vars, add your Bot token as botToken, your channel ID as channelID and the role you want to mention as roleID.
  4. Your Bot is now ready, DM me on Discord if you face any problems.

Usage

List of commands:

  1. !ping - To check if the Bot is onlilne.
  2. !newtour - To publish a tournament schedule in a specific channel and mentioning a specific role. Bot will ask you to enter specific informations related to the tournament, use N/A if you doesn't have information on something. Send cancel to cancel the ongoing publishing procedure.

Contributing

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

  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 GNU 3.0. See LICENSE for more information.

Contact

Mahdi - @M4hd1BD - virtualmahdi@gmail.com