osu README

The project's README from github.com/ppy/osu. As one markdown file: README.md.

osu! logo

osu!

Build status GitHub release CodeFactor dev chat Crowdin

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

This is the future – and final – iteration of the osu! 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.

Status

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:

Running osu!

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

Latest release:

Windows 10+ (x64) macOS 12+ (Intel, Apple Silicon) Linux (x64) iOS 13.4+ Android 5+

You can also generally download a version for your current device from the osu! 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 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.

Developing a custom ruleset

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 available here.

You can see some examples of custom rulesets by visiting the custom ruleset directory.

Developing osu!

Prerequisites

Please make sure you have the following prerequisites:

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.

Downloading the source code

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 osu directory:

git pull

Building

From an IDE

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:

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.

From CLI

You can also build and run osu! 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 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.

Testing with resource/framework modifications

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

Windows:

UseLocalFramework.ps1
UseLocalResources.ps1

macOS / Linux:

UseLocalFramework.sh
UseLocalResources.sh

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

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

Code analysis

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.

Contributing

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.

Our team believes in human contributions. Any contribution – be it an issue report or a pull request – which is created by, documented by, or aided by AI/LLM usage will typically be closed and locked without further discussion.

Licence

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.

osu (ppy/osu)

Searching Database…

19.3K ·GitHub
Osu
Что это такое?osu! (lazer) — это бесплатная ритм-игра с моделью «free-to-win»: open-source, будущая и финальная версия игрового клиента osu!, знаменующая начало открытой эры проекта.
Это тот же osu!, который у меня уже стоит, или другая игра?Это следующая версия клиента osu! под кодовым именем «lazer». Она устанавливается рядом с классическим клиентом «stable», так что вы можете попробовать её, не отказываясь от текущей игры.
Как её запустить?Просто скачайте последний релиз для своей платформы с сайта osu! — ничего собирать не нужно. Установщики доступны для Windows 10+, macOS 12+, Linux, iOS и Android.
Есть ли подвох для игроков на iOS?Да — ссылки TestFlight быстро заполняются, потому что Apple ограничивает её 10 000 пользователей, а места освобождаются лишь изредка. Релизы в App Store планируются, чтобы убрать это ограничение.
Это только для игры, или разработчики тоже могут что-то строить на её основе?И то, и другое. osu! рассчитана на создаваемые пользователями варианты геймплея — «rulesets». Разработчик получает библиотеку карт, игровой движок и интерфейс, чтобы сделать свой стиль игры, причём есть готовые шаблоны для старта.
На каких устройствах это работает?Windows 10+ (x64), macOS 12+ (Intel и Apple Silicon), Linux (x64), iOS 13.4+ и Android 5+. Неперечисленные платформы тоже могут заработать, если собрать проект вручную.
Могу ли я использовать код, название и ресурсы игры?Код и фреймворк — под лицензией MIT, то есть с указанием авторства вы можете делать с ними почти что угодно. Но бренды «osu!» и «ppy» защищены как товарные знаки, а игровые ресурсы распространяются по отдельной лицензии.
Что означает кодовое имя «lazer»?Это название новой версии osu! — «as in sharper than cutting-edge» (то есть «ещё острее, чем передовое»). Проект постоянно развивается и будет меняться, пока большинство игроков не предпочтёт его старому релизу «osu!stable».
Какие игровые режимы там есть?Помимо классического режима osu!, в проекте есть режимы catch, mania и taiko, а пользовательские rulesets могут добавить совершенно новые способы игры.
Как запустить игру во время разработки?Одна команда собирает и запускает игру из CLI. Для тестирования производительности добавьте -c Release, потому что конфигурация Debug по умолчанию имеет большие накладные расходы.
What are similar projects?MonoGame, spotube, CircuitLordVRModInstaller, Avalonia, runtime, uno, maui, Mindustry
Which topics is it in?music, game-development, dotnet, game, c#, csharp, app, gaming, audio, mobile-app, mobile, desktop
Creator
ppy
Size
201.8 MB
Stars
19.3K
Updated
CommitOct 15Release2026.1005.0-lazerOct 05
Age
12y
Commits · 90 Days