Furniture Modding - Revision history

Khornel: /* Components */

2025-08-29T15:38:05Z

Components

Khornel: /* Mesh replacements */

2024-05-02T11:28:49Z

Mesh replacements

Khornel: /* Mesh replacements */

2024-05-02T11:27:57Z

Mesh replacements

Khornel: /* Mesh replacements */

2024-05-02T11:27:49Z

Mesh replacements

Khornel: /* Mesh replacements */

2024-05-02T11:25:21Z

Mesh replacements

Khornel: /* Mesh replacements */

2024-05-02T11:25:05Z

Mesh replacements

Khornel: /* Mesh replacements */

2024-05-02T11:24:50Z

Mesh replacements

Khornel: /* Mesh replacements */

2024-05-02T11:20:41Z

Mesh replacements

Khornel: /* Mesh replacements */

2024-05-02T11:19:28Z

Mesh replacements

Khornel: /* Mesh replacements */

2024-05-02T11:17:18Z

Mesh replacements

@@ Line 236: / Line 236: @@
 Other than the elements described so far, all tables added to the root table are interpreted as Unity MonoBehaviour components. If you added a table called '''BoxCollider''', the children records would be interpreted as variables of the BoxCollider component and if the component does not exist, it will be instantiated for the Furniture. All MonoBehaviour variables in a Component will use the '''ComponentName''' record set in the other tags, or alternatively you can add a Transforms list to define empty transforms with a Name, Position and Rotation. Using '''self''' as a value for a MonoBehaviour variable will find the corresponding component in the root furniture object itself. This allows for anything to be added to a furniture, even MonoBehaviors from custom mods.
-If you set the '''ParentTransform''' record to a '''ComponentName''' reference, the component will be fetched/added to that object instead of the root furniture object. This could be used to add a Light component to an empty object to make your own lights. Make sure to add a '''LampScript''' component to your furniture object if you’re making a custom lamp, so the game can control shadows and lighting.
+If you set the '''TransformParent''' record to a '''ComponentName''' reference, the component will be fetched/added to that object instead of the root furniture object. This could be used to add a Light component to an empty object to make your own lights. Make sure to add a '''LampScript''' component to your furniture object if you’re making a custom lamp, so the game can control shadows and lighting.
 Adding a '''RemoveComponent True''' record for a table will remove that MonoBehavior from the furniture or '''TransformParent'''.

@@ Line 178: / Line 178: @@
 You can add mesh replacements, which work kind of like the texture atlas, but allow the player to replace entire meshes + materials for a piece of furniture. This feature is only available as of Beta 1.7.35.
-Replacements are grouped together, replacement groups can be mapped to one or more furniture. As an example, all stairs in the game use 2 replacement groups: "Stairs" and "Railings". Each group contains a list of possible replacements for that group, e.g. "metal", "glass", "fence". The replacement has a thumbnail for the UI and a material that all meshes that get replaced will use, when that replacement is active. Each replacement also has a list of mesh replacements, which tell the game which objects should use which mesh when that replacement is active, e.g "Stairs", "Platform" and "Support" for the "Stairs" replacement, and "Pole" and "Railing" for the "Railing" replacement.
+Replacements are grouped together, replacement groups can be mapped to one or more furniture. As an example, all stairs in the game use 2 replacement groups: "Stairs" and "Railings". Each group contains a list of possible replacements for that group, e.g. "metal", "glass", "fence". The replacement has a thumbnail for the UI and a material that all meshes that get replaced will use, when that replacement is active. Each replacement also has a list of key/mesh pairs, which tell the game which objects should use which mesh when that replacement is active, e.g "Stairs", "Platform" and "Support" for the "Stairs" replacement, and "Pole" and "Railing" for the "Railing" replacement.
 So the overall structure is:

@@ Line 176: / Line 176: @@
 === Mesh replacements ===
