Modding

This section of the wiki is for creating mods. If you are looking for how to find or install existing mods then please check the excellent Mod Index on the forum

Broadly speaking, game updates add new things rather than remove or modify existing things, so older information is very often still relevant. This format is designed to facilitate finding specific information quickly when you know what to look for. If you are seeking a step by step guide then look in Intro to Modding.

It is also frequently helpful to search the official forum for posts by Alex (user "Alex") on any niche topics not yet covered here.

Mod updating from 0.9 to 0.95a Compatibility

Mod updating from 0.8 to 0.9a Compatibility

Welcome!

This page will provide you with everything you need in order to get you up to speed in the realm of Starsector modding. This is a work in progress, so if you are a competent modder please consider adding to this.

Every mod will need a Mod_Info.json file

• Mod_Info.json Overview
• Guidelines to Modding

Basic Ships

• Ship Data CSV
• .ship File Overview
• .variant File Overview
• .skin File Overview
• Modding carriers
• Wing_data.csv_Overview

Basic Weapons

• Weapons Data CSV
• .wpn File Overview
• .proj File Overview

Hullmods

• Modding hullmods
• Hull_mods.csv
• Hullmod code call-order

Ship Systems

• Modding ship systems overview
• Ship Systems CSV
• .system File Overview
• Alternate defense systems

Industries

• Industries CSV

Missions

• MissionDefinition.java
• Early blog post on mission editing

Libraries

• MagicLib

Additional

• Misc .csv File Overview (hullmods, wing_data, sim_opponents, etc)
• .faction File Overview
• hull_styles.json
• engine_styles.json
• Damage Decal Sheet Overview
• Starsector API
• FORTRESS_SHIELD shipsystem AI
• Render order
• Simple weapon animation
• Descriptions CSV
• custom_entities.json
• Miscellaneous modding tidbits
• Rules.csv
• Blueprint Modding

Map generation

• starmap.json
• planets.json

Economy

• economy.json
• Custom market json

Tutorials

• DR's Modding Guidelines
• Intro to Modding
• King Alfonzo's brief overview of modding
• Creating a Custom Ship
• Creating a Custom Weapon
• Creating a Custom Faction
• Setting up IntelliJ
• Getting started with mod programming
• Basic Campaign Editing
• Creating a Custom Planet
• Modding Quests
• Turning 3D Models into 2D Sprites (Alternate method)
• Hardcore Kitbashing Tutorial
• Advanced sprite creating technique
• Mod Inter-compatibility and integration

Other

• Modding Hardpoints
• Modding Extra
• Config Files (settings, sounds, and planets)
• Code Samples
• Trylobot's Ship Editor
• Name Generator
• Modding Plugins
• AI Flags

Troubleshooting

• Modding troubleshooting
• Guide to using a debugger
• Reading Starsector's log file to diagnose errors

Tips

• If you have devmode on, pressing F8 in simulator re-reads .json and .csv files, allowing you to make and check changes without restarting Starsector, which is a great timesaver.