Difference between revisions of "Modding"

From Stellaris Wiki
Jump to navigation Jump to search
Line 571: Line 571:
| inteface/*_l_english.yml
| *_l_english.yml
| Contains English localisation
| Contains English localisation
| [[Modding Localisation|Localisation]]
| [[Modding Localisation|Localisation]]
| inteface/*_l_french.yml
| *_l_french.yml
| Contains French localisation
| Contains French localisation
| [[Modding Localisation|Localisation]]
| [[Modding Localisation|Localisation]]
| inteface/*_l_german.yml
| *_l_german.yml
| Contains German localisation
| Contains German localisation
| [[Modding Localisation|Localisation]]
| [[Modding Localisation|Localisation]]
| inteface/*_l_polish.yml
| *_l_polish.yml
| Contains Polish localisation
| Contains Polish localisation
| [[Modding Localisation|Localisation]]
| [[Modding Localisation|Localisation]]
| inteface/*_l_russian.yml
| *_l_russian.yml
| Contains Russian localisation
| Contains Russian localisation
| [[Modding Localisation|Localisation]]
| [[Modding Localisation|Localisation]]
| inteface/*_l_spanish.yml
| *_l_spanish.yml
| Contains Spanish localisation
| Contains Spanish localisation
| [[Modding Localisation|Localisation]]
| [[Modding Localisation|Localisation]]
| inteface/*_l_braz_por.yml
| *_l_braz_por.yml
| Contains Brazilian/Portuguese localisation
| Contains Brazilian/Portuguese localisation
| [[Modding Localisation|Localisation]]
| [[Modding Localisation|Localisation]]

Revision as of 17:24, 12 May 2016


Outliner top.png
This article is timeless and should be accurate for any version of the game.

Modding, or creating mods, is the act of modifying the behavior of the base game (often referred as vanilla), either for personal use, or to release publicly to other players, for instance via the Steam Workshop.

As for all Paradox games, Stellaris is moddable to a great extent. Motivations of modders may vary widely: better translation to native language, more events or decisions, better map, major overhaul, etc.

This guide is intended to lower the entry barriers to the world of Stellaris modding. However, there is still a learning curve to it, and it cannot replace the need to read some working vanilla code, and do lots of trial and error experimentation!


  • Create a mod for your modifications: use a personal mod even for small changes, and never modify directly game files in Steam Stellaris folder, as they may be overwritten without warning.
  • Use a good text editor (like Notepad++ or Sublime Text) to edit files and search into multiple files. Or Vim if you are a real programmer.
  • Validate your mod with The Validator, it will save you a lot of pain and time troubleshooting crashes and bugs.
  • Minimize overwrites of vanilla files by adding separate files and loading from folders whenever possible, to improve mod compatibility and maintenance.
  • Use a proper merge tool (like WinMerge), to merge between folders, and update modified vanilla files to a new vanilla patch.
  • Backup your work to avoid losing everything. Consider using a source control system like Git and a collaborative forge like GitHub to manage team collaboration.
  • Use UTF-8 encoding for text files.
  • Indent properly to easily spot unclosed curly braced. Vanilla uses 1 tab for indentation rather than spaces.
  • Use comments starting with # character, to remember reasons for writing tricky stuff.

Mod structure

Mods are located in folder ~\Paradox Interactive\Stellaris\mod, which must contain:

  • the .mod file, to tell the launcher what to do with the mod-folder.
  • the mod folder or zip containing the mod data. The mod data must have the same file and folder structure as if it was along with stallaris.exe in the game directory.

Note that folder and file names are case sensitive on Mac OS X and Linux.

For example, the a new text file called test1.mod' can be created in the "C:\Users\<Username>\Documents\Paradox Interactive\Stellaris\mod" folder, alongside a new 'test1' folder.


In the 'test1' folder, the test1.mod file should be copied and can be renamed to descriptor.mod.

Game files can now be replaced using the same structure as the game directory. Here, a common folder was created, with a traits subfolder that contains the 00_species_traits.txt from the game folder. The structure now looks like the following:

 C:\Users\Jason\Documents\Paradox Interactive\Stellaris\mod
   test1 (dir)
     common (dir)
       traits (dir)

A new trait with various bonuses called trait_super can be added. Here it has a high cost (so the AI could not use it, but the user could load it using the console commands). (Using is_ai = no seems to also do the trick)

trait_super = {
	cost = 1000
	modifier = {
		tile_resource_food_mult = 10
		tile_resource_energy_mult = 10
		tile_resource_minerals_mult = 10

In addition, downloaded mods will use content in zip files. Their '.mod' files will contain lines defining the 'remote_file_id' and 'archive'. Here is an example:

name="999 Core Planets - All your planets are belong to you"

This directory is based off the Stellaris directory in your documents folder, for instance this zip file is:

C:\Users\<Username>\Documents\Paradox Interactive\Stellaris\workshop\content\281990\678893824\999cores.zip

Game data

Game structure

Below is a list of game files and folders, with associated modding guide.


Folder/File Summary Guides
agendas Agendas are given to leader-candidates in Oligarchic government-forms
ambient_objects References used by code to spawn ambient objects
anomalies Events that occur for research ships
armies Definitions for army types
army_attachments Definitions for attachments that can be added to armies
attitudes Definitions containing the restrictions for each attitude used by the AI
buildable_pops Definitions for buildable pops. i.e. Robots
buildings Setup for buildings constructable on planets, and those given through events
colors Color definitions used for the country color selection
component_flags List of flags used by the AI for selecting components
component_sets List of the sets of components used by ships
component_tags Used to group components together for common modifiers
component_templates Attribute setup for each weapon and the templates used for ships
country_types Rules for each country within the game.
defines Basic game behaviors and settings Defines
deposits Setup for the deposits of resources found on planets
diplo_phrases Setup for the logic behind the diplomatic phrases used between countries.
diplomatic_actions Setup for the rules for diplomatic actions.
edicts Setup for the edicts used by planets and countries.
ethics Setup for ethics, controlling their modifiers and categories
event_chains Setup for the event chains used in the events folder
fallen_empires Sets up the countries and system initializer used for fallen empires
game_rules Logic used for various game actions, i.e. can_enslave_pop. Logic here does not override hardcoded rules.
global_ship_designs Designs used by the ship designer for each species
governments Setup for the governments.
graphical_culture Controls the lightning used for ships, which differs between graphical cultures.
mandates Controls the mandates used by factions
name_lists Sets up the names used for each species.
technology Technology


Folder/File Summary Guides
example_events.txt Contains the event code for a set of events. Events


Folder/File Summary Guides
*.dds A flag image file. Flags
colors.txt Sets up the allowed colors for flags and the randomizable combos. Flags


File Summary Guides
fonts.asset Sets up the fonts used by the game. Fonts


Folder/File Summary Guides
advisorwindow Sets up the 3D view for the advisor Graphics
arrows Contains the images used by various arrows ingame. Graphics
cursors Contains the cursor files/images used ingame. Graphics
event_pictures Contains the pictures used in events. Events
fonts Contains the font files used ingame. Fonts
FX Contains the FX shaders used ingame. Graphical Effects
interface/ Contains the images used for interfaces ingame. Graphics
interface/anomaly Contains the images used for the anomaly mechanic Graphics
interface/buttons Contains the images used for buttons Graphics
interface/diplomacy Contains the images used for the diplomacy interface. Graphics
interface/elections Contains the images used for the election interface. Graphics
interface/event_window Contains the images used for the event window. Graphics
interface/flags Contains the image masks used for flags. Graphics
interface/fleet_view Contains the images used for fleets. Graphics
interface/event_window Contains the images used for the frontend interface. Graphics
interface/government_mod_window Contains the images used for the government modification interface. Graphics
interface/icons Contains the icons used for everything in the game. Graphics
interface/main Contains the images used for generic actions. Graphics
interface/old Contains the images used from EU4 Graphics
interface/outliner Contains the images used for the outliner interface. Graphics
interface/planetview Contains the images used for the planet view interface. Graphics
interface/progressbars Contains the images used for progress bars ingame. Graphics
interface/ship_designer Contains the images used for the ship designer interface. Graphics
interface/situation_log Contains the images used for the situation log interface. Graphics
interface/sliders Contains the images used for sliders ingame. Graphics
interface/system Contains the images used for the system view interface. Graphics
interface/tech_view Contains the images used for the technology view interface. Graphics
interface/tiles Contains the images used for the tile view interface. Graphics
interface/topbar Contains the images used for the topbar interface. Graphics
interface/waroverview Contains the images used for the war view interface. Graphics
keyicons Contains the images used for button presses ingame. Graphics
lights Contains the logic used for the light effects ingame. Graphical Effects
loadingscreens Contains the images used for loadscreens. Graphics
models Contains the model .mesh files and images. Models
models/portraits Contains the portrait .mesh files and images. Portraits
particles Contains the logic and images used for particles. Graphics
pingmap Contains the logic used for pings. Graphics
portraits Contains the logic used for portrait images. Portraits
projectiles Contains the logic used for projectiles. Graphics
shipview Contains the logic used for ship view. Graphics
worldgfx Contains the logic and images used for world graphic effects. Graphics


Folder Summary Guides
inteface/*.gfx Controls the assignment of image to interface variable. Interfaces
inteface/*.gui Controls the visual logic of an interface. Interfaces


File Summary Guides
*_l_english.yml Contains English localisation Localisation
*_l_french.yml Contains French localisation Localisation
*_l_german.yml Contains German localisation Localisation
*_l_polish.yml Contains Polish localisation Localisation
*_l_russian.yml Contains Russian localisation Localisation
*_l_spanish.yml Contains Spanish localisation Localisation
*_l_braz_por.yml Contains Brazilian/Portuguese localisation Localisation


Folder/File Summary Guides
galaxy Contains the galaxy options. You cannot add new ones currently. Galaxies
setup_scenarios Controls the logic for different sizes of galaxies. Galaxies


Folder/File Summary Guides
*.ogg A music file. Music
songs.asset Controls the assignment of music to an code name, and sets the volume of playback. Music
songs.txt Music


Folder/File Summary Guides
*.txt Contains a pre-scripted setup for a country. Listed on the side ingame. Galaxies
setup_scenarios Controls the logic for different sizes of galaxies. Galaxies


Folder/File Summary Guides
*.asset Sets up sounds. Sound
*.wav A sound file. Sound

Tools & utilities

  • Notepad++ - Powerful editor to change files.
  • Maya exporter - Clausewitz Maya Exporter to create your own 3D models.
  • Steam Workshop - The place for where you can share your creations with other players.

External links

Stellaris Dev Diary #31 - Modding (Scripting Anomalies)
Stellaris Dev Diary #32 - Modding art

See also


Empire EmpireEthicsGovernments • Civics • OriginsMandatesAgendasTraditions • Ascension PerksEdictsPoliciesRelicsTechnologiesCustom Empires
Pops JobsFactions
Leaders LeadersLeader Traits
Species SpeciesSpecies Traits
Planets PlanetsPlanetary Feature • Orbital DepositBuildings • DistrictsPlanetary Decisions
Systems SystemsStarbasesMegastructuresBypassesMap
Fleets FleetsShips • Components
Land Warfare ArmiesBombardment Stance
Diplomacy Diplomacy • Federations • Galactic CommunityOpinion ModifiersCasus Belli • War Goals
Events EventsAnomaliesSpecial projectsArchaeological Sites
Gameplay GameplayDefinesResources • Economy
Dynamic modding Dynamic moddingEffectsConditionsScopesModifiersVariablesAI
Media/localisation Maya exporterGraphicsPortraitsFlagsEvent picturesInterfaceIconsMusicLocalisation
Other Console commandsSave-game editingSteam Workshop