Skip to content
This repository has been archived by the owner on Jun 26, 2024. It is now read-only.

Latest commit

 

History

History
150 lines (108 loc) · 3.74 KB

README.md

File metadata and controls

150 lines (108 loc) · 3.74 KB
Raw

Logo

Vaughan Esports Tournament Bot

Home of Vaughan Esports' very own Discord Bot used to run our events!

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. License
  6. Contact

About The Project

Tournament rules and rulesets are long can get pretty annoying to read and keep up with, especially with our regular monthly events. Having a dedicated bot to handle the processes for veto'ing and selecting maps helps keeps players engaged and following the rules!

The bot walks all players through the veto process and has a multitude of commands to help players and teams setup their matches.

Built With

Getting Started

Follow the steps below if you'd like to host your own instance our the bot.

Prerequisites

  • Python 3.8 or higher (May work on 3.6 and 3.7 but untested)
  • Discord Developer Account

Installation

  1. Get your Discord bot API Key ( Instructions here)
  2. Clone the repo 
    git clone https://github.com/Vaughan-Esports/VE-Tourney-Bot.git
  3. Install Python packages 
    pip install -r requirements.txt
  4. Create a file called .env amd put your API key in like so: 
    BOT_TOKEN=YOUR_TOKEN

Configuration

Everything is configurable from settings.py

Usage

Its main commands are

  • ve!coinflip @opponent
    • Flips a coin
  • ve!match @opponent
    • Starts a private chat between you and your opponent
  • ve!smash {best-of} @opponent
    • Starts a smash veto with your opponent (Best of can be 3 or 5)
  • ve!val {best-of} @opponent
    • Starts a VALORANT veto with your opponent (Best of can be 1, 3, or 5)
  • ve!osu {best-of} @opponent
    • Starts a osu! veto with your opponent (Best of can be 3, 5, or 7)
  • ve!close
    • Closes a private chat between you and your opponent
  • ve!purge
    • Purges all closed channels

Commands can also be run with pings to both players so that TO's may manually set up commands for players (e.g ve!match @player1 @player2)

Roadmap

  • League of Legends ARAM Roll
  • Logging
  • MongoDB Support (V2)
  • Dynamic Veto (Easy config of veto from a single file) (V3)

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Your Name - @brndnly - [email protected]

Project Link: https://github.com/Vaughan-Esports/VE-Tourney-Bot