Go to file
smoogipooo 06c392d6f2 Update OsuMenu in line with framework. 2017-08-25 15:09:07 +09:00
.vscode Update VSCode with new configurations. 2017-08-04 17:18:44 +09:30
osu-framework@5a189d1050 Update OsuMenu in line with framework. 2017-08-25 15:09:07 +09:00
osu-resources@f6042e1cb3 Update resources 2017-08-08 07:18:31 +09:00
osu.Desktop Remove redundant visibility changes 2017-08-22 22:48:50 +09:00
osu.Desktop.Deploy Update paths 2017-08-19 12:28:23 +09:00
osu.Desktop.Tests Make ScrollingPlayfield.Reversed protected; make ManiaPlayfield 'invertible'. 2017-08-23 20:50:03 +09:00
osu.Desktop.VisualTests Merge remote-tracking branch 'upstream/master' into taiko-fixes 2017-08-04 18:04:23 +09:00
osu.Game Update OsuMenu in line with framework. 2017-08-25 15:09:07 +09:00
osu.Game.Rulesets.Catch Update KeyCounterCollection to support action-based buttons 2017-08-21 12:39:22 +09:00
osu.Game.Rulesets.Mania Make ScrollingPlayfield.Reversed protected; make ManiaPlayfield 'invertible'. 2017-08-23 20:50:03 +09:00
osu.Game.Rulesets.Osu Add missing licence header 2017-08-24 20:37:03 +09:00
osu.Game.Rulesets.Taiko Rename keys -> actions 2017-08-24 20:30:18 +09:00
osu.Game.Tests Avoid threading conflicts when resetting the database in unit tests 2017-08-23 14:42:46 +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
.travis.yml
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 Update README.md 2017-05-01 22:00:36 +09:00
appveyor.yml Treat inspectcode warnings as errors (CI) 2017-06-06 22:06:43 +09:00
osu.licenseheader Add/update license headers. 2017-02-14 18:17:35 +09:00
osu.sln Update to support new framework VisualTests structure 2017-08-04 15:37:31 +09:00
osu.sln.DotSettings Optimise file lookups and other database operations 2017-08-01 17:37:21 +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

  • A desktop platform which can compile .NET 4.5 (tested on macOS, linux and windows). We recommend using Visual Studio Code (all platforms) or Visual Studio Community Edition (windows only), both of which are free.
  • Make sure you initialise and keep submodules up-to-date.

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.

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.