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

Mod Data

Jump to bottom
Mackery edited this page Jan 5, 2023 · 6 revisions

Mod Data

REMEMBER WHILE DOING THIS THERE IS A EXAMPLE MOD TO HELP!!

A lot of the data that the mod uses is stored in xml files and loaded when you switch mods.

The mod data for Weeks, Which Character Xmls to Load, and Dialogue Data is contained in MOD-FOLDER/modData.xml.

The file should start with: <!DOCTYPE test-engine-modData> and end with: </mod>.

Line 2's requires some of your input. it should start with <mod and end with >. and it can have data inside.

Changing the title bar name

titleBarName="[TITLE-NAME]" - Replace [TITLE-NAME] with what you want the title bar to say. image

Changing the mod select color

color="[HEX-OR-RGB-COLOR]" - Replace [HEX-OR-RGB-COLOR] with what you want the select mod gradient color to be. It will try to get a hexadecimal color by default, but it will try to get a rgb color if it contains a comma.

Hexadecimal Example: color="00FF88" || RGB Example: color="0,255,120"

The color variable modifies this.

image

Adding Which Character Xmls To Load.

charXmlPaths="[XML-PATHS]" - Replace [XML-PATHS] with all the characters xml data paths separated with |.

Adding Weeks

Every week should have an element inside the lines we added eariler. Like this.

image

What each variable in the top green line does

name - What the name of the week is. Is used in the saves and the story menu.

image - What the story menu should display for the week icon. Path starts from MOD-FOLDER/images/menus/storymenu so if you type in week3, it will display the image from path MOD-FOLDER/images/menus/storymenu/week3.png.

songs - The display names of the songs separated by commas. Is used in both freeplay and the story menu.

songPaths - The path to the songs separated by commas. Is used in freeplay, the story menu, and playstate. This determines where the game tries to find the data and music of the songs. Ex: songPaths="bopeebo, fresh" -> Game searches in MOD-FOLDER/[data or songs]/bopeebo or MOD-FOLDER/[data or songs]/fresh

icons - What icons the freeplay menu displays separated by commas. Have one for each song.

diffs - The difficulties the songs have separated by commas. Capitalization does not matter.

What the lines inside are.

These are the data of the menu characters used in the story menu.

Menu Char Data Variables

path - Where to find the spritesheet for the character. Path starts from MOD-FOLDER/images/menus/storymenu.

idle - The idle animation in the xml. This animation is played every beat when a week has not been selected yet.

confirm - The confirm animation in the xml. Not required. This animation is played when a week has been selected.

scale - Name says it all. Just put in a number.

xOffset - How much the character moves from the default X Position.

yOffset - How much the character moves from the default Y Position.

flipX - If the character should be flipped horizontally. Either true or false.

What does default do?

The default var sets the menu character to a template/default menu character. Note that the default menu characters can't be modified.

The default var can equal three things:

bf or boyfriend - Load menu character as BF and load next menu char.

gf or girlfriend - Load menu character as GF and load next menu char.

dad - Load menu character as Dad and load next menu char. Least used as the opponent is normally different every time.

Clone this wiki locally