Skip to content


Switch branches/tags
This branch is 9 commits behind ppy:master.

osu!tools Build status CodeFactor dev chat

Tools for osu!.


Getting Started

I just want to run it

  • Clone the repository (git clone
  • 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.
    • PerformanceCalculatorGUI - A GUI tool for calculating the difficulty of beatmaps, changes in profile scores and leaderboards.

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; git clone
  • Run the ./UseLocalOsu.ps1 powershell script (or ./ 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.


modified osu-tools







No releases published


No packages published


  • C# 99.2%
  • Other 0.8%