Descriptions CSV
Description
The descriptions csv is used to hold bulk text strings about various game entities, such as descriptions. Descriptions.csv is expected in location \Starsector\mods\ExampleMod\data\strings\Descriptions.csv . This is formatted in comma delimited, quote-aware csv format. To use commas in your description please ensure that field is totally enclosed in quotes (best practice anyway). If you want to use literal quotes within the description itself then the breakout character is / . Which fields are used is nominally dependant on the type of object by convention, set out below in the Type section. The PrintDescription command in Rules.csv can optionally pull data from any column by specifying it for that entity.
Example
Types
The ID field can correspond to an entity ID, such as a weapon, ship, ship system, etc. and when an appropriate type field is also set then it will automatically pull these text fields for that entity. The type field determines which other fields in descriptions.csv are meaningful. Possible types are represented in Enum Description.Type, information on them follows;
WEAPON
id
- The ID of the weapon, from the Weapon data.csv
type
- WEAPON
text1
- Description of the weapon as it appears in it's codex entry
text2
- Weapon class description as it appears in it's codex entry. For example Fire Support, Close Support, Strike, Assault, Special, etc
test3
- unused for this type
notes
- unused for this type
SHIP
id
- The ID of the ship, from the Ship Data CSV
type
- SHIP
text1
- Description of the ship as it appears in it's codex entry
text2
- Second description
test3
- unused for this type
notes
- unused for this type
SHIP_SYSTEM
id
- The ID of the ship system, from the Ship Systems CSV
type
- SHIP_SYSTEM
text1
- Long description
text2
- Ship system type description, such as "Movement/Offensive", Defensive, Offensive, etc
test3
- Short description
notes
- unused for this type
PLANET
id
- The ID of the planet
type
- PLANET
text1
- The text used when mousing over a planet or viewing it in your intel screen.
text2
- The name of the planet when you mouse over it. This can be different from the planet's actual name.
text3
- The description when you 'land' on a planet or dock at its station.
notes
- unused for this type
FACTION
id
- The ID of the faction, from the Factions CSV
type
- FACTION
text1
- Long description
text2
- unused for this type
test3
- unused for this type
notes
- unused for this type
RESOURCE
id
- The ID of the resource
type
- RESOURCE
text1
- Long description
text2
- unused for this type
test3
- unused for this type
notes
- unused for this type
TERRAIN
id
- The ID of the terrain (asteroid fields, coronas, etc)
type
- TERRAIN
text1
- Long description
text2
- unused for this type
test3
- unused for this type
notes
- unused for this type
ASTEROID
id
- The ID of the asteroid
type
- ASTEROID
text1
- Long description
text2
- unused for this type
test3
- unused for this type
notes
- unused for this type
ACTION_TOOLTIP
id
- The ID of the tactical map command
type
- ACTION_TOOLTIP
text1
- Long description
text2
- Friendly name of the command
test3
- unused for this type
notes
- unused for this type
CUSTOM
Custom can be used for a wide variety of purposes and which fields are meaningful is highly dependent on how it's called. It is commonly used (even in the base game) to override the default descriptions of planets and stations in system gen java files, in which case it has the following configuration:
id
- a unique ID which will be referenced in the java file
type
- CUSTOM
text1
- campaign-map description shown when mousing over the entity
text2
- unused for this type
test3
- description shown when interacting with the entity, before choosing any dialogue actions such as "open comms channel" or trading -- note that the description shown inside the actual buy/sell menu is stored elsewhere, in data/campaign/rules.csv, and uses its own, different syntax
notes
- unused for this type
Return to: Modding
- Potentially outdated