Mods - Revision history

Stlnegril9: /* Footprint Rendering & Unit Colliders */

2025-01-01T23:41:53Z

Footprint Rendering & Unit Colliders

← Older revision		Revision as of 23:41, 1 January 2025
Line 87:		Line 87:
	==Footprint Rendering & Unit Colliders==		==Footprint Rendering & Unit Colliders==
	The [[ModRender\|'''render.json''']] file can be used to change or define the footprint rendering of:		The [[ModRender\|'''render.json''']] file can be used to change or define the footprint rendering of:
	: Buildings		: Buildings (obsolete - see [[BuildingFloorCoordDict]])

	: Tree Fields		: Tree Fields

Codebyfire: /* Enabling mods */

2024-01-30T15:24:35Z

Enabling mods

← Older revision		Revision as of 15:24, 30 January 2024
Line 27:		Line 27:
	## '''Sandbox''' - "Active Mods" will open Mod Manager with Available and Workshop tabs for activating mods.		## '''Sandbox''' - "Active Mods" will open Mod Manager with Available and Workshop tabs for activating mods.
	## '''Random Map''' - "Active Mods" will open Mod Manager with Available and Workshop tabs for activating mods.		## '''Random Map''' - "Active Mods" will open Mod Manager with Available and Workshop tabs for activating mods.
	## '''Custom Map''' - "Active Mods" available when creating a new Custom Map, will open Mod Manager with Available and Workshop tabs for activating mods. ~~Note that you cannot~~ change active mods once the map has been created~~. Also note that while local mods can~~ be ~~selected for testing~~, ~~maps containing local mods can not be published to the Steam Workshop~~. Published Custom Maps with mods will include the mod(s) for subscribers.		## '''Custom Map''' - "Active Mods" available when creating a new Custom Map, will open Mod Manager with Available and Workshop tabs for activating mods. You can change active mods once the map has been created but be careful when doing so, in particular when removing content that is in use in your map. Published Custom Maps with mods will include the mod(s) for subscribers.
	# When a game is started all selected mods will be activated and their content processed, i.e. json files, images etc.		# When a game is started all selected mods will be activated and their content processed, i.e. json files, images etc.
	# All activated mods for the current game are listed in the Info panel, accessed in the top left of the screen.		# All activated mods for the current game are listed in the Info panel, accessed in the top left of the screen.

7up: /* Hot Reloading */

2023-08-22T16:20:05Z

Hot Reloading

← Older revision		Revision as of 16:20, 22 August 2023
Line 33:		Line 33:
	===Hot Reloading===		===Hot Reloading===
	Hot Reloading is intended as a mod development aid to quickly iterate on certain changes. Not all changes can be hot reloaded. For example a building model change that was generated using Unity AssetBundles will not be updated. However, changes to json files will iterate.<br><br>		Hot Reloading is intended as a mod development aid to quickly iterate on certain changes. Not all changes can be hot reloaded. For example a building model change that was generated using Unity AssetBundles will not be updated. However, changes to json files will iterate.<br><br>
	~~If you get a~~ "IOException: Sharing Violation..." it is often caused when ~~you have~~ the translations.csv file open in an editor.<br><br>		An "IOException: Sharing Violation..." is most often caused when the translations.csv file is open in an editor.<br><br>
	If you're using a local mod, you can update the contents of your mod and then reload the mod mid-game using the 'Reload' button in the Info panel. Be careful though! Some things may go wrong when reloading the codex mid-game, depending on the changes you make! For example, removing a building or resource may not go down well.		If you're using a local mod, you can update the contents of your mod and then reload the mod mid-game using the 'Reload' button in the Info panel. Be careful though! Some things may go wrong when reloading the codex mid-game, depending on the changes you make! For example, removing a building or resource may not go down well.

7up: /* Hot Reloading */

2023-08-22T16:19:19Z

Hot Reloading

← Older revision		Revision as of 16:19, 22 August 2023
Line 33:		Line 33:
	===Hot Reloading===		===Hot Reloading===
	Hot Reloading is intended as a mod development aid to quickly iterate on certain changes. Not all changes can be hot reloaded. For example a building model change that was generated using Unity AssetBundles will not be updated. However, changes to json files will iterate.<br><br>		Hot Reloading is intended as a mod development aid to quickly iterate on certain changes. Not all changes can be hot reloaded. For example a building model change that was generated using Unity AssetBundles will not be updated. However, changes to json files will iterate.<br><br>
			If you get a "IOException: Sharing Violation..." it is often caused when you have the translations.csv file open in an editor.<br><br>
	If you're using a local mod, you can update the contents of your mod and then reload the mod mid-game using the 'Reload' button in the Info panel. Be careful though! Some things may go wrong when reloading the codex mid-game, depending on the changes you make! For example, removing a building or resource may not go down well.		If you're using a local mod, you can update the contents of your mod and then reload the mod mid-game using the 'Reload' button in the Info panel. Be careful though! Some things may go wrong when reloading the codex mid-game, depending on the changes you make! For example, removing a building or resource may not go down well.

