1
0
mirror of https://github.com/ppy/osu.git synced 2024-12-17 20:02:58 +08:00
osu-lazer/Templates/README.md

22 lines
708 B
Markdown
Raw Normal View History

2021-04-05 12:56:04 +08:00
# Templates
2021-04-05 10:41:40 +08:00
Templates for use when creating osu! dependent projects. Create a fully-testable (and ready for git) custom ruleset in just two lines.
## Usage
```bash
# install (or update) templates package.
# this only needs to be done once
2023-10-29 21:25:15 +08:00
dotnet new install ppy.osu.Game.Templates
2021-04-05 10:41:40 +08:00
# 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
```