A free-to-win rhythm game. Rhythm is just aclickaway!
The future ofosu!and 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 heavy development, but is in a stable state. Users are encouraged to try it out and keep it installed alongside the stableosu!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 potentiallyreduce 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:
- Detailed release changelogs are available on theofficial osu! site.
- You can learn more about our approach toproject management.
- Read peppy'sblog postexploring where the project is currently and the roadmap going forward.
If you are looking to install or test osu! without setting up a development environment, you can consume ourbinary releases.Handy links below will download the latest version for your operating system of choice:
Latest build:
| Windows 8.1+ (x64) | macOS 10.15+ (Intel,Apple Silicon) | Linux (x64) | iOS 13.4+ | Android 5+ |
|---|
- The iOS testflight link may fill up (Apple has a hard limit of 10,000 users). We reset it occasionally when this happens. Please do not ask about this. Check back regularly for link resets or followpeppyon twitter for announcements of link resets.
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 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 6.0 SDKinstalled.
- When developing with mobile,Xamarinis required, which is shipped together with Visual Studio orVisual Studio for Mac.
- 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 RiderorVisual Studio Code.
- When running on Linux, please have a system-wide FFmpeg installation available to support video decoding.
Clone the repository:
git clone https://github /ppy/osu
cdosuTo update the source code to the latest commit, run the following command inside theosudirectory:
git pullBuild 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 theVisualTestsproject/configuration. More information on this is providedbelow.
- Visual Studio / Rider users should load the project via one of the platform-specific
.slnffiles, rather than the main.sln.This will allow access to template run configurations.
You can also build and runosu!from the command-line with a single command:
dotnet run --project osu.DesktopIf you are not interested in debuggingosu!,you can add-c Releaseto gain performance. In this case, you must replaceDebugwithReleasein any commands mentioned in this document.
If the build fails, try to restore NuGet packages withdotnet restore.
Due to a historical feature gap between.NET Core and Xamarin, runningdotnetCLI from the root directory will not work for most commands. This can be resolved by specifying a target.csprojor the helper project atbuild/Desktop.proj.Configurations have been provided to work around this issue for all supported IDEs mentioned above.
Sometimes it may be necessary to cross-test changes inosu-resourcesorosu-framework.This can be achieved by running some commands as documented on theosu-resourcesandosu-frameworkwiki pages.
Before committing your code, please run a code formatter. This can be achieved by runningdotnet formatin the command line, or using theFormat 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. Please refer to thecontributing guidelinesto understand how to help in the most effective way possible.
If you wish to help with localisation efforts, head over tocrowdin.
For those interested, we love to reward quality contributions viabounties,paid out via PayPal or osu!supporter tags. Don't hesitate torequest a bountyfor your work on this project.
osu!'s code and framework are licensed under theMIT licence.Please seethe licence filefor more information.tl;dryou 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 coverthe 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-resourcesrepository for clarifications.