rhythm is just a *click* away!
A free-to-win rhythm game. Rhythm is just a click away!
The future of osu! and the beginning of an open era! Currently known by and released under the codename "lazer". As in sharper than cutting-edge.
This project is under heavy development, but is in a stable state. Users are encouraged to try it out and keep it installed alongside the stable osu! client. It will continue to evolve to the point of eventually replacing the existing stable client as an update.
IMPORTANT: Gameplay mechanics (and other features which you may have come to know and love) are in a constant state of flux. Game balance and final quality-of-life passes come at the end of development, preceded by experimentation and changes which may potentially reduce playability or usability. This is done in order to allow us to move forward as developers and designers more efficiently. If this offends you, please consider sticking to the stable releases of osu! (found on the website). We are not yet open to heated discussion over game mechanics and will not be using github as a forum for such discussions just yet.
We are accepting bug reports (please report with as much detail as possible and follow the existing issue templates). Feature requests are also welcome, but understand that our focus is on completing the game to feature parity before adding new features. A few resources are available as starting points to getting involved and understanding the project:
If you are looking to install or test osu! without setting up a development environment, you can consume our binary releases. Handy links below will download the latest version for your operating system of choice:
If your platform is not listed above, there is still a chance you can manually build it by following the instructions below.
osu! is designed to have extensible modular gameplay modes, called "rulesets". Building one of these allows a developer to harness the power of osu! for their own game style. To get started working on a ruleset, we have some templates available here.
You can see some examples of custom rulesets by visiting the custom ruleset directory.
Please make sure you have the following prerequisites:
Clone the repository:
git clone https://github.com/ppy/osu cd osu
To update the source code to the latest commit, run the following command inside the
Build 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
VisualTestsproject/configuration. More information on this is provided below.
.slnffiles, rather than the main
.sln.This will allow access to template run configurations.
You can also build and run osu! from the command-line with a single command:
dotnet run --project osu.Desktop
If you are not interested in debugging osu!, you can add
-c Releaseto gain performance. In this case, you must replace
Releasein any commands mentioned in this document.
If the build fails, try to restore NuGet packages with
Due to a historical feature gap between .NET Core and Xamarin, running
dotnetCLI from the root directory will not work for most commands. This can be resolved by specifying a target
.csprojor the helper project at
build/Desktop.proj. Configurations have been provided to work around this issue for all supported IDEs mentioned above.
Before committing your code, please run a code formatter. This can be achieved by running
dotnet formatin the command line, or using the
Format codecommand 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. Based on past experiences, we have prepared a list of contributing guidelines that should hopefully ease you into our collaboration process and answer the most frequently-asked questions.
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, or with any processes involved with contributing, please bring it up. We welcome all feedback so we can make contributing to this project as painless as possible.
osu!'s code and framework 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.