Skip to content

Latest commit

 

History

History
66 lines (49 loc) · 3.24 KB

readme.md

File metadata and controls

66 lines (49 loc) · 3.24 KB
Raw

RoboStats

A discord bot for retrieving information regarding robootics competitions and teams.

server badge invite badge build badge

Features

The following features are currently supported:

  • The ability to look up information about teams on RobotEvents for all program types (basic info, awards, event attendance).
  • Integration with VRC Data Analysis to pull a VRC team's TrueSkill value and rank.
  • The ability to look up articles on the Purdue Sigbots wiki.
  • The ability to predict VRC match results, again using VRC Data Analysis.

Additionally, the following features are in-development or planned:

  • The ability to view information about specific events.
  • The ability to perform lookups in documentation for other LemLib projects.
  • The ability to look up specific VRC game rules (and potentially Q&A responses).

Development

This bot is written in Rust using the serenity framework for interacting with the Discord API. It is deployed through Shuttle.

Prerequisites

  • Git
  • rustc and a valid Rust toolchain for your platform's target.
  • Command line of your choice.
  • A RobotEvents v2 API bearer token.
  • A discord application token.

Tokens should be placed in Secrets.toml and Secrets.dev.toml files in the repository's root directory. Example file:

DISCORD_TOKEN = ''
ROBOTEVENTS_TOKEN = ''

Secrets.dev.toml will be used for local deployments while Secrets.toml will be used for deployments to the actual shuttle service.

Testing the bot on a local instance

This will temporarily deploy the bot using your local machine as a server for testing purposes:

cargo shuttle run

Deploying the bot to Shuttle

This will deploy the bot to a shuttle project. Doing this will require a shuttle account login and a valid project name in Shuttle.toml

cargo shuttle deploy

License

This project is licensed under the MIT license. Check LICENSE for more details.

Documentation

Contributing

Code of Conduct

See the Code of Conduct on how to behave like an adult.