Mod Installation
If you are using Steam, the easiest way to install mods is by going to the Steam Workshop and subscribing to whichever mods look interesting. These will automatically appear in the Mods menu in game.
Otherwise, you can install Mods by moving the folder that defines the mod (this folder should contain a file called manifest.lua) to the following locations:
- Windows: $APPDATA/Share/Local/Warp Factory/Mods (where $APPDATA is your app data directory - probably $HOME/AppData)
- Windows: Or in "Mods" folder in the same directory as Warp Factory.exe
- Mac: ~/Library/Application Support/warp-factory-game/Mods
- Mac: ...or in a "Mods" folder in the same directory as the app.
- Linux: $XDG_DATA_HOME/Warp Factory/Mods (where $XDG_DATA_HOME is probably ~/.local/share)
This method of installation is necessary if you wish to develop your own mods.
Mod Development
This documentation describes the modding API for Warp Factory. Basic mods can be created just using some built-in tools and a text editor. More advanced mods require using the game's Lua API. This is a work in progress - but for now, please visit the tutorial on creating a simple mod. Some documentation of more advanced features exists in the Lua API tab, but this is still very much incomplete - better is to look at the advanced examples to get a sense for how levels are implemented in the game itself.
Mod Publishing (Steam only)
Warp Factory allows plays to upload and distribute their mods through Steam Workshop. Once you have a working mod, you can prepare it for upload by adding the following files to the main directory:
- metadata.txt - this file should contain the title of the mod on the first line followed, on the second and further lines, by a description of the mod (max 8000 characters).
- preview.png - this file should contain an image with a square aspect ratio to be used as the cover for your mod in Steam Workshop (max 1 megabyte)
- wants_publish.txt - contents are ignored. The presence of this file signals to Warp Factory that you want to upload the mod to Steam Workshop.
When you open Warp Factory and it detects a mod with a wants_publish.txt file in the mod's directory, it will present you with a screen where you can choose whether to upload the mod to Steam. If the mod is missing another required file or the upload fails, the error will be displayed to you.
After successfully creating the item, Warp Factory will generate a mod_id.txt file which, if present, will allow you to update the existing mod instead of create a new one. After a successful upload, Warp Factory will delete the wants_publish.txt file that triggered the upload. You can always recreate this file if you wish to upload again.