Go to file
Dean Herbert 2bf2cc15d4 Fix unnecessary osu-resources rollback 2018-01-12 18:09:37 +09:00
.vscode Update tasks.json to remove warnings 2017-12-11 16:32:19 +09:00
osu-framework@6594729122 Update framework 2018-01-11 21:12:27 +09:00
osu-resources@7724abdf1d Fix unnecessary osu-resources rollback 2018-01-12 18:09:37 +09:00
osu.Desktop Update licence headers 2018-01-05 20:21:19 +09:00
osu.Desktop.Deploy Update licence headers 2018-01-05 20:21:19 +09:00
osu.Game Merge remote-tracking branch 'upstream/master' into fix-mod-implementation-check 2018-01-12 17:49:31 +09:00
osu.Game.Rulesets.Catch Merge remote-tracking branch 'upstream/master' into fix-mod-implementation-check 2018-01-12 17:49:31 +09:00
osu.Game.Rulesets.Mania Merge remote-tracking branch 'upstream/master' into fix-mod-implementation-check 2018-01-12 17:49:31 +09:00
osu.Game.Rulesets.Osu Remove extra newline 2018-01-12 18:07:40 +09:00
osu.Game.Rulesets.Taiko Make ScrollingHitObjectContainer handle nested hitobjects 2018-01-11 15:08:30 +09:00
osu.Game.Tests Merge branch 'master' into scrolling-hitobjects-rewrite 2018-01-12 17:35:24 +09:00
.editorconfig EditorConfig naming style settings for vs2017. 2017-02-28 11:37:08 +08:00
.gitattributes Revert .gitattributes additions for now. 2016-10-15 20:43:42 +09:00
.gitignore Add missing file. 2017-02-26 18:28:01 +09:00
.gitmodules Initial commit. 2016-08-26 14:41:47 +09:00
.travis.yml Initial commit. 2016-08-26 14:41:47 +09:00
COMPILING.md Update COMPILING.md 2017-12-28 15:25:54 +01:00
ISSUE_TEMPLATE.md Add ISSUE_TEMPLATE.md 2016-12-28 00:06:45 -05:00
LICENCE Update licence year. 2017-02-12 20:39:21 +09:00
README.md Improve wording and fix macOS requirement 2017-12-30 18:20:51 +09:00
appveyor.yml Quieten nuget 2017-11-29 12:27:18 +09:00
osu.Game.props Merge LangVer.props and osu.Game.props 2017-12-01 13:53:32 +09:00
osu.licenseheader Update licence headers 2018-01-05 20:21:19 +09:00
osu.sln Revert incorrectly changed GUID 2017-11-01 23:38:08 +09:00
osu.sln.DotSettings FIx incorrect licence header template 2018-01-07 12:02:42 +09:00

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!

Status

This is still heavily under development and is not intended for end-user use. This repository is intended for developer collaboration. You're welcome to try and use it but please do not submit bug reports without a patch. Please do not ask for help building or using this software.

Requirements

Getting Started

  • Clone the repository including submodules (git clone --recurse-submodules https://github.com/ppy/osu)
  • Build in your IDE of choice (recommended IDEs automatically restore nuget packages; if you are using an alternative make sure to nuget 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.