No description
Find a file
2026-11-14 20:11:53 +03:00
.config Update framework (#38818) 2026-09-15 12:41:16 +09:00
.githooks chore: fix code quality and add pre-commit hook 2026-10-29 09:38:28 +03:00
.github ci: stabilize Linux test execution 2026-10-28 15:29:33 +03:00
.idea Reset UI scale for mobile platforms 2025-02-14 06:25:53 -05:00
.run Update Rider configuration files 2024-02-16 01:45:38 +03:00
.vscode feat(auth): implement auth subsystem 2026-10-21 17:44:38 +03:00
assets feat(deploy): add osu!oss packaging and nightly releases 2026-10-28 08:13:58 +03:00
CodeAnalysis Ban culture-unsafe taglib APIs 2025-04-28 09:26:39 +02:00
docs/js_examples refactor(scripting): extract engine-neutral services shared with C# plugins 2026-10-24 15:53:51 +03:00
osu.Android chore(versioning): unify game version and add lazer suffix 2026-10-27 20:42:24 +03:00
osu.Desktop feat(storage): centralize osu-oss data 2026-10-29 11:34:26 +03:00
osu.Game feat(song-select): highlight favourite beatmapsets 2026-10-29 13:15:53 +03:00
osu.Game.API fix(plugins): prevent duplicate plugin loads 2026-10-29 14:42:02 +03:00
osu.Game.API.UI style: resolve remaining code analysis warnings 2026-10-28 14:14:21 +03:00
osu.Game.Auth fix: incompatible architecture need arm64e on macOS 2026-11-04 23:22:54 +03:00
osu.Game.Auth.Supervisor refactor(auth): align namespaces with folder structure 2026-10-28 14:38:17 +03:00
osu.Game.Benchmarks Replace APIMod.ToMod() passthrough invocations with direct invocations of new extension method (#38986) 2026-10-06 21:20:23 +09:00
osu.Game.Rulesets.Catch update osu! drain time thresholds to match current RC (#38987) 2026-10-06 21:55:20 +09:00
osu.Game.Rulesets.Catch.Tests Make pressing ESC first deselect any placement tool (#38921) 2026-09-29 20:31:05 +09:00
osu.Game.Rulesets.Catch.Tests.Android Use CoreCLR runtime on Android (#39029) 2026-10-15 08:35:10 +02:00
osu.Game.Rulesets.Catch.Tests.iOS Fix iOS hard crash on startup on iOS 27 devices (#38966) 2026-10-04 21:32:26 +09:00
osu.Game.Rulesets.Mania update osu! drain time thresholds to match current RC (#38987) 2026-10-06 21:55:20 +09:00
osu.Game.Rulesets.Mania.Tests fix(gameplay): source break skipping from playable beatmap 2026-10-24 16:23:25 +03:00
osu.Game.Rulesets.Mania.Tests.Android Use CoreCLR runtime on Android (#39029) 2026-10-15 08:35:10 +02:00
osu.Game.Rulesets.Mania.Tests.iOS Fix iOS hard crash on startup on iOS 27 devices (#38966) 2026-10-04 21:32:26 +09:00
osu.Game.Rulesets.Osu Refactor flashlight difficulty attribute (#38982) 2026-10-08 11:41:33 +09:00
osu.Game.Rulesets.Osu.Tests Make pressing ESC first deselect any placement tool (#38921) 2026-09-29 20:31:05 +09:00
osu.Game.Rulesets.Osu.Tests.Android Use CoreCLR runtime on Android (#39029) 2026-10-15 08:35:10 +02:00
osu.Game.Rulesets.Osu.Tests.iOS Fix iOS hard crash on startup on iOS 27 devices (#38966) 2026-10-04 21:32:26 +09:00
osu.Game.Rulesets.Taiko update osu! drain time thresholds to match current RC (#38987) 2026-10-06 21:55:20 +09:00
osu.Game.Rulesets.Taiko.Tests Update framework (#38818) 2026-09-15 12:41:16 +09:00
osu.Game.Rulesets.Taiko.Tests.Android Use CoreCLR runtime on Android (#39029) 2026-10-15 08:35:10 +02:00
osu.Game.Rulesets.Taiko.Tests.iOS Fix iOS hard crash on startup on iOS 27 devices (#38966) 2026-10-04 21:32:26 +09:00
osu.Game.Tests fix(plugins): prevent duplicate plugin loads 2026-10-29 14:42:02 +03:00
osu.Game.Tests.Android fix(mobile): reference game API from test projects 2026-10-28 14:38:17 +03:00
osu.Game.Tests.iOS fix(mobile): reference game API from test projects 2026-10-28 14:38:17 +03:00
osu.Game.Tournament style: resolve remaining code analysis warnings 2026-10-28 14:14:21 +03:00
osu.Game.Tournament.Tests Update framework (#38818) 2026-09-15 12:41:16 +09:00
osu.iOS chore(versioning): unify game version and add lazer suffix 2026-10-27 20:42:24 +03:00
Templates Update framework (#38818) 2026-09-15 12:41:16 +09:00
tools fix(release): use deploy root for macOS entitlements 2026-10-28 14:50:31 +03:00
.editorconfig Update framework (#38818) 2026-09-15 12:41:16 +09:00
.envrc feat(auth): implement auth subsystem 2026-10-21 17:44:38 +03:00
.git-blame-ignore-revs Add automated commit to blame ignore revs 2023-06-24 01:56:38 +09:00
.gitattributes Force crlf for osu.licenseheader 2019-01-25 16:22:20 +09:00
.gitignore feat(deploy): add osu!oss packaging and nightly releases 2026-10-28 08:13:58 +03:00
app.manifest Remove manifest DPI awareness entires 2023-07-01 19:11:48 +02:00
CONTRIBUTING.md Add note on AI usage in contributions 2026-04-16 18:24:14 +09:00
Directory.Build.props feat(deploy): add osu!oss packaging and nightly releases 2026-10-28 08:13:58 +03:00
flake.lock feat(auth): implement auth subsystem 2026-10-21 17:44:38 +03:00
flake.nix feat: devshell other systems compat 2026-11-04 22:56:58 +03:00
FodyWeavers.xml Disable realm analytics submission 2021-06-28 17:37:58 +09:00
global.json Upgrade to .NET 10.0 (#38039) 2026-09-09 15:50:38 +09:00
InspectCode.ps1 fix InspectCode scripts after nvika removal (#38857) 2026-09-21 17:24:56 +09:00
InspectCode.sh fix InspectCode scripts after nvika removal (#38857) 2026-09-21 17:24:56 +09:00
LICENCE Update various licence years 2025-07-09 12:46:14 +09:00
osu.Android.props Add score attribute text skinnable component (#39052) 2026-10-20 00:08:57 +09:00
osu.Android.slnf Use slnf for filtering platform. 2019-10-30 21:35:58 +08:00
osu.Desktop.slnf refactor(auth): merge isolation into the auth assembly 2026-10-27 18:09:01 +03:00
osu.iOS.props Add score attribute text skinnable component (#39052) 2026-10-20 00:08:57 +09:00
osu.iOS.slnf Add missing project to iOS filter. 2019-11-08 21:17:59 +08:00
osu.licenseheader Force crlf for osu.licenseheader 2019-01-25 16:22:20 +09:00
osu.sln refactor(auth): merge isolation into the auth assembly 2026-10-27 18:09:01 +03:00
osu.sln.DotSettings Update framework (#38818) 2026-09-15 12:41:16 +09:00
osu.TestProject.props Normalize .props 2019-10-30 21:54:14 +08:00
README.md chore: replace icon in README 2026-10-28 18:16:35 +03:00
UseLocalFramework.ps1 Add mobile local framework reference support 2023-02-21 18:59:33 +03:00
UseLocalFramework.sh Add mobile local framework reference support 2023-02-21 18:59:33 +03:00
UseLocalResources.ps1 Add helper scripts for using local resources 2022-11-12 17:22:18 +09:00
UseLocalResources.sh Add helper scripts for using local resources 2022-11-12 17:22:18 +09:00

osu! logo

osu!oss

A source-built osu! client that connects to the official servers without hooks or runtime patching.

Before you start

osu!oss is an unofficial fork of osu!lazer and is not affiliated with ppy Pty Ltd.

Using a modified client violates the osu! Terms of Service. Account restrictions are possible. The risk is lower than with binary patching or runtime modification, because osu!oss does not inject into an installed official client or patch it after launch, but the risk is not zero. You use osu!oss at your own risk.

osu!oss contains no cheats and will not add them. Contributions that add gameplay advantages, gameplay automation, or other cheating functionality are not accepted.

What it is

osu!oss is built from source. The client itself is changed, not an installed official binary. Authentication is implemented in osu.Game.Auth and uses the official client's managed auth module with pristine assemblies fetched from the matching osu! release.

As far as we know, this is the first public project to run a source-modified osu! client against the official servers this way.

Status

Early development. There are no installers or prebuilt packages yet; the client is built and run from source. Authentication uses the transplant path only.

Current features

  • Official-server authentication via transplant mode, including the first-run download of the required official files.
  • osu!oss settings section: incompatible mods, system mods, "Download all favourites", break skipping, and auto-skip for breaks, intro/outro, or both.
  • Layout controls: toolbar position and inversion, notification panel and toast positions, settings panel on either side, muted and transparent notifications.
  • Themes: 11 built-in themes, custom JSON themes, glass blur, and aggressive tinting. The default is Midnight (Violet).
  • Skin cursor for the menu.
  • JavaScript scripting: editor, console (Ctrl+F4), persistent script storage, event and notification APIs.
  • Command palette (Ctrl+Space) with fuzzy search, argument hints, and built-in commands such as search, mods, skin, ruleset, randommap, and exit.

Authentication (osu.Game.Auth)

The module installs APIRequest.Sign and HubClientConnector.Sign, so requests and SignalR connections are signed in the same places as in the official client.

transplant

  • Fetches pristine, version-matched official assemblies and the managed auth module from the matching GitHub release: the AppImage on Linux, the app ZIP on macOS, and the Squirrel package on Windows. Neither the measured game assemblies nor the managed auth module are shipped in this repository.
  • Caches them under <osu! storage>/osu-oss/auth-blobs and disables signing until the set is complete. The first launch downloads them in the background; restart after it finishes.
  • Loads the managed auth module from the cache as osu.Game.Auth.transplant.dll and delegates signing to it.
  • Redirects the module's measurements to the pristine files with the authredirect shim. On Linux and macOS the game re-executes itself with LD_PRELOAD/DYLD_INSERT_LIBRARIES; on Windows the shim is loaded into the process.
  • On Linux, the module runs under a seccomp user-notification filter with a separate supervisor process. Process creation, tracing, namespaces, mounts, kernel-module operations, and network access are denied by default. Windows and macOS only have the redirect shim; there is no seccomp equivalent there.

Relevant environment variables:

  • AUTHISOLATE — enforce (default), audit, or 0 to disable isolation.
  • AUTHISOLATE_NET — deny (default) or allow.
  • AUTHISOLATE_LOG — path to the supervisor log.
  • OSU_AUTH_NO_REEXEC=1 — do not re-execute with the shim on Linux/macOS (useful when debugging).
  • OSU_AUTHREDIRECT — override the shim path.
  • OSU_AUTH_TRANSPLANT — override the transplant assembly path.

Running from source

Requirements

  • .NET SDK 10.0 (see global.json).
  • Git.
  • A C compiler for the auth redirect shim:
    • Linux: cc (build-essential or base-devel) and libseccomp (libseccomp2 on Debian/Ubuntu, libseccomp on Arch).
    • macOS: Xcode Command Line Tools (clang).
    • Windows: Visual Studio Build Tools with the C++ workload, or mingw-w64. Without a compiler the shim is not built and transplant authentication will not work.
  • The usual osu!lazer desktop runtime dependencies (SDL3, OpenGL/Vulkan, audio).

Clone and restore:

git clone ssh://forgejo@git.ruject.fun/RuJect/osu-oss.git
cd osu-oss
dotnet restore

Build and run:

dotnet run --project osu.Desktop -c Release

Use -c Debug while working on the code.

Platform notes

Linux. The shim is built automatically as authredirect.so. If you use Nix, nix develop provides the SDK, compiler, and runtime libraries; run-osu starts the client.

Windows. Run from a Developer PowerShell where cl is available, or install mingw-w64 and pass -p:AuthRedirectShimWindowsToolchain=mingw to dotnet run. MSVC builds the shim automatically when the Visual Studio environment is present.

macOS. Xcode Command Line Tools provide clang, which builds authredirect.dylib automatically.

First launch

On first launch, osu!oss downloads the official authentication files. Wait for the notification, then restart. The log should contain Using transplanted (proprietary) auth signing. If it says that signing is disabled or that the native path was used, check the shim and the auth-blobs cache.

Files specific to osu!oss live next to the normal osu! data:

  • osu-oss/config.ini
  • osu-oss/themes/
  • osu-oss/scripts/
  • osu-oss/auth-blobs/

Roadmap

  • Prebuilt executables and installers.
  • Plugin subsystem.
  • Colored usernames.
  • Android support; iOS is being considered.
  • Sharing skins and settings.
  • Custom toolbar widgets.
  • Keyboard shortcuts for commands.

No dates. The order may change.

Contact

For security issues, use email rather than a public issue.

Licence and credits

osu!oss is based on ppy/osu and keeps its MIT licence; see LICENCE. The osu! and ppy names and branding are not covered by the MIT licence and belong to ppy Pty Ltd. Game resources and the downloaded official authentication files keep their original terms.