osu-lazer/README.md

osu!

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

• A desktop platform with the .NET Core SDK 2.2 or higher installed.
• When working with the codebase, we recommend using an IDE with intellisense and syntax highlighting, such as Visual Studio Community Edition (Windows), Visual Studio Code (with the C# plugin installed) or Jetbrains Rider (commercial).

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 64 bit users should download and run install.exe.
• MacOS users should download and run osu.app.zip.
• iOS users can join the TestFlight beta program.

There is currently no release for Windows 32 bit, Linux, or any other platform. If you are not running Windows 64 bit or MacOS, you should build osu! from the source code (see 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

Configuration for Visual Studio 2017, Rider and Visual Studio Code is included in the source code.

Visual Studio Code users must run the Restore task before any build attempt.

You can also build osu! from the command-line, with dotnet:

dotnet restore
dotnet run --project osu.Desktop -c Release

The -c Release option must be omitted when building for development purposes.

A note for Linux users

On Linux, the environment variable LD_LIBRARY_PATH must point to the build directory (replace Release with Debug in the following paths if you do not want to include the -c Release flag).

The build directory is located at osu.Desktop/bin/Release/netcoreappX.X, where X.X is the version of the .NET Core SDK (see Requirements). The required value can be found in osu.Desktop/osu.Desktop.csproj, look for a line starting with "TargetFramework".

For example, you can run osu! with the following commands:

export NETCORE_VERSION="$(grep TargetFramework osu.Desktop/osu.Desktop.csproj | sed -r 's/.*>(.*)<\/.*/\1/')"
export LD_LIBRARY_PATH="$(pwd)/osu.Desktop/bin/Release/$NETCORE_VERSION"
dotnet run --project osu.Desktop -c Release

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.