Skip to content
See here for (incomplete) documentation of the new pp system ->
C# Other
  1. C# 99.8%
  2. Other 0.2%
Branch: master
Clone or download
#1 Compare This branch is 207 commits ahead, 5111 commits behind ppy:master.

Latest commit

Latest commit 9e09d10 Feb 26, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Test github "funding" button Jun 4, 2019
.idea/.idea.osu/.idea/runConfigurations Move rider configurations into folders Jun 18, 2019
.vscode Add VSCode debug configs Jun 21, 2019
assets Add drop shadow Jul 12, 2019
build Update cake Aug 2, 2019
fastlane Reorder functions in Fastfile for readability Aug 16, 2019
osu.Android Remove Android BASS libraries Aug 9, 2019
osu.Desktop Hide NotificationOverlay Aug 13, 2019
osu.Game.Rulesets.Catch.Tests.Android Target newer api version Jul 4, 2019
osu.Game.Rulesets.Catch.Tests.iOS Remove iOS BASS libraries and properly reference Aug 9, 2019
osu.Game.Rulesets.Catch.Tests Merge branch 'master' Sep 5, 2019
osu.Game.Rulesets.Catch Revert SkinnableSprite lookups to old behaviour Sep 3, 2019
osu.Game.Rulesets.Mania.Tests.Android Target newer api version Jul 4, 2019
osu.Game.Rulesets.Mania.Tests.iOS Remove iOS BASS libraries and properly reference Aug 9, 2019
osu.Game.Rulesets.Mania.Tests Bump NUnit3TestAdapter from 3.15.0 to 3.15.1 Aug 30, 2019
osu.Game.Rulesets.Mania Merge remote-tracking branch 'upstream/master' into non-timeoffset-ju… Sep 3, 2019
osu.Game.Rulesets.Osu.Tests.Android Target newer api version Jul 4, 2019
osu.Game.Rulesets.Osu.Tests.iOS Remove iOS BASS libraries and properly reference Aug 9, 2019
osu.Game.Rulesets.Osu.Tests Refactor skin configuration to be infinitely extensible Sep 3, 2019
osu.Game.Rulesets.Osu remove small jump nerf Feb 26, 2020
osu.Game.Rulesets.Taiko.Tests.Android Target newer api version Jul 4, 2019
osu.Game.Rulesets.Taiko.Tests.iOS Remove iOS BASS libraries and properly reference Aug 9, 2019
osu.Game.Rulesets.Taiko.Tests Expose full hitobject rather than hit windows Sep 2, 2019
osu.Game.Rulesets.Taiko Fix taiko sample namespace Sep 4, 2019
osu.Game.Tests.Android Target newer api version Jul 4, 2019
osu.Game.Tests.iOS Remove BASS references from osu.Game.Tests.iOS Aug 9, 2019
osu.Game.Tests Merge pull request ppy#5969 from peppy/skin-configuration-refactor Sep 5, 2019
osu.Game.Tournament.Tests Bump NUnit3TestAdapter from 3.15.0 to 3.15.1 Aug 30, 2019
osu.Game.Tournament Update framework Aug 21, 2019
osu.Game add modified acc to scoreinfo Oct 25, 2019
osu.iOS Attempt to appease apple with some plist keys Aug 13, 2019
.editorconfig EditorConfig naming style settings for vs2017. Feb 28, 2017
.gitattributes Force crlf for osu.licenseheader Jan 25, 2019
.gitignore Merge remote-tracking branch 'upstream/master' into android Mar 5, 2019
Gemfile Fastlane initial setup Mar 1, 2019
Gemfile.lock Update fastlane plugins Aug 16, 2019
LICENCE Standardise remaining cases Jan 24, 2019
README.md Fix double grammar Aug 13, 2019
app.manifest Merge remote-tracking branch 'upstream/master' into tgi74-rightclicks… Apr 18, 2018
appveyor.yml Add basic nuget deploy support Sep 4, 2019
appveyor_deploy.yml Add basic nuget deploy support Sep 4, 2019
build.ps1 Improve the buildscript Feb 15, 2019
build.sh Correct the path to the cakebuild.csproj. Feb 17, 2019
cake.config Add config file Oct 5, 2018
osu.Android.props Update framework Sep 5, 2019
osu.Android.sln Update Android csproj files Mar 5, 2019
osu.Android.sln.DotSettings Update Android csproj files Mar 5, 2019
osu.Game.props Standardise remaining cases Jan 24, 2019
osu.TestProject.props Move osu-resources to nuget Jan 28, 2019
osu.iOS.props Bump Humanizer from 2.6.2 to 2.7.2 Sep 6, 2019
osu.iOS.sln Update iOS project in line with changes Jan 29, 2019
osu.iOS.sln.DotSettings Add flag to osu.iOS.sln.DotSettings Feb 26, 2019
osu.licenseheader Force crlf for osu.licenseheader Jan 25, 2019
osu.sln Remove mistaken change Jul 1, 2019
osu.sln.DotSettings Merge remote-tracking branch 'origin/master' into fix-new-inspections May 7, 2019

