Repository files navigation

A free-to-win rhythm game. Rhythm is just aclick away!

This is the future – and final – iteration of theosu! game client which marks the beginning of an open era! Currently known by and released under the release codename "lazer". As in sharper than cutting-edge.

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 stableosu! 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 theofficial osu! site.
• You can learn more about our approach toproject management.
• Track our current effortstowards improving the game.

If you are just looking to give the game a whirl, you can grab the latest release for your platform:

You can also generally download a version for your current device from theosu! site.

If your platform is unsupported or not listed above, there is still a chance you can run the release or manually build it by following the instructions below.

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 followpeppy 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.

osu! is designed to allow user-created gameplay variations, called "rulesets". Building one of these allows a developer to harness the power of the osu! beatmap library, game engine, and general UX for a new style of gameplay. To get started working on a ruleset, we have some templates availablehere.

You can see some examples of custom rulesets by visiting thecustom 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 ofVisual Studio,JetBrains Rider, orVisual Studio Code with theEditorConfig andC# Dev Kit plugin installed.

Clone the repository:

git clone https://github.com/ppy/osucd osu

To update the source code to the latest commit, run the following command inside theosu directory:

git pull

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 theosu! (Tests) project/configuration. More information on this is providedbelow.

To build for mobile platforms, you will likely need to runsudo 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 runosu! from the command-line with a single command:

dotnet run --project osu.Desktop

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 defaultDebug configuration can be large (especially when testing with local framework modifications as below).

If the build fails, try to restore NuGet packages withdotnet restore.

Sometimes it may be necessary to cross-test changes inosu-resources orosu-framework. This can be quickly achieved using included commands:

Windows:

UseLocalFramework.ps1UseLocalResources.ps1

macOS / Linux:

UseLocalFramework.shUseLocalResources.sh

Note that these commands assume you have the relevant project(s) checked out in adjacent directories:

|- osu            // this repository|- osu-framework|- osu-resources

Before committing your code, please run a code formatter. This can be achieved by runningdotnet format in the command line, or using theFormat 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 thecontributing guidelines to understand how to help in the most effective way possible.

If you wish to help with localisation efforts, head over tocrowdin.

We love to reward quality contributions. If you have made a large contribution, or are a regular contributor, you are welcome tosubmit an expense via opencollective. If you have any questions, feel free toreach out to peppy before doing so.

osu!'s code and framework are licensed under theMIT licence. Please seethe 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 thisdoes 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 theppy/osu-resources repository for clarifications.