rhythm is just a *click* away!
Clone or download
peppy Merge pull request #4103 from ekrctb/taiko-namespace
Fix taiko sample namespace ignored
Latest commit ca470ff Jan 22, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Update template Nov 5, 2018
.idea/.idea.osu/.idea/runConfigurations Fix targeting netcoreapp2.1 in many places Dec 21, 2018
.vscode Fix targeting netcoreapp2.1 in many places Dec 21, 2018
osu-resources @ 9880089 Update resources Dec 20, 2018
osu.Desktop Update framework and other nuget packages Jan 16, 2019
osu.Game.Rulesets.Catch.Tests Update framework and other nuget packages Jan 16, 2019
osu.Game.Rulesets.Catch remove blank lines Jan 11, 2019
osu.Game.Rulesets.Mania.Tests Update framework and other nuget packages Jan 16, 2019
osu.Game.Rulesets.Mania Use IApplicableToBeatmap for mirror and random mania mods Jan 16, 2019
osu.Game.Rulesets.Osu.Tests Update framework and other nuget packages Jan 16, 2019
osu.Game.Rulesets.Osu Fix final section not being saved Jan 17, 2019
osu.Game.Rulesets.Taiko.Tests Update framework and other nuget packages Jan 16, 2019
osu.Game.Rulesets.Taiko Use Find instead of FirstOrDefault Jan 5, 2019
osu.Game.Tests Merge branch 'master' into update-framework Jan 16, 2019
osu.Game Merge branch 'master' into taiko-namespace Jan 22, 2019
tools Use the coreclr instead of caketool, hoping that the version fixes ru… Oct 5, 2018
.editorconfig EditorConfig naming style settings for vs2017. Feb 28, 2017
.gitattributes Merge remote-tracking branch 'upstream/master' into tgi74-rightclicks… Apr 18, 2018
.gitignore Change .idea ignore rules to not ignore run configurations Nov 6, 2018
.gitmodules Merge upstream master into external-deploy Jun 6, 2018
.travis.yml Normalize all the line endings Apr 13, 2018
ISSUE_TEMPLATE.md Update ISSUE_TEMPLATE Mar 10, 2018
LICENCE Update license year. Jan 22, 2018
README.md Format better Jan 21, 2019
app.manifest Merge remote-tracking branch 'upstream/master' into tgi74-rightclicks… Apr 18, 2018
appveyor.yml Merge branch 'master' of https://github.com/ppy/osu into Cakefy_osu! Jul 30, 2018
build.cake Fix weird code formatting Oct 30, 2018
build.ps1 Use the coreclr instead of caketool, hoping that the version fixes ru… Oct 5, 2018
build.sh Add executable flag to build.sh Nov 6, 2018
cake.config Add config file Oct 5, 2018
osu.Game.props Pass sub-controlpoints as span slices Oct 11, 2018
osu.TestProject.props Remove nuget includes im props Oct 12, 2018
osu.licenseheader Update licence headers Jan 5, 2018
osu.sln Merge upstream master into external-deploy Jun 6, 2018
osu.sln.DotSettings Add rider live templates Dec 26, 2018

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 --recurse-submodules https://github.com/ppy/osu
cd osu

If you forgot the --recurse-submodules option, run this command inside the osu directory:

git submodule update --init --recursive

To update the source code to the latest commit, run the following command inside the osu directory:

git pull --recurse-submodules

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

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. Alternative, 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.