Skip to content

Starting a DLC pack

PurpleInsomnia edited this page Jul 13, 2024 · 4 revisions

How to create a DLC in-game

Go to the "DLC" via the Main Menu, then click on the button labeled "Create".

There, you will title the folder for your DLC, after doing so, you can go into dlc/[your dlc]/meta.json to edit the name, description and color.

Adding extra stuff

To add credits, simply make a new file in dlc/[your dlc]/ and title it credits.txt

A 150 x 150 icon called icon.png may also be used as your DLC's icon.

What to do from here

There are multiple things to do after creating the DLC pack, starting with these should be a good way to get the pack started.

Adding weeks

From here, you can start including weeks for the Freeplay Menu to load. Inside of dlc/[your dlc]/, make a new folder called data, then inside this folder, make another folder called weeks.

Inside dlc/[your dlc]/data/weeks/ create a new file called myweek.json (the week can be named whatever you want as long as .json is after it) You can copy code from week files inside of assets/data/weeks/, and edit it to your liking.

When testing to see if your week is active, press "Freeplay" in the Main Menu, you will then be taken to a screen that will let you choose to play "Default Weeks" or "DLC Weeks", You're obviously gonna press "DLC Weeks". (HINT: Closing and re-opening the game is NOT necessary, just as long as you switch between menus, the files should update automatically)

Adding art for the story/freeplay menu.

In your week json, the title variable is how the freeplay menu collects album art.

To add art, go into dlc/[your dlc]/images/freeplay/albums/[your title].png (NOTE: It has to be spelt EXACTLY how you spelt title, if it is in all upper case it should be in all upper case and etc.)

For story menu, art is defined by the name of your week file. (For example; you will name your files myweek if your file name was myweek.json)

For week names: dlc/[your dlc]/images/story/weeks/[name].png For week bgs: dlc/[your dlc]/images/story/bgs/[name].png

How to save a song/song events

After charting a song, you song should be placed in dlc/[your dlc]/data/songs/[song name]/ and MUST be called song.json Song events must be placed in the same folder and must be called events.json

Custom Menus

Custom menus can be made by making a new folder in dlc/[your dlc]/ called menus

If you want to create a custom main menu, create a file called MainMenuState.hxs inside the menus folder. (NOTE: ALWAYS HAVE A WAY TO GET BACK INTO THE DLC MENU!! IF THERE IS NO WAY YOU WILL BE FORCED TO EXIT THE GAME!!!)

(Other important menu names)

  • StoryMenuState
  • FreeplayState
  • DlcMenuState

Clone this wiki locally