FBX file format - Revision history

Pcas1986: Added some information for Blender users.

2021-01-14T06:09:44Z

Added some information for Blender users.

← Older revision		Revision as of 06:09, 14 January 2021
Line 124:		Line 124:
	You must name your animation "anim.kin" in your bogey asset. You can leave the anim tag out of your config.txt as the anim.kin file is what the bogeys use.		You must name your animation "anim.kin" in your bogey asset. You can leave the anim tag out of your config.txt as the anim.kin file is what the bogeys use.

	====Warnings and Errors====		===Blender===
			====FBX Format====
			There are several Blender addon FBX exporters however the default version supplied with Blender is known to work. Blender 2.8 and later only have the binary export version. Earlier versions of Blender had the plain text option. You should use the binary export format.
			====UV Maps====
			Blender, by default, creates a UV map for each new mesh. This is usually called "UVMap" although the name itself is not important. Before exporting make sure you only have one UV map as multiple maps may cause issues including a VE258 error.
			UV maps can be found in the Properties panel, object data properties section.

			===Warnings and Errors===
	We will be updating this section with more information as we continue testing the new systems.		We will be updating this section with more information as we continue testing the new systems.

	* Warn, T13272: FBX-DOM (TOK_KEY, offset 0x14d27) source object for connection does not exist		* Warn, T13272: FBX-DOM (TOK_KEY, offset 0x14d27) source object for connection does not exist
	* Error, T13272: FBX: length of input data unexpected for ByPolygon mapping: 2586, expected 2463		* Error, T13272: FBX: length of input data unexpected for ByPolygon mapping: 2586, expected 2463
			* Error, T17344: Failed to triangulate polygon (no ear found). Probably not a simple polygon?
			** Cause: probably a malformed mesh as a result of mesh reduction. Can be hard to find.

	To fix these errors, check your UV and channel maps then re-export.		To fix these errors, check your UV and channel maps then re-export.

Gdennish: /* Animation Event Files */

2020-06-17T22:07:57Z

Animation Event Files

@@ Line 36: / Line 36: @@
 ''<frame-number> <event-type> <event-name>''
-The frame number is a zero-based frame index. Animations are typically exported at 30fps, which means that 0 is the very start of the animation, 30 is one second into the animation, and so on. Events should be in ascending frame order.
+For example, if the FBX came from Blender and was called:
 Event type must always be "Generic_Event" (without the quotes).
@@ Line 46: / Line 58: @@
 Please note that animation event files are processed by the mesh importer and the results are included into the Trainz animation file (*.kin). The game proper never uses "*.evt" files.
 == Submit ==

Windwalkr at 03:24, 6 June 2018

2018-06-06T03:24:57Z

← Older revision		Revision as of 03:24, 6 June 2018
Line 113:		Line 113:
	[[Category:Modeling]]		[[Category:Modeling]]
	[[Category:Content creation]]		[[Category:Content creation]]
	~~[[Category:TRS18]]~~

Tonyhilliam at 02:03, 24 January 2018

2018-01-24T02:03:46Z

← Older revision		Revision as of 02:03, 24 January 2018
Line 110:		Line 110:

	To fix these errors, check your UV and channel maps then re-export.		To fix these errors, check your UV and channel maps then re-export.

			[[Category:Modeling]]
			[[Category:Content creation]]
			[[Category:TRS18]]

Tonyhilliam: /* Asset Configuration */

2018-01-24T02:02:58Z

Asset Configuration

← Older revision		Revision as of 02:02, 24 January 2018
Line 19:		Line 19:

	* The [[config.txt file]] must specify a [[trainz-build]] version of 4.5 or higher.		* The [[config.txt file]] must specify a [[trainz-build]] version of 4.5 or higher.
	* The mesh reference in the [[config.txt file]] (for example, in the [["mesh-table" container]]) must use a "*.trainzmesh" file extension.		* The mesh reference in the [[config.txt file]] (for example, in the [["mesh-table" container]]) must use a [[Trainzmesh_file\|"*.trainzmesh"]] file extension.
	* If the FBX file contains animation tracks, the anim reference in the config.txt file should be named "<mesh-file-name>_<animation-track-name>.kin".		* If the FBX file contains animation tracks, the anim reference in the config.txt file should be named "<mesh-file-name>_<animation-track-name>.kin".
	* The FBX file must be placed within the asset folder at the indicated location, but with a "*.FBX" file extension.		* The FBX file must be placed within the asset folder at the indicated location, but with a "*.FBX" file extension.
	* If the FBX file references textures, an image file (eg. ".tga") or a texture resource (eg. ".texture.txt") with a matching file name must be present in the same folder as the FBX file.		* If the FBX file references textures, an image file (eg. ".tga") or a texture resource (eg. ".texture.txt") with a matching file name must be present in the same folder as the FBX file.
	* If the FBX file contains animation tracks, an animation event file may be present in the same folder as the FBX file. This should be named "<mesh-file-name>_<animation-track-name>.evt". This is not mandatory.		* If the FBX file contains animation tracks, an animation event file may be present in the same folder as the FBX file. This should be named "<mesh-file-name>_<animation-track-name>.evt". This is not mandatory.


	== Mesh Metadata Files ==		== Mesh Metadata Files ==

