ModsUnityAssetBundles - Revision history

7up: /* Animation */

2024-10-11T11:07:29Z

Animation

← Older revision		Revision as of 11:07, 11 October 2024
Line 170:		Line 170:
	[[File:UnityCodeExample_3D_Animation.png]]		[[File:UnityCodeExample_3D_Animation.png]]
	<br><br>		<br><br>
			Example of a Common Animation Issue: Smooth Rotation<br>
			Change both the start and end animation keyframes to match image below.<BR>
			[[File:UnitySmoothRotation.png\|Smooth Rotation]]

	==Example Step-by-Step Mods==		==Example Step-by-Step Mods==
	These examples should help you with the general flow, showing only minimum requirements. See [[Example_Step-by-Step_Mods\|Example_Step-by-Step_Mods]]		These examples should help you with the general flow, showing only minimum requirements. See [[Example_Step-by-Step_Mods\|Example_Step-by-Step_Mods]]

Stlnegril9: /* Animation */ clarify territory ownership vs watchtower specifically

2024-09-24T18:25:35Z

Animation: clarify territory ownership vs watchtower specifically

← Older revision		Revision as of 18:25, 24 September 2024
Line 163:		Line 163:
	:For particle effects (e.g. smoke, sparks, wood chips, etc) you can add 1 or more Particle Systems to the Production_Lx object, where "x" = the building level.<br><br>		:For particle effects (e.g. smoke, sparks, wood chips, etc) you can add 1 or more Particle Systems to the Production_Lx object, where "x" = the building level.<br><br>
	<br><strong>BURNING EFFECT</strong><br>		<br><strong>BURNING EFFECT</strong><br>
	:The "BURN" effect is built into the game. To activate it, there must be at least one object marked with the suffix "_Burn". See [[ModsUnityAssetBundles#Specific_hierarchies:\|Building Specific hierarchies]] and notice that there are "_Burn" items under Construction, Main and Rubble. The "BURN" effect is activated when a building is no longer covered by a ~~Watchtower range~~. This can happen from dismantling/destroying a Watchtower or from a combat scenario.<br><br>		:The "BURN" effect is built into the game. To activate it, there must be at least one object marked with the suffix "_Burn". See [[ModsUnityAssetBundles#Specific_hierarchies:\|Building Specific hierarchies]] and notice that there are "_Burn" items under Construction, Main and Rubble. The "BURN" effect is activated when a building is no longer covered by a territory ownership building. This can happen from dismantling/destroying a Watchtower, Harbour, etc. or from losing such buildings in a [[Combat\|combat]] scenario.<br><br>

	Example of Building animation in Unity:<br>		Example of Building animation in Unity:<br>

7up: /* Specific Hierarchies */

2023-08-24T12:53:23Z

Specific Hierarchies

← Older revision		Revision as of 12:53, 24 August 2023
Line 117:		Line 117:
	:::Rubble_Burn </span>		:::Rubble_Burn </span>

	*Note any object ending with "_Burn" will have burn particles applied when the building burns.		*Note any object ending with "_Burn" will have burn particles applied when the building burns. The Object can not be a Prefab, so be sure to unpack it.
	FLORA		FLORA
	:flora_200		:flora_200

7up: /* Animation */ Link to Unity Community on how to check for "Legacy"

2023-06-14T10:32:26Z

Animation: Link to Unity Community on how to check for "Legacy"

← Older revision		Revision as of 10:32, 14 June 2023
Line 159:		Line 159:
	: Review the "activeDirtyType" setting as shown here: [[ModBuildingProductionDataInfo#Mod_Building.json_-_ageComponentsDict_-_BuildingProductionDataInfo\|BuildingProductionDataInfo]].<br><br>		: Review the "activeDirtyType" setting as shown here: [[ModBuildingProductionDataInfo#Mod_Building.json_-_ageComponentsDict_-_BuildingProductionDataInfo\|BuildingProductionDataInfo]].<br><br>

	: Note: Animations that plug into existing behaviours, like production buildings, will need to be marked '''legacy''' in Unity.<br>		: Note: Animations that plug into existing behaviours, like production buildings, will need to be marked '''legacy''' in Unity. ([https://discussions.unity.com/t/mark-animation-as-legacy/200484 Unity Community How-to])<br>
	<br><strong>BUILDING PARTICLE EFFECTS</strong><br>		<br><strong>BUILDING PARTICLE EFFECTS</strong><br>
	:For particle effects (e.g. smoke, sparks, wood chips, etc) you can add 1 or more Particle Systems to the Production_Lx object, where "x" = the building level.<br><br>		:For particle effects (e.g. smoke, sparks, wood chips, etc) you can add 1 or more Particle Systems to the Production_Lx object, where "x" = the building level.<br><br>
Line 170:		Line 170:
	[[File:UnityCodeExample_3D_Animation.png]]		[[File:UnityCodeExample_3D_Animation.png]]
	<br><br>		<br><br>

	==Example Step-by-Step Mods==		==Example Step-by-Step Mods==
	These examples should help you with the general flow, showing only minimum requirements. See [[Example_Step-by-Step_Mods\|Example_Step-by-Step_Mods]]		These examples should help you with the general flow, showing only minimum requirements. See [[Example_Step-by-Step_Mods\|Example_Step-by-Step_Mods]]

7up: Add Example Step-by-Step page link and minor cleanup

2023-06-13T20:24:16Z

Add Example Step-by-Step page link and minor cleanup

← Older revision		Revision as of 20:24, 13 June 2023
Line 11:		Line 11:
	One method is to download the compressed file, uncompress it, then "OPEN" the project in the Unity Hub. You may get an error ("No 'git' executable was found") and you can ignore that error and continue.		One method is to download the compressed file, uncompress it, then "OPEN" the project in the Unity Hub. You may get an error ("No 'git' executable was found") and you can ignore that error and continue.

	==Unity Package - Asset Bundle builder:==		==Unity Package - Asset Bundle builder==
	A Unity Package to help build asset bundles for mods for The Colonists is available and can be found here, along with instructions:<br>		A Unity Package to help build asset bundles for mods for The Colonists is available and can be found here, along with instructions:<br>
	[https://github.com/codebyfire/colonists-mod-asset-bundle-builder Unity Package - Asset Bundle builder] <br><br>		[https://github.com/codebyfire/colonists-mod-asset-bundle-builder Unity Package - Asset Bundle builder] <br><br>
Line 18:		Line 18:
	The Asset Bundle Builder option ''"Clean Existing Asset Bundles"'' will delete every asset bundle in the target folder before building. Otherwise, only modified ABs will overwrite existing ABs.		The Asset Bundle Builder option ''"Clean Existing Asset Bundles"'' will delete every asset bundle in the target folder before building. Otherwise, only modified ABs will overwrite existing ABs.

	==3D Models & Colliders:==		==3D Models & Colliders==
	It is recommended to have a collider (or two) in the 3D models to make the game play more user friendly. Without a collider then you can only select the 3D model by selecting the tile(s) it is occupying. While this may be easier to do from a top down play, any other view angle would make selecting the 3D model more challenging without a collider. See specific Asset page for information on colliders to include in assets:<br>		It is recommended to have a collider (or two) in the 3D models to make the game play more user friendly. Without a collider then you can only select the 3D model by selecting the tile(s) it is occupying. While this may be easier to do from a top down play, any other view angle would make selecting the 3D model more challenging without a collider. See specific Asset page for information on colliders to include in assets:<br>
	<ol><li>Buildings: [[ModBuildings#3D_Models\|ModBuildings]]</li>		<ol><li>Buildings: [[ModBuildings#3D_Models\|ModBuildings]]</li>
Line 28:		Line 28:
	[[File:collider_on_example_building.png]]		[[File:collider_on_example_building.png]]

	==LOD (level of detail) and ~~culling~~==		==LOD (level of detail) and Culling==
	General guidelines for model size (by number of vertices) and when to use LOD to improve game performance can be surmised by comparing to the Chocolate Factory (a fairly detailed building) that has ~3,000 vertices.<br>		General guidelines for model size (by number of vertices) and when to use LOD to improve game performance can be surmised by comparing to the Chocolate Factory (a fairly detailed building) that has ~3,000 vertices.<br>
	A building that would occur infrequently like a monument with 15,000 vertices should not have performance issues, but a building with 10 instances at 15,000 vertices might.<br> Using a LOD with far fewer vertices for views far away from the building (zoomed out) would be a good compromise.<br>		A building that would occur infrequently like a monument with 15,000 vertices should not have performance issues, but a building with 10 instances at 15,000 vertices might.<br> Using a LOD with far fewer vertices for views far away from the building (zoomed out) would be a good compromise.<br>
Line 77:		Line 77:
	:"closest", i.e. highest detail, is LOD0.		:"closest", i.e. highest detail, is LOD0.

	==General ~~hierarchy:~~==		==General Hierarchy==
	ASSETS		ASSETS
	:prefabs		:prefabs
	==Specific ~~hierarchies:~~==		==Specific Hierarchies==
	ANIMALS		ANIMALS
	:animal_200		:animal_200
Line 147:		Line 147:
	[[File:Example Buidinghierarchy-Assets.png]]		[[File:Example Buidinghierarchy-Assets.png]]

	==Animation:==		==Animation==
	Also see [[ModsUnityAssetBundles#Specific_hierarchies:\|Building Specific hierarchies]].<br>		Also see [[ModsUnityAssetBundles#Specific_hierarchies:\|Building Specific hierarchies]].<br>
	<br><strong>BUILDING PRODUCTION ANIMATION</strong>		<br><strong>BUILDING PRODUCTION ANIMATION</strong>
Line 169:		Line 169:
	)<br>		)<br>
	[[File:UnityCodeExample_3D_Animation.png]]		[[File:UnityCodeExample_3D_Animation.png]]
			<br><br>
			==Example Step-by-Step Mods==
			These examples should help you with the general flow, showing only minimum requirements. See [[Example_Step-by-Step_Mods\|Example_Step-by-Step_Mods]]

7up: A little re-ordering and more on Colliders added

2023-06-09T17:49:36Z

A little re-ordering and more on Colliders added

← Older revision		Revision as of 17:49, 9 June 2023
Line 17:		Line 17:
	The Unity Console should show an information message upon successful AB built for each. e.g. ''Asset Bundle built: My_test_AB''. <br>		The Unity Console should show an information message upon successful AB built for each. e.g. ''Asset Bundle built: My_test_AB''. <br>
	The Asset Bundle Builder option ''"Clean Existing Asset Bundles"'' will delete every asset bundle in the target folder before building. Otherwise, only modified ABs will overwrite existing ABs.		The Asset Bundle Builder option ''"Clean Existing Asset Bundles"'' will delete every asset bundle in the target folder before building. Otherwise, only modified ABs will overwrite existing ABs.

			==3D Models & Colliders:==
			It is recommended to have a collider (or two) in the 3D models to make the game play more user friendly. Without a collider then you can only select the 3D model by selecting the tile(s) it is occupying. While this may be easier to do from a top down play, any other view angle would make selecting the 3D model more challenging without a collider. See specific Asset page for information on colliders to include in assets:<br>
			<ol><li>Buildings: [[ModBuildings#3D_Models\|ModBuildings]]</li>
			<li>Natural Resources: [[ModNatural_Resources]]</li>
			<li>Resources: [[ModResources#3D_Models\|ModResources]]</li>
			<li>Flora: [[ModFlora\|ModFlora]]</li>
			<li>Boats: [[ModBoats#3D_Models\|ModBoats]]</li></ol><br>
			Example of Building hierarchy showing the Collider (found in [[ModsUnityAssetBundles#Specific_hierarchies:\|Unity Project Example Assets]]):<br>
			[[File:collider_on_example_building.png]]

	==LOD (level of detail) and culling==		==LOD (level of detail) and culling==
Line 136:		Line 146:
	Example of Building hierarchy of assets and naming convention in Unity:<br>		Example of Building hierarchy of assets and naming convention in Unity:<br>
	[[File:Example Buidinghierarchy-Assets.png]]		[[File:Example Buidinghierarchy-Assets.png]]
	~~==Colliders:==~~
	See specific Asset page for information on colliders to include in assets (e.g. [[ModBuildings#3D_Models\|ModBuildings]], [[ModResources#3D_Models\|ModResources]], [[ModFlora\|ModFlora]], [[ModNatural_Resources]],[[ModBoats#3D_Models\|ModBoats]] )

	==Animation:==		==Animation:==

7up: /* Animation: */

2023-06-09T14:45:22Z

Animation:

← Older revision		Revision as of 14:45, 9 June 2023
Line 155:		Line 155:
	:For particle effects (e.g. smoke, sparks, wood chips, etc) you can add 1 or more Particle Systems to the Production_Lx object, where "x" = the building level.<br><br>		:For particle effects (e.g. smoke, sparks, wood chips, etc) you can add 1 or more Particle Systems to the Production_Lx object, where "x" = the building level.<br><br>
	<br><strong>BURNING EFFECT</strong><br>		<br><strong>BURNING EFFECT</strong><br>
	:The "BURN" effect is built into the game. To activate it, there must be at least one object marked with the suffix "_Burn". See [[ModsUnityAssetBundles#Specific_hierarchies:\|Building Specific hierarchies]] and notice that there are "_Burn" items under Construction, ~~Building~~ and Rubble. The "BURN" effect is activated when a building is no longer covered by a Watchtower range. This can happen from dismantling/destroying a Watchtower or from a combat scenario.<br><br>		:The "BURN" effect is built into the game. To activate it, there must be at least one object marked with the suffix "_Burn". See [[ModsUnityAssetBundles#Specific_hierarchies:\|Building Specific hierarchies]] and notice that there are "_Burn" items under Construction, Main and Rubble. The "BURN" effect is activated when a building is no longer covered by a Watchtower range. This can happen from dismantling/destroying a Watchtower or from a combat scenario.<br><br>

	Example of Building animation in Unity:<br>		Example of Building animation in Unity:<br>

7up: /* Animation: */ added some clarification, "BURN" subtitle

2023-06-09T14:38:21Z

Animation:: added some clarification, "BURN" subtitle

← Older revision		Revision as of 14:38, 9 June 2023
Line 141:		Line 141:
	==Animation:==		==Animation:==
	Also see [[ModsUnityAssetBundles#Specific_hierarchies:\|Building Specific hierarchies]].<br>		Also see [[ModsUnityAssetBundles#Specific_hierarchies:\|Building Specific hierarchies]].<br>
	BUILDING PRODUCTION ANIMATION		<br><strong>BUILDING PRODUCTION ANIMATION</strong>
	:Animations can be added to the Production object. Create two animations for the object:<br>		:Animations can be added to the Production object. Create two animations for the object:<br>
	<ol><li> One will be must end with "Idle" (e.g. Building200_Production_Idle).</li>		<ol><li> One will be must end with "Idle" (e.g. Building200_Production_Idle).</li>
	<li> One will end with "ProcessLoop" or "ProcessOnce" (all though this is not necessary but will help keep things organized when following the example)</li></ol><br>		<li> One will end with "ProcessLoop" or "ProcessOnce" (all though this is not necessary but will help keep things organized when following the example)</li></ol><br>
			: The "idle" Animation in Unity, is not active no matter whether you put animation actions in it or not: "idle" is basically just a reset point, it doesn't process it as an animation as the building is not considered to be "dirty" when idle.<br><br>
	:The two process animations (wrap modes) are:		:The two process animations (wrap modes) are:
	::A) looped (name ends with "processloop", e.g. Building200_Production_ProcessLoop) <br>		::A) looped (name ends with "processloop", e.g. Building200_Production_ProcessLoop) <br>
	::B) whole length (name ends with "processonce", e.g. Building200_Production_ProcessOnce)<br><br>		::B) whole length (name ends with "processonce", e.g. Building200_Production_ProcessOnce)<br><br>
	: Review the "activeDirtyType" setting as shown here: [[ModBuildingProductionDataInfo#Mod_Building.json_-_ageComponentsDict_-_BuildingProductionDataInfo\|BuildingProductionDataInfo]].<br><br>		: Review the "activeDirtyType" setting as shown here: [[ModBuildingProductionDataInfo#Mod_Building.json_-_ageComponentsDict_-_BuildingProductionDataInfo\|BuildingProductionDataInfo]].<br><br>
	: The "idle" Animation in Unity, is not active no matter whether you put animation actions in it or not: "idle" is basically just a reset point, it doesn't process it as an animation as the building is not considered to be "dirty" when idle.<br><br>
	: Note ~~that animations~~ that plug into existing behaviours, like production buildings, will need to be marked '''legacy''' in Unity.<br>		: Note: Animations that plug into existing behaviours, like production buildings, will need to be marked '''legacy''' in Unity.<br>
	BUILDING PARTICLE EFFECTS<br>		<br><strong>BUILDING PARTICLE EFFECTS</strong><br>
	:For particle effects you can add 1 or more Particle Systems to the Production_Lx object, where "x" = the building level.<br>		:For particle effects (e.g. smoke, sparks, wood chips, etc) you can add 1 or more Particle Systems to the Production_Lx object, where "x" = the building level.<br><br>
			<br><strong>BURNING EFFECT</strong><br>
			:The "BURN" effect is built into the game. To activate it, there must be at least one object marked with the suffix "_Burn". See [[ModsUnityAssetBundles#Specific_hierarchies:\|Building Specific hierarchies]] and notice that there are "_Burn" items under Construction, Building and Rubble. The "BURN" effect is activated when a building is no longer covered by a Watchtower range. This can happen from dismantling/destroying a Watchtower or from a combat scenario.<br><br>

	Example of Building animation in Unity:<br>		Example of Building animation in Unity:<br>
			(in this example the Particle Effect are sparks coming from the building and the Animation is the bouncing ball and can be found in [[ModsUnityAssetBundles#Specific_hierarchies:\|Unity Project Example Assets]]
			)<br>
	[[File:UnityCodeExample_3D_Animation.png]]		[[File:UnityCodeExample_3D_Animation.png]]

Stlnegril9: /* Specific hierarchies: */ correct-clarify subasset_naturalresources in groups of 5

2023-06-07T18:32:32Z

Specific hierarchies:: correct-clarify subasset_naturalresources in groups of 5

← Older revision		Revision as of 18:32, 7 June 2023
Line 114:		Line 114:
	NATURAL RESOURCES		NATURAL RESOURCES
	:naturalresources_200		:naturalresources_200
	::subasset_naturalresources_200_0 (mineable resource ~~numbering from 1 to 2~~)		::subasset_naturalresources_200_0 (1st fifth of mineable resource)
	::subasset_naturalresources_200_1 (mineable resource ~~numbering from 3 to 4~~)		::subasset_naturalresources_200_1 (2nd fifth of mineable resource)
	::subasset_naturalresources_200_2 (mineable resource ~~numbering from 5 to 6~~)		::subasset_naturalresources_200_2 (3rd fifth of mineable resource)
	::subasset_naturalresources_200_3 (mineable resource ~~numbering from 7 to 8~~)		::subasset_naturalresources_200_3 (4th fifth of mineable resource)
	::subasset_naturalresources_200_4 (mineable resource ~~numbering from 9 to 10~~)		::subasset_naturalresources_200_4 (5th fifth of mineable resource)

	PROJECTILES		PROJECTILES

Stlnegril9: /* Specific hierarchies: */ minor clarity for natural resource subasset numbers

2023-06-07T17:11:04Z

Specific hierarchies:: minor clarity for natural resource subasset numbers

← Older revision		Revision as of 17:11, 7 June 2023
Line 114:		Line 114:
	NATURAL RESOURCES		NATURAL RESOURCES
	:naturalresources_200		:naturalresources_200
	::subasset_naturalresources_200_0 (mineable resource 1 to 2)		::subasset_naturalresources_200_0 (mineable resource numbering from 1 to 2)
	::subasset_naturalresources_200_1 (mineable resource 3 to 4)		::subasset_naturalresources_200_1 (mineable resource numbering from 3 to 4)
	::subasset_naturalresources_200_2 (mineable resource 5 to 6)		::subasset_naturalresources_200_2 (mineable resource numbering from 5 to 6)
	::subasset_naturalresources_200_3 (mineable resource 7 to 8)		::subasset_naturalresources_200_3 (mineable resource numbering from 7 to 8)
	::subasset_naturalresources_200_4 (mineable resource 9 to 10)		::subasset_naturalresources_200_4 (mineable resource numbering from 9 to 10)

	PROJECTILES		PROJECTILES
Line 132:		Line 132:
	:subasset_plantablefieldplantable_200		:subasset_plantablefieldplantable_200
	::Main		::Main







	==Example Hierarchy==		==Example Hierarchy==