-You can add mesh replacement, which work kind of like the texture atlas, but allow the player to replace entire meshes + materials for a piece of furniture. This feature is only available as of Beta 1.7.35.
+You can add mesh replacements, which work kind of like the texture atlas, but allow the player to replace entire meshes + materials for a piece of furniture. This feature is only available as of Beta 1.7.35.
 Replacements are grouped together, replacement groups can be mapped to one or more furniture. As an example, all stairs in the game use 2 replacement groups: "Stairs" and "Railings". Each group contains a list of possible replacements for that group, e.g. "metal", "glass", "fence". The replacement has a thumbnail for the UI and a material that all meshes that get replaced will use, when that replacement is active. Each replacement also has a list of mesh replacements, which tell the game which objects should use which mesh when that replacement is active, e.g "Stairs", "Platform" and "Support" for the "Stairs" replacement, and "Pole" and "Railing" for the "Railing" replacement.

@@ Line 178: / Line 178: @@
 You can add mesh replacement, which work kind of like the texture atlas, but allow the player to replace entire meshes + materials for a piece of furniture. This feature is only available as of Beta 1.7.35.
-Replacements are grouped together, replacement groups can be mapped to one or more furniture. As an example, all stairs in the game use 2 replacement groups: "Stairs" and "Railings". Each group contains a list of possible replacements for that group. The replacement has a thumbnail for the UI and a material that all meshes that get replaced will use, when that replacement is active. Each replacement also has a list of mesh replacements, which tell the game which objects should use which mesh when that replacement is active.
+Replacements are grouped together, replacement groups can be mapped to one or more furniture. As an example, all stairs in the game use 2 replacement groups: "Stairs" and "Railings". Each group contains a list of possible replacements for that group, e.g. "metal", "glass", "fence". The replacement has a thumbnail for the UI and a material that all meshes that get replaced will use, when that replacement is active. Each replacement also has a list of mesh replacements, which tell the game which objects should use which mesh when that replacement is active, e.g "Stairs", "Platform" and "Support" for the "Stairs" replacement, and "Pole" and "Railing" for the "Railing" replacement.
 So the overall structure is:
@@ Line 229: / Line 229: @@
+  	}
-Note that each mesh can optionally have LOD1 and LOD2 defined. The Thumbnail should either be defined as "Thumbnail" or "ThumbnailRGB", depending on whether it should be RGB color mapped in the selection menu.
+Note that each mesh can optionally have LOD1 and LOD2 defined and that all meshes in a replacement uses the same material, so if you have multiple meshes for one replacement, they need to share materials and textures. The Thumbnail should either be defined as "Thumbnail" or "ThumbnailRGB", depending on whether it should be RGB color mapped in the selection menu.
 To make replacements work for your furniture, edit your furniture in the furniture editor and under the Replacement Options tab for your furniture add however many Replacement groups the furniture will use and add a default selection for each, in the same order. Then go to your mesh and select which mesh replacement it will be mapped to. As an example the telephone furniture could use the "TelephoneReplacementGroup" group, with "OldTelephone" as its default and then its keypad and handle meshes would be mapped to "KeyPad" and "Handle" mesh replacements.

@@ Line 178: / Line 178: @@
 You can add mesh replacement, which work kind of like the texture atlas, but allow the player to replace entire meshes + materials for a piece of furniture. This feature is only available as of Beta 1.7.35.
-Replacements are grouped together, a replacement groups can be mapped to on or more furniture. As an example, all stairs in the game use 2 replacement groups: "Stairs" and "Railings". Each group contains a list of possible replacements for that group. The replacement has a thumbnail for the UI and a material that all meshes that get replaced will use, when that replacement is active. Each replacement also has a list of mesh replacements, which tell the game which objects should use which mesh when that replacement is active.
+Replacements are grouped together, replacement groups can be mapped to one or more furniture. As an example, all stairs in the game use 2 replacement groups: "Stairs" and "Railings". Each group contains a list of possible replacements for that group. The replacement has a thumbnail for the UI and a material that all meshes that get replaced will use, when that replacement is active. Each replacement also has a list of mesh replacements, which tell the game which objects should use which mesh when that replacement is active.
 So the overall structure is:

@@ Line 228: / Line 228: @@
+  		}
+  	}
 === Components ===

@@ Line 185: / Line 185: @@
 To add mesh replacements, you need to add a "replacements.tyd" to the root of your mod folder. Here's an example of a replacement file:
