How to Install Sandustry Mods With Fluxloader
I want to run mods and custom maps, but I do not know which loader is current or what it needs from me.
What Fluxloader is
Fluxloader is the community mod loader for Sandustry — the project previously known as modloader. It lets you enable gameplay mods, quality-of-life tweaks and companion tools without recompiling the game.
It is a Node.js application, with an updater script for Windows (.bat) and for Unix-like systems (.sh).
Setup, in the order it happens
- Get the loader. Releases are published on the project’s GitHub repository.
- Let it generate its config. On first run it creates a
fluxloader-config.jsonand a dedicated mods folder. - Point it at the game if asked. Auto-detection handles most installs; if it fails, you supply the path to the game executable yourself.
- Drop mods into the mods folder.
If you want to run the loader from source instead, the repository documents cloning it, installing dependencies, and starting it with npm start.
npm install && npm start
Custom maps
The Sandustry Custom Map Loader is a separate mod that runs on top of Fluxloader. It handles creating and selecting custom maps, so you do not need a separate install path for map content.
What the modding API actually exposes
Worth knowing before you plan a mod, because it shapes what is realistic.
Mods apply changes by patching files, through three documented functions:
| Function | Purpose |
|---|---|
addPatch(file, patchObj) |
Standard file modification |
addMappedPatch(fileMap, mapFn) |
File mapping with a transform function |
setPatch(file, tag, patchObj) |
Tagged patches, for organisation |
The documented patch style is string replacement against game files. Beyond patching, the API covers cross-environment communication (Electron, game and worker contexts), lifecycle event listeners such as scene loading, and configuration schema management.
What it does not document is a query API for game data — there is no documented interface for reading materials, recipes or building statistics. The modding guide is explicit about its own limits, advising that the source code is the final authority over the guide.
That matters for anyone hoping to build data tools on top of the loader: as documented, you are patching files, not reading a content database.
A caution about versions
Everything above describes the loader as it stood against the demo. Early Access ships with official modding tools of its own, and a loader built for the demo build will not necessarily survive that. Check the project’s own releases before assuming a mod still applies.
Frequently asked
What is Fluxloader?
The community mod loader for Sandustry, previously known as modloader. It is a Node.js application that manages a mods folder and launches the game with mods enabled.
What does Fluxloader need to set up?
It generates a fluxloader-config.json and a mods folder. If it cannot auto-detect your game installation, you supply the path to the game executable yourself.
Can mods read the game's recipe and machine data?
The modding guide documents file patching (addPatch, addMappedPatch, setPatch) and cross-environment events, but it does not document an API for querying materials, recipes or building stats. The guide itself says to treat the source code as the final truth.
Sources for this guide
- fluxloader — community mod loader for Sandustry (GitHub)Player report
- Sandustry Custom Map Loader (GitHub)Player report
Game behaviour changes between builds. This page describes Demo. If something here no longer matches your game, the source links above are the place to check first.