Difference between revisions of "Modding"

From Stellaris Wiki
Jump to navigation Jump to search
m
(Game structure)
Line 38: Line 38:
 
Below is a list of game files and folders, with associated modding guide.
 
Below is a list of game files and folders, with associated modding guide.
  
 +
==== Stellaris/common/ ====
 
{| class = "wikitable"
 
{| class = "wikitable"
!File/Folder
+
!Folder
!What it contains
+
!Summary
!How to mod
+
!Guides
 
|-
 
|-
|Stellaris'''\common\'''
+
| agendas
* Edicts
+
| Agendas are given to leader-candidates in Oligarchic government-forms
* ethics
+
|  
* game rules
 
* army attachments
 
* name lists
 
* country types
 
* planet classes
 
* modifiers
 
* buildings
 
|General information
 
|[[Modifiers]]
 
 
|-
 
|-
|Stellaris'''\common\defines\'''
+
| ambient_objects
|Basic game behaviors and settings
+
| 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]]
 
|[[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.
 +
|
 +
|-
 +
|
 
|}
 
|}
 +
 +
==== Stellaris/events/ ====
 +
 +
==== Stellaris/flags/ ====
 +
 +
==== Stellaris/fonts/ ====
 +
 +
==== Stellaris/gfx/ ====
 +
 +
==== Stellaris/inteface/ ====
 +
 +
==== Stellaris/localisation/ ====
 +
 +
==== Stellaris/map/ ====
 +
 +
==== Stellaris/music/ ====
 +
 +
==== Stellaris/prescripted_countries/ ====
 +
 +
==== Stellaris/sound/ ====
  
 
== Modding Guides ==
 
== Modding Guides ==

Revision as of 22:44, 10 May 2016

Version

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!

Guidelines

  • 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.
  • 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 and Linux.

Game data

Game structure

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

Stellaris/common/

Folder 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.

Stellaris/events/

Stellaris/flags/

Stellaris/fonts/

Stellaris/gfx/

Stellaris/inteface/

Stellaris/localisation/

Stellaris/map/

Stellaris/music/

Stellaris/prescripted_countries/

Stellaris/sound/

Modding Guides

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

References


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