Structure

The following page describes the folder structure, and the location, of the mod folder.

Where are the mods?

All mods are located in the Mods folder. The Mods folder is located in the same directory as the Saves folder.

Platform	Path
Windows	`C:\Users\YOUR_USERNAME\AppData\Roaming\Temporary Escape\Mods\MOD_NAME\`
Linux	`~/.temporary-escape/Mods/MOD_NAME/`
MacOS	`~/Library/Application Support/Temporary Escape/Mods/MOD_NAME/`

All folders are optional, but the manifest.yml is required.

Name	Description
`manifest.yml`	File. Describes the mod. Must end with `.yml`. More information here.
`blocks`	Contains definition of ship blocks. More information here
`entities`	Lua script files for entities that appear in the scene. More information here
`events`	Lua script files for handling world events. More information here
`factions`	Lua script files to define Factions and their behavior. More information here
`grids`	Saved ship designs (voxel grids) that can be used by entities. More information here
`images`	Image files for avatars, items, etc. More information here
`items`	Lua script files to define items and their behavior. More information here
`models`	GLTF models and their textures, such as asteroids and turrets. More information here
`planets`	Yaml files describing planet styles (not behavior). More information here
`sounds`	Audio files for music and effects. More information here
`textures`	Textures used by blocks and for rendering. More information here
`turrets`	Yaml files to describe turrets. More information here