osu!

This project is under constant development, but we do our best to keep things in a stable state. Players are encouraged to install from a release alongside their stable osu! client. This project will continue to evolve until we eventually reach the point where most users prefer it over the previous "osu!stable" release. A few resources are available as starting points to getting involved and understanding the project: Detailed release changelogs are available on the official osu! site. You can learn more about our approach to project management. Track our current efforts towards improving the game. You can also generally download a version for your current device from the osu! site. For iOS/iPadOS users : The iOS testflight link fills up very fast (Apple has a hard limit of 10,000 users). We reset it occasionally. Please do not ask about this. Check back regularly for link resets or follow peppy on twitter for announcements. Our goal is to get the game on mobile app stores very soon so we don't have to live with this limitation. You can see some examples of custom rulesets by visiting the custom ruleset directory. Please make sure you have the following prerequisites: A desktop platform with the .NET 8.0 SDK installed. When working with the codebase, we recommend using an IDE with intelligent code completion and syntax highlighting, such as the latest version of Visual Studio, JetBrains Rider, or Visual Studio Code with the EditorConfig and C Dev Kit plugin installed. You should load the solution via one of the platform-specific .slnf files, rather than the main .sln . This will reduce dependencies and hide platforms that you don't care about. Valid .slnf files are: osu.Desktop.slnf (most common) osu.Android.slnf osu.iOS.slnf Run configurations for the recommended IDEs (listed above) are included. You should use the provided Build/Run functionality of your IDE to get things going. When testing or building new components, it's highly encouraged you use the osu! (Tests) project/configuration. More information on this is provided below. To build for mobile platforms, you will likely need to run sudo dotnet workload restore if you haven't done so previously. This will install Android/iOS tooling required to complete the build. You can also build and run osu! from the command-line with a single command: When running locally to do any kind of performance testing, make sure to add -c Release to the build command, as the overhead of running with the default Debug configuration can be large (especially when testing with local framework modifications as below). If the build fails, try to restore NuGet packages with dotnet restore . Before committing your code, please run a code formatter. This can be achieved by running dotnet format in the command line, or using the Format code command in your IDE. We have adopted some cross-platform, compiler integrated analyzers. They can provide warnings when you are editing, building inside IDE or from command line, as-if they are provided by the compiler itself. JetBrains ReSharper InspectCode is also used for wider rule sets. You can run it from PowerShell with . InspectCode.ps1 . Alternatively, you can install ReSharper or use Rider to get inline support in your IDE of choice. When it comes to contributing to the project, the two main things you can do to help out are reporting issues and submitting pull requests. Please refer to the contributing guidelines to understand how to help in the most effective way possible. If you wish to help with localisation efforts, head over to crowdin. 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.