<aside> ⚠️

Warning: This documentation only applies only to mods uploaded to Nexus Mods to make them download correctly via ETB Rocket

</aside>

Basic Guidelines

There only should be 1 pak file and 1 folder in the zip. Only 1 file will be detected from the app with its folder. Putting no folder and only a single file in the zip file will resoult in the .pak file being copied to the ~mods folder.

Interpose Mods

Putting your .pak file in the interpose_mods folder in the zip will display the modloader as Interpose to the user and will put the file in the interpose_mods folder.

UE4SS Mods

Putting your .pak file in the LogicMods folder in the zip will display the modloader as UE4SS to the user and will put the file in the LogicMods folder.

~Mods

Putting the .pak file at the zip root or at the ~mods folder will display an Unknown modloader and will put the .pak in the ~mods folder.

/ Mods

To put the .pak file in the EscapeTheBackrooms/Content/Paks folder relative to the game root put your .pak file in the basefolder folder.

Modpack Format

<aside> ⛔

Warning: This feature has not been developed yet, if you are making a modpack keep this in mind for the future. Everything said here can be subject to change

</aside>

To make the modpack installable from ETB Rocket you first have to flag is as a modpack in the Creator Hub. Then you have to put a file called ETBRPACK.json that will contain all the info for the app to install the modpack.

Its reccomended to put all your modpack .pak files inside a mods folder

ETBRPACK.json format

{
	"name": "MODPACK NAME HERE",
	"requiredLoaders": ["ue4ss","interpose"],
	"mods": [
		{
			"name": "MOD NAME",
			"source": "modpack",
			"path": "MOD FILE PATH RELATIVE TO THE ETBRPACK.json",
			"installPath": "Mod path relative to the Paks directory, can only be interpose_mods, ~mods, LogicMods or . (for root directory)"
		},
		{
			"name": "MOD NAME",
			"source": "etbr",
			"id": "ETB Rocket MOD ID",
			"customInstallPath": false // REMOVE THIS COMMENT WHEN MAKING MODPACK: if true you have to add an installPath key like the one in the modpack source
		},
		{
			"name": "MOD NAME",
			"source": "nexus",
			"fileLink": "Nexus mod file link. Example: <https://www.nexusmods.com/skyrimspecialedition/mods/130983?tab=files&file_id=550375> get it from copying the link of the file download page, NOT THE DIRECT FILE DOWNLOAD LINK",
			"customInstallPath": false // REMOVE THIS COMMENT WHEN MAKING MODPACK: if true you have to add an installPath key like the one in the modpack source
		},
		{
			"name": "MOD NAME",
			"source": "github",
			"downloadLink": "Github direct download link",
			"installPath": "Mod path relative to the Paks directory, can only be interpose_mods, ~mods, LogicMods or . (for root directory)"
		}
	]
}

Written by lu2000luk - ETB Rocket is open source - ETB Modding Discord