ModsFileNamingConventions: Difference between revisions

From The Colonists
Jump to navigation Jump to search
Bot_Materials entry and link
filename case flexibility
Line 2: Line 2:


The following filenames in a mod folder will be "read" and processed. <br>  
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 file "custom_log.txt" should show results of processing each file.<br>
<br>
'''NOTE''': most filenames are forgiving of case.<br> E.g. "landroutefloor_200.png", "LandRouteFloor_200.png", "LANDROUTEFLOOR_200.png", or "Landroutefloor_200.png" should all work the same.<br>
=Special Files=
=Special Files=
:[[Bot_Names|bot_names.txt]]
:[[Bot_Names|bot_names.txt]]

Revision as of 14:07, 22 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.

NOTE: most filenames are forgiving of case.
E.g. "landroutefloor_200.png", "LandRouteFloor_200.png", "LANDROUTEFLOOR_200.png", or "Landroutefloor_200.png" should all work the same.

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
landroutes.json
naturalresources.json
projectiles.json
resources.json
structures.json
techs.json
trains.json
units.json


Image Files

Files that match the object ID in the mod
e.g. "animal_200.png" -(image in building's in certain situations - see MiscCatModIds )
e.g. "boat_200.png" (see Icon )
e.g. "building_200_L2.png" (see Icon )
e.g. "dynamicfloor_200_L2.png" (see DynamicFloor )
e.g. "structurefloor_200_L2.png" (see StrutureFloor )
e.g. "resource_200.png" (see Icon )
e.g. "terraindetail_200.png" (see TerrainTypeDetail )
e.g. "misccategory_201.png" (input image in building's Production, Research, or Boatyard Dock panel - see MiscCatModIds)
e.g. "category_201.png" (image for a resource category , e.g. alcohol)
e.g. "naturalresource_200.png" (image for natural resource, e.g. used in creating a new natural resource in Custom Maps - see Icon)
e.g. "tech_200.png" (image for new research technology in Technology Panel -see Icon
e.g. "landroutefloor_200.png" (see LandRouteFloor )
e.g. "landroute_200.png" (see Image File )
thumbnail.png (image for Mod)
bot_material_main.png (image for Bot Materials)
bot_material_ramp.png (image for Bot Materials ramp)
floor_buildings.png (obsolete)
floor_base.png (obsolete)
floor_extra.png (obsolete)

3D Model Files

xyz.assetbundle