Starbound
Starbound

Modding & Custom Content

Master modding Starbound to enhance gameplay, add new races, weapons, or change core mechanics. This guide simplifies installing and managing custom content.

·Multi-source verified (77/77)

Modding & Custom Content

Welcome, intrepid spacefarer, to the exciting world of Starbound modding! Whether you're looking to enhance your gameplay experience, add new races, weapons, or even overhaul core mechanics, the Starbound modding community offers a vast universe of possibilities. This section will guide you through the process of installing and managing mods, as well as offer a glimpse into creating your own custom content.

Installing Mods

There are two primary methods for installing mods in Starbound: using the Steam Workshop and manual installation. We'll cover both, detailing the steps for each.

Steam Workshop Installation (Recommended)

The Steam Workshop is by far the easiest and most recommended method for installing mods. It handles downloads, updates, and even some basic compatibility checks automatically.

  1. Launch Steam: Open your Steam client and navigate to your Library.
  2. Find Starbound: Locate Starbound in your game list and click on it.
  3. Access the Workshop: On the Starbound game page, look for the "Workshop" tab and click it. This will take you to the Starbound Steam Workshop page.
  4. Browse and Subscribe:
    • Use the search bar, filters (e.g., "New Races," "Weapons," "Quality of Life"), and categories to find mods that interest you.
    • Once you find a mod you want, click on its page.
    • Click the green "Subscribe" button. Steam will automatically download and install the mod the next time you launch Starbound.
  5. Launch Starbound: Start Starbound as usual. The subscribed mods should now be active.
  6. Verify Installation:
    • Some mods, especially those adding new races, will be immediately apparent on the character creation screen.
    • For other mods, you might need to craft new items (check the Inventing Table or Anvil), visit specific planets, or encounter new NPCs.
    • Always check the mod's Workshop page for specific instructions or in-game verification methods.

Important Note: Always read the mod description carefully on the Steam Workshop page. Many mods have specific requirements (e.g., "Frackin' Universe" often requires a fresh save or specific load order) or known incompatibilities. Pay attention to the "Required Items" section.

Manual Mod Installation

Manual installation is necessary for mods not available on the Steam Workshop (e.g., from sites like the Chucklefish Forums or Nexus Mods) or for advanced troubleshooting.

  1. Download the Mod: Obtain the mod file(s) from its source. These are typically in .zip or .pak format.
  2. Locate Your Starbound Installation Directory:
    • Steam (Windows): C:\Program Files (x86)\Steam\steamapps\common\Starbound\
    • Steam (macOS): ~/Library/Application Support/Steam/steamapps/common/Starbound/
    • Steam (Linux): ~/.steam/steam/steamapps/common/Starbound/
    • GOG: The directory where you installed Starbound.
  3. Navigate to the mods Folder: Inside your Starbound installation directory, you will find a folder named mods. If it doesn't exist, create it.
  4. Extract/Place the Mod Files:
    • For .pak files: Simply move the .pak file directly into the mods folder.
    • For .zip files: Extract the contents of the .zip file. You should find a folder named after the mod (e.g., MyAwesomeMod) containing its assets. Place this entire mod folder directly into the mods folder. Do NOT place the .zip file itself into the mods folder.
  5. Launch Starbound: Start the game. The manually installed mods should now be active.
  6. Verify Installation: As with Workshop mods, check the mod's documentation for specific in-game verification steps.

Managing Mods & Troubleshooting

As your mod list grows, managing them becomes crucial for a stable and enjoyable experience.

Mod Load Order

Starbound loads mods alphabetically by their folder/file name within the mods directory. This can be critical for mods that modify the same game files. If two mods change the same asset, the one loaded later (alphabetically) will "win" and overwrite the changes of the earlier one.

  • Renaming for Order: If a mod requires a specific load order, you can rename its folder/.pak file. For example, adding a prefix like _00_ or _ZZ_ can force it to load earlier or later. Always consult the mod's documentation for recommended load orders.
  • Example: If ModA needs to load before ModB, you might rename ModA's folder to _00_ModA and ModB's folder to _01_ModB.

