Drison64 / tau

A customized osu! mode surrounding a paddle and some notes.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

tau

tau for osu!

Join Discord Server

release GitHub license GitHub stars GitHub forks GitHub issues

A customized osu! mode surrounding a paddle and some notes. Original credit to the idea belonging to pizzapip.

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

Since version 2020.429.0 The installation method has now changed and is much more consistent than the old method. If you wish to see the old method of how to install this ruleset the please expand details below.

Old method

Windows

On Windows, the library must be put in %localappdata%\osulazer\app-(Current osu!lazer Version), inside the directory of the current osu!lazer version. osu!lazer will automatically work with the .dll when you open it, so nothing else needs to be done.

Linux

On Linux, you will need to extract the app image with the following command line:

./osu.AppImage --appimage-extract

This will extract all files to squashfs-root, in this folder go to usr/bin and put Tau's dll there.

Special thanks to Kotypey#9393 for figuring out how to install Tau on linux.
macOS

On macOS, the library must be put inside the osu!lazer app contents here osu!.app/Contents/MacOS/

Context menu

You can access the app contents by right-clicking on osu! and clicking "Show Package Contents"

Special thanks to sexnine#6969 for figuring out how to install Tau on macOS.

New Method

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

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:

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

[SECTION WIP]

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.

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.

About

A customized osu! mode surrounding a paddle and some notes.

License:MIT License


Languages

Language:C# 100.0%