History

Salman Ahmed ec85bf0ae6 Update other VS code configuration files		2024-02-16 01:45:30 +03:00
..
Rulesets	Update other VS code configuration files	2024-02-16 01:45:30 +03:00
Directory.Build.props	Isolate rulesets subtree	2021-04-05 12:22:38 +09:00
README.md	Small update to README of Templates	2023-10-29 21:25:15 +08:00
osu.Game.Templates.csproj	Update copyright years	2024-01-25 20:37:50 +09:00

README.md

Templates

Templates for use when creating osu! dependent projects. Create a fully-testable (and ready for git) custom ruleset in just two lines.

Usage

# install (or update) templates package.
# this only needs to be done once
dotnet new install ppy.osu.Game.Templates

# create an empty freeform ruleset
dotnet new ruleset -n MyCoolRuleset
# create an empty scrolling ruleset (which provides the basics for a scrolling ←↑→↓ ruleset)
dotnet new ruleset-scrolling -n MyCoolRuleset

# ..or start with a working sample freeform game
dotnet new ruleset-example -n MyCoolWorkingRuleset
# ..or a working sample scrolling game
dotnet new ruleset-scrolling-example -n MyCoolWorkingRuleset