ppy / osu-difficulty-calculator

Processes raw beatmaps and saves difficulty attributes to a database backend

osu-difficulty-calculator

Difficulty calculation server for osu!.

For more detailed information see per-component READMEs.

Current Versions

This is part of a group of projects which are used in live deployments where the deployed version is critical to producing correct results. The master branch tracks ongoing developments. If looking to use the correct version for matching live values, please consult this wiki page for the latest information.

Requirements

• A desktop platform that can compile .NET 6.0. 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.

Getting Started

• Clone the repository (git clone https://github.com/ppy/osu-difficulty-calculator)
• Build in your IDE of choice (recommended IDEs automatically restore nuget packages; if you are using an alternative make sure to nuget restore)

Contributing

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.

Licence

The osu! client code, framework, and server-side components 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.

osu-difficulty-calculator's Issues

Re-enable health monitoring after next humanizer release

See #110. Requires Humanizer > v2.8.26.

Rename project

osu-server is too generic. this should be called osu-diffcalc-server or similar.

Command line arguments are hard to understand

It'll probably prevent a lot of confusion if we invert arguments such that all rulesets are processed by default, and then --ruleset=1 --ruleset=2 will be a marker to only process the given rulesets. Along the same line of thinking, --no-converts instead of --allow-converts.

Test