Skip to content
This repository has been archived by the owner on Apr 22, 2023. It is now read-only.

Creating Weeks

Leather128 edited this page Nov 15, 2021 · 5 revisions

# Creating Weeks

Week Setup

To create a new week, you must first create a new folder in the mod's main directory called data.

Then create another folder inside it called week data.

Adding Assets

To add the week assets (difficulties, menu character sprites, actual week sprites), first create a folder named images in the mod directory.

Then create another folder in it called campaign menu.

Custom Weeks

Create a folder called weeks in the campaign menu folder. Then add another folder for your week's pathName property (by default is default) in it.

Inside this folder you can put PNG images of all of your weeks as they appear in-game. It will look something like this when done.

Weeks Folder

Custom Difficulties

Create a folder called difficulties in the campaign menu folder. You can add another folder in that folder to organize things, but it is not required.

Put PNG files of all your difficulties as they will appear in game inside the folder, and it should look like this:

Difficulty PNGS

Custom Menu Characters

Create a folder called characters in the campaign menu folder. You can add another folder in that folder to organize things, but it is not required.

Then just put PNG and XML files according to the characters you want to add.

It will look something like this when done:

Story Menu Character Sprites

Creating Menu Characters

First create a new folder in the data folder in your mod's main directory named menu character data.

Then inside it, create a .json with the name you want to use for your character (this is the name you'd use in your week's .json file).

Obviously, you can make this file from scratch, but a smarter solution is to copy-paste a pre-existing one (I chose the dad's).

This is what it looks like:

JSON of Menu Character

All these properties are pretty self explanatory with their names, so I won't go into detail on what each of them do.

Creating the Week JSON

File Creation

You could create the .json for the week yourself, but a faster way is to just copy-paste the original_weeks.json file from (in base assets) data/week data/ into the week data folder in the mod.

Original Thingy

New

Rename your new week's .json to something other than original_weeks, and then open it.

In this file you'll see a lot of things, it is recommended you delete all the weeks except one so that it's easier to manage.

Before Trim After Trim

Properties

Change the property groupName to change the text that appears when selecting your weeks (because they are separated into groups).

In JSON

In Game

Change the songs property in any week in the json to change what songs (WITH EXACT SAME NAME AS THE CHART AND AUDIO FILES) there are (separated by commas).

Week Property

Change the imagePath property of any week to change what image the game looks for, for the week.

imagePath

In Game

Difficulties are formatted as: [DIFFICULTY NAME IN CHART NAME HERE], [PATH TO DIFFICULTY SPRITE]

Difficulties

Changing one of the three character names in the characters property of a week, changes what json the game gets (from data/menu character data/) for the character information (with "" being invisible).

Characters

The weekTitle property changes the text that appears in the top right when selecting the week.

Week Title Example

Last Step

Add a folder named _append to your mod's directory, then inside that folder add another folder named data.

Inside the data folder in _append add a file named storyWeekList.txt (CASE SENSITIVE) and just add the name of each set of weeks you made (the JSONs in data/week data/) as a new line (without the .json at the end).

And now it's in the Story Menu! (Press E & Q to navigate the groups).

Finished Week