diff --git a/song-pkg-format.md b/song-pkg-format.md new file mode 100644 index 0000000..ae198b2 --- /dev/null +++ b/song-pkg-format.md @@ -0,0 +1,51 @@ +Here is how a song in WacK is packaged. + +# Song folder Layout +``` +/ +├─ 0.mer +├─ 1.mer +├─ 2.mer +├─ 3.mer +├─ meta.mer +├─ jacket.png/.jpg +├─ *.mp3/.ogg/.wav //SONG AUDIO +``` + +# meta.mer +**This file must be present to define its folder as a song.** Everything here only dictates how the song is displayed in song select; none of these tags affect how the chart is played. + +``` +#TITLE +#RUBI +#ARTIST +#COPYRIGHT +#GENRE +#BPM +#PREVIEW_TIME +#PREVIEW_DURATION +``` +*`?` = optional + +# Chart .mer +### Naming +**Every charted .mer file must contain an integer that may be padded.** The first four, 0-3, correspond to in-game difficulty as follows: +``` +0. Normal +1. Hard +2. Expert +3. Inferno +``` + +### Tags +`#LEVEL` (float): difficulty level +`#MUSIC_FILE_PATH` (str) +`#OFFSET` (float) +`#CLEAR_THRESHOLD` (float? 0-1) +`#AUTHOR` (str?) +`#PREVIEW_TIME` (float? seconds) +`#PREVIEW_DURATION` (float? seconds) +`#MOVIE_FILE_PATH` (str?) +`#MOVIE_OFFSET` (float? seconds) + +*`?` = optional