Common Issues & Solutions

  • Crashes on Startup:
    • Check starbound.log: This is your best friend for troubleshooting. It's located in your Starbound installation directory (e.g., Starbound/storage/starbound.log). Look for lines marked (Error) or (Fatal) near the end of the log after a crash. These often point to the problematic mod or file.
    • Disable Mods One by One: If you've recently added multiple mods, disable them one by one (or in batches) until the crash stops. This helps pinpoint the culprit.
    • Outdated Mods: Starbound updates can break older mods. Check the mod's Workshop page for recent update dates or comments about compatibility.
  • Missing Textures/Items:
    • Load Order: Ensure no conflicting mods are overwriting essential assets.
    • Required Mods: Double-check if the mod requires other mods to function (e.g., a "patch" for another large mod).
    • Corrupted Download: Try re-downloading and reinstalling the mod.
  • Performance Issues:
    • Too many large mods can impact performance. Consider disabling less essential mods if you experience significant slowdowns.
    • Large content mods like Frackin' Universe are known to be resource-intensive.

Uninstalling Mods

  • Steam Workshop: Go to the mod's Workshop page and click the "Unsubscribe" button. Steam will remove it automatically.
  • Manual Installation: Simply delete the mod's folder or .pak file from your Starbound/mods/ directory.

Warning: Removing mods that add new items, blocks, or NPCs to existing saves can lead to issues, including crashes or corrupted save files. Always back up your save files (located in Starbound/storage/player/ and Starbound/storage/universe/) before making significant changes to your mod list, especially when removing large content mods.

Creating Custom Content (A Brief Introduction)

For the truly ambitious, Starbound offers robust tools for creating your own custom content. This is a vast topic, but here's a brief overview to get you started.

Essential Tools & Concepts

  • Text Editor: A good text editor like Notepad++, Sublime Text, or VS Code is essential for editing .json and .lua files.
  • Image Editor: GIMP or Photoshop are needed for creating custom sprites, textures, and UI elements.
  • Starbound Asset Extractor: This tool (often found in the Starbound installation directory, e.g., Starbound/win32/asset_unpacker.exe) allows you to extract the game's core assets (packed.pak) into readable files. This is crucial for understanding how existing game elements are structured.
  • JSON (JavaScript Object Notation): Starbound uses JSON extensively for defining items, weapons, blocks, NPCs, quests, and almost everything else. Understanding JSON syntax is paramount.
  • Lua Scripting: For more complex behaviors, custom AI, or unique item functions, Starbound uses Lua scripting.

Basic Mod Structure

A typical Starbound mod folder will contain:

  • _metadata folder: Contains .metadata file with mod name, author, version, and dependencies.
  • assets folder: Contains subfolders for various asset types (e.g., items, objects, monsters, recipes, liquids, biomes, quests, interface).
  • scripts folder: Contains .lua files for custom behaviors.

Getting Started with Modding

  1. Extract Game Assets: Use the asset_unpacker to get a full set of the game's default assets. This provides a reference for how everything is structured.
  2. Start Small: Don't try to create a new race with custom lore and a full questline immediately. Begin with something simple:
    • Recoloring an existing item: Find an item's .json and .png files, modify the .png, and create a new item definition.
    • Creating a simple custom object: Design a new decorative object and define its properties in a .json file.
    • Adjusting weapon stats: Find a weapon's .json file and tweak its damage, fire rate, or energy consumption.
  3. Consult the Wiki & Forums: The Starbound Modding Wiki and the Chucklefish Forums are invaluable resources for tutorials, documentation, and community support.
  4. Test Frequently: Make small changes and test them in-game often to catch errors early.

Modding Starbound can be a deeply rewarding experience, allowing you to tailor the game precisely to your desires or even contribute new content to the community. Happy modding, and may your adventures be ever more extraordinary!

Compare modding & custom content inBlade & Sorcery