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 89a05c086c
Merge pull request #4314 from peppy/fix-more-e
21 hours ago
.github Remove github pull request template 1 week ago
.idea/.idea.osu/.idea/runConfigurations Fix targeting netcoreapp2.1 in many places 2 months ago
.vscode Improve the buildscript 1 week ago
build Remove the unused desktop project variable 6 days ago
osu.Desktop Woops 22 hours ago
osu.Game Revert some more instances of 'e' variable names 22 hours ago
osu.Game.Rulesets.Catch Adjust namespaces 1 day ago
osu.Game.Rulesets.Catch.Tests Remove LegacyDifficultyCalculator 2 days ago
osu.Game.Rulesets.Catch.Tests.iOS Update iOS project in line with changes 3 weeks ago
osu.Game.Rulesets.Mania Revert some more instances of 'e' variable names 22 hours ago
osu.Game.Rulesets.Mania.Tests Merge branch 'master' into osu-fontusage 1 day ago
osu.Game.Rulesets.Mania.Tests.iOS Update iOS project in line with changes 3 weeks ago
osu.Game.Rulesets.Osu Revert some more instances of 'e' variable names 22 hours ago
osu.Game.Rulesets.Osu.Tests Merge branch 'master' into osu-fontusage 1 day ago
osu.Game.Rulesets.Osu.Tests.iOS Update iOS project in line with changes 3 weeks ago
osu.Game.Rulesets.Taiko Adjust namespaces 1 day ago
osu.Game.Rulesets.Taiko.Tests Remove LegacyDifficultyCalculator 2 days ago
osu.Game.Rulesets.Taiko.Tests.iOS Update iOS project in line with changes 3 weeks ago
osu.Game.Tests Revert some more instances of 'e' variable names 22 hours ago
osu.Game.Tests.iOS Update iOS project in line with changes 3 weeks ago
osu.iOS Update iOS project in line with changes 3 weeks ago
.editorconfig EditorConfig naming style settings for vs2017. 2 years ago
.gitattributes Force crlf for osu.licenseheader 4 weeks ago
.gitignore Improve the buildscript 1 week ago
.gitmodules Move osu-resources to nuget 3 weeks ago
.travis.yml Normalize all the line endings 10 months ago
LICENCE Standardise remaining cases 1 month ago
README.md Fix typo in README.md 2 weeks ago
app.manifest Merge remote-tracking branch 'upstream/master' into tgi74-rightclickscrolling 10 months ago
appveyor.yml Merge branch 'master' of https://github.com/ppy/osu into Cakefy_osu! 6 months ago
build.ps1 Improve the buildscript 1 week ago
build.sh Correct the path to the cakebuild.csproj. 5 days ago
cake.config Add config file 4 months ago
osu.Game.props Standardise remaining cases 1 month ago
osu.TestProject.props Move osu-resources to nuget 3 weeks ago
osu.iOS.props Update framework 1 day ago
osu.iOS.sln Update iOS project in line with changes 3 weeks ago
osu.iOS.sln.DotSettings Update iOS dotsettings file 3 weeks ago
osu.licenseheader Force crlf for osu.licenseheader 4 weeks ago
osu.sln Update iOS project in line with changes 3 weeks ago
osu.sln.DotSettings Use leased bindables 3 weeks 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.

Requirements

Running osu!

Releases

If you are not interested in developing the game, please head over to the releases to download a precompiled build with automatic updating enabled.

  • Windows (x64) users should download and run install.exe.
  • macOS users (10.12 “Sierra” and higher) should download and run osu.app.zip.
  • iOS users can join the TestFlight beta program.

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 including submodules:

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 .NET Core SDK. You can have it with 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.

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.

Contributions can be made via pull requests to this repository. We hope to credit and reward larger contributions via a bounty system. If you’re unsure of what you can help with, check out the list of open issues.

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. I welcome all feedback so we can make contributing to this project as pain-free as possible.

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.