3D:CMB format - Revision history

M-1: CMB: Fix reference error and various other updates

2021-03-08T23:38:45Z

CMB: Fix reference error and various other updates

Show changes

M-1: Small edits, still need to finish

2020-05-27T10:28:50Z

Small edits, still need to finish

M-1: Updated model info

2020-03-10T18:10:20Z

Updated model info

Show changes

M-1: Update Depth function

2020-03-10T17:34:50Z

Update Depth function

M-1: Almost done with materials

2020-03-10T17:32:55Z

Almost done with materials

Show changes

M-1: WIP material changes

2020-03-10T16:47:35Z

WIP material changes

M-1 at 16:03, 10 March 2020

2020-03-10T16:03:31Z

BoringPerson: clarify some stuff

2018-04-27T15:46:44Z

clarify some stuff

BoringPerson: new info from my own research, plus some old info moved around or better explained

2018-03-01T06:40:31Z

new info from my own research, plus some old info moved around or better explained

BoringPerson: added more pictures

2017-12-31T10:05:23Z

added more pictures

@@ Line 275: / Line 275: @@
 | 0138 || bool || BlendMode Enabled
 |-
-| 0139 || bool || Unknown
+| 0139 || bool || Padding 3
 |-
 | 013C || u16 ''([[#BlendingFactorSrc|BlendingFactorSrc]])''  || Alpha Source Function
@@ Line 416: / Line 412: @@
 | 0004 || u16 || Mipmap Count
 |-
-| 0006 || u16 || Unknown (Alwyas 0 or 1)
+| 0006 || u16 || Unknown (Always 0 or 1)
 |-
 | 0008 || u16 || Width
@@ Line 476: / Line 472: @@
 | 0002 || u8 || index of the [[#Material|Material]] to use ''(from the [[#MATS chunk|MATS chunk]])''
 |-
-| 0003 || u8 || ID (Also not sure)
+| 0003 || u8 || ID
 |}
@@ Line 518: / Line 514: @@
 | 0008 || u16 || # of PRMS chunks
 |-
 | 000A || u16 || Bit Flags
   HasPosition : 00000001
   HasNormals  : 00000010
@@ Line 557: / Line 553: @@
 ! Bit !! Vertex data to automatically generate
 |-
-|0x01 || vertex positions?
+|0x01 || Position
 |-
-|0x02 || normals? seen in some models, TODO
+|0x02 || Normals
 |-
-|0x04 || vertex colors?
+|0x04 || vertex colors
 |-
-|0x08 || texture coordinates? seen in some models, TODO
+|0x08 || TextureCoords Layer0
 |-
-|0x10 || unknown
+|0x10 || TextureCoords Layer1
 |-
-|0x20 || unknown
+|0x20 || TextureCoords Layer2
 |-
-|0x40 || bone index lookups, see [[#Notes_on_Skinning|Notes on Skinning]]
+|0x40 || Bone Indices
 |-
-|0x80 || bone weights, see [[#Notes_on_Skinning|Notes on Skinning]]
+|0x80 || Bone Weights
 |-
 |}
@@ Line 597: / Line 593: @@
 |-
 | 000C || Vector4 || Constant
 =====PRMS chunk=====
@@ Line 792: / Line 789: @@
 | 0 || Zero
 |-
-| 0x0300 || SrcColor
+| 0x0300 || SourceColor
 |-
-| 0x0301 || OneMinusSrcColor
+| 0x0301 || OneMinusSourceColor
 |-
-| 0x0302 || SrcAlpha
+| 0x0302 || SourceAlpha
 |-
-| 0x0303 || OneMinusSrcAlpha
+| 0x0303 || OneMinusSourceAlpha
 |-
-| 0x0304 || DstAlpha
+| 0x0304 || DestinationAlpha
 |-
-| 0x0305 || OneMinusDstAlpha
+| 0x0305 || OneMinusDestinationAlpha
 |-
 | 0x8001 || ConstantColor
@@ Line 811: / Line 808: @@
 |-
 | 0x8004 || OneMinusConstantAlpha
 |-
 | 1 || One
@@ Line 839: / Line 828: @@
 |-
 | 0x2703 || LinearMipmapLinear
 |}
@@ Line 865: / Line 838: @@
 |-
 | 0x2601 || Linear
 |}
@@ Line 986: / Line 939: @@
 ! Value !! Description
 |-
-| 0x00 || SrcAlpha
+| 0x00 || SourceAlpha
 |-
-| 0x01 || OneMinusSrcAlpha
+| 0x01 || OneMinusSourceAlpha
 |-
 | 0x02 || SrcRDMP ''(same as 0x8580 in OpenGL)''
@@ Line 1,085: / Line 1,038: @@
 Each ''RGBA'' is:
 {| class="wikitable" border="1"
-! Value !! Description
+! Value !! Type
 |-
 | R || u8
@@ Line 1,095: / Line 1,048: @@
 | A || u8
 |}

@@ Line 272: / Line 272: @@
 | 0135 || bool || DepthWriteEnabled
 |-
-| 0136 || u16 ''([[#AlphaFunction and StencilFunction|StencilFunction]])'' || Depth Test Function
+| 0136 || u16 ''([[#AlphaFunction and StencilFunction|DepthFunction]])'' || Depth Test Function
 |-
 | 0138 || bool || BlendMode Enabled
@@ Line 309: / Line 309: @@
 | 015F || u8 || Buffer
 |-
-| 0160 || u16 || Stencil Function
+| 0160 || [[#AlphaFunction and StencilFunction|StencilFunction]] || Stencil Function
 |-
 | 0162 || u16 || FailOP

@@ Line 124: / Line 124: @@
 |-
 | 000C || ''[[#Material|Material]]''[# of materials] || array of materials
 |}
 '''*''' zelda_am.zar/amos.cmb (Armos) has 2 materials but enough data for 8 texture environment settings. This means either the extra data is unused or something else determines the number of texture environment settings.
@@ Line 134: / Line 132: @@
 ! Offset !! Type !! Description
 |-
-| 0000 || u32 || unknown
+| 0000 || bool || IsFragmentLightingEnabled
 |-
-| 0004 || u32 || unknown
+| 0001 || bool || IsVertexLightingEnabled
 |-
-| 0008 || u32 || unknown
+| 0008 || u32 || TextureMappersUsed
 |-
-| 000C || u32 || unknown
+| 000C || u32 || TextureCoordsUsed
 |-
 | 0010 || ''[[#MatTexture|MatTexture]]''[3] || array of 3 textures
 |-
-| 0058 || u32/f32[50] || 50 unknown values of type u32 and f32'''*'''
+| 0058 || ''[[#TextureCoords|TextureCoords]]''[3] || array of 3 textures
 |-
-| 0120 || u32 || # of unknown indices
+| 00A4 || [[#RGBA|RGBA]] || Ambient Color
 |-
-| 0124 || u16[12] || array of unknown indices, padded to 12 bytes long with the value 0xff.
+| 00A8 || [[#RGBA|RGBA]] || Diffuse Color
 |-
 | 0130 || u8 (bool) || alpha test enable
@@ Line 209: / Line 225: @@
 | 0000 || s16 || index of the [[#Texture|Texture]] to use ''(from the [[#TEX chunk|TEX chunk]])'' or -1 for none
 |-
-| 0002 || s16 || unknown
+| 0002 || s16 || Padding
 |-
 | 0004 || u16 ''([[#TextureMinFilter|TextureMinFilter]])'' || texture minification filter
@@ Line 219: / Line 235: @@
 | 000A || u16 ''([[#TextureWrapMode|TextureWrapMode]])'' || texture wrap mode T
 |-
-| 000C || u32 || unknown
+| 000C || f32 || MinLODBias (Minimum Level Of Detail Bias)
 |-
-| 0010 || u32 || unknown
+| 0010 || Vector2 || Translation
 |-
 |}
@@ Line 953: / Line 990: @@
 |-
 | 0x8363 || UnsignedShort565
 |}

@@ Line 9: / Line 9: @@
 ! Offset !! Type !! Description
 |-
-| 0000 || char[4] || magic "cmb " ''("CTR Model Binary?")''
+| 0000 || char[4] || magic "cmb " ''("CTR Model Binary")''
 |-
-| 0004 || u32 || size of chunk ''(effectively the file size)''
+| 0004 || u32 || FileSize
 |-
-| 0008 || u32 || # of contained chunks'''*'''
+| 0008 || u32 || Version 0x6 = OoT3D
 |-
-| 000C || u32 || unknown
+| 000C || u32 || Unused. Always 0
 |-
-| 0010 || char[16] || name of chunk
+| 0010 || char[16] || Model Name
 |-
-| 0020 || u32 || # of vertex indices
+| 0020 || u32 || # of vertex indices (# is always in size of u16 Even when bytes)
 |-
 | 0024 || u32 || [[#SKL chunk|SKL chunk]] pointer (absolute)
 |-
-| 0028|| u32 || [[#MATS chunk |MATS chunk ]]pointer (absolute)'''**'''
+| 0028|| u32 || [[#MATS chunk |MATS chunk ]]pointer (absolute)
 |-
 | 002C || u32 || [[#TEX chunk|TEX chunk]] pointer (absolute)
@@ Line 37: / Line 37: @@
 | 0040 || u32 || Texture data pointer
 |}
 ==SKL chunk==
@@ Line 51: / Line 44: @@
 ! Offset !! Type !! Description
 |-
-| 0000 || char[4] || magic "skl " ''("Skeleton?")''
+| 0000 || char[4] || magic "skl " ''("Skeleton")''
 |-
 | 0004 || u32 || size of chunk
@@ Line 57: / Line 50: @@
 | 0008 || u32 || # of bones
 |-
-| 000C || u32 || unknown
+| 000C || u32 || unknown (Values seen: 0-2 Maybe Flags?)
 |-
 | 0010 || ''[[#Bone|Bone]]''[# of bones] || array of bones
@@ Line 68: / Line 61: @@
 ! Offset !! Type !! Description
 |-
-| 0000 || s16 || bone ID
+| 0000 || u8 || bone ID
 |-
 | 0002 || s16 || parent bone's ID, or -1 for no parent
 |-
-| 0004 || f32 * 3 || unknown
+| 0004 || vector3 || scale
 |-
-| 0010 || f32 * 3 || rotation
+| 0010 || vector3 || rotation
 |-
-| 001C || f32 * 3 || translation
+| 001C || vector3 || translation
 |}
@@ Line 122: / Line 117: @@
 ! Offset !! Type !! Description
 |-
-| 0000 || char[4] || magic "mats" ''("Materials?")''
+| 0000 || char[4] || magic "mats" ''("Materials")''
 |-
-| 0004 || u32 || size of chunk? doesn't seem to match actual size
+| 0004 || u32 || size of chunk (size not accurate probably an oversight)
 |-
 | 0008 || u32 || # of materials

@@ Line 72: / Line 72: @@
 | 0002 || s16 || parent bone's ID, or -1 for no parent
 |-
-| 0004 || f32 * 3 || scale
+| 0004 || f32 * 3 || unknown
 |-
 | 0010 || f32 * 3 || rotation
@@ Line 487: / Line 487: @@
 |-
 | 1
-| The bone will be skinned as per [[#Notes_on_Skinning|Notes on Skinning]].
+| The vertices in the PRMS chunk will be weighed between multiple bones (see [[#Notes_on_Skinning|Notes on Skinning]]).
 * In addition, all vertices in the PRMS chunk must be repositioned like in skinning mode 0.
 |-
 | 2
-| The bone will be skinned as per [[#Notes_on_Skinning|Notes on Skinning]].
+| The vertices in the PRMS chunk will be weighed between multiple bones (see [[#Notes_on_Skinning|Notes on Skinning]]).
 |}
 |-

@@ Line 78: / Line 78: @@
 | 001C || f32 * 3 || translation
 |}
 ==QTRS chunk (Majora's Mask 3D only)==
@@ Line 410: / Line 412: @@
 | 00E8 || ''[[#VertexList|VertexList]]'' || bone weights (normally unused, only used when the '''skinning mode''' in a [[#PRMS chunk|PRMS chunk]] is 1 or 2)
 |-
-| 0104 || u32 || unknown
+| 0104 || u16 || bones per vertex. Used when skinning mode is 1 or 2, ignored otherwise. A 3 for this value means every 3 bone lookups and bone weights in the VertexList are assigned to a single vertex, and so on. A value of 1 is a special case, see [[#Notes_on_Skinning|Notes on Skinning]].
 |-
 | 0108 || u16[# of PRMS chunks] || array of [[#PRMS chunk|PRMS chunks]] offsets, relative to the beginning of the SEPD chunk. The values are aligned on a 4-byte boundary.
@@ Line 424: / Line 451: @@
 | 0000 || u32 || offset from which to start reading list elements, relative to '''offset to data''' in the matching ''[[#VertexListData|VertexListData]]''.<br />(For example, if this VertexList is for normals and you want to read the normals: the beginning of the VATR chunk + '''offset to data''' in the normals' ''[[#VertexListData|VertexListData]]'' + this offset = the absolute offset from which to start reading normals.)
 |-
-| 0004 || f32 || scale (presumably multiply all list elements by this?)
+| 0004 || f32 || scale. All list elements are multiplied by this value. For example, bone weights range from 0 to 100, and multiplying by scale will result in a value between 0.0 and 1.0.
 |-
 | 0008 || u16 (''[[#PicaDataType|PicaDataType]]'') || data type of the list elements
@@ Line 452: / Line 479: @@
 |-
 | 000C || u16 || skinning mode, with regard to [[#Bones|Bones]] from the [[#SKL chunk|SKL chunk]]:
-* 0 means all vertices in the PRMS chunk will be bound to a single bone. In this case, there will only be 1 bone index below, and that bone index will be the bone ID to use.
+{| class="wikitable" border="1"
-* 1 means the vertex indices from the PRM chunk will use not only vertex positions and normals and such, but also bone index lookups and bone weights (from the ''[[#VertexLists|VertexLists]]'' in the [[#SEPD chunk|SEPD chunk]]).
+! Skinning mode !! Description
-**Each vertex index points to a pair of bone index lookups in the list (which means every vertex is ultimately assigned to 2 bones). Each bone index lookup in turn each point to one of the bone indices below, which in turn points to a Bone in the SKL chunk. ([[#PRM chunk|PRM]] vertex index &rarr; [[#SEPD chunk|SEPD]] bone index lookups &rarr; [[#PRMS chunk|PRMS]] bone indices &rarr; [[#SKL chunk|SKL]] bone ID)
+|-
-**Each vertex index also points to a pair of bone weights. As mentioned before, each vertex is ultimately assigned to 2 bones. The bone weights are a pair of values adding up to 100. A value of [0,100] means the vertex ignores the first bone and is controlled 100% by the second bone. A [50, 50] split weighs the vertex evenly between the two bones.
+| 0
-* 2 means "the same as 1, except the vertices DO NOT inherit the translations of their bones, they are only "mapped" to them. (Scaling and rotation only.)" However, xdaniel was having trouble getting it to work, so there may be more to it than that.
+| All vertices in the PRMS chunk will be bound to a single bone, the first (and only) bone index in the array of bone indices below.
+* In addition, all vertices in the PRMS chunk must be repositioned, or else model parts like faces and held objects will appear by the character's feet. To do this, transform them by the bone's matrix (i.e. the orientation of the bone after taking the parent bones into account).
-[https://www.the-gcn.com/community/topic/2859-oot-3d-3ds-model-format-discussion/?do=findComment&comment=46121 more info] (forum registration required)
+|-
 |-
 | 000E || u16 || # of bone indices
@@ Line 495: / Line 529: @@
 The vertex indices read this way refer to the vertices in each ''[[#VertexList|VertexList]]'' of the [[#SEPD chunk|SEPD chunk]]. Every three vertex indices creates a single triangle.
 : For example: Consider the SEPD chunk containing the PRMS chunk that contains this PRM chunk. If the vertices indices read in this PRM chunk are [0,1,2], those numbers refer to the first 3 vertex positions, normals, texcoords, etc. in each of the ''VertexLists'' of that SEPD chunk.
 ==LUTS chunk==

@@ Line 1: / Line 1: @@
-[[File:CMB_format_chart.png|thumb|A chart showing how different parts of a CMB model file are connected.]]The '''CMB format''' ('''CTR Model Binary'''?) is a 3D model format used in Ocarina of Time 3D. It's also used in Majora's Mask 3D with a few differences.
+[[File:OoTMM3D CMB format diagram.png|thumb|A diagram showing how different parts of a CMB model file are connected.]]The '''CMB format''' ('''CTR Model Binary'''?) is a 3D model format used in Ocarina of Time 3D. It's also used in Majora's Mask 3D with a few differences.
 Note: Nearly all this information was gathered from the source code of [https://github.com/xdanieldzd/N3DSCmbViewer N3DSCmbViewer], which warns that it is "unfinished, experimental code."
@@ Line 46: / Line 46: @@
 ==SKL chunk==
-The SKL chunk contains bones ordered in a hierarchy.
+[[File:OoTMM3D CMB format skl.png|thumb|SKL chunk]]The SKL chunk contains bones ordered in a hierarchy.
 {| class="wikitable" border="1"
@@ Line 115: / Line 115: @@
 ==MATS chunk==
-The MATS chunk contains materials and texture environment settings.
+[[File:OoTMM3D CMB format mats.png|thumb|MATS chunk]]The MATS chunk contains materials and texture environment settings.
 {| class="wikitable" border="1"
@@ Line 254: / Line 254: @@
 ==TEX chunk==
-The TEX chunk contains textures.
+[[File:OoTMM3D CMB format tex.png|thumb|TEX chunk]]The TEX chunk contains textures.
 {| class="wikitable" border="1"
@@ Line 294: / Line 294: @@
 ==SKLM chunk==
-The SKLM chunk contains mesh-related data.
+[[File:OoTMM3D CMB format sklm.png|thumb|SKLM chunk]]The SKLM chunk contains mesh-related data.
 {| class="wikitable" border="1"
@@ Line 307: / Line 307: @@
 | 000C || u32 || [[#SHP chunk|SHP chunk]] pointer, relative to the beginning of the SKLM chunk
 |}
-After that, the SKLM chunk contains the [[#MSHS chunk|MSHS chunk]] and [[#SHP chunk|SHP chunk]].
+After that, the SKLM chunk contains the [[#MSHS chunk|MSHS chunk]] and [[#SHP chunk|SHP chunk]].{{clear}}
 ===MSHS chunk===
-The MSHS chunk contains meshes, which are a shape combined with a material.
+[[File:OoTMM3D CMB format mshs.png|thumb|MSHS chunk]]The MSHS chunk contains meshes, which are a shape combined with a material.
 {| class="wikitable" border="1"
@@ Line 351: / Line 351: @@
 ===SHP chunk===
-The SHP chunk is a collection of multiple shapes, each of which can be used by a mesh.
+[[File:OoTMM3D CMB format shp.png|thumb|SHP chunk]]The SHP chunk is a collection of multiple shapes, each of which can be used by a mesh.
 {| class="wikitable" border="1"
@@ Line 369: / Line 369: @@
 ====SEPD chunk====
-Each SEPD chunk is a shape made of multiple primitives and the lists of vertex attributes used by those primitives.
+[[File:OoTMM3D CMB format sepd.png|thumb|SEPD chunk]]Each SEPD chunk is a shape made of multiple primitives and the lists of vertex attributes used by those primitives.
 {| class="wikitable" border="1"
@@ Line 440: / Line 440: @@
 =====PRMS chunk=====
-Each PRMS chunk contains a PRM chunk (primitive) and binds it to one or more bones.
+[[File:OoTMM3D CMB format prms.png|thumb|PRMS chunk]]Each PRMS chunk contains a PRM chunk (primitive) and binds it to one or more bones.
 {| class="wikitable" border="1"
@@ Line 456: / Line 456: @@
 **Each vertex index points to a pair of bone index lookups in the list (which means every vertex is ultimately assigned to 2 bones). Each bone index lookup in turn each point to one of the bone indices below, which in turn points to a Bone in the SKL chunk. ([[#PRM chunk|PRM]] vertex index &rarr; [[#SEPD chunk|SEPD]] bone index lookups &rarr; [[#PRMS chunk|PRMS]] bone indices &rarr; [[#SKL chunk|SKL]] bone ID)
 **Each vertex index also points to a pair of bone weights. As mentioned before, each vertex is ultimately assigned to 2 bones. The bone weights are a pair of values adding up to 100. A value of [0,100] means the vertex ignores the first bone and is controlled 100% by the second bone. A [50, 50] split weighs the vertex evenly between the two bones.
-* 2 means "the same as 1, except the vertices DO NOT inherit the translations of their bones, they are only "mapped" to them. (Scaling and rotation only.)" However, xdaniel was having trouble getting it to work, so things may be more complicated than that.
+* 2 means "the same as 1, except the vertices DO NOT inherit the translations of their bones, they are only "mapped" to them. (Scaling and rotation only.)" However, xdaniel was having trouble getting it to work, so there may be more to it than that.
 [https://www.the-gcn.com/community/topic/2859-oot-3d-3ds-model-format-discussion/?do=findComment&comment=46121 more info] (forum registration required)
@@ Line 471: / Line 471: @@
 ======PRM chunk======
-Each PRM chunk contains a single primitive, in this case a set of triangles created from a list of vertex indices.
+[[File:OoTMM3D CMB format prm.png|thumb|PRM chunk]]Each PRM chunk contains a single primitive, in this case a set of triangles created from a list of vertex indices.
 {| class="wikitable" border="1"
@@ Line 512: / Line 512: @@
 ==VATR chunk==
-The VATR chunk contains the raw data for vertices.
+[[File:OoTMM3D CMB format vatr.png|thumb|VATR chunk]]The VATR chunk contains the raw data for vertices.
 {| class="wikitable" border="1"