Setup

Installation

WARNING! Traffic is unencrypted unless a reverse proxy with HTTPS is used (and properly configured), see this for more information. This pretty much only matters if you expose the WebUI on the web, if you're hosting locally (i.e. on your computer on your home network) then it's not that big of a deal. Use at your own risk.

Download the latest release from the releases page. Also make sure you have the .NET Framework 6.0 SDK installed!

Modify appsettings.json and fill out a username and a password as shown below. This is not for the osu! IRC credentials, but the admin panel of the bot itself.

{
  ...
  "Authentication": {
    "AdminUsername": "<fill out a username>",
    "AdminPassword": "<fill out a password>"
  }
  ...
}

Then run the bot, for example on Windows you may run the BanchoMultiplayerBot.Host.Web.exe file, or on Linux run dotnet BanchoMultiplayerBot.Host.Web.dll. Now while the bot application is running you can visit http://localhost:5000/osu-bot where you should be greeted by a login page. Here you can login with the username and password that you picked earlier.

Now you should open up the Authentication page (within Settings) and fill out your osu! IRC credentials and osu!api v1 key, both of which you can get from the bottom of your osu! account settings page here (You can use localhost for the app URL).

After this is done you may go back to the Dashboard page and hit the "Connect" button, and after waiting a few seconds it should hopefully connect and the Bancho Connection label should say OK. If you encounter issues and you are sure that the credentials are correct, try hitting the Save Configuration button, then manually restart the bot and try again. If you still have issues check out the console window for any error messages which might point you in the right direction. If you still have issues feel free to open up an issue here or DM me on osu!

At this point you may start creating lobbies, with the "Add new lobby" page to the left. Use the Auto Host Rotate preset to create an AHR lobby. The lobby should then be created and you should be able to click on it on the menu to the left, where you can configure it to your liking and see the current players and chat etc.

Performance Points

The bot will function just fine without it, but if you want the bot to provide performance point information for each map, you will need to build performance-calculator, and then provide it's binary in the bot folder named performance-calculator. After restarting the bot it should automatically be calculating the pp for each map picked. I could possibly released pre-compiled binaries soon.

Build

The current newest release of BanchoSharp will not work with the bot currently, instead use my fork for now.