Tools for osu!.
For more detailed information see per-tool READMEs.
- PerformanceCalculator - A CLI tool for calculating the difficulty of beatmaps and the performance of replays.
- A desktop platform that can compile .NET 4.7.1. We recommend using Visual Studio Community Edition (Windows), Visual Studio for Mac (macOS) or MonoDevelop (Linux), all of which are free. Visual Studio Code may also be used but requires further setup steps which are not covered here.
- Clone the repository including submodules (
git clone --recurse-submodules https://github.com/ppy/osu-tools
) - Build in your IDE of choice (recommended IDEs automatically restore nuget packages; if you are using an alternative make sure to
nuget restore
)
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.