Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/christinecha/league-bot-rl
A Discord bot to help manage Rocket League leaderboards within your server.
https://github.com/christinecha/league-bot-rl
bot discord leaderboard rocket-league
Last synced: 3 months ago
JSON representation
A Discord bot to help manage Rocket League leaderboards within your server.
- Host: GitHub
- URL: https://github.com/christinecha/league-bot-rl
- Owner: christinecha
- Created: 2020-11-08T22:52:19.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-07-18T03:52:57.000Z (over 2 years ago)
- Last Synced: 2024-05-01T16:24:04.711Z (10 months ago)
- Topics: bot, discord, leaderboard, rocket-league
- Language: JavaScript
- Homepage: https://www.leaguebotrl.com
- Size: 922 KB
- Stars: 6
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
## Discord League Bot
A bot that lets you run simultaneous 1s, 2s, and 3s leagues in your Discord channel. Specifically geared toward Rocket League for now, but has the potential to be generalized.
If you'd like to help support the development and maintenance of this project, you can [become a Github Sponsor](https://github.com/sponsors/christinecha).
---
### Usage
Click [this link](https://discord.com/oauth2/authorize?client_id=775129640322203658&scope=bot) to add the bot to your Discord server, or visit www.leaguebotrl.com for more information. If you're interested in running this project locally, development instructions are below.
### Variables
- `date` - A date value formatted `yyyy-mm-dd`.
- `matchId` - The unique match ID.
- `prefix` - A prefix to go in front of League Bot commands. The default is `!`, ex. `!queue`. No spaces allowed.
- `teamSize` - 1, 2, or 3.
### Commands
- `@LeagueBot cancel ` - Cancel a match.
- `@LeagueBot clear | c ` - Clear the queue for a specific league.
- `@LeagueBot help | h` - Show me all the commands.
- `@LeagueBot leaderboard <[teamSize]>` - Show me the leaderboard!
- `@LeagueBot leave | l <[teamSize]>` - Leave the queue for one or all leagues.
- `@LeagueBot loss | lose | lost ` - Report that you lost this match.
- `@LeagueBot new | n ` - Start a new league for a specific team size.
- `@LeagueBot queue | q ` - Join the queue for a specific league.
- `@LeagueBot status | s <[teamSize]>` - Show the current queue(s).
- `@LeagueBot win | won | w ` - Report that you won this match.
### Mod-Only Commands
- `@LeagueBot end ` - Set the end date of the leaderboard.
- `@LeagueBot end-all ` - Set the end date of the leaderboard.
- `@LeagueBot fix ` - Overwrite the results of a specific match.
- `@LeagueBot prefix ` - Change the command prefix for @LeagueBot to recognize. The default is `!`.
- `@LeagueBot reset ` - Reset the start of the leaderboard to _right now_.
- `@LeagueBot start ` - Set the start date of the leaderboard.
- `@LeagueBot start-all ` - Set the start date of the leaderboard.
- `@LeagueBot void ` - Erase a specific match from history.
### Advanced
- Mentioning `@LeagueBot` is optional in the channel that has most recently been queued in. As a shortcut in this channel, you can use a `!` prefix instead, like `!leave 2s`, `!q 1` or `!leaderboard`
---
### Feature/Bug Backlog
- ✨ **Requeue | Rematch.** Requeue everyone from a specific match.
- ✨ **Insult/Compliment Contributions.** Add a place for people to submit bot insults & compliments.
- ✨ **Recent matches.** A command that lists the most recent matches played in this server.
- 🐛 **Prune queues on match creation.** If you get a match for one league, it should remove all those players from the other leagues' queues.
- 🐛 **Cleaning queue should only kick old queuers.** If you re-queue mid-clean, for instance it should no longer kick you.
- ✨ **View leaderboard with custom range.** Add query parameters to leaderboard page?
- 🐛 **Set timezone.** Timezone is US Eastern (-5) by default, but shouldn't have to be.
### Development
1. Open up `example.env`. You need to fill in these secret values for this repo to run.
2. Create a Firebase project that uses Firestore. Then, follow [this link](https://firebase.google.com/docs/admin/setup#initialize-sdk) for instructions on generating a **private key file** for your service account. This will contain all the Firebase values you need.
3. [Create a Discord bot.](https://discord.com/developers/applications) This link will require you to log in. Then you can create a new application and create a Bot for it. The `BOT_ID` is the application's client id (under General Information) and the `BOT_TOKEN` is just called Token (on the Bot page).
4. Follow the instructions in the `example.env` file to update & rename it to `.env`.
5. Finally for the fun stuff! Let's run the server locally:
```
yarn install
# DEV MODE
yarn run dev
open http://localhost:4242 (client app)
# PRODUCTION MODE
yarn run build && yarn start
```
6. To run tests locally, you'll need to [install Firebase Emulators](https://firebase.google.com/docs/rules/emulator-setup). Then:
```
# In one window
firebase emulators:start
# In another window
yarn run test
```