Welcome to the Restructure Engine wiki!

This wiki documents modding in Restructure Engine, both in terms of specific modding tools and scripting.

Note that this wiki is a work in progress and might not contain a lot of information for a while.

Also note that as of version 1.5.0, much of this wiki is outdated due to heavy reworks of the editors.

Getting Started

To create a mod in Restructure Engine, navigate to the Main Menu and press the Editors Menu key (E by default) to bring up the Editors Menu. From here, click "Create New Mod," enter some information about your mod, then click "Create." This will make a new folder for your mod in the "mods" folder, to which you can add mod assets. You'll have to restart the game after creating a mod for the game to see the mod that you've created. From here, you can add characters, stages, songs, weeks, etc. Make sure any assets of your mod are in the mod's folder, so that the game can read them.

"Create New Mod" fields

Mod Name is the name of your mod. This name, as-is, will be used in the Mods menu, while the created folder will be a truncated camel case version of this name.

Mod Description is a short description of the mod, and will be shown in the Mods menu.

Create Asset Folders is used to determine which folders your mod will have. None means it won't have any, Simplified means it will have the most commonly used ones, and Extended means it will have less common but still useful ones in addition. Simplified is the default.

Subfolder is an optional parameter which will be the name of several separating folders inside the mod for various assets. It is highly recommended to use this, as it can prevent unexpected file name conflicts between mods.

Adding an icon

Once a mod is created, the folder for it will contain a file called _polymod_meta.json. If you wish for your mod to have an icon, copy a PNG of the icon into the mod's folder and rename it _polymod_icon.png. This icon will show up in the Mods menu, as well as in the Story Mode and Freeplay menus.