[REQUEST] Course (.crs) files

Is there an existing request for this?

[X] I have searched the existing requests and none matched.

Request

Course (.crs) files used to create courses.

Details to Document

All tags and their uses
What tags are required for a course file.
What tags are optional for a course file.
Example of course files in action.

Help the documentation

Course Location

Courses default location are Project OutFox/Courses/, following the following structure:

Project OutFox/Courses/
│
└───Some Creative Course Collection Name
│   │   
│   └───My Course.crs
│   └───My Course.png (Optional)

A course Collection can have as many courses inside of it as it wishes. The name of the course collection is not used during the music wheel as noted inside the instruction.txt

Course files (.crs) typically go in folders, though they aren't shown like that on the wheel... yet. (Coming soon: a metric that allows a theme to do that, once we get the wheel to treat course directories like song directories)

Playing courses

To play courses, you can have to choose "Extended", "Oni" or "Nonstop" modes.

Tags

SONG

#SONG:Pack Name/Song Name:Difficulty:[showcourse/noshowcourse/nodifficult/award];

Example

Placeholder	Value
Pack	OutFox
Song	Credits
Difficulty	Hard

COURSE

Defines the course name to be shown during the music wheel.

Example

#COURSE:Very creative course name;

SCRIPTER

Defines the author of the course to be shown during the music wheel

Example

#SCRIPTER:SSC;

BANNER

Defines the banner to be used during the music wheel when this course is selected. The banner must be on the same folder as the course file.

Example

#BANNER:Automation;

MODS

Defines a scripted attack to happen at a given time. This tag can be used multiple times to define multiple attacks. This tag must be inserted before the #SONG tag to apply the attacks to that song.

Example

#MODS:TIME=2.580000:LEN=0.310000:MODS=Drunk, Overhead;

Using this line, we're making so 100% Drunk and 100% Overhead are applied at 2.580000 seconds in when playing the song, those attacks will also last 0.310000 seconds and then slowly decay back to their default values. Read more about Attack/Modifiers here

TeamRizu / outfox-wiki