A customized osu! game mode that resembles the Theatrhythm games by Square Enix/indieszero!
This is currently a work-in-progress and does nothing yet... Stay tuned!
You will need a copy of osu!lazer built and run at least once. Visit the osu!lazer GitHub page for details on how to build that project.
Since this is a work-in-progress, there is currently no release to install. Follow the Build directions below to compile the osu.Game.Rulesets.Theater.dll file.
NOTE: This mode is currently only supported in desktop mode. Mobile support is planned in the future.
When developing or debugging the theater-osu codebase, a few prerequisites are required as following:
- An IDE that supports the C# language. Ideally, your IDE should support automatic code 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.
You are able to clone the repository over command line or by downloading it via GitHub's clone options above.
git clone https://github.com/bdjeffyp/theater-osu.git
cd theater-osuUpdating this code to the latest commit would be done with git pull inside the theater-osu directory or through your IDE's Git controls.
To build the osu!theater game mode, you will need to have the latest .NET Core installed on your computer.
You can run osu!lazer with this game mode installed for you directly from the IDE! The .csproj file contains a post-build event script that always runs when the Debug (F5) or Run Without Debugging (Ctrl+F5) command is given in Visual Studio 2019. Running from the IDE will issue an error dialog stating that "A project with an Output Type of Class Library cannot be started directly" after closing osu!lazer that can be safely ignored.
If you are not using Visual Studio 2019 or you feel inclined to, you can also run osu!lazer with the osu!theater ruleset from the command line when you build this project with dotnet build.
NOTE: You will need to update the osu.Game.Rulesets.Theater.csproj file and modify the <OsuDir> environment variable with the build location of your instance of osu!lazer for this to work.
All contributions are appreciated in order to improve the mode's playability and functionality. Contributions should be done over an issue or a pull request.
theater-osu is licenced under the MIT License. For licensing information, refer to the license file.
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.