Radia

Radia is the mascot of Inkling Performance Labs. As the lead researcher, her duty is to take care of the teams participating in Low Ink as well as to see growth in the teams and individuals taking part in the tournaments.

Usage

This is for staff members, for non-staff members, type !help.

Managing tournaments

Setting it up

1. First, make sure that the bot has the ICAL environment variable set up.
2. Create a calendar event, make sure it's on the calendar that the ICAL variable points to.
   • The name of the event will be used to reference the tournament.
   • The date of the event will be used to determine the order in the agenda.
3. Set the description of the event.

   battlefy: <the battlefy tournament id>
   role: <optionally, you can include a custom captain role id to use, defaults to the Captain role>
   

4. The bot will automatically refresh calendar data (along with other data) ever hour, but you can run !refresh or !sync to see your changes immediately.

Using commands

• You can run !agenda to get a look at all the scheduled tournaments. The command will also tell you the index of each tournament, this is important.
• You can run !captain to check the current status of captains. This command does NOT assign roles.

You can append the index of any tournament to these commands / subcommands to specify a specific tournament.

!agenda 1 !captain 2

Agenda management

• To get the upcoming tournament, you can run !agenda next or !agenda 0. This will be the default tournament used by the !captain command.
• To get the previous tournament, you can run !agenda prev or !agenda -1. This can be helpful when removing captains.

You can also use the aliases, !cal, or !calendar if you so wish.

Captain management

Running !captain will only check the status of captains, to assign roles, you have to explicitly state that you want roles assigned.

As said before, you can append the index of a tournament to use that tournament instead of the default.

• !captain assign Assigns the captain role for the next tournament. This command automatically send a status check after it is complete.
• !captain remove Removes the captain role for the next tournament. Be careful, if you're running this command after the tournament has ended, make sure to specify it to use the previous tournament with !captain remove -1.
• !captain check This is simply an alias for !captain.

Final words

Thanks for reading, I hope this documentation section was helpful to you. If you have any questions, feel free to ask me @LeptoFlare.

Contributing

1. Fork the repository, do NOT create any branches on the source repository.
2. Make a new branch to submit your pull request from.
3. Submit a pull request to the master branch. Please make sure you select "Allow edits from contributors".

Checkin management

The checkin command group helps with day 2 checkin and bracket management.

In order to check-in, you do !checkin [<team name>], here are some things to note.

• This command is only avaliable to those with a valid bracket role.
• Staff members can check in for a team by specifying team name of the team they want to check in.

Managing the check-in command staff can use these subcommands:

• !checkin load [<agenda id>] Loads the battlefy teams using the agenda specified, defaults to the next tournament, see Agenda management for information on how agenda id's work.
• !checkin assign <bracket> <team name> [<captain>] Assigns a bracket to a team.
  • <bracket> This corresponds to ALPHA, BETA, and GAMMA, you can also use the first letter.
  • <team name> The name of the team you are assigning to the bracket, make sure to surround the name in quotes.
  • [<captain>] You can optionally specify a different user to assign the role to, incase the battlefy field is invalid.
  • You can use !b a as a shorthand for the command name, and a, b, g are shorthands for the bracket names.
• !checkin list [<bracket>] List all of the teams who have checked in, you can optionally filter by bracket.
• !checkin remove Removes the bracket roles from every member, this effectively closes check-in.
• !checkin purge A utility command that purges a channel of every message, only avaliable in a check-in channel.

Running locally

Prerequisites

1. Make sure you have Docker installed.
2. A Google API project for the bot.

Google setup

1. Enable the following API
   • Google Sheets API
   • Google Drive API
2. Go to the API & Services and navigate to credentials tab
3. Click on + create credentials and create a new Service Accounts fill in the necessary field.
   • When you get to Role give it editor.
4. Download the credentials files and rename it google.json
5. Share the Google Sheet with the client_email from the json file.
6. Copy the gsheet key from the url at https://docs.google.com/spreadsheets/d/{key}/edit, you will use this in the .env

MongoDB

1. Create a MongoDB Database, either locally via a docker or using MongoDB Cloud
2. Form a valid URI to access the database. e.g. mongodb://username:password@localhost:27017
3. Place URI into environment variables

Database will create tables as needed and used

Bot Setup

1. Create a .env in the repository root:

   TOKEN=discord.bot.token
   GSHEET=gsheet_key
   ICAL="https://calendar.google.com/calendar/ical/43cm%40group.calendar.google.com/private-1b6d/basic.ics"
   MONGOURI="Your MongoDB Connection URI"
   DATABASENAME=DatabaseName
   MONGOURI=MongoDbURI
   SENTRY="System Environment"  # Optional
   DEBUG=1  # Optional

   Please know that there are no true or false values in .env files. If you want to set a key to false, set it to 0

2. Run docker-compose up in the repository root.