Skip to content
This repository has been archived by the owner on Feb 3, 2023. It is now read-only.

nephest/sc2-lineup-bot

Repository files navigation

SC2 lineup discord bot

This is a discord bot that should help tournament organizers create lineups of players. It is built as a prototype using inefficient(but fast to develop) templates. This is a Spring Boot app, using Spring Data JPA and Discord4J under the hood.

How to use it

  • Invite the bot
  • Create a ruleset with the ruleset slash command. There are lots of optional parameters, don't miss them.
  • Create a lineup with the lineup-create slash command. Use ruleset id from previously created ruleset. Discord doesn't provide a way to input dates(revealAt param), so we have to use offsets or numerical timestamps.
    • minutes Offset in minutes. Examples: 1 is 1 minute offset.
    • duration Offset in duration of hours, minutes, and seconds. Examples: 1h2m3s, 2h, 1h15m.
    • timestamp(seconds) Use timestamp converters like epochconverter or unixtimestamp.
  • Fill the lineup with the lineup-fill slash command. There are several lineup modes
    • Plain text. Example: name z, anotherName t. The bot will save your lineup as it is without checking it against the supplied ruleset.
    • Pulse character id + race. Example: 1 z, 2 t. The bot will use the supplied ruleset to verify all players against the SC2 Pulse API. You can find pulse ids in the URL. For example https://www.nephest.com/sc2/?type=character&id=236695&m=1#player-stats-mmr, copy the id parameter, in this case the id is 236695.
    • Pulse race id. Go to SC2 Pulse, add teams to the buffer, copy to clipboard->raceId. The bot will verify players.
  • Reveal the lineup with the lineup-reveal slash command.

Running

  • Set the discord.token application property.
  • Use dev profile to run a local server gradle -PbuildProfile=dev bootRun.