-  TelephoneReplacementGroup
+  '''TelephoneReplacementGroup'''
+  	{
-  	OldTelephone
+  	'''OldTelephone'''
+  		{
-  		Material "Old Telephone Material"
+  		'''Material''' "Old Telephone Material"
-  		Thumbnail "Old telephone thumbnail.png"
+  		'''Thumbnail''' "Old telephone thumbnail.png"
-  		Meshes
+  		'''Meshes'''
+  			[
+  				{
-  				Name "KeyPad"
+  				'''Name''' "KeyPad"
-  				Mesh "OldKeyPad.obj"
+  				'''Mesh''' "OldKeyPad.obj"
-  				LOD1 "OldKeyPad-LOD1.obj"
+  				'''LOD1''' "OldKeyPad-LOD1.obj"
-  				LOD2 "OldKeyPad-LOD2.obj"
+  				'''LOD2''' "OldKeyPad-LOD2.obj"
+  				}
+  				{
-  				Name "Handle"
+  				'''Name''' "Handle"
-  				Mesh "OldHandle.obj"
+  				'''Mesh''' "OldHandle.obj"
-  				LOD1 "OldHandle-LOD1.obj"
+  				'''LOD1''' "OldHandle-LOD1.obj"
-  				LOD2 "OldHandle-LOD2.obj"
+  				'''LOD2''' "OldHandle-LOD2.obj"
+  				}
+  			]
+  		}
-  	NewTelephone
+  	'''NewTelephone'''
+  		{
-  		Material "New Telephone Material"
+  		'''Material''' "New Telephone Material"
-  		ThumbnailRGB "New telephone thumbnail.png"
+  		'''ThumbnailRGB''' "New telephone thumbnail.png"
-  		Meshes
+  		'''Meshes'''
+  			[
+  				{
-  				Name "KeyPad"
+  				'''Name''' "KeyPad"
-  				Mesh "NewKeyPad.obj"
+  				'''Mesh''' "NewKeyPad.obj"
-  				LOD1 "NewKeyPad-LOD1.obj"
+  				'''LOD1''' "NewKeyPad-LOD1.obj"
-  				LOD2 "NewKeyPad-LOD2.obj"
+  				'''LOD2''' "NewKeyPad-LOD2.obj"
+  				}
+  				{
-  				Name "Handle"
+  				'''Name''' "Handle"
-  				Mesh "NewHandle.obj"
+  				'''Mesh''' "NewHandle.obj"
-  				LOD1 "NewHandle-LOD1.obj"
+  				'''LOD1''' "NewHandle-LOD1.obj"
-  				LOD2 "NewHandle-LOD2.obj"
+  				'''LOD2''' "NewHandle-LOD2.obj"
+  				}
+  			]

← Older revision		Revision as of 11:19, 2 May 2024
Line 185:		Line 185:

	To add mesh replacements, you need to add a "replacements.tyd" to the root of your mod folder. Here's an example of a replacement file:		To add mesh replacements, you need to add a "replacements.tyd" to the root of your mod folder. Here's an example of a replacement file:
		+	TelephoneReplacementGroup
		+	{
		+	OldTelephone
		+	{
		+	Material "Old Telephone Material"
		+	Thumbnail "Old telephone thumbnail.png"
		+	Meshes
		+	[
		+	{
		+	Name "KeyPad"
		+	Mesh "OldKeyPad.obj"
		+	LOD1 "OldKeyPad-LOD1.obj"
		+	LOD2 "OldKeyPad-LOD2.obj"
		+	}
		+	{
		+	Name "Handle"
		+	Mesh "OldHandle.obj"
		+	LOD1 "OldHandle-LOD1.obj"
		+	LOD2 "OldHandle-LOD2.obj"
		+	}
		+	]
		+	}
		+	NewTelephone
		+	{
		+	Material "New Telephone Material"
		+	ThumbnailRGB "New telephone thumbnail.png"
		+	Meshes
		+	[
		+	{
		+	Name "KeyPad"
		+	Mesh "NewKeyPad.obj"
		+	LOD1 "NewKeyPad-LOD1.obj"
		+	LOD2 "NewKeyPad-LOD2.obj"
		+	}
		+	{
		+	Name "Handle"
		+	Mesh "NewHandle.obj"
		+	LOD1 "NewHandle-LOD1.obj"
		+	LOD2 "NewHandle-LOD2.obj"
		+	}
		+	]
		+	}
		+	}

	=== Components ===		=== Components ===