Tonyhilliam at 04:30, 19 January 2018

2018-01-19T04:30:24Z

← Older revision		Revision as of 04:30, 19 January 2018
Line 96:		Line 96:

	Another one to check is your mesh scale. If any of your meshes are scaled to something other than 100% (X:100, Y:100, Z:100) your mesh is likely to look incorrect or animate incorrectly. Check all bones and meshes to make sure they are 100% scale.		Another one to check is your mesh scale. If any of your meshes are scaled to something other than 100% (X:100, Y:100, Z:100) your mesh is likely to look incorrect or animate incorrectly. Check all bones and meshes to make sure they are 100% scale.

			====Displacement Slot====

			When you render your scene with a pbrmetaldetail material and forget about the displacement slot, strange results will arise. Don't forget your displacement slot!

			====Bogey Animations====
			You must name your animation "anim.kin" in your bogey asset. You can leave the anim tag out of your config.txt as the anim.kin file is what the bogeys use.

			====Warnings and Errors====
			We will be updating this section with more information as we continue testing the new systems.

			* Warn, T13272: FBX-DOM (TOK_KEY, offset 0x14d27) source object for connection does not exist
			* Error, T13272: FBX: length of input data unexpected for ByPolygon mapping: 2586, expected 2463

			To fix these errors, check your UV and channel maps then re-export.

Tonyhilliam: /* Channel Maps */

2018-01-19T04:23:16Z

Channel Maps

← Older revision		Revision as of 04:23, 19 January 2018
Line 71:		Line 71:
	====Channel Maps====		====Channel Maps====

	Sometimes 3DS Max likes to add extra map channels without you realising~~... This can cause rendering issue with Trainz~~.		Sometimes 3DS Max likes to add extra map channels without you realising, and FBX will most likely report an error such as "Error, T13316:FBX: ignoring binormal layer" or "Unable to determine vertex format".

	You can remove ~~them~~ by:		You can remove the extras by:

	1) Select mesh		1) Select mesh
Line 92:		Line 92:

	Now try exporting.		Now try exporting.


	====Mesh / Bone Scale====		====Mesh / Bone Scale====

	Another one to check is your mesh scale. If any of your meshes are scaled to something other than 100% (X:100, Y:100, Z:100) your mesh is likely to look incorrect or animate incorrectly. Check all bones and meshes to make sure they are 100% scale.		Another one to check is your mesh scale. If any of your meshes are scaled to something other than 100% (X:100, Y:100, Z:100) your mesh is likely to look incorrect or animate incorrectly. Check all bones and meshes to make sure they are 100% scale.

N3vpolsen: /* 3DS MAX */

2017-12-01T04:50:44Z

3DS MAX

← Older revision		Revision as of 04:50, 1 December 2017
Line 68:		Line 68:

	=== 3DS MAX ===		=== 3DS MAX ===

			====Channel Maps====

	Sometimes 3DS Max likes to add extra map channels without you realising... This can cause rendering issue with Trainz.		Sometimes 3DS Max likes to add extra map channels without you realising... This can cause rendering issue with Trainz.
Line 90:		Line 92:

	Now try exporting.		Now try exporting.


			====Mesh / Bone Scale====

			Another one to check is your mesh scale. If any of your meshes are scaled to something other than 100% (X:100, Y:100, Z:100) your mesh is likely to look incorrect or animate incorrectly. Check all bones and meshes to make sure they are 100% scale.

Windwalkr at 01:17, 11 October 2017

2017-10-11T01:17:38Z