README.md

osu!

Build status CodeFactor dev chat

Rhythm is just a click away. The future of osu! and the beginning of an open era! Commonly known by the codename "osu!lazer". Pew pew.

Status

This project is still heavily under development, but is in a state where users are encouraged to try it out and keep it installed alongside the stable osu! client. It will continue to evolve over the coming months and hopefully bring some new unique features to the table.

We are accepting bug reports (please report with as much detail as possible). Feature requests are welcome as long as you read and understand the contribution guidelines listed below.

Detailed changelogs are published on the official osu! site.

Requirements

  • A desktop platform with the .NET Core SDK 2.2 or higher installed.
  • When running on linux, please have a system-wide ffmpeg installation available to support video decoding.
  • When running on Windows 7 or 8.1, additional prerequisites may be required to correctly run .NET Core applications if your operating system is not up-to-date with the latest service packs.
  • When working with the codebase, we recommend using an IDE with intellisense and syntax highlighting, such as Visual Studio 2017+, Jetbrains Rider or Visual Studio Code.

Running osu!

Releases

If you are not interested in developing the game, you can still consume our binary releases.

Latest build:

Windows (x64) macOS 10.12+
  • Linux users are recommended to self-compile until we have official deployment in place.
  • iOS users can join the TestFlight beta program (note that due to high demand this is regularly full).
  • Android users can self-compile, and expect a public beta soon.

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

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

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 VisualTests project/configuration. More information on this provided below.

Visual Studio Code users must run the Restore task before any build attempt.

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 Release to gain performance. In this case, you must replace Debug with Release in any commands mentioned in this document.

If the build fails, try to restore nuget packages with dotnet restore.

A note for Linux users

On Linux, the environment variable LD_LIBRARY_PATH must point to the build directory, located at osu.Desktop/bin/Debug/$NETCORE_VERSION.

$NETCORE_VERSION is the version of the targeted .NET Core SDK. You can check it by running grep TargetFramework osu.Desktop/osu.Desktop.csproj | sed -r 's/.*>(.*)<\/.*/\1/'.

For example, you can run osu! with the following command:

LD_LIBRARY_PATH="$(pwd)/osu.Desktop/bin/Debug/netcoreapp2.2" dotnet run --project osu.Desktop

Testing with resource/framework modifications

Sometimes it may be necessary to cross-test changes in osu-resources or osu-framework. This can be achieved by running some commands as documented on the osu-resources and osu-framework wiki pages.

Code analysis

Code analysis can be run with powershell ./build.ps1 or build.sh. This is currently only supported under windows due to resharper cli shortcomings. Alternatively, you can install resharper or use rider to get inline support in your IDE of choice.

Contributing

We welcome all contributions, but keep in mind that we already have a lot of the UI designed. If you wish to work on something with the intention on having it included in the official distribution, please open an issue for discussion and we will give you what you need from a design perspective to proceed. If you want to make changes to the design, we recommend you open an issue with your intentions before spending too much time, to ensure no effort is wasted.

If you're unsure of what you can help with, check out the list of open issues (especially those with the "good first issue" label).

Before starting, please make sure you are familiar with the development and testing procedure we have set up. New component development, and where possible, bug fixing and debugging existing components should always be done under VisualTests.

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; with any processes involved with contributing, please bring it up. We welcome all feedback so we can make contributing to this project as pain-free as possible.

For those interested, we love to reward quality contributions via bounties, paid out via paypal or osu! supporter tags. Don't hesitate to request a bounty for your work on this project.

Licence

The osu! client 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.

You can’t perform that action at this time.