Tools for osu!.
- A desktop platform with the .NET SDK 5.0 or higher installed.
- When working with the codebase, we recommend using an IDE with intellisense and syntax highlighting, such as Visual Studio 2017+, Jetbrains Rider or Visual Studio Code.
- These instructions assume you have the the CLI git client installed, but any other GUI client such as GitKraken will suffice.
- Note that there are additional requirements for Windows 7 and Windows 8.1 which you may need to manually install if your operating system is not up-to-date.
I just want to run it
- Clone the repository including submodules (
git clone --recurse-submodules https://github.com/ppy/osu-tools)
- Navigate to each tool's directory and follow the instructions listed in the tool's README.
- PerformanceCalculator - A tool for calculating the difficulty of beatmaps and the performance of replays.
I want to make changes
Most relevant code is in the main ppy/osu repository. To make any meaningful changes you will likely need to edit that as well.
- Clone all relevant repos into the same directory (
git clone https://github.com/ppy/osu-tools;
git clone https://github.com/ppy/osu)
- Run the
./UseLocalOsu.ps1powershell script (or
./UseLocalOsu.sh) to use your local copy of ppy/osu
Contributions can be made via pull requests to this repository. We hope to credit and reward larger contributions via a bounty system. If you're unsure of what you can help with, check out the list of open issues.
Note that while we already have certain standards in place, nothing is set in stone. If you have an issue with the way code is structured; with any libraries we are using; with any processes involved with contributing, please bring it up. I welcome all feedback so we can make contributing to this project as pain-free as possible.
The osu! client code, framework, and tools are licensed under the MIT licence. Please see the licence file for more information. tl;dr you can do whatever you want as long as you include the original copyright and license notice in any copy of the software/source.
Please note that this does not cover the usage of the "osu!" or "ppy" branding in any software, resources, advertising or promotion, as this is protected by trademark law.
Please also note that game resources are covered by a separate licence. Please see the ppy/osu-resources repository for clarifications.