Packages - SlightlySimple/FNF-Restructure-Engine GitHub Wiki

Packages are a feature of Restructure Engine that allow for the creation and organization of "overhauls," or mods that completely change the game's menus/UI or even add new ones.

Ordinarily, Restructure loads every mod you have selected at once, making these types of overhauls unideal.

Creating a new Package

To create a package, 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 Package," enter some information about the package, then click "Create." This will create a folder called "packages" if it doesn't already exist, and make a new folder in the "packages" folder containing the data for your package. From here, if you restart the game, you will be able to select and play your package.

"Create New Package" fields

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

Package Description is a description of the mod, and will be shown in the packages menu. If you wish to write a longer description, you can leave this blank and write the description in a text file instead.

Window Title is the title of the game window while your package is being played. If this is left blank, the window title will not change.

Package Mods is a comma-separated list of every mod in the package. You can type this out manually, or use the dropdown menu below to create or add to the list.

Include Base controls whether or not base game weeks and songs are accessible in the package.

Allow Mod Tools controls whether or not the editors menu is accessible in the package.

Create Menu Mod controls whether or not a new mod should be created for custom menus/UI in the package. This mod will be hidden from the normal Mods menu, but will be run when the package is being played.

Additional images and files

Normally when a package is created, it will only have one file in it's folder. The following files can be optionally added to give your package extra flavor:

boxart.png will show up on the packages menu to represent the mod as a selectable image. The ideal resolution for this image is 6x9

banner.png will show up at the top of the screen when the mod is selected. The ideal resolution for this image is 128x25

logo.png will show up at the top center of the screen when the mod is selected, instead of simply showing the mod's name.

description.txt will be used as the description instead of what's in the JSON. It is recommended for longer, more organized package descriptions.

icon.png will replace the game's icon when the package is played.

icon.ico will be used as the Desktop Shortcut's icon if one is made.