Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
NicholasBottone committed May 12, 2023
1 parent e50f218 commit f0c2e6d
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,15 @@

A Discord bot for running simulation robotics tournaments in xRC Sim. Designed to expedite and simplify the process of running tournaments, and to provide a better experience for competitors.

[!] This project is currently a work in progress. [!]

- [x] Generates match schedules and player lists.
- [x] Creates voice channels for each match and moves players into them.
- [x] Saves match results from xRC Simulator games to a Google Sheet.
- [x] Notifies players of upcoming matches and results via Discord.
- [ ] Displays live game data on livestream overlays via OBS Lua scripts.

To be used for competitions and tournaments in the Unity-based game [xRC Simulator](http://xrcsimulator.org/). Used in online [SRC events](https://secondrobotics.org).

Currently configured to be used with xRC Sim Charged Up, would need modifications to be used with other games.

Powered by [Discord.js](https://discord.js.org/) and [Google Sheets API](https://developers.google.com/sheets/api). Based on the [NicholasBottone/xRCSim-Tourney-Runner](https://github.com/NicholasBottone/xRCSim-Tourney-Runner) CLI tool.

## Getting Started
Expand Down

0 comments on commit f0c2e6d

Please sign in to comment.