taulazer / tau

Original idea belonging to pizzapip and DeadlySprinklez.

Art done by Izeunne

Running the Gamemode

We have prebuilt libraries for users looking to play the mode without creating a development environment. All releases will work on all operating systems that osu! supports.

Instructions

From the osu settings menu scroll down till you see Open osu! folder, that button should take you under %appdata%/osu.

Copy the ruleset file into the rulesets directory, do make sure that duplicate copies of the ruleset is overwritten.

Once done, restart osu!lazer, if lazer is already open. Once lazer is started, you should see the ruleset alongside the standard rulesets on the toolbar at the top.

Do note that this instruction will only work with desktop devices.

Development

When developing or debugging the tau codebase, a few prerequisites are required as following:

• An IDE that supports the C# language in automatic completion, and syntax highlighting; examples of such being Visual Studio 2019 and above, or JetBrains Rider.
• The osu!framework, and osu! codebases are added as dependencies for building

Source Code

You are able to clone the repository over command line, or by downloading it. Updating this code to the latest commit would be done with git pull, inside the tau directory.

git clone https://github.com/Altenhh/tau.git
cd tau

Building the Gamemode From Source

To build Tau, you will need to have .NET 5 installed on your computer.

First, open a terminal and navigate to wherever you have the Tau source code downloaded. Once you are in the root of the repository, enter the directory named osu.Game.Rulesets.Tau.

Next, run the command dotnet build and wait for the project to be built. This shouldn't take very long.

Once the project has finished building, dotnet should tell you where the binary was built to (usually somewhere along the lines of ./tau/osu.Game.Rulesets.Tau/bin/Debug/netstandardx.x/). Find the .dll binary in the given location and follow the installation instructions above.

Contributions

All contributions are appreciated, as to improve the mode on its playability and functionality. As this gamemode isn't perfect, we would enjoy all additions to the code through bugfixing and ideas. Contributions should be done over an issue or a pull request, to give maintainers a chance to review changes to the codebase.

For new ideas and features, we would prefer for you to write an issue before trying to add it to show the maintainers.

If you wish to help with localisation efforts, head over to crowdin.

Special thanks

Thanks to each and every contributor to this project.

Thanks to all of those who have helped with localization efforts. Members includes (as of 2022, September 5th): Akira, KalTa, Loreos, MioStream_, Morco011, Nooraldeen Samir, and Peri.

Thanks to all of the amazing people within our discord community.

License

tau is licenced under the MIT License. For licensing information, refer to the license file regarding what is permitted regarding the codebase of tau.

The licensing here does not directly apply to osu!, as it is bound to its own licensing. What is reflected in our licensing may not be allowed in the osu! github repository.