Traditionally, FTL modding was very restrictive, only allowing the alteration or
replacement of existing content. Adding new content was only possible within very narrow
boundaries. Hyperspace allows mod developers to step beyond these limitations.
In short, FTL: Hyperspace is an API that enables modders to create mods with
unprecedented features. Examples include new alien races with their own strengths and
weaknesses, new systems and subsystems, combined and hidden augments, custom drones, new
special stores and a command console, as well as Lua script support.
Dynamic asset loading, which improves load speeds over vanilla
Command console
Commands that unlock ships, spawn weapons or load events
Discord Rich Presence
Shows what you are playing, on Windows builds
There are more features that are off by default, like tile-based crew control. Mods
can enable them through hyperspace.xml. Every switch and its default is
listed separately.
Hyperspace is natively supported on Windows, macOS and Linux, including SteamOS.
Most of the features that Hyperspace provides are documented in data/hyperspace.xml
inside the Hyperspace.ftl file. Normal mods should use a basic hyperspace.xml.append
file and add or modify the existing tags. Large overhauls, such as FTL: Multiverse, ship
with their own hyperspace.xml.
If you are shipping your mod, expect your players to download Hyperspace separately and
patch it first. To ensure the best compatibility with other mods, do not redistribute
Hyperspace’s resource files or binaries; simply direct people to the download.
