History

ekrctb 207f7f1e56 Rename FramedAutoGenerator<T> -> AutoGenerator<T>		2021-05-07 00:31:12 +09:00
..
Rulesets	Rename FramedAutoGenerator<T> -> AutoGenerator<T>	2021-05-07 00:31:12 +09:00
Directory.Build.props	Isolate rulesets subtree	2021-04-05 12:22:38 +09:00
README.md	Rename README header	2021-04-05 13:56:04 +09:00
osu.Game.Templates.csproj	Fix ruleset templates not being included	2021-04-05 12:23:03 +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 -i 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