Mirror of github.com/ppy/osu, in case ppy decides to take the original down for some reason.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Dan Balasescu 2f4f1c6d99
Merge pull request #6538 from peppy/fix-editor-clock-stopping
9 hours ago
.github Test github "funding" button 4 months ago
.idea/.idea.osu/.idea/runConfigurations Update 2.2 references 1 week ago
.vscode Update 2.2 references 1 week ago
assets Add drop shadow 3 months ago
build Update cake dependencies 1 week ago
fastlane Add proper signing and github release support 3 weeks ago
osu.Android Fix version fallback logic 3 weeks ago
osu.Desktop Fix volume scrolling when hovering VersionManager 3 days ago
osu.Game Fix editor's clock not being processed unless composer is loaded 10 hours ago
osu.Game.Rulesets.Catch Use empty hitwindows instead of null 1 week ago
osu.Game.Rulesets.Catch.Tests Update 2.2 references 1 week ago
osu.Game.Rulesets.Catch.Tests.Android Target newer api version 3 months ago
osu.Game.Rulesets.Catch.Tests.iOS Remove iOS BASS libraries and properly reference 2 months ago
osu.Game.Rulesets.Mania Merge pull request #6528 from smoogipoo/fix-mania-selection-movement 12 hours ago
osu.Game.Rulesets.Mania.Tests Update 2.2 references 1 week ago
osu.Game.Rulesets.Mania.Tests.Android Target newer api version 3 months ago
osu.Game.Rulesets.Mania.Tests.iOS Remove iOS BASS libraries and properly reference 2 months ago
osu.Game.Rulesets.Osu Merge pull request #6474 from smoogipoo/osu-beatsnapping-grid 12 hours ago
osu.Game.Rulesets.Osu.Tests Rename grid to DistanceSnap to be more in line with its purpose 1 day ago
osu.Game.Rulesets.Osu.Tests.Android Target newer api version 3 months ago
osu.Game.Rulesets.Osu.Tests.iOS Remove iOS BASS libraries and properly reference 2 months ago
osu.Game.Rulesets.Taiko Use empty hitwindows instead of null 1 week ago
osu.Game.Rulesets.Taiko.Tests Update 2.2 references 1 week ago
osu.Game.Rulesets.Taiko.Tests.Android Target newer api version 3 months ago
osu.Game.Rulesets.Taiko.Tests.iOS Remove iOS BASS libraries and properly reference 2 months ago
osu.Game.Tests Fix hitobject combo colour potentially not getting adjusted 11 hours ago
osu.Game.Tests.Android Target newer api version 3 months ago
osu.Game.Tests.iOS Remove BASS references from osu.Game.Tests.iOS 2 months ago
osu.Game.Tournament Don't automatically return to gameplay from map pool if no picks are made 4 days ago
osu.Game.Tournament.Tests Update 2.2 references 1 week ago
osu.iOS Attempt to appease apple with some plist keys 2 months ago
.editorconfig EditorConfig naming style settings for vs2017. 2 years ago
.gitattributes Force crlf for osu.licenseheader 8 months ago
.gitignore Merge remote-tracking branch 'upstream/master' into android 7 months ago
Gemfile Fastlane initial setup 7 months ago
Gemfile.lock Update fastlane 1 week ago
LICENCE Standardise remaining cases 8 months ago
README.md Update 2.2 references 1 week ago
app.manifest Merge remote-tracking branch 'upstream/master' into tgi74-rightclickscrolling 1 year ago
appveyor.yml Update appveyor images 1 week ago
appveyor_deploy.yml Update appveyor images 1 week ago
build.ps1 Fix build scripts not passing arguments to cake 1 week ago
build.sh Fix build scripts not passing arguments to cake 1 week ago
cake.config Add config file 1 year ago
osu.Android.props Bump ppy.osu.Game.Resources from 2019.913.0 to 2019.1010.0 1 week ago
osu.Android.sln Update Android csproj files 7 months ago
osu.Android.sln.DotSettings Specify Rider analysis rules explicitly 1 month ago
osu.Game.props Standardise remaining cases 8 months ago
osu.TestProject.props Move osu-resources to nuget 8 months ago
osu.iOS.props Revert nativelibs update 1 week ago
osu.iOS.sln Update iOS project in line with changes 8 months ago
osu.iOS.sln.DotSettings Specify Rider analysis rules explicitly 1 month ago
osu.licenseheader Force crlf for osu.licenseheader 8 months ago
osu.sln Use nuget packages again 8 months ago
osu.sln.DotSettings Specify Rider analysis rules explicitly 1 month ago

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 3.0 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+ iOS(iOS 10+) Android (5+)
  • Linux users are recommended to self-compile until we have official deployment in place.

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/netcoreapp3.0" 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.