Code Monkey home page Code Monkey logo

gromp-bot's Introduction

Gromp Bot

Gromp Bot is a specialized Discord bot designed to deliver League of Legends Esports replays directly to coaches and players. Leveraging the Bayes Esports API, the bot offers a user-friendly interface to search, filter, and download match replays right in discord.

With esports data being moved onto GRID and the author joining a team, this project will no longer receive updates.

Example Usage Image

Features

  • Search Replays: Filter by game type, team name, and tags.
  • Download Replays: Direct download links for replays.
  • User-Friendly: Designed for coaches and players to use with minimal setup.
  • Highly Configurable: Limit bot to specific Discord guilds.

Prerequisites

  • Python 3.10 or higher
  • Docker (Optional for deployment)

Clone the project

git clone https://github.com/Allan-Cao/Gromp-Bot.git

(Optional) Create a virtual environment

  • Linux/MacOS

    python3 -m venv bot-env
    source bot-env/bin/activate
  • Windows

    py -m venv bot-env
    bot-env\Scripts\activate

Install dependencies

pip install -r requirements.txt

Environment Variables

You'll need to set the environment variables. You can do this by renaming .env.example to a file called .env in the root directory of the project and modifying the variables in the file or if you are deploying with docker, consider passing in env variables with the --env-file option.

GUILDS_ALLOWED specifies which servers the bot is allowed to take commands from which should be a string that has comma-seperated server-IDs.

Note: To find your server ID, follow this guide.


Start the bot

python bot.py

Building and Deploying with Docker

  1. Install Docker: Official Website
  2. Clone Repository: git clone https://github.com/Allan-Cao/Gromp-Bot.git
  3. Navigate to Directory: cd Gromp-Bot
  4. Build Image: docker build -t gromp-bot .
  5. Run Container: docker run -d gromp-bot
  6. Verify Container: docker ps

Stop Container: docker stop <container-id>


Usage

  • Search Matches: /match
  • Download Replay: /download <game_id>

License

This project is licensed under the MIT License. See the LICENSE file for more information.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.