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

Latest commit

 

History

History
36 lines (24 loc) · 1.51 KB

README.md

File metadata and controls

36 lines (24 loc) · 1.51 KB

docs/logo.png

TT Squad Bot

A discord bot for the TT server that handles Squad related tasks. This project depends on a backend process that aggregates stats and shits them into a redis database. This bot is simply the discord implementation that consumes the data from the redis database. The companion project for this bot can be found here TT Stats Updater

What It Does

  • Display leaderboard stats from the squad server in a paginated list
  • Show individual player stats from the squad server

Usage Overview

Commands

  • /ping - Check that the bot is online and working
  • /leaderboard - Display a squad player leaderboard in a detailed, paginated embed message. The response for this command is ephemeral
  • /stats - Display a squad player's stats in a detail embed message. The response for this command is sent publicly.

How do I use this on my server?

Prerequisites

  1. Node.js 17 or later (refer to the nvmrc file for the exact version)
  2. A redis database that contains stats data (preferrably the one from the companion project here)

Installation

  1. Clone this project
  2. cd into the project root and nvm use && npm install
  3. For production, you will want to build the project by running npm run build
  4. Start the process for production by running start:prod (after building it in the previous step)