Quick Disclaimer this is by no means a bot meant for huge servers or heavy workload (it might work but i can't guarantee anything)
- Have Dotnet Runtime installed (in order for Performance Calculator to run)
- Have a Discord Bot + osu!api v1 Key
- Have the correct folder structure
Make sure that you have the CLI git client installed https://git-scm.com/
- Open Git Bash
- Enter the following commands
git clone https://github.com/ppy/osu-tools
git clone [the github link of whatever rework you want to check out, ie: https://github.com/emu1337/osu]
- If the rework you want is under a branch, you will also need to enter these commands command:
cd osu
git pull
git checkout [name of branch, ie: ppv2-xexxar-round3]
- To update, type and run the following:
cd osu
git pull
- Open the osu-tools folder on your computer (it will probably be located in the Users/user/ directory)
- Run the file UseLocalOsu.sh / useLocalOsu.ps1
- Open the PerformanceCalculator folder in the osu-tools folder
- Open the file titled ProcessWorkingBeatmap.cs in Notepad
- Near the bottom, you will see a line of code:
public override Stream GetStream(string storagePath) => null;
all you have to do is put a//
before the line, like such://public override Stream GetStream(string storagePath) => null;
somefolder/
├── osu/
└── osu-tools/
└── PerformanceCalculator <-- This is the folder the bot runs in
- Extract the zip archive downloaded from Releases into the PerformanceCalculator folder
- This is a CLI App, so start a terminal of your choice, navigate to the folder and run it via
RebalanceBot.exe <your discord bot token> <your osu api client id> <your osu api client secret> [bot prefix]
- Should be running now, if you didn't configure it, the prefix will be
r!
or mentioning the bot
r!rebalance <username>
Checks the rebalance for a specific playerr!map <map id>
Recalculates star rating for a specific mapr!update
Updates the osu repo in case any new changes got pushed (This is a bot owner only command)r!simulate <map id> [accuracy] [mods]
Simulates a play on the given map with provided acc/mods (By default 100% and NM)