ModsFileNamingConventions: Difference between revisions

From The Colonists
Jump to navigation Jump to search
temp placeholders for image file names that need updating
No edit summary
Line 1: Line 1:
The Colonists Mod file naming conventions
The Colonists Mod file naming conventions


The following filenames in a mod folder will be "read" and processed. <br> The file "custom_log.txt" should show results of processing each file.
The following filenames in a mod folder will be "read" and processed. <br>  
The file "custom_log.txt" should show results of processing each file.
=Special Files=
=Special Files=
:bot_names.txt
:bot_names.txt
:[[global.json|global.json]]
:[[global.json|global.json]]
:[[ModMarket|market.json]]
:[[ModMarket|market.json]]
:[[Meta|meta.json]]
:[[ModRender|render.json]]
:[[ModRender|render.json]]
:[[ModTranslation.Csv|translation.csv]]
:[[ModTranslation.Csv|translation.csv]]
:[[ModUI|ui.json]]
:[[ModUI|ui.json]]
:[[Meta|meta.json]]
:[[PublishedFileId.txt]]


=Object Specific Files=
=Object Specific Files=

Revision as of 23:00, 19 December 2022

The Colonists Mod file naming conventions

The following filenames in a mod folder will be "read" and processed.
The file "custom_log.txt" should show results of processing each file.

Special Files

bot_names.txt
global.json
market.json
render.json
translation.csv
ui.json
meta.json
PublishedFileId.txt


Object Specific Files

animals.json
boats.json
buildings.json
flora.json
natural_resources.json
projectiles.json
resources.json
structures.json
techs.json
trains.json
units.json


Image Files

Files that match the object name in the mod
e.g. "animal_200.png"
e.g. "boat_200.png"
e.g. "building_200_L2.png"
e.g. "dynamicfloor_200_L2.png"
e.g. "structurefloor_200_L2.png"
e.g. "resource_200.png"
e.g. "terraindetail_200.png"
misccategory_201.png (input image in building's Production, Research, or Boatyard Dock panel)
category_201.png (image for a resource category , e.g. alcohol)
natu_201.png (image for natural resource, e.g. used in creating a new natural resource in Custom Maps)
tech_200.png (image for new research technology in Technology Panel)
floor_buildings.png (obsolete)
floor_base.png (obsolete)
floor_extra.png (obsolete)


3D Model Files

xyz.assetbundle