Getting this bot to run all of its features is a long process, so for your convenience, the installation is split into three steps. Only the first step is required.

Prerequisites

• Node.JS LTS
• Yarn
• Rust (for calculating pp)
• Nginx
• On Windows, Visual Studio 2013/2015/2017/2019 with C++ Option

Installation (basic)

• Run yarn

• Copy config.json.example to config.json

• Create a new osu! API application, then add the client ID and secret to osu_v2api_client_id and osu_v2api_client_secret in config.json.

• Put nginx.cfg into nginx's /sites-enabled/ directory.

• Add these lines to your hosts file (/etc/hosts on linux):

  127.0.0.1 osu.osudev.local
  127.0.0.1 taiko.osudev.local
  127.0.0.1 catch.osudev.local
  127.0.0.1 mania.osudev.local
  

That's it! You should be able to run the website with yarn start.

Installation (osu!)

• Download orl.db from my website

It's an SQLite database containing the list of all leaderboarded maps and the pp values for every mod combination.

• Download and extract the latest osu_files.tar.bz2 file from data.ppy.sh and extract the .osu files to the maps/ directory

• Set CONNECT_TO_BANCHO and CREATE_LOBBIES to true in config.json

• Get an IRC password then add it to config.json (osu_irc_password) along with your osu! ID (osu_id) and username (osu_username).

Try running the bot with yarn start and see if it connects successfully. You should be able to find and join a lobby named "test lobby".

Installation (Discord)

• Go to your Discord settings, and in Advanced, toggle Developer Mode on.

• Create a new Discord application and add the bot id and token to config.json

• Create a Discord server with a welcome channel, a verified role and a "The One" role, and add their IDs to config.json by using Right Click -> Copy ID on the server name, channel, and role

• Invite the bot to your Discord server (invite generator)

• Set CONNECT_TO_DISCORD to true in config.json

• Run node util/deploy_commands.js

• Run node util/deploy_prompts.js

Congratulations! You're done.