rhythm is just a *click* away!
C#
Clone or download
smoogipoo Merge pull request #3063 from peppy/fix-model-import
Fix ArchiveModelManager's model import method not running import logic
Latest commit 1796ffd Jul 20, 2018
Permalink
Failed to load latest commit information.
.github Add a simple Pull Request template Jun 22, 2018
.idea/.idea.osu/.idea/runConfigurations Update rider configuration names Jun 19, 2018
.vscode Remove extra , make this valid JSON file Jul 5, 2018
osu-resources @ c3848d8 Update submodules Mar 27, 2018
osu.Desktop Change default to being important Jul 16, 2018
osu.Game.Rulesets.Catch.Tests Use switch with type matching in place of if-else where possible Jul 17, 2018
osu.Game.Rulesets.Catch Merge branch 'master' into use-switch-over-if Jul 17, 2018
osu.Game.Rulesets.Mania.Tests Remove scroll direction from ScrolingPlayfield constructor Jul 17, 2018
osu.Game.Rulesets.Mania Merge branch 'master' into use-switch-over-if Jul 17, 2018
osu.Game.Rulesets.Osu.Tests Add common custom words to dotsettings dictionary Jul 5, 2018
osu.Game.Rulesets.Osu Fix GameplayCursor state not restoring correctly after Show/Hide Jul 18, 2018
osu.Game.Rulesets.Taiko.Tests Public + explicitly define test fixtures Jun 27, 2018
osu.Game.Rulesets.Taiko Fix potential quadratic complexity in taiko autoplay Jul 17, 2018
osu.Game.Tests Merge branch 'master' into pause-input-fixes Jul 20, 2018
osu.Game Merge branch 'master' into fix-model-import Jul 20, 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 Normalize all the line endings Apr 13, 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 Update nuget restore instructions Jul 8, 2018
app.manifest Merge remote-tracking branch 'upstream/master' into tgi74-rightclicks… Apr 18, 2018
appveyor.yml Turn cache back on for chocolatey packages Jul 11, 2018
appveyor_deploy.yml Disable caches Jun 6, 2018
osu.Game.props Add back app.manifest Apr 11, 2018
osu.TestProject.props Update framework and other nuget dependencies Jun 26, 2018
osu.licenseheader Update licence headers Jan 5, 2018
osu.sln Merge upstream master into external-deploy Jun 6, 2018
osu.sln.DotSettings Add common custom words to dotsettings dictionary Jul 5, 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

Building and running

If you are not interested in developing the game, please head over to the releases to download a precompiled build with automatic updating enabled (download and run the install executable for your platform).

Clone the repository including submodules

git clone --recurse-submodules https://github.com/ppy/osu

Build and run

  • Using Visual Studio 2017, Rider or Visual Studio Code (configurations are included)
  • From command line using dotnet run --project osu.Desktop --framework netcoreapp2.1

The above methods should automatically do so, but if you run into issues building you may need to restore nuget packages (commonly via dotnet restore).

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.