← Older revision		Revision as of 01:17, 11 October 2017
Line 29:		Line 29:
	Various attributes which users may wish to control are frequently not available in standard modelling packages, or are not exported to the FBX file format. An optional "<mesh-file-name>.txt" file may be included alongside the "<mesh-file-name>.fbx" file to convey these attributes. Where attributes are specified in this metadata file, they override any entries read from the FBX file itself. If an attribute is not specified, it is calculated from the FBX file.		Various attributes which users may wish to control are frequently not available in standard modelling packages, or are not exported to the FBX file format. An optional "<mesh-file-name>.txt" file may be included alongside the "<mesh-file-name>.fbx" file to convey these attributes. Where attributes are specified in this metadata file, they override any entries read from the FBX file itself. If an attribute is not specified, it is calculated from the FBX file.

	~~Mesh metadata files are in a simple text format similar to~~ the config.txt format. They are not currently validated in any fashion beyond basic readability; if you mis-type a tag it will simply be ignored by the reader. Do not rely on this behaviour- we may add validation in the future and it may apply retroactively.		See the [[mesh metadata file]] page for full details.

	~~At the current time, the only use for a~~ mesh metadata file is to specify additional material parameters. A "materials" block is added to the file, and within this you may name any of the materials present within your FBX file. Within each of those, you may specify one of the following parameters:

	* 'two-sided' - A boolean (0 / 1) value which indicates whether chunks which use this material should be rendered as two-sided (no backface culling) or one-sided (regular backface culling).
	* 'blend-mode' - A string with one of the following values:
	** 'alpha-blend' - Chunks which use this material are rendered using a true alpha blend.
	** 'alpha-to-coverage' - Chunks which use this material are rendered using alpha-to-coverage. This technique is a fast approximation of alpha which sacrifices some visual detail in favour of performance and depth-independance.
	** 'alpha-masked' - Chunks which use this material are rendered using alpha masking. This technique discards pixels with low diffuse alpha values, resulting in holes in the geometry.
	** 'opaque' - Chunks which use this material are rendered fully opaque.
	* 'material-type' - A string which specifies the [[Material_Types\|material type]] to use. This causes the game to ignore any material type suffix on the material name. Be careful when overriding material types in this manner, as other requirements (such as texture slot bindings) may vary between material types. The material type string does not include a leading "m." - so "notex" is a valid entry here, but "m.notex" is not.

	~~=== Mesh Metadata File Example ===~~

	~~<pre>materials~~
	{
	~~example0.m.onetex~~
	{
	~~two-sided 1~~
	}
	~~example1.m~~.~~onetex~~
	{
	~~two-sided 1~~
	}
	}
	~~</pre>~~

Windwalkr at 01:11, 18 July 2017

2017-07-18T01:11:53Z

← Older revision		Revision as of 01:11, 18 July 2017
Line 29:		Line 29:
	Various attributes which users may wish to control are frequently not available in standard modelling packages, or are not exported to the FBX file format. An optional "<mesh-file-name>.txt" file may be included alongside the "<mesh-file-name>.fbx" file to convey these attributes. Where attributes are specified in this metadata file, they override any entries read from the FBX file itself. If an attribute is not specified, it is calculated from the FBX file.		Various attributes which users may wish to control are frequently not available in standard modelling packages, or are not exported to the FBX file format. An optional "<mesh-file-name>.txt" file may be included alongside the "<mesh-file-name>.fbx" file to convey these attributes. Where attributes are specified in this metadata file, they override any entries read from the FBX file itself. If an attribute is not specified, it is calculated from the FBX file.

	Mesh metadata files are in a simple text format similar to the config.txt format. They are not currently validated in any fashion beyond basic readability; if you mis-type a tag it will simply be ignored by the reader.		Mesh metadata files are in a simple text format similar to the config.txt format. They are not currently validated in any fashion beyond basic readability; if you mis-type a tag it will simply be ignored by the reader. Do not rely on this behaviour- we may add validation in the future and it may apply retroactively.

	At the current time, the only use for a mesh metadata file is to specify additional material parameters. A "materials" block is added to the file, and within this you may name any of the materials present within your FBX file. Within each of those, you may specify one of the ~~follow~~ parameters:		At the current time, the only use for a mesh metadata file is to specify additional material parameters. A "materials" block is added to the file, and within this you may name any of the materials present within your FBX file. Within each of those, you may specify one of the following parameters:

	* 'two-sided' - A boolean (0 / 1) value which indicates whether chunks which use this material should be rendered as two-sided (no backface culling) or one-sided (regular backface culling).		* 'two-sided' - A boolean (0 / 1) value which indicates whether chunks which use this material should be rendered as two-sided (no backface culling) or one-sided (regular backface culling).
Line 39:		Line 39:
	** 'alpha-masked' - Chunks which use this material are rendered using alpha masking. This technique discards pixels with low diffuse alpha values, resulting in holes in the geometry.		** 'alpha-masked' - Chunks which use this material are rendered using alpha masking. This technique discards pixels with low diffuse alpha values, resulting in holes in the geometry.
	** 'opaque' - Chunks which use this material are rendered fully opaque.		** 'opaque' - Chunks which use this material are rendered fully opaque.
			* 'material-type' - A string which specifies the [[Material_Types\|material type]] to use. This causes the game to ignore any material type suffix on the material name. Be careful when overriding material types in this manner, as other requirements (such as texture slot bindings) may vary between material types. The material type string does not include a leading "m." - so "notex" is a valid entry here, but "m.notex" is not.

	=== Mesh Metadata File Example ===		=== Mesh Metadata File Example ===