7up: /* Existing IDs */

2023-08-21T14:08:30Z

Existing IDs

← Older revision		Revision as of 14:08, 21 August 2023
Line 82:		Line 82:

	==Existing IDs==		==Existing IDs==
	A ~~tables~~ of links to ~~IDs~~ currently used can be found here: [[ModIds\|Existing IDs]]		ID's are used to identify the variety of buildings, resources, units (bots), technology, and other aspects of the game. For mods of existing json files it is good to know how to identify these existing IDs. A table of links to various ID tables that are currently used can be found here: [[ModIds\|Existing IDs]]

	==Footprint Rendering & Unit Colliders==		==Footprint Rendering & Unit Colliders==

7up: /* Interface */

2023-08-21T13:51:58Z

Interface

← Older revision		Revision as of 13:51, 21 August 2023
Line 67:		Line 67:
	Note many objects can be disabled in their main json file. See [[ModDisabledObjects\|DisabledObjects]].		Note many objects can be disabled in their main json file. See [[ModDisabledObjects\|DisabledObjects]].

	==Interface==		==User Interface==
	The game interface can be changed using the [[ModUI\|ui.json]] file. This can be modded to change Resource Storage and Building Menu displays.		The game interface can be changed using the [[ModUI\|ui.json]] file. This can be modded to change Resource Storage and Building Menu displays.

7up: /* Codex Objects */ Just changing the subtitle

2023-06-19T08:48:48Z

Codex Objects: Just changing the subtitle

← Older revision		Revision as of 08:48, 19 June 2023
Line 62:		Line 62:
	https://github.com/codebyfire/colonists-base-codex/tree/dev		https://github.com/codebyfire/colonists-base-codex/tree/dev

	===Codex Objects===		===Understanding and Modding Codex Objects===
	See [[ModCodexList\|Codex List]] for a list of Objects and explanation of JSON files for the base game of The Colonists.		See [[ModCodexList\|Codex List]] for a list of Objects and explanation of JSON files for the base game of The Colonists.

Stlnegril9: /* Footprint Rendering & Unit Colliders */ Re-org and clarify

2023-06-14T14:33:54Z

Footprint Rendering & Unit Colliders: Re-org and clarify

← Older revision		Revision as of 14:33, 14 June 2023
Line 86:		Line 86:
	==Footprint Rendering & Unit Colliders==		==Footprint Rendering & Unit Colliders==
	The [[ModRender\|'''render.json''']] file can be used to change or define the footprint rendering of:		The [[ModRender\|'''render.json''']] file can be used to change or define the footprint rendering of:
	# Buildings		: Buildings
	# Tree Fields
	# Plantable Fields ~~(see [[StructureDynamicFloorSpecs\|StructureDynamicFloorSpecs]])~~		: Tree Fields
	~~# LandRoutes (aka Paths and Roads) (see [[LandRouteFloor\|LandRouteFloor]])~~		: Plantable Fields
	~~# Structures~~		: Structures
	# Terrain Color
	# Terrain Detail Types		: Terrain Color
	~~as well as~~:		: Terrain Detail Types
	~~# Colliders used by~~ units on building floors.
			The render.json file can also be used to define unit colliders for:
			: Which units will use colliders on building floors.
			: Which buildings units will use colliders on building floors
			<br>
			The [[LandRouteFloor\|'''LandRouteFloor''']] file can be used to change or define the footprint rendering of:
			: LandRoutes (aka Paths and Roads)

	==Modding in Unity and Asset Bundles==		==Modding in Unity and Asset Bundles==

7up: providing links to Plantable Fields and LandRoutes

2023-06-13T18:38:44Z

providing links to Plantable Fields and LandRoutes

← Older revision		Revision as of 18:38, 13 June 2023
Line 88:		Line 88:
	# Buildings		# Buildings
	# Tree Fields		# Tree Fields
	# Plantable Fields		# Plantable Fields (see [[StructureDynamicFloorSpecs\|StructureDynamicFloorSpecs]])
			# LandRoutes (aka Paths and Roads) (see [[LandRouteFloor\|LandRouteFloor]])
	# Structures		# Structures
	# Terrain Color		# Terrain Color
Line 94:		Line 95:
	as well as:		as well as:
	# Colliders used by units on building floors.		# Colliders used by units on building floors.
	~~A [[LandRouteFloor\|LandRouteFloor image file]] can be used to change or define rendering of Paths and Roads.~~

	==Modding in Unity and Asset Bundles==		==Modding in Unity and Asset Bundles==

7up: /* Text Content */

2023-06-07T08:51:42Z

Text Content

← Older revision		Revision as of 08:51, 7 June 2023
Line 75:		Line 75:
	==Text Localisation==		==Text Localisation==
	===Text Content===		===Text Content===
	Use the [[ModTranslation.Csv\|translations.csv]] file to set dynamic and localised text content in the game.		Use the [[ModTranslation.Csv\|translations.csv]] file to set dynamic and localised text content in the game. This is also used to provide the text for newly created buildings and resources.

	===Bot Names===		===Bot Names===