juanm4t / osu-qualifiers-autoref

automated qualifiers referee interface for osu!

osu!autoref

Semi-automated referee bot for osu! by Cychloryn. Adapted to be an automated qualifiers bot by M A N O L O.

Tested on Windows. Uses bancho.js by ThePoon.

I might work on a better readme later...

Features

• Creates match automatically
• Extra mp commands
  • Invite all players with >invite
  • Auto tactical timeout with >timeout
  • Close the lobby automatically with >close
• Automatic scorekeeping
• Auto start matches when players are ready
• Every match starts with your own Elevator music
• As many runs as you'd like!

Configuration

Before running osu!autoref, you'll need to fill out some configuration.

config.json

Create a file config.json. You can copy the template file config.example.json. You will need to add your username, IRC password, and osu! API key.

pool.json

Load the mappool into this file. The format should be self-explanatory from the example pool. It requires only the map code (NM2, HR3, DT1, etc) and the ID of the map. The bot will infer the mods based on the map code, but you can (optionally) explicitly provide the mod via the "mod" field.

match.json

Configure the game settings, including timers, waiting song/map, ID, whether you want the mp to be private or not, the number of runs, the tournament acronym, and players participating, ensuring adherence to the provided JSON structure. In case you need to add more players do it like this:

  "teams": [
      {"name": "Player 1"},
      {"name": "Player 2"},
      {"name": "Player 3"}
  ]

Running

Requires: node.js (I use node v10) latest node.js also works though I recommend using LTS

npm install
npm start OR node index

Usage

Upon running this bot, a match will be created, and the password will be logged to the terminal. You can send messages to the chatroom via the terminal window, but this is kinda janky, so I'd recommenda also having an IRC client open/being in-game.

First, you can use this special command to invite all players from both teams to the match:

>invite

If you want to give the players a break, you can easily do it by executing this next command:

>timeout

If you need to takeover the bot at any point through, but you don't want to close the enitre thing just yet, you can use this next command, with any argument, except on, which will turn it back on.

>auto off
>auto on

At the end of the match, close the lobby with:

>close

This command is recommended over !mp close, because it also disconnects the bot from Bancho and cleanly exits the program.