Luma's Workshop - User contributions [en]

BMD/BDL (File Format)

2026-06-01T18:44:35Z

Super Hackio: /* Index Buffer Formats */ Note about the matrix types

[[Category:File formats]]
{{WIP}}

BMD ('''B'''inary '''M'''o'''d'''el) and BDL ('''B'''inary '''D'''isplay '''L'''ist) are two 3D model formats used in ''Super Mario Galaxy'' and ''Super Mario Galaxy 2'', among a few other ''Wii'' and ''GameCube'' games, such as ''Super Mario Sunshine''.

These two formats hold the same data, except BDL contains an additional set of data which is used for faster rendering speeds.

''Super Mario Galaxy'' & ''Super Mario Galaxy 2'' contain J3DLoader versions 21 and 26.

== File Header ==
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || The magic that tells the game which format this file is. (ASCII) '''J3D2bmd2''' for BMD (J3DLoader V21) '''J3D2bmd3''' for BMD (J3DLoader v26) '''J3D2bdl4''' for BDL (J3DLoader v26)
|-
| 0x08 || Int32 || The total size of the file
|-
| 0x0C || Int32 || The number of chunks present in this file. '''8''' for BMD '''9''' for BDL
|}

=== Subversion Header ===
This part of the header is not used, and can be anything.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || A 4 character value representing the Subversion. Usually SVR3 for SMG/2.
|-
| 0x04 || Byte[12] || Twelve bytes of padding. Usually these are '''0xFF'''
|}

== INF1 - Scene Information ==
The '''Inf'''ormation section hosts a hierarchy of Joints, Materials, and Shapes, which are used to render the model.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''INF1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || [[#J3DLoader%20Flags|J3DLoader Flags]]
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || Matrix Group Data Count Referring to the Matrix Group Data in [[#SHP1_-_Shape_Information|SHP1]] Stored in a variable by the game, but not used to dictate the actual number of Matrix Groups.
|-
| 0x10 || Int32 || Vertex Count Always equals the number of entries in the [[#VTX1_-_Vertex_Data|VTX1]] "POSITION" [[#Vertex%20Buffer%20Formats|data buffer]] Stored in a variable by the game, but never used for anything. The game reads Vertex Data directly from the [[#Vertex%20Buffer%20Formats|data buffer]]s without bounds checking.
|-
| 0x14 || Int32 || Relative offset to the [[#Scene%20Hierarchy|Scene Hierarchy]]
|}

=== J3DLoader Flags ===
The J3DLoader contains several flags which affect how models are handled. There are more than what are shown here, however, those must be applied by the game itself in the code.
{| class="wikitable"
|-
! Value !! Description
|-
| 0b0000000000000000 || No flags applied (TODO: Check if this defaults to basic matrix calculation)
|-
| 0b0000000000000001 || Use Autodesk Softimage matrix calculation
|-
| 0b0000000000000010 || Use Autodesk Maya matrix calculation
|-
| 0b0000000000000100 || Use Basic matrix calculation
|-
| 0b0000000000001000 || ''UNKNOWN''
|-
| 0b0000000000010000 || UseImmidiateMtx (needs research)
|-
| 0b0000000000100000 || UsePostTexMtx (needs research)
|-
| 0b0000000001000000 || ''UNKNOWN''
|-
| 0b0000000010000000 || ''UNKNOWN''
|-
| 0b0000000100000000 || NoMatrixTransform (needs research)
|-
| 0b0000001000000000 || ''UNKNOWN''
|-
| 0b0000010000000000 || ''UNKNOWN''
|-
| 0b0000100000000000 || ''UNKNOWN''
|-
| 0b0001000000000000 || ''UNKNOWN''
|-
| 0b0010000000000000 || DoBdlMaterialCalc
|-
| 0b0100000000000000 || NoBdlMaterialPatch - If set, skips the call to '''J3DModelLoader::readPatchedMaterial'''.
|-
| 0b1000000000000000 || ''UNKNOWN''
|}
For all BMD files, the game always includes load flags ''Material_PE_Full'', ''Material_UseIndirect'', ''UseUniqueMaterials'', and ''UNKNOWN_21''. 
For all BDL files, the game always includes load flags ''Material_UseIndirect'', and ''UseUniqueMaterials''.

> ''Note: Changing the load flags by changing the code doesn't seem to do much.''

=== Scene Hierarchy ===
Each model is constructed using a Scene Hierarchy. This simply determines the order of bones (in turn, defining the parent/child relations), material assignments, and Shape assignments.

Each node consists of the following:
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || UInt16 || Node Type. 0x00 = Marks the end of the node list 0x01 = Creates a new child of the previous node 0x02 = Finishes the child node and returns ownership to the previous node 0x10 = Joint Assignment node. "Data" holds the Joint ID (index into JNT1) 0x11 = Material assignment. "Data" holds the Material ID (index into MAT3) 0x12 = Shape Assignment. "Data" holds the Shape ID (index into SHP1)
|-
| 0x02 || UInt16 || A Data value. Used by some nodes to index into other chunks. Usage depends on the node type.
|}

The node list is padded to the nearest 32.

== VTX1 - Vertex Data ==
The '''V'''er'''t'''e'''x''' Data section contains the actual number values used for the properties of the geometry. It also includes the information on how the values are formatted.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''VTX1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int32 || Buffer Format list offset
|-
| 0x0C || Int32 || "POSITION" data buffer offset 0 if not used.
|-
| 0x10 || Int32 || "NORMAL" data buffer offset 0 if not used.
|-
| 0x14 || Int32 || "TANGENT" data buffer offset 0 if not used.
|-
| 0x18 || Int32 || "COLOR_0" data buffer offset 0 if not used.
|-
| 0x1C || Int32 || "COLOR_1" data buffer offset 0 if not used.
|-
| 0x20 || Int32 || "TEXCOORD_0" data buffer offset 0 if not used.
|-
| 0x24 || Int32 || "TEXCOORD_1" data buffer offset 0 if not used.
|-
| 0x28 || Int32 || "TEXCOORD_2" data buffer offset 0 if not used.
|-
| 0x2C || Int32 || "TEXCOORD_3" data buffer offset 0 if not used.
|-
| 0x30 || Int32 || "TEXCOORD_4" data buffer offset 0 if not used.
|-
| 0x34 || Int32 || "TEXCOORD_5" data buffer offset 0 if not used.
|-
| 0x38 || Int32 || "TEXCOORD_6" data buffer offset 0 if not used.
|-
| 0x3C || Int32 || "TEXCOORD_7" data buffer offset 0 if not used.
|}

=== Vertex Buffer Formats ===
Each of the Buffers in this section have a format descriptor. This allows different types of data storage, allowing for smaller files.

Each format descriptor contains an Attribute Target, a Component Count, a Data Type, and a Mantissa shifter (to allow floats to be stored as smaller datatypes compared to FLOAT). Only one descriptor can exist for each attribute.

The Attribute Target tells the game what this buffer is used for.
{| class="wikitable"
|+ Attribute Targets
|-
! Value !! Name !! Description
|-
| 0x00000009 || POSITION || This buffer represents the positions of vertices in the model. Basically required for all visual models.
|-
| 0x0000000A || NORMAL || This buffer represents vertex normals, used for the engine's vertex shading. Not needed if no material requires it.
|-
| 0x0000000B || COLOR_0 || This buffer is available for Vertex Colors.
|-
| 0x0000000C || COLOR_1 || This buffer is available for Vertex Colors.
|-
| 0x0000000D || TEXCOORD_0 || This buffer is available for Texture Coordinates.
|-
| 0x0000000E || TEXCOORD_1 || This buffer is available for Texture Coordinates.
|-
| 0x0000000F || TEXCOORD_2 || This buffer is available for Texture Coordinates.
|-
| 0x00000010 || TEXCOORD_3 || This buffer is available for Texture Coordinates.
|-
| 0x00000011 || TEXCOORD_4 || This buffer is available for Texture Coordinates.
|-
| 0x00000012 || TEXCOORD_5 || This buffer is available for Texture Coordinates.
|-
| 0x00000013 || TEXCOORD_6 || This buffer is available for Texture Coordinates.
|-
| 0x00000014 || TEXCOORD_7 || This buffer is available for Texture Coordinates.
|-
| 0x00000019 || TANGENT || ''Currently unknown exactly what goes in here.''
|-
| 0x000000FF || List End || A buffer using this target will end the descriptor list.
|}

The component count tells the game how many parts of the component that there are. Note that the values are considered based on the attribute target they're assigned to.
{| class="wikitable"
|+ Component Count
|-
! Value !! Name !! Description
|-
| 0x00000000 || POSITION_XY || ''Unknown''
|-
| 0x00000001 || POSITION_XYZ || Represents a position in 3D space with 3 values: X, Y, and Z.
|-
|colspan="3"|
|-
| 0x00000000 || NORMAL_XYZ || Represents a normal vector in 3D space with 3 values: X, Y, and Z.
|-
| 0x00000001 || NORMAL_NBT || ''Unknown''
|-
| 0x00000002 || NORMAL_NBT3 || ''Unknown''
|-
|colspan="3"|
|-
| 0x00000000 || COLOR_RGB || Represents a color value with only Red, Green, and Blue values.
|-
| 0x00000001 || COLOR_RGBA || Represents a color value with Red, Green, Blue, and Alpha values.
|-
|colspan="3"|
|-
| 0x00000000 || TEXCOORD_S || ''Unknown''
|-
| 0x00000001 || TEXCOORD_ST || Represents a UV texture coordinate with 2 values: X and Y.
|}

The Data Type tells the game how many bytes each value is, in the sense that an Int32 is 4 bytes, a Int16 is 2 bytes, a Float is 4 bytes, etc. Note that the Color values have a different set of options.
{| class="wikitable"
|+ Data Types
|-
! Value !! Name !! Description
|-
| 0x00000000 || UInt8 || 1 byte per value (0 to 255)
|-
| 0x00000001 || Int8 || 1 byte per value (-128 to 127)
|-
| 0x00000002 || UInt16 || 2 bytes per value (0 to 65535)
|-
| 0x00000003 || Int16 || 2 bytes per value (-32,768 to 32,767)
|-
| 0x00000004 || Float || 4 bytes per value
|-
|colspan="3"|
|-
| 0x00000000 || RGB565 || 2 bytes per color
|-
| 0x00000001 || RGB8 || 3 bytes per color
|-
| 0x00000002 || RGBX8 || 3 bytes per color
|-
| 0x00000003 || RGBA4 || 2 bytes per color
|-
| 0x00000004 || RGBA6 || 4 bytes per color
|-
| 0x00000005 || RGBA8 || 4 bytes per color
|}
> ''Note: Both games require colors to be 4 bytes wide at all times, so changing from RGBA8 is worthless.''

== EVP1 - Skinning Envelopes ==
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''EVP1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of Envelopes stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || Envelope Size Table offset
|-
| 0x10 || Int32 || Envelope Joint Index Table offset
|-
| 0x14 || Int32 || Envelope Weight Table offset
|-
| 0x18 || Int32 || Inverse Bind Matrix Table offset
|}
This section is padded to the nearest 32.

=== Envelope Size Table ===
This table simply consists of an array of UInt8, where each value dictates how many entries are in a given Envelope.

=== Envelope Joint Index Table ===
This table consists of the actual [[#JNT1_-_Joint_Hierarchy|JNT1]] index values. Each value is a UInt16, and are ordered directly based on the Envelope Size Table. (The first Envelope's values come directly after each other, then the second envelope's values, etc.)

=== Envelope Weight Table ===
This table consists of joint weighting values which determine how much of an effect the given Joint Index has on this envelope. Each value is a Float, and are ordered directly based on the Envelope Size Table. (The first Envelope's values come directly after each other, then the second envelope's values, etc.)

This table ends with padding to the nearest 4th byte so the Floats that come after are aligned correctly.

=== Inverse Bind Matrix Table ===
This table contains Inverse Bind Matrices for each joint in [[#JNT1_-_Joint_Hierarchy|JNT1]]. The EVP1 section itself contains no size of this table, but the number of Inverse Bind Matrices is always equal to the amount of Joints in the model. Each entry is a 3 Row 4 Column Matrix (Mtx34), and is stored as 3 Vector4 values.

== DRW1 - Skinning Assignments ==
This section contains a map which redirects skinning information to the correct location: either JNT1 (Single Matrix) or EVP1 (Multi-Matrix) The Destination Type list and Destination ID list must be equal in length.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''DRW1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of Entries stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || Destination Type list offset
|-
| 0x10 || Int32 || Destination ID list offset
|}

=== Destination Type List ===
This is an array of bytes that dictates the destination type. It is ordered so that all the '''Joint'''s come first, and all the '''Envelope'''s second.
{| class="wikitable"
|-
! Value !! Name !! Description
|-
| 0x00 || Joint || Redirects to a Joint within [[#JNT1_-_Joint_Hierarchy|JNT1]]
|-
| 0x01 || Envelope || Redirects to an Envelope in [[#EVP1_-_Skinning_Envelopes|EVP1]]
|}
It's worth noting that Nintendo's development tools had a bug in it where all the '''Envelope''' entries were duplicated. Some JSystem games do not care about this, but certain games try to explicitly ignore this data, and therefore require the wasteful duplicate data.

=== Destination ID List ===
This is an array of UInt16 that simply dictate an index into the provided section.

DRW1 ends with padding to the nearest 32.

== JNT1 - Joint Hierarchy ==
The '''J'''oi'''nt''' Hierarchy section defines the rigging skeleton of a model. There can only be one skeleton per model.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''JNT1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of Joints stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || Joint Data table offset
|-
| 0x10 || Int32 || Remap table offset
|-
| 0x14 || Int32 || Name table offset 0 if not present.
|}

=== Joint Data ===
Each joint includes positional data and a bounding box which is used by the game for determining rendering range automatically.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int16 || Matrix Type
|-
| 0x01 || UInt8 || Parent Scale inheritance 0 = Follow parent joint's scale 1 = Ignore parent joint's scale
|-
| 0x02 || UInt8 || Padding (0xFF)
|-
| 0x04 || Float || Scale X
|-
| 0x08 || Float || Scale Y
|-
| 0x0C || Float || Scale Z
|-
| 0x10 || Int16 || Rotation X
|-
| 0x12 || Int16 || Rotation Y
|-
| 0x14 || Int16 || Rotation Z
|-
| 0x16 || Int16 || Padding (0xFFFF)
|-
| 0x18 || Float || Translation X
|-
| 0x1C || Float || Translation Y
|-
| 0x20 || Float || Translation Z
|-
| 0x24 || Float || Bounding Sphere Should encapsulate all vertices that the joint affects
|-
| 0x28 || Float || Bounding Box Minimum X
|-
| 0x2C || Float || Bounding Box Minimum Y
|-
| 0x30 || Float || Bounding Box Minimum Z
|-
| 0x34 || Float || Bounding Box Maximum X
|-
| 0x38 || Float || Bounding Box Maximum Y
|-
| 0x3C || Float || Bounding Box Maximum Z
|}
Rotation is stored between -0x7FFF and 0x7FFF, which ranges -180 degrees and 180 degrees.

== SHP1 - Shape Information==
The '''Sh'''a'''p'''e Information section determines how to use the data in the [[#VTX1_-_Vertex_Data|VTX1]] section to create shapes.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''SHP1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of Shapes stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || Shape Init Data offset
|-
| 0x10 || Int32 || Remap table offset
|-
| 0x14 || Int32 || Name table offset 0 if not present, which it usually isn't.
|-
| 0x18 || Int32 || Vertex Index Attribute table offset
|-
| 0x1C || Int32 || Weight Index table offset
|-
| 0x20 || Int32 || Primitive Data offset
|-
| 0x24 || Int32 || Matrix Group Data offset (entry count must equal the entry count of the GXDisplayList group table)
|-
| 0x28 || Int32 || Matrix Group Definition table offset
|}

=== Shape Data ===
Each shape denotes a Matrix Calculation type, which is used for Billboarding, as well as multi-joint skinning. A shape also hosts a collection of Matrix Groups. If the geometry needs to be weighted to more than 10 [[#DRW1_-_Skinning_Assignments|DRW1]] matrices, more than one Matrix Group is needed. A single Matrix Group can have multiple Primitives in it, but these Primitives must share the same set of [[#DRW1_-_Skinning_Assignments|DRW1]] matrices.

TODO: Figure out what happens in the event that more than 10 are needed (such as one vertex being weighted to 11 bones). Is it just straight up not allowed?

{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || UInt8 || Matrix Type

* 0 = Single Joint

* 1 = Billboard Joint

* 2 = Billboard Joint (Y axis only)

* 3 = Multiple Joints
|-
| 0x01 || UInt8 || Padding (0xFF)
|-
| 0x02 || Int16 || Matrix Group count
|-
| 0x04 || Int16 || Vertex Index Attribute offset Relative to the Vertex Index Attribute Table offset defined in SHP1
|-
| 0x06 || Int16 || Matrix Group Data index
|-
| 0x08 || Int16 || First Matrix Group Definition index
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Float || Bounding Sphere
|-
| 0x10 || Float || Bounding Box Minimum X
|-
| 0x14 || Float || Bounding Box Minimum Y
|-
| 0x18 || Float || Bounding Box Minimum Z
|-
| 0x1C || Float || Bounding Box Maximum X
|-
| 0x20 || Float || Bounding Box Maximum Y
|-
| 0x24 || Float || Bounding Box Maximum Z
|}

=== Vertex Index Attribute Table ===

{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int32 || An [[#Index%20Buffer%20Formats|index buffer]] attribute target
|-
| 0x04 || Int32 || An [[#Index%20Buffer%20Formats|index buffer]] type
|}

==== Index Buffer Formats ====
Each of the Buffers in this section have a format descriptor. This allows different types of data storage, allowing for smaller files.

These attributes line up with either a direct value that is stored in the shape, or an index into a [[#VTX1_-_Vertex_Data|VTX1]] [[#Vertex%20Buffer%20Formats|data buffer]]. Only one indexer can exist for each attribute.

The Attribute Target tells the game what this index buffer is used for.
{| class="wikitable"
|+ Attribute Targets
|-
! Value !! Name !! Description
|-
| 0x00000000 || POSITION_MATRIX || This is a direct list of indices into the Matrix Group's Weight collection. Required for Shapes that use Multiple Joint skinning.
|-
| 0x00000001 || TEXTURE_0_MATRIX || ''Uses the Direct type. Seems to break models that use it, and no official models in either galaxy game use it.''
|-
| 0x00000002 || TEXTURE_1_MATRIX || ''Uses the Direct type. Seems to break models that use it, and no official models in either galaxy game use it.''
|-
| 0x00000003 || TEXTURE_2_MATRIX || ''Uses the Direct type. Seems to break models that use it, and no official models in either galaxy game use it.''
|-
| 0x00000004 || TEXTURE_3_MATRIX || ''Uses the Direct type. Seems to break models that use it, and no official models in either galaxy game use it.''
|-
| 0x00000005 || TEXTURE_4_MATRIX || ''Uses the Direct type. Seems to break models that use it, and no official models in either galaxy game use it.''
|-
| 0x00000006 || TEXTURE_5_MATRIX || ''Uses the Direct type. Seems to break models that use it, and no official models in either galaxy game use it.''
|-
| 0x00000007 || TEXTURE_6_MATRIX || ''Uses the Direct type. Seems to break models that use it, and no official models in either galaxy game use it.''
|-
| 0x00000008 || TEXTURE_7_MATRIX || ''Uses the Direct type. Seems to break models that use it, and no official models in either galaxy game use it.''
|-
| 0x00000009 || POSITION || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "POSITION" buffer. Required.
|-
| 0x0000000A || NORMAL || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "NORMAL" buffer
|-
| 0x0000000B || COLOR_0 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "COLOR_0" buffer
|-
| 0x0000000C || COLOR_1 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "COLOR_1" buffer
|-
| 0x0000000D || TEXCOORD_0 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_0" buffer
|-
| 0x0000000E || TEXCOORD_1 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_1" buffer
|-
| 0x0000000F || TEXCOORD_2 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_2" buffer
|-
| 0x00000010 || TEXCOORD_3 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_3" buffer
|-
| 0x00000011 || TEXCOORD_4 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_4" buffer
|-
| 0x00000012 || TEXCOORD_5 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_5" buffer
|-
| 0x00000013 || TEXCOORD_6 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_6" buffer
|-
| 0x00000014 || TEXCOORD_7 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_7" buffer
|-
| 0x00000019 || TANGENT || ''This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TANGENT" buffer, but we don't yet know what that buffer does.''
|-
| 0x000000FF || List End || A buffer using this target will end the descriptor list.
|}

The Data Type of an Index Buffer determines the size of each Index. Direct Buffers can only be 1 byte per value.
{| class="wikitable"
|+ Data Types
|-
! Value !! Name !! Description
|-
| 0x00000000 || None || Only used for the List End
|-
| 0x00000001 || Direct || 1 byte per value. Only used for data that is not stored within [[#VTX1_-_Vertex_Data|VTX1]] Needs to be divided by 3 for some reason...
|-
| 0x00000002 || UInt8 || 1 byte per value (0 to 255). Indexes a buffer in [[#VTX1_-_Vertex_Data|VTX1]].
|-
| 0x00000003 || UInt16 || 2 bytes per value (0 to 65535). Indexes a buffer in [[#VTX1_-_Vertex_Data|VTX1]].
|}

=== Primitive Data ===
This chunk contains raw primitives. These are what hold the index buffers. The Index Buffers are ordered the same way the Index Buffer Attributes are ordered. For example, POSITION (UInt16), NORMAL (UInt16), COLOR_0 (UInt8), TEXCOORD_0 (UInt16), would result in the following byte structure: '''PPPP NNNN C0 TXC0''' This repeats for each vertex in the primitive.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Uint8 || Primitive Type

* 0x80 = Individual Quads

* 0x90 = Individual Triangles

* 0x98 = Triangle Strip

* 0xA0 = Triangle Fan

* 0xA8 = Individual Lines

* 0xB0 = Line Strip

* 0xB8 = Individual Points

TODO: Figure out if Quads, Lines, Line Strips, and Points work. TODO: Figure out if "Quad Strips" exist at 0x88.
|-
| 0x04 || Int16 || Vertex Count
|}
Each Matrix Group's primitive collection MUST be padded to the nearest 32. The game dies if you don't.

=== Matrix Group Definition Table ===
This table defines a list of Matrix Groups for each Shape. A Shape can have multiple Matrix Groups, but only stores the index of the first one. This means that all the Matrix Groups for a given Shape must come directly one after another. It contains only two values: The size of all Primitive Data within this group, and an offset to the first Primitive (relative to the Primitive Data offset defined in SHP1).
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int32 || Primitive Data size
|-
| 0x04 || Int32 || First Primitive offset
|}

=== Matrix Group Data Table ===
This table contains definitions of sub-segments inside the Weight Index Table. How these values are used differs based on the shape matrix calculation type, but official files generally set both usages up correctly regardless.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int16 || [[#DRW1_-_Skinning_Assignments|DRW1]] Matrix ID This is only used with Single Joint shape matrix calculation.
|-
| 0x02 || Int16 || Matrix Count This is only used with Multiple Joint shape matrix calculation.
|-
| 0x04 || Int32 || Starting Weight Index This is only used with Multiple Joint shape matrix calculation.
|}

=== Weight Index Table ===
This table contains several indices into [[#DRW1_-_Skinning_Assignments|DRW1]]. Each index is a Signed 16 value. The values may also contain 0xFFFF, which indicates that the last used index should be used instead. Matrix Groups can select a segment of these indices (up to 10) for use. A Matrix Group must not start with 0xFFFF.

== MAT2 - Material List (Old) ==
Technically supported by the game, but not known to be used by any model.

== MAT3 - Material List ==
Contains information for '''Mat'''erials to fill the rendered geometry with.

== MDL3 - Display List ==
Contains raw material GX opcodes to speed up rendering.

== TEX1 - Texture Data ==
The '''Tex'''ture Information section holds several embedded [[BTI_(File_Format)|BTI]] files that [[#MAT3_-_Material_List|MAT3]] can reference by index for texture assignment.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''TEX1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of [[BTI_(File_Format)|BTI]] files stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || [[BTI_(File_Format)|BTI]] Header Table Offset
|-
| 0x10 || Int32 || Name table offset
|}

The texture data locations are defined by the [[BTI_(File_Format)|BTI]] headers (which themselves are located directly one after another at the Header Table) 
This structure allows multiple textures that have the same visual data to have their headers point to just one block of visual data. In other words, two identical textures can be "compressed" into one while still having their own properties (wrapping, filtering, etc.)

Cutscenes

2026-04-30T18:05:46Z

Super Hackio: tools

[[Category:Files]]
[[Category:Lists]]
{{WIP}}
'''Todo:'''
*Finish the hardcoded cutscene names.
*More info and research on the use of canm and supported objects.

Cutscenes are flexible, complex scenes, which can execute more freedom in contrast to the SimpleDemoExecutor.
These scenes consist of individual sequences that are played in order. In each sequence, several actions can be executed from certain frames, such as changing the player's position, camera movements, sound effects, and more. To each sequence (and subsequence) different actions are linked, which are then executed at the time of this sequence.

You can best visualize this in a kind of timeline. The timeline consists of the individual sequences, which consist of several actions. At the same time single subscequences can be executed together with the actual sequences.

==Structure==
[[File:Cutscene_Visual-Representation.png|thumb|A visual representation of the first Yoshi Meets cutscene.]]
A cutscene is activated by a demo object via SW_APPEAR within the map and loads several sheet BCSV files located in the demo.arc archive of the respective galaxy/zone. The demo object loads the bcsv files using its defined sheet name and additional "Demo" in front of the file name of the BSCV attached and a respective sheet type at the end of the file name (e.g. '''Demo'''AfterGameOver'''Time''').

In addition, the demo object has its own cutscene name, which is only used in certain cases (e.g. to load certain sequences for [[Starship Mario]]) and also for camera codes. Certain names can be recognized by the game and then loads additional hardcoded settings such as behavior after scene completion. A list of these names [[Cutscenes#Hardcoded_Cutscene_Names|can be found below]].

Objects other than the player object itself can be linked to the cutscene. These then use a cutscene group ID, which on the one hand must match the demo object ID and on the other hand must be entered in the action sheet together with the object's name. If the object is entered in the [[ObjNameTable]], the name from the Japanese column must be entered instead.

If there are several identical objects that are part of a cutscene, you can also define a cast group id for one specific object to distinguish it from the other identical objects for the scene.

===Time===
Defines the individual sequences with their names and length. They are played in the order they are in the list.
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| PartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the sequence
|-
| TotalStep
| style="font-size:12px;" | LONG
| Duration of the sequence in frames
|-
| SuspendFlag
| style="font-size:12px;" | LONG
| If set to 1, pauses the cutscene and resumes gameplay. The cutscene will continue from here next time it is activated.
|-
| WaitUserInputFlag
| style="font-size:12px;" | LONG
|
|}

===SubPart===
Runs additional subsequences in parallel during a sequence.
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| SubPartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the sub sequence
|-
| SubPartTotalStep
| style="font-size:12px;" | LONG
| The length of the sub sequence
|-
| MainPartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the main sequence this sub sequence belongs to
|-
| MainPartStep
| style="font-size:12px;" | LONG
| The frame of the main sequence this sub sequence starts at
|}

===Action===
Picks up objects and can position them to a given GeneralPos and play an animation.

All animation types are supported. For more control you can use [[ActorInfo#ActorInfo|ActorAnimCtrl.bcsv]] for your objects to define multiple animation names of different animation types to the animation name defined in the cutscene.
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| PartName
| style="font-size:12px;" | STRING_OFFSET
| Sequence Name
|-
| CastName
| style="font-size:12px;" | STRING_OFFSET
| Name of the target object. Either Japanese name defined in [[ObjNameTable]], or ''ModelName'' defined in [[ProductMapObjDataTable]].
|-
| CastID
| style="font-size:12px;" | LONG
| Optional Cast ID of the target object. -1 = Deactivated. 
To target a specific object among identical objects that are part of the cutscene.
|-
| ActionType
| style="font-size:12px;" | LONG
| Pick an Action Type from the table below.
|-
| PosName
| style="font-size:12px;" | STRING_OFFSET
| Name of the GeneralPos object for destination location
|-
| AnimName
| style="font-size:12px;" | STRING_OFFSET
| Name of the animation, which can be loaded either from the ARC archive object or from a separate ARC archive with the additional name "Anim".
|}
====Action Types====
Note that these action types are not available for any object that registers as a "Simple Demo Cast".

===== SMG1 =====
{| class="wikitable"
! ID !! Name !! Description
|-
| 0 || Apppear || Makes the object Appear.
|-
| 1 || Kill || Makes the object Disappear (using it's Kill function).
|-
| 2 || Special Function || Executes a function that the object specifically registered to the cutscene. This is object specific, and not every object has one.
|-
| 3 || Special Nerve || Sets the objects Nerve to a nerve specifically registered to the cutscene. This is object specific, and not every object has one.
|-
| 4 || On SW_A || The SW_A of this object will be activated.
|-
| 5 || On SW_B || The SW_B of this object will be activated.
|-
| 6 || Show Model || The model of the object will be unhidden.
|-
| 7 || Hide Model || The model of the object will be hidden.
|-
| 8 || Start NPC Message || Start a conversation with an NPC. Effectively useless because NPC's do not register their text to cutscenes unless the cutscene has a specific name.
|-
| 9 || Start NPC Message (Alt) || Start a conversation with an NPC without stopping Mario's current animation. Effectively useless because NPC's do not register their text to cutscenes unless the cutscene has a specific name.
|-
| 10 || Duplicate of 9 || Duplicate of 9.
|-
| 11 || Play Animation || Plays the animation that "AnimName" is set to. This happens for all Action Types.
|-
| 12 || Off SW_A || The SW_A of this object will be deactivated.
|-
| 13 || Off SW_B || The SW_B of this object will be deactivated.
|}
===== SMG2 =====
{| class="wikitable"
! ID !! Name !! Description
|-
| 0 || Play Animation || Plays the animation that "AnimName" is set to. This happens for all Action Types.
|-
| 1 || Apppear || Makes the object Appear.
|-
| 2 || Kill || Makes the object Disappear (using it's Kill function).
|-
| 3 || Special Function || Executes a function that the object specifically registered to the cutscene. This is object specific, and not every object has one.
|-
| 4 || Special Nerve || Sets the objects Nerve to a nerve specifically registered to the cutscene. This is object specific, and not every object has one.
|-
| 5 || On SW_A || The SW_A of this object will be activated.
|-
| 6 || On SW_B || The SW_B of this object will be activated.
|-
| 7 || Show Model || The model of the object will be unhidden.
|-
| 8 || Hide Model || The model of the object will be hidden.
|-
| 9 || Start NPC Message || Start a conversation with an NPC. Effectively useless because NPC's do not register their text to cutscenes unless the cutscene has a specific name.
|-
| 10 || Start NPC Message (Alt) || Start a conversation with an NPC without stopping Mario's current animation. Effectively useless because NPC's do not register their text to cutscenes unless the cutscene has a specific name.
|-
| 11 || Duplicate of 10 || Duplicate of 10.
|-
| 12 || Off SW_A || The SW_A of this object will be deactivated.
|-
| 13 || Off SW_B || The SW_B of this object will be deactivated.
|-
| 14 || Request Movement Off || Tries to pause execution of this object.
|-
| 15 || Request Movement On || Tries to resume execution of this object.
|-
| 16 || StoryBookWarpDemo || Unknown. Related to StoryBookWarpDemo. Uses 1 as arg.
|-
| 17 || StoryBookWarpDemo || Unknown. Related to StoryBookWarpDemo. Uses 0 as arg.
|-
| 18 || StoryBookWarpDemo || Unknown. Related to StoryBookWarpDemo.
|-
| 19 || StoryBookWarpDemo || Unknown. Related to StoryBookWarpDemo.
|-
| 20 || ? || Unknown. Used at the end of the cutscene where Mario meets Yoshi for the first time.
|}

===Player===
Can position Mario/Luigi to a specific GeneralPos and play an animation.
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| PartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the sequence
|-
| PosName
| style="font-size:12px;" | STRING_OFFSET
| Name of the GeneralPos to teleport the player to
|-
| BckName
| style="font-size:12px;" | STRING_OFFSET
| Name of the animation from /ObjectData/MarioAnime.arc to play. (All other animationtypes than BCK are also supported)
|-
| Visible
| style="font-size:12px;" | LONG
|
|}

===Camera===
Can play cameras, which can be played one after another. Can use either a camera code from the Map archive's [[Cameras|CameraParam.bcam]] file, or a key frame camera animation which are controlled via [[CANM]] files, which must be located in the object archive of the targeted object.
By default the camera is fixed on Mario/Luigi.

For BCAM usage, the Camera ID name to be used is composed of the ''PartName'' and the ''Cutscenename'' (not the sheet name): '''e:Cutscenename[PartName]'''.

For CANM usage, the name defined in ''AnimCameraName'' must match the CANM file's name and needs to be placed in the root of the targeted object's archive.
Seems to be supported only by certain objects. This has not yet been fully explored.

{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| PartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the sequence
|-
| CameraTargetName
| style="font-size:12px;" | STRING_OFFSET
| Japanese Name of the object the camera is focused to. (Primarily uses ObjNameTable names)
|-
| CameraTargetCastID
| style="font-size:12px;" | LONG
| Cast ID of the object
|-
| AnimCameraName
| style="font-size:12px;" | STRING_OFFSET
| CANM file name (".canm" extension optional) which must be placed in the root of the targeted object's archive.
|-
| AnimCameraStartFrame
| style="font-size:12px;" | LONG
| The part frame to begin the camera on. -1 will have the camera interpolate to the start of the CANM
|-
| AnimCameraEndFrame
| style="font-size:12px;" | LONG
|
|-
| IsContinuous
| style="font-size:12px;" | LONG
|
|}

===Sound===
Can change music and play sound effects.
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| PartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the sequence
|-
| Bgm
| style="font-size:12px;" | STRING_OFFSET
| [[List_of_Music|Name of the music]] to play.
|-
| SystemSe
| style="font-size:12px;" | STRING_OFFSET
| [[List_of_Sounds_(SMG2)|Name of the soundeffect]] to play.
|-
| ActionSe
| style="font-size:12px;" | STRING_OFFSET
|
|-
| ReturnBgm
| style="font-size:12px;" | LONG
|
|-
| BgmWipeoutFrame
| style="font-size:12px;" | LONG
| Duration in frames for fading out the music. -1 = No fade-out
|-
| AllSoundStopFrame
| style="font-size:12px;" | LONG
|
|}

===Wipe===
Can perform a fade out animation.
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| PartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the sequence
|-
| WipeName
| style="font-size:12px;" | STRING_OFFSET
| The wipe to use. See the [[#WipeName|WipeName]] table below.
|-
| WipeType
| style="font-size:12px;" | LONG
| The function for the Wipe to perform. See the [[#WipeType|WipeType]] table below.
|-
| WipeFrame
| style="font-size:12px;" | LONG
| The amount of frames that the wipe will move for. Higher values = Slower movement
|}

====WipeName====
Below is a list of available WipeName values:
{| class="wikitable"
|-
! Value !! Description
|-
| 円ワイプ || Circle Wipe
|-
| フェードワイプ || Black Fade
|-
| 白フェードワイプ || White Fade
|-
| ゲームオーバー || Game Over
|-
| クッパ || Bowser Face (Death wipe)
|}

''Note: The Mario wipe is missing because the Mario wipe is a System Wipe and not a Scene Wipe. DemoWipes can only be Scene Wipes.''

====WipeType====
Below is the list of Wipe functions. The table below uses the Black Fade as an example.
{| class="wikitable"
|-
! Value !! Description
|-
| 0 || Open Wipe (Fade to Gameplay)
|-
| 1 || Close Wipe (Fade to Black)
|-
| 2 || Force Open Wipe (Cut to Gameplay)
|-
| 3 || Force Close Wipe (Cut to Black)
|}

''Tip: If you need to change wipes while the wipe is closed, use Force Close before using Open for a smoother transition.''

===Hardcoded Cutscene Names===
'''Todo:''' Finish this.
{| class="wikitable"
|-
! Cutscene Name
! Meaning
! Notes
|-
| ベビチコ出会い
| Master Luma Meeting
| -Uses hardcoded cameras -Activates spin after completion when the galaxy uses the StageType "Storybook"
|}

==Tools==
The tools can be found on the [https://www.lumasworkshop.com/tools/ tools and libraries page].

RARC (File Format)

2025-12-26T18:44:51Z

Super Hackio: Fix documentation for File Nodes

[[Category:File formats]]
'''RARC''' stands for '''R'''esource '''ARC'''hive. These files make up a majority of the files that you see on the game's disc, under the extension ''.arc''. '''RARC''' files are archives, containing multiple files and folders inside. This format was also used on the Nintendo GameCube.

The ''Resource'' in the file name here breaks the common convention they used in naming most similar formats intending it to signify ''Revolution'' instead, the codename for the Nintendo Wii. Proof of this is known and can be seen in the various references in the game files to the Official tool Nintendo used for creating and managing this file format, ''Resarc''.

= Format Specifications =
Below you'll find helpful tables on how the file is structured
== Header ==
Each RARC starts with a ''header''
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || String || "RARC" in ASCII
|-
| 0x04 || UInt32 || Size of the entire file
|-
| 0x08 || UInt32 || Data Header Offset (Always 0x20)
|-
| 0x0C || UInt32 || Offset to the File Data section minus 0x20
|-
| 0x10 || UInt32 || Length of the File Data section
|-
| 0x14 || UInt32 || Size of all the MRAM Files in the File Data section
|-
| 0x18 || UInt32 || Size of all the ARAM Files in the File Data section
|-
| 0x1C || UInt32 || Size of all the DVD Files in the File Data section
|-
|}
== Data Header ==
This section has information on the entire archive
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || UInt32 || The number of Directory Nodes
|-
| 0x04 || UInt32 || Offset to the Directory Nodes section minus 0x20 (always 0x20)
|-
| 0x08 || UInt32 || The number of File Nodes
|-
| 0x0C || UInt32 || Offset to the File Nodes section minus 0x20
|-
| 0x10 || UInt32 || Size of the String Table
|-
| 0x14 || UInt32 || String Table offset minus 0x20
|-
| 0x18 || UInt16 || The next available File Index
|-
| 0x1A || bool || Keeps the File ID's Synced (Always 0x01, or TRUE in SMG)
|-
| 0x1B || UInt8[5] || Padding, All 0x00's
|-
|}
== Directory Node section ==
This section is a list of information for each folder (or, subdirectory) in the archive. 
Each list entry looks like this:
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || String || The first 4 characters in the Directory's name in all caps. Example: "RootFolder" = "ROOT", and "Tmp" = "TMP " (Names less than 4 characters are padded to 4 characters with spaces)
|-
| 0x04 || UInt32 || Offset to the Directory's name in the String Table
|-
| 0x08 || UInt16 || Hash of the Directory's name
|-
| 0x0A || UInt16 || The number of File Nodes in this directory
|-
| 0x0C || UInt32 || Offset to the first File Node in the File Nodes section
|-
|}
== File Node section ==
This section is a list of information for each file in the archive. It also contains entries for directories so we can know which directory belongs where. 
Each list entry looks like this:
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || UInt16 || Node Index (0xFFFF if this entry represents a subdirectory)
|-
| 0x02 || UInt16 || Hash of the Node's name
|-
| 0x04 || Uint32 || This is a uint8 (0xFF000000) and uint24 (0x00FFFFFF). The uint8 defines certain Node Attributes. See the Node Attributes table below. The uint24 defines the offset to the Node's name in the String Table.
|-
| 0x08 || UInt32 || If this node represents a file: Offset to the File's Data in the File Data section. If this node represents a directory: Directory Node section index to use
|-
| 0x0C || UInt32 || If this node represents a file: Size of the File's Data. If this node represents a directory: The size of the Directory Node (always 0x10)
|-
|}
=== Node Attributes ===
{| class="wikitable"
! Mask !! Name !! Description
|-
| 0x01 || FILE || This node is a File
|-
| 0x02 || DIRECTORY || This node is a Directory
|-
| 0x04 || COMPRESSED || This node's file is compressed
|-
| 0x10 || PRELOAD_TO_MRAM || Set the file to be loaded into Main RAM
|-
| 0x20 || PRELOAD_TO_ARAM || Set the file to be loaded into Auxiliary RAM (GameCube only)
|-
| 0x40 || LOAD_FROM_DVD || Set the file to be loaded right off the DVD when needed
|-
| 0x80 || YAZ0_COMPRESSED || This node's file is specifically YAZ0 compressed. Enable the COMPRESSED flag as well when using this
|-
|}

Among the File Nodes are nodes for a ".." and "." directory. The "." entry points to the current directory, and the ".." directory points to the parent directory (or 0xFFFFFFFF if the current directory is the topmost directory).

== String Table ==
This section is composed of NULL-terminated ASCII strings. The above information references these strings.

== File Data section ==
This section is a chunk of all the data that files in the archive contain. Files are sorted in a specific order, and are padded to the nearest 32 byte boundary. The sorting order is MRAM Files then ARAM Files then DVD Files.

BMD/BDL (File Format)

2025-10-26T23:47:02Z

Super Hackio: Prelimary MAT3 & MDL3 docs

[[Category:File formats]]
{{WIP}}

BMD ('''B'''inary '''M'''o'''d'''el) and BDL ('''B'''inary '''D'''isplay '''L'''ist) are two 3D model formats used in ''Super Mario Galaxy'' and ''Super Mario Galaxy 2'', among a few other ''Wii'' and ''GameCube'' games, such as ''Super Mario Sunshine''.

These two formats hold the same data, except BDL contains an additional set of data which is used for faster rendering speeds.

''Super Mario Galaxy'' & ''Super Mario Galaxy 2'' contain J3DLoader versions 21 and 26.

== File Header ==
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || The magic that tells the game which format this file is. (ASCII) '''J3D2bmd2''' for BMD (J3DLoader V21) '''J3D2bmd3''' for BMD (J3DLoader v26) '''J3D2bdl4''' for BDL (J3DLoader v26)
|-
| 0x08 || Int32 || The total size of the file
|-
| 0x0C || Int32 || The number of chunks present in this file. '''8''' for BMD '''9''' for BDL
|}

=== Subversion Header ===
This part of the header is not used, and can be anything.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || A 4 character value representing the Subversion. Usually SVR3 for SMG/2.
|-
| 0x04 || Byte[12] || Twelve bytes of padding. Usually these are '''0xFF'''
|}

== INF1 - Scene Information ==
The '''Inf'''ormation section hosts a hierarchy of Joints, Materials, and Shapes, which are used to render the model.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''INF1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || [[#J3DLoader%20Flags|J3DLoader Flags]]
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || Matrix Group Data Count Referring to the Matrix Group Data in [[#SHP1_-_Shape_Information|SHP1]] Stored in a variable by the game, but not used to dictate the actual number of Matrix Groups.
|-
| 0x10 || Int32 || Vertex Count Always equals the number of entries in the [[#VTX1_-_Vertex_Data|VTX1]] "POSITION" [[#Vertex%20Buffer%20Formats|data buffer]] Stored in a variable by the game, but never used for anything. The game reads Vertex Data directly from the [[#Vertex%20Buffer%20Formats|data buffer]]s without bounds checking.
|-
| 0x14 || Int32 || Relative offset to the [[#Scene%20Hierarchy|Scene Hierarchy]]
|}

=== J3DLoader Flags ===
The J3DLoader contains several flags which affect how models are handled. There are more than what are shown here, however, those must be applied by the game itself in the code.
{| class="wikitable"
|-
! Value !! Description
|-
| 0b0000000000000000 || No flags applied (TODO: Check if this defaults to basic matrix calculation)
|-
| 0b0000000000000001 || Use Autodesk Softimage matrix calculation
|-
| 0b0000000000000010 || Use Autodesk Maya matrix calculation
|-
| 0b0000000000000100 || Use Basic matrix calculation
|-
| 0b0000000000001000 || ''UNKNOWN''
|-
| 0b0000000000010000 || UseImmidiateMtx (needs research)
|-
| 0b0000000000100000 || UsePostTexMtx (needs research)
|-
| 0b0000000001000000 || ''UNKNOWN''
|-
| 0b0000000010000000 || ''UNKNOWN''
|-
| 0b0000000100000000 || NoMatrixTransform (needs research)
|-
| 0b0000001000000000 || ''UNKNOWN''
|-
| 0b0000010000000000 || ''UNKNOWN''
|-
| 0b0000100000000000 || ''UNKNOWN''
|-
| 0b0001000000000000 || ''UNKNOWN''
|-
| 0b0010000000000000 || DoBdlMaterialCalc
|-
| 0b0100000000000000 || NoBdlMaterialPatch - If set, skips the call to '''J3DModelLoader::readPatchedMaterial'''.
|-
| 0b1000000000000000 || ''UNKNOWN''
|}
For all BMD files, the game always includes load flags ''Material_PE_Full'', ''Material_UseIndirect'', ''UseUniqueMaterials'', and ''UNKNOWN_21''. 
For all BDL files, the game always includes load flags ''Material_UseIndirect'', and ''UseUniqueMaterials''.

> ''Note: Changing the load flags by changing the code doesn't seem to do much.''

=== Scene Hierarchy ===
Each model is constructed using a Scene Hierarchy. This simply determines the order of bones (in turn, defining the parent/child relations), material assignments, and Shape assignments.

Each node consists of the following:
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || UInt16 || Node Type. 0x00 = Marks the end of the node list 0x01 = Creates a new child of the previous node 0x02 = Finishes the child node and returns ownership to the previous node 0x10 = Joint Assignment node. "Data" holds the Joint ID (index into JNT1) 0x11 = Material assignment. "Data" holds the Material ID (index into MAT3) 0x12 = Shape Assignment. "Data" holds the Shape ID (index into SHP1)
|-
| 0x02 || UInt16 || A Data value. Used by some nodes to index into other chunks. Usage depends on the node type.
|}

The node list is padded to the nearest 32.

== VTX1 - Vertex Data ==
The '''V'''er'''t'''e'''x''' Data section contains the actual number values used for the properties of the geometry. It also includes the information on how the values are formatted.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''VTX1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int32 || Buffer Format list offset
|-
| 0x0C || Int32 || "POSITION" data buffer offset 0 if not used.
|-
| 0x10 || Int32 || "NORMAL" data buffer offset 0 if not used.
|-
| 0x14 || Int32 || "TANGENT" data buffer offset 0 if not used.
|-
| 0x18 || Int32 || "COLOR_0" data buffer offset 0 if not used.
|-
| 0x1C || Int32 || "COLOR_1" data buffer offset 0 if not used.
|-
| 0x20 || Int32 || "TEXCOORD_0" data buffer offset 0 if not used.
|-
| 0x24 || Int32 || "TEXCOORD_1" data buffer offset 0 if not used.
|-
| 0x28 || Int32 || "TEXCOORD_2" data buffer offset 0 if not used.
|-
| 0x2C || Int32 || "TEXCOORD_3" data buffer offset 0 if not used.
|-
| 0x30 || Int32 || "TEXCOORD_4" data buffer offset 0 if not used.
|-
| 0x34 || Int32 || "TEXCOORD_5" data buffer offset 0 if not used.
|-
| 0x38 || Int32 || "TEXCOORD_6" data buffer offset 0 if not used.
|-
| 0x3C || Int32 || "TEXCOORD_7" data buffer offset 0 if not used.
|}

=== Vertex Buffer Formats ===
Each of the Buffers in this section have a format descriptor. This allows different types of data storage, allowing for smaller files.

Each format descriptor contains an Attribute Target, a Component Count, a Data Type, and a Mantissa shifter (to allow floats to be stored as smaller datatypes compared to FLOAT). Only one descriptor can exist for each attribute.

The Attribute Target tells the game what this buffer is used for.
{| class="wikitable"
|+ Attribute Targets
|-
! Value !! Name !! Description
|-
| 0x00000009 || POSITION || This buffer represents the positions of vertices in the model. Basically required for all visual models.
|-
| 0x0000000A || NORMAL || This buffer represents vertex normals, used for the engine's vertex shading. Not needed if no material requires it.
|-
| 0x0000000B || COLOR_0 || This buffer is available for Vertex Colors.
|-
| 0x0000000C || COLOR_1 || This buffer is available for Vertex Colors.
|-
| 0x0000000D || TEXCOORD_0 || This buffer is available for Texture Coordinates.
|-
| 0x0000000E || TEXCOORD_1 || This buffer is available for Texture Coordinates.
|-
| 0x0000000F || TEXCOORD_2 || This buffer is available for Texture Coordinates.
|-
| 0x00000010 || TEXCOORD_3 || This buffer is available for Texture Coordinates.
|-
| 0x00000011 || TEXCOORD_4 || This buffer is available for Texture Coordinates.
|-
| 0x00000012 || TEXCOORD_5 || This buffer is available for Texture Coordinates.
|-
| 0x00000013 || TEXCOORD_6 || This buffer is available for Texture Coordinates.
|-
| 0x00000014 || TEXCOORD_7 || This buffer is available for Texture Coordinates.
|-
| 0x00000019 || TANGENT || ''Currently unknown exactly what goes in here.''
|-
| 0x000000FF || List End || A buffer using this target will end the descriptor list.
|}

The component count tells the game how many parts of the component that there are. Note that the values are considered based on the attribute target they're assigned to.
{| class="wikitable"
|+ Component Count
|-
! Value !! Name !! Description
|-
| 0x00000000 || POSITION_XY || ''Unknown''
|-
| 0x00000001 || POSITION_XYZ || Represents a position in 3D space with 3 values: X, Y, and Z.
|-
|colspan="3"|
|-
| 0x00000000 || NORMAL_XYZ || Represents a normal vector in 3D space with 3 values: X, Y, and Z.
|-
| 0x00000001 || NORMAL_NBT || ''Unknown''
|-
| 0x00000002 || NORMAL_NBT3 || ''Unknown''
|-
|colspan="3"|
|-
| 0x00000000 || COLOR_RGB || Represents a color value with only Red, Green, and Blue values.
|-
| 0x00000001 || COLOR_RGBA || Represents a color value with Red, Green, Blue, and Alpha values.
|-
|colspan="3"|
|-
| 0x00000000 || TEXCOORD_S || ''Unknown''
|-
| 0x00000001 || TEXCOORD_ST || Represents a UV texture coordinate with 2 values: X and Y.
|}

The Data Type tells the game how many bytes each value is, in the sense that an Int32 is 4 bytes, a Int16 is 2 bytes, a Float is 4 bytes, etc. Note that the Color values have a different set of options.
{| class="wikitable"
|+ Data Types
|-
! Value !! Name !! Description
|-
| 0x00000000 || UInt8 || 1 byte per value (0 to 255)
|-
| 0x00000001 || Int8 || 1 byte per value (-128 to 127)
|-
| 0x00000002 || UInt16 || 2 bytes per value (0 to 65535)
|-
| 0x00000003 || Int16 || 2 bytes per value (-32,768 to 32,767)
|-
| 0x00000004 || Float || 4 bytes per value
|-
|colspan="3"|
|-
| 0x00000000 || RGB565 || 2 bytes per color
|-
| 0x00000001 || RGB8 || 3 bytes per color
|-
| 0x00000002 || RGBX8 || 3 bytes per color
|-
| 0x00000003 || RGBA4 || 2 bytes per color
|-
| 0x00000004 || RGBA6 || 4 bytes per color
|-
| 0x00000005 || RGBA8 || 4 bytes per color
|}
> ''Note: Both games require colors to be 4 bytes wide at all times, so changing from RGBA8 is worthless.''

== EVP1 - Skinning Envelopes ==
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''EVP1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of Envelopes stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || Envelope Size Table offset
|-
| 0x10 || Int32 || Envelope Joint Index Table offset
|-
| 0x14 || Int32 || Envelope Weight Table offset
|-
| 0x18 || Int32 || Inverse Bind Matrix Table offset
|}
This section is padded to the nearest 32.

=== Envelope Size Table ===
This table simply consists of an array of UInt8, where each value dictates how many entries are in a given Envelope.

=== Envelope Joint Index Table ===
This table consists of the actual [[#JNT1_-_Joint_Hierarchy|JNT1]] index values. Each value is a UInt16, and are ordered directly based on the Envelope Size Table. (The first Envelope's values come directly after each other, then the second envelope's values, etc.)

=== Envelope Weight Table ===
This table consists of joint weighting values which determine how much of an effect the given Joint Index has on this envelope. Each value is a Float, and are ordered directly based on the Envelope Size Table. (The first Envelope's values come directly after each other, then the second envelope's values, etc.)

This table ends with padding to the nearest 4th byte so the Floats that come after are aligned correctly.

=== Inverse Bind Matrix Table ===
This table contains Inverse Bind Matrices for each joint in [[#JNT1_-_Joint_Hierarchy|JNT1]]. The EVP1 section itself contains no size of this table, but the number of Inverse Bind Matrices is always equal to the amount of Joints in the model. Each entry is a 3 Row 4 Column Matrix (Mtx34), and is stored as 3 Vector4 values.

== DRW1 - Skinning Assignments ==
This section contains a map which redirects skinning information to the correct location: either JNT1 (Single Matrix) or EVP1 (Multi-Matrix) The Destination Type list and Destination ID list must be equal in length.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''DRW1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of Entries stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || Destination Type list offset
|-
| 0x10 || Int32 || Destination ID list offset
|}

=== Destination Type List ===
This is an array of bytes that dictates the destination type. It is ordered so that all the '''Joint'''s come first, and all the '''Envelope'''s second.
{| class="wikitable"
|-
! Value !! Name !! Description
|-
| 0x00 || Joint || Redirects to a Joint within [[#JNT1_-_Joint_Hierarchy|JNT1]]
|-
| 0x01 || Envelope || Redirects to an Envelope in [[#EVP1_-_Skinning_Envelopes|EVP1]]
|}
It's worth noting that Nintendo's development tools had a bug in it where all the '''Envelope''' entries were duplicated. Some JSystem games do not care about this, but certain games try to explicitly ignore this data, and therefore require the wasteful duplicate data.

=== Destination ID List ===
This is an array of UInt16 that simply dictate an index into the provided section.

DRW1 ends with padding to the nearest 32.

== JNT1 - Joint Hierarchy ==
The '''J'''oi'''nt''' Hierarchy section defines the rigging skeleton of a model. There can only be one skeleton per model.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''JNT1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of Joints stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || Joint Data table offset
|-
| 0x10 || Int32 || Remap table offset
|-
| 0x14 || Int32 || Name table offset 0 if not present.
|}

=== Joint Data ===
Each joint includes positional data and a bounding box which is used by the game for determining rendering range automatically.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int16 || Matrix Type
|-
| 0x01 || UInt8 || Parent Scale inheritance 0 = Follow parent joint's scale 1 = Ignore parent joint's scale
|-
| 0x02 || UInt8 || Padding (0xFF)
|-
| 0x04 || Float || Scale X
|-
| 0x08 || Float || Scale Y
|-
| 0x0C || Float || Scale Z
|-
| 0x10 || Int16 || Rotation X
|-
| 0x12 || Int16 || Rotation Y
|-
| 0x14 || Int16 || Rotation Z
|-
| 0x16 || Int16 || Padding (0xFFFF)
|-
| 0x18 || Float || Translation X
|-
| 0x1C || Float || Translation Y
|-
| 0x20 || Float || Translation Z
|-
| 0x24 || Float || Bounding Sphere Should encapsulate all vertices that the joint affects
|-
| 0x28 || Float || Bounding Box Minimum X
|-
| 0x2C || Float || Bounding Box Minimum Y
|-
| 0x30 || Float || Bounding Box Minimum Z
|-
| 0x34 || Float || Bounding Box Maximum X
|-
| 0x38 || Float || Bounding Box Maximum Y
|-
| 0x3C || Float || Bounding Box Maximum Z
|}
Rotation is stored between -0x7FFF and 0x7FFF, which ranges -180 degrees and 180 degrees.

== SHP1 - Shape Information==
The '''Sh'''a'''p'''e Information section determines how to use the data in the [[#VTX1_-_Vertex_Data|VTX1]] section to create shapes.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''SHP1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of Shapes stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || Shape Init Data offset
|-
| 0x10 || Int32 || Remap table offset
|-
| 0x14 || Int32 || Name table offset 0 if not present, which it usually isn't.
|-
| 0x18 || Int32 || Vertex Index Attribute table offset
|-
| 0x1C || Int32 || Weight Index table offset
|-
| 0x20 || Int32 || Primitive Data offset
|-
| 0x24 || Int32 || Matrix Group Data offset (entry count must equal the entry count of the GXDisplayList group table)
|-
| 0x28 || Int32 || Matrix Group Definition table offset
|}

=== Shape Data ===
Each shape denotes a Matrix Calculation type, which is used for Billboarding, as well as multi-joint skinning. A shape also hosts a collection of Matrix Groups. If the geometry needs to be weighted to more than 10 [[#DRW1_-_Skinning_Assignments|DRW1]] matrices, more than one Matrix Group is needed. A single Matrix Group can have multiple Primitives in it, but these Primitives must share the same set of [[#DRW1_-_Skinning_Assignments|DRW1]] matrices.

TODO: Figure out what happens in the event that more than 10 are needed (such as one vertex being weighted to 11 bones). Is it just straight up not allowed?

{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || UInt8 || Matrix Type

* 0 = Single Joint

* 1 = Billboard Joint

* 2 = Billboard Joint (Y axis only)

* 3 = Multiple Joints
|-
| 0x01 || UInt8 || Padding (0xFF)
|-
| 0x02 || Int16 || Matrix Group count
|-
| 0x04 || Int16 || Vertex Index Attribute offset Relative to the Vertex Index Attribute Table offset defined in SHP1
|-
| 0x06 || Int16 || Matrix Group Data index
|-
| 0x08 || Int16 || First Matrix Group Definition index
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Float || Bounding Sphere
|-
| 0x10 || Float || Bounding Box Minimum X
|-
| 0x14 || Float || Bounding Box Minimum Y
|-
| 0x18 || Float || Bounding Box Minimum Z
|-
| 0x1C || Float || Bounding Box Maximum X
|-
| 0x20 || Float || Bounding Box Maximum Y
|-
| 0x24 || Float || Bounding Box Maximum Z
|}

=== Vertex Index Attribute Table ===

{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int32 || An [[#Index%20Buffer%20Formats|index buffer]] attribute target
|-
| 0x04 || Int32 || An [[#Index%20Buffer%20Formats|index buffer]] type
|}

==== Index Buffer Formats ====
Each of the Buffers in this section have a format descriptor. This allows different types of data storage, allowing for smaller files.

These attributes line up with either a direct value that is stored in the shape, or an index into a [[#VTX1_-_Vertex_Data|VTX1]] [[#Vertex%20Buffer%20Formats|data buffer]]. Only one indexer can exist for each attribute.

The Attribute Target tells the game what this index buffer is used for.
{| class="wikitable"
|+ Attribute Targets
|-
! Value !! Name !! Description
|-
| 0x00000000 || POSITION_MATRIX || This is a direct list of indices into the Matrix Group's Weight collection. Required for Shapes that use Multiple Joint skinning.
|-
| 0x00000001 || TEXTURE_0_MATRIX || ''UNKNOWN''
|-
| 0x00000002 || TEXTURE_1_MATRIX || ''UNKNOWN''
|-
| 0x00000003 || TEXTURE_2_MATRIX || ''UNKNOWN''
|-
| 0x00000004 || TEXTURE_3_MATRIX || ''UNKNOWN''
|-
| 0x00000005 || TEXTURE_4_MATRIX || ''UNKNOWN''
|-
| 0x00000006 || TEXTURE_5_MATRIX || ''UNKNOWN''
|-
| 0x00000007 || TEXTURE_6_MATRIX || ''UNKNOWN''
|-
| 0x00000008 || TEXTURE_7_MATRIX || ''UNKNOWN''
|-
| 0x00000009 || POSITION || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "POSITION" buffer. Required.
|-
| 0x0000000A || NORMAL || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "NORMAL" buffer
|-
| 0x0000000B || COLOR_0 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "COLOR_0" buffer
|-
| 0x0000000C || COLOR_1 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "COLOR_1" buffer
|-
| 0x0000000D || TEXCOORD_0 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_0" buffer
|-
| 0x0000000E || TEXCOORD_1 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_1" buffer
|-
| 0x0000000F || TEXCOORD_2 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_2" buffer
|-
| 0x00000010 || TEXCOORD_3 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_3" buffer
|-
| 0x00000011 || TEXCOORD_4 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_4" buffer
|-
| 0x00000012 || TEXCOORD_5 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_5" buffer
|-
| 0x00000013 || TEXCOORD_6 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_6" buffer
|-
| 0x00000014 || TEXCOORD_7 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_7" buffer
|-
| 0x00000019 || TANGENT || ''This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TANGENT" buffer, but we don't yet know what that buffer does.''
|-
| 0x000000FF || List End || A buffer using this target will end the descriptor list.
|}

The Data Type of an Index Buffer determines the size of each Index. Direct Buffers can only be 1 byte per value.
{| class="wikitable"
|+ Data Types
|-
! Value !! Name !! Description
|-
| 0x00000000 || None || Only used for the List End
|-
| 0x00000001 || Direct || 1 byte per value. Only used for data that is not stored within [[#VTX1_-_Vertex_Data|VTX1]] Needs to be divided by 3 for some reason...
|-
| 0x00000002 || UInt8 || 1 byte per value (0 to 255). Indexes a buffer in [[#VTX1_-_Vertex_Data|VTX1]].
|-
| 0x00000003 || UInt16 || 2 bytes per value (0 to 65535). Indexes a buffer in [[#VTX1_-_Vertex_Data|VTX1]].
|}

=== Primitive Data ===
This chunk contains raw primitives. These are what hold the index buffers. The Index Buffers are ordered the same way the Index Buffer Attributes are ordered. For example, POSITION (UInt16), NORMAL (UInt16), COLOR_0 (UInt8), TEXCOORD_0 (UInt16), would result in the following byte structure: '''PPPP NNNN C0 TXC0''' This repeats for each vertex in the primitive.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Uint8 || Primitive Type

* 0x80 = Individual Quads

* 0x90 = Individual Triangles

* 0x98 = Triangle Strip

* 0xA0 = Triangle Fan

* 0xA8 = Individual Lines

* 0xB0 = Line Strip

* 0xB8 = Individual Points

TODO: Figure out if Quads, Lines, Line Strips, and Points work. TODO: Figure out if "Quad Strips" exist at 0x88.
|-
| 0x04 || Int16 || Vertex Count
|}
Each Matrix Group's primitive collection MUST be padded to the nearest 32. The game dies if you don't.

=== Matrix Group Definition Table ===
This table defines a list of Matrix Groups for each Shape. A Shape can have multiple Matrix Groups, but only stores the index of the first one. This means that all the Matrix Groups for a given Shape must come directly one after another. It contains only two values: The size of all Primitive Data within this group, and an offset to the first Primitive (relative to the Primitive Data offset defined in SHP1).
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int32 || Primitive Data size
|-
| 0x04 || Int32 || First Primitive offset
|}

=== Matrix Group Data Table ===
This table contains definitions of sub-segments inside the Weight Index Table. How these values are used differs based on the shape matrix calculation type, but official files generally set both usages up correctly regardless.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int16 || [[#DRW1_-_Skinning_Assignments|DRW1]] Matrix ID This is only used with Single Joint shape matrix calculation.
|-
| 0x02 || Int16 || Matrix Count This is only used with Multiple Joint shape matrix calculation.
|-
| 0x04 || Int32 || Starting Weight Index This is only used with Multiple Joint shape matrix calculation.
|}

=== Weight Index Table ===
This table contains several indices into [[#DRW1_-_Skinning_Assignments|DRW1]]. Each index is a Signed 16 value. The values may also contain 0xFFFF, which indicates that the last used index should be used instead. Matrix Groups can select a segment of these indices (up to 10) for use. A Matrix Group must not start with 0xFFFF.

== MAT2 - Material List (Old) ==
Technically supported by the game, but not known to be used by any model.

== MAT3 - Material List ==
Contains information for '''Mat'''erials to fill the rendered geometry with.

== MDL3 - Display List ==
Contains raw material GX opcodes to speed up rendering.

== TEX1 - Texture Data ==
The '''Tex'''ture Information section holds several embedded [[BTI_(File_Format)|BTI]] files that [[#MAT3_-_Material_List|MAT3]] can reference by index for texture assignment.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''TEX1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of [[BTI_(File_Format)|BTI]] files stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || [[BTI_(File_Format)|BTI]] Header Table Offset
|-
| 0x10 || Int32 || Name table offset
|}

The texture data locations are defined by the [[BTI_(File_Format)|BTI]] headers (which themselves are located directly one after another at the Header Table) 
This structure allows multiple textures that have the same visual data to have their headers point to just one block of visual data. In other words, two identical textures can be "compressed" into one while still having their own properties (wrapping, filtering, etc.)

BMD/BDL (File Format)

2025-10-26T21:29:59Z

Super Hackio: EVP1

[[Category:File formats]]
{{WIP}}

BMD ('''B'''inary '''M'''o'''d'''el) and BDL ('''B'''inary '''D'''isplay '''L'''ist) are two 3D model formats used in ''Super Mario Galaxy'' and ''Super Mario Galaxy 2'', among a few other ''Wii'' and ''GameCube'' games, such as ''Super Mario Sunshine''.

These two formats hold the same data, except BDL contains an additional set of data which is used for faster rendering speeds.

''Super Mario Galaxy'' & ''Super Mario Galaxy 2'' contain J3DLoader versions 21 and 26.

== File Header ==
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || The magic that tells the game which format this file is. (ASCII) '''J3D2bmd2''' for BMD (J3DLoader V21) '''J3D2bmd3''' for BMD (J3DLoader v26) '''J3D2bdl4''' for BDL (J3DLoader v26)
|-
| 0x08 || Int32 || The total size of the file
|-
| 0x0C || Int32 || The number of chunks present in this file. '''8''' for BMD '''9''' for BDL
|}

=== Subversion Header ===
This part of the header is not used, and can be anything.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || A 4 character value representing the Subversion. Usually SVR3 for SMG/2.
|-
| 0x04 || Byte[12] || Twelve bytes of padding. Usually these are '''0xFF'''
|}

== INF1 - Scene Information ==
The '''Inf'''ormation section hosts a hierarchy of Joints, Materials, and Shapes, which are used to render the model.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''INF1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || [[#J3DLoader%20Flags|J3DLoader Flags]]
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || Matrix Group Data Count Referring to the Matrix Group Data in [[#SHP1_-_Shape_Information|SHP1]] Stored in a variable by the game, but not used to dictate the actual number of Matrix Groups.
|-
| 0x10 || Int32 || Vertex Count Always equals the number of entries in the [[#VTX1_-_Vertex_Data|VTX1]] "POSITION" [[#Vertex%20Buffer%20Formats|data buffer]] Stored in a variable by the game, but never used for anything. The game reads Vertex Data directly from the [[#Vertex%20Buffer%20Formats|data buffer]]s without bounds checking.
|-
| 0x14 || Int32 || Relative offset to the [[#Scene%20Hierarchy|Scene Hierarchy]]
|}

=== J3DLoader Flags ===
The J3DLoader contains several flags which affect how models are handled. There are more than what are shown here, however, those must be applied by the game itself in the code.
{| class="wikitable"
|-
! Value !! Description
|-
| 0b0000000000000000 || No flags applied (TODO: Check if this defaults to basic matrix calculation)
|-
| 0b0000000000000001 || Use Autodesk Softimage matrix calculation
|-
| 0b0000000000000010 || Use Autodesk Maya matrix calculation
|-
| 0b0000000000000100 || Use Basic matrix calculation
|-
| 0b0000000000001000 || ''UNKNOWN''
|-
| 0b0000000000010000 || UseImmidiateMtx (needs research)
|-
| 0b0000000000100000 || UsePostTexMtx (needs research)
|-
| 0b0000000001000000 || ''UNKNOWN''
|-
| 0b0000000010000000 || ''UNKNOWN''
|-
| 0b0000000100000000 || NoMatrixTransform (needs research)
|-
| 0b0000001000000000 || ''UNKNOWN''
|-
| 0b0000010000000000 || ''UNKNOWN''
|-
| 0b0000100000000000 || ''UNKNOWN''
|-
| 0b0001000000000000 || ''UNKNOWN''
|-
| 0b0010000000000000 || DoBdlMaterialCalc
|-
| 0b0100000000000000 || NoBdlMaterialPatch - If set, skips the call to '''J3DModelLoader::readPatchedMaterial'''.
|-
| 0b1000000000000000 || ''UNKNOWN''
|}
For all BMD files, the game always includes load flags ''Material_PE_Full'', ''Material_UseIndirect'', ''UseUniqueMaterials'', and ''UNKNOWN_21''. 
For all BDL files, the game always includes load flags ''Material_UseIndirect'', and ''UseUniqueMaterials''.

> ''Note: Changing the load flags by changing the code doesn't seem to do much.''

=== Scene Hierarchy ===
Each model is constructed using a Scene Hierarchy. This simply determines the order of bones (in turn, defining the parent/child relations), material assignments, and Shape assignments.

Each node consists of the following:
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || UInt16 || Node Type. 0x00 = Marks the end of the node list 0x01 = Creates a new child of the previous node 0x02 = Finishes the child node and returns ownership to the previous node 0x10 = Joint Assignment node. "Data" holds the Joint ID (index into JNT1) 0x11 = Material assignment. "Data" holds the Material ID (index into MAT3) 0x12 = Shape Assignment. "Data" holds the Shape ID (index into SHP1)
|-
| 0x02 || UInt16 || A Data value. Used by some nodes to index into other chunks. Usage depends on the node type.
|}

The node list is padded to the nearest 32.

== VTX1 - Vertex Data ==
The '''V'''er'''t'''e'''x''' Data section contains the actual number values used for the properties of the geometry. It also includes the information on how the values are formatted.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''VTX1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int32 || Buffer Format list offset
|-
| 0x0C || Int32 || "POSITION" data buffer offset 0 if not used.
|-
| 0x10 || Int32 || "NORMAL" data buffer offset 0 if not used.
|-
| 0x14 || Int32 || "TANGENT" data buffer offset 0 if not used.
|-
| 0x18 || Int32 || "COLOR_0" data buffer offset 0 if not used.
|-
| 0x1C || Int32 || "COLOR_1" data buffer offset 0 if not used.
|-
| 0x20 || Int32 || "TEXCOORD_0" data buffer offset 0 if not used.
|-
| 0x24 || Int32 || "TEXCOORD_1" data buffer offset 0 if not used.
|-
| 0x28 || Int32 || "TEXCOORD_2" data buffer offset 0 if not used.
|-
| 0x2C || Int32 || "TEXCOORD_3" data buffer offset 0 if not used.
|-
| 0x30 || Int32 || "TEXCOORD_4" data buffer offset 0 if not used.
|-
| 0x34 || Int32 || "TEXCOORD_5" data buffer offset 0 if not used.
|-
| 0x38 || Int32 || "TEXCOORD_6" data buffer offset 0 if not used.
|-
| 0x3C || Int32 || "TEXCOORD_7" data buffer offset 0 if not used.
|}

=== Vertex Buffer Formats ===
Each of the Buffers in this section have a format descriptor. This allows different types of data storage, allowing for smaller files.

Each format descriptor contains an Attribute Target, a Component Count, a Data Type, and a Mantissa shifter (to allow floats to be stored as smaller datatypes compared to FLOAT). Only one descriptor can exist for each attribute.

The Attribute Target tells the game what this buffer is used for.
{| class="wikitable"
|+ Attribute Targets
|-
! Value !! Name !! Description
|-
| 0x00000009 || POSITION || This buffer represents the positions of vertices in the model. Basically required for all visual models.
|-
| 0x0000000A || NORMAL || This buffer represents vertex normals, used for the engine's vertex shading. Not needed if no material requires it.
|-
| 0x0000000B || COLOR_0 || This buffer is available for Vertex Colors.
|-
| 0x0000000C || COLOR_1 || This buffer is available for Vertex Colors.
|-
| 0x0000000D || TEXCOORD_0 || This buffer is available for Texture Coordinates.
|-
| 0x0000000E || TEXCOORD_1 || This buffer is available for Texture Coordinates.
|-
| 0x0000000F || TEXCOORD_2 || This buffer is available for Texture Coordinates.
|-
| 0x00000010 || TEXCOORD_3 || This buffer is available for Texture Coordinates.
|-
| 0x00000011 || TEXCOORD_4 || This buffer is available for Texture Coordinates.
|-
| 0x00000012 || TEXCOORD_5 || This buffer is available for Texture Coordinates.
|-
| 0x00000013 || TEXCOORD_6 || This buffer is available for Texture Coordinates.
|-
| 0x00000014 || TEXCOORD_7 || This buffer is available for Texture Coordinates.
|-
| 0x00000019 || TANGENT || ''Currently unknown exactly what goes in here.''
|-
| 0x000000FF || List End || A buffer using this target will end the descriptor list.
|}

The component count tells the game how many parts of the component that there are. Note that the values are considered based on the attribute target they're assigned to.
{| class="wikitable"
|+ Component Count
|-
! Value !! Name !! Description
|-
| 0x00000000 || POSITION_XY || ''Unknown''
|-
| 0x00000001 || POSITION_XYZ || Represents a position in 3D space with 3 values: X, Y, and Z.
|-
|colspan="3"|
|-
| 0x00000000 || NORMAL_XYZ || Represents a normal vector in 3D space with 3 values: X, Y, and Z.
|-
| 0x00000001 || NORMAL_NBT || ''Unknown''
|-
| 0x00000002 || NORMAL_NBT3 || ''Unknown''
|-
|colspan="3"|
|-
| 0x00000000 || COLOR_RGB || Represents a color value with only Red, Green, and Blue values.
|-
| 0x00000001 || COLOR_RGBA || Represents a color value with Red, Green, Blue, and Alpha values.
|-
|colspan="3"|
|-
| 0x00000000 || TEXCOORD_S || ''Unknown''
|-
| 0x00000001 || TEXCOORD_ST || Represents a UV texture coordinate with 2 values: X and Y.
|}

The Data Type tells the game how many bytes each value is, in the sense that an Int32 is 4 bytes, a Int16 is 2 bytes, a Float is 4 bytes, etc. Note that the Color values have a different set of options.
{| class="wikitable"
|+ Data Types
|-
! Value !! Name !! Description
|-
| 0x00000000 || UInt8 || 1 byte per value (0 to 255)
|-
| 0x00000001 || Int8 || 1 byte per value (-128 to 127)
|-
| 0x00000002 || UInt16 || 2 bytes per value (0 to 65535)
|-
| 0x00000003 || Int16 || 2 bytes per value (-32,768 to 32,767)
|-
| 0x00000004 || Float || 4 bytes per value
|-
|colspan="3"|
|-
| 0x00000000 || RGB565 || 2 bytes per color
|-
| 0x00000001 || RGB8 || 3 bytes per color
|-
| 0x00000002 || RGBX8 || 3 bytes per color
|-
| 0x00000003 || RGBA4 || 2 bytes per color
|-
| 0x00000004 || RGBA6 || 4 bytes per color
|-
| 0x00000005 || RGBA8 || 4 bytes per color
|}
> ''Note: Both games require colors to be 4 bytes wide at all times, so changing from RGBA8 is worthless.''

== EVP1 - Skinning Envelopes ==
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''EVP1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of Envelopes stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || Envelope Size Table offset
|-
| 0x10 || Int32 || Envelope Joint Index Table offset
|-
| 0x14 || Int32 || Envelope Weight Table offset
|-
| 0x18 || Int32 || Inverse Bind Matrix Table offset
|}
This section is padded to the nearest 32.

=== Envelope Size Table ===
This table simply consists of an array of UInt8, where each value dictates how many entries are in a given Envelope.

=== Envelope Joint Index Table ===
This table consists of the actual [[#JNT1_-_Joint_Hierarchy|JNT1]] index values. Each value is a UInt16, and are ordered directly based on the Envelope Size Table. (The first Envelope's values come directly after each other, then the second envelope's values, etc.)

=== Envelope Weight Table ===
This table consists of joint weighting values which determine how much of an effect the given Joint Index has on this envelope. Each value is a Float, and are ordered directly based on the Envelope Size Table. (The first Envelope's values come directly after each other, then the second envelope's values, etc.)

This table ends with padding to the nearest 4th byte so the Floats that come after are aligned correctly.

=== Inverse Bind Matrix Table ===
This table contains Inverse Bind Matrices for each joint in [[#JNT1_-_Joint_Hierarchy|JNT1]]. The EVP1 section itself contains no size of this table, but the number of Inverse Bind Matrices is always equal to the amount of Joints in the model. Each entry is a 3 Row 4 Column Matrix (Mtx34), and is stored as 3 Vector4 values.

== DRW1 - Skinning Assignments ==
This section contains a map which redirects skinning information to the correct location: either JNT1 (Single Matrix) or EVP1 (Multi-Matrix) The Destination Type list and Destination ID list must be equal in length.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''DRW1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of Entries stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || Destination Type list offset
|-
| 0x10 || Int32 || Destination ID list offset
|}

=== Destination Type List ===
This is an array of bytes that dictates the destination type. It is ordered so that all the '''Joint'''s come first, and all the '''Envelope'''s second.
{| class="wikitable"
|-
! Value !! Name !! Description
|-
| 0x00 || Joint || Redirects to a Joint within [[#JNT1_-_Joint_Hierarchy|JNT1]]
|-
| 0x01 || Envelope || Redirects to an Envelope in [[#EVP1_-_Skinning_Envelopes|EVP1]]
|}
It's worth noting that Nintendo's development tools had a bug in it where all the '''Envelope''' entries were duplicated. Some JSystem games do not care about this, but certain games try to explicitly ignore this data, and therefore require the wasteful duplicate data.

=== Destination ID List ===
This is an array of UInt16 that simply dictate an index into the provided section.

DRW1 ends with padding to the nearest 32.

== JNT1 - Joint Hierarchy ==
The '''J'''oi'''nt''' Hierarchy section defines the rigging skeleton of a model. There can only be one skeleton per model.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''JNT1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of Joints stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || Joint Data table offset
|-
| 0x10 || Int32 || Remap table offset
|-
| 0x14 || Int32 || Name table offset 0 if not present.
|}

=== Joint Data ===
Each joint includes positional data and a bounding box which is used by the game for determining rendering range automatically.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int16 || Matrix Type
|-
| 0x01 || UInt8 || Parent Scale inheritance 0 = Follow parent joint's scale 1 = Ignore parent joint's scale
|-
| 0x02 || UInt8 || Padding (0xFF)
|-
| 0x04 || Float || Scale X
|-
| 0x08 || Float || Scale Y
|-
| 0x0C || Float || Scale Z
|-
| 0x10 || Int16 || Rotation X
|-
| 0x12 || Int16 || Rotation Y
|-
| 0x14 || Int16 || Rotation Z
|-
| 0x16 || Int16 || Padding (0xFFFF)
|-
| 0x18 || Float || Translation X
|-
| 0x1C || Float || Translation Y
|-
| 0x20 || Float || Translation Z
|-
| 0x24 || Float || Bounding Sphere Should encapsulate all vertices that the joint affects
|-
| 0x28 || Float || Bounding Box Minimum X
|-
| 0x2C || Float || Bounding Box Minimum Y
|-
| 0x30 || Float || Bounding Box Minimum Z
|-
| 0x34 || Float || Bounding Box Maximum X
|-
| 0x38 || Float || Bounding Box Maximum Y
|-
| 0x3C || Float || Bounding Box Maximum Z
|}
Rotation is stored between -0x7FFF and 0x7FFF, which ranges -180 degrees and 180 degrees.

== SHP1 - Shape Information==
The '''Sh'''a'''p'''e Information section determines how to use the data in the [[#VTX1_-_Vertex_Data|VTX1]] section to create shapes.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''SHP1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of Shapes stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || Shape Init Data offset
|-
| 0x10 || Int32 || Remap table offset
|-
| 0x14 || Int32 || Name table offset (Generally not used, and thus set to 0)
|-
| 0x18 || Int32 || Vertex Index Attribute table offset
|-
| 0x1C || Int32 || Weight Index table offset
|-
| 0x20 || Int32 || Primitive Data offset
|-
| 0x24 || Int32 || Matrix Group Data offset (entry count must equal the entry count of the GXDisplayList group table)
|-
| 0x28 || Int32 || Matrix Group Definition table offset
|}

=== Shape Data ===
Each shape denotes a Matrix Calculation type, which is used for Billboarding, as well as multi-joint skinning. A shape also hosts a collection of Matrix Groups. If the geometry needs to be weighted to more than 10 [[#DRW1_-_Skinning_Assignments|DRW1]] matrices, more than one Matrix Group is needed. A single Matrix Group can have multiple Primitives in it, but these Primitives must share the same set of [[#DRW1_-_Skinning_Assignments|DRW1]] matrices.

TODO: Figure out what happens in the event that more than 10 are needed (such as one vertex being weighted to 11 bones). Is it just straight up not allowed?

{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || UInt8 || Matrix Type

* 0 = Single Joint

* 1 = Billboard Joint

* 2 = Billboard Joint (Y axis only)

* 3 = Multiple Joints
|-
| 0x01 || UInt8 || Padding (0xFF)
|-
| 0x02 || Int16 || Matrix Group count
|-
| 0x04 || Int16 || Vertex Index Attribute offset Relative to the Vertex Index Attribute Table offset defined in SHP1
|-
| 0x06 || Int16 || Matrix Group Data index
|-
| 0x08 || Int16 || First Matrix Group Definition index
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Float || Bounding Sphere
|-
| 0x10 || Float || Bounding Box Minimum X
|-
| 0x14 || Float || Bounding Box Minimum Y
|-
| 0x18 || Float || Bounding Box Minimum Z
|-
| 0x1C || Float || Bounding Box Maximum X
|-
| 0x20 || Float || Bounding Box Maximum Y
|-
| 0x24 || Float || Bounding Box Maximum Z
|}

=== Vertex Index Attribute Table ===

{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int32 || An [[#Index%20Buffer%20Formats|index buffer]] attribute target
|-
| 0x04 || Int32 || An [[#Index%20Buffer%20Formats|index buffer]] type
|}

==== Index Buffer Formats ====
Each of the Buffers in this section have a format descriptor. This allows different types of data storage, allowing for smaller files.

These attributes line up with either a direct value that is stored in the shape, or an index into a [[#VTX1_-_Vertex_Data|VTX1]] [[#Vertex%20Buffer%20Formats|data buffer]]. Only one indexer can exist for each attribute.

The Attribute Target tells the game what this index buffer is used for.
{| class="wikitable"
|+ Attribute Targets
|-
! Value !! Name !! Description
|-
| 0x00000000 || POSITION_MATRIX || This is a direct list of indices into the Matrix Group's Weight collection. Required for Shapes that use Multiple Joint skinning.
|-
| 0x00000001 || TEXTURE_0_MATRIX || ''UNKNOWN''
|-
| 0x00000002 || TEXTURE_1_MATRIX || ''UNKNOWN''
|-
| 0x00000003 || TEXTURE_2_MATRIX || ''UNKNOWN''
|-
| 0x00000004 || TEXTURE_3_MATRIX || ''UNKNOWN''
|-
| 0x00000005 || TEXTURE_4_MATRIX || ''UNKNOWN''
|-
| 0x00000006 || TEXTURE_5_MATRIX || ''UNKNOWN''
|-
| 0x00000007 || TEXTURE_6_MATRIX || ''UNKNOWN''
|-
| 0x00000008 || TEXTURE_7_MATRIX || ''UNKNOWN''
|-
| 0x00000009 || POSITION || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "POSITION" buffer. Required.
|-
| 0x0000000A || NORMAL || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "NORMAL" buffer
|-
| 0x0000000B || COLOR_0 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "COLOR_0" buffer
|-
| 0x0000000C || COLOR_1 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "COLOR_1" buffer
|-
| 0x0000000D || TEXCOORD_0 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_0" buffer
|-
| 0x0000000E || TEXCOORD_1 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_1" buffer
|-
| 0x0000000F || TEXCOORD_2 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_2" buffer
|-
| 0x00000010 || TEXCOORD_3 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_3" buffer
|-
| 0x00000011 || TEXCOORD_4 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_4" buffer
|-
| 0x00000012 || TEXCOORD_5 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_5" buffer
|-
| 0x00000013 || TEXCOORD_6 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_6" buffer
|-
| 0x00000014 || TEXCOORD_7 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_7" buffer
|-
| 0x00000019 || TANGENT || ''This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TANGENT" buffer, but we don't yet know what that buffer does.''
|-
| 0x000000FF || List End || A buffer using this target will end the descriptor list.
|}

The Data Type of an Index Buffer determines the size of each Index. Direct Buffers can only be 1 byte per value.
{| class="wikitable"
|+ Data Types
|-
! Value !! Name !! Description
|-
| 0x00000000 || None || Only used for the List End
|-
| 0x00000001 || Direct || 1 byte per value. Only used for data that is not stored within [[#VTX1_-_Vertex_Data|VTX1]] Needs to be divided by 3 for some reason...
|-
| 0x00000002 || UInt8 || 1 byte per value (0 to 255). Indexes a buffer in [[#VTX1_-_Vertex_Data|VTX1]].
|-
| 0x00000003 || UInt16 || 2 bytes per value (0 to 65535). Indexes a buffer in [[#VTX1_-_Vertex_Data|VTX1]].
|}

=== Primitive Data ===
This chunk contains raw primitives. These are what hold the index buffers. The Index Buffers are ordered the same way the Index Buffer Attributes are ordered. For example, POSITION (UInt16), NORMAL (UInt16), COLOR_0 (UInt8), TEXCOORD_0 (UInt16), would result in the following byte structure: '''PPPP NNNN C0 TXC0''' This repeats for each vertex in the primitive.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Uint8 || Primitive Type

* 0x80 = Individual Quads

* 0x90 = Individual Triangles

* 0x98 = Triangle Strip

* 0xA0 = Triangle Fan

* 0xA8 = Individual Lines

* 0xB0 = Line Strip

* 0xB8 = Individual Points

TODO: Figure out if Quads, Lines, Line Strips, and Points work. TODO: Figure out if "Quad Strips" exist at 0x88.
|-
| 0x04 || Int16 || Vertex Count
|}
Each Matrix Group's primitive collection MUST be padded to the nearest 32. The game dies if you don't.

=== Matrix Group Definition Table ===
This table defines a list of Matrix Groups for each Shape. A Shape can have multiple Matrix Groups, but only stores the index of the first one. This means that all the Matrix Groups for a given Shape must come directly one after another. It contains only two values: The size of all Primitive Data within this group, and an offset to the first Primitive (relative to the Primitive Data offset defined in SHP1).
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int32 || Primitive Data size
|-
| 0x04 || Int32 || First Primitive offset
|}

=== Matrix Group Data Table ===
This table contains definitions of sub-segments inside the Weight Index Table. How these values are used differs based on the shape matrix calculation type, but official files generally set both usages up correctly regardless.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int16 || [[#DRW1_-_Skinning_Assignments|DRW1]] Matrix ID This is only used with Single Joint shape matrix calculation.
|-
| 0x02 || Int16 || Matrix Count This is only used with Multiple Joint shape matrix calculation.
|-
| 0x04 || Int32 || Starting Weight Index This is only used with Multiple Joint shape matrix calculation.
|}

=== Weight Index Table ===
This table contains several indices into [[#DRW1_-_Skinning_Assignments|DRW1]]. Each index is a Signed 16 value. The values may also contain 0xFFFF, which indicates that the last used index should be used instead. Matrix Groups can select a segment of these indices (up to 10) for use. A Matrix Group must not start with 0xFFFF.

== MAT2 - Material List (Old) ==
Technically supported by the game, but not known to be used by any model.

== MAT3 - Material List ==

== MDL3 - Display List ==

== TEX1 - Texture Data ==
The '''Tex'''ture Information section holds several embedded [[BTI_(File_Format)|BTI]] files that [[#MAT3_-_Material_List|MAT3]] can reference by index for texture assignment.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''TEX1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of [[BTI_(File_Format)|BTI]] files stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || [[BTI_(File_Format)|BTI]] Header Table Offset
|-
| 0x10 || Int32 || Name table offset
|}

The texture data locations are defined by the [[BTI_(File_Format)|BTI]] headers (which themselves are located directly one after another at the Header Table) 
This structure allows multiple textures that have the same visual data to have their headers point to just one block of visual data. In other words, two identical textures can be "compressed" into one while still having their own properties (wrapping, filtering, etc.)

BMD/BDL (File Format)

2025-10-26T01:20:08Z

Super Hackio: Add DRW1

[[Category:File formats]]
{{WIP}}

BMD ('''B'''inary '''M'''o'''d'''el) and BDL ('''B'''inary '''D'''isplay '''L'''ist) are two 3D model formats used in ''Super Mario Galaxy'' and ''Super Mario Galaxy 2'', among a few other ''Wii'' and ''GameCube'' games, such as ''Super Mario Sunshine''.

These two formats hold the same data, except BDL contains an additional set of data which is used for faster rendering speeds.

''Super Mario Galaxy'' & ''Super Mario Galaxy 2'' contain J3DLoader versions 21 and 26.

== File Header ==
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || The magic that tells the game which format this file is. (ASCII) '''J3D2bmd2''' for BMD (J3DLoader V21) '''J3D2bmd3''' for BMD (J3DLoader v26) '''J3D2bdl4''' for BDL (J3DLoader v26)
|-
| 0x08 || Int32 || The total size of the file
|-
| 0x0C || Int32 || The number of chunks present in this file. '''8''' for BMD '''9''' for BDL
|}

=== Subversion Header ===
This part of the header is not used, and can be anything.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || A 4 character value representing the Subversion. Usually SVR3 for SMG/2.
|-
| 0x04 || Byte[12] || Twelve bytes of padding. Usually these are '''0xFF'''
|}

== INF1 - Scene Information ==
The '''Inf'''ormation section hosts a hierarchy of Joints, Materials, and Shapes, which are used to render the model.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''INF1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || [[#J3DLoader%20Flags|J3DLoader Flags]]
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || Matrix Group Data Count Referring to the Matrix Group Data in [[#SHP1_-_Shape_Information|SHP1]] Stored in a variable by the game, but not used to dictate the actual number of Matrix Groups.
|-
| 0x10 || Int32 || Vertex Count Always equals the number of entries in the [[#VTX1_-_Vertex_Data|VTX1]] "POSITION" [[#Vertex%20Buffer%20Formats|data buffer]] Stored in a variable by the game, but never used for anything. The game reads Vertex Data directly from the [[#Vertex%20Buffer%20Formats|data buffer]]s without bounds checking.
|-
| 0x14 || Int32 || Relative offset to the [[#Scene%20Hierarchy|Scene Hierarchy]]
|}

=== J3DLoader Flags ===
The J3DLoader contains several flags which affect how models are handled. There are more than what are shown here, however, those must be applied by the game itself in the code.
{| class="wikitable"
|-
! Value !! Description
|-
| 0b0000000000000000 || No flags applied (TODO: Check if this defaults to basic matrix calculation)
|-
| 0b0000000000000001 || Use Autodesk Softimage matrix calculation
|-
| 0b0000000000000010 || Use Autodesk Maya matrix calculation
|-
| 0b0000000000000100 || Use Basic matrix calculation
|-
| 0b0000000000001000 || ''UNKNOWN''
|-
| 0b0000000000010000 || UseImmidiateMtx (needs research)
|-
| 0b0000000000100000 || UsePostTexMtx (needs research)
|-
| 0b0000000001000000 || ''UNKNOWN''
|-
| 0b0000000010000000 || ''UNKNOWN''
|-
| 0b0000000100000000 || NoMatrixTransform (needs research)
|-
| 0b0000001000000000 || ''UNKNOWN''
|-
| 0b0000010000000000 || ''UNKNOWN''
|-
| 0b0000100000000000 || ''UNKNOWN''
|-
| 0b0001000000000000 || ''UNKNOWN''
|-
| 0b0010000000000000 || DoBdlMaterialCalc
|-
| 0b0100000000000000 || NoBdlMaterialPatch - If set, skips the call to '''J3DModelLoader::readPatchedMaterial'''.
|-
| 0b1000000000000000 || ''UNKNOWN''
|}
For all BMD files, the game always includes load flags ''Material_PE_Full'', ''Material_UseIndirect'', ''UseUniqueMaterials'', and ''UNKNOWN_21''. 
For all BDL files, the game always includes load flags ''Material_UseIndirect'', and ''UseUniqueMaterials''.

> ''Note: Changing the load flags by changing the code doesn't seem to do much.''

=== Scene Hierarchy ===
Each model is constructed using a Scene Hierarchy. This simply determines the order of bones (in turn, defining the parent/child relations), material assignments, and Shape assignments.

Each node consists of the following:
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || UInt16 || Node Type. 0x00 = Marks the end of the node list 0x01 = Creates a new child of the previous node 0x02 = Finishes the child node and returns ownership to the previous node 0x10 = Joint Assignment node. "Data" holds the Joint ID (index into JNT1) 0x11 = Material assignment. "Data" holds the Material ID (index into MAT3) 0x12 = Shape Assignment. "Data" holds the Shape ID (index into SHP1)
|-
| 0x02 || UInt16 || A Data value. Used by some nodes to index into other chunks. Usage depends on the node type.
|}

The node list is padded to the nearest 32.

== VTX1 - Vertex Data ==
The '''V'''er'''t'''e'''x''' Data section contains the actual number values used for the properties of the geometry. It also includes the information on how the values are formatted.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''VTX1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int32 || Buffer Format list offset
|-
| 0x0C || Int32 || "POSITION" data buffer offset 0 if not used.
|-
| 0x10 || Int32 || "NORMAL" data buffer offset 0 if not used.
|-
| 0x14 || Int32 || "TANGENT" data buffer offset 0 if not used.
|-
| 0x18 || Int32 || "COLOR_0" data buffer offset 0 if not used.
|-
| 0x1C || Int32 || "COLOR_1" data buffer offset 0 if not used.
|-
| 0x20 || Int32 || "TEXCOORD_0" data buffer offset 0 if not used.
|-
| 0x24 || Int32 || "TEXCOORD_1" data buffer offset 0 if not used.
|-
| 0x28 || Int32 || "TEXCOORD_2" data buffer offset 0 if not used.
|-
| 0x2C || Int32 || "TEXCOORD_3" data buffer offset 0 if not used.
|-
| 0x30 || Int32 || "TEXCOORD_4" data buffer offset 0 if not used.
|-
| 0x34 || Int32 || "TEXCOORD_5" data buffer offset 0 if not used.
|-
| 0x38 || Int32 || "TEXCOORD_6" data buffer offset 0 if not used.
|-
| 0x3C || Int32 || "TEXCOORD_7" data buffer offset 0 if not used.
|}

=== Vertex Buffer Formats ===
Each of the Buffers in this section have a format descriptor. This allows different types of data storage, allowing for smaller files.

Each format descriptor contains an Attribute Target, a Component Count, a Data Type, and a Mantissa shifter (to allow floats to be stored as smaller datatypes compared to FLOAT). Only one descriptor can exist for each attribute.

The Attribute Target tells the game what this buffer is used for.
{| class="wikitable"
|+ Attribute Targets
|-
! Value !! Name !! Description
|-
| 0x00000009 || POSITION || This buffer represents the positions of vertices in the model. Basically required for all visual models.
|-
| 0x0000000A || NORMAL || This buffer represents vertex normals, used for the engine's vertex shading. Not needed if no material requires it.
|-
| 0x0000000B || COLOR_0 || This buffer is available for Vertex Colors.
|-
| 0x0000000C || COLOR_1 || This buffer is available for Vertex Colors.
|-
| 0x0000000D || TEXCOORD_0 || This buffer is available for Texture Coordinates.
|-
| 0x0000000E || TEXCOORD_1 || This buffer is available for Texture Coordinates.
|-
| 0x0000000F || TEXCOORD_2 || This buffer is available for Texture Coordinates.
|-
| 0x00000010 || TEXCOORD_3 || This buffer is available for Texture Coordinates.
|-
| 0x00000011 || TEXCOORD_4 || This buffer is available for Texture Coordinates.
|-
| 0x00000012 || TEXCOORD_5 || This buffer is available for Texture Coordinates.
|-
| 0x00000013 || TEXCOORD_6 || This buffer is available for Texture Coordinates.
|-
| 0x00000014 || TEXCOORD_7 || This buffer is available for Texture Coordinates.
|-
| 0x00000019 || TANGENT || ''Currently unknown exactly what goes in here.''
|-
| 0x000000FF || List End || A buffer using this target will end the descriptor list.
|}

The component count tells the game how many parts of the component that there are. Note that the values are considered based on the attribute target they're assigned to.
{| class="wikitable"
|+ Component Count
|-
! Value !! Name !! Description
|-
| 0x00000000 || POSITION_XY || ''Unknown''
|-
| 0x00000001 || POSITION_XYZ || Represents a position in 3D space with 3 values: X, Y, and Z.
|-
|colspan="3"|
|-
| 0x00000000 || NORMAL_XYZ || Represents a normal vector in 3D space with 3 values: X, Y, and Z.
|-
| 0x00000001 || NORMAL_NBT || ''Unknown''
|-
| 0x00000002 || NORMAL_NBT3 || ''Unknown''
|-
|colspan="3"|
|-
| 0x00000000 || COLOR_RGB || Represents a color value with only Red, Green, and Blue values.
|-
| 0x00000001 || COLOR_RGBA || Represents a color value with Red, Green, Blue, and Alpha values.
|-
|colspan="3"|
|-
| 0x00000000 || TEXCOORD_S || ''Unknown''
|-
| 0x00000001 || TEXCOORD_ST || Represents a UV texture coordinate with 2 values: X and Y.
|}

The Data Type tells the game how many bytes each value is, in the sense that an Int32 is 4 bytes, a Int16 is 2 bytes, a Float is 4 bytes, etc. Note that the Color values have a different set of options.
{| class="wikitable"
|+ Data Types
|-
! Value !! Name !! Description
|-
| 0x00000000 || UInt8 || 1 byte per value (0 to 255)
|-
| 0x00000001 || Int8 || 1 byte per value (-128 to 127)
|-
| 0x00000002 || UInt16 || 2 bytes per value (0 to 65535)
|-
| 0x00000003 || Int16 || 2 bytes per value (-32,768 to 32,767)
|-
| 0x00000004 || Float || 4 bytes per value
|-
|colspan="3"|
|-
| 0x00000000 || RGB565 || 2 bytes per color
|-
| 0x00000001 || RGB8 || 3 bytes per color
|-
| 0x00000002 || RGBX8 || 3 bytes per color
|-
| 0x00000003 || RGBA4 || 2 bytes per color
|-
| 0x00000004 || RGBA6 || 4 bytes per color
|-
| 0x00000005 || RGBA8 || 4 bytes per color
|}
> ''Note: Both games require colors to be 4 bytes wide at all times, so changing from RGBA8 is worthless.''

== EVP1 - Skinning Envelopes ==
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''EVP1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of Envelopes stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || "Joint Count" list offset
|-
| 0x10 || Int32 || "'Joint Count' list index" list offset
|-
| 0x14 || Int32 || "Joint Weight" list offset
|-
| 0x18 || Int32 || "Inverse Bind Matrices" list offset
|}

== DRW1 - Skinning Assignments ==
This section contains a map which redirects skinning information to the correct location: either JNT1 (Single Matrix) or EVP1 (Multi-Matrix) The Destination Type list and Destination ID list must be equal in length.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''DRW1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of Entries stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || Destination Type list offset
|-
| 0x10 || Int32 || Destination ID list offset
|}

=== Destination Type List ===
This is an array of bytes that dictates the destination type. It is ordered so that all the '''Joint'''s come first, and all the '''Envelope'''s second.
{| class="wikitable"
|-
! Value !! Name !! Description
|-
| 0x00 || Joint || Redirects to a Joint within [[#JNT1_-_Joint_Hierarchy|JNT1]]
|-
| 0x01 || Envelope || Redirects to an Envelope in [[#EVP1_-_Skinning_Envelopes|EVP1]]
|}
It's worth noting that Nintendo's development tools had a bug in it where all the '''Envelope''' entries were duplicated. Some JSystem games do not care about this, but certain games try to explicitly ignore this data, and therefore require the wasteful duplicate data.

=== Destination ID List ===
This is an array of UInt16 that simply dictate an index into the provided section.

DRW1 ends with padding to the nearest 32.

== JNT1 - Joint Hierarchy ==
The '''J'''oi'''nt''' Hierarchy section defines the rigging skeleton of a model. There can only be one skeleton per model.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''JNT1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of Joints stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || Joint Data table offset
|-
| 0x10 || Int32 || Remap table offset
|-
| 0x14 || Int32 || Name table offset 0 if not present.
|}

=== Joint Data ===
Each joint includes positional data and a bounding box which is used by the game for determining rendering range automatically.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int16 || Matrix Type
|-
| 0x01 || UInt8 || Parent Scale inheritance 0 = Follow parent joint's scale 1 = Ignore parent joint's scale
|-
| 0x02 || UInt8 || Padding (0xFF)
|-
| 0x04 || Float || Scale X
|-
| 0x08 || Float || Scale Y
|-
| 0x0C || Float || Scale Z
|-
| 0x10 || Int16 || Rotation X
|-
| 0x12 || Int16 || Rotation Y
|-
| 0x14 || Int16 || Rotation Z
|-
| 0x16 || Int16 || Padding (0xFFFF)
|-
| 0x18 || Float || Translation X
|-
| 0x1C || Float || Translation Y
|-
| 0x20 || Float || Translation Z
|-
| 0x24 || Float || Bounding Sphere Should encapsulate all vertices that the joint affects
|-
| 0x28 || Float || Bounding Box Minimum X
|-
| 0x2C || Float || Bounding Box Minimum Y
|-
| 0x30 || Float || Bounding Box Minimum Z
|-
| 0x34 || Float || Bounding Box Maximum X
|-
| 0x38 || Float || Bounding Box Maximum Y
|-
| 0x3C || Float || Bounding Box Maximum Z
|}
Rotation is stored between -0x7FFF and 0x7FFF, which ranges -180 degrees and 180 degrees.

== SHP1 - Shape Information==
The '''Sh'''a'''p'''e Information section determines how to use the data in the [[#VTX1_-_Vertex_Data|VTX1]] section to create shapes.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''SHP1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of Shapes stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || Shape Init Data offset
|-
| 0x10 || Int32 || Remap table offset
|-
| 0x14 || Int32 || Name table offset (Generally not used, and thus set to 0)
|-
| 0x18 || Int32 || Vertex Index Attribute table offset
|-
| 0x1C || Int32 || Weight Index table offset
|-
| 0x20 || Int32 || Primitive Data offset
|-
| 0x24 || Int32 || Matrix Group Data offset (entry count must equal the entry count of the GXDisplayList group table)
|-
| 0x28 || Int32 || Matrix Group Definition table offset
|}

=== Shape Data ===
Each shape denotes a Matrix Calculation type, which is used for Billboarding, as well as multi-joint skinning. A shape also hosts a collection of Matrix Groups. If the geometry needs to be weighted to more than 10 [[#DRW1_-_Skinning_Assignments|DRW1]] matrices, more than one Matrix Group is needed. A single Matrix Group can have multiple Primitives in it, but these Primitives must share the same set of [[#DRW1_-_Skinning_Assignments|DRW1]] matrices.

TODO: Figure out what happens in the event that more than 10 are needed (such as one vertex being weighted to 11 bones). Is it just straight up not allowed?

{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || UInt8 || Matrix Type

* 0 = Single Joint

* 1 = Billboard Joint

* 2 = Billboard Joint (Y axis only)

* 3 = Multiple Joints
|-
| 0x01 || UInt8 || Padding (0xFF)
|-
| 0x02 || Int16 || Matrix Group count
|-
| 0x04 || Int16 || Vertex Index Attribute offset Relative to the Vertex Index Attribute Table offset defined in SHP1
|-
| 0x06 || Int16 || Matrix Group Data index
|-
| 0x08 || Int16 || First Matrix Group Definition index
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Float || Bounding Sphere
|-
| 0x10 || Float || Bounding Box Minimum X
|-
| 0x14 || Float || Bounding Box Minimum Y
|-
| 0x18 || Float || Bounding Box Minimum Z
|-
| 0x1C || Float || Bounding Box Maximum X
|-
| 0x20 || Float || Bounding Box Maximum Y
|-
| 0x24 || Float || Bounding Box Maximum Z
|}

=== Vertex Index Attribute Table ===

{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int32 || An [[#Index%20Buffer%20Formats|index buffer]] attribute target
|-
| 0x04 || Int32 || An [[#Index%20Buffer%20Formats|index buffer]] type
|}

==== Index Buffer Formats ====
Each of the Buffers in this section have a format descriptor. This allows different types of data storage, allowing for smaller files.

These attributes line up with either a direct value that is stored in the shape, or an index into a [[#VTX1_-_Vertex_Data|VTX1]] [[#Vertex%20Buffer%20Formats|data buffer]]. Only one indexer can exist for each attribute.

The Attribute Target tells the game what this index buffer is used for.
{| class="wikitable"
|+ Attribute Targets
|-
! Value !! Name !! Description
|-
| 0x00000000 || POSITION_MATRIX || This is a direct list of indices into the Matrix Group's Weight collection. Required for Shapes that use Multiple Joint skinning.
|-
| 0x00000001 || TEXTURE_0_MATRIX || ''UNKNOWN''
|-
| 0x00000002 || TEXTURE_1_MATRIX || ''UNKNOWN''
|-
| 0x00000003 || TEXTURE_2_MATRIX || ''UNKNOWN''
|-
| 0x00000004 || TEXTURE_3_MATRIX || ''UNKNOWN''
|-
| 0x00000005 || TEXTURE_4_MATRIX || ''UNKNOWN''
|-
| 0x00000006 || TEXTURE_5_MATRIX || ''UNKNOWN''
|-
| 0x00000007 || TEXTURE_6_MATRIX || ''UNKNOWN''
|-
| 0x00000008 || TEXTURE_7_MATRIX || ''UNKNOWN''
|-
| 0x00000009 || POSITION || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "POSITION" buffer. Required.
|-
| 0x0000000A || NORMAL || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "NORMAL" buffer
|-
| 0x0000000B || COLOR_0 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "COLOR_0" buffer
|-
| 0x0000000C || COLOR_1 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "COLOR_1" buffer
|-
| 0x0000000D || TEXCOORD_0 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_0" buffer
|-
| 0x0000000E || TEXCOORD_1 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_1" buffer
|-
| 0x0000000F || TEXCOORD_2 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_2" buffer
|-
| 0x00000010 || TEXCOORD_3 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_3" buffer
|-
| 0x00000011 || TEXCOORD_4 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_4" buffer
|-
| 0x00000012 || TEXCOORD_5 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_5" buffer
|-
| 0x00000013 || TEXCOORD_6 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_6" buffer
|-
| 0x00000014 || TEXCOORD_7 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_7" buffer
|-
| 0x00000019 || TANGENT || ''This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TANGENT" buffer, but we don't yet know what that buffer does.''
|-
| 0x000000FF || List End || A buffer using this target will end the descriptor list.
|}

The Data Type of an Index Buffer determines the size of each Index. Direct Buffers can only be 1 byte per value.
{| class="wikitable"
|+ Data Types
|-
! Value !! Name !! Description
|-
| 0x00000000 || None || Only used for the List End
|-
| 0x00000001 || Direct || 1 byte per value. Only used for data that is not stored within [[#VTX1_-_Vertex_Data|VTX1]] Needs to be divided by 3 for some reason...
|-
| 0x00000002 || UInt8 || 1 byte per value (0 to 255). Indexes a buffer in [[#VTX1_-_Vertex_Data|VTX1]].
|-
| 0x00000003 || UInt16 || 2 bytes per value (0 to 65535). Indexes a buffer in [[#VTX1_-_Vertex_Data|VTX1]].
|}

=== Primitive Data ===
This chunk contains raw primitives. These are what hold the index buffers. The Index Buffers are ordered the same way the Index Buffer Attributes are ordered. For example, POSITION (UInt16), NORMAL (UInt16), COLOR_0 (UInt8), TEXCOORD_0 (UInt16), would result in the following byte structure: '''PPPP NNNN C0 TXC0''' This repeats for each vertex in the primitive.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Uint8 || Primitive Type

* 0x80 = Individual Quads

* 0x90 = Individual Triangles

* 0x98 = Triangle Strip

* 0xA0 = Triangle Fan

* 0xA8 = Individual Lines

* 0xB0 = Line Strip

* 0xB8 = Individual Points

TODO: Figure out if Quads, Lines, Line Strips, and Points work. TODO: Figure out if "Quad Strips" exist at 0x88.
|-
| 0x04 || Int16 || Vertex Count
|}
Each Matrix Group's primitive collection MUST be padded to the nearest 32. The game dies if you don't.

=== Matrix Group Definition Table ===
This table defines a list of Matrix Groups for each Shape. A Shape can have multiple Matrix Groups, but only stores the index of the first one. This means that all the Matrix Groups for a given Shape must come directly one after another. It contains only two values: The size of all Primitive Data within this group, and an offset to the first Primitive (relative to the Primitive Data offset defined in SHP1).
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int32 || Primitive Data size
|-
| 0x04 || Int32 || First Primitive offset
|}

=== Matrix Group Data Table ===
This table contains definitions of sub-segments inside the Weight Index Table. How these values are used differs based on the shape matrix calculation type, but official files generally set both usages up correctly regardless.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int16 || [[#DRW1_-_Skinning_Assignments|DRW1]] Matrix ID This is only used with Single Joint shape matrix calculation.
|-
| 0x02 || Int16 || Matrix Count This is only used with Multiple Joint shape matrix calculation.
|-
| 0x04 || Int32 || Starting Weight Index This is only used with Multiple Joint shape matrix calculation.
|}

=== Weight Index Table ===
This table contains several indices into [[#DRW1_-_Skinning_Assignments|DRW1]]. Each index is a Signed 16 value. The values may also contain 0xFFFF, which indicates that the last used index should be used instead. Matrix Groups can select a segment of these indices (up to 10) for use. A Matrix Group must not start with 0xFFFF.

== MAT2 - Material List (Old) ==
Technically supported by the game, but not known to be used by any model.

== MAT3 - Material List ==

== MDL3 - Display List ==

== TEX1 - Texture Data ==
The '''Tex'''ture Information section holds several embedded [[BTI_(File_Format)|BTI]] files that [[#MAT3_-_Material_List|MAT3]] can reference by index for texture assignment.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''TEX1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of [[BTI_(File_Format)|BTI]] files stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || [[BTI_(File_Format)|BTI]] Header Table Offset
|-
| 0x10 || Int32 || Name table offset
|}

The texture data locations are defined by the [[BTI_(File_Format)|BTI]] headers (which themselves are located directly one after another at the Header Table) 
This structure allows multiple textures that have the same visual data to have their headers point to just one block of visual data. In other words, two identical textures can be "compressed" into one while still having their own properties (wrapping, filtering, etc.)

BMD/BDL (File Format)

2025-10-26T00:43:51Z

Super Hackio: /* Primitive Data */ Turns out you need to pad the primitive collections

[[Category:File formats]]
{{WIP}}

BMD ('''B'''inary '''M'''o'''d'''el) and BDL ('''B'''inary '''D'''isplay '''L'''ist) are two 3D model formats used in ''Super Mario Galaxy'' and ''Super Mario Galaxy 2'', among a few other ''Wii'' and ''GameCube'' games, such as ''Super Mario Sunshine''.

These two formats hold the same data, except BDL contains an additional set of data which is used for faster rendering speeds.

''Super Mario Galaxy'' & ''Super Mario Galaxy 2'' contain J3DLoader versions 21 and 26.

== File Header ==
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || The magic that tells the game which format this file is. (ASCII) '''J3D2bmd2''' for BMD (J3DLoader V21) '''J3D2bmd3''' for BMD (J3DLoader v26) '''J3D2bdl4''' for BDL (J3DLoader v26)
|-
| 0x08 || Int32 || The total size of the file
|-
| 0x0C || Int32 || The number of chunks present in this file. '''8''' for BMD '''9''' for BDL
|}

=== Subversion Header ===
This part of the header is not used, and can be anything.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || A 4 character value representing the Subversion. Usually SVR3 for SMG/2.
|-
| 0x04 || Byte[12] || Twelve bytes of padding. Usually these are '''0xFF'''
|}

== INF1 - Scene Information ==
The '''Inf'''ormation section hosts a hierarchy of Joints, Materials, and Shapes, which are used to render the model.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''INF1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || [[#J3DLoader%20Flags|J3DLoader Flags]]
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || Matrix Group Data Count Referring to the Matrix Group Data in [[#SHP1_-_Shape_Information|SHP1]] Stored in a variable by the game, but not used to dictate the actual number of Matrix Groups.
|-
| 0x10 || Int32 || Vertex Count Always equals the number of entries in the [[#VTX1_-_Vertex_Data|VTX1]] "POSITION" [[#Vertex%20Buffer%20Formats|data buffer]] Stored in a variable by the game, but never used for anything. The game reads Vertex Data directly from the [[#Vertex%20Buffer%20Formats|data buffer]]s without bounds checking.
|-
| 0x14 || Int32 || Relative offset to the [[#Scene%20Hierarchy|Scene Hierarchy]]
|}

=== J3DLoader Flags ===
The J3DLoader contains several flags which affect how models are handled. There are more than what are shown here, however, those must be applied by the game itself in the code.
{| class="wikitable"
|-
! Value !! Description
|-
| 0b0000000000000000 || No flags applied (TODO: Check if this defaults to basic matrix calculation)
|-
| 0b0000000000000001 || Use Autodesk Softimage matrix calculation
|-
| 0b0000000000000010 || Use Autodesk Maya matrix calculation
|-
| 0b0000000000000100 || Use Basic matrix calculation
|-
| 0b0000000000001000 || ''UNKNOWN''
|-
| 0b0000000000010000 || UseImmidiateMtx (needs research)
|-
| 0b0000000000100000 || UsePostTexMtx (needs research)
|-
| 0b0000000001000000 || ''UNKNOWN''
|-
| 0b0000000010000000 || ''UNKNOWN''
|-
| 0b0000000100000000 || NoMatrixTransform (needs research)
|-
| 0b0000001000000000 || ''UNKNOWN''
|-
| 0b0000010000000000 || ''UNKNOWN''
|-
| 0b0000100000000000 || ''UNKNOWN''
|-
| 0b0001000000000000 || ''UNKNOWN''
|-
| 0b0010000000000000 || DoBdlMaterialCalc
|-
| 0b0100000000000000 || NoBdlMaterialPatch - If set, skips the call to '''J3DModelLoader::readPatchedMaterial'''.
|-
| 0b1000000000000000 || ''UNKNOWN''
|}
For all BMD files, the game always includes load flags ''Material_PE_Full'', ''Material_UseIndirect'', ''UseUniqueMaterials'', and ''UNKNOWN_21''. 
For all BDL files, the game always includes load flags ''Material_UseIndirect'', and ''UseUniqueMaterials''.

> ''Note: Changing the load flags by changing the code doesn't seem to do much.''

=== Scene Hierarchy ===
Each model is constructed using a Scene Hierarchy. This simply determines the order of bones (in turn, defining the parent/child relations), material assignments, and Shape assignments.

Each node consists of the following:
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || UInt16 || Node Type. 0x00 = Marks the end of the node list 0x01 = Creates a new child of the previous node 0x02 = Finishes the child node and returns ownership to the previous node 0x10 = Joint Assignment node. "Data" holds the Joint ID (index into JNT1) 0x11 = Material assignment. "Data" holds the Material ID (index into MAT3) 0x12 = Shape Assignment. "Data" holds the Shape ID (index into SHP1)
|-
| 0x02 || UInt16 || A Data value. Used by some nodes to index into other chunks. Usage depends on the node type.
|}

The node list is padded to the nearest 32.

== VTX1 - Vertex Data ==
The '''V'''er'''t'''e'''x''' Data section contains the actual number values used for the properties of the geometry. It also includes the information on how the values are formatted.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''VTX1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int32 || Buffer Format list offset
|-
| 0x0C || Int32 || "POSITION" data buffer offset 0 if not used.
|-
| 0x10 || Int32 || "NORMAL" data buffer offset 0 if not used.
|-
| 0x14 || Int32 || "TANGENT" data buffer offset 0 if not used.
|-
| 0x18 || Int32 || "COLOR_0" data buffer offset 0 if not used.
|-
| 0x1C || Int32 || "COLOR_1" data buffer offset 0 if not used.
|-
| 0x20 || Int32 || "TEXCOORD_0" data buffer offset 0 if not used.
|-
| 0x24 || Int32 || "TEXCOORD_1" data buffer offset 0 if not used.
|-
| 0x28 || Int32 || "TEXCOORD_2" data buffer offset 0 if not used.
|-
| 0x2C || Int32 || "TEXCOORD_3" data buffer offset 0 if not used.
|-
| 0x30 || Int32 || "TEXCOORD_4" data buffer offset 0 if not used.
|-
| 0x34 || Int32 || "TEXCOORD_5" data buffer offset 0 if not used.
|-
| 0x38 || Int32 || "TEXCOORD_6" data buffer offset 0 if not used.
|-
| 0x3C || Int32 || "TEXCOORD_7" data buffer offset 0 if not used.
|}

=== Vertex Buffer Formats ===
Each of the Buffers in this section have a format descriptor. This allows different types of data storage, allowing for smaller files.

Each format descriptor contains an Attribute Target, a Component Count, a Data Type, and a Mantissa shifter (to allow floats to be stored as smaller datatypes compared to FLOAT). Only one descriptor can exist for each attribute.

The Attribute Target tells the game what this buffer is used for.
{| class="wikitable"
|+ Attribute Targets
|-
! Value !! Name !! Description
|-
| 0x00000009 || POSITION || This buffer represents the positions of vertices in the model. Basically required for all visual models.
|-
| 0x0000000A || NORMAL || This buffer represents vertex normals, used for the engine's vertex shading. Not needed if no material requires it.
|-
| 0x0000000B || COLOR_0 || This buffer is available for Vertex Colors.
|-
| 0x0000000C || COLOR_1 || This buffer is available for Vertex Colors.
|-
| 0x0000000D || TEXCOORD_0 || This buffer is available for Texture Coordinates.
|-
| 0x0000000E || TEXCOORD_1 || This buffer is available for Texture Coordinates.
|-
| 0x0000000F || TEXCOORD_2 || This buffer is available for Texture Coordinates.
|-
| 0x00000010 || TEXCOORD_3 || This buffer is available for Texture Coordinates.
|-
| 0x00000011 || TEXCOORD_4 || This buffer is available for Texture Coordinates.
|-
| 0x00000012 || TEXCOORD_5 || This buffer is available for Texture Coordinates.
|-
| 0x00000013 || TEXCOORD_6 || This buffer is available for Texture Coordinates.
|-
| 0x00000014 || TEXCOORD_7 || This buffer is available for Texture Coordinates.
|-
| 0x00000019 || TANGENT || ''Currently unknown exactly what goes in here.''
|-
| 0x000000FF || List End || A buffer using this target will end the descriptor list.
|}

The component count tells the game how many parts of the component that there are. Note that the values are considered based on the attribute target they're assigned to.
{| class="wikitable"
|+ Component Count
|-
! Value !! Name !! Description
|-
| 0x00000000 || POSITION_XY || ''Unknown''
|-
| 0x00000001 || POSITION_XYZ || Represents a position in 3D space with 3 values: X, Y, and Z.
|-
|colspan="3"|
|-
| 0x00000000 || NORMAL_XYZ || Represents a normal vector in 3D space with 3 values: X, Y, and Z.
|-
| 0x00000001 || NORMAL_NBT || ''Unknown''
|-
| 0x00000002 || NORMAL_NBT3 || ''Unknown''
|-
|colspan="3"|
|-
| 0x00000000 || COLOR_RGB || Represents a color value with only Red, Green, and Blue values.
|-
| 0x00000001 || COLOR_RGBA || Represents a color value with Red, Green, Blue, and Alpha values.
|-
|colspan="3"|
|-
| 0x00000000 || TEXCOORD_S || ''Unknown''
|-
| 0x00000001 || TEXCOORD_ST || Represents a UV texture coordinate with 2 values: X and Y.
|}

The Data Type tells the game how many bytes each value is, in the sense that an Int32 is 4 bytes, a Int16 is 2 bytes, a Float is 4 bytes, etc. Note that the Color values have a different set of options.
{| class="wikitable"
|+ Data Types
|-
! Value !! Name !! Description
|-
| 0x00000000 || UInt8 || 1 byte per value (0 to 255)
|-
| 0x00000001 || Int8 || 1 byte per value (-128 to 127)
|-
| 0x00000002 || UInt16 || 2 bytes per value (0 to 65535)
|-
| 0x00000003 || Int16 || 2 bytes per value (-32,768 to 32,767)
|-
| 0x00000004 || Float || 4 bytes per value
|-
|colspan="3"|
|-
| 0x00000000 || RGB565 || 2 bytes per color
|-
| 0x00000001 || RGB8 || 3 bytes per color
|-
| 0x00000002 || RGBX8 || 3 bytes per color
|-
| 0x00000003 || RGBA4 || 2 bytes per color
|-
| 0x00000004 || RGBA6 || 4 bytes per color
|-
| 0x00000005 || RGBA8 || 4 bytes per color
|}
> ''Note: Both games require colors to be 4 bytes wide at all times, so changing from RGBA8 is worthless.''

== EVP1 - Skinning Envelopes ==
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''EVP1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of Envelopes stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || "Joint Count" list offset
|-
| 0x10 || Int32 || "'Joint Count' list index" list offset
|-
| 0x14 || Int32 || "Joint Weight" list offset
|-
| 0x18 || Int32 || "Inverse Bind Matrices" list offset
|}

== DRW1 - Skinning Assignments ==

== JNT1 - Joint Hierarchy ==
The '''J'''oi'''nt''' Hierarchy section defines the rigging skeleton of a model. There can only be one skeleton per model.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''JNT1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of Joints stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || Joint Data table offset
|-
| 0x10 || Int32 || Remap table offset
|-
| 0x14 || Int32 || Name table offset 0 if not present.
|}

=== Joint Data ===
Each joint includes positional data and a bounding box which is used by the game for determining rendering range automatically.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int16 || Matrix Type
|-
| 0x01 || UInt8 || Parent Scale inheritance 0 = Follow parent joint's scale 1 = Ignore parent joint's scale
|-
| 0x02 || UInt8 || Padding (0xFF)
|-
| 0x04 || Float || Scale X
|-
| 0x08 || Float || Scale Y
|-
| 0x0C || Float || Scale Z
|-
| 0x10 || Int16 || Rotation X
|-
| 0x12 || Int16 || Rotation Y
|-
| 0x14 || Int16 || Rotation Z
|-
| 0x16 || Int16 || Padding (0xFFFF)
|-
| 0x18 || Float || Translation X
|-
| 0x1C || Float || Translation Y
|-
| 0x20 || Float || Translation Z
|-
| 0x24 || Float || Bounding Sphere Should encapsulate all vertices that the joint affects
|-
| 0x28 || Float || Bounding Box Minimum X
|-
| 0x2C || Float || Bounding Box Minimum Y
|-
| 0x30 || Float || Bounding Box Minimum Z
|-
| 0x34 || Float || Bounding Box Maximum X
|-
| 0x38 || Float || Bounding Box Maximum Y
|-
| 0x3C || Float || Bounding Box Maximum Z
|}
Rotation is stored between -0x7FFF and 0x7FFF, which ranges -180 degrees and 180 degrees.

== SHP1 - Shape Information==
The '''Sh'''a'''p'''e Information section determines how to use the data in the [[#VTX1_-_Vertex_Data|VTX1]] section to create shapes.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''SHP1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of Shapes stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || Shape Init Data offset
|-
| 0x10 || Int32 || Remap table offset
|-
| 0x14 || Int32 || Name table offset (Generally not used, and thus set to 0)
|-
| 0x18 || Int32 || Vertex Index Attribute table offset
|-
| 0x1C || Int32 || Weight Index table offset
|-
| 0x20 || Int32 || Primitive Data offset
|-
| 0x24 || Int32 || Matrix Group Data offset (entry count must equal the entry count of the GXDisplayList group table)
|-
| 0x28 || Int32 || Matrix Group Definition table offset
|}

=== Shape Data ===
Each shape denotes a Matrix Calculation type, which is used for Billboarding, as well as multi-joint skinning. A shape also hosts a collection of Matrix Groups. If the geometry needs to be weighted to more than 10 [[#DRW1_-_Skinning_Assignments|DRW1]] matrices, more than one Matrix Group is needed. A single Matrix Group can have multiple Primitives in it, but these Primitives must share the same set of [[#DRW1_-_Skinning_Assignments|DRW1]] matrices.

TODO: Figure out what happens in the event that more than 10 are needed (such as one vertex being weighted to 11 bones). Is it just straight up not allowed?

{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || UInt8 || Matrix Type

* 0 = Single Joint

* 1 = Billboard Joint

* 2 = Billboard Joint (Y axis only)

* 3 = Multiple Joints
|-
| 0x01 || UInt8 || Padding (0xFF)
|-
| 0x02 || Int16 || Matrix Group count
|-
| 0x04 || Int16 || Vertex Index Attribute offset Relative to the Vertex Index Attribute Table offset defined in SHP1
|-
| 0x06 || Int16 || Matrix Group Data index
|-
| 0x08 || Int16 || First Matrix Group Definition index
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Float || Bounding Sphere
|-
| 0x10 || Float || Bounding Box Minimum X
|-
| 0x14 || Float || Bounding Box Minimum Y
|-
| 0x18 || Float || Bounding Box Minimum Z
|-
| 0x1C || Float || Bounding Box Maximum X
|-
| 0x20 || Float || Bounding Box Maximum Y
|-
| 0x24 || Float || Bounding Box Maximum Z
|}

=== Vertex Index Attribute Table ===

{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int32 || An [[#Index%20Buffer%20Formats|index buffer]] attribute target
|-
| 0x04 || Int32 || An [[#Index%20Buffer%20Formats|index buffer]] type
|}

==== Index Buffer Formats ====
Each of the Buffers in this section have a format descriptor. This allows different types of data storage, allowing for smaller files.

These attributes line up with either a direct value that is stored in the shape, or an index into a [[#VTX1_-_Vertex_Data|VTX1]] [[#Vertex%20Buffer%20Formats|data buffer]]. Only one indexer can exist for each attribute.

The Attribute Target tells the game what this index buffer is used for.
{| class="wikitable"
|+ Attribute Targets
|-
! Value !! Name !! Description
|-
| 0x00000000 || POSITION_MATRIX || This is a direct list of indices into the Matrix Group's Weight collection. Required for Shapes that use Multiple Joint skinning.
|-
| 0x00000001 || TEXTURE_0_MATRIX || ''UNKNOWN''
|-
| 0x00000002 || TEXTURE_1_MATRIX || ''UNKNOWN''
|-
| 0x00000003 || TEXTURE_2_MATRIX || ''UNKNOWN''
|-
| 0x00000004 || TEXTURE_3_MATRIX || ''UNKNOWN''
|-
| 0x00000005 || TEXTURE_4_MATRIX || ''UNKNOWN''
|-
| 0x00000006 || TEXTURE_5_MATRIX || ''UNKNOWN''
|-
| 0x00000007 || TEXTURE_6_MATRIX || ''UNKNOWN''
|-
| 0x00000008 || TEXTURE_7_MATRIX || ''UNKNOWN''
|-
| 0x00000009 || POSITION || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "POSITION" buffer. Required.
|-
| 0x0000000A || NORMAL || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "NORMAL" buffer
|-
| 0x0000000B || COLOR_0 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "COLOR_0" buffer
|-
| 0x0000000C || COLOR_1 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "COLOR_1" buffer
|-
| 0x0000000D || TEXCOORD_0 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_0" buffer
|-
| 0x0000000E || TEXCOORD_1 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_1" buffer
|-
| 0x0000000F || TEXCOORD_2 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_2" buffer
|-
| 0x00000010 || TEXCOORD_3 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_3" buffer
|-
| 0x00000011 || TEXCOORD_4 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_4" buffer
|-
| 0x00000012 || TEXCOORD_5 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_5" buffer
|-
| 0x00000013 || TEXCOORD_6 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_6" buffer
|-
| 0x00000014 || TEXCOORD_7 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_7" buffer
|-
| 0x00000019 || TANGENT || ''This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TANGENT" buffer, but we don't yet know what that buffer does.''
|-
| 0x000000FF || List End || A buffer using this target will end the descriptor list.
|}

The Data Type of an Index Buffer determines the size of each Index. Direct Buffers can only be 1 byte per value.
{| class="wikitable"
|+ Data Types
|-
! Value !! Name !! Description
|-
| 0x00000000 || None || Only used for the List End
|-
| 0x00000001 || Direct || 1 byte per value. Only used for data that is not stored within [[#VTX1_-_Vertex_Data|VTX1]] Needs to be divided by 3 for some reason...
|-
| 0x00000002 || UInt8 || 1 byte per value (0 to 255). Indexes a buffer in [[#VTX1_-_Vertex_Data|VTX1]].
|-
| 0x00000003 || UInt16 || 2 bytes per value (0 to 65535). Indexes a buffer in [[#VTX1_-_Vertex_Data|VTX1]].
|}

=== Primitive Data ===
This chunk contains raw primitives. These are what hold the index buffers. The Index Buffers are ordered the same way the Index Buffer Attributes are ordered. For example, POSITION (UInt16), NORMAL (UInt16), COLOR_0 (UInt8), TEXCOORD_0 (UInt16), would result in the following byte structure: '''PPPP NNNN C0 TXC0''' This repeats for each vertex in the primitive.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Uint8 || Primitive Type

* 0x80 = Individual Quads

* 0x90 = Individual Triangles

* 0x98 = Triangle Strip

* 0xA0 = Triangle Fan

* 0xA8 = Individual Lines

* 0xB0 = Line Strip

* 0xB8 = Individual Points

TODO: Figure out if Quads, Lines, Line Strips, and Points work. TODO: Figure out if "Quad Strips" exist at 0x88.
|-
| 0x04 || Int16 || Vertex Count
|}
Each Matrix Group's primitive collection MUST be padded to the nearest 32. The game dies if you don't.

=== Matrix Group Definition Table ===
This table defines a list of Matrix Groups for each Shape. A Shape can have multiple Matrix Groups, but only stores the index of the first one. This means that all the Matrix Groups for a given Shape must come directly one after another. It contains only two values: The size of all Primitive Data within this group, and an offset to the first Primitive (relative to the Primitive Data offset defined in SHP1).
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int32 || Primitive Data size
|-
| 0x04 || Int32 || First Primitive offset
|}

=== Matrix Group Data Table ===
This table contains definitions of sub-segments inside the Weight Index Table. How these values are used differs based on the shape matrix calculation type, but official files generally set both usages up correctly regardless.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int16 || [[#DRW1_-_Skinning_Assignments|DRW1]] Matrix ID This is only used with Single Joint shape matrix calculation.
|-
| 0x02 || Int16 || Matrix Count This is only used with Multiple Joint shape matrix calculation.
|-
| 0x04 || Int32 || Starting Weight Index This is only used with Multiple Joint shape matrix calculation.
|}

=== Weight Index Table ===
This table contains several indices into [[#DRW1_-_Skinning_Assignments|DRW1]]. Each index is a Signed 16 value. The values may also contain 0xFFFF, which indicates that the last used index should be used instead. Matrix Groups can select a segment of these indices (up to 10) for use. A Matrix Group must not start with 0xFFFF.

== MAT2 - Material List (Old) ==
Technically supported by the game, but not known to be used by any model.

== MAT3 - Material List ==

== MDL3 - Display List ==

== TEX1 - Texture Data ==
The '''Tex'''ture Information section holds several embedded [[BTI_(File_Format)|BTI]] files that [[#MAT3_-_Material_List|MAT3]] can reference by index for texture assignment.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''TEX1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of [[BTI_(File_Format)|BTI]] files stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || [[BTI_(File_Format)|BTI]] Header Table Offset
|-
| 0x10 || Int32 || Name table offset
|}

The texture data locations are defined by the [[BTI_(File_Format)|BTI]] headers (which themselves are located directly one after another at the Header Table) 
This structure allows multiple textures that have the same visual data to have their headers point to just one block of visual data. In other words, two identical textures can be "compressed" into one while still having their own properties (wrapping, filtering, etc.)

BMD/BDL (File Format)

2025-10-25T23:36:27Z

Super Hackio: /* JNT1 - Joint Hierarchy */ Fix formatting on the last minor edit

[[Category:File formats]]
{{WIP}}

BMD ('''B'''inary '''M'''o'''d'''el) and BDL ('''B'''inary '''D'''isplay '''L'''ist) are two 3D model formats used in ''Super Mario Galaxy'' and ''Super Mario Galaxy 2'', among a few other ''Wii'' and ''GameCube'' games, such as ''Super Mario Sunshine''.

These two formats hold the same data, except BDL contains an additional set of data which is used for faster rendering speeds.

''Super Mario Galaxy'' & ''Super Mario Galaxy 2'' contain J3DLoader versions 21 and 26.

== File Header ==
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || The magic that tells the game which format this file is. (ASCII) '''J3D2bmd2''' for BMD (J3DLoader V21) '''J3D2bmd3''' for BMD (J3DLoader v26) '''J3D2bdl4''' for BDL (J3DLoader v26)
|-
| 0x08 || Int32 || The total size of the file
|-
| 0x0C || Int32 || The number of chunks present in this file. '''8''' for BMD '''9''' for BDL
|}

=== Subversion Header ===
This part of the header is not used, and can be anything.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || A 4 character value representing the Subversion. Usually SVR3 for SMG/2.
|-
| 0x04 || Byte[12] || Twelve bytes of padding. Usually these are '''0xFF'''
|}

== INF1 - Scene Information ==
The '''Inf'''ormation section hosts a hierarchy of Joints, Materials, and Shapes, which are used to render the model.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''INF1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || [[#J3DLoader%20Flags|J3DLoader Flags]]
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || Matrix Group Data Count Referring to the Matrix Group Data in [[#SHP1_-_Shape_Information|SHP1]] Stored in a variable by the game, but not used to dictate the actual number of Matrix Groups.
|-
| 0x10 || Int32 || Vertex Count Always equals the number of entries in the [[#VTX1_-_Vertex_Data|VTX1]] "POSITION" [[#Vertex%20Buffer%20Formats|data buffer]] Stored in a variable by the game, but never used for anything. The game reads Vertex Data directly from the [[#Vertex%20Buffer%20Formats|data buffer]]s without bounds checking.
|-
| 0x14 || Int32 || Relative offset to the [[#Scene%20Hierarchy|Scene Hierarchy]]
|}

=== J3DLoader Flags ===
The J3DLoader contains several flags which affect how models are handled. There are more than what are shown here, however, those must be applied by the game itself in the code.
{| class="wikitable"
|-
! Value !! Description
|-
| 0b0000000000000000 || No flags applied (TODO: Check if this defaults to basic matrix calculation)
|-
| 0b0000000000000001 || Use Autodesk Softimage matrix calculation
|-
| 0b0000000000000010 || Use Autodesk Maya matrix calculation
|-
| 0b0000000000000100 || Use Basic matrix calculation
|-
| 0b0000000000001000 || ''UNKNOWN''
|-
| 0b0000000000010000 || UseImmidiateMtx (needs research)
|-
| 0b0000000000100000 || UsePostTexMtx (needs research)
|-
| 0b0000000001000000 || ''UNKNOWN''
|-
| 0b0000000010000000 || ''UNKNOWN''
|-
| 0b0000000100000000 || NoMatrixTransform (needs research)
|-
| 0b0000001000000000 || ''UNKNOWN''
|-
| 0b0000010000000000 || ''UNKNOWN''
|-
| 0b0000100000000000 || ''UNKNOWN''
|-
| 0b0001000000000000 || ''UNKNOWN''
|-
| 0b0010000000000000 || DoBdlMaterialCalc
|-
| 0b0100000000000000 || NoBdlMaterialPatch - If set, skips the call to '''J3DModelLoader::readPatchedMaterial'''.
|-
| 0b1000000000000000 || ''UNKNOWN''
|}
For all BMD files, the game always includes load flags ''Material_PE_Full'', ''Material_UseIndirect'', ''UseUniqueMaterials'', and ''UNKNOWN_21''. 
For all BDL files, the game always includes load flags ''Material_UseIndirect'', and ''UseUniqueMaterials''.

> ''Note: Changing the load flags by changing the code doesn't seem to do much.''

=== Scene Hierarchy ===
Each model is constructed using a Scene Hierarchy. This simply determines the order of bones (in turn, defining the parent/child relations), material assignments, and Shape assignments.

Each node consists of the following:
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || UInt16 || Node Type. 0x00 = Marks the end of the node list 0x01 = Creates a new child of the previous node 0x02 = Finishes the child node and returns ownership to the previous node 0x10 = Joint Assignment node. "Data" holds the Joint ID (index into JNT1) 0x11 = Material assignment. "Data" holds the Material ID (index into MAT3) 0x12 = Shape Assignment. "Data" holds the Shape ID (index into SHP1)
|-
| 0x02 || UInt16 || A Data value. Used by some nodes to index into other chunks. Usage depends on the node type.
|}

The node list is padded to the nearest 32.

== VTX1 - Vertex Data ==
The '''V'''er'''t'''e'''x''' Data section contains the actual number values used for the properties of the geometry. It also includes the information on how the values are formatted.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''VTX1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int32 || Buffer Format list offset
|-
| 0x0C || Int32 || "POSITION" data buffer offset 0 if not used.
|-
| 0x10 || Int32 || "NORMAL" data buffer offset 0 if not used.
|-
| 0x14 || Int32 || "TANGENT" data buffer offset 0 if not used.
|-
| 0x18 || Int32 || "COLOR_0" data buffer offset 0 if not used.
|-
| 0x1C || Int32 || "COLOR_1" data buffer offset 0 if not used.
|-
| 0x20 || Int32 || "TEXCOORD_0" data buffer offset 0 if not used.
|-
| 0x24 || Int32 || "TEXCOORD_1" data buffer offset 0 if not used.
|-
| 0x28 || Int32 || "TEXCOORD_2" data buffer offset 0 if not used.
|-
| 0x2C || Int32 || "TEXCOORD_3" data buffer offset 0 if not used.
|-
| 0x30 || Int32 || "TEXCOORD_4" data buffer offset 0 if not used.
|-
| 0x34 || Int32 || "TEXCOORD_5" data buffer offset 0 if not used.
|-
| 0x38 || Int32 || "TEXCOORD_6" data buffer offset 0 if not used.
|-
| 0x3C || Int32 || "TEXCOORD_7" data buffer offset 0 if not used.
|}

=== Vertex Buffer Formats ===
Each of the Buffers in this section have a format descriptor. This allows different types of data storage, allowing for smaller files.

Each format descriptor contains an Attribute Target, a Component Count, a Data Type, and a Mantissa shifter (to allow floats to be stored as smaller datatypes compared to FLOAT). Only one descriptor can exist for each attribute.

The Attribute Target tells the game what this buffer is used for.
{| class="wikitable"
|+ Attribute Targets
|-
! Value !! Name !! Description
|-
| 0x00000009 || POSITION || This buffer represents the positions of vertices in the model. Basically required for all visual models.
|-
| 0x0000000A || NORMAL || This buffer represents vertex normals, used for the engine's vertex shading. Not needed if no material requires it.
|-
| 0x0000000B || COLOR_0 || This buffer is available for Vertex Colors.
|-
| 0x0000000C || COLOR_1 || This buffer is available for Vertex Colors.
|-
| 0x0000000D || TEXCOORD_0 || This buffer is available for Texture Coordinates.
|-
| 0x0000000E || TEXCOORD_1 || This buffer is available for Texture Coordinates.
|-
| 0x0000000F || TEXCOORD_2 || This buffer is available for Texture Coordinates.
|-
| 0x00000010 || TEXCOORD_3 || This buffer is available for Texture Coordinates.
|-
| 0x00000011 || TEXCOORD_4 || This buffer is available for Texture Coordinates.
|-
| 0x00000012 || TEXCOORD_5 || This buffer is available for Texture Coordinates.
|-
| 0x00000013 || TEXCOORD_6 || This buffer is available for Texture Coordinates.
|-
| 0x00000014 || TEXCOORD_7 || This buffer is available for Texture Coordinates.
|-
| 0x00000019 || TANGENT || ''Currently unknown exactly what goes in here.''
|-
| 0x000000FF || List End || A buffer using this target will end the descriptor list.
|}

The component count tells the game how many parts of the component that there are. Note that the values are considered based on the attribute target they're assigned to.
{| class="wikitable"
|+ Component Count
|-
! Value !! Name !! Description
|-
| 0x00000000 || POSITION_XY || ''Unknown''
|-
| 0x00000001 || POSITION_XYZ || Represents a position in 3D space with 3 values: X, Y, and Z.
|-
|colspan="3"|
|-
| 0x00000000 || NORMAL_XYZ || Represents a normal vector in 3D space with 3 values: X, Y, and Z.
|-
| 0x00000001 || NORMAL_NBT || ''Unknown''
|-
| 0x00000002 || NORMAL_NBT3 || ''Unknown''
|-
|colspan="3"|
|-
| 0x00000000 || COLOR_RGB || Represents a color value with only Red, Green, and Blue values.
|-
| 0x00000001 || COLOR_RGBA || Represents a color value with Red, Green, Blue, and Alpha values.
|-
|colspan="3"|
|-
| 0x00000000 || TEXCOORD_S || ''Unknown''
|-
| 0x00000001 || TEXCOORD_ST || Represents a UV texture coordinate with 2 values: X and Y.
|}

The Data Type tells the game how many bytes each value is, in the sense that an Int32 is 4 bytes, a Int16 is 2 bytes, a Float is 4 bytes, etc. Note that the Color values have a different set of options.
{| class="wikitable"
|+ Data Types
|-
! Value !! Name !! Description
|-
| 0x00000000 || UInt8 || 1 byte per value (0 to 255)
|-
| 0x00000001 || Int8 || 1 byte per value (-128 to 127)
|-
| 0x00000002 || UInt16 || 2 bytes per value (0 to 65535)
|-
| 0x00000003 || Int16 || 2 bytes per value (-32,768 to 32,767)
|-
| 0x00000004 || Float || 4 bytes per value
|-
|colspan="3"|
|-
| 0x00000000 || RGB565 || 2 bytes per color
|-
| 0x00000001 || RGB8 || 3 bytes per color
|-
| 0x00000002 || RGBX8 || 3 bytes per color
|-
| 0x00000003 || RGBA4 || 2 bytes per color
|-
| 0x00000004 || RGBA6 || 4 bytes per color
|-
| 0x00000005 || RGBA8 || 4 bytes per color
|}
> ''Note: Both games require colors to be 4 bytes wide at all times, so changing from RGBA8 is worthless.''

== EVP1 - Skinning Envelopes ==
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''EVP1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of Envelopes stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || "Joint Count" list offset
|-
| 0x10 || Int32 || "'Joint Count' list index" list offset
|-
| 0x14 || Int32 || "Joint Weight" list offset
|-
| 0x18 || Int32 || "Inverse Bind Matrices" list offset
|}

== DRW1 - Skinning Assignments ==

== JNT1 - Joint Hierarchy ==
The '''J'''oi'''nt''' Hierarchy section defines the rigging skeleton of a model. There can only be one skeleton per model.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''JNT1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of Joints stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || Joint Data table offset
|-
| 0x10 || Int32 || Remap table offset
|-
| 0x14 || Int32 || Name table offset 0 if not present.
|}

=== Joint Data ===
Each joint includes positional data and a bounding box which is used by the game for determining rendering range automatically.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int16 || Matrix Type
|-
| 0x01 || UInt8 || Parent Scale inheritance 0 = Follow parent joint's scale 1 = Ignore parent joint's scale
|-
| 0x02 || UInt8 || Padding (0xFF)
|-
| 0x04 || Float || Scale X
|-
| 0x08 || Float || Scale Y
|-
| 0x0C || Float || Scale Z
|-
| 0x10 || Int16 || Rotation X
|-
| 0x12 || Int16 || Rotation Y
|-
| 0x14 || Int16 || Rotation Z
|-
| 0x16 || Int16 || Padding (0xFFFF)
|-
| 0x18 || Float || Translation X
|-
| 0x1C || Float || Translation Y
|-
| 0x20 || Float || Translation Z
|-
| 0x24 || Float || Bounding Sphere Should encapsulate all vertices that the joint affects
|-
| 0x28 || Float || Bounding Box Minimum X
|-
| 0x2C || Float || Bounding Box Minimum Y
|-
| 0x30 || Float || Bounding Box Minimum Z
|-
| 0x34 || Float || Bounding Box Maximum X
|-
| 0x38 || Float || Bounding Box Maximum Y
|-
| 0x3C || Float || Bounding Box Maximum Z
|}
Rotation is stored between -0x7FFF and 0x7FFF, which ranges -180 degrees and 180 degrees.

== SHP1 - Shape Information==
The '''Sh'''a'''p'''e Information section determines how to use the data in the [[#VTX1_-_Vertex_Data|VTX1]] section to create shapes.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''SHP1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of Shapes stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || Shape Init Data offset
|-
| 0x10 || Int32 || Remap table offset
|-
| 0x14 || Int32 || Name table offset (Generally not used, and thus set to 0)
|-
| 0x18 || Int32 || Vertex Index Attribute table offset
|-
| 0x1C || Int32 || Weight Index table offset
|-
| 0x20 || Int32 || Primitive Data offset
|-
| 0x24 || Int32 || Matrix Group Data offset (entry count must equal the entry count of the GXDisplayList group table)
|-
| 0x28 || Int32 || Matrix Group Definition table offset
|}

=== Shape Data ===
Each shape denotes a Matrix Calculation type, which is used for Billboarding, as well as multi-joint skinning. A shape also hosts a collection of Matrix Groups. If the geometry needs to be weighted to more than 10 [[#DRW1_-_Skinning_Assignments|DRW1]] matrices, more than one Matrix Group is needed. A single Matrix Group can have multiple Primitives in it, but these Primitives must share the same set of [[#DRW1_-_Skinning_Assignments|DRW1]] matrices.

TODO: Figure out what happens in the event that more than 10 are needed (such as one vertex being weighted to 11 bones). Is it just straight up not allowed?

{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || UInt8 || Matrix Type

* 0 = Single Joint

* 1 = Billboard Joint

* 2 = Billboard Joint (Y axis only)

* 3 = Multiple Joints
|-
| 0x01 || UInt8 || Padding (0xFF)
|-
| 0x02 || Int16 || Matrix Group count
|-
| 0x04 || Int16 || Vertex Index Attribute offset Relative to the Vertex Index Attribute Table offset defined in SHP1
|-
| 0x06 || Int16 || Matrix Group Data index
|-
| 0x08 || Int16 || First Matrix Group Definition index
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Float || Bounding Sphere
|-
| 0x10 || Float || Bounding Box Minimum X
|-
| 0x14 || Float || Bounding Box Minimum Y
|-
| 0x18 || Float || Bounding Box Minimum Z
|-
| 0x1C || Float || Bounding Box Maximum X
|-
| 0x20 || Float || Bounding Box Maximum Y
|-
| 0x24 || Float || Bounding Box Maximum Z
|}

=== Vertex Index Attribute Table ===

{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int32 || An [[#Index%20Buffer%20Formats|index buffer]] attribute target
|-
| 0x04 || Int32 || An [[#Index%20Buffer%20Formats|index buffer]] type
|}

==== Index Buffer Formats ====
Each of the Buffers in this section have a format descriptor. This allows different types of data storage, allowing for smaller files.

These attributes line up with either a direct value that is stored in the shape, or an index into a [[#VTX1_-_Vertex_Data|VTX1]] [[#Vertex%20Buffer%20Formats|data buffer]]. Only one indexer can exist for each attribute.

The Attribute Target tells the game what this index buffer is used for.
{| class="wikitable"
|+ Attribute Targets
|-
! Value !! Name !! Description
|-
| 0x00000000 || POSITION_MATRIX || This is a direct list of indices into the Matrix Group's Weight collection. Required for Shapes that use Multiple Joint skinning.
|-
| 0x00000001 || TEXTURE_0_MATRIX || ''UNKNOWN''
|-
| 0x00000002 || TEXTURE_1_MATRIX || ''UNKNOWN''
|-
| 0x00000003 || TEXTURE_2_MATRIX || ''UNKNOWN''
|-
| 0x00000004 || TEXTURE_3_MATRIX || ''UNKNOWN''
|-
| 0x00000005 || TEXTURE_4_MATRIX || ''UNKNOWN''
|-
| 0x00000006 || TEXTURE_5_MATRIX || ''UNKNOWN''
|-
| 0x00000007 || TEXTURE_6_MATRIX || ''UNKNOWN''
|-
| 0x00000008 || TEXTURE_7_MATRIX || ''UNKNOWN''
|-
| 0x00000009 || POSITION || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "POSITION" buffer. Required.
|-
| 0x0000000A || NORMAL || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "NORMAL" buffer
|-
| 0x0000000B || COLOR_0 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "COLOR_0" buffer
|-
| 0x0000000C || COLOR_1 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "COLOR_1" buffer
|-
| 0x0000000D || TEXCOORD_0 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_0" buffer
|-
| 0x0000000E || TEXCOORD_1 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_1" buffer
|-
| 0x0000000F || TEXCOORD_2 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_2" buffer
|-
| 0x00000010 || TEXCOORD_3 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_3" buffer
|-
| 0x00000011 || TEXCOORD_4 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_4" buffer
|-
| 0x00000012 || TEXCOORD_5 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_5" buffer
|-
| 0x00000013 || TEXCOORD_6 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_6" buffer
|-
| 0x00000014 || TEXCOORD_7 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_7" buffer
|-
| 0x00000019 || TANGENT || ''This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TANGENT" buffer, but we don't yet know what that buffer does.''
|-
| 0x000000FF || List End || A buffer using this target will end the descriptor list.
|}

The Data Type of an Index Buffer determines the size of each Index. Direct Buffers can only be 1 byte per value.
{| class="wikitable"
|+ Data Types
|-
! Value !! Name !! Description
|-
| 0x00000000 || None || Only used for the List End
|-
| 0x00000001 || Direct || 1 byte per value. Only used for data that is not stored within [[#VTX1_-_Vertex_Data|VTX1]] Needs to be divided by 3 for some reason...
|-
| 0x00000002 || UInt8 || 1 byte per value (0 to 255). Indexes a buffer in [[#VTX1_-_Vertex_Data|VTX1]].
|-
| 0x00000003 || UInt16 || 2 bytes per value (0 to 65535). Indexes a buffer in [[#VTX1_-_Vertex_Data|VTX1]].
|}

=== Primitive Data ===
This chunk contains raw primitives. These are what hold the index buffers. The Index Buffers are ordered the same way the Index Buffer Attributes are ordered. For example, POSITION (UInt16), NORMAL (UInt16), COLOR_0 (UInt8), TEXCOORD_0 (UInt16), would result in the following byte structure: '''PPPP NNNN C0 TXC0''' This repeats for each vertex in the primitive.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Uint8 || Primitive Type

* 0x80 = Individual Quads

* 0x90 = Individual Triangles

* 0x98 = Triangle Strip

* 0xA0 = Triangle Fan

* 0xA8 = Individual Lines

* 0xB0 = Line Strip

* 0xB8 = Individual Points

TODO: Figure out if Quads, Lines, Line Strips, and Points work. TODO: Figure out if "Quad Strips" exist at 0x88.
|-
| 0x04 || Int16 || Vertex Count
|}
Each Matrix Group's primitives are padded to the nearest 32.
TODO: Figure out if the padding is allowed to be omitted.

=== Matrix Group Definition Table ===
This table defines a list of Matrix Groups for each Shape. A Shape can have multiple Matrix Groups, but only stores the index of the first one. This means that all the Matrix Groups for a given Shape must come directly one after another. It contains only two values: The size of all Primitive Data within this group, and an offset to the first Primitive (relative to the Primitive Data offset defined in SHP1).
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int32 || Primitive Data size
|-
| 0x04 || Int32 || First Primitive offset
|}

=== Matrix Group Data Table ===
This table contains definitions of sub-segments inside the Weight Index Table. How these values are used differs based on the shape matrix calculation type, but official files generally set both usages up correctly regardless.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int16 || [[#DRW1_-_Skinning_Assignments|DRW1]] Matrix ID This is only used with Single Joint shape matrix calculation.
|-
| 0x02 || Int16 || Matrix Count This is only used with Multiple Joint shape matrix calculation.
|-
| 0x04 || Int32 || Starting Weight Index This is only used with Multiple Joint shape matrix calculation.
|}

=== Weight Index Table ===
This table contains several indices into [[#DRW1_-_Skinning_Assignments|DRW1]]. Each index is a Signed 16 value. The values may also contain 0xFFFF, which indicates that the last used index should be used instead. Matrix Groups can select a segment of these indices (up to 10) for use. A Matrix Group must not start with 0xFFFF.

== MAT2 - Material List (Old) ==
Technically supported by the game, but not known to be used by any model.

== MAT3 - Material List ==

== MDL3 - Display List ==

== TEX1 - Texture Data ==
The '''Tex'''ture Information section holds several embedded [[BTI_(File_Format)|BTI]] files that [[#MAT3_-_Material_List|MAT3]] can reference by index for texture assignment.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''TEX1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of [[BTI_(File_Format)|BTI]] files stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || [[BTI_(File_Format)|BTI]] Header Table Offset
|-
| 0x10 || Int32 || Name table offset
|}

The texture data locations are defined by the [[BTI_(File_Format)|BTI]] headers (which themselves are located directly one after another at the Header Table) 
This structure allows multiple textures that have the same visual data to have their headers point to just one block of visual data. In other words, two identical textures can be "compressed" into one while still having their own properties (wrapping, filtering, etc.)

BMD/BDL (File Format)

2025-10-25T23:35:32Z

Super Hackio: Joint Name Table can be excluded from the file

[[Category:File formats]]
{{WIP}}

BMD ('''B'''inary '''M'''o'''d'''el) and BDL ('''B'''inary '''D'''isplay '''L'''ist) are two 3D model formats used in ''Super Mario Galaxy'' and ''Super Mario Galaxy 2'', among a few other ''Wii'' and ''GameCube'' games, such as ''Super Mario Sunshine''.

These two formats hold the same data, except BDL contains an additional set of data which is used for faster rendering speeds.

''Super Mario Galaxy'' & ''Super Mario Galaxy 2'' contain J3DLoader versions 21 and 26.

== File Header ==
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || The magic that tells the game which format this file is. (ASCII) '''J3D2bmd2''' for BMD (J3DLoader V21) '''J3D2bmd3''' for BMD (J3DLoader v26) '''J3D2bdl4''' for BDL (J3DLoader v26)
|-
| 0x08 || Int32 || The total size of the file
|-
| 0x0C || Int32 || The number of chunks present in this file. '''8''' for BMD '''9''' for BDL
|}

=== Subversion Header ===
This part of the header is not used, and can be anything.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || A 4 character value representing the Subversion. Usually SVR3 for SMG/2.
|-
| 0x04 || Byte[12] || Twelve bytes of padding. Usually these are '''0xFF'''
|}

== INF1 - Scene Information ==
The '''Inf'''ormation section hosts a hierarchy of Joints, Materials, and Shapes, which are used to render the model.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''INF1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || [[#J3DLoader%20Flags|J3DLoader Flags]]
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || Matrix Group Data Count Referring to the Matrix Group Data in [[#SHP1_-_Shape_Information|SHP1]] Stored in a variable by the game, but not used to dictate the actual number of Matrix Groups.
|-
| 0x10 || Int32 || Vertex Count Always equals the number of entries in the [[#VTX1_-_Vertex_Data|VTX1]] "POSITION" [[#Vertex%20Buffer%20Formats|data buffer]] Stored in a variable by the game, but never used for anything. The game reads Vertex Data directly from the [[#Vertex%20Buffer%20Formats|data buffer]]s without bounds checking.
|-
| 0x14 || Int32 || Relative offset to the [[#Scene%20Hierarchy|Scene Hierarchy]]
|}

=== J3DLoader Flags ===
The J3DLoader contains several flags which affect how models are handled. There are more than what are shown here, however, those must be applied by the game itself in the code.
{| class="wikitable"
|-
! Value !! Description
|-
| 0b0000000000000000 || No flags applied (TODO: Check if this defaults to basic matrix calculation)
|-
| 0b0000000000000001 || Use Autodesk Softimage matrix calculation
|-
| 0b0000000000000010 || Use Autodesk Maya matrix calculation
|-
| 0b0000000000000100 || Use Basic matrix calculation
|-
| 0b0000000000001000 || ''UNKNOWN''
|-
| 0b0000000000010000 || UseImmidiateMtx (needs research)
|-
| 0b0000000000100000 || UsePostTexMtx (needs research)
|-
| 0b0000000001000000 || ''UNKNOWN''
|-
| 0b0000000010000000 || ''UNKNOWN''
|-
| 0b0000000100000000 || NoMatrixTransform (needs research)
|-
| 0b0000001000000000 || ''UNKNOWN''
|-
| 0b0000010000000000 || ''UNKNOWN''
|-
| 0b0000100000000000 || ''UNKNOWN''
|-
| 0b0001000000000000 || ''UNKNOWN''
|-
| 0b0010000000000000 || DoBdlMaterialCalc
|-
| 0b0100000000000000 || NoBdlMaterialPatch - If set, skips the call to '''J3DModelLoader::readPatchedMaterial'''.
|-
| 0b1000000000000000 || ''UNKNOWN''
|}
For all BMD files, the game always includes load flags ''Material_PE_Full'', ''Material_UseIndirect'', ''UseUniqueMaterials'', and ''UNKNOWN_21''. 
For all BDL files, the game always includes load flags ''Material_UseIndirect'', and ''UseUniqueMaterials''.

> ''Note: Changing the load flags by changing the code doesn't seem to do much.''

=== Scene Hierarchy ===
Each model is constructed using a Scene Hierarchy. This simply determines the order of bones (in turn, defining the parent/child relations), material assignments, and Shape assignments.

Each node consists of the following:
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || UInt16 || Node Type. 0x00 = Marks the end of the node list 0x01 = Creates a new child of the previous node 0x02 = Finishes the child node and returns ownership to the previous node 0x10 = Joint Assignment node. "Data" holds the Joint ID (index into JNT1) 0x11 = Material assignment. "Data" holds the Material ID (index into MAT3) 0x12 = Shape Assignment. "Data" holds the Shape ID (index into SHP1)
|-
| 0x02 || UInt16 || A Data value. Used by some nodes to index into other chunks. Usage depends on the node type.
|}

The node list is padded to the nearest 32.

== VTX1 - Vertex Data ==
The '''V'''er'''t'''e'''x''' Data section contains the actual number values used for the properties of the geometry. It also includes the information on how the values are formatted.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''VTX1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int32 || Buffer Format list offset
|-
| 0x0C || Int32 || "POSITION" data buffer offset 0 if not used.
|-
| 0x10 || Int32 || "NORMAL" data buffer offset 0 if not used.
|-
| 0x14 || Int32 || "TANGENT" data buffer offset 0 if not used.
|-
| 0x18 || Int32 || "COLOR_0" data buffer offset 0 if not used.
|-
| 0x1C || Int32 || "COLOR_1" data buffer offset 0 if not used.
|-
| 0x20 || Int32 || "TEXCOORD_0" data buffer offset 0 if not used.
|-
| 0x24 || Int32 || "TEXCOORD_1" data buffer offset 0 if not used.
|-
| 0x28 || Int32 || "TEXCOORD_2" data buffer offset 0 if not used.
|-
| 0x2C || Int32 || "TEXCOORD_3" data buffer offset 0 if not used.
|-
| 0x30 || Int32 || "TEXCOORD_4" data buffer offset 0 if not used.
|-
| 0x34 || Int32 || "TEXCOORD_5" data buffer offset 0 if not used.
|-
| 0x38 || Int32 || "TEXCOORD_6" data buffer offset 0 if not used.
|-
| 0x3C || Int32 || "TEXCOORD_7" data buffer offset 0 if not used.
|}

=== Vertex Buffer Formats ===
Each of the Buffers in this section have a format descriptor. This allows different types of data storage, allowing for smaller files.

Each format descriptor contains an Attribute Target, a Component Count, a Data Type, and a Mantissa shifter (to allow floats to be stored as smaller datatypes compared to FLOAT). Only one descriptor can exist for each attribute.

The Attribute Target tells the game what this buffer is used for.
{| class="wikitable"
|+ Attribute Targets
|-
! Value !! Name !! Description
|-
| 0x00000009 || POSITION || This buffer represents the positions of vertices in the model. Basically required for all visual models.
|-
| 0x0000000A || NORMAL || This buffer represents vertex normals, used for the engine's vertex shading. Not needed if no material requires it.
|-
| 0x0000000B || COLOR_0 || This buffer is available for Vertex Colors.
|-
| 0x0000000C || COLOR_1 || This buffer is available for Vertex Colors.
|-
| 0x0000000D || TEXCOORD_0 || This buffer is available for Texture Coordinates.
|-
| 0x0000000E || TEXCOORD_1 || This buffer is available for Texture Coordinates.
|-
| 0x0000000F || TEXCOORD_2 || This buffer is available for Texture Coordinates.
|-
| 0x00000010 || TEXCOORD_3 || This buffer is available for Texture Coordinates.
|-
| 0x00000011 || TEXCOORD_4 || This buffer is available for Texture Coordinates.
|-
| 0x00000012 || TEXCOORD_5 || This buffer is available for Texture Coordinates.
|-
| 0x00000013 || TEXCOORD_6 || This buffer is available for Texture Coordinates.
|-
| 0x00000014 || TEXCOORD_7 || This buffer is available for Texture Coordinates.
|-
| 0x00000019 || TANGENT || ''Currently unknown exactly what goes in here.''
|-
| 0x000000FF || List End || A buffer using this target will end the descriptor list.
|}

The component count tells the game how many parts of the component that there are. Note that the values are considered based on the attribute target they're assigned to.
{| class="wikitable"
|+ Component Count
|-
! Value !! Name !! Description
|-
| 0x00000000 || POSITION_XY || ''Unknown''
|-
| 0x00000001 || POSITION_XYZ || Represents a position in 3D space with 3 values: X, Y, and Z.
|-
|colspan="3"|
|-
| 0x00000000 || NORMAL_XYZ || Represents a normal vector in 3D space with 3 values: X, Y, and Z.
|-
| 0x00000001 || NORMAL_NBT || ''Unknown''
|-
| 0x00000002 || NORMAL_NBT3 || ''Unknown''
|-
|colspan="3"|
|-
| 0x00000000 || COLOR_RGB || Represents a color value with only Red, Green, and Blue values.
|-
| 0x00000001 || COLOR_RGBA || Represents a color value with Red, Green, Blue, and Alpha values.
|-
|colspan="3"|
|-
| 0x00000000 || TEXCOORD_S || ''Unknown''
|-
| 0x00000001 || TEXCOORD_ST || Represents a UV texture coordinate with 2 values: X and Y.
|}

The Data Type tells the game how many bytes each value is, in the sense that an Int32 is 4 bytes, a Int16 is 2 bytes, a Float is 4 bytes, etc. Note that the Color values have a different set of options.
{| class="wikitable"
|+ Data Types
|-
! Value !! Name !! Description
|-
| 0x00000000 || UInt8 || 1 byte per value (0 to 255)
|-
| 0x00000001 || Int8 || 1 byte per value (-128 to 127)
|-
| 0x00000002 || UInt16 || 2 bytes per value (0 to 65535)
|-
| 0x00000003 || Int16 || 2 bytes per value (-32,768 to 32,767)
|-
| 0x00000004 || Float || 4 bytes per value
|-
|colspan="3"|
|-
| 0x00000000 || RGB565 || 2 bytes per color
|-
| 0x00000001 || RGB8 || 3 bytes per color
|-
| 0x00000002 || RGBX8 || 3 bytes per color
|-
| 0x00000003 || RGBA4 || 2 bytes per color
|-
| 0x00000004 || RGBA6 || 4 bytes per color
|-
| 0x00000005 || RGBA8 || 4 bytes per color
|}
> ''Note: Both games require colors to be 4 bytes wide at all times, so changing from RGBA8 is worthless.''

== EVP1 - Skinning Envelopes ==
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''EVP1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of Envelopes stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || "Joint Count" list offset
|-
| 0x10 || Int32 || "'Joint Count' list index" list offset
|-
| 0x14 || Int32 || "Joint Weight" list offset
|-
| 0x18 || Int32 || "Inverse Bind Matrices" list offset
|}

== DRW1 - Skinning Assignments ==

== JNT1 - Joint Hierarchy ==
The '''J'''oi'''nt''' Hierarchy section defines the rigging skeleton of a model. There can only be one skeleton per model.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''JNT1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of Joints stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || Joint Data table offset
|-
| 0x10 || Int32 || Remap table offset
|-
| 0x14 || Int32 || Name table offset0 if not present.
|}

=== Joint Data ===
Each joint includes positional data and a bounding box which is used by the game for determining rendering range automatically.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int16 || Matrix Type
|-
| 0x01 || UInt8 || Parent Scale inheritance 0 = Follow parent joint's scale 1 = Ignore parent joint's scale
|-
| 0x02 || UInt8 || Padding (0xFF)
|-
| 0x04 || Float || Scale X
|-
| 0x08 || Float || Scale Y
|-
| 0x0C || Float || Scale Z
|-
| 0x10 || Int16 || Rotation X
|-
| 0x12 || Int16 || Rotation Y
|-
| 0x14 || Int16 || Rotation Z
|-
| 0x16 || Int16 || Padding (0xFFFF)
|-
| 0x18 || Float || Translation X
|-
| 0x1C || Float || Translation Y
|-
| 0x20 || Float || Translation Z
|-
| 0x24 || Float || Bounding Sphere Should encapsulate all vertices that the joint affects
|-
| 0x28 || Float || Bounding Box Minimum X
|-
| 0x2C || Float || Bounding Box Minimum Y
|-
| 0x30 || Float || Bounding Box Minimum Z
|-
| 0x34 || Float || Bounding Box Maximum X
|-
| 0x38 || Float || Bounding Box Maximum Y
|-
| 0x3C || Float || Bounding Box Maximum Z
|}
Rotation is stored between -0x7FFF and 0x7FFF, which ranges -180 degrees and 180 degrees.

== SHP1 - Shape Information==
The '''Sh'''a'''p'''e Information section determines how to use the data in the [[#VTX1_-_Vertex_Data|VTX1]] section to create shapes.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''SHP1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of Shapes stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || Shape Init Data offset
|-
| 0x10 || Int32 || Remap table offset
|-
| 0x14 || Int32 || Name table offset (Generally not used, and thus set to 0)
|-
| 0x18 || Int32 || Vertex Index Attribute table offset
|-
| 0x1C || Int32 || Weight Index table offset
|-
| 0x20 || Int32 || Primitive Data offset
|-
| 0x24 || Int32 || Matrix Group Data offset (entry count must equal the entry count of the GXDisplayList group table)
|-
| 0x28 || Int32 || Matrix Group Definition table offset
|}

=== Shape Data ===
Each shape denotes a Matrix Calculation type, which is used for Billboarding, as well as multi-joint skinning. A shape also hosts a collection of Matrix Groups. If the geometry needs to be weighted to more than 10 [[#DRW1_-_Skinning_Assignments|DRW1]] matrices, more than one Matrix Group is needed. A single Matrix Group can have multiple Primitives in it, but these Primitives must share the same set of [[#DRW1_-_Skinning_Assignments|DRW1]] matrices.

TODO: Figure out what happens in the event that more than 10 are needed (such as one vertex being weighted to 11 bones). Is it just straight up not allowed?

{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || UInt8 || Matrix Type

* 0 = Single Joint

* 1 = Billboard Joint

* 2 = Billboard Joint (Y axis only)

* 3 = Multiple Joints
|-
| 0x01 || UInt8 || Padding (0xFF)
|-
| 0x02 || Int16 || Matrix Group count
|-
| 0x04 || Int16 || Vertex Index Attribute offset Relative to the Vertex Index Attribute Table offset defined in SHP1
|-
| 0x06 || Int16 || Matrix Group Data index
|-
| 0x08 || Int16 || First Matrix Group Definition index
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Float || Bounding Sphere
|-
| 0x10 || Float || Bounding Box Minimum X
|-
| 0x14 || Float || Bounding Box Minimum Y
|-
| 0x18 || Float || Bounding Box Minimum Z
|-
| 0x1C || Float || Bounding Box Maximum X
|-
| 0x20 || Float || Bounding Box Maximum Y
|-
| 0x24 || Float || Bounding Box Maximum Z
|}

=== Vertex Index Attribute Table ===

{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int32 || An [[#Index%20Buffer%20Formats|index buffer]] attribute target
|-
| 0x04 || Int32 || An [[#Index%20Buffer%20Formats|index buffer]] type
|}

==== Index Buffer Formats ====
Each of the Buffers in this section have a format descriptor. This allows different types of data storage, allowing for smaller files.

These attributes line up with either a direct value that is stored in the shape, or an index into a [[#VTX1_-_Vertex_Data|VTX1]] [[#Vertex%20Buffer%20Formats|data buffer]]. Only one indexer can exist for each attribute.

The Attribute Target tells the game what this index buffer is used for.
{| class="wikitable"
|+ Attribute Targets
|-
! Value !! Name !! Description
|-
| 0x00000000 || POSITION_MATRIX || This is a direct list of indices into the Matrix Group's Weight collection. Required for Shapes that use Multiple Joint skinning.
|-
| 0x00000001 || TEXTURE_0_MATRIX || ''UNKNOWN''
|-
| 0x00000002 || TEXTURE_1_MATRIX || ''UNKNOWN''
|-
| 0x00000003 || TEXTURE_2_MATRIX || ''UNKNOWN''
|-
| 0x00000004 || TEXTURE_3_MATRIX || ''UNKNOWN''
|-
| 0x00000005 || TEXTURE_4_MATRIX || ''UNKNOWN''
|-
| 0x00000006 || TEXTURE_5_MATRIX || ''UNKNOWN''
|-
| 0x00000007 || TEXTURE_6_MATRIX || ''UNKNOWN''
|-
| 0x00000008 || TEXTURE_7_MATRIX || ''UNKNOWN''
|-
| 0x00000009 || POSITION || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "POSITION" buffer. Required.
|-
| 0x0000000A || NORMAL || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "NORMAL" buffer
|-
| 0x0000000B || COLOR_0 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "COLOR_0" buffer
|-
| 0x0000000C || COLOR_1 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "COLOR_1" buffer
|-
| 0x0000000D || TEXCOORD_0 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_0" buffer
|-
| 0x0000000E || TEXCOORD_1 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_1" buffer
|-
| 0x0000000F || TEXCOORD_2 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_2" buffer
|-
| 0x00000010 || TEXCOORD_3 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_3" buffer
|-
| 0x00000011 || TEXCOORD_4 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_4" buffer
|-
| 0x00000012 || TEXCOORD_5 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_5" buffer
|-
| 0x00000013 || TEXCOORD_6 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_6" buffer
|-
| 0x00000014 || TEXCOORD_7 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_7" buffer
|-
| 0x00000019 || TANGENT || ''This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TANGENT" buffer, but we don't yet know what that buffer does.''
|-
| 0x000000FF || List End || A buffer using this target will end the descriptor list.
|}

The Data Type of an Index Buffer determines the size of each Index. Direct Buffers can only be 1 byte per value.
{| class="wikitable"
|+ Data Types
|-
! Value !! Name !! Description
|-
| 0x00000000 || None || Only used for the List End
|-
| 0x00000001 || Direct || 1 byte per value. Only used for data that is not stored within [[#VTX1_-_Vertex_Data|VTX1]] Needs to be divided by 3 for some reason...
|-
| 0x00000002 || UInt8 || 1 byte per value (0 to 255). Indexes a buffer in [[#VTX1_-_Vertex_Data|VTX1]].
|-
| 0x00000003 || UInt16 || 2 bytes per value (0 to 65535). Indexes a buffer in [[#VTX1_-_Vertex_Data|VTX1]].
|}

=== Primitive Data ===
This chunk contains raw primitives. These are what hold the index buffers. The Index Buffers are ordered the same way the Index Buffer Attributes are ordered. For example, POSITION (UInt16), NORMAL (UInt16), COLOR_0 (UInt8), TEXCOORD_0 (UInt16), would result in the following byte structure: '''PPPP NNNN C0 TXC0''' This repeats for each vertex in the primitive.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Uint8 || Primitive Type

* 0x80 = Individual Quads

* 0x90 = Individual Triangles

* 0x98 = Triangle Strip

* 0xA0 = Triangle Fan

* 0xA8 = Individual Lines

* 0xB0 = Line Strip

* 0xB8 = Individual Points

TODO: Figure out if Quads, Lines, Line Strips, and Points work. TODO: Figure out if "Quad Strips" exist at 0x88.
|-
| 0x04 || Int16 || Vertex Count
|}
Each Matrix Group's primitives are padded to the nearest 32.
TODO: Figure out if the padding is allowed to be omitted.

=== Matrix Group Definition Table ===
This table defines a list of Matrix Groups for each Shape. A Shape can have multiple Matrix Groups, but only stores the index of the first one. This means that all the Matrix Groups for a given Shape must come directly one after another. It contains only two values: The size of all Primitive Data within this group, and an offset to the first Primitive (relative to the Primitive Data offset defined in SHP1).
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int32 || Primitive Data size
|-
| 0x04 || Int32 || First Primitive offset
|}

=== Matrix Group Data Table ===
This table contains definitions of sub-segments inside the Weight Index Table. How these values are used differs based on the shape matrix calculation type, but official files generally set both usages up correctly regardless.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int16 || [[#DRW1_-_Skinning_Assignments|DRW1]] Matrix ID This is only used with Single Joint shape matrix calculation.
|-
| 0x02 || Int16 || Matrix Count This is only used with Multiple Joint shape matrix calculation.
|-
| 0x04 || Int32 || Starting Weight Index This is only used with Multiple Joint shape matrix calculation.
|}

=== Weight Index Table ===
This table contains several indices into [[#DRW1_-_Skinning_Assignments|DRW1]]. Each index is a Signed 16 value. The values may also contain 0xFFFF, which indicates that the last used index should be used instead. Matrix Groups can select a segment of these indices (up to 10) for use. A Matrix Group must not start with 0xFFFF.

== MAT2 - Material List (Old) ==
Technically supported by the game, but not known to be used by any model.

== MAT3 - Material List ==

== MDL3 - Display List ==

== TEX1 - Texture Data ==
The '''Tex'''ture Information section holds several embedded [[BTI_(File_Format)|BTI]] files that [[#MAT3_-_Material_List|MAT3]] can reference by index for texture assignment.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''TEX1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of [[BTI_(File_Format)|BTI]] files stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || [[BTI_(File_Format)|BTI]] Header Table Offset
|-
| 0x10 || Int32 || Name table offset
|}

The texture data locations are defined by the [[BTI_(File_Format)|BTI]] headers (which themselves are located directly one after another at the Header Table) 
This structure allows multiple textures that have the same visual data to have their headers point to just one block of visual data. In other words, two identical textures can be "compressed" into one while still having their own properties (wrapping, filtering, etc.)

BMD/BDL (File Format)

2025-10-22T22:54:36Z

Super Hackio: INF1 - Fixed notes on the Matrix Group Data count and Vertex count.

[[Category:File formats]]
{{WIP}}

BMD ('''B'''inary '''M'''o'''d'''el) and BDL ('''B'''inary '''D'''isplay '''L'''ist) are two 3D model formats used in ''Super Mario Galaxy'' and ''Super Mario Galaxy 2'', among a few other ''Wii'' and ''GameCube'' games, such as ''Super Mario Sunshine''.

These two formats hold the same data, except BDL contains an additional set of data which is used for faster rendering speeds.

''Super Mario Galaxy'' & ''Super Mario Galaxy 2'' contain J3DLoader versions 21 and 26.

== File Header ==
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || The magic that tells the game which format this file is. (ASCII) '''J3D2bmd2''' for BMD (J3DLoader V21) '''J3D2bmd3''' for BMD (J3DLoader v26) '''J3D2bdl4''' for BDL (J3DLoader v26)
|-
| 0x08 || Int32 || The total size of the file
|-
| 0x0C || Int32 || The number of chunks present in this file. '''8''' for BMD '''9''' for BDL
|}

=== Subversion Header ===
This part of the header is not used, and can be anything.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || A 4 character value representing the Subversion. Usually SVR3 for SMG/2.
|-
| 0x04 || Byte[12] || Twelve bytes of padding. Usually these are '''0xFF'''
|}

== INF1 - Scene Information ==
The '''Inf'''ormation section hosts a hierarchy of Joints, Materials, and Shapes, which are used to render the model.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''INF1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || [[#J3DLoader%20Flags|J3DLoader Flags]]
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || Matrix Group Data Count Referring to the Matrix Group Data in [[#SHP1_-_Shape_Information|SHP1]] Stored in a variable by the game, but not used to dictate the actual number of Matrix Groups.
|-
| 0x10 || Int32 || Vertex Count Always equals the number of entries in the [[#VTX1_-_Vertex_Data|VTX1]] "POSITION" [[#Vertex%20Buffer%20Formats|data buffer]] Stored in a variable by the game, but never used for anything. The game reads Vertex Data directly from the [[#Vertex%20Buffer%20Formats|data buffer]]s without bounds checking.
|-
| 0x14 || Int32 || Relative offset to the [[#Scene%20Hierarchy|Scene Hierarchy]]
|}

=== J3DLoader Flags ===
The J3DLoader contains several flags which affect how models are handled. There are more than what are shown here, however, those must be applied by the game itself in the code.
{| class="wikitable"
|-
! Value !! Description
|-
| 0b0000000000000000 || No flags applied (TODO: Check if this defaults to basic matrix calculation)
|-
| 0b0000000000000001 || Use Autodesk Softimage matrix calculation
|-
| 0b0000000000000010 || Use Autodesk Maya matrix calculation
|-
| 0b0000000000000100 || Use Basic matrix calculation
|-
| 0b0000000000001000 || ''UNKNOWN''
|-
| 0b0000000000010000 || UseImmidiateMtx (needs research)
|-
| 0b0000000000100000 || UsePostTexMtx (needs research)
|-
| 0b0000000001000000 || ''UNKNOWN''
|-
| 0b0000000010000000 || ''UNKNOWN''
|-
| 0b0000000100000000 || NoMatrixTransform (needs research)
|-
| 0b0000001000000000 || ''UNKNOWN''
|-
| 0b0000010000000000 || ''UNKNOWN''
|-
| 0b0000100000000000 || ''UNKNOWN''
|-
| 0b0001000000000000 || ''UNKNOWN''
|-
| 0b0010000000000000 || DoBdlMaterialCalc
|-
| 0b0100000000000000 || NoBdlMaterialPatch - If set, skips the call to '''J3DModelLoader::readPatchedMaterial'''.
|-
| 0b1000000000000000 || ''UNKNOWN''
|}
For all BMD files, the game always includes load flags ''Material_PE_Full'', ''Material_UseIndirect'', ''UseUniqueMaterials'', and ''UNKNOWN_21''. 
For all BDL files, the game always includes load flags ''Material_UseIndirect'', and ''UseUniqueMaterials''.

> ''Note: Changing the load flags by changing the code doesn't seem to do much.''

=== Scene Hierarchy ===
Each model is constructed using a Scene Hierarchy. This simply determines the order of bones (in turn, defining the parent/child relations), material assignments, and Shape assignments.

Each node consists of the following:
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || UInt16 || Node Type. 0x00 = Marks the end of the node list 0x01 = Creates a new child of the previous node 0x02 = Finishes the child node and returns ownership to the previous node 0x10 = Joint Assignment node. "Data" holds the Joint ID (index into JNT1) 0x11 = Material assignment. "Data" holds the Material ID (index into MAT3) 0x12 = Shape Assignment. "Data" holds the Shape ID (index into SHP1)
|-
| 0x02 || UInt16 || A Data value. Used by some nodes to index into other chunks. Usage depends on the node type.
|}

The node list is padded to the nearest 32.

== VTX1 - Vertex Data ==
The '''V'''er'''t'''e'''x''' Data section contains the actual number values used for the properties of the geometry. It also includes the information on how the values are formatted.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''VTX1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int32 || Buffer Format list offset
|-
| 0x0C || Int32 || "POSITION" data buffer offset 0 if not used.
|-
| 0x10 || Int32 || "NORMAL" data buffer offset 0 if not used.
|-
| 0x14 || Int32 || "TANGENT" data buffer offset 0 if not used.
|-
| 0x18 || Int32 || "COLOR_0" data buffer offset 0 if not used.
|-
| 0x1C || Int32 || "COLOR_1" data buffer offset 0 if not used.
|-
| 0x20 || Int32 || "TEXCOORD_0" data buffer offset 0 if not used.
|-
| 0x24 || Int32 || "TEXCOORD_1" data buffer offset 0 if not used.
|-
| 0x28 || Int32 || "TEXCOORD_2" data buffer offset 0 if not used.
|-
| 0x2C || Int32 || "TEXCOORD_3" data buffer offset 0 if not used.
|-
| 0x30 || Int32 || "TEXCOORD_4" data buffer offset 0 if not used.
|-
| 0x34 || Int32 || "TEXCOORD_5" data buffer offset 0 if not used.
|-
| 0x38 || Int32 || "TEXCOORD_6" data buffer offset 0 if not used.
|-
| 0x3C || Int32 || "TEXCOORD_7" data buffer offset 0 if not used.
|}

=== Vertex Buffer Formats ===
Each of the Buffers in this section have a format descriptor. This allows different types of data storage, allowing for smaller files.

Each format descriptor contains an Attribute Target, a Component Count, a Data Type, and a Mantissa shifter (to allow floats to be stored as smaller datatypes compared to FLOAT). Only one descriptor can exist for each attribute.

The Attribute Target tells the game what this buffer is used for.
{| class="wikitable"
|+ Attribute Targets
|-
! Value !! Name !! Description
|-
| 0x00000009 || POSITION || This buffer represents the positions of vertices in the model. Basically required for all visual models.
|-
| 0x0000000A || NORMAL || This buffer represents vertex normals, used for the engine's vertex shading. Not needed if no material requires it.
|-
| 0x0000000B || COLOR_0 || This buffer is available for Vertex Colors.
|-
| 0x0000000C || COLOR_1 || This buffer is available for Vertex Colors.
|-
| 0x0000000D || TEXCOORD_0 || This buffer is available for Texture Coordinates.
|-
| 0x0000000E || TEXCOORD_1 || This buffer is available for Texture Coordinates.
|-
| 0x0000000F || TEXCOORD_2 || This buffer is available for Texture Coordinates.
|-
| 0x00000010 || TEXCOORD_3 || This buffer is available for Texture Coordinates.
|-
| 0x00000011 || TEXCOORD_4 || This buffer is available for Texture Coordinates.
|-
| 0x00000012 || TEXCOORD_5 || This buffer is available for Texture Coordinates.
|-
| 0x00000013 || TEXCOORD_6 || This buffer is available for Texture Coordinates.
|-
| 0x00000014 || TEXCOORD_7 || This buffer is available for Texture Coordinates.
|-
| 0x00000019 || TANGENT || ''Currently unknown exactly what goes in here.''
|-
| 0x000000FF || List End || A buffer using this target will end the descriptor list.
|}

The component count tells the game how many parts of the component that there are. Note that the values are considered based on the attribute target they're assigned to.
{| class="wikitable"
|+ Component Count
|-
! Value !! Name !! Description
|-
| 0x00000000 || POSITION_XY || ''Unknown''
|-
| 0x00000001 || POSITION_XYZ || Represents a position in 3D space with 3 values: X, Y, and Z.
|-
|colspan="3"|
|-
| 0x00000000 || NORMAL_XYZ || Represents a normal vector in 3D space with 3 values: X, Y, and Z.
|-
| 0x00000001 || NORMAL_NBT || ''Unknown''
|-
| 0x00000002 || NORMAL_NBT3 || ''Unknown''
|-
|colspan="3"|
|-
| 0x00000000 || COLOR_RGB || Represents a color value with only Red, Green, and Blue values.
|-
| 0x00000001 || COLOR_RGBA || Represents a color value with Red, Green, Blue, and Alpha values.
|-
|colspan="3"|
|-
| 0x00000000 || TEXCOORD_S || ''Unknown''
|-
| 0x00000001 || TEXCOORD_ST || Represents a UV texture coordinate with 2 values: X and Y.
|}

The Data Type tells the game how many bytes each value is, in the sense that an Int32 is 4 bytes, a Int16 is 2 bytes, a Float is 4 bytes, etc. Note that the Color values have a different set of options.
{| class="wikitable"
|+ Data Types
|-
! Value !! Name !! Description
|-
| 0x00000000 || UInt8 || 1 byte per value (0 to 255)
|-
| 0x00000001 || Int8 || 1 byte per value (-128 to 127)
|-
| 0x00000002 || UInt16 || 2 bytes per value (0 to 65535)
|-
| 0x00000003 || Int16 || 2 bytes per value (-32,768 to 32,767)
|-
| 0x00000004 || Float || 4 bytes per value
|-
|colspan="3"|
|-
| 0x00000000 || RGB565 || 2 bytes per color
|-
| 0x00000001 || RGB8 || 3 bytes per color
|-
| 0x00000002 || RGBX8 || 3 bytes per color
|-
| 0x00000003 || RGBA4 || 2 bytes per color
|-
| 0x00000004 || RGBA6 || 4 bytes per color
|-
| 0x00000005 || RGBA8 || 4 bytes per color
|}
> ''Note: Both games require colors to be 4 bytes wide at all times, so changing from RGBA8 is worthless.''

== EVP1 - Skinning Envelopes ==
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''EVP1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of Envelopes stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || "Joint Count" list offset
|-
| 0x10 || Int32 || "'Joint Count' list index" list offset
|-
| 0x14 || Int32 || "Joint Weight" list offset
|-
| 0x18 || Int32 || "Inverse Bind Matrices" list offset
|}

== DRW1 - Skinning Assignments ==

== JNT1 - Joint Hierarchy ==
The '''J'''oi'''nt''' Hierarchy section defines the rigging skeleton of a model. There can only be one skeleton per model.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''JNT1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of Joints stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || Joint Data table offset
|-
| 0x10 || Int32 || Remap table offset
|-
| 0x14 || Int32 || Name table offset
|}

=== Joint Data ===
Each joint includes positional data and a bounding box which is used by the game for determining rendering range automatically.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int16 || Matrix Type
|-
| 0x01 || UInt8 || Parent Scale inheritance 0 = Follow parent joint's scale 1 = Ignore parent joint's scale
|-
| 0x02 || UInt8 || Padding (0xFF)
|-
| 0x04 || Float || Scale X
|-
| 0x08 || Float || Scale Y
|-
| 0x0C || Float || Scale Z
|-
| 0x10 || Int16 || Rotation X
|-
| 0x12 || Int16 || Rotation Y
|-
| 0x14 || Int16 || Rotation Z
|-
| 0x16 || Int16 || Padding (0xFFFF)
|-
| 0x18 || Float || Translation X
|-
| 0x1C || Float || Translation Y
|-
| 0x20 || Float || Translation Z
|-
| 0x24 || Float || Bounding Sphere Should encapsulate all vertices that the joint affects
|-
| 0x28 || Float || Bounding Box Minimum X
|-
| 0x2C || Float || Bounding Box Minimum Y
|-
| 0x30 || Float || Bounding Box Minimum Z
|-
| 0x34 || Float || Bounding Box Maximum X
|-
| 0x38 || Float || Bounding Box Maximum Y
|-
| 0x3C || Float || Bounding Box Maximum Z
|}
Rotation is stored between -0x7FFF and 0x7FFF, which ranges -180 degrees and 180 degrees.

== SHP1 - Shape Information==
The '''Sh'''a'''p'''e Information section determines how to use the data in the [[#VTX1_-_Vertex_Data|VTX1]] section to create shapes.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''SHP1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of Shapes stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || Shape Init Data offset
|-
| 0x10 || Int32 || Remap table offset
|-
| 0x14 || Int32 || Name table offset (Generally not used, and thus set to 0)
|-
| 0x18 || Int32 || Vertex Index Attribute table offset
|-
| 0x1C || Int32 || Weight Index table offset
|-
| 0x20 || Int32 || Primitive Data offset
|-
| 0x24 || Int32 || Matrix Group Data offset (entry count must equal the entry count of the GXDisplayList group table)
|-
| 0x28 || Int32 || Matrix Group Definition table offset
|}

=== Shape Data ===
Each shape denotes a Matrix Calculation type, which is used for Billboarding, as well as multi-joint skinning. A shape also hosts a collection of Matrix Groups. If the geometry needs to be weighted to more than 10 [[#DRW1_-_Skinning_Assignments|DRW1]] matrices, more than one Matrix Group is needed. A single Matrix Group can have multiple Primitives in it, but these Primitives must share the same set of [[#DRW1_-_Skinning_Assignments|DRW1]] matrices.

TODO: Figure out what happens in the event that more than 10 are needed (such as one vertex being weighted to 11 bones). Is it just straight up not allowed?

{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || UInt8 || Matrix Type

* 0 = Single Joint

* 1 = Billboard Joint

* 2 = Billboard Joint (Y axis only)

* 3 = Multiple Joints
|-
| 0x01 || UInt8 || Padding (0xFF)
|-
| 0x02 || Int16 || Matrix Group count
|-
| 0x04 || Int16 || Vertex Index Attribute offset Relative to the Vertex Index Attribute Table offset defined in SHP1
|-
| 0x06 || Int16 || Matrix Group Data index
|-
| 0x08 || Int16 || First Matrix Group Definition index
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Float || Bounding Sphere
|-
| 0x10 || Float || Bounding Box Minimum X
|-
| 0x14 || Float || Bounding Box Minimum Y
|-
| 0x18 || Float || Bounding Box Minimum Z
|-
| 0x1C || Float || Bounding Box Maximum X
|-
| 0x20 || Float || Bounding Box Maximum Y
|-
| 0x24 || Float || Bounding Box Maximum Z
|}

=== Vertex Index Attribute Table ===

{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int32 || An [[#Index%20Buffer%20Formats|index buffer]] attribute target
|-
| 0x04 || Int32 || An [[#Index%20Buffer%20Formats|index buffer]] type
|}

==== Index Buffer Formats ====
Each of the Buffers in this section have a format descriptor. This allows different types of data storage, allowing for smaller files.

These attributes line up with either a direct value that is stored in the shape, or an index into a [[#VTX1_-_Vertex_Data|VTX1]] [[#Vertex%20Buffer%20Formats|data buffer]]. Only one indexer can exist for each attribute.

The Attribute Target tells the game what this index buffer is used for.
{| class="wikitable"
|+ Attribute Targets
|-
! Value !! Name !! Description
|-
| 0x00000000 || POSITION_MATRIX || This is a direct list of indices into the Matrix Group's Weight collection. Required for Shapes that use Multiple Joint skinning.
|-
| 0x00000001 || TEXTURE_0_MATRIX || ''UNKNOWN''
|-
| 0x00000002 || TEXTURE_1_MATRIX || ''UNKNOWN''
|-
| 0x00000003 || TEXTURE_2_MATRIX || ''UNKNOWN''
|-
| 0x00000004 || TEXTURE_3_MATRIX || ''UNKNOWN''
|-
| 0x00000005 || TEXTURE_4_MATRIX || ''UNKNOWN''
|-
| 0x00000006 || TEXTURE_5_MATRIX || ''UNKNOWN''
|-
| 0x00000007 || TEXTURE_6_MATRIX || ''UNKNOWN''
|-
| 0x00000008 || TEXTURE_7_MATRIX || ''UNKNOWN''
|-
| 0x00000009 || POSITION || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "POSITION" buffer. Required.
|-
| 0x0000000A || NORMAL || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "NORMAL" buffer
|-
| 0x0000000B || COLOR_0 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "COLOR_0" buffer
|-
| 0x0000000C || COLOR_1 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "COLOR_1" buffer
|-
| 0x0000000D || TEXCOORD_0 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_0" buffer
|-
| 0x0000000E || TEXCOORD_1 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_1" buffer
|-
| 0x0000000F || TEXCOORD_2 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_2" buffer
|-
| 0x00000010 || TEXCOORD_3 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_3" buffer
|-
| 0x00000011 || TEXCOORD_4 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_4" buffer
|-
| 0x00000012 || TEXCOORD_5 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_5" buffer
|-
| 0x00000013 || TEXCOORD_6 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_6" buffer
|-
| 0x00000014 || TEXCOORD_7 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_7" buffer
|-
| 0x00000019 || TANGENT || ''This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TANGENT" buffer, but we don't yet know what that buffer does.''
|-
| 0x000000FF || List End || A buffer using this target will end the descriptor list.
|}

The Data Type of an Index Buffer determines the size of each Index. Direct Buffers can only be 1 byte per value.
{| class="wikitable"
|+ Data Types
|-
! Value !! Name !! Description
|-
| 0x00000000 || None || Only used for the List End
|-
| 0x00000001 || Direct || 1 byte per value. Only used for data that is not stored within [[#VTX1_-_Vertex_Data|VTX1]] Needs to be divided by 3 for some reason...
|-
| 0x00000002 || UInt8 || 1 byte per value (0 to 255). Indexes a buffer in [[#VTX1_-_Vertex_Data|VTX1]].
|-
| 0x00000003 || UInt16 || 2 bytes per value (0 to 65535). Indexes a buffer in [[#VTX1_-_Vertex_Data|VTX1]].
|}

=== Primitive Data ===
This chunk contains raw primitives. These are what hold the index buffers. The Index Buffers are ordered the same way the Index Buffer Attributes are ordered. For example, POSITION (UInt16), NORMAL (UInt16), COLOR_0 (UInt8), TEXCOORD_0 (UInt16), would result in the following byte structure: '''PPPP NNNN C0 TXC0''' This repeats for each vertex in the primitive.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Uint8 || Primitive Type

* 0x80 = Individual Quads

* 0x90 = Individual Triangles

* 0x98 = Triangle Strip

* 0xA0 = Triangle Fan

* 0xA8 = Individual Lines

* 0xB0 = Line Strip

* 0xB8 = Individual Points

TODO: Figure out if Quads, Lines, Line Strips, and Points work. TODO: Figure out if "Quad Strips" exist at 0x88.
|-
| 0x04 || Int16 || Vertex Count
|}
Each Matrix Group's primitives are padded to the nearest 32.
TODO: Figure out if the padding is allowed to be omitted.

=== Matrix Group Definition Table ===
This table defines a list of Matrix Groups for each Shape. A Shape can have multiple Matrix Groups, but only stores the index of the first one. This means that all the Matrix Groups for a given Shape must come directly one after another. It contains only two values: The size of all Primitive Data within this group, and an offset to the first Primitive (relative to the Primitive Data offset defined in SHP1).
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int32 || Primitive Data size
|-
| 0x04 || Int32 || First Primitive offset
|}

=== Matrix Group Data Table ===
This table contains definitions of sub-segments inside the Weight Index Table. How these values are used differs based on the shape matrix calculation type, but official files generally set both usages up correctly regardless.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int16 || [[#DRW1_-_Skinning_Assignments|DRW1]] Matrix ID This is only used with Single Joint shape matrix calculation.
|-
| 0x02 || Int16 || Matrix Count This is only used with Multiple Joint shape matrix calculation.
|-
| 0x04 || Int32 || Starting Weight Index This is only used with Multiple Joint shape matrix calculation.
|}

=== Weight Index Table ===
This table contains several indices into [[#DRW1_-_Skinning_Assignments|DRW1]]. Each index is a Signed 16 value. The values may also contain 0xFFFF, which indicates that the last used index should be used instead. Matrix Groups can select a segment of these indices (up to 10) for use. A Matrix Group must not start with 0xFFFF.

== MAT2 - Material List (Old) ==
Technically supported by the game, but not known to be used by any model.

== MAT3 - Material List ==

== MDL3 - Display List ==

== TEX1 - Texture Data ==
The '''Tex'''ture Information section holds several embedded [[BTI_(File_Format)|BTI]] files that [[#MAT3_-_Material_List|MAT3]] can reference by index for texture assignment.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''TEX1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of [[BTI_(File_Format)|BTI]] files stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || [[BTI_(File_Format)|BTI]] Header Table Offset
|-
| 0x10 || Int32 || Name table offset
|}

The texture data locations are defined by the [[BTI_(File_Format)|BTI]] headers (which themselves are located directly one after another at the Header Table) 
This structure allows multiple textures that have the same visual data to have their headers point to just one block of visual data. In other words, two identical textures can be "compressed" into one while still having their own properties (wrapping, filtering, etc.)

BMD/BDL (File Format)

2025-10-22T22:25:31Z

Super Hackio: INF1 - Matrix Group Count and POSITION data buffer sizes are purely informative and ignored by the game upon load.

[[Category:File formats]]
{{WIP}}

BMD ('''B'''inary '''M'''o'''d'''el) and BDL ('''B'''inary '''D'''isplay '''L'''ist) are two 3D model formats used in ''Super Mario Galaxy'' and ''Super Mario Galaxy 2'', among a few other ''Wii'' and ''GameCube'' games, such as ''Super Mario Sunshine''.

These two formats hold the same data, except BDL contains an additional set of data which is used for faster rendering speeds.

''Super Mario Galaxy'' & ''Super Mario Galaxy 2'' contain J3DLoader versions 21 and 26.

== File Header ==
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || The magic that tells the game which format this file is. (ASCII) '''J3D2bmd2''' for BMD (J3DLoader V21) '''J3D2bmd3''' for BMD (J3DLoader v26) '''J3D2bdl4''' for BDL (J3DLoader v26)
|-
| 0x08 || Int32 || The total size of the file
|-
| 0x0C || Int32 || The number of chunks present in this file. '''8''' for BMD '''9''' for BDL
|}

=== Subversion Header ===
This part of the header is not used, and can be anything.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || A 4 character value representing the Subversion. Usually SVR3 for SMG/2.
|-
| 0x04 || Byte[12] || Twelve bytes of padding. Usually these are '''0xFF'''
|}

== INF1 - Scene Information ==
The '''Inf'''ormation section hosts a hierarchy of Joints, Materials, and Shapes, which are used to render the model.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''INF1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || [[#J3DLoader%20Flags|J3DLoader Flags]]
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || Matrix Group Data Count Referring to the Matrix Group Data in [[#SHP1_-_Shape_Information|SHP1]] Ignored by the game. Seems to only be informative.
|-
| 0x10 || Int32 || Vertex Count Always equals the number of entries in the [[#VTX1_-_Vertex_Data|VTX1]] "POSITION" [[#Vertex%20Buffer%20Formats|data buffer]] Ignored by the game. Seems to only be informative.
|-
| 0x14 || Int32 || Relative offset to the [[#Scene%20Hierarchy|Scene Hierarchy]]
|}

=== J3DLoader Flags ===
The J3DLoader contains several flags which affect how models are handled. There are more than what are shown here, however, those must be applied by the game itself in the code.
{| class="wikitable"
|-
! Value !! Description
|-
| 0b0000000000000000 || No flags applied (TODO: Check if this defaults to basic matrix calculation)
|-
| 0b0000000000000001 || Use Autodesk Softimage matrix calculation
|-
| 0b0000000000000010 || Use Autodesk Maya matrix calculation
|-
| 0b0000000000000100 || Use Basic matrix calculation
|-
| 0b0000000000001000 || ''UNKNOWN''
|-
| 0b0000000000010000 || UseImmidiateMtx (needs research)
|-
| 0b0000000000100000 || UsePostTexMtx (needs research)
|-
| 0b0000000001000000 || ''UNKNOWN''
|-
| 0b0000000010000000 || ''UNKNOWN''
|-
| 0b0000000100000000 || NoMatrixTransform (needs research)
|-
| 0b0000001000000000 || ''UNKNOWN''
|-
| 0b0000010000000000 || ''UNKNOWN''
|-
| 0b0000100000000000 || ''UNKNOWN''
|-
| 0b0001000000000000 || ''UNKNOWN''
|-
| 0b0010000000000000 || DoBdlMaterialCalc
|-
| 0b0100000000000000 || NoBdlMaterialPatch - If set, skips the call to '''J3DModelLoader::readPatchedMaterial'''.
|-
| 0b1000000000000000 || ''UNKNOWN''
|}
For all BMD files, the game always includes load flags ''Material_PE_Full'', ''Material_UseIndirect'', ''UseUniqueMaterials'', and ''UNKNOWN_21''. 
For all BDL files, the game always includes load flags ''Material_UseIndirect'', and ''UseUniqueMaterials''.

> ''Note: Changing the load flags by changing the code doesn't seem to do much.''

=== Scene Hierarchy ===
Each model is constructed using a Scene Hierarchy. This simply determines the order of bones (in turn, defining the parent/child relations), material assignments, and Shape assignments.

Each node consists of the following:
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || UInt16 || Node Type. 0x00 = Marks the end of the node list 0x01 = Creates a new child of the previous node 0x02 = Finishes the child node and returns ownership to the previous node 0x10 = Joint Assignment node. "Data" holds the Joint ID (index into JNT1) 0x11 = Material assignment. "Data" holds the Material ID (index into MAT3) 0x12 = Shape Assignment. "Data" holds the Shape ID (index into SHP1)
|-
| 0x02 || UInt16 || A Data value. Used by some nodes to index into other chunks. Usage depends on the node type.
|}

The node list is padded to the nearest 32.

== VTX1 - Vertex Data ==
The '''V'''er'''t'''e'''x''' Data section contains the actual number values used for the properties of the geometry. It also includes the information on how the values are formatted.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''VTX1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int32 || Buffer Format list offset
|-
| 0x0C || Int32 || "POSITION" data buffer offset 0 if not used.
|-
| 0x10 || Int32 || "NORMAL" data buffer offset 0 if not used.
|-
| 0x14 || Int32 || "TANGENT" data buffer offset 0 if not used.
|-
| 0x18 || Int32 || "COLOR_0" data buffer offset 0 if not used.
|-
| 0x1C || Int32 || "COLOR_1" data buffer offset 0 if not used.
|-
| 0x20 || Int32 || "TEXCOORD_0" data buffer offset 0 if not used.
|-
| 0x24 || Int32 || "TEXCOORD_1" data buffer offset 0 if not used.
|-
| 0x28 || Int32 || "TEXCOORD_2" data buffer offset 0 if not used.
|-
| 0x2C || Int32 || "TEXCOORD_3" data buffer offset 0 if not used.
|-
| 0x30 || Int32 || "TEXCOORD_4" data buffer offset 0 if not used.
|-
| 0x34 || Int32 || "TEXCOORD_5" data buffer offset 0 if not used.
|-
| 0x38 || Int32 || "TEXCOORD_6" data buffer offset 0 if not used.
|-
| 0x3C || Int32 || "TEXCOORD_7" data buffer offset 0 if not used.
|}

=== Vertex Buffer Formats ===
Each of the Buffers in this section have a format descriptor. This allows different types of data storage, allowing for smaller files.

Each format descriptor contains an Attribute Target, a Component Count, a Data Type, and a Mantissa shifter (to allow floats to be stored as smaller datatypes compared to FLOAT). Only one descriptor can exist for each attribute.

The Attribute Target tells the game what this buffer is used for.
{| class="wikitable"
|+ Attribute Targets
|-
! Value !! Name !! Description
|-
| 0x00000009 || POSITION || This buffer represents the positions of vertices in the model. Basically required for all visual models.
|-
| 0x0000000A || NORMAL || This buffer represents vertex normals, used for the engine's vertex shading. Not needed if no material requires it.
|-
| 0x0000000B || COLOR_0 || This buffer is available for Vertex Colors.
|-
| 0x0000000C || COLOR_1 || This buffer is available for Vertex Colors.
|-
| 0x0000000D || TEXCOORD_0 || This buffer is available for Texture Coordinates.
|-
| 0x0000000E || TEXCOORD_1 || This buffer is available for Texture Coordinates.
|-
| 0x0000000F || TEXCOORD_2 || This buffer is available for Texture Coordinates.
|-
| 0x00000010 || TEXCOORD_3 || This buffer is available for Texture Coordinates.
|-
| 0x00000011 || TEXCOORD_4 || This buffer is available for Texture Coordinates.
|-
| 0x00000012 || TEXCOORD_5 || This buffer is available for Texture Coordinates.
|-
| 0x00000013 || TEXCOORD_6 || This buffer is available for Texture Coordinates.
|-
| 0x00000014 || TEXCOORD_7 || This buffer is available for Texture Coordinates.
|-
| 0x00000019 || TANGENT || ''Currently unknown exactly what goes in here.''
|-
| 0x000000FF || List End || A buffer using this target will end the descriptor list.
|}

The component count tells the game how many parts of the component that there are. Note that the values are considered based on the attribute target they're assigned to.
{| class="wikitable"
|+ Component Count
|-
! Value !! Name !! Description
|-
| 0x00000000 || POSITION_XY || ''Unknown''
|-
| 0x00000001 || POSITION_XYZ || Represents a position in 3D space with 3 values: X, Y, and Z.
|-
|colspan="3"|
|-
| 0x00000000 || NORMAL_XYZ || Represents a normal vector in 3D space with 3 values: X, Y, and Z.
|-
| 0x00000001 || NORMAL_NBT || ''Unknown''
|-
| 0x00000002 || NORMAL_NBT3 || ''Unknown''
|-
|colspan="3"|
|-
| 0x00000000 || COLOR_RGB || Represents a color value with only Red, Green, and Blue values.
|-
| 0x00000001 || COLOR_RGBA || Represents a color value with Red, Green, Blue, and Alpha values.
|-
|colspan="3"|
|-
| 0x00000000 || TEXCOORD_S || ''Unknown''
|-
| 0x00000001 || TEXCOORD_ST || Represents a UV texture coordinate with 2 values: X and Y.
|}

The Data Type tells the game how many bytes each value is, in the sense that an Int32 is 4 bytes, a Int16 is 2 bytes, a Float is 4 bytes, etc. Note that the Color values have a different set of options.
{| class="wikitable"
|+ Data Types
|-
! Value !! Name !! Description
|-
| 0x00000000 || UInt8 || 1 byte per value (0 to 255)
|-
| 0x00000001 || Int8 || 1 byte per value (-128 to 127)
|-
| 0x00000002 || UInt16 || 2 bytes per value (0 to 65535)
|-
| 0x00000003 || Int16 || 2 bytes per value (-32,768 to 32,767)
|-
| 0x00000004 || Float || 4 bytes per value
|-
|colspan="3"|
|-
| 0x00000000 || RGB565 || 2 bytes per color
|-
| 0x00000001 || RGB8 || 3 bytes per color
|-
| 0x00000002 || RGBX8 || 3 bytes per color
|-
| 0x00000003 || RGBA4 || 2 bytes per color
|-
| 0x00000004 || RGBA6 || 4 bytes per color
|-
| 0x00000005 || RGBA8 || 4 bytes per color
|}
> ''Note: Both games require colors to be 4 bytes wide at all times, so changing from RGBA8 is worthless.''

== EVP1 - Skinning Envelopes ==
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''EVP1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of Envelopes stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || "Joint Count" list offset
|-
| 0x10 || Int32 || "'Joint Count' list index" list offset
|-
| 0x14 || Int32 || "Joint Weight" list offset
|-
| 0x18 || Int32 || "Inverse Bind Matrices" list offset
|}

== DRW1 - Skinning Assignments ==

== JNT1 - Joint Hierarchy ==
The '''J'''oi'''nt''' Hierarchy section defines the rigging skeleton of a model. There can only be one skeleton per model.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''JNT1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of Joints stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || Joint Data table offset
|-
| 0x10 || Int32 || Remap table offset
|-
| 0x14 || Int32 || Name table offset
|}

=== Joint Data ===
Each joint includes positional data and a bounding box which is used by the game for determining rendering range automatically.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int16 || Matrix Type
|-
| 0x01 || UInt8 || Parent Scale inheritance 0 = Follow parent joint's scale 1 = Ignore parent joint's scale
|-
| 0x02 || UInt8 || Padding (0xFF)
|-
| 0x04 || Float || Scale X
|-
| 0x08 || Float || Scale Y
|-
| 0x0C || Float || Scale Z
|-
| 0x10 || Int16 || Rotation X
|-
| 0x12 || Int16 || Rotation Y
|-
| 0x14 || Int16 || Rotation Z
|-
| 0x16 || Int16 || Padding (0xFFFF)
|-
| 0x18 || Float || Translation X
|-
| 0x1C || Float || Translation Y
|-
| 0x20 || Float || Translation Z
|-
| 0x24 || Float || Bounding Sphere Should encapsulate all vertices that the joint affects
|-
| 0x28 || Float || Bounding Box Minimum X
|-
| 0x2C || Float || Bounding Box Minimum Y
|-
| 0x30 || Float || Bounding Box Minimum Z
|-
| 0x34 || Float || Bounding Box Maximum X
|-
| 0x38 || Float || Bounding Box Maximum Y
|-
| 0x3C || Float || Bounding Box Maximum Z
|}
Rotation is stored between -0x7FFF and 0x7FFF, which ranges -180 degrees and 180 degrees.

== SHP1 - Shape Information==
The '''Sh'''a'''p'''e Information section determines how to use the data in the [[#VTX1_-_Vertex_Data|VTX1]] section to create shapes.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''SHP1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of Shapes stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || Shape Init Data offset
|-
| 0x10 || Int32 || Remap table offset
|-
| 0x14 || Int32 || Name table offset (Generally not used, and thus set to 0)
|-
| 0x18 || Int32 || Vertex Index Attribute table offset
|-
| 0x1C || Int32 || Weight Index table offset
|-
| 0x20 || Int32 || Primitive Data offset
|-
| 0x24 || Int32 || Matrix Group Data offset (entry count must equal the entry count of the GXDisplayList group table)
|-
| 0x28 || Int32 || Matrix Group Definition table offset
|}

=== Shape Data ===
Each shape denotes a Matrix Calculation type, which is used for Billboarding, as well as multi-joint skinning. A shape also hosts a collection of Matrix Groups. If the geometry needs to be weighted to more than 10 [[#DRW1_-_Skinning_Assignments|DRW1]] matrices, more than one Matrix Group is needed. A single Matrix Group can have multiple Primitives in it, but these Primitives must share the same set of [[#DRW1_-_Skinning_Assignments|DRW1]] matrices.

TODO: Figure out what happens in the event that more than 10 are needed (such as one vertex being weighted to 11 bones). Is it just straight up not allowed?

{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || UInt8 || Matrix Type

* 0 = Single Joint

* 1 = Billboard Joint

* 2 = Billboard Joint (Y axis only)

* 3 = Multiple Joints
|-
| 0x01 || UInt8 || Padding (0xFF)
|-
| 0x02 || Int16 || Matrix Group count
|-
| 0x04 || Int16 || Vertex Index Attribute offset Relative to the Vertex Index Attribute Table offset defined in SHP1
|-
| 0x06 || Int16 || Matrix Group Data index
|-
| 0x08 || Int16 || First Matrix Group Definition index
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Float || Bounding Sphere
|-
| 0x10 || Float || Bounding Box Minimum X
|-
| 0x14 || Float || Bounding Box Minimum Y
|-
| 0x18 || Float || Bounding Box Minimum Z
|-
| 0x1C || Float || Bounding Box Maximum X
|-
| 0x20 || Float || Bounding Box Maximum Y
|-
| 0x24 || Float || Bounding Box Maximum Z
|}

=== Vertex Index Attribute Table ===

{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int32 || An [[#Index%20Buffer%20Formats|index buffer]] attribute target
|-
| 0x04 || Int32 || An [[#Index%20Buffer%20Formats|index buffer]] type
|}

==== Index Buffer Formats ====
Each of the Buffers in this section have a format descriptor. This allows different types of data storage, allowing for smaller files.

These attributes line up with either a direct value that is stored in the shape, or an index into a [[#VTX1_-_Vertex_Data|VTX1]] [[#Vertex%20Buffer%20Formats|data buffer]]. Only one indexer can exist for each attribute.

The Attribute Target tells the game what this index buffer is used for.
{| class="wikitable"
|+ Attribute Targets
|-
! Value !! Name !! Description
|-
| 0x00000000 || POSITION_MATRIX || This is a direct list of indices into the Matrix Group's Weight collection. Required for Shapes that use Multiple Joint skinning.
|-
| 0x00000001 || TEXTURE_0_MATRIX || ''UNKNOWN''
|-
| 0x00000002 || TEXTURE_1_MATRIX || ''UNKNOWN''
|-
| 0x00000003 || TEXTURE_2_MATRIX || ''UNKNOWN''
|-
| 0x00000004 || TEXTURE_3_MATRIX || ''UNKNOWN''
|-
| 0x00000005 || TEXTURE_4_MATRIX || ''UNKNOWN''
|-
| 0x00000006 || TEXTURE_5_MATRIX || ''UNKNOWN''
|-
| 0x00000007 || TEXTURE_6_MATRIX || ''UNKNOWN''
|-
| 0x00000008 || TEXTURE_7_MATRIX || ''UNKNOWN''
|-
| 0x00000009 || POSITION || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "POSITION" buffer. Required.
|-
| 0x0000000A || NORMAL || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "NORMAL" buffer
|-
| 0x0000000B || COLOR_0 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "COLOR_0" buffer
|-
| 0x0000000C || COLOR_1 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "COLOR_1" buffer
|-
| 0x0000000D || TEXCOORD_0 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_0" buffer
|-
| 0x0000000E || TEXCOORD_1 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_1" buffer
|-
| 0x0000000F || TEXCOORD_2 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_2" buffer
|-
| 0x00000010 || TEXCOORD_3 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_3" buffer
|-
| 0x00000011 || TEXCOORD_4 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_4" buffer
|-
| 0x00000012 || TEXCOORD_5 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_5" buffer
|-
| 0x00000013 || TEXCOORD_6 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_6" buffer
|-
| 0x00000014 || TEXCOORD_7 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_7" buffer
|-
| 0x00000019 || TANGENT || ''This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TANGENT" buffer, but we don't yet know what that buffer does.''
|-
| 0x000000FF || List End || A buffer using this target will end the descriptor list.
|}

The Data Type of an Index Buffer determines the size of each Index. Direct Buffers can only be 1 byte per value.
{| class="wikitable"
|+ Data Types
|-
! Value !! Name !! Description
|-
| 0x00000000 || None || Only used for the List End
|-
| 0x00000001 || Direct || 1 byte per value. Only used for data that is not stored within [[#VTX1_-_Vertex_Data|VTX1]] Needs to be divided by 3 for some reason...
|-
| 0x00000002 || UInt8 || 1 byte per value (0 to 255). Indexes a buffer in [[#VTX1_-_Vertex_Data|VTX1]].
|-
| 0x00000003 || UInt16 || 2 bytes per value (0 to 65535). Indexes a buffer in [[#VTX1_-_Vertex_Data|VTX1]].
|}

=== Primitive Data ===
This chunk contains raw primitives. These are what hold the index buffers. The Index Buffers are ordered the same way the Index Buffer Attributes are ordered. For example, POSITION (UInt16), NORMAL (UInt16), COLOR_0 (UInt8), TEXCOORD_0 (UInt16), would result in the following byte structure: '''PPPP NNNN C0 TXC0''' This repeats for each vertex in the primitive.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Uint8 || Primitive Type

* 0x80 = Individual Quads

* 0x90 = Individual Triangles

* 0x98 = Triangle Strip

* 0xA0 = Triangle Fan

* 0xA8 = Individual Lines

* 0xB0 = Line Strip

* 0xB8 = Individual Points

TODO: Figure out if Quads, Lines, Line Strips, and Points work. TODO: Figure out if "Quad Strips" exist at 0x88.
|-
| 0x04 || Int16 || Vertex Count
|}
Each Matrix Group's primitives are padded to the nearest 32.
TODO: Figure out if the padding is allowed to be omitted.

=== Matrix Group Definition Table ===
This table defines a list of Matrix Groups for each Shape. A Shape can have multiple Matrix Groups, but only stores the index of the first one. This means that all the Matrix Groups for a given Shape must come directly one after another. It contains only two values: The size of all Primitive Data within this group, and an offset to the first Primitive (relative to the Primitive Data offset defined in SHP1).
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int32 || Primitive Data size
|-
| 0x04 || Int32 || First Primitive offset
|}

=== Matrix Group Data Table ===
This table contains definitions of sub-segments inside the Weight Index Table. How these values are used differs based on the shape matrix calculation type, but official files generally set both usages up correctly regardless.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int16 || [[#DRW1_-_Skinning_Assignments|DRW1]] Matrix ID This is only used with Single Joint shape matrix calculation.
|-
| 0x02 || Int16 || Matrix Count This is only used with Multiple Joint shape matrix calculation.
|-
| 0x04 || Int32 || Starting Weight Index This is only used with Multiple Joint shape matrix calculation.
|}

=== Weight Index Table ===
This table contains several indices into [[#DRW1_-_Skinning_Assignments|DRW1]]. Each index is a Signed 16 value. The values may also contain 0xFFFF, which indicates that the last used index should be used instead. Matrix Groups can select a segment of these indices (up to 10) for use. A Matrix Group must not start with 0xFFFF.

== MAT2 - Material List (Old) ==
Technically supported by the game, but not known to be used by any model.

== MAT3 - Material List ==

== MDL3 - Display List ==

== TEX1 - Texture Data ==
The '''Tex'''ture Information section holds several embedded [[BTI_(File_Format)|BTI]] files that [[#MAT3_-_Material_List|MAT3]] can reference by index for texture assignment.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''TEX1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of [[BTI_(File_Format)|BTI]] files stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || [[BTI_(File_Format)|BTI]] Header Table Offset
|-
| 0x10 || Int32 || Name table offset
|}

The texture data locations are defined by the [[BTI_(File_Format)|BTI]] headers (which themselves are located directly one after another at the Header Table) 
This structure allows multiple textures that have the same visual data to have their headers point to just one block of visual data. In other words, two identical textures can be "compressed" into one while still having their own properties (wrapping, filtering, etc.)

BMD/BDL (File Format)

2025-10-22T21:35:43Z

Super Hackio: Labelled INF1 section value to be related to SHP1

[[Category:File formats]]
{{WIP}}

BMD ('''B'''inary '''M'''o'''d'''el) and BDL ('''B'''inary '''D'''isplay '''L'''ist) are two 3D model formats used in ''Super Mario Galaxy'' and ''Super Mario Galaxy 2'', among a few other ''Wii'' and ''GameCube'' games, such as ''Super Mario Sunshine''.

These two formats hold the same data, except BDL contains an additional set of data which is used for faster rendering speeds.

''Super Mario Galaxy'' & ''Super Mario Galaxy 2'' contain J3DLoader versions 21 and 26.

== File Header ==
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || The magic that tells the game which format this file is. (ASCII) '''J3D2bmd2''' for BMD (J3DLoader V21) '''J3D2bmd3''' for BMD (J3DLoader v26) '''J3D2bdl4''' for BDL (J3DLoader v26)
|-
| 0x08 || Int32 || The total size of the file
|-
| 0x0C || Int32 || The number of chunks present in this file. '''8''' for BMD '''9''' for BDL
|}

=== Subversion Header ===
This part of the header is not used, and can be anything.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || A 4 character value representing the Subversion. Usually SVR3 for SMG/2.
|-
| 0x04 || Byte[12] || Twelve bytes of padding. Usually these are '''0xFF'''
|}

== INF1 - Scene Information ==
The '''Inf'''ormation section hosts a hierarchy of Joints, Materials, and Shapes, which are used to render the model.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''INF1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || [[#J3DLoader%20Flags|J3DLoader Flags]]
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || Matrix Group Data Count Referring to the Matrix Group Data in [[#SHP1_-_Shape_Information|SHP1]]
|-
| 0x10 || Int32 || Vertex Count Always equals the number of entries in the "POSITION" [[#Vertex%20Buffer%20Formats|data buffer]]
|-
| 0x14 || Int32 || Relative offset to the [[#Scene%20Hierarchy|Scene Hierarchy]]
|}

=== J3DLoader Flags ===
The J3DLoader contains several flags which affect how models are handled. There are more than what are shown here, however, those must be applied by the game itself in the code.
{| class="wikitable"
|-
! Value !! Description
|-
| 0b0000000000000000 || No flags applied (TODO: Check if this defaults to basic matrix calculation)
|-
| 0b0000000000000001 || Use Autodesk Softimage matrix calculation
|-
| 0b0000000000000010 || Use Autodesk Maya matrix calculation
|-
| 0b0000000000000100 || Use Basic matrix calculation
|-
| 0b0000000000001000 || ''UNKNOWN''
|-
| 0b0000000000010000 || UseImmidiateMtx (needs research)
|-
| 0b0000000000100000 || UsePostTexMtx (needs research)
|-
| 0b0000000001000000 || ''UNKNOWN''
|-
| 0b0000000010000000 || ''UNKNOWN''
|-
| 0b0000000100000000 || NoMatrixTransform (needs research)
|-
| 0b0000001000000000 || ''UNKNOWN''
|-
| 0b0000010000000000 || ''UNKNOWN''
|-
| 0b0000100000000000 || ''UNKNOWN''
|-
| 0b0001000000000000 || ''UNKNOWN''
|-
| 0b0010000000000000 || DoBdlMaterialCalc
|-
| 0b0100000000000000 || NoBdlMaterialPatch - If set, skips the call to '''J3DModelLoader::readPatchedMaterial'''.
|-
| 0b1000000000000000 || ''UNKNOWN''
|}
For all BMD files, the game always includes load flags ''Material_PE_Full'', ''Material_UseIndirect'', ''UseUniqueMaterials'', and ''UNKNOWN_21''. 
For all BDL files, the game always includes load flags ''Material_UseIndirect'', and ''UseUniqueMaterials''.

> ''Note: Changing the load flags by changing the code doesn't seem to do much.''

=== Scene Hierarchy ===
Each model is constructed using a Scene Hierarchy. This simply determines the order of bones (in turn, defining the parent/child relations), material assignments, and Shape assignments.

Each node consists of the following:
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || UInt16 || Node Type. 0x00 = Marks the end of the node list 0x01 = Creates a new child of the previous node 0x02 = Finishes the child node and returns ownership to the previous node 0x10 = Joint Assignment node. "Data" holds the Joint ID (index into JNT1) 0x11 = Material assignment. "Data" holds the Material ID (index into MAT3) 0x12 = Shape Assignment. "Data" holds the Shape ID (index into SHP1)
|-
| 0x02 || UInt16 || A Data value. Used by some nodes to index into other chunks. Usage depends on the node type.
|}

The node list is padded to the nearest 32.

== VTX1 - Vertex Data ==
The '''V'''er'''t'''e'''x''' Data section contains the actual number values used for the properties of the geometry. It also includes the information on how the values are formatted.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''VTX1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int32 || Buffer Format list offset
|-
| 0x0C || Int32 || "POSITION" data buffer offset 0 if not used.
|-
| 0x10 || Int32 || "NORMAL" data buffer offset 0 if not used.
|-
| 0x14 || Int32 || "TANGENT" data buffer offset 0 if not used.
|-
| 0x18 || Int32 || "COLOR_0" data buffer offset 0 if not used.
|-
| 0x1C || Int32 || "COLOR_1" data buffer offset 0 if not used.
|-
| 0x20 || Int32 || "TEXCOORD_0" data buffer offset 0 if not used.
|-
| 0x24 || Int32 || "TEXCOORD_1" data buffer offset 0 if not used.
|-
| 0x28 || Int32 || "TEXCOORD_2" data buffer offset 0 if not used.
|-
| 0x2C || Int32 || "TEXCOORD_3" data buffer offset 0 if not used.
|-
| 0x30 || Int32 || "TEXCOORD_4" data buffer offset 0 if not used.
|-
| 0x34 || Int32 || "TEXCOORD_5" data buffer offset 0 if not used.
|-
| 0x38 || Int32 || "TEXCOORD_6" data buffer offset 0 if not used.
|-
| 0x3C || Int32 || "TEXCOORD_7" data buffer offset 0 if not used.
|}

=== Vertex Buffer Formats ===
Each of the Buffers in this section have a format descriptor. This allows different types of data storage, allowing for smaller files.

Each format descriptor contains an Attribute Target, a Component Count, a Data Type, and a Mantissa shifter (to allow floats to be stored as smaller datatypes compared to FLOAT). Only one descriptor can exist for each attribute.

The Attribute Target tells the game what this buffer is used for.
{| class="wikitable"
|+ Attribute Targets
|-
! Value !! Name !! Description
|-
| 0x00000009 || POSITION || This buffer represents the positions of vertices in the model. Basically required for all visual models.
|-
| 0x0000000A || NORMAL || This buffer represents vertex normals, used for the engine's vertex shading. Not needed if no material requires it.
|-
| 0x0000000B || COLOR_0 || This buffer is available for Vertex Colors.
|-
| 0x0000000C || COLOR_1 || This buffer is available for Vertex Colors.
|-
| 0x0000000D || TEXCOORD_0 || This buffer is available for Texture Coordinates.
|-
| 0x0000000E || TEXCOORD_1 || This buffer is available for Texture Coordinates.
|-
| 0x0000000F || TEXCOORD_2 || This buffer is available for Texture Coordinates.
|-
| 0x00000010 || TEXCOORD_3 || This buffer is available for Texture Coordinates.
|-
| 0x00000011 || TEXCOORD_4 || This buffer is available for Texture Coordinates.
|-
| 0x00000012 || TEXCOORD_5 || This buffer is available for Texture Coordinates.
|-
| 0x00000013 || TEXCOORD_6 || This buffer is available for Texture Coordinates.
|-
| 0x00000014 || TEXCOORD_7 || This buffer is available for Texture Coordinates.
|-
| 0x00000019 || TANGENT || ''Currently unknown exactly what goes in here.''
|-
| 0x000000FF || List End || A buffer using this target will end the descriptor list.
|}

The component count tells the game how many parts of the component that there are. Note that the values are considered based on the attribute target they're assigned to.
{| class="wikitable"
|+ Component Count
|-
! Value !! Name !! Description
|-
| 0x00000000 || POSITION_XY || ''Unknown''
|-
| 0x00000001 || POSITION_XYZ || Represents a position in 3D space with 3 values: X, Y, and Z.
|-
|colspan="3"|
|-
| 0x00000000 || NORMAL_XYZ || Represents a normal vector in 3D space with 3 values: X, Y, and Z.
|-
| 0x00000001 || NORMAL_NBT || ''Unknown''
|-
| 0x00000002 || NORMAL_NBT3 || ''Unknown''
|-
|colspan="3"|
|-
| 0x00000000 || COLOR_RGB || Represents a color value with only Red, Green, and Blue values.
|-
| 0x00000001 || COLOR_RGBA || Represents a color value with Red, Green, Blue, and Alpha values.
|-
|colspan="3"|
|-
| 0x00000000 || TEXCOORD_S || ''Unknown''
|-
| 0x00000001 || TEXCOORD_ST || Represents a UV texture coordinate with 2 values: X and Y.
|}

The Data Type tells the game how many bytes each value is, in the sense that an Int32 is 4 bytes, a Int16 is 2 bytes, a Float is 4 bytes, etc. Note that the Color values have a different set of options.
{| class="wikitable"
|+ Data Types
|-
! Value !! Name !! Description
|-
| 0x00000000 || UInt8 || 1 byte per value (0 to 255)
|-
| 0x00000001 || Int8 || 1 byte per value (-128 to 127)
|-
| 0x00000002 || UInt16 || 2 bytes per value (0 to 65535)
|-
| 0x00000003 || Int16 || 2 bytes per value (-32,768 to 32,767)
|-
| 0x00000004 || Float || 4 bytes per value
|-
|colspan="3"|
|-
| 0x00000000 || RGB565 || 2 bytes per color
|-
| 0x00000001 || RGB8 || 3 bytes per color
|-
| 0x00000002 || RGBX8 || 3 bytes per color
|-
| 0x00000003 || RGBA4 || 2 bytes per color
|-
| 0x00000004 || RGBA6 || 4 bytes per color
|-
| 0x00000005 || RGBA8 || 4 bytes per color
|}
> ''Note: Both games require colors to be 4 bytes wide at all times, so changing from RGBA8 is worthless.''

== EVP1 - Skinning Envelopes ==
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''EVP1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of Envelopes stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || "Joint Count" list offset
|-
| 0x10 || Int32 || "'Joint Count' list index" list offset
|-
| 0x14 || Int32 || "Joint Weight" list offset
|-
| 0x18 || Int32 || "Inverse Bind Matrices" list offset
|}

== DRW1 - Skinning Assignments ==

== JNT1 - Joint Hierarchy ==
The '''J'''oi'''nt''' Hierarchy section defines the rigging skeleton of a model. There can only be one skeleton per model.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''JNT1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of Joints stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || Joint Data table offset
|-
| 0x10 || Int32 || Remap table offset
|-
| 0x14 || Int32 || Name table offset
|}

=== Joint Data ===
Each joint includes positional data and a bounding box which is used by the game for determining rendering range automatically.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int16 || Matrix Type
|-
| 0x01 || UInt8 || Parent Scale inheritance 0 = Follow parent joint's scale 1 = Ignore parent joint's scale
|-
| 0x02 || UInt8 || Padding (0xFF)
|-
| 0x04 || Float || Scale X
|-
| 0x08 || Float || Scale Y
|-
| 0x0C || Float || Scale Z
|-
| 0x10 || Int16 || Rotation X
|-
| 0x12 || Int16 || Rotation Y
|-
| 0x14 || Int16 || Rotation Z
|-
| 0x16 || Int16 || Padding (0xFFFF)
|-
| 0x18 || Float || Translation X
|-
| 0x1C || Float || Translation Y
|-
| 0x20 || Float || Translation Z
|-
| 0x24 || Float || Bounding Sphere Should encapsulate all vertices that the joint affects
|-
| 0x28 || Float || Bounding Box Minimum X
|-
| 0x2C || Float || Bounding Box Minimum Y
|-
| 0x30 || Float || Bounding Box Minimum Z
|-
| 0x34 || Float || Bounding Box Maximum X
|-
| 0x38 || Float || Bounding Box Maximum Y
|-
| 0x3C || Float || Bounding Box Maximum Z
|}
Rotation is stored between -0x7FFF and 0x7FFF, which ranges -180 degrees and 180 degrees.

== SHP1 - Shape Information==
The '''Sh'''a'''p'''e Information section determines how to use the data in the [[#VTX1_-_Vertex_Data|VTX1]] section to create shapes.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''SHP1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of Shapes stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || Shape Init Data offset
|-
| 0x10 || Int32 || Remap table offset
|-
| 0x14 || Int32 || Name table offset (Generally not used, and thus set to 0)
|-
| 0x18 || Int32 || Vertex Index Attribute table offset
|-
| 0x1C || Int32 || Weight Index table offset
|-
| 0x20 || Int32 || Primitive Data offset
|-
| 0x24 || Int32 || Matrix Group Data offset (entry count must equal the entry count of the GXDisplayList group table)
|-
| 0x28 || Int32 || Matrix Group Definition table offset
|}

=== Shape Data ===
Each shape denotes a Matrix Calculation type, which is used for Billboarding, as well as multi-joint skinning. A shape also hosts a collection of Matrix Groups. If the geometry needs to be weighted to more than 10 [[#DRW1_-_Skinning_Assignments|DRW1]] matrices, more than one Matrix Group is needed. A single Matrix Group can have multiple Primitives in it, but these Primitives must share the same set of [[#DRW1_-_Skinning_Assignments|DRW1]] matrices.

TODO: Figure out what happens in the event that more than 10 are needed (such as one vertex being weighted to 11 bones). Is it just straight up not allowed?

{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || UInt8 || Matrix Type

* 0 = Single Joint

* 1 = Billboard Joint

* 2 = Billboard Joint (Y axis only)

* 3 = Multiple Joints
|-
| 0x01 || UInt8 || Padding (0xFF)
|-
| 0x02 || Int16 || Matrix Group count
|-
| 0x04 || Int16 || Vertex Index Attribute offset Relative to the Vertex Index Attribute Table offset defined in SHP1
|-
| 0x06 || Int16 || Matrix Group Data index
|-
| 0x08 || Int16 || First Matrix Group Definition index
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Float || Bounding Sphere
|-
| 0x10 || Float || Bounding Box Minimum X
|-
| 0x14 || Float || Bounding Box Minimum Y
|-
| 0x18 || Float || Bounding Box Minimum Z
|-
| 0x1C || Float || Bounding Box Maximum X
|-
| 0x20 || Float || Bounding Box Maximum Y
|-
| 0x24 || Float || Bounding Box Maximum Z
|}

=== Vertex Index Attribute Table ===

{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int32 || An [[#Index%20Buffer%20Formats|index buffer]] attribute target
|-
| 0x04 || Int32 || An [[#Index%20Buffer%20Formats|index buffer]] type
|}

==== Index Buffer Formats ====
Each of the Buffers in this section have a format descriptor. This allows different types of data storage, allowing for smaller files.

These attributes line up with either a direct value that is stored in the shape, or an index into a [[#VTX1_-_Vertex_Data|VTX1]] [[#Vertex%20Buffer%20Formats|data buffer]]. Only one indexer can exist for each attribute.

The Attribute Target tells the game what this index buffer is used for.
{| class="wikitable"
|+ Attribute Targets
|-
! Value !! Name !! Description
|-
| 0x00000000 || POSITION_MATRIX || This is a direct list of indices into the Matrix Group's Weight collection. Required for Shapes that use Multiple Joint skinning.
|-
| 0x00000001 || TEXTURE_0_MATRIX || ''UNKNOWN''
|-
| 0x00000002 || TEXTURE_1_MATRIX || ''UNKNOWN''
|-
| 0x00000003 || TEXTURE_2_MATRIX || ''UNKNOWN''
|-
| 0x00000004 || TEXTURE_3_MATRIX || ''UNKNOWN''
|-
| 0x00000005 || TEXTURE_4_MATRIX || ''UNKNOWN''
|-
| 0x00000006 || TEXTURE_5_MATRIX || ''UNKNOWN''
|-
| 0x00000007 || TEXTURE_6_MATRIX || ''UNKNOWN''
|-
| 0x00000008 || TEXTURE_7_MATRIX || ''UNKNOWN''
|-
| 0x00000009 || POSITION || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "POSITION" buffer. Required.
|-
| 0x0000000A || NORMAL || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "NORMAL" buffer
|-
| 0x0000000B || COLOR_0 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "COLOR_0" buffer
|-
| 0x0000000C || COLOR_1 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "COLOR_1" buffer
|-
| 0x0000000D || TEXCOORD_0 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_0" buffer
|-
| 0x0000000E || TEXCOORD_1 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_1" buffer
|-
| 0x0000000F || TEXCOORD_2 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_2" buffer
|-
| 0x00000010 || TEXCOORD_3 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_3" buffer
|-
| 0x00000011 || TEXCOORD_4 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_4" buffer
|-
| 0x00000012 || TEXCOORD_5 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_5" buffer
|-
| 0x00000013 || TEXCOORD_6 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_6" buffer
|-
| 0x00000014 || TEXCOORD_7 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_7" buffer
|-
| 0x00000019 || TANGENT || ''This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TANGENT" buffer, but we don't yet know what that buffer does.''
|-
| 0x000000FF || List End || A buffer using this target will end the descriptor list.
|}

The Data Type of an Index Buffer determines the size of each Index. Direct Buffers can only be 1 byte per value.
{| class="wikitable"
|+ Data Types
|-
! Value !! Name !! Description
|-
| 0x00000000 || None || Only used for the List End
|-
| 0x00000001 || Direct || 1 byte per value. Only used for data that is not stored within [[#VTX1_-_Vertex_Data|VTX1]] Needs to be divided by 3 for some reason...
|-
| 0x00000002 || UInt8 || 1 byte per value (0 to 255). Indexes a buffer in [[#VTX1_-_Vertex_Data|VTX1]].
|-
| 0x00000003 || UInt16 || 2 bytes per value (0 to 65535). Indexes a buffer in [[#VTX1_-_Vertex_Data|VTX1]].
|}

=== Primitive Data ===
This chunk contains raw primitives. These are what hold the index buffers. The Index Buffers are ordered the same way the Index Buffer Attributes are ordered. For example, POSITION (UInt16), NORMAL (UInt16), COLOR_0 (UInt8), TEXCOORD_0 (UInt16), would result in the following byte structure: '''PPPP NNNN C0 TXC0''' This repeats for each vertex in the primitive.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Uint8 || Primitive Type

* 0x80 = Individual Quads

* 0x90 = Individual Triangles

* 0x98 = Triangle Strip

* 0xA0 = Triangle Fan

* 0xA8 = Individual Lines

* 0xB0 = Line Strip

* 0xB8 = Individual Points

TODO: Figure out if Quads, Lines, Line Strips, and Points work. TODO: Figure out if "Quad Strips" exist at 0x88.
|-
| 0x04 || Int16 || Vertex Count
|}
Each Matrix Group's primitives are padded to the nearest 32.
TODO: Figure out if the padding is allowed to be omitted.

=== Matrix Group Definition Table ===
This table defines a list of Matrix Groups for each Shape. A Shape can have multiple Matrix Groups, but only stores the index of the first one. This means that all the Matrix Groups for a given Shape must come directly one after another. It contains only two values: The size of all Primitive Data within this group, and an offset to the first Primitive (relative to the Primitive Data offset defined in SHP1).
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int32 || Primitive Data size
|-
| 0x04 || Int32 || First Primitive offset
|}

=== Matrix Group Data Table ===
This table contains definitions of sub-segments inside the Weight Index Table. How these values are used differs based on the shape matrix calculation type, but official files generally set both usages up correctly regardless.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int16 || [[#DRW1_-_Skinning_Assignments|DRW1]] Matrix ID This is only used with Single Joint shape matrix calculation.
|-
| 0x02 || Int16 || Matrix Count This is only used with Multiple Joint shape matrix calculation.
|-
| 0x04 || Int32 || Starting Weight Index This is only used with Multiple Joint shape matrix calculation.
|}

=== Weight Index Table ===
This table contains several indices into [[#DRW1_-_Skinning_Assignments|DRW1]]. Each index is a Signed 16 value. The values may also contain 0xFFFF, which indicates that the last used index should be used instead. Matrix Groups can select a segment of these indices (up to 10) for use. A Matrix Group must not start with 0xFFFF.

== MAT2 - Material List (Old) ==
Technically supported by the game, but not known to be used by any model.

== MAT3 - Material List ==

== MDL3 - Display List ==

== TEX1 - Texture Data ==
The '''Tex'''ture Information section holds several embedded [[BTI_(File_Format)|BTI]] files that [[#MAT3_-_Material_List|MAT3]] can reference by index for texture assignment.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''TEX1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of [[BTI_(File_Format)|BTI]] files stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || [[BTI_(File_Format)|BTI]] Header Table Offset
|-
| 0x10 || Int32 || Name table offset
|}

The texture data locations are defined by the [[BTI_(File_Format)|BTI]] headers (which themselves are located directly one after another at the Header Table) 
This structure allows multiple textures that have the same visual data to have their headers point to just one block of visual data. In other words, two identical textures can be "compressed" into one while still having their own properties (wrapping, filtering, etc.)

BMD/BDL (File Format)

2025-10-16T22:53:52Z

Super Hackio: Primitive Padding Note

[[Category:File formats]]
{{WIP}}

BMD ('''B'''inary '''M'''o'''d'''el) and BDL ('''B'''inary '''D'''isplay '''L'''ist) are two 3D model formats used in ''Super Mario Galaxy'' and ''Super Mario Galaxy 2'', among a few other ''Wii'' and ''GameCube'' games, such as ''Super Mario Sunshine''.

These two formats hold the same data, except BDL contains an additional set of data which is used for faster rendering speeds.

''Super Mario Galaxy'' & ''Super Mario Galaxy 2'' contain J3DLoader versions 21 and 26.

== File Header ==
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || The magic that tells the game which format this file is. (ASCII) '''J3D2bmd2''' for BMD (J3DLoader V21) '''J3D2bmd3''' for BMD (J3DLoader v26) '''J3D2bdl4''' for BDL (J3DLoader v26)
|-
| 0x08 || Int32 || The total size of the file
|-
| 0x0C || Int32 || The number of chunks present in this file. '''8''' for BMD '''9''' for BDL
|}

=== Subversion Header ===
This part of the header is not used, and can be anything.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || A 4 character value representing the Subversion. Usually SVR3 for SMG/2.
|-
| 0x04 || Byte[12] || Twelve bytes of padding. Usually these are '''0xFF'''
|}

== INF1 - Scene Information ==
The '''Inf'''ormation section hosts a hierarchy of Joints, Materials, and Shapes, which are used to render the model.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''INF1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || [[#J3DLoader%20Flags|J3DLoader Flags]]
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || Matrix Group Count
|-
| 0x10 || Int32 || Vertex Count Always equals the number of entries in the "POSITION" [[#Vertex%20Buffer%20Formats|data buffer]]
|-
| 0x14 || Int32 || Relative offset to the [[#Scene%20Hierarchy|Scene Hierarchy]]
|}

=== J3DLoader Flags ===
The J3DLoader contains several flags which affect how models are handled. There are more than what are shown here, however, those must be applied by the game itself in the code.
{| class="wikitable"
|-
! Value !! Description
|-
| 0b0000000000000000 || No flags applied (TODO: Check if this defaults to basic matrix calculation)
|-
| 0b0000000000000001 || Use Autodesk Softimage matrix calculation
|-
| 0b0000000000000010 || Use Autodesk Maya matrix calculation
|-
| 0b0000000000000100 || Use Basic matrix calculation
|-
| 0b0000000000001000 || ''UNKNOWN''
|-
| 0b0000000000010000 || UseImmidiateMtx (needs research)
|-
| 0b0000000000100000 || UsePostTexMtx (needs research)
|-
| 0b0000000001000000 || ''UNKNOWN''
|-
| 0b0000000010000000 || ''UNKNOWN''
|-
| 0b0000000100000000 || NoMatrixTransform (needs research)
|-
| 0b0000001000000000 || ''UNKNOWN''
|-
| 0b0000010000000000 || ''UNKNOWN''
|-
| 0b0000100000000000 || ''UNKNOWN''
|-
| 0b0001000000000000 || ''UNKNOWN''
|-
| 0b0010000000000000 || DoBdlMaterialCalc
|-
| 0b0100000000000000 || NoBdlMaterialPatch - If set, skips the call to '''J3DModelLoader::readPatchedMaterial'''.
|-
| 0b1000000000000000 || ''UNKNOWN''
|}
For all BMD files, the game always includes load flags ''Material_PE_Full'', ''Material_UseIndirect'', ''UseUniqueMaterials'', and ''UNKNOWN_21''. 
For all BDL files, the game always includes load flags ''Material_UseIndirect'', and ''UseUniqueMaterials''.

> ''Note: Changing the load flags by changing the code doesn't seem to do much.''

=== Scene Hierarchy ===
Each model is constructed using a Scene Hierarchy. This simply determines the order of bones (in turn, defining the parent/child relations), material assignments, and Shape assignments.

Each node consists of the following:
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || UInt16 || Node Type. 0x00 = Marks the end of the node list 0x01 = Creates a new child of the previous node 0x02 = Finishes the child node and returns ownership to the previous node 0x10 = Joint Assignment node. "Data" holds the Joint ID (index into JNT1) 0x11 = Material assignment. "Data" holds the Material ID (index into MAT3) 0x12 = Shape Assignment. "Data" holds the Shape ID (index into SHP1)
|-
| 0x02 || UInt16 || A Data value. Used by some nodes to index into other chunks. Usage depends on the node type.
|}

The node list is padded to the nearest 32.

== VTX1 - Vertex Data ==
The '''V'''er'''t'''e'''x''' Data section contains the actual number values used for the properties of the geometry. It also includes the information on how the values are formatted.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''VTX1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int32 || Buffer Format list offset
|-
| 0x0C || Int32 || "POSITION" data buffer offset 0 if not used.
|-
| 0x10 || Int32 || "NORMAL" data buffer offset 0 if not used.
|-
| 0x14 || Int32 || "TANGENT" data buffer offset 0 if not used.
|-
| 0x18 || Int32 || "COLOR_0" data buffer offset 0 if not used.
|-
| 0x1C || Int32 || "COLOR_1" data buffer offset 0 if not used.
|-
| 0x20 || Int32 || "TEXCOORD_0" data buffer offset 0 if not used.
|-
| 0x24 || Int32 || "TEXCOORD_1" data buffer offset 0 if not used.
|-
| 0x28 || Int32 || "TEXCOORD_2" data buffer offset 0 if not used.
|-
| 0x2C || Int32 || "TEXCOORD_3" data buffer offset 0 if not used.
|-
| 0x30 || Int32 || "TEXCOORD_4" data buffer offset 0 if not used.
|-
| 0x34 || Int32 || "TEXCOORD_5" data buffer offset 0 if not used.
|-
| 0x38 || Int32 || "TEXCOORD_6" data buffer offset 0 if not used.
|-
| 0x3C || Int32 || "TEXCOORD_7" data buffer offset 0 if not used.
|}

=== Vertex Buffer Formats ===
Each of the Buffers in this section have a format descriptor. This allows different types of data storage, allowing for smaller files.

Each format descriptor contains an Attribute Target, a Component Count, a Data Type, and a Mantissa shifter (to allow floats to be stored as smaller datatypes compared to FLOAT). Only one descriptor can exist for each attribute.

The Attribute Target tells the game what this buffer is used for.
{| class="wikitable"
|+ Attribute Targets
|-
! Value !! Name !! Description
|-
| 0x00000009 || POSITION || This buffer represents the positions of vertices in the model. Basically required for all visual models.
|-
| 0x0000000A || NORMAL || This buffer represents vertex normals, used for the engine's vertex shading. Not needed if no material requires it.
|-
| 0x0000000B || COLOR_0 || This buffer is available for Vertex Colors.
|-
| 0x0000000C || COLOR_1 || This buffer is available for Vertex Colors.
|-
| 0x0000000D || TEXCOORD_0 || This buffer is available for Texture Coordinates.
|-
| 0x0000000E || TEXCOORD_1 || This buffer is available for Texture Coordinates.
|-
| 0x0000000F || TEXCOORD_2 || This buffer is available for Texture Coordinates.
|-
| 0x00000010 || TEXCOORD_3 || This buffer is available for Texture Coordinates.
|-
| 0x00000011 || TEXCOORD_4 || This buffer is available for Texture Coordinates.
|-
| 0x00000012 || TEXCOORD_5 || This buffer is available for Texture Coordinates.
|-
| 0x00000013 || TEXCOORD_6 || This buffer is available for Texture Coordinates.
|-
| 0x00000014 || TEXCOORD_7 || This buffer is available for Texture Coordinates.
|-
| 0x00000019 || TANGENT || ''Currently unknown exactly what goes in here.''
|-
| 0x000000FF || List End || A buffer using this target will end the descriptor list.
|}

The component count tells the game how many parts of the component that there are. Note that the values are considered based on the attribute target they're assigned to.
{| class="wikitable"
|+ Component Count
|-
! Value !! Name !! Description
|-
| 0x00000000 || POSITION_XY || ''Unknown''
|-
| 0x00000001 || POSITION_XYZ || Represents a position in 3D space with 3 values: X, Y, and Z.
|-
|colspan="3"|
|-
| 0x00000000 || NORMAL_XYZ || Represents a normal vector in 3D space with 3 values: X, Y, and Z.
|-
| 0x00000001 || NORMAL_NBT || ''Unknown''
|-
| 0x00000002 || NORMAL_NBT3 || ''Unknown''
|-
|colspan="3"|
|-
| 0x00000000 || COLOR_RGB || Represents a color value with only Red, Green, and Blue values.
|-
| 0x00000001 || COLOR_RGBA || Represents a color value with Red, Green, Blue, and Alpha values.
|-
|colspan="3"|
|-
| 0x00000000 || TEXCOORD_S || ''Unknown''
|-
| 0x00000001 || TEXCOORD_ST || Represents a UV texture coordinate with 2 values: X and Y.
|}

The Data Type tells the game how many bytes each value is, in the sense that an Int32 is 4 bytes, a Int16 is 2 bytes, a Float is 4 bytes, etc. Note that the Color values have a different set of options.
{| class="wikitable"
|+ Data Types
|-
! Value !! Name !! Description
|-
| 0x00000000 || UInt8 || 1 byte per value (0 to 255)
|-
| 0x00000001 || Int8 || 1 byte per value (-128 to 127)
|-
| 0x00000002 || UInt16 || 2 bytes per value (0 to 65535)
|-
| 0x00000003 || Int16 || 2 bytes per value (-32,768 to 32,767)
|-
| 0x00000004 || Float || 4 bytes per value
|-
|colspan="3"|
|-
| 0x00000000 || RGB565 || 2 bytes per color
|-
| 0x00000001 || RGB8 || 3 bytes per color
|-
| 0x00000002 || RGBX8 || 3 bytes per color
|-
| 0x00000003 || RGBA4 || 2 bytes per color
|-
| 0x00000004 || RGBA6 || 4 bytes per color
|-
| 0x00000005 || RGBA8 || 4 bytes per color
|}
> ''Note: Both games require colors to be 4 bytes wide at all times, so changing from RGBA8 is worthless.''

== EVP1 - Skinning Envelopes ==
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''EVP1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of Envelopes stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || "Joint Count" list offset
|-
| 0x10 || Int32 || "'Joint Count' list index" list offset
|-
| 0x14 || Int32 || "Joint Weight" list offset
|-
| 0x18 || Int32 || "Inverse Bind Matrices" list offset
|}

== DRW1 - Skinning Assignments ==

== JNT1 - Joint Hierarchy ==
The '''J'''oi'''nt''' Hierarchy section defines the rigging skeleton of a model. There can only be one skeleton per model.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''JNT1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of Joints stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || Joint Data table offset
|-
| 0x10 || Int32 || Remap table offset
|-
| 0x14 || Int32 || Name table offset
|}

=== Joint Data ===
Each joint includes positional data and a bounding box which is used by the game for determining rendering range automatically.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int16 || Matrix Type
|-
| 0x01 || UInt8 || Parent Scale inheritance 0 = Follow parent joint's scale 1 = Ignore parent joint's scale
|-
| 0x02 || UInt8 || Padding (0xFF)
|-
| 0x04 || Float || Scale X
|-
| 0x08 || Float || Scale Y
|-
| 0x0C || Float || Scale Z
|-
| 0x10 || Int16 || Rotation X
|-
| 0x12 || Int16 || Rotation Y
|-
| 0x14 || Int16 || Rotation Z
|-
| 0x16 || Int16 || Padding (0xFFFF)
|-
| 0x18 || Float || Translation X
|-
| 0x1C || Float || Translation Y
|-
| 0x20 || Float || Translation Z
|-
| 0x24 || Float || Bounding Sphere Should encapsulate all vertices that the joint affects
|-
| 0x28 || Float || Bounding Box Minimum X
|-
| 0x2C || Float || Bounding Box Minimum Y
|-
| 0x30 || Float || Bounding Box Minimum Z
|-
| 0x34 || Float || Bounding Box Maximum X
|-
| 0x38 || Float || Bounding Box Maximum Y
|-
| 0x3C || Float || Bounding Box Maximum Z
|}
Rotation is stored between -0x7FFF and 0x7FFF, which ranges -180 degrees and 180 degrees.

== SHP1 - Shape Information==
The '''Sh'''a'''p'''e Information section determines how to use the data in the [[#VTX1_-_Vertex_Data|VTX1]] section to create shapes.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''SHP1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of Shapes stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || Shape Init Data offset
|-
| 0x10 || Int32 || Remap table offset
|-
| 0x14 || Int32 || Name table offset (Generally not used, and thus set to 0)
|-
| 0x18 || Int32 || Vertex Index Attribute table offset
|-
| 0x1C || Int32 || Weight Index table offset
|-
| 0x20 || Int32 || Primitive Data offset
|-
| 0x24 || Int32 || Matrix Group Data offset (entry count must equal the entry count of the GXDisplayList group table)
|-
| 0x28 || Int32 || Matrix Group Definition table offset
|}

=== Shape Data ===
Each shape denotes a Matrix Calculation type, which is used for Billboarding, as well as multi-joint skinning. A shape also hosts a collection of Matrix Groups. If the geometry needs to be weighted to more than 10 [[#DRW1_-_Skinning_Assignments|DRW1]] matrices, more than one Matrix Group is needed. A single Matrix Group can have multiple Primitives in it, but these Primitives must share the same set of [[#DRW1_-_Skinning_Assignments|DRW1]] matrices.

TODO: Figure out what happens in the event that more than 10 are needed (such as one vertex being weighted to 11 bones). Is it just straight up not allowed?

{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || UInt8 || Matrix Type

* 0 = Single Joint

* 1 = Billboard Joint

* 2 = Billboard Joint (Y axis only)

* 3 = Multiple Joints
|-
| 0x01 || UInt8 || Padding (0xFF)
|-
| 0x02 || Int16 || Matrix Group count
|-
| 0x04 || Int16 || Vertex Index Attribute offset Relative to the Vertex Index Attribute Table offset defined in SHP1
|-
| 0x06 || Int16 || Matrix Group Data index
|-
| 0x08 || Int16 || First Matrix Group Definition index
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Float || Bounding Sphere
|-
| 0x10 || Float || Bounding Box Minimum X
|-
| 0x14 || Float || Bounding Box Minimum Y
|-
| 0x18 || Float || Bounding Box Minimum Z
|-
| 0x1C || Float || Bounding Box Maximum X
|-
| 0x20 || Float || Bounding Box Maximum Y
|-
| 0x24 || Float || Bounding Box Maximum Z
|}

=== Vertex Index Attribute Table ===

{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int32 || An [[#Index%20Buffer%20Formats|index buffer]] attribute target
|-
| 0x04 || Int32 || An [[#Index%20Buffer%20Formats|index buffer]] type
|}

==== Index Buffer Formats ====
Each of the Buffers in this section have a format descriptor. This allows different types of data storage, allowing for smaller files.

These attributes line up with either a direct value that is stored in the shape, or an index into a [[#VTX1_-_Vertex_Data|VTX1]] [[#Vertex%20Buffer%20Formats|data buffer]]. Only one indexer can exist for each attribute.

The Attribute Target tells the game what this index buffer is used for.
{| class="wikitable"
|+ Attribute Targets
|-
! Value !! Name !! Description
|-
| 0x00000000 || POSITION_MATRIX || This is a direct list of indices into the Matrix Group's Weight collection. Required for Shapes that use Multiple Joint skinning.
|-
| 0x00000001 || TEXTURE_0_MATRIX || ''UNKNOWN''
|-
| 0x00000002 || TEXTURE_1_MATRIX || ''UNKNOWN''
|-
| 0x00000003 || TEXTURE_2_MATRIX || ''UNKNOWN''
|-
| 0x00000004 || TEXTURE_3_MATRIX || ''UNKNOWN''
|-
| 0x00000005 || TEXTURE_4_MATRIX || ''UNKNOWN''
|-
| 0x00000006 || TEXTURE_5_MATRIX || ''UNKNOWN''
|-
| 0x00000007 || TEXTURE_6_MATRIX || ''UNKNOWN''
|-
| 0x00000008 || TEXTURE_7_MATRIX || ''UNKNOWN''
|-
| 0x00000009 || POSITION || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "POSITION" buffer. Required.
|-
| 0x0000000A || NORMAL || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "NORMAL" buffer
|-
| 0x0000000B || COLOR_0 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "COLOR_0" buffer
|-
| 0x0000000C || COLOR_1 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "COLOR_1" buffer
|-
| 0x0000000D || TEXCOORD_0 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_0" buffer
|-
| 0x0000000E || TEXCOORD_1 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_1" buffer
|-
| 0x0000000F || TEXCOORD_2 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_2" buffer
|-
| 0x00000010 || TEXCOORD_3 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_3" buffer
|-
| 0x00000011 || TEXCOORD_4 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_4" buffer
|-
| 0x00000012 || TEXCOORD_5 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_5" buffer
|-
| 0x00000013 || TEXCOORD_6 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_6" buffer
|-
| 0x00000014 || TEXCOORD_7 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_7" buffer
|-
| 0x00000019 || TANGENT || ''This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TANGENT" buffer, but we don't yet know what that buffer does.''
|-
| 0x000000FF || List End || A buffer using this target will end the descriptor list.
|}

The Data Type of an Index Buffer determines the size of each Index. Direct Buffers can only be 1 byte per value.
{| class="wikitable"
|+ Data Types
|-
! Value !! Name !! Description
|-
| 0x00000000 || None || Only used for the List End
|-
| 0x00000001 || Direct || 1 byte per value. Only used for data that is not stored within [[#VTX1_-_Vertex_Data|VTX1]] Needs to be divided by 3 for some reason...
|-
| 0x00000002 || UInt8 || 1 byte per value (0 to 255). Indexes a buffer in [[#VTX1_-_Vertex_Data|VTX1]].
|-
| 0x00000003 || UInt16 || 2 bytes per value (0 to 65535). Indexes a buffer in [[#VTX1_-_Vertex_Data|VTX1]].
|}

=== Primitive Data ===
This chunk contains raw primitives. These are what hold the index buffers. The Index Buffers are ordered the same way the Index Buffer Attributes are ordered. For example, POSITION (UInt16), NORMAL (UInt16), COLOR_0 (UInt8), TEXCOORD_0 (UInt16), would result in the following byte structure: '''PPPP NNNN C0 TXC0''' This repeats for each vertex in the primitive.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Uint8 || Primitive Type

* 0x80 = Individual Quads

* 0x90 = Individual Triangles

* 0x98 = Triangle Strip

* 0xA0 = Triangle Fan

* 0xA8 = Individual Lines

* 0xB0 = Line Strip

* 0xB8 = Individual Points

TODO: Figure out if Quads, Lines, Line Strips, and Points work. TODO: Figure out if "Quad Strips" exist at 0x88.
|-
| 0x04 || Int16 || Vertex Count
|}
Each Matrix Group's primitives are padded to the nearest 32.
TODO: Figure out if the padding is allowed to be omitted.

=== Matrix Group Definition Table ===
This table defines a list of Matrix Groups for each Shape. A Shape can have multiple Matrix Groups, but only stores the index of the first one. This means that all the Matrix Groups for a given Shape must come directly one after another. It contains only two values: The size of all Primitive Data within this group, and an offset to the first Primitive (relative to the Primitive Data offset defined in SHP1).
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int32 || Primitive Data size
|-
| 0x04 || Int32 || First Primitive offset
|}

=== Matrix Group Data Table ===
This table contains definitions of sub-segments inside the Weight Index Table. How these values are used differs based on the shape matrix calculation type, but official files generally set both usages up correctly regardless.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int16 || [[#DRW1_-_Skinning_Assignments|DRW1]] Matrix ID This is only used with Single Joint shape matrix calculation.
|-
| 0x02 || Int16 || Matrix Count This is only used with Multiple Joint shape matrix calculation.
|-
| 0x04 || Int32 || Starting Weight Index This is only used with Multiple Joint shape matrix calculation.
|}

=== Weight Index Table ===
This table contains several indices into [[#DRW1_-_Skinning_Assignments|DRW1]]. Each index is a Signed 16 value. The values may also contain 0xFFFF, which indicates that the last used index should be used instead. Matrix Groups can select a segment of these indices (up to 10) for use. A Matrix Group must not start with 0xFFFF.

== MAT2 - Material List (Old) ==
Technically supported by the game, but not known to be used by any model.

== MAT3 - Material List ==

== MDL3 - Display List ==

== TEX1 - Texture Data ==
The '''Tex'''ture Information section holds several embedded [[BTI_(File_Format)|BTI]] files that [[#MAT3_-_Material_List|MAT3]] can reference by index for texture assignment.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''TEX1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of [[BTI_(File_Format)|BTI]] files stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || [[BTI_(File_Format)|BTI]] Header Table Offset
|-
| 0x10 || Int32 || Name table offset
|}

The texture data locations are defined by the [[BTI_(File_Format)|BTI]] headers (which themselves are located directly one after another at the Header Table) 
This structure allows multiple textures that have the same visual data to have their headers point to just one block of visual data. In other words, two identical textures can be "compressed" into one while still having their own properties (wrapping, filtering, etc.)

Cutscenes

2025-10-15T20:02:06Z

Super Hackio: /* Player */ MarioAnime not MarioAnim lol

[[Category:Files]]
[[Category:Lists]]
{{WIP}}
'''Todo:'''
*Finish the hardcoded cutscene names.
*More info and research on the use of canm and supported objects.

Cutscenes are flexible, complex scenes, which can execute more freedom in contrast to the SimpleDemoExecutor.
These scenes consist of individual sequences that are played in order. In each sequence, several actions can be executed from certain frames, such as changing the player's position, camera movements, sound effects, and more. To each sequence (and subsequence) different actions are linked, which are then executed at the time of this sequence.

You can best visualize this in a kind of timeline. The timeline consists of the individual sequences, which consist of several actions. At the same time single subscequences can be executed together with the actual sequences.

==Structure==
[[File:Cutscene_Visual-Representation.png|thumb|A visual representation of the first Yoshi Meets cutscene.]]
A cutscene is activated by a demo object via SW_APPEAR within the map and loads several sheet BCSV files located in the demo.arc archive of the respective galaxy/zone. The demo object loads the bcsv files using its defined sheet name and additional "Demo" in front of the file name of the BSCV attached and a respective sheet type at the end of the file name (e.g. '''Demo'''AfterGameOver'''Time''').

In addition, the demo object has its own cutscene name, which is only used in certain cases (e.g. to load certain sequences for [[Starship Mario]]) and also for camera codes. Certain names can be recognized by the game and then loads additional hardcoded settings such as behavior after scene completion. A list of these names [[Cutscenes#Hardcoded_Cutscene_Names|can be found below]].

Objects other than the player object itself can be linked to the cutscene. These then use a cutscene group ID, which on the one hand must match the demo object ID and on the other hand must be entered in the action sheet together with the object's name. If the object is entered in the [[ObjNameTable]], the name from the Japanese column must be entered instead.

If there are several identical objects that are part of a cutscene, you can also define a cast group id for one specific object to distinguish it from the other identical objects for the scene.

===Time===
Defines the individual sequences with their names and length. They are played in the order they are in the list.
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| PartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the sequence
|-
| TotalStep
| style="font-size:12px;" | LONG
| Duration of the sequence in frames
|-
| SuspendFlag
| style="font-size:12px;" | LONG
| If set to 1, pauses the cutscene and resumes gameplay. The cutscene will continue from here next time it is activated.
|-
| WaitUserInputFlag
| style="font-size:12px;" | LONG
|
|}

===SubPart===
Runs additional subsequences in parallel during a sequence.
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| SubPartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the sub sequence
|-
| SubPartTotalStep
| style="font-size:12px;" | LONG
| The length of the sub sequence
|-
| MainPartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the main sequence this sub sequence belongs to
|-
| MainPartStep
| style="font-size:12px;" | LONG
| The frame of the main sequence this sub sequence starts at
|}

===Action===
Picks up objects and can position them to a given GeneralPos and play an animation.

All animation types are supported. For more control you can use [[ActorInfo#ActorInfo|ActorAnimCtrl.bcsv]] for your objects to define multiple animation names of different animation types to the animation name defined in the cutscene.
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| PartName
| style="font-size:12px;" | STRING_OFFSET
| Sequence Name
|-
| CastName
| style="font-size:12px;" | STRING_OFFSET
| Name of the target object. Either Japanese name defined in [[ObjNameTable]], or ''ModelName'' defined in [[ProductMapObjDataTable]].
|-
| CastID
| style="font-size:12px;" | LONG
| Optional Cast ID of the target object. -1 = Deactivated. 
To target a specific object among identical objects that are part of the cutscene.
|-
| ActionType
| style="font-size:12px;" | LONG
| Pick an Action Type from the table below.
|-
| PosName
| style="font-size:12px;" | STRING_OFFSET
| Name of the GeneralPos object for destination location
|-
| AnimName
| style="font-size:12px;" | STRING_OFFSET
| Name of the animation, which can be loaded either from the ARC archive object or from a separate ARC archive with the additional name "Anim".
|}
====Action Types====
Note that these action types are not available for any object that registers as a "Simple Demo Cast".

===== SMG1 =====
{| class="wikitable"
! ID !! Name !! Description
|-
| 0 || Apppear || Makes the object Appear.
|-
| 1 || Kill || Makes the object Disappear (using it's Kill function).
|-
| 2 || Special Function || Executes a function that the object specifically registered to the cutscene. This is object specific, and not every object has one.
|-
| 3 || Special Nerve || Sets the objects Nerve to a nerve specifically registered to the cutscene. This is object specific, and not every object has one.
|-
| 4 || On SW_A || The SW_A of this object will be activated.
|-
| 5 || On SW_B || The SW_B of this object will be activated.
|-
| 6 || Show Model || The model of the object will be unhidden.
|-
| 7 || Hide Model || The model of the object will be hidden.
|-
| 8 || Start NPC Message || Start a conversation with an NPC. Effectively useless because NPC's do not register their text to cutscenes unless the cutscene has a specific name.
|-
| 9 || Start NPC Message (Alt) || Start a conversation with an NPC without stopping Mario's current animation. Effectively useless because NPC's do not register their text to cutscenes unless the cutscene has a specific name.
|-
| 10 || Duplicate of 9 || Duplicate of 9.
|-
| 11 || Play Animation || Plays the animation that "AnimName" is set to. This happens for all Action Types.
|-
| 12 || Off SW_A || The SW_A of this object will be deactivated.
|-
| 13 || Off SW_B || The SW_B of this object will be deactivated.
|}
===== SMG2 =====
{| class="wikitable"
! ID !! Name !! Description
|-
| 0 || Play Animation || Plays the animation that "AnimName" is set to. This happens for all Action Types.
|-
| 1 || Apppear || Makes the object Appear.
|-
| 2 || Kill || Makes the object Disappear (using it's Kill function).
|-
| 3 || Special Function || Executes a function that the object specifically registered to the cutscene. This is object specific, and not every object has one.
|-
| 4 || Special Nerve || Sets the objects Nerve to a nerve specifically registered to the cutscene. This is object specific, and not every object has one.
|-
| 5 || On SW_A || The SW_A of this object will be activated.
|-
| 6 || On SW_B || The SW_B of this object will be activated.
|-
| 7 || Show Model || The model of the object will be unhidden.
|-
| 8 || Hide Model || The model of the object will be hidden.
|-
| 9 || Start NPC Message || Start a conversation with an NPC. Effectively useless because NPC's do not register their text to cutscenes unless the cutscene has a specific name.
|-
| 10 || Start NPC Message (Alt) || Start a conversation with an NPC without stopping Mario's current animation. Effectively useless because NPC's do not register their text to cutscenes unless the cutscene has a specific name.
|-
| 11 || Duplicate of 10 || Duplicate of 10.
|-
| 12 || Off SW_A || The SW_A of this object will be deactivated.
|-
| 13 || Off SW_B || The SW_B of this object will be deactivated.
|-
| 14 || Request Movement Off || Tries to pause execution of this object.
|-
| 15 || Request Movement On || Tries to resume execution of this object.
|-
| 16 || StoryBookWarpDemo || Unknown. Related to StoryBookWarpDemo. Uses 1 as arg.
|-
| 17 || StoryBookWarpDemo || Unknown. Related to StoryBookWarpDemo. Uses 0 as arg.
|-
| 18 || StoryBookWarpDemo || Unknown. Related to StoryBookWarpDemo.
|-
| 19 || StoryBookWarpDemo || Unknown. Related to StoryBookWarpDemo.
|-
| 20 || ? || Unknown. Used at the end of the cutscene where Mario meets Yoshi for the first time.
|}

===Player===
Can position Mario/Luigi to a specific GeneralPos and play an animation.
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| PartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the sequence
|-
| PosName
| style="font-size:12px;" | STRING_OFFSET
| Name of the GeneralPos to teleport the player to
|-
| BckName
| style="font-size:12px;" | STRING_OFFSET
| Name of the animation from /ObjectData/MarioAnime.arc to play. (All other animationtypes than BCK are also supported)
|-
| Visible
| style="font-size:12px;" | LONG
|
|}

===Camera===
Can play cameras, which can be played one after another. Can use either a camera code from the Map archive's [[Cameras|CameraParam.bcam]] file, or a key frame camera animation which are controlled via [[CANM]] files, which must be located in the object archive of the targeted object.
By default the camera is fixed on Mario/Luigi.

For BCAM usage, the Camera ID name to be used is composed of the ''PartName'' and the ''Cutscenename'' (not the sheet name): '''e:Cutscenename[PartName]'''.

For CANM usage, the name defined in ''AnimCameraName'' must match the CANM file's name and needs to be placed in the root of the targeted object's archive.
Seems to be supported only by certain objects. This has not yet been fully explored.

{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| PartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the sequence
|-
| CameraTargetName
| style="font-size:12px;" | STRING_OFFSET
| Japanese Name of the object the camera is focused to. (Primarily uses ObjNameTable names)
|-
| CameraTargetCastID
| style="font-size:12px;" | LONG
| Cast ID of the object
|-
| AnimCameraName
| style="font-size:12px;" | STRING_OFFSET
| CANM file name (".canm" extension optional) which must be placed in the root of the targeted object's archive.
|-
| AnimCameraStartFrame
| style="font-size:12px;" | LONG
| The part frame to begin the camera on. -1 will have the camera interpolate to the start of the CANM
|-
| AnimCameraEndFrame
| style="font-size:12px;" | LONG
|
|-
| IsContinuous
| style="font-size:12px;" | LONG
|
|}

===Sound===
Can change music and play sound effects.
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| PartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the sequence
|-
| Bgm
| style="font-size:12px;" | STRING_OFFSET
| [[List_of_Music|Name of the music]] to play.
|-
| SystemSe
| style="font-size:12px;" | STRING_OFFSET
| [[List_of_Sounds_(SMG2)|Name of the soundeffect]] to play.
|-
| ActionSe
| style="font-size:12px;" | STRING_OFFSET
|
|-
| ReturnBgm
| style="font-size:12px;" | LONG
|
|-
| BgmWipeoutFrame
| style="font-size:12px;" | LONG
| Duration in frames for fading out the music. -1 = No fade-out
|-
| AllSoundStopFrame
| style="font-size:12px;" | LONG
|
|}

===Wipe===
Can perform a fade out animation.
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| PartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the sequence
|-
| WipeName
| style="font-size:12px;" | STRING_OFFSET
| The wipe to use. See the [[#WipeName|WipeName]] table below.
|-
| WipeType
| style="font-size:12px;" | LONG
| The function for the Wipe to perform. See the [[#WipeType|WipeType]] table below.
|-
| WipeFrame
| style="font-size:12px;" | LONG
| The amount of frames that the wipe will move for. Higher values = Slower movement
|}

====WipeName====
Below is a list of available WipeName values:
{| class="wikitable"
|-
! Value !! Description
|-
| 円ワイプ || Circle Wipe
|-
| フェードワイプ || Black Fade
|-
| 白フェードワイプ || White Fade
|-
| ゲームオーバー || Game Over
|-
| クッパ || Bowser Face (Death wipe)
|}

''Note: The Mario wipe is missing because the Mario wipe is a System Wipe and not a Scene Wipe. DemoWipes can only be Scene Wipes.''

====WipeType====
Below is the list of Wipe functions. The table below uses the Black Fade as an example.
{| class="wikitable"
|-
! Value !! Description
|-
| 0 || Open Wipe (Fade to Gameplay)
|-
| 1 || Close Wipe (Fade to Black)
|-
| 2 || Force Open Wipe (Cut to Gameplay)
|-
| 3 || Force Close Wipe (Cut to Black)
|}

''Tip: If you need to change wipes while the wipe is closed, use Force Close before using Open for a smoother transition.''

===Hardcoded Cutscene Names===
'''Todo:''' Finish this.
{| class="wikitable"
|-
! Cutscene Name
! Meaning
! Notes
|-
| ベビチコ出会い
| Master Luma Meeting
| -Uses hardcoded cameras -Activates spin after completion when the galaxy uses the StageType "Storybook"
|}

==Tools==
Up to now, there are no tools that allow the cutscenes to be edited directly in a clear interface. Since the cutscenes sheet consists of [[BCSV]] files, they can be edited with any other BCSV editor, like Whitehole. They can also be converted to CSV files and vice versa with Pyjmap.

The tools can be found on the [[Tools_and_Resources|tools and ressources page]].

BMD/BDL (File Format)

2025-10-14T01:22:08Z

Super Hackio: SHP1 major upgrades

[[Category:File formats]]
{{WIP}}

BMD ('''B'''inary '''M'''o'''d'''el) and BDL ('''B'''inary '''D'''isplay '''L'''ist) are two 3D model formats used in ''Super Mario Galaxy'' and ''Super Mario Galaxy 2'', among a few other ''Wii'' and ''GameCube'' games, such as ''Super Mario Sunshine''.

These two formats hold the same data, except BDL contains an additional set of data which is used for faster rendering speeds.

''Super Mario Galaxy'' & ''Super Mario Galaxy 2'' contain J3DLoader versions 21 and 26.

== File Header ==
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || The magic that tells the game which format this file is. (ASCII) '''J3D2bmd2''' for BMD (J3DLoader V21) '''J3D2bmd3''' for BMD (J3DLoader v26) '''J3D2bdl4''' for BDL (J3DLoader v26)
|-
| 0x08 || Int32 || The total size of the file
|-
| 0x0C || Int32 || The number of chunks present in this file. '''8''' for BMD '''9''' for BDL
|}

=== Subversion Header ===
This part of the header is not used, and can be anything.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || A 4 character value representing the Subversion. Usually SVR3 for SMG/2.
|-
| 0x04 || Byte[12] || Twelve bytes of padding. Usually these are '''0xFF'''
|}

== INF1 - Scene Information ==
The '''Inf'''ormation section hosts a hierarchy of Joints, Materials, and Shapes, which are used to render the model.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''INF1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || [[#J3DLoader%20Flags|J3DLoader Flags]]
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || Matrix Group Count
|-
| 0x10 || Int32 || Vertex Count Always equals the number of entries in the "POSITION" [[#Vertex%20Buffer%20Formats|data buffer]]
|-
| 0x14 || Int32 || Relative offset to the [[#Scene%20Hierarchy|Scene Hierarchy]]
|}

=== J3DLoader Flags ===
The J3DLoader contains several flags which affect how models are handled. There are more than what are shown here, however, those must be applied by the game itself in the code.
{| class="wikitable"
|-
! Value !! Description
|-
| 0b0000000000000000 || No flags applied (TODO: Check if this defaults to basic matrix calculation)
|-
| 0b0000000000000001 || Use Autodesk Softimage matrix calculation
|-
| 0b0000000000000010 || Use Autodesk Maya matrix calculation
|-
| 0b0000000000000100 || Use Basic matrix calculation
|-
| 0b0000000000001000 || ''UNKNOWN''
|-
| 0b0000000000010000 || UseImmidiateMtx (needs research)
|-
| 0b0000000000100000 || UsePostTexMtx (needs research)
|-
| 0b0000000001000000 || ''UNKNOWN''
|-
| 0b0000000010000000 || ''UNKNOWN''
|-
| 0b0000000100000000 || NoMatrixTransform (needs research)
|-
| 0b0000001000000000 || ''UNKNOWN''
|-
| 0b0000010000000000 || ''UNKNOWN''
|-
| 0b0000100000000000 || ''UNKNOWN''
|-
| 0b0001000000000000 || ''UNKNOWN''
|-
| 0b0010000000000000 || DoBdlMaterialCalc
|-
| 0b0100000000000000 || NoBdlMaterialPatch - If set, skips the call to '''J3DModelLoader::readPatchedMaterial'''.
|-
| 0b1000000000000000 || ''UNKNOWN''
|}
For all BMD files, the game always includes load flags ''Material_PE_Full'', ''Material_UseIndirect'', ''UseUniqueMaterials'', and ''UNKNOWN_21''. 
For all BDL files, the game always includes load flags ''Material_UseIndirect'', and ''UseUniqueMaterials''.

> ''Note: Changing the load flags by changing the code doesn't seem to do much.''

=== Scene Hierarchy ===
Each model is constructed using a Scene Hierarchy. This simply determines the order of bones (in turn, defining the parent/child relations), material assignments, and Shape assignments.

Each node consists of the following:
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || UInt16 || Node Type. 0x00 = Marks the end of the node list 0x01 = Creates a new child of the previous node 0x02 = Finishes the child node and returns ownership to the previous node 0x10 = Joint Assignment node. "Data" holds the Joint ID (index into JNT1) 0x11 = Material assignment. "Data" holds the Material ID (index into MAT3) 0x12 = Shape Assignment. "Data" holds the Shape ID (index into SHP1)
|-
| 0x02 || UInt16 || A Data value. Used by some nodes to index into other chunks. Usage depends on the node type.
|}

The node list is padded to the nearest 32.

== VTX1 - Vertex Data ==
The '''V'''er'''t'''e'''x''' Data section contains the actual number values used for the properties of the geometry. It also includes the information on how the values are formatted.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''VTX1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int32 || Buffer Format list offset
|-
| 0x0C || Int32 || "POSITION" data buffer offset 0 if not used.
|-
| 0x10 || Int32 || "NORMAL" data buffer offset 0 if not used.
|-
| 0x14 || Int32 || "TANGENT" data buffer offset 0 if not used.
|-
| 0x18 || Int32 || "COLOR_0" data buffer offset 0 if not used.
|-
| 0x1C || Int32 || "COLOR_1" data buffer offset 0 if not used.
|-
| 0x20 || Int32 || "TEXCOORD_0" data buffer offset 0 if not used.
|-
| 0x24 || Int32 || "TEXCOORD_1" data buffer offset 0 if not used.
|-
| 0x28 || Int32 || "TEXCOORD_2" data buffer offset 0 if not used.
|-
| 0x2C || Int32 || "TEXCOORD_3" data buffer offset 0 if not used.
|-
| 0x30 || Int32 || "TEXCOORD_4" data buffer offset 0 if not used.
|-
| 0x34 || Int32 || "TEXCOORD_5" data buffer offset 0 if not used.
|-
| 0x38 || Int32 || "TEXCOORD_6" data buffer offset 0 if not used.
|-
| 0x3C || Int32 || "TEXCOORD_7" data buffer offset 0 if not used.
|}

=== Vertex Buffer Formats ===
Each of the Buffers in this section have a format descriptor. This allows different types of data storage, allowing for smaller files.

Each format descriptor contains an Attribute Target, a Component Count, a Data Type, and a Mantissa shifter (to allow floats to be stored as smaller datatypes compared to FLOAT). Only one descriptor can exist for each attribute.

The Attribute Target tells the game what this buffer is used for.
{| class="wikitable"
|+ Attribute Targets
|-
! Value !! Name !! Description
|-
| 0x00000009 || POSITION || This buffer represents the positions of vertices in the model. Basically required for all visual models.
|-
| 0x0000000A || NORMAL || This buffer represents vertex normals, used for the engine's vertex shading. Not needed if no material requires it.
|-
| 0x0000000B || COLOR_0 || This buffer is available for Vertex Colors.
|-
| 0x0000000C || COLOR_1 || This buffer is available for Vertex Colors.
|-
| 0x0000000D || TEXCOORD_0 || This buffer is available for Texture Coordinates.
|-
| 0x0000000E || TEXCOORD_1 || This buffer is available for Texture Coordinates.
|-
| 0x0000000F || TEXCOORD_2 || This buffer is available for Texture Coordinates.
|-
| 0x00000010 || TEXCOORD_3 || This buffer is available for Texture Coordinates.
|-
| 0x00000011 || TEXCOORD_4 || This buffer is available for Texture Coordinates.
|-
| 0x00000012 || TEXCOORD_5 || This buffer is available for Texture Coordinates.
|-
| 0x00000013 || TEXCOORD_6 || This buffer is available for Texture Coordinates.
|-
| 0x00000014 || TEXCOORD_7 || This buffer is available for Texture Coordinates.
|-
| 0x00000019 || TANGENT || ''Currently unknown exactly what goes in here.''
|-
| 0x000000FF || List End || A buffer using this target will end the descriptor list.
|}

The component count tells the game how many parts of the component that there are. Note that the values are considered based on the attribute target they're assigned to.
{| class="wikitable"
|+ Component Count
|-
! Value !! Name !! Description
|-
| 0x00000000 || POSITION_XY || ''Unknown''
|-
| 0x00000001 || POSITION_XYZ || Represents a position in 3D space with 3 values: X, Y, and Z.
|-
|colspan="3"|
|-
| 0x00000000 || NORMAL_XYZ || Represents a normal vector in 3D space with 3 values: X, Y, and Z.
|-
| 0x00000001 || NORMAL_NBT || ''Unknown''
|-
| 0x00000002 || NORMAL_NBT3 || ''Unknown''
|-
|colspan="3"|
|-
| 0x00000000 || COLOR_RGB || Represents a color value with only Red, Green, and Blue values.
|-
| 0x00000001 || COLOR_RGBA || Represents a color value with Red, Green, Blue, and Alpha values.
|-
|colspan="3"|
|-
| 0x00000000 || TEXCOORD_S || ''Unknown''
|-
| 0x00000001 || TEXCOORD_ST || Represents a UV texture coordinate with 2 values: X and Y.
|}

The Data Type tells the game how many bytes each value is, in the sense that an Int32 is 4 bytes, a Int16 is 2 bytes, a Float is 4 bytes, etc. Note that the Color values have a different set of options.
{| class="wikitable"
|+ Data Types
|-
! Value !! Name !! Description
|-
| 0x00000000 || UInt8 || 1 byte per value (0 to 255)
|-
| 0x00000001 || Int8 || 1 byte per value (-128 to 127)
|-
| 0x00000002 || UInt16 || 2 bytes per value (0 to 65535)
|-
| 0x00000003 || Int16 || 2 bytes per value (-32,768 to 32,767)
|-
| 0x00000004 || Float || 4 bytes per value
|-
|colspan="3"|
|-
| 0x00000000 || RGB565 || 2 bytes per color
|-
| 0x00000001 || RGB8 || 3 bytes per color
|-
| 0x00000002 || RGBX8 || 3 bytes per color
|-
| 0x00000003 || RGBA4 || 2 bytes per color
|-
| 0x00000004 || RGBA6 || 4 bytes per color
|-
| 0x00000005 || RGBA8 || 4 bytes per color
|}
> ''Note: Both games require colors to be 4 bytes wide at all times, so changing from RGBA8 is worthless.''

== EVP1 - Skinning Envelopes ==
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''EVP1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of Envelopes stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || "Joint Count" list offset
|-
| 0x10 || Int32 || "'Joint Count' list index" list offset
|-
| 0x14 || Int32 || "Joint Weight" list offset
|-
| 0x18 || Int32 || "Inverse Bind Matrices" list offset
|}

== DRW1 - Skinning Assignments ==

== JNT1 - Joint Hierarchy ==
The '''J'''oi'''nt''' Hierarchy section defines the rigging skeleton of a model. There can only be one skeleton per model.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''JNT1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of Joints stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || Joint Data table offset
|-
| 0x10 || Int32 || Remap table offset
|-
| 0x14 || Int32 || Name table offset
|}

=== Joint Data ===
Each joint includes positional data and a bounding box which is used by the game for determining rendering range automatically.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int16 || Matrix Type
|-
| 0x01 || UInt8 || Parent Scale inheritance 0 = Follow parent joint's scale 1 = Ignore parent joint's scale
|-
| 0x02 || UInt8 || Padding (0xFF)
|-
| 0x04 || Float || Scale X
|-
| 0x08 || Float || Scale Y
|-
| 0x0C || Float || Scale Z
|-
| 0x10 || Int16 || Rotation X
|-
| 0x12 || Int16 || Rotation Y
|-
| 0x14 || Int16 || Rotation Z
|-
| 0x16 || Int16 || Padding (0xFFFF)
|-
| 0x18 || Float || Translation X
|-
| 0x1C || Float || Translation Y
|-
| 0x20 || Float || Translation Z
|-
| 0x24 || Float || Bounding Sphere Should encapsulate all vertices that the joint affects
|-
| 0x28 || Float || Bounding Box Minimum X
|-
| 0x2C || Float || Bounding Box Minimum Y
|-
| 0x30 || Float || Bounding Box Minimum Z
|-
| 0x34 || Float || Bounding Box Maximum X
|-
| 0x38 || Float || Bounding Box Maximum Y
|-
| 0x3C || Float || Bounding Box Maximum Z
|}
Rotation is stored between -0x7FFF and 0x7FFF, which ranges -180 degrees and 180 degrees.

== SHP1 - Shape Information==
The '''Sh'''a'''p'''e Information section determines how to use the data in the [[#VTX1_-_Vertex_Data|VTX1]] section to create shapes.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''SHP1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of Shapes stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || Shape Init Data offset
|-
| 0x10 || Int32 || Remap table offset
|-
| 0x14 || Int32 || Name table offset (Generally not used, and thus set to 0)
|-
| 0x18 || Int32 || Vertex Index Attribute table offset
|-
| 0x1C || Int32 || Weight Index table offset
|-
| 0x20 || Int32 || Primitive Data offset
|-
| 0x24 || Int32 || Matrix Group Data offset (entry count must equal the entry count of the GXDisplayList group table)
|-
| 0x28 || Int32 || Matrix Group Definition table offset
|}

=== Shape Data ===
Each shape denotes a Matrix Calculation type, which is used for Billboarding, as well as multi-joint skinning. A shape also hosts a collection of Matrix Groups. If the geometry needs to be weighted to more than 10 [[#DRW1_-_Skinning_Assignments|DRW1]] matrices, more than one Matrix Group is needed. A single Matrix Group can have multiple Primitives in it, but these Primitives must share the same set of [[#DRW1_-_Skinning_Assignments|DRW1]] matrices.

TODO: Figure out what happens in the event that more than 10 are needed (such as one vertex being weighted to 11 bones). Is it just straight up not allowed?

{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || UInt8 || Matrix Type

* 0 = Single Joint

* 1 = Billboard Joint

* 2 = Billboard Joint (Y axis only)

* 3 = Multiple Joints
|-
| 0x01 || UInt8 || Padding (0xFF)
|-
| 0x02 || Int16 || Matrix Group count
|-
| 0x04 || Int16 || Vertex Index Attribute offset Relative to the Vertex Index Attribute Table offset defined in SHP1
|-
| 0x06 || Int16 || Matrix Group Data index
|-
| 0x08 || Int16 || First Matrix Group Definition index
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Float || Bounding Sphere
|-
| 0x10 || Float || Bounding Box Minimum X
|-
| 0x14 || Float || Bounding Box Minimum Y
|-
| 0x18 || Float || Bounding Box Minimum Z
|-
| 0x1C || Float || Bounding Box Maximum X
|-
| 0x20 || Float || Bounding Box Maximum Y
|-
| 0x24 || Float || Bounding Box Maximum Z
|}

=== Vertex Index Attribute Table ===

{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int32 || An [[#Index%20Buffer%20Formats|index buffer]] attribute target
|-
| 0x04 || Int32 || An [[#Index%20Buffer%20Formats|index buffer]] type
|}

==== Index Buffer Formats ====
Each of the Buffers in this section have a format descriptor. This allows different types of data storage, allowing for smaller files.

These attributes line up with either a direct value that is stored in the shape, or an index into a [[#VTX1_-_Vertex_Data|VTX1]] [[#Vertex%20Buffer%20Formats|data buffer]]. Only one indexer can exist for each attribute.

The Attribute Target tells the game what this index buffer is used for.
{| class="wikitable"
|+ Attribute Targets
|-
! Value !! Name !! Description
|-
| 0x00000000 || POSITION_MATRIX || This is a direct list of indices into the Matrix Group's Weight collection. Required for Shapes that use Multiple Joint skinning.
|-
| 0x00000001 || TEXTURE_0_MATRIX || ''UNKNOWN''
|-
| 0x00000002 || TEXTURE_1_MATRIX || ''UNKNOWN''
|-
| 0x00000003 || TEXTURE_2_MATRIX || ''UNKNOWN''
|-
| 0x00000004 || TEXTURE_3_MATRIX || ''UNKNOWN''
|-
| 0x00000005 || TEXTURE_4_MATRIX || ''UNKNOWN''
|-
| 0x00000006 || TEXTURE_5_MATRIX || ''UNKNOWN''
|-
| 0x00000007 || TEXTURE_6_MATRIX || ''UNKNOWN''
|-
| 0x00000008 || TEXTURE_7_MATRIX || ''UNKNOWN''
|-
| 0x00000009 || POSITION || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "POSITION" buffer. Required.
|-
| 0x0000000A || NORMAL || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "NORMAL" buffer
|-
| 0x0000000B || COLOR_0 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "COLOR_0" buffer
|-
| 0x0000000C || COLOR_1 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "COLOR_1" buffer
|-
| 0x0000000D || TEXCOORD_0 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_0" buffer
|-
| 0x0000000E || TEXCOORD_1 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_1" buffer
|-
| 0x0000000F || TEXCOORD_2 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_2" buffer
|-
| 0x00000010 || TEXCOORD_3 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_3" buffer
|-
| 0x00000011 || TEXCOORD_4 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_4" buffer
|-
| 0x00000012 || TEXCOORD_5 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_5" buffer
|-
| 0x00000013 || TEXCOORD_6 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_6" buffer
|-
| 0x00000014 || TEXCOORD_7 || This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TEXCOORD_7" buffer
|-
| 0x00000019 || TANGENT || ''This indexes into the [[#VTX1_-_Vertex_Data|VTX1]] "TANGENT" buffer, but we don't yet know what that buffer does.''
|-
| 0x000000FF || List End || A buffer using this target will end the descriptor list.
|}

The Data Type of an Index Buffer determines the size of each Index. Direct Buffers can only be 1 byte per value.
{| class="wikitable"
|+ Data Types
|-
! Value !! Name !! Description
|-
| 0x00000000 || None || Only used for the List End
|-
| 0x00000001 || Direct || 1 byte per value. Only used for data that is not stored within [[#VTX1_-_Vertex_Data|VTX1]] Needs to be divided by 3 for some reason...
|-
| 0x00000002 || UInt8 || 1 byte per value (0 to 255). Indexes a buffer in [[#VTX1_-_Vertex_Data|VTX1]].
|-
| 0x00000003 || UInt16 || 2 bytes per value (0 to 65535). Indexes a buffer in [[#VTX1_-_Vertex_Data|VTX1]].
|}

=== Primitive Data ===
This chunk contains raw primitives. These are what hold the index buffers. The Index Buffers are ordered the same way the Index Buffer Attributes are ordered. For example, POSITION (UInt16), NORMAL (UInt16), COLOR_0 (UInt8), TEXCOORD_0 (UInt16), would result in the following byte structure: '''PPPP NNNN C0 TXC0''' This repeats for each vertex in the primitive.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Uint8 || Primitive Type

* 0x80 = Individual Quads

* 0x90 = Individual Triangles

* 0x98 = Triangle Strip

* 0xA0 = Triangle Fan

* 0xA8 = Individual Lines

* 0xB0 = Line Strip

* 0xB8 = Individual Points

TODO: Figure out if Quads, Lines, Line Strips, and Points work. TODO: Figure out if "Quad Strips" exist at 0x88.
|-
| 0x04 || Int16 || Vertex Count
|}

=== Matrix Group Definition Table ===
This table defines a list of Matrix Groups for each Shape. A Shape can have multiple Matrix Groups, but only stores the index of the first one. This means that all the Matrix Groups for a given Shape must come directly one after another. It contains only two values: The size of all Primitive Data within this group, and an offset to the first Primitive (relative to the Primitive Data offset defined in SHP1).
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int32 || Primitive Data size
|-
| 0x04 || Int32 || First Primitive offset
|}

=== Matrix Group Data Table ===
This table contains definitions of sub-segments inside the Weight Index Table. How these values are used differs based on the shape matrix calculation type, but official files generally set both usages up correctly regardless.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int16 || [[#DRW1_-_Skinning_Assignments|DRW1]] Matrix ID This is only used with Single Joint shape matrix calculation.
|-
| 0x02 || Int16 || Matrix Count This is only used with Multiple Joint shape matrix calculation.
|-
| 0x04 || Int32 || Starting Weight Index This is only used with Multiple Joint shape matrix calculation.
|}

=== Weight Index Table ===
This table contains several indices into [[#DRW1_-_Skinning_Assignments|DRW1]]. Each index is a Signed 16 value. The values may also contain 0xFFFF, which indicates that the last used index should be used instead. Matrix Groups can select a segment of these indices (up to 10) for use. A Matrix Group must not start with 0xFFFF.

== MAT2 - Material List (Old) ==
Technically supported by the game, but not known to be used by any model.

== MAT3 - Material List ==

== MDL3 - Display List ==

== TEX1 - Texture Data ==
The '''Tex'''ture Information section holds several embedded [[BTI_(File_Format)|BTI]] files that [[#MAT3_-_Material_List|MAT3]] can reference by index for texture assignment.
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || Always '''TEX1''' (ASCII)
|-
| 0x04 || Int32 || The total size of this chunk
|-
| 0x08 || Int16 || The number of [[BTI_(File_Format)|BTI]] files stored.
|-
| 0x0A || Int16 || Padding (0xFFFF)
|-
| 0x0C || Int32 || [[BTI_(File_Format)|BTI]] Header Table Offset
|-
| 0x10 || Int32 || Name table offset
|}

The texture data locations are defined by the [[BTI_(File_Format)|BTI]] headers (which themselves are located directly one after another at the Header Table) 
This structure allows multiple textures that have the same visual data to have their headers point to just one block of visual data. In other words, two identical textures can be "compressed" into one while still having their own properties (wrapping, filtering, etc.)

BMD/BDL (File Format)

2025-10-13T16:34:11Z

Super Hackio: Add TEX1 data

BMD/BDL (File Format)

2025-09-27T00:30:32Z

Super Hackio: /* Shape Data */ Added the Matrix Types

BMD/BDL (File Format)

2025-03-25T07:39:25Z

Super Hackio: INF1 - Scene Nodes

Cutscenes

2025-03-21T16:31:03Z

Super Hackio: /* Camera */

[[Category:Files]]
[[Category:Lists]]
{{WIP}}
'''Todo:'''
*Finish the hardcoded cutscene names.
*More info and research on the use of canm and supported objects.

Cutscenes are flexible, complex scenes, which can execute more freedom in contrast to the SimpleDemoExecutor.
These scenes consist of individual sequences that are played in order. In each sequence, several actions can be executed from certain frames, such as changing the player's position, camera movements, sound effects, and more. To each sequence (and subsequence) different actions are linked, which are then executed at the time of this sequence.

You can best visualize this in a kind of timeline. The timeline consists of the individual sequences, which consist of several actions. At the same time single subscequences can be executed together with the actual sequences.

==Structure==
[[File:Cutscene_Visual-Representation.png|thumb|A visual representation of the first Yoshi Meets cutscene.]]
A cutscene is activated by a demo object via SW_APPEAR within the map and loads several sheet BCSV files located in the demo.arc archive of the respective galaxy/zone. The demo object loads the bcsv files using its defined sheet name and additional "Demo" in front of the file name of the BSCV attached and a respective sheet type at the end of the file name (e.g. '''Demo'''AfterGameOver'''Time''').

In addition, the demo object has its own cutscene name, which is only used in certain cases (e.g. to load certain sequences for [[Starship Mario]]) and also for camera codes. Certain names can be recognized by the game and then loads additional hardcoded settings such as behavior after scene completion. A list of these names [[Cutscenes#Hardcoded_Cutscene_Names|can be found below]].

Objects other than the player object itself can be linked to the cutscene. These then use a cutscene group ID, which on the one hand must match the demo object ID and on the other hand must be entered in the action sheet together with the object's name. If the object is entered in the [[ObjNameTable]], the name from the Japanese column must be entered instead.

If there are several identical objects that are part of a cutscene, you can also define a cast group id for one specific object to distinguish it from the other identical objects for the scene.

===Time===
Defines the individual sequences with their names and length. They are played in the order they are in the list.
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| PartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the sequence
|-
| TotalStep
| style="font-size:12px;" | LONG
| Duration of the sequence in frames
|-
| SuspendFlag
| style="font-size:12px;" | LONG
| If set to 1, pauses the cutscene and resumes gameplay. The cutscene will continue from here next time it is activated.
|-
| WaitUserInputFlag
| style="font-size:12px;" | LONG
|
|}

===SubPart===
Runs additional subsequences in parallel during a sequence.
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| SubPartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the sub sequence
|-
| SubPartTotalStep
| style="font-size:12px;" | LONG
| The length of the sub sequence
|-
| MainPartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the main sequence this sub sequence belongs to
|-
| MainPartStep
| style="font-size:12px;" | LONG
| The frame of the main sequence this sub sequence starts at
|}

===Action===
Picks up objects and can position them to a given GeneralPos and play an animation.

All animation types are supported. For more control you can use [[ActorInfo#ActorInfo|ActorAnimCtrl.bcsv]] for your objects to define multiple animation names of different animation types to the animation name defined in the cutscene.
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| PartName
| style="font-size:12px;" | STRING_OFFSET
| Sequence Name
|-
| CastName
| style="font-size:12px;" | STRING_OFFSET
| Japanese Name of the object (defined in [[ObjNameTable]])
|-
| CastID
| style="font-size:12px;" | LONG
| Cast ID of the object
|-
| ActionType
| style="font-size:12px;" | LONG
| Pick an Action Type from the table below.
|-
| PosName
| style="font-size:12px;" | STRING_OFFSET
| Name of the GeneralPos object for destination location
|-
| AnimName
| style="font-size:12px;" | STRING_OFFSET
| Name of the animation, which can be loaded either from the ARC archive object or from a separate ARC archive with the additional name "Anim".
|}
====Action Types====
Note that these action types are not available for any object that registers as a "Simple Demo Cast".

===== SMG1 =====
{| class="wikitable"
! ID !! Name !! Description
|-
| 0 || Apppear || Makes the object Appear.
|-
| 1 || Kill || Makes the object Disappear (using it's Kill function).
|-
| 2 || Special Function || Executes a function that the object specifically registered to the cutscene. This is object specific, and not every object has one.
|-
| 3 || Special Nerve || Sets the objects Nerve to a nerve specifically registered to the cutscene. This is object specific, and not every object has one.
|-
| 4 || On SW_A || The SW_A of this object will be activated.
|-
| 5 || On SW_B || The SW_B of this object will be activated.
|-
| 6 || Show Model || The model of the object will be unhidden.
|-
| 7 || Hide Model || The model of the object will be hidden.
|-
| 8 || Start NPC Message || Start a conversation with an NPC. Effectively useless because NPC's do not register their text to cutscenes unless the cutscene has a specific name.
|-
| 9 || Start NPC Message (Alt) || Start a conversation with an NPC without stopping Mario's current animation. Effectively useless because NPC's do not register their text to cutscenes unless the cutscene has a specific name.
|-
| 10 || Duplicate of 9 || Duplicate of 9.
|-
| 11 || Play Animation || Plays the animation that "AnimName" is set to. This happens for all Action Types.
|-
| 12 || Off SW_A || The SW_A of this object will be deactivated.
|-
| 13 || Off SW_B || The SW_B of this object will be deactivated.
|}
===== SMG2 =====
{| class="wikitable"
! ID !! Name !! Description
|-
| 0 || Play Animation || Plays the animation that "AnimName" is set to. This happens for all Action Types.
|-
| 1 || Apppear || Makes the object Appear.
|-
| 2 || Kill || Makes the object Disappear (using it's Kill function).
|-
| 3 || Special Function || Executes a function that the object specifically registered to the cutscene. This is object specific, and not every object has one.
|-
| 4 || Special Nerve || Sets the objects Nerve to a nerve specifically registered to the cutscene. This is object specific, and not every object has one.
|-
| 5 || On SW_A || The SW_A of this object will be activated.
|-
| 6 || On SW_B || The SW_B of this object will be activated.
|-
| 7 || Show Model || The model of the object will be unhidden.
|-
| 8 || Hide Model || The model of the object will be hidden.
|-
| 9 || Start NPC Message || Start a conversation with an NPC. Effectively useless because NPC's do not register their text to cutscenes unless the cutscene has a specific name.
|-
| 10 || Start NPC Message (Alt) || Start a conversation with an NPC without stopping Mario's current animation. Effectively useless because NPC's do not register their text to cutscenes unless the cutscene has a specific name.
|-
| 11 || Duplicate of 10 || Duplicate of 10.
|-
| 12 || Off SW_A || The SW_A of this object will be deactivated.
|-
| 13 || Off SW_B || The SW_B of this object will be deactivated.
|-
| 14 || Request Movement Off || Tries to pause execution of this object.
|-
| 15 || Request Movement On || Tries to resume execution of this object.
|-
| 16 || StoryBookWarpDemo || Unknown. Related to StoryBookWarpDemo. Uses 1 as arg.
|-
| 17 || StoryBookWarpDemo || Unknown. Related to StoryBookWarpDemo. Uses 0 as arg.
|-
| 18 || StoryBookWarpDemo || Unknown. Related to StoryBookWarpDemo.
|-
| 19 || StoryBookWarpDemo || Unknown. Related to StoryBookWarpDemo.
|-
| 20 || ? || Unknown. Used at the end of the cutscene where Mario meets Yoshi for the first time.
|}

===Player===
Can position Mario/Luigi to a specific GeneralPos and play an animation.
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| PartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the sequence
|-
| PosName
| style="font-size:12px;" | STRING_OFFSET
| Name of the GeneralPos to teleport the player to
|-
| BckName
| style="font-size:12px;" | STRING_OFFSET
| Name of the animation from MarioAnim.arc to play. (All other animationtypes than BCK are also supported)
|-
| Visible
| style="font-size:12px;" | LONG
|
|}

===Camera===
Can play cameras, which can be played one after another. Can use either a camera code from the Map archive's [[Cameras|CameraParam.bcam]] file, or a key frame camera animation which are controlled via [[CANM]] files, which must be located in the object archive of the targeted object.
By default the camera is fixed on Mario/Luigi.

For BCAM usage, the Camera ID name to be used is composed of the ''PartName'' and the ''Cutscenename'' (not the sheet name): '''e:Cutscenename[PartName]'''.

For CANM usage, the name defined in ''AnimCameraName'' must match the CANM file's name and needs to be placed in the root of the targeted object's archive.
Seems to be supported only by certain objects. This has not yet been fully explored.

{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| PartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the sequence
|-
| CameraTargetName
| style="font-size:12px;" | STRING_OFFSET
| Japanese Name of the object the camera is focused to. (Primarily uses ObjNameTable names)
|-
| CameraTargetCastID
| style="font-size:12px;" | LONG
| Cast ID of the object
|-
| AnimCameraName
| style="font-size:12px;" | STRING_OFFSET
| CANM file name (".canm" extension optional) which must be placed in the root of the targeted object's archive.
|-
| AnimCameraStartFrame
| style="font-size:12px;" | LONG
| The part frame to begin the camera on. -1 will have the camera interpolate to the start of the CANM
|-
| AnimCameraEndFrame
| style="font-size:12px;" | LONG
|
|-
| IsContinuous
| style="font-size:12px;" | LONG
|
|}

===Sound===
Can change music and play sound effects.
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| PartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the sequence
|-
| Bgm
| style="font-size:12px;" | STRING_OFFSET
| [[List_of_Music|Name of the music]] to play.
|-
| SystemSe
| style="font-size:12px;" | STRING_OFFSET
| [[List_of_Sounds_(SMG2)|Name of the soundeffect]] to play.
|-
| ActionSe
| style="font-size:12px;" | STRING_OFFSET
|
|-
| ReturnBgm
| style="font-size:12px;" | LONG
|
|-
| BgmWipeoutFrame
| style="font-size:12px;" | LONG
| Duration in frames for fading out the music. -1 = No fade-out
|-
| AllSoundStopFrame
| style="font-size:12px;" | LONG
|
|}

===Wipe===
Can perform a fade out animation.
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| PartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the sequence
|-
| WipeName
| style="font-size:12px;" | STRING_OFFSET
| The wipe to use. See the [[#WipeName|WipeName]] table below.
|-
| WipeType
| style="font-size:12px;" | LONG
| The function for the Wipe to perform. See the [[#WipeType|WipeType]] table below.
|-
| WipeFrame
| style="font-size:12px;" | LONG
| The amount of frames that the wipe will move for. Higher values = Slower movement
|}

====WipeName====
Below is a list of available WipeName values:
{| class="wikitable"
|-
! Value !! Description
|-
| 円ワイプ || Circle Wipe
|-
| フェードワイプ || Black Fade
|-
| 白フェードワイプ || White Fade
|-
| ゲームオーバー || Game Over
|-
| クッパ || Bowser Face (Death wipe)
|}

''Note: The Mario wipe is missing because the Mario wipe is a System Wipe and not a Scene Wipe. DemoWipes can only be Scene Wipes.''

====WipeType====
Below is the list of Wipe functions. The table below uses the Black Fade as an example.
{| class="wikitable"
|-
! Value !! Description
|-
| 0 || Open Wipe (Fade to Gameplay)
|-
| 1 || Close Wipe (Fade to Black)
|-
| 2 || Force Open Wipe (Cut to Gameplay)
|-
| 3 || Force Close Wipe (Cut to Black)
|}

''Tip: If you need to change wipes while the wipe is closed, use Force Close before using Open for a smoother transition.''

===Hardcoded Cutscene Names===
'''Todo:''' Finish this.
{| class="wikitable"
|-
! Cutscene Name
! Meaning
! Notes
|-
| ベビチコ出会い
| Master Luma Meeting
| -Uses hardcoded cameras -Activates spin after completion when the galaxy uses the StageType "Storybook"
|}

==Tools==
Up to now, there are no tools that allow the cutscenes to be edited directly in a clear interface. Since the cutscenes sheet consists of [[BCSV]] files, they can be edited with any other BCSV editor, like Whitehole. They can also be converted to CSV files and vice versa with Pyjmap.

The tools can be found on the [[Tools_and_Resources|tools and ressources page]].

ActorInfo

2025-03-21T00:22:35Z

Super Hackio: /* InitActor.bcsv */

[[Category:Files]]

= ActorInfo =
'''ActorInfo''' is a folder that only exists in ''SMG2''. it contains files that control certain aspects of objects. Below is a list of every file that can be put in this folder.
{| class="wikitable"
! Filename !! Uses !! Description
|-
| ActionBgmCtrl.bcsv || 13 || Used by bosses to start their music
|-
| ActionFlagCtrl.bcsv || 111 ||
|-
| ActionFootPrintCtrl.bcsv || 1 || Used by ''DinoPackunBaby'' to assist in controlling the footsteps
|-
| ActionScreenBlurCtrl.bcsv || 21 ||
|-
| ActorAnimCtrl.bcsv || 109 ||
|-
| ActorHitReactionCtrl.bcsv || 139 ||
|-
| ActorParam.bcsv || 5 ||
|-
| ActorStateWalk.bcsv || 1 || Used by ''DinoPackunBaby'' to assist in controlling his walk
|-
| AnimBlendTriple.bcsv || 2 ||
|-
| InitActor.bcsv || 529 || Contains information on how the actor gets initialized.
|-
| InitActor2D.bcsv || 1 || Contains information on how the 2D actor gets initialized. Only used by ''Tongari''.
|-
| InitActor2DWater.bcsv || 1 || Contains information on how the 2D Water actor gets initialized. Only used by ''GhostAttackGhost''.
|-
| InitActorCollection.bcsv || 7 || Contains information on how the Collection actor gets initialized. Used by all 7 Powerups that appear on ''Starship Mario''.
|-
| InitActorDemo.bcsv || 10 || Contains information on how the Demo actor gets initialized. Used by ''GrandStar'', ''PowerStar'', and some other objects used in the game's main cutscenes.
|-
| InitActorDemoBellyDragon.bcsv || 2 || Contains information on how the Demo actor gets initialized during a Gobblegut cutscene. Only used by ''KoopaJr'' and ''KoopaJrRobotPod''.
|-
| InitActorDemoTitle.bcsv || 3 || Contains information on how the Demo actor gets initialized while on the Title Screen. Only used by ''DemoTitlePlanet'', ''Tico'', and ''Yoshi''.
|-
| InitActorDemoWithShadow.bcsv || 1 || Contains information on how the Demo actor gets initialized with a shadow. Only used by ''PowerStar''.
|-
| InitActorDummy.bcsv || 5 || Contains information on how the actor gets initialized in dummy form. Used by ''KinokoLifeUp'', ''KinokoOneUp'', ''Kuribo'', ''PowerStar'', and ''Tico''.
|-
| InitActorExit.bcsv || 1 || Contains information on how the exit actor gets initialized. Only used by ''PetitPorter''.
|-
| InitCollision.bcsv || 101 || Contains information on how the collision for this object is created
|-
| InitScale.bcsv || 6 || Contains a Vector3 that represents a size scale.
|-
| InitSensor.bcsv || 303 || Contains information on how to setup hitboxes for this object.
|-
| InitStageEffectCamera.bcsv || 11 || Contains information on how this object interacts with the camera.
|-
| InitStageEffectPad.bcsv || 12 || Contains information on pad. Unknown for sure, but it looks to be related to Wiimote Rumbling
|-
| InitSwitch.bcsv || 114 || Contains information on which switches are used and how
|-
| ItemGenerator.bcsv || 77 || Contains information on what objects to spawn when certain events are triggered (such as "Death by Spin Attack")
|-
| PadAndCameraCtrl.bcsv || 105 ||
|-
| Reaction.bcsv || 3 ||
|-
| Sequence.bcsv || 2 || Used for the Chimp Ice skating minigames
|-
| Shadow.bcsv || 256 || Contains information on how to create shadows for this object. Useful for '''ProductMapObjDataTable''' classes such as ''SimpleMapObj''.
|-
| (ObjectName).banmt || 234 ||
|}

== InitActor.bcsv ==
InitActor.bcsv and it's variants (like InitActor2D.bcsv) are all structured the same way, and define certain values for the object during it's initialization.
{| class="wikitable"
! Field Name !! Type !! Description
|-
| InitFunction || string || The name of the function that this entry corresponds to. Functions: '''Rail''': Only uses ''Data''. "" for "Doesn't use Rails". "Use" for "Can use Rails". "Needs" for "Requires a Rail" '''DefaultPos''': Only uses ''Data''. "o" for Enabled, "x" for Disabled. '''UseScaleForParam''': Only uses ''Data''. "o" for Enabled, "x" for Disabled. '''Model''': Only uses ''Data''. The name of the model to use. '''Executor''': Only uses ''Data''. Check the executor list below this table for more details. '''Light''': Only uses ''Data''. The name of the Light Type to use. '''Binder''': "o" for Enabled, "x" for Disabled. '''Effect''': The name of the Effect group to use. '''Sound''':The name of the Sound group to use. You can offset the sound from the object position using the Param00VecX, Y, and Z. '''Clipping''': Only uses ''Param00F32''. The distance that this object will clip out at. '''GroupClipping''': '''DemoSimpleCastAll''': '''StarPointer''': '''DebugNode''': Useless.
|-
| Data || string || The main data input. Most InitFunctions use this.
|-
| Param00Int || int || An integer parameter
|-
| Param00F32 || float || A float parameter
|-
| Param01F32 || float || A second float parameter
|-
| Param00Str || string || A string parameter, different from the Data parameter.
|-
| Param00VecX || float || The X Value of a Vector3 parameter.
|-
| Param00VecY || float || The Y Value of a Vector3 parameter.
|-
| Param00VecZ || float || The Z Value of a Vector3 parameter.
|}

{| class="wikitable"
! Executor !! Description
|-
| MapObj ||
|-
| MapObjStrongLight ||
|-
| MapObjNoShadow || This object does not get shadows applied to it
|-
| MapObjNoSilhouetted ||
|-
| MapObjDecoration || *Seems to not correctly support environment maps*
|-
| MapObjNoCalcAnim ||
|-
| MapObjMovement ||
|-
| MapObjNoMovement ||
|-
| MapObjIndirect ||
|-
| MapObjIndirectStrongLight ||
|-
| MapObjNoMovementNoCalcAnimIndirectStrongLight ||
|-
| ClippedMapParts ||
|-
| CollisionMapObj ||
|-
| CollisionMapObjWeakLight ||
|-
| CollisionMapObjNoShadow ||
|-
| CollisionMapObjNoShadowNoCalcAnim ||
|-
| CollisionMapObjIndirectNoCalcAnim ||
|-
| Enemy ||
|-
| EnemyDecoration ||
|-
| EnemyIndirect ||
|-
| EnemySilhouette ||
|-
| EnemyNoShadow ||
|-
| EnemyNoMovement ||
|-
| Boss ||
|-
| NpcNoShadow ||
|-
| NpcNoCalcAnim ||
|-
| Ride ||
|-
| RideSilhouette ||
|-
| Planet ||
|-
| PlanetIndirect ||
|-
| DynamicMapObj ||
|-
| PlayerDecoration ||
|-
| Item ||
|-
| Bloom || Renders the object on the Bloom pass, which requires a BloomArea to activate.
|-
| BossBussun ||
|-
| CrystalItem ||
|-
| FireBarBall ||
|-
| GliBird ||
|-
| HipDropStarMove ||
|-
| StoryBook ||
|-
| StoryBookFilter ||
|-
| WorldMapMiniObj ||
|-
| GhostMazeMask ||
|-
| Crystal ||
|-
| Tamakoro ||
|-
| SuperDreamer ||
|-
| Ghost2DWater ||
|-
| WoodLogBridge ||
|}

== Shadow.bcsv ==
Shadow.bcsv is used to create shadows for objects.
{| class="wikitable"
! Field Name !! Type !! Description
|-
| Name || string || Shadow name
|-
| GroupName || string ||
|-
| Joint || string || Name of the joint to attach to
|-
| DropStart || float || How far until the shadow starts to drop
|-
| DropLength || float || How far the shadow drops for
|-
| FollowScale || int || Set to 1 to make the shadow scale with the model (if scaled in an editor from the original size)
|-
| SyncShow || int || Set to 1 to make the shadow clip in and out with it's parent model
|-
| Gravity || int ||
|-
| Collision || int ||
|-
| DropOffsetX || float || X Offset to drop the shadow at.
|-
| DropOffsetY || float || Y Offset to drop the shadow at.
|-
| DropOffsetZ || float || Z Offset to drop the shadow at.
|-
| VolumeStart || float ||
|-
| VolumeEnd || float ||
|-
| VolumeCut || int || Set to 1
|-
| Type || string || '''VolumeBox''': A Box where any shadow responsive object that enters it gets the shadow applied '''VolumeSphere''': '''VolumeCylinder''': '''VolumeOval''': '''VolumeLine''': '''VolumeOvalPole''': '''VolumeFlatModel''': Define the shadow using a shadow model '''SurfaceCircle''': '''SurfaceOval''':
|-
| SizeX || float || X Scale of the shadow
|-
| SizeY || float || Y Scale of the shadow
|-
| SizeZ || float || Z Scale of the shadow
|-
| Radius || float ||
|-
| LineStart || string ||
|-
| LineEnd || string ||
|-
| LineStartRadius || float ||
|-
| LineEndRadius || float ||
|-
| Model || string || Used to specify what model to use for the Shadow
|-
| LocalRotateX || float ||
|-
| LocalRotateY || float ||
|-
| LocalRotateZ || float ||
|}

== InitSensor.bcsv ==
InitSensor.bcsv defines all of the HitSensors that are applied to the actor.

{| class="wikitable"
! Name !! Type !! Description
|-
| SensorName || string ||
|-
| SensorType || string ||
|-
| Radius || float || The radius of the sensor.
|-
| HitSensorNumMax || int || The maximum amount of other sensors that can interact with this sensor.
|-
| JointName || string || The joint to attach this sensor to on the model.
|-
| Callback || string ||
|-
| OffsetX || float || Offset X of the sensor.
|-
| OffsetY || float || Offset Y of the sensor.
|-
| OffsetZ || float || Offset Z of the sensor.
|}

== InitSwitch.bcsv ==
InitSwitch.bcsv defines all of the switches that can be used with the actor.

{| class="wikitable"
! Name !! Type !! Description
|-
| SwitchName || string || The name of the switch.
|-
| Usage || string || The way that the switch is used.
|}

=== Usage Types ===
Below is a table of the available options for the Usage field.
{| class="wikitable"
! Name !! Description
|-
| UseRead || The switch type can be read from.
|-
| NeedRead || The switch type is '''required''' to read from.
|-
| UseWrite || The switch type can be written to.
|-
| NeedWrite || The switch type is '''required''' to write to.
|-
| UseWriteAuto || The switch type can be automatically triggered.
|-
| NeedWriteAuto || The switch type is '''required''' to automatically trigger.
|-
| x || Switch type is disabled.
|}

=== Availability ===
Certain Switches only support specific Usage Types. This table details which switches can use which Usage Types.
{| class="wikitable"
! Switch Name !! Available Usage Types
|-
| SW_APPEAR || '''UseRead''' (calls ''MR::useStageSwitchReadAppear'') '''NeedRead''' (calls ''MR::needStageSwitchReadAppear'')
|-
| SW_DEAD || '''UseWrite''' (calls ''MR::useStageSwitchWriteDead'') '''NeedWrite''' (calls ''MR::needStageSwitchWriteDead'') '''UseWriteAuto''' (calls ''MR::useStageSwitchWriteAutoDead'') '''NeedWriteAuto''' (calls ''MR::needStageSwitchWriteAutoDead'')
|-
| SW_A || '''UseRead''' (calls ''MR::initUseStageSwitchReadA'') '''UseWrite''' (calls ''MR::initUseStageSwitchWriteA'') '''NeedRead''' (calls ''MR::needStageSwitchReadA'') '''NeedWrite''' (calls ''MR::needStageSwitchWriteA'')
|-
| SW_B || '''UseRead''' (calls ''MR::useStageSwitchReadB'') '''UseWrite''' (calls ''MR::initUseStageSwitchWriteB'') '''NeedRead''' (calls ''MR::needStageSwitchReadB'') '''NeedWrite''' (calls ''MR::needStageSwitchWriteB'')
|-
| SW_AWAKE (Optional) || '''UseRead''' (calls ''MR::useStageSwitchAwake'')
|}

== ItemGenerator.bcsv ==
Relates on items that can be generated from the actor.

{| class="wikitable"
! Name !! Type !! Description
|-
| ActionName || string || The action that has to be committed for the item to spawn. These actions are defined through code.
|-
| ItemInfoName || string || The item to spawn. See [[#Item_Info|Item Info]].
|-
| JointName || string || The joint where the item is spawned.
|-
| Count || int || The number of said item to spawn.
|}

=== Item Info ===
{| class="wikitable"
! Name !! Description
|-
| Coinx1 || Spawns a single coin.
|-
| StarPiecex1 || Spawns a single star piece.
|-
| StarPiecex3 || Spawns three star pieces.
|-
| StarPiecex6 || Spawns six star pieces.
|-
| StarPiecex10 || Spawns ten star pieces.
|}

ActorInfo

2025-03-19T19:01:00Z

Super Hackio: /* InitActor.bcsv */ Bloom note

[[Category:Files]]

= ActorInfo =
'''ActorInfo''' is a folder that only exists in ''SMG2''. it contains files that control certain aspects of objects. Below is a list of every file that can be put in this folder.
{| class="wikitable"
! Filename !! Uses !! Description
|-
| ActionBgmCtrl.bcsv || 13 || Used by bosses to start their music
|-
| ActionFlagCtrl.bcsv || 111 ||
|-
| ActionFootPrintCtrl.bcsv || 1 || Used by ''DinoPackunBaby'' to assist in controlling the footsteps
|-
| ActionScreenBlurCtrl.bcsv || 21 ||
|-
| ActorAnimCtrl.bcsv || 109 ||
|-
| ActorHitReactionCtrl.bcsv || 139 ||
|-
| ActorParam.bcsv || 5 ||
|-
| ActorStateWalk.bcsv || 1 || Used by ''DinoPackunBaby'' to assist in controlling his walk
|-
| AnimBlendTriple.bcsv || 2 ||
|-
| InitActor.bcsv || 529 || Contains information on how the actor gets initialized.
|-
| InitActor2D.bcsv || 1 || Contains information on how the 2D actor gets initialized. Only used by ''Tongari''.
|-
| InitActor2DWater.bcsv || 1 || Contains information on how the 2D Water actor gets initialized. Only used by ''GhostAttackGhost''.
|-
| InitActorCollection.bcsv || 7 || Contains information on how the Collection actor gets initialized. Used by all 7 Powerups that appear on ''Starship Mario''.
|-
| InitActorDemo.bcsv || 10 || Contains information on how the Demo actor gets initialized. Used by ''GrandStar'', ''PowerStar'', and some other objects used in the game's main cutscenes.
|-
| InitActorDemoBellyDragon.bcsv || 2 || Contains information on how the Demo actor gets initialized during a Gobblegut cutscene. Only used by ''KoopaJr'' and ''KoopaJrRobotPod''.
|-
| InitActorDemoTitle.bcsv || 3 || Contains information on how the Demo actor gets initialized while on the Title Screen. Only used by ''DemoTitlePlanet'', ''Tico'', and ''Yoshi''.
|-
| InitActorDemoWithShadow.bcsv || 1 || Contains information on how the Demo actor gets initialized with a shadow. Only used by ''PowerStar''.
|-
| InitActorDummy.bcsv || 5 || Contains information on how the actor gets initialized in dummy form. Used by ''KinokoLifeUp'', ''KinokoOneUp'', ''Kuribo'', ''PowerStar'', and ''Tico''.
|-
| InitActorExit.bcsv || 1 || Contains information on how the exit actor gets initialized. Only used by ''PetitPorter''.
|-
| InitCollision.bcsv || 101 || Contains information on how the collision for this object is created
|-
| InitScale.bcsv || 6 || Contains a Vector3 that represents a size scale.
|-
| InitSensor.bcsv || 303 || Contains information on how to setup hitboxes for this object.
|-
| InitStageEffectCamera.bcsv || 11 || Contains information on how this object interacts with the camera.
|-
| InitStageEffectPad.bcsv || 12 || Contains information on pad. Unknown for sure, but it looks to be related to Wiimote Rumbling
|-
| InitSwitch.bcsv || 114 || Contains information on which switches are used and how
|-
| ItemGenerator.bcsv || 77 || Contains information on what objects to spawn when certain events are triggered (such as "Death by Spin Attack")
|-
| PadAndCameraCtrl.bcsv || 105 ||
|-
| Reaction.bcsv || 3 ||
|-
| Sequence.bcsv || 2 || Used for the Chimp Ice skating minigames
|-
| Shadow.bcsv || 256 || Contains information on how to create shadows for this object. Useful for '''ProductMapObjDataTable''' classes such as ''SimpleMapObj''.
|-
| (ObjectName).banmt || 234 ||
|}

== InitActor.bcsv ==
InitActor.bcsv and it's variants (like InitActor2D.bcsv) are all structured the same way, and define certain values for the object during it's initialization.
{| class="wikitable"
! Field Name !! Type !! Description
|-
| InitFunction || string || The name of the function that this entry corresponds to. Functions: '''Rail''': Only uses ''Data''. "" for "Doesn't use Rails". "Use" for "Can use Rails". "Needs" for "Requires a Rail" '''DefaultPos''': Only uses ''Data''. "o" for Enabled, "x" for Disabled. '''UseScaleForParam''': Only uses ''Data''. "o" for Enabled, "x" for Disabled. '''Model''': Only uses ''Data''. The name of the model to use. '''Executor''': Only uses ''Data''. Check the executor list below this table for more details. '''Light''': Only uses ''Data''. The name of the Light Type to use. '''Binder''': "o" for Enabled, "x" for Disabled. '''Effect''': The name of the Effect group to use. '''Sound''':The name of the Sound group to use. You can offset the sound from the object position using the Param00VecX, Y, and Z. '''Clipping''': Only uses ''Param00F32''. The distance that this object will clip out at. '''GroupClipping''': '''DemoSimpleCastAll''': '''StarPointer''': '''DebugNode''': Useless.
|-
| Data || string || The main data input. Most InitFunctions use this.
|-
| Param00Int || int || An integer parameter
|-
| Param00F32 || float || A float parameter
|-
| Param01F32 || float || A second float parameter
|-
| Param00Str || string || A string parameter, different from the Data parameter.
|-
| Param00VecX || float || The X Value of a Vector3 parameter.
|-
| Param00VecY || float || The Y Value of a Vector3 parameter.
|-
| Param00VecZ || float || The Z Value of a Vector3 parameter.
|}

{| class="wikitable"
! Executor !! Description
|-
| MapObj ||
|-
| MapObjStrongLight ||
|-
| MapObjNoShadow || This object does not get shadows applied to it
|-
| MapObjNoSilhouetted ||
|-
| MapObjDecoration ||
|-
| MapObjNoCalcAnim ||
|-
| MapObjMovement ||
|-
| MapObjNoMovement ||
|-
| MapObjIndirect ||
|-
| MapObjIndirectStrongLight ||
|-
| MapObjNoMovementNoCalcAnimIndirectStrongLight ||
|-
| ClippedMapParts ||
|-
| CollisionMapObj ||
|-
| CollisionMapObjWeakLight ||
|-
| CollisionMapObjNoShadow ||
|-
| CollisionMapObjNoShadowNoCalcAnim ||
|-
| CollisionMapObjIndirectNoCalcAnim ||
|-
| Enemy ||
|-
| EnemyDecoration ||
|-
| EnemyIndirect ||
|-
| EnemySilhouette ||
|-
| EnemyNoShadow ||
|-
| EnemyNoMovement ||
|-
| Boss ||
|-
| NpcNoShadow ||
|-
| NpcNoCalcAnim ||
|-
| Ride ||
|-
| RideSilhouette ||
|-
| Planet ||
|-
| PlanetIndirect ||
|-
| DynamicMapObj ||
|-
| PlayerDecoration ||
|-
| Item ||
|-
| Bloom || Renders the object on the Bloom pass, which requires a BloomArea to activate.
|-
| BossBussun ||
|-
| CrystalItem ||
|-
| FireBarBall ||
|-
| GliBird ||
|-
| HipDropStarMove ||
|-
| StoryBook ||
|-
| StoryBookFilter ||
|-
| WorldMapMiniObj ||
|-
| GhostMazeMask ||
|-
| Crystal ||
|-
| Tamakoro ||
|-
| SuperDreamer ||
|-
| Ghost2DWater ||
|-
| WoodLogBridge ||
|}

== Shadow.bcsv ==
Shadow.bcsv is used to create shadows for objects.
{| class="wikitable"
! Field Name !! Type !! Description
|-
| Name || string || Shadow name
|-
| GroupName || string ||
|-
| Joint || string || Name of the joint to attach to
|-
| DropStart || float || How far until the shadow starts to drop
|-
| DropLength || float || How far the shadow drops for
|-
| FollowScale || int || Set to 1 to make the shadow scale with the model (if scaled in an editor from the original size)
|-
| SyncShow || int || Set to 1 to make the shadow clip in and out with it's parent model
|-
| Gravity || int ||
|-
| Collision || int ||
|-
| DropOffsetX || float || X Offset to drop the shadow at.
|-
| DropOffsetY || float || Y Offset to drop the shadow at.
|-
| DropOffsetZ || float || Z Offset to drop the shadow at.
|-
| VolumeStart || float ||
|-
| VolumeEnd || float ||
|-
| VolumeCut || int || Set to 1
|-
| Type || string || '''VolumeBox''': A Box where any shadow responsive object that enters it gets the shadow applied '''VolumeSphere''': '''VolumeCylinder''': '''VolumeOval''': '''VolumeLine''': '''VolumeOvalPole''': '''VolumeFlatModel''': Define the shadow using a shadow model '''SurfaceCircle''': '''SurfaceOval''':
|-
| SizeX || float || X Scale of the shadow
|-
| SizeY || float || Y Scale of the shadow
|-
| SizeZ || float || Z Scale of the shadow
|-
| Radius || float ||
|-
| LineStart || string ||
|-
| LineEnd || string ||
|-
| LineStartRadius || float ||
|-
| LineEndRadius || float ||
|-
| Model || string || Used to specify what model to use for the Shadow
|-
| LocalRotateX || float ||
|-
| LocalRotateY || float ||
|-
| LocalRotateZ || float ||
|}

== InitSensor.bcsv ==
InitSensor.bcsv defines all of the HitSensors that are applied to the actor.

{| class="wikitable"
! Name !! Type !! Description
|-
| SensorName || string ||
|-
| SensorType || string ||
|-
| Radius || float || The radius of the sensor.
|-
| HitSensorNumMax || int || The maximum amount of other sensors that can interact with this sensor.
|-
| JointName || string || The joint to attach this sensor to on the model.
|-
| Callback || string ||
|-
| OffsetX || float || Offset X of the sensor.
|-
| OffsetY || float || Offset Y of the sensor.
|-
| OffsetZ || float || Offset Z of the sensor.
|}

== InitSwitch.bcsv ==
InitSwitch.bcsv defines all of the switches that can be used with the actor.

{| class="wikitable"
! Name !! Type !! Description
|-
| SwitchName || string || The name of the switch.
|-
| Usage || string || The way that the switch is used.
|}

=== Usage Types ===
Below is a table of the available options for the Usage field.
{| class="wikitable"
! Name !! Description
|-
| UseRead || The switch type can be read from.
|-
| NeedRead || The switch type is '''required''' to read from.
|-
| UseWrite || The switch type can be written to.
|-
| NeedWrite || The switch type is '''required''' to write to.
|-
| UseWriteAuto || The switch type can be automatically triggered.
|-
| NeedWriteAuto || The switch type is '''required''' to automatically trigger.
|-
| x || Switch type is disabled.
|}

=== Availability ===
Certain Switches only support specific Usage Types. This table details which switches can use which Usage Types.
{| class="wikitable"
! Switch Name !! Available Usage Types
|-
| SW_APPEAR || '''UseRead''' (calls ''MR::useStageSwitchReadAppear'') '''NeedRead''' (calls ''MR::needStageSwitchReadAppear'')
|-
| SW_DEAD || '''UseWrite''' (calls ''MR::useStageSwitchWriteDead'') '''NeedWrite''' (calls ''MR::needStageSwitchWriteDead'') '''UseWriteAuto''' (calls ''MR::useStageSwitchWriteAutoDead'') '''NeedWriteAuto''' (calls ''MR::needStageSwitchWriteAutoDead'')
|-
| SW_A || '''UseRead''' (calls ''MR::initUseStageSwitchReadA'') '''UseWrite''' (calls ''MR::initUseStageSwitchWriteA'') '''NeedRead''' (calls ''MR::needStageSwitchReadA'') '''NeedWrite''' (calls ''MR::needStageSwitchWriteA'')
|-
| SW_B || '''UseRead''' (calls ''MR::useStageSwitchReadB'') '''UseWrite''' (calls ''MR::initUseStageSwitchWriteB'') '''NeedRead''' (calls ''MR::needStageSwitchReadB'') '''NeedWrite''' (calls ''MR::needStageSwitchWriteB'')
|-
| SW_AWAKE (Optional) || '''UseRead''' (calls ''MR::useStageSwitchAwake'')
|}

== ItemGenerator.bcsv ==
Relates on items that can be generated from the actor.

{| class="wikitable"
! Name !! Type !! Description
|-
| ActionName || string || The action that has to be committed for the item to spawn. These actions are defined through code.
|-
| ItemInfoName || string || The item to spawn. See [[#Item_Info|Item Info]].
|-
| JointName || string || The joint where the item is spawned.
|-
| Count || int || The number of said item to spawn.
|}

=== Item Info ===
{| class="wikitable"
! Name !! Description
|-
| Coinx1 || Spawns a single coin.
|-
| StarPiecex1 || Spawns a single star piece.
|-
| StarPiecex3 || Spawns three star pieces.
|-
| StarPiecex6 || Spawns six star pieces.
|-
| StarPiecex10 || Spawns ten star pieces.
|}

BMD/BDL (File Format)

2025-03-01T23:39:21Z

Super Hackio: /* INF1 - Scene Information */ Added missing Offset

BMD/BDL (File Format)

2025-03-01T23:35:52Z

Super Hackio: Added note about how INF1 counts "Verticies"

BMD/BDL (File Format)

2025-02-06T19:20:11Z

Super Hackio: Added JNT1

BMD/BDL (File Format)

2025-01-10T04:22:49Z

Super Hackio:

BMD/BDL (File Format)

2025-01-09T22:17:20Z

Super Hackio: Early SHP1 writeup

BMD/BDL (File Format)

2025-01-08T18:52:23Z

Super Hackio: A bunch of VTX1 docs

BMD/BDL (File Format)

2025-01-08T16:10:37Z

Super Hackio: Add section headers

BMD/BDL (File Format)

2025-01-02T07:40:51Z

Super Hackio:

BMD/BDL (File Format)

2025-01-02T04:40:45Z

Super Hackio:

BMD/BDL (File Format)

2025-01-01T00:49:41Z

Super Hackio: Begin a BMD/BDL page with the goal to actually have a complete one

Decompiling

2024-12-27T14:57:52Z

Super Hackio: Add Overload Symbol suffixes

[[Category:Guides]]
[[Category:Decompiling]]
{{WIP}}

== Introduction ==
''Decompiling'' is the process of taking assembly code and turning it back into a higher level language such as C or C++. It is essentially the reverse of ''compiling''. ''Matching decompilation'' is the process of decompiling, but having the compiled code match the original assembly 1:1. While matching decompilation is harder than normal decompiling, it can become easier when you understand the patterns of the compiler used. This page aims to let new people understand how this process works, and hopefully be able to get new people into decompilation! While you do not need to be an expert at C or C++ to decompile, it is recommended that you have some experience before attempting decompilation. It is also very recommended that you have some prior knowledge of PowerPC assembly, as that is the key to understanding how a function works. [https://www.nxp.com/docs/en/reference-manual/MPC82XINSET.pdf This document] is a good way to learn or refresh knowledge of the PowerPC architecture. [https://www.warthman.com/images/IBM_PPC_Compiler_Writer%27s_Guide-cwg.pdf This document] is also good to learn some of the patterns that CodeWarrior does.

== Getting Set Up ==
To begin decompiling ''Super Mario Galaxy'', you first need to set up the environment. You will need the following tools:
* [https://gitforwindows.org/ Git (Windows)]
* Any IDE ([https://code.visualstudio.com/ Visual Studio Recommended])
* [https://www.python.org/downloads/release/python-397/ Python 3.9.7]
* IDA Pro (recommended) or Ghidra (Not recommended)
* [https://shibbo.net/smg/RMGK01_01.idb SMG1 Korean IDB (For IDA)]
* A ''Super Mario Galaxy'' Korean region DOL.

After you have acquired all of these, setting up [https://github.com/shibbo/Petari Petari] is very simple.

# With a new command prompt open, type in '''git clone https://github.com/shibbo/Petari'''. This will clone the repository into a directory called "Petari".
# In this new "Petari" folder, place the SMG1 Korean '''main.dol''' into this folder, and rename it to '''baserom.dol'''.
# Open a new command prompt in the "Petari" folder.
# Run the command '''python setup.py'''. This will verify your DOL and install all of the libraries used, and the compilers we use to compile the code.
# Run the command '''python build.py'''. This will build the entire project. If you see any warnings, do not worry about them.

== Environment ==
To properly utilize and use ''Petari'', it is necessary to understand the structure of the environment. Petari is structured in a way that makes it easy to access and use.

{| class="wikitable"
|-
! Folder Name !! Description
|-
| archive || The folder that gets created when '''build.py -link''' is ran. Contains an archive of the object files in each library.
|-
| build || The folder that gets created when '''build.py''' is ran. Contains the compiled object files.
|-
| csv || Contains CSV files that store the status of functions being matched.
|-
| data || Contains map files and the percentage badges for the GitHub repo.
|-
| docs || The folder that gets created when '''progress.py''' is ran. Contains all of the Markdown documentation for matching status.
|-
| include || Contains all of the header files for ''Super Mario Galaxy'' specific code.
|-
| libs || Contains this folder structure but for different libraries used by the game.
|-
| scripts || Various scripts used in IDA for generating headers.
|-
| source || Contains all of the source files for ''Super Mario Galaxy'' specific code.
|}

== Libraries ==
''Super Mario Galaxy'' uses a lot of libraries for certain functionality such as heaps, layouts, OS specific code, and more. Each library described in the table below are '''statically linked''' to the game, so every library's used code is inside of the ''main.dol''.

=== Non-SMG Libraries ===
{| class="wikitable"
|-
! Name !! Language !! Description
|-
| JSystem || C++ || Contains classes for backend things, such as heaps and linked lists.
|-
| MetroTRK || C || Target Resident Kernel, for debugging.
|-
| MSL_C || C & C++ || Contains standard library functions and types.
|-
| nw4r || C++ || Contains classes for sounds, layouts, and more. (SMG only uses the layouts and some math functions)
|-
| Runtime || C & C++ || Contains functions that relate to CodeWarrior's runtime code generation (ctor / dtor lists, etc)
|-
| RVL_SDK || C || Contains functions that relate to the Wii's "OS".
|-
| RVLFaceLib || C || Contains functions that relate to Miis.
|}

=== SMG Libraries ===
All of ''Super Mario Galaxy'''s libraries are written in C++.

{| class="wikitable"
|-
! Header text !! Header text
|-
| Animation || Library for animation playing.
|-
| AreaObj || Library for invisible areas that can be accessed by players in the game.
|-
| AudioLib || N/A
|-
| Boss || Library for all of the bosses and mini-bosses in the game.
|-
| Camera || Library for all camera types.
|-
| Demo || Library for all cutscenes.
|-
| Effect || Library for all effect rendering.
|-
| Enemy || Library for all enemies.
|-
| GameAudio || N/A
|-
| Gravity || Library for all of the gravity types in the game.
|-
| LiveActor || Library for LiveActor, which is an actor that can switch states.
|-
| Map || Library for map classes that do not directly interact with the player. (ie switches)
|-
| MapObj || Library for all of the map objects in the game.
|-
| NameObj || Library for the most basic form of an object in the game.
|-
| NPC || Library for all of the non-playable characters.
|-
| NWC24 || Library for the mail system in the game.
|-
| Player || Library for all of the player related functions.
|-
| RhythmLib || N/A
|-
| Ride || Library for all of the actors that can be controlled by the player.
|-
| Scene || Library for all of the game scene related code.
|-
| Screen || Library for all of the layouts in the game.
|-
| Speaker || Library for the sound effect playing done on the Wiimote.
|-
| System || Library for a lot of the game's backend systems.
|-
| Util || Library for utility functions and classes.
|}

== Basics ==
To properly decompile, it is vital to know how a lot of the assembly will translate into C / C++ code. Here are a couple of patterns that you will see when decompiling code.

== Class Mapping ==
=== Base Class ===
The first step to decompiling a class is to map out the class itself. You need to be sure that you document every member, its type (as close as you can guess), its virtual functions, and more. The easiest way to achieve this is to look at the class's ''constructor''. Seen below, is an example of a ''constructor''.

[[Image:NameObj_Ctor.png|frameless|700px|The constructor for ''NameObj''.]]

There are a couple of takeaways from this screenshot:
* The constructor passes an argument, which is a '''const char *''' (contained in r4) and is stored in (r3 + 0x4).
* (r3 + 0x0) is where the vtable is ''usually'' stored when a class has virtual functions. There are rare execptions.
* (r3 + 0x8) is stored with a '''sth''', which means that it is a '''short''' datatype.
* (r3 + 0xA) is also stored with a '''sth''', but with a '''-1''' value, so we know for sure that this type is ''signed''.

Keep in mind that a constructor does not have to initialize every single member variable in the class! So there could be other members in a class that aren't mentioned in the constructor at all. After you look at the constructor, look around at the ''member functions'' to see if they use any members that are not initialized in the constructor. You can always verify if your class setup is correct when you can find where this class is created using the '''new''' operator. Check if the size passed to the '''new''' call matches the size of the class that you have mapped. If it is smaller, you are missing members. If it is bigger, you have too many! Remember that the vtable is implicitly stored at '''(this + 0x0)''', so you do not have to explicitly define it. With all of these members documented, our class setup looks a little like this so far:

<pre>
class NameObj {
public:
NameObj(const char *pName);

/* remember that the vtable will be placed here once we define our virtuals! */
/* 0x4 */ const char* mName;
/* 0x8 */ volatile u16 mFlags;
/* 0xA */ s16 mExecutorIdx;
};
</pre>

After the members comes the '''vtable''', or ''virtual table''. It is an array of function pointers that can be overridden by classes that inherit the parent class. The vtable for '''NameObj''' looks like this:
[[Image:NameObj_Vtable.png|frameless|700px|The vtable for ''NameObj''.]]

To document the vtable, you simply document every single function placed here that contains the class name of the class you are currently decompiling. Since ''NameObj'' is a base class, every single function here is going to be defined. If a class overrides a function, you will only document the functions that are overridden. After documenting the vtable, our class looks something like this:

<pre>
class NameObj {
public:
NameObj(const char *pName);

virtual ~NameObj();
virtual void init(const JMapInfoIter &rIter);
virtual void initAfterPlacement();
virtual void movement();
virtual void draw() const;
virtual void calcAnim();
virtual void calcViewAndEntry();

/* remember that the vtable will be placed here once we define our virtuals! */
/* 0x4 */ const char* mName;
/* 0x8 */ volatile u16 mFlags;
/* 0xA */ s16 mExecutorIdx;
};
</pre>

Once the vtable is complete, you want to document all of the member functions that are in the class. Since ''Super Mario Galaxy 1'' has a symbol map, we can easily find the member functions that ''NameObj'' contains. Once you have figured out their return types and their arguments, you can finish mapping out a class! After finding all of ''NameObj'''s member functions, the class looks like this:

<pre>
class NameObj {
public:
NameObj(const char *pName);

virtual ~NameObj();
virtual void init(const JMapInfoIter &rIter);
virtual void initAfterPlacement();
virtual void movement();
virtual void draw() const;
virtual void calcAnim();
virtual void calcViewAndEntry();

void initWithoutIter();
void setName(const char *pName);
void executeMovement();
void requestSuspend();
void requestResume();
void syncWithFlags();

/* remember that the vtable will be placed here once we define our virtuals! */
/* 0x4 */ const char* mName;
/* 0x8 */ volatile u16 mFlags;
/* 0xA */ s16 mExecutorIdx;
};
</pre>

=== Inheriting Class ===
The process of mapping a class that inherits another class is mainly the same as mapping a base class, except there are things to watch out for so you don't accidentally duplicate a member variable. The first step is to look at the ''constructor'' of the class you want to map:

[[Image:TripodBossCoin_Ctor.png|frameless|700px|The constructor for ''TripodBossCoin''.]]

There are a few takeaways from this by looking at the constructor:
* The class inherits NameObj. Since ''NameObj'' is 0xC bytes long, we know that any member variables for ''TripodBossCoin'' start at '''0xC'''.
* The vtable pointer '''(this + 0x0)''' from ''NameObj'' is overridden with the vtable for ''TripodBossCoin'' implicitly.
* '''(this + 0xC)''' is a 32-bit integer initialized to 0. It is not possible to determine if it is signed or not from this store alone.
* '''(this + 0x10)''' is the same scenario as '''(this + 0xC)'''.
* There is a direct instance of ''JGeometry::TMatrix34<JGeometry::SMatrix34C<f32>'' at 0x14. (in Petari & Syati this is typedef'd as ''TMtx34f''). Since ''TMtx34f'' is 0x30 in size, the next member variable is at 0x14 + 0x30, which is '''0x44'''.
* '''(this + 0x44)''' is a signed 32-bit integer, due to '''-1''' being stored to it.

After these observations, our class looks like this:
<pre>
class TripodBossCoin : public NameObj {
public:
TripodBossCoin(const char *);

u32 _C;
u32 _10;
TMtx34f _14;
s32 _44;
};
</pre>

Next are the virtuals. The process is a little different from a base class. Let's take a look at the vtable for ''TripodBossCoin'':

[[Image:TripodBossCoin_Vtable.png|frameless|700px|The vtable for ''TripodBossCoin''.]]

The biggest takeaway from this screenshot is that only three virtuals are overriden by ''TripodBossCoin''. And those three functions are '''TripodBossCoin::~TripodBossCoin()''', '''TripodBossCoin::init()''' and '''TripodBossCoin::movement()'''. So we define them as such:

<pre>
class TripodBossCoin : public NameObj {
public:
TripodBossCoin(const char *);

virtual ~TripodBossCoin();
virtual void init(const JMapInfoIter &);
virtual void movement();

u32 _C;
u32 _10;
TMtx34f _14;
s32 _44;
};
</pre>

It is worth noting that the '''override''' keyword was not a part of the C++ standard at this point in time, so all overrides are implicit. After all of this is done, you simply have to repeat the process for base classes and document the member functions that are a part of the class.

=== Loops ===
==== Predefined bounds ====
Let's take a simple loop that stores nullptr in each 8 elements of a pointer array.

<pre>
class TestClass {
public:
TestClass();

int* mPointers[8];
};

TestClass::TestClass() {
for (int i = 0; i < 8; i++) {
mPointers[i] = nullptr;
}
}
</pre>

The output assembly would look something like:

<pre>
li r0, 8 # there are 8 elements in this loop
li r5, 0 # the value to store in the element (nullptr)
li r4, 0 # the current element offset in the loop
mtctr r0 # move the number of iterations into the counter register (8)

loop:
stwx r5, r3, r4 # store 0 (r5) into the array at r3 (this) + r4 (our current offset, which is i * 4)
addi r4, r4, 4 # increment our offset by sizeof(int) since integers are 32-bits
bdnz+ loop # branch back to our loop again
</pre>

==== Variable Length Bounds ====
Let's take a simple loop that stores nullptr in each element of a variable-length array. We will have a class with two members, one that contains the pointer array itself, and another that stores the number of pointers.

<pre>
class TestClass {
public:
TestClass();

int** mPointers;
int mNumPointers;
};

TestClass::TestClass() {
mNumPointers = 8;
for (int i = 0; i < mNumPointers ; i++) {
mPointers[i] = nullptr;
}
}
</pre>

Because we do not know how many pointers we have stored, we cannot use the counter register like we did with a fixed-size array. Instead, the compiler will use a cmpw (signed integer) or cmplw (unsigned) instruction to compare the current iteration to how many pointers are stored in the class.

<pre>
li r0, 8 # there are 8 elements in this loop
li r7, 0 # the value to store in the element (nullptr)
stw r0, 4(r3) # r3 + 4 is the offset to our member variable "mNumPointers"
mr r6, r7 # simple copy of the 0 value so we can also use it for our counter
li r4, 0 # load 0 into our offset
b loop # branch into our loop

loop:
lwz r5, 0(r3) # load our pointer array from this + 0
addi r7, r7, 1 # increment our index by 1
stwx r6, r5, r4 # store our nullptr value (r6) into r5 + r4 (ptrArray + currentOffset)
addi r4, r4, 4 # increment our offset by sizeof(int) since integers are 32-bits
lwz r0, 4(r3) # load our number of pointers we will increment by (mNumPointers)
cmpw r7, r0 # compare our number of pointers to the current index in our loop
blt+ loop # branch if the number is less than mNumPointers
</pre>

==== Structure Access In Arrays (Pointer Array) ====
More complex forms of loops comes into play when you are iterating through structures and storing / loading members from those structures. Let's take this class for example:
<pre>
struct TestStruct {
int SomeMember;
int AnotherMember;
};

class TestClass {
public:
TestClass();

void storeVals();

TestStruct** mStructures;
int mNumStructures;
};
</pre>
For the sake of simplicity, let's assume that the TestClass constructor initializes the number of structures to 8, and constructs them accordingly. With that in mind, let's see how a struct store will work.
<pre>
void TestClass::storeVals() {
for (int i = 0; i < mNumStructures; i++) {
mStructures[i]->AnotherMember = 5;
}
}
</pre>
The output assembly would look something like:
<pre>
li r7, 0 # our "i" used in the loop, starts at 0
li r4, 0 # our current offset into the array
li r6, 5 # the value we are storing into the array
b loop

loop:
lwz r5, 0(r3) # load the array pointer
addi r7, r7, 1 # increment our current index (i) by 1
lwzx r5, r5, r4 # load the current structure, mStructures[i] where r4 is the current offset
addi r4, r4, 4 # increment our offset by sizeof(TestStruct*), which is 4
stw r6, 4(r5) # store our value (5) into (mStructures[i] + 4), which is our AnotherMember
lwz r0, 4(r3) # load the number of structures from TestClass
cmpw r7, r0 # compare the current index to our value in TestClass
blt+ loop # loop back if it is less than the value
</pre>

==== Structure Access In Arrays (Direct Array) ====
Let's take the previous example and modify it a little. Instead of making an array of pointers to the struct instances, let's store the array directly into our class instance.
<pre>
struct TestStruct {
int SomeMember;
int AnotherMember;
};

class TestClass {
public:
TestClass();

void storeVals();

TestStruct mStructures[8];
};
</pre>
Again, let us assume that the array has already been constructed and everything is initialized as it should be.
<pre>
void TestClass::storeVals() {
for (int i = 0; i < 8; i++) {
mStructures[i].AnotherMember = 5;
}
}
</pre>
The output assembly would look something like:
<pre>
li r0, 8 # load our number of iterations (8)
li r4, 0 # current offset into the array. initialized at 0
li r6, 5 # the value to store into the array
mtctr r0 # move the number of iterations into the counter register

loop:
add r5, r3, r4 # jump to the offset into the array. r5 = (this + 0) + r4
addi r4, r4, 8 # increment our current offset by sizeof(TestStruct), which is 8
stw r6, 4(r5) # store our constant value (5) into the loaded struct + 4 (AnotherMember)
bdnz+ loop # branch back to the loop if the counter is not 8
</pre>

== Operator Overloads ==
There are specific ways that CodeWarrior mangles symbols when overloading operators for classes.
{| class="wikitable"
! Operator !! Mangled Symbol
|-
| "+" || "pl"
|-
| "-" || "mi"
|-
| "*" || "ml"
|-
| "/" || "dv"
|-
| "%" || "md"
|-
| "^" || "er"
|-
| "/=" || "adv"
|-
| "&" || "ad"
|-
| "|" || "or"
|-
| "~" || "co"
|-
| "!" || "nt"
|-
| "=" || "as"
|-
| "<" || "lt"
|-
| ">" || "gt"
|-
| "+=" || "apl"
|-
| "-=" || "ami"
|-
| "*=" || "amu"
|-
| "%=" || "amd"
|-
| "^=" || "aer"
|-
| "&=" || "aad"
|-
| "|=" || "aor"
|-
| "<<" || "ls"
|-
| ">>" || "rs"
|-
| ">>=" || "ars"
|-
| "<<=" || "als"
|-
| "==" || "eq"
|-
| "!=" || "ne"
|-
| "<=" || "le"
|-
| ">=" || "ge"
|-
| "&&" || "aa"
|-
| "||" || "oo"
|-
| "++" || "pp"
|-
| "--" || "mm"
|-
| "()" || "cl"
|-
| "[]" || "vc"
|-
| "->" || "rf"
|-
| "," || "cm"
|-
| "->*" || "rm"
|}

MediaWiki:Sidebar

2024-12-18T06:28:00Z

Super Hackio: I don't understand mediawiki...

MediaWiki:Sidebar

2024-12-18T06:27:28Z

Super Hackio: ???

MediaWiki:Sidebar

2024-12-18T06:24:41Z

Super Hackio: Fix Object Database link

BMS (File Format)

2024-10-23T15:09:52Z

Super Hackio:

== File Format ==
BMS files are '''B'''inary '''M'''usic '''S'''equences that store commands for the audio engine to play notes, similar to the MIDI file format.

== Data ==
BMS files contain raw instructions for the audio engine. There are no headers or filesize checks. Each instruction (OpCode) stands for its own function in the engine. The following table lists all JAudio2 OpCodes that have functions in SMG2:

{| class="wikitable"
|-
! OpCode
! Function (SMG/SMG2)
! Usage
! Example
! Description
|-
| 00 01 02 ... 7D 7E 7F
|
| {OpCode[1]} {Voice[1]} {Velocity[1]} OpCode: one byte with range 0x00 through 0x7F. 0x00 = C-1, 0x60 = C4 (middle C), 0x7F = G9. Voice: one byte with range 0x01 through 0x07 (needs testing/verification). Each Voice can only hold one Note. Velocity: one byte with range 0x00 through 0x7F. 0x00 = 0, 0x7F = 127. If the Voice is not 1 - 7, the game will treat this note as a Midi Gate note, and will expect a 4th value that is one or more bytes with range 0x00 through 0xFF. If the leading byte is 0x80 (bit 7 = 1) or greater, another following byte will be taken into account. It is unknown what effects this has on the output
| 64 02 68 64: Key E4 02: Voice 2 68: Velocity 104
| Starts playing a Note with the previously defined Instrument (see E1, E2 and E3).
|-
| 80
| Unknown. Seems to do nothing based on the code...
|
|
|
|-
| 81 ... 87
|
| {OpCode[1]} OpCode: one byte with range 0x81 through 0x87. 0x81 = Close Voice 1, 0x87 = Close Voice 7.
|
| Stops playing a Note.
|-
| 88 ... 8F
| Unknown
|
|
|
|-
| 90 ... 9F
| Unknown
|
|
|
|-
| A0
| NULL
|
|
|
|-
| A1
| NULL
|
|
|
|-
| A2
| NULL
|
|
|
|-
| A3
| NULL
|
|
|
|-
| A4
| NULL
|
|
|
|-
| A5
| NULL
|
|
|
|-
| A6
| NULL
|
|
|
|-
| A7
| NULL
|
|
|
|-
| A8
| NULL
|
|
|
|-
| A9
| NULL
|
|
|
|-
| AA
| NULL
|
|
|
|-
| AB
| NULL
|
|
|
|-
| AC
| NULL
|
|
|
|-
| AD
| NULL
|
|
|
|-
| AE
| NULL
|
|
|
|-
| AF
| NULL
|
|
|
|-
| B0
| Extended Opcode Indicator
|
|
|
|-
| B1
| JASSeqParser::cmdNoteOn
|
|
|
|-
| B2
| JASSeqParser::cmdNoteOff
|
|
|
|-
| B3
| JASSeqParser::cmdNote
|
|
|
|-
| B4
| JASSeqParser::cmdSetLastNote
|
|
|
|-
| B5
| NULL
|
|
|
|-
| B6
| NULL
|
|
|
|-
| B7
| NULL
|
|
|
|-
| B8
| JASSeqParser::cmdParamE
|
|
|
|-
| B9
| JASSeqParser::cmdParamI
|
|
|
|-
| BA
| JASSeqParser::cmdParamEI
|
|
|
|-
| BB
| JASSeqParser::cmdParamII
|
|
|
|-
| BC
| NULL
|
|
|
|-
| BD
| NULL
|
|
|
|-
| BE
| NULL
|
|
|
|-
| BF
| NULL
|
|
|
|-
| C0
| NULL
|
|
|
|-
| C1
| JASSeqParser::cmdOpenTrack
| {OpCode[1]} {TrackNumber[1]} {Pointer[3]} OpCode: one byte, C1. TrackNumber: one byte with range 0x00 through 0x0F. 0x00 = Track 0, 0x0F = Track 15. Pointer: three bytes with range 0x000000 through 0xFFFFFF. Defines an offset in the file.
| C1 04 05 B4 73 C1: OpCode 04: Track 4 05 B4 73: Offset
| Creates a Track which can play Notes. Track 15 is usually reserved for Yoshi Drums.
|-
| C2
| JASSeqParser::cmdCloseTrack
|
|
|
|-
| C3
| JASSeqParser::cmdCall
| {OpCode[1]} {Pointer[3]} OpCode: one byte, C3. Pointer: three bytes with range 0x000000 through 0xFFFFFF. Defines an offset in the file.
| C3 00 00 40 C3: OpCode 00 00 40: Offset
| Redirects execution to the defined offset. Execution can return with C5.
|-
| C4
| JASSeqParser::cmdCallF
|
|
|
|-
| C5
| JASSeqParser::cmdRet
| {OpCode[1]} OpCode: one byte, C5.
|
| Returns redirected execution (like from C3) to the initial call.
|-
| C6
| JASSeqParser::cmdRetF
|
|
|
|-
| C7
| JASSeqParser::cmdJmp
| {OpCode[1]} {Pointer[3]} OpCode: one byte, C7. Pointer: three bytes with range 0x000000 through 0xFFFFFF. Defines an offset in the file.
| C7 08 02 34 C7: OpCode 08 02 34: Offset
| Redirects execution to the defined offset, used for Loops.
|-
| C8
| JASSeqParser::cmdJmpF
|
|
|
|-
| C9
| JASSeqParser::cmdJmpTable
|
|
|
|-
| CA
| JASSeqParser::cmdCallTable
|
|
|
|-
| CB
| JASSeqParser::cmdLoopS
|
|
|
|-
| CC
| JASSeqParser::cmdLoopE
|
|
|
|-
| CD
| NULL
|
|
|
|-
| CE
| NULL
|
|
|
|-
| CF
| NULL
|
|
|
|-
| D0
| JASSeqParser::cmdReadPort
|
|
|
|-
| D1
| JASSeqParser::cmdWritePort
|
|
|
|-
| D2
| JASSeqParser::cmdCheckPortImport
|
|
|
|-
| D3
| JASSeqParser::cmdCheckPortExport
|
|
|
|-
| D4
| JASSeqParser::cmdParentWritePort
|
|
|
|-
| D5
| JASSeqParser::cmdChildWritePort
|
|
|
|-
| D6
| JASSeqParser::cmdParentReadPort
|
|
|
|-
| D7
| JASSeqParser::cmdChildReadPort
|
|
|
|-
| D8
| JASSeqParser::cmdRegLoad
|
|
|
|-
| D9
| JASSeqParser::cmdReg
|
|
|
|-
| DA
| JASSeqParser::cmdReg
|
|
|
|-
| DB
| JASSeqParser::cmdRegUni
|
|
|
|-
| DC
| JASSeqParser::cmdRegTblLoad
|
|
|
|-
| DD
| NULL
|
|
|
|-
| DE
| NULL
|
|
|
|-
| DF
| NULL
|
|
|
|-
| E0
| JASSeqParser::cmdTempo
| {OpCode[1]} {Unknown[1]} {BPM[1]} OpCode: one byte, E0. Unknown: one byte with unknown range and purpose. BPM: one byte with range 0x00 through 0xFF. 0x78 = 120, F0 = 240.
| E0 00 90 E0: OpCode 00: Unknown 90: BPM 144
| Defines the tempo (playback speed) of the BMS file.
|-
| E1
| JASSeqParser::cmdBankPrg
| {OpCode[1]} {Bank[1]} {Program[1]} OpCode: one byte, E1. Bank: one byte with range 0x00 through 0xFF. This byte represents a WSYS ID. Program: one byte ranging from 0x00 through 0xFF. This byte represents a LIST entry in the IBNK belonging to the defined WSYS ID.
| E1 01 0F E1: OpCode 01: WSYS ID 1 0F: IBNK LIST entry 15 (01 0F is the percussion set for Yoshi Drums)
| Defines the Instrument to be used in a Track.
|-
| E2
| JASSeqParser::cmdBank
| {OpCode[1]} {Bank[1]} OpCode: one byte, E2. Bank: one byte with range 0x00 through 0xFF. This byte represents a WSYS ID.
| E2 53 E2: OpCode 53: WSYS ID 83 (This bank holds sounds for Megahammer)
| Defines the WSYS/IBNK whose sounds are to be used in a Track.
|-
| E3
| JASSeqParser::cmdPrg
| {OpCode[1]} {Program[1]} OpCode: one byte, E3. Program: one byte with range 0x00 through 0xFF. This byte represents a LIST entry in the IBNK belonging to the defined WSYS ID.
| E3 0B E3: OpCode 0B: IBNK LIST entry 11 (In relation to Megahammer, this Program holds movement related sounds)
| Defines the Keyboard which holds more specific sounds to an IBNK.
|-
| E4
| NULL
|
|
|
|-
| E5
| NULL
|
|
|
|-
| E6
| NULL
|
|
|
|-
| E7
| JASSeqParser::cmdEnvScaleSet
|
|
|
|-
| E8
| JASSeqParser::cmdEnvSet
|
|
|
|-
| E9
| JASSeqParser::cmdSimpleADSR
|
|
|
|-
| EA
| JASSeqParser::cmdBusConnect
|
|
|
|-
| EB
| JASSeqParser::cmdIIRCutOff
|
|
|
|-
| EC
| JASSeqParser::cmdIIRSet
|
|
|
|-
| ED
| JASSeqParser::cmdFIRSet
|
|
|
|-
| EE
| NULL
|
|
|
|-
| EF
| NULL
|
|
|
|-
| F0
| JASSeqParser::cmdWait
| {OpCode[1]} {WaitTime[n]} OpCode: one byte, 0xF0. WaitTime: one or more bytes with range 0x00 through 0xFF. If the leading byte is 0x80 (bit 7 = 1) or greater, another following byte will be taken into account. Time is measured in ticks here.
| F0 60 (96 Ticks) F0 81 56 (214 Ticks) F0 83 81 30 (49328 Ticks)
| Creates a delay, used to define the length of a Note or gap between Notes.
|-
| F1
| JASSeqParser::cmdWaitByte
|
|
|
|-
| F2
| NULL
|
|
|
|-
| F3
| JASSeqParser::cmdSetIntTable
|
|
|
|-
| F4
| JASSeqParser::cmdSetInterrupt
|
|
|
|-
| F5
| JASSeqParser::cmdDisInterrupt
|
|
|
|-
| F6
| JASSeqParser::cmdRetI
|
|
|
|-
| F7
| JASSeqParser::cmdClrI
|
|
|
|-
| F8
| JASSeqParser::cmdIntTimer
|
|
|
|-
| F9
| JASSeqParser::cmdSyncCPU
|
|
|
|-
| FA
| NULL
|
|
|
|-
| FB
| NULL
|
|
|
|-
| FC
| NULL
|
|
|
|-
| FD
| JASSeqParser::cmdPrintf
|
|
|
|-
| FE
| JASSeqParser::cmdNop
|
|
|
|-
| FF
| JASSeqParser::cmdFinish
| {OpCode[1]} OpCode: one byte, 0xFF.
|
| Stops execution of a Track.
|-
| B000
| NULL
|
|
|
|-
| B001
| JASSeqParser::cmdDump
|
|
|
|}

== Tools ==
[https://cdn.discordapp.com/attachments/421356154795458570/1291660143758413824/BMS_DEC.zip?ex=6719f440&is=6718a2c0&hm=f44c5197a070f30a00283858942f9e4ae5066034862eba006f8abe87a228a6aa& BMS_DEC] (converts BMS to MIDI) 
[https://github.com/XAYRGA/JaiSeqX JaiSeqX] (playback for JAudio1 and JAudio2 BMS files)

IBNK

2024-09-19T16:25:09Z

Super Hackio: /* IBNK Header */ Fully documented header

IBNK page. Feel free to overwrite with accurate information

== IBNK Header ==
{| class="wikitable"
! Offset !! Type !! Description !! Notes
|-
| 0x00 || String[4] || IBNK (0x49424E4B) || |
|-
| 0x04 || UInt32 || File size minus 0x08 || |
|-
| 0x08 || Int32 || Bank ID || |
|-
| 0x0C || Int32 || Bank Version || 0x00000000 = Bank Version 0 0x00000001 = Bank Version 1 Both are supported in ''Super Mario Galaxy'' & ''Super Mario Galaxy 2''
|-
| 0x10 || Byte[16] || Padding? || All Zeros |
|}

== INST Section ==
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| String[4]
| INST (0x494E5354)
|
|-
| 0x04
| UInt32
| Section size minus 0x08
|
|-
| 0x08
| UInt32
| Amount '''N''' of Inst sections
|
|-
| 0x0C
|
| Start of first Inst section
|
|}

== Inst Section ==
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| String[4]
| Inst (0x496E7374)
|
|-
| 0x04
| UInt32
| ?
|
|-
| 0x08
| UInt32
| ?
|
|-
| 0x0C
| UInt32
| ?
|
|-
| 0x10
| UInt32
| Amount '''N''' of Keyboard sections
|
|-
| 0x14
|
| Start of first Keyboard section
|
|-
| 0x14+N*0x18
| Float
| Keyboard global volume
|
|-
| 0x14+N*0x18+0x04
| Float
| Keyboard global pitch
|
|}

=== Keyboard section (size 0x18) ===
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| UInt8
| Highest key of current keyboard
| Cannot be higher than 7F. Lowest key of next keyboard (if exists) is this value + 0x01.
|-
| 0x01
| Byte[6]
| ?
|
|-
| 0x07
| Byte[1]
| ?
|
|-
| 0x08
| UInt8
| Velocity
|
|-
| 0x09
| Byte[3]
| ?
|
|-
| 0x0C
| UInt16
| '''Bank ID'''
|
|-
| 0x0E
| UInt16
| '''Wave ID'''
|
|-
| 0x10
| Float
| Volume
|
|-
| 0x14
| Float
| Pitch
|
|}

== PMAP Section ==
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| String[4]
| PMAP (0x504D4150)
|
|-
| 0x04
| UInt32
| Section size minus 0x08
|
|-
| 0x08
| UInt32
| Amount '''N''' of Pmap sections
|
|-
| 0x0C
|
| Start of first Inst section
|
|}

=== Pmap Section (Size 0x28) ===
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| String[4]
| Pmap (0x506D6170)
|
|-
| 0x04
| Float
| ?
|
|-
| 0x08
| Float
| ?
|
|-
| 0x0C
| Float
| ?
|
|-
| 0x10
| Byte[7]
| ?
|
|-
| 0x17
| Byte[1]
| ?
|
|-
| 0x18
| UInt8
| Velocity
|
|-
| 0x19
| Byte[3]
| ?
|
|-
| 0x1C
| UInt16
| '''Bank ID'''
|
|-
| 0x1E
| UInt16
| '''Wave ID'''
|
|-
| 0x20
| Float
| ?
|
|-
| 0x24
| Float
| ?
|
|}

== PERC Section ==
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| String[4]
| PERC (0x50455243)
|
|-
| 0x04
| UInt32
| Section size minus 0x08
|
|-
| 0x08
| UInt32
| Amount '''N''' of Perc sections
|
|-
| 0x0C
|
| Start of first Inst section
|
|}

== Perc Section ==
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| String[4]
| Perc (0x50657263)
|
|-
| 0x04
| UInt32
| Amount '''N''' of entries
|
|-
| 0x08
|
| Start of entries
|
|}

=== Perc entry ===
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| UInt32
| Offset to Pmap section relative to file beginning.
| Many entries can be found holding no offset (0x00000000).
|}

== LIST Section ==
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| String[4]
| LIST (0x4C495354)
|
|-
| 0x04
| UInt32
| Section size minus 0x08
|
|-
| 0x08
| UInt32
| Amount '''N''' of entries
|
|-
| 0x0C
|
| Start of entries
|
|}

=== List entry ===
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| UInt32
| Offset to Inst or Perc section relative to file beginning.
| Many entries can be found holding no offset (0x00000000). The position of an entry in this list defines the '''Program ID'''. It starts counting at 0.
|}

ActorInfo

2024-07-10T22:49:59Z

Super Hackio: Fully document InitSwitch.bcsv

[[Category:Files]]

= ActorInfo =
'''ActorInfo''' is a folder that only exists in ''SMG2''. it contains files that control certain aspects of objects. Below is a list of every file that can be put in this folder.
{| class="wikitable"
! Filename !! Uses !! Description
|-
| ActionBgmCtrl.bcsv || 13 || Used by bosses to start their music
|-
| ActionFlagCtrl.bcsv || 111 ||
|-
| ActionFootPrintCtrl.bcsv || 1 || Used by ''DinoPackunBaby'' to assist in controlling the footsteps
|-
| ActionScreenBlurCtrl.bcsv || 21 ||
|-
| ActorAnimCtrl.bcsv || 109 ||
|-
| ActorHitReactionCtrl.bcsv || 139 ||
|-
| ActorParam.bcsv || 5 ||
|-
| ActorStateWalk.bcsv || 1 || Used by ''DinoPackunBaby'' to assist in controlling his walk
|-
| AnimBlendTriple.bcsv || 2 ||
|-
| InitActor.bcsv || 529 || Contains information on how the actor gets initialized.
|-
| InitActor2D.bcsv || 1 || Contains information on how the 2D actor gets initialized. Only used by ''Tongari''.
|-
| InitActor2DWater.bcsv || 1 || Contains information on how the 2D Water actor gets initialized. Only used by ''GhostAttackGhost''.
|-
| InitActorCollection.bcsv || 7 || Contains information on how the Collection actor gets initialized. Used by all 7 Powerups that appear on ''Starship Mario''.
|-
| InitActorDemo.bcsv || 10 || Contains information on how the Demo actor gets initialized. Used by ''GrandStar'', ''PowerStar'', and some other objects used in the game's main cutscenes.
|-
| InitActorDemoBellyDragon.bcsv || 2 || Contains information on how the Demo actor gets initialized during a Gobblegut cutscene. Only used by ''KoopaJr'' and ''KoopaJrRobotPod''.
|-
| InitActorDemoTitle.bcsv || 3 || Contains information on how the Demo actor gets initialized while on the Title Screen. Only used by ''DemoTitlePlanet'', ''Tico'', and ''Yoshi''.
|-
| InitActorDemoWithShadow.bcsv || 1 || Contains information on how the Demo actor gets initialized with a shadow. Only used by ''PowerStar''.
|-
| InitActorDummy.bcsv || 5 || Contains information on how the actor gets initialized in dummy form. Used by ''KinokoLifeUp'', ''KinokoOneUp'', ''Kuribo'', ''PowerStar'', and ''Tico''.
|-
| InitActorExit.bcsv || 1 || Contains information on how the exit actor gets initialized. Only used by ''PetitPorter''.
|-
| InitCollision.bcsv || 101 || Contains information on how the collision for this object is created
|-
| InitScale.bcsv || 6 || Contains a Vector3 that represents a size scale.
|-
| InitSensor.bcsv || 303 || Contains information on how to setup hitboxes for this object.
|-
| InitStageEffectCamera.bcsv || 11 || Contains information on how this object interacts with the camera.
|-
| InitStageEffectPad.bcsv || 12 || Contains information on pad. Unknown for sure, but it looks to be related to Wiimote Rumbling
|-
| InitSwitch.bcsv || 114 || Contains information on which switches are used and how
|-
| ItemGenerator.bcsv || 77 || Contains information on what objects to spawn when certain events are triggered (such as "Death by Spin Attack")
|-
| PadAndCameraCtrl.bcsv || 105 ||
|-
| Reaction.bcsv || 3 ||
|-
| Sequence.bcsv || 2 || Used for the Chimp Ice skating minigames
|-
| Shadow.bcsv || 256 || Contains information on how to create shadows for this object. Useful for '''ProductMapObjDataTable''' classes such as ''SimpleMapObj''.
|-
| (ObjectName).banmt || 234 ||
|}

== InitActor.bcsv ==
InitActor.bcsv and it's variants (like InitActor2D.bcsv) are all structured the same way, and define certain values for the object during it's initialization.
{| class="wikitable"
! Field Name !! Type !! Description
|-
| InitFunction || string || The name of the function that this entry corresponds to. Functions: '''Rail''': Only uses ''Data''. "" for "Doesn't use Rails". "Use" for "Can use Rails". "Needs" for "Requires a Rail" '''DefaultPos''': Only uses ''Data''. "o" for Enabled, "x" for Disabled. '''UseScaleForParam''': Only uses ''Data''. "o" for Enabled, "x" for Disabled. '''Model''': Only uses ''Data''. The name of the model to use. '''Executor''': Only uses ''Data''. Check the executor list below this table for more details. '''Light''': Only uses ''Data''. The name of the Light Type to use. '''Binder''': "o" for Enabled, "x" for Disabled. '''Effect''': The name of the Effect group to use. '''Sound''':The name of the Sound group to use. You can offset the sound from the object position using the Param00VecX, Y, and Z. '''Clipping''': Only uses ''Param00F32''. The distance that this object will clip out at. '''GroupClipping''': '''DemoSimpleCastAll''': '''StarPointer''': '''DebugNode''': Useless.
|-
| Data || string || The main data input. Most InitFunctions use this.
|-
| Param00Int || int || An integer parameter
|-
| Param00F32 || float || A float parameter
|-
| Param01F32 || float || A second float parameter
|-
| Param00Str || string || A string parameter, different from the Data parameter.
|-
| Param00VecX || float || The X Value of a Vector3 parameter.
|-
| Param00VecY || float || The Y Value of a Vector3 parameter.
|-
| Param00VecZ || float || The Z Value of a Vector3 parameter.
|}

{| class="wikitable"
! Executor !! Description
|-
| MapObj ||
|-
| MapObjStrongLight ||
|-
| MapObjNoShadow || This object does not get shadows applied to it
|-
| MapObjNoSilhouetted ||
|-
| MapObjDecoration ||
|-
| MapObjNoCalcAnim ||
|-
| MapObjMovement ||
|-
| MapObjNoMovement ||
|-
| MapObjIndirect ||
|-
| MapObjIndirectStrongLight ||
|-
| MapObjNoMovementNoCalcAnimIndirectStrongLight ||
|-
| ClippedMapParts ||
|-
| CollisionMapObj ||
|-
| CollisionMapObjWeakLight ||
|-
| CollisionMapObjNoShadow ||
|-
| CollisionMapObjNoShadowNoCalcAnim ||
|-
| CollisionMapObjIndirectNoCalcAnim ||
|-
| Enemy ||
|-
| EnemyDecoration ||
|-
| EnemyIndirect ||
|-
| EnemySilhouette ||
|-
| EnemyNoShadow ||
|-
| EnemyNoMovement ||
|-
| Boss ||
|-
| NpcNoShadow ||
|-
| NpcNoCalcAnim ||
|-
| Ride ||
|-
| RideSilhouette ||
|-
| Planet ||
|-
| PlanetIndirect ||
|-
| DynamicMapObj ||
|-
| PlayerDecoration ||
|-
| Item ||
|-
| Bloom ||
|-
| BossBussun ||
|-
| CrystalItem ||
|-
| FireBarBall ||
|-
| GliBird ||
|-
| HipDropStarMove ||
|-
| StoryBook ||
|-
| StoryBookFilter ||
|-
| WorldMapMiniObj ||
|-
| GhostMazeMask ||
|-
| Crystal ||
|-
| Tamakoro ||
|-
| SuperDreamer ||
|-
| Ghost2DWater ||
|-
| WoodLogBridge ||
|}

== Shadow.bcsv ==
Shadow.bcsv is used to create shadows for objects.
{| class="wikitable"
! Field Name !! Type !! Description
|-
| Name || string || Shadow name
|-
| GroupName || string ||
|-
| Joint || string || Name of the joint to attach to
|-
| DropStart || float || How far until the shadow starts to drop
|-
| DropLength || float || How far the shadow drops for
|-
| FollowScale || int || Set to 1 to make the shadow scale with the model (if scaled in an editor from the original size)
|-
| SyncShow || int || Set to 1 to make the shadow clip in and out with it's parent model
|-
| Gravity || int ||
|-
| Collision || int ||
|-
| DropOffsetX || float || X Offset to drop the shadow at.
|-
| DropOffsetY || float || Y Offset to drop the shadow at.
|-
| DropOffsetZ || float || Z Offset to drop the shadow at.
|-
| VolumeStart || float ||
|-
| VolumeEnd || float ||
|-
| VolumeCut || int || Set to 1
|-
| Type || string || '''VolumeBox''': A Box where any shadow responsive object that enters it gets the shadow applied '''VolumeSphere''': '''VolumeCylinder''': '''VolumeOval''': '''VolumeLine''': '''VolumeOvalPole''': '''VolumeFlatModel''': Define the shadow using a shadow model '''SurfaceCircle''': '''SurfaceOval''':
|-
| SizeX || float || X Scale of the shadow
|-
| SizeY || float || Y Scale of the shadow
|-
| SizeZ || float || Z Scale of the shadow
|-
| Radius || float ||
|-
| LineStart || string ||
|-
| LineEnd || string ||
|-
| LineStartRadius || float ||
|-
| LineEndRadius || float ||
|-
| Model || string || Used to specify what model to use for the Shadow
|-
| LocalRotateX || float ||
|-
| LocalRotateY || float ||
|-
| LocalRotateZ || float ||
|}

== InitSensor.bcsv ==
InitSensor.bcsv defines all of the HitSensors that are applied to the actor.

{| class="wikitable"
! Name !! Type !! Description
|-
| SensorName || string ||
|-
| SensorType || string ||
|-
| Radius || float || The radius of the sensor.
|-
| HitSensorNumMax || int || The maximum amount of other sensors that can interact with this sensor.
|-
| JointName || string || The joint to attach this sensor to on the model.
|-
| Callback || string ||
|-
| OffsetX || float || Offset X of the sensor.
|-
| OffsetY || float || Offset Y of the sensor.
|-
| OffsetZ || float || Offset Z of the sensor.
|}

== InitSwitch.bcsv ==
InitSwitch.bcsv defines all of the switches that can be used with the actor.

{| class="wikitable"
! Name !! Type !! Description
|-
| SwitchName || string || The name of the switch.
|-
| Usage || string || The way that the switch is used.
|}

=== Usage Types ===
Below is a table of the available options for the Usage field.
{| class="wikitable"
! Name !! Description
|-
| UseRead || The switch type can be read from.
|-
| NeedRead || The switch type is '''required''' to read from.
|-
| UseWrite || The switch type can be written to.
|-
| NeedWrite || The switch type is '''required''' to write to.
|-
| UseWriteAuto || The switch type can be automatically triggered.
|-
| NeedWriteAuto || The switch type is '''required''' to automatically trigger.
|-
| x || Switch type is disabled.
|}

=== Availability ===
Certain Switches only support specific Usage Types. This table details which switches can use which Usage Types.
{| class="wikitable"
! Switch Name !! Available Usage Types
|-
| SW_APPEAR || '''UseRead''' (calls ''MR::useStageSwitchReadAppear'') '''NeedRead''' (calls ''MR::needStageSwitchReadAppear'')
|-
| SW_DEAD || '''UseWrite''' (calls ''MR::useStageSwitchWriteDead'') '''NeedWrite''' (calls ''MR::needStageSwitchWriteDead'') '''UseWriteAuto''' (calls ''MR::useStageSwitchWriteAutoDead'') '''NeedWriteAuto''' (calls ''MR::needStageSwitchWriteAutoDead'')
|-
| SW_A || '''UseRead''' (calls ''MR::initUseStageSwitchReadA'') '''UseWrite''' (calls ''MR::initUseStageSwitchWriteA'') '''NeedRead''' (calls ''MR::needStageSwitchReadA'') '''NeedWrite''' (calls ''MR::needStageSwitchWriteA'')
|-
| SW_B || '''UseRead''' (calls ''MR::useStageSwitchReadB'') '''UseWrite''' (calls ''MR::initUseStageSwitchWriteB'') '''NeedRead''' (calls ''MR::needStageSwitchReadB'') '''NeedWrite''' (calls ''MR::needStageSwitchWriteB'')
|-
| SW_AWAKE (Optional) || '''UseRead''' (calls ''MR::useStageSwitchAwake'')
|}

== ItemGenerator.bcsv ==
Relates on items that can be generated from the actor.

{| class="wikitable"
! Name !! Type !! Description
|-
| ActionName || string || The action that has to be committed for the item to spawn. These actions are defined through code.
|-
| ItemInfoName || string || The item to spawn. See [[#Item_Info|Item Info]].
|-
| JointName || string || The joint where the item is spawned.
|-
| Count || int || The number of said item to spawn.
|}

=== Item Info ===
{| class="wikitable"
! Name !! Description
|-
| Coinx1 || Spawns a single coin.
|-
| StarPiecex1 || Spawns a single star piece.
|-
| StarPiecex3 || Spawns three star pieces.
|-
| StarPiecex6 || Spawns six star pieces.
|-
| StarPiecex10 || Spawns ten star pieces.
|}

ProductMapObjDataTable

2024-06-27T17:29:04Z

Super Hackio: Fix BCSV Format link

[[Category:Files]]
'''ProductMapObjDataTable''' is a [[BCSV (File format)|BCSV]] table that defines map objects and assigns them a class. The file can be found in ''SMG2'' in ''ObjectData/ProductMapObjDataTable.arc/root/ProductMapObjDataTable.bcsv''. It contains the following fields:
{| class="wikitable"
! Field !! Type !! Description
|-
| ModelName || string || The object name and model file in [[File system#ObjectData|ObjectData]].
|-
| ClassName || string || The name of the class that this object uses. A list of propery classes can be found below.
|}

=== Classes ===
{| class="wikitable"
! Class !! Function
|-
| AutoMakeMapObj || Alias for SimpleMapObj.
|-
| SimpleMapObj || A basic object that can be used in any level. Supports [[BCK]], [[BTK]], [[BTP]], [[BVA]], and [[BRK]]. [[BPK]] is not supported. Animations must take on the same name as the model in order to be played, and they start playing once the object loads. '''obj_arg0''' allows for this model to change colours based on a file inside the archive called "ColorChange.brk". The value put into '''obj_arg0''' corresponds to the frame to use. '''obj_arg1''' allows for this model to change textures based on a file inside the archive called "TexChange.btp" ("TexChange.btk" is also supported. Both btk and btp may exist at the same time, both will be used). The value put into '''obj_arg1''' corresponds to the frame to use. '''obj_arg2''' dictates how far the shadow of the object drops (Calculated with in-game units). Shadows can be used if you setup a Shadow.bcsv inside the object's [[ActorInfo]].
|-
| SimpleMapObjFarMax || Basic object with a far viewing range
|-
| SimpleMapObjWithEffect || Basic object with particle effects
|-
| SimpleClipPartsObj || Basic object that can be clipped
|-
| SimpleSeesawObj || Basic seesaw MapParts object '''MoveConditionType''': Rotate back to initially rotation when jumped off? 1 = Yes, 0 = No '''RotateSpeed''': Rotation Speed; How fast the Seesaw rotates when jumped on '''RotateAngle''': Degree of rotation; How far the Seesaw can rotate on one side '''RotateAxis''': On which axis the object rotates; 0 = Z-Axis, 1 = ? (Doesn't rotate), 2 = Z- and X-Axis '''RotateAccelType''': ? '''RotateStopTime''': Back Swinging Speed; How fast it swings back when jumped off
|-
| SimpleFloaterObj || Basic floater MapParts object '''MoveConditionType''': Depth; How far it sinks (a negative value to make the object rising up will glitch, turning the object over instead will work) '''RotateSpeed''': Sinking Speed; How fast it sinks '''RotateAngle''': Pop-Up Speed; How fast it comes back to it's initially height
|-
| LavaFloater || Lava floating platform that requires effects
|-
| SimpleBreakableObj || Object that can be destroyed with a SW_B switch. Can spawn items when destroyed via '''obj_arg3''': '''-1:''' Coin '''0:''' Nothing '''1:''' 1-Up mushroom '''2:''' Power Star '''3:''' Starbits The Power Star requires a properly set up AppearPowerStarObj parameter.
|-
| SimpleBreakableCollisionObj ||
|-
| SimpleBreakableDeleteShadowObj ||
|-
| SimpleBreakableStrongLightObj ||
|-
| AnmModelSwitchMove || Object for which animations with the name ''Move'' are played as soon as its SW_A switch is activated. Supports any animation type except [[BPK]].
|-
| AnmModelSwitchMoveEndKill || Special object for [[cutscenes]] with action type 4.
Plays animations with the name ''Move'' when activated and then disappears.
|-
| AnmModelSwitchMoveEndKillAnyAnim || Same as AnmModelSwitchMoveEndKill but supports any animation type? More investigation needed.
Used by YoshiEggCapsuleCage.
|-
| AnmModelSwitchMoveValidateCollision ||
|-
| AnmModelSwitchMoveInvalidateCollision ||
|-
| AnmModelSwitchSyncBrk || An object for which the following animation names are played:
'''Move''' When its SW_A switch is activated
'''Reverse''' When its SW_A switch is deactivated
|-
| RailMoveObj || Path-moving MapParts platform. Can play animations with the name ''Move'' when moving.
|-
| RailMoveWithReverseAnimObj ||
|-
| RailMoveWithIndirectModelObj ||
|-
| RailMoveShadowDropYObj || Path-moving MapParts platform that drops a shadow
|-
| RailMoveObjClipParts || Path-moving platform that can be clipped
|-
| RailMoveDemoActionObj ||
|-
| RailMoveLavaProjmapObj ||
|-
| RailRotateMoveObj || A MapParts platform that can move and rotate along a path. '''point_arg0''': Move speed/time (see point arg 7) '''point_arg1''': Acceleration speed/time (see point arg 7) '''point_arg2''': Rotate Speed/time (see point arg 7) '''point_arg3''': Rotation Angle. Relative (180 on two path points will rotate 360) '''point_arg4''': Rotation Axis. (0 = X, 1 = Y, 2 = Z) '''point_arg5''': Wait time. Stops movement at this path point for the provided time (in frames). '''point_arg6''': Rotation Type (-1 = Rotate at point, 1 = Rotate between this path point and next path point) '''point_arg7''': Calculation Type (-1 = Speed, 1 = Time. Time will define a fixed amount of time, while speed will set a value without care for how far away the next point is.)
|-
| RailAndRotateMoveObj ||
|-
| RotateMoveObj || Rotating MapParts platform '''MoveConditionType''': 0 = Always moving, 1 = Wait for player to step on it. '''RotateSpeed''': Rotation Speed. How fast the object rotates. Negative numbers are allowed, and will rotate the object in the opposite direction. '''RotateAngle''': How much to rotate. For always spinning objects that just do 360, set this to 0. '''RotateAxis''': On which axis the object rotates. 0 = X, 1 = Y, 2 = Z. '''RotateAccelType''': ? '''RotateStopTime''': If applicable, how long to stop rotating for. In frames.
|-
| RotateMoveObjClipParts || Rotating MapParts platform that can be clipped.
|-
| EffectObjR500F50 || An effect object which can span with a radius of 500 and a Far Clip distance of 50.
|-
| EffectObjR1000F50 || An effect object which can span with a radius of 1000 and a Far Clip distance of 50.
|-
| EffectObjR1500F400 || An effect object which can span with a radius of 1500 and a Far Clip distance of 400.
|-
| EffectObj20x20x10SyncClipping ||
|-
| EffectObj50x50x10SyncClipping ||
|-
| EffectObj10x10x10SyncClipping ||
|-
| Sky || A basic Sky that simply moves with the camera. Supports most animation formats with the same name as the model.
|-
| ProjectionMapSky || Also a Sky model, but the difference is unknown
|-
| SoundSyncSky || Sky model that plays a BRK animation to the beat
|-
| Air || Basic atmosphere object
|-
| ProjectionMapAir ||
|-
| PriorDrawAir ||
|-
| AfterMapObjDrawAir ||
|-
| CloudStep || Cloud platform that can move on paths as well
|-
| CloudSea || Unknown; used by the bowl swamp planet in Cloudy Court Galaxy
|-
| HipDropMoveBlock || Moves when groundpounded on its Y-Axis; used by the blocks in Puzzle Plank Galaxy 
*'''Obj_arg0''': Units, how far the object may be pushed at most in one direction; a positive number lets you move the object from the bottom up, while a negative number lets you move it from the top down. 
*'''Obj_arg1''': How many times you have to stomp on it until it reaches the end point set above 
*'''Obj_arg2''': Rising Speed 
*'''Obj_arg3''': Can be stomped only in one direction? -1 = No, 0 = Yes; allows stomping only in the direction set in arg_0
|-
| GorogoroCylinderRock || Rolling cylinder rocks that move on a path and respawn; see Clockwork Ruins Galaxy
|-
| SwitchingMoveBlock || Moves when a switch is activated. Used by the red and blue platforms in Flip-Out Galaxy '''obj_arg0''': How many units this object moves on its X Axis '''obj_arg1''': How many units this object moves on its Y Axis '''obj_arg2''': How many units this object moves on its Z Axis '''obj_arg3''': How many units this object rotates on its X Axis '''obj_arg4''': How many units this object rotates on its Y Axis '''obj_arg5''': How many units this object rotates on its Z Axis
|}

SoundIdToInstList

2024-06-26T19:18:37Z

Super Hackio: Note about referencing missing instrument banks

[[Category:Files]]
'''SoundIdToInstList''' is a [[BCSV (File format)|BCSV]] table that pairs Sound IDs to Instrument Bank Program Numbers. This allows the game to actually load audio data, as simply referencing a sound label won't do the trick. The file can be found in ''SMG2'' in ''AudioRes/Info/SoundIdToInstList.arc/root/SoundIdToInstList.bcsv''. It contains the following fields:

{| class="wikitable"
! Field !! Type !! Description
|-
| SoundId || LONG || The JAudio Sound ID that will be used for Lookup
|-
| BankProgNoName || STRING_OFFSET || Holds the names of the instruments represented in BankProgNo. ''This is not used by the game.''
|-
| BankProgNo || SHORT || The Instrument Bank Program Number.
|}

'''This BCSV ''MUST'' be sorted by the SoundId column in proper numerical order!''' 
''Referencing WSYS Entries that are not in the vanilla game will crash due to a hardcoded remap table.'' 
''Referencing Instrument Banks that do not exist will crash the game.''

SoundIdToInstList

2024-06-25T22:40:23Z

Super Hackio: Created this page after so many years :)

[[Category:Files]]
'''SoundIdToInstList''' is a [[BCSV (File format)|BCSV]] table that pairs Sound IDs to Instrument Bank Program Numbers. This allows the game to actually load audio data, as simply referencing a sound label won't do the trick. The file can be found in ''SMG2'' in ''AudioRes/Info/SoundIdToInstList.arc/root/SoundIdToInstList.bcsv''. It contains the following fields:

{| class="wikitable"
! Field !! Type !! Description
|-
| SoundId || LONG || The JAudio Sound ID that will be used for Lookup
|-
| BankProgNoName || STRING_OFFSET || Holds the names of the instruments represented in BankProgNo. ''This is not used by the game.''
|-
| BankProgNo || SHORT || The Instrument Bank Program Number.
|}

'''This BCSV ''MUST'' be sorted by the SoundId column in proper numerical order! Referencing WSYS Entries that are not in the vanilla game will crash due to a hardcoded remap table.'''

BgmParam

2024-03-30T17:17:20Z

Super Hackio: Created page with "Category:Files '''BgmParam''' is a BCSV table that defines override playback volumes for music. The file can be found in ''SMG2'' in ''AudioRes/Info/BgmParam.arc/root/BgmParam.bcsv''. It contains the following fields: {| class="wikitable" ! Field !! Type !! Description |- | SoundIdName || STRING_OFFSET || The song name to affect the volume of. |- | Volume || LONG || The volume to use as an override. Default 100, lower values make the song quie..."

[[Category:Files]]
'''BgmParam''' is a [[BCSV (File format)|BCSV]] table that defines override playback volumes for music. The file can be found in ''SMG2'' in ''AudioRes/Info/BgmParam.arc/root/BgmParam.bcsv''. It contains the following fields:

{| class="wikitable"
! Field !! Type !! Description
|-
| SoundIdName || STRING_OFFSET || The song name to affect the volume of.
|-
| Volume || LONG || The volume to use as an override. Default 100, lower values make the song quieter, and larger values make the song louder. Max 128.
|}

List of Music

2024-03-28T22:22:48Z

Super Hackio: Missing ScenarioSelect information

[[Category:Lists]]
{{WIP}}

This page lists all music that can be found in both ''Galaxy'' games along with their respective BGM, STM, MBGM and stream file names:
* '''BGM Name''': The name of the sequenced track.
* '''Stream Name''': The name of the streamed track.
* '''Combined Name''': The Multi BGM name that combines the sequenced and streamed tracks.
* '''Stream File''': The stream's file name in ''AudioRes/Streams''.

==Super Mario Galaxy==
{| class="wikitable"
! Description !! BGM Name !! Stream Name !! Combined Name !! Stream File
|-
| No music || BGM_CLEAR || || ||
|-
! colspan="5" | General Galaxy Music
|-
| Gateway Galaxy || BGM_GALAXY_24 || STM_GALAXY_24 || MBGM_GALAXY_24 || SMG_galaxy24_multi
|-
| Gateway Galaxy 2 || BGM_GALAXY_25 || STM_GALAXY_25 || MBGM_GALAXY_25 || SMG_galaxy25_strm
|-
| Gateway Galaxy 3 || BGM_GALAXY_26 || STM_GALAXY_26 || MBGM_GALAXY_26 || SMG_galaxy26_strm
|-
| Good Egg Galaxy || BGM_GALAXY_01 || STM_GALAXY_01 || MBGM_GALAXY_01 || SMG_galaxy01_strm
|-
| Honeyhive Galaxy || BGM_GALAXY_10 || STM_GALAXY_10 || MBGM_GALAXY_10 || SMG_galaxy10_strm
|-
| Big Bad Bugaboom || BGM_GALAXY_10_HURRY || STM_GALAXY_10_HURRY || MBGM_GALAXY_10_HURRY || SMG_galaxy10_hurry_strm
|-
| Space Junk Galaxy || BGM_GALAXY_08 || STM_GALAXY_08 || MBGM_GALAXY_08 || SMG_galaxy08_strm
|-
| Battlerock Galaxy || BGM_GALAXY_11 || STM_GALAXY_11 || MBGM_GALAXY_11 || SMG_galaxy11_multi
|-
| Bowser's Star Reactor || BGM_GALAXY_15 || STM_GALAXY_15 || MBGM_GALAXY_15 || SMG_galaxy15_strm
|-
| Bowser's Big Staircase || BGM_GALAXY_15_HURRY || STM_GALAXY_15_HURRY || MBGM_GALAXY_15_HURRY || SMG_galaxy15_hurry_strm
|-
| Beach Bowl Galaxy || BGM_GALAXY_03 || STM_GALAXY_03 || MBGM_GALAXY_03 || SMG_galaxy03_multi
|-
| Ghostly Galaxy || BGM_GALAXY_06 || STM_GALAXY_06 || MBGM_GALAXY_06 || SMG_galaxy06_strm
|-
| Buoy Base Galaxy || BGM_GALAXY_04 || STM_GALAXY_04 || MBGM_GALAXY_04 || SMG_galaxy04_multi
|-
| Bowser Jr.'s Airship Armada || BGM_GALAXY_09 || STM_GALAXY_09 || MBGM_GALAXY_09 || SMG_galaxy09_strm
|-
| Drip Drop Galaxy || BGM_GALAXY_23 || STM_GALAXY_23 || MBGM_GALAXY_23 || SMG_galaxy23_strm
|-
| Gusty Garden Galaxy || BGM_GALAXY_14 || STM_GALAXY_14 || MBGM_GALAXY_14 || SMG_galaxy14_strm
|-
| Freezeflame Galaxy || BGM_GALAXY_16 || STM_GALAXY_16 || MBGM_GALAXY_16 || SMG_galaxy16_multi
|-
| Dusty Dune Galaxy || BGM_GALAXY_19 || STM_GALAXY_19 || MBGM_GALAXY_19 || SMG_galaxy19_strm
|-
| Toy Time Galaxy || BGM_GALAXY_22 || STM_GALAXY_22 || MBGM_GALAXY_22 || SMG_galaxy22_strm
|-
| Deep Dark Galaxy || BGM_GALAXY_05 || STM_GALAXY_05 || MBGM_GALAXY_05 || SMG_galaxy05_strm
|-
| Melty Molten Galaxy || BGM_GALAXY_02 || STM_GALAXY_02 || MBGM_GALAXY_02 || SMG_galaxy02_strm
|-
| Snow Cap Galaxy || BGM_GALAXY_27 || STM_GALAXY_27 || MBGM_GALAXY_27 || SMG_galaxy27_strm
|-
| Bowser's Galaxy Reactor || BGM_GALAXY_28 || STM_GALAXY_28 || MBGM_GALAXY_28 || SMG_galaxy28_strm
|-
! colspan="5" | Miscellaneous Stage Music
|-
| Interlude || BGM_GALAXY_INTER || STM_GALAXY_INTER || MBGM_GALAXY_INTER || SMG_galaxy_inter_strm
|-
| A Tense Moment || BGM_GALAXY_01_TOMB || STM_GALAXY_01_TOMB || MBGM_GALAXY_01_TOMB || SMG_galaxy01_tomb_strm
|-
| Space Fantasy || BGM_GALAXY_12 || STM_GALAXY_12 || MBGM_GALAXY_12 || SMG_galaxy12_strm
|-
| Space Athletic || BGM_GALAXY_13 || STM_GALAXY_13 || MBGM_GALAXY_13 || SMG_galaxy13_strm
|-
| Blue Sky Athletic || BGM_GALAXY_17 || STM_GALAXY_17 || MBGM_GALAXY_17 || SMG_galaxy17_strm
|-
| Speedy Comet || BGM_GALAXY_02_HURRY || STM_GALAXY_02_HURRY || MBGM_GALAXY_02_HURRY || SMG_galaxy02_hurry_strm
|-
| Cosmic Comet || BGM_GALAXY_20 || STM_GALAXY_20 || MBGM_GALAXY_20 || SMG_galaxy20_strm
|-
| Purple Comet || BGM_GALAXY_21 || STM_GALAXY_21 || MBGM_GALAXY_21 || SMG_galaxy21_strm
|-
| Pipe Interior || BGM_GALAXY_18 || STM_GALAXY_18 || MBGM_GALAXY_18 || SMG_galaxy18_strm
|-
| Captain Toad's Theme || BGM_KINOPIO_TANKEN || STM_KINOPIO_TANKEN || MBGM_KINOPIO_TANKEN || SMG_ev_kinotan_strm
|-
| Captain Toad's Theme (Duplicate) || BGM_KINOPIO_TANKEN_B || STM_KINOPIO_TANKEN_B || MBGM_KINOPIO_TANKEN_B || SMG_ev_kinotan_strm
|-
| Surfing Race || BGM_RACE_01 || STM_RACE_01 || MBGM_RACE_01 || SMG_ev_race_strm
|-
| Spooky Race || BGM_RACE_02 || STM_RACE_02 || MBGM_RACE_02 || SMG_ev_race02_multi
|-
| Star Ball (Rolling Greens) || BGM_TAMAKORO || || ||
|-
| Star Ball (Melty Molten) || BGM_TAMAKORO_2 || || ||
|-
| Star Bunny Theme || BGM_GALAXY_02_CHASE || STM_GALAXY_02_CHASE || MBGM_GALAXY_02_CHASE || SMG_ev_rabbit_strm
|-
| Bowser Appears || || STM_MEET_KOOPA || || SMG_ev_kuppabt01_strm
|-
| A Chance to Grab a Star! 1 || BGM_STAR_EXIST || STM_STAR_EXIST || MBGM_STAR_EXIST || SMG_ev_starchance_strm
|-
| A Chance to Grab a Star! 2 || BGM_STAR_EXIST_2 || STM_STAR_EXIST_2 || MBGM_STAR_EXIST_2 || SMG_ev_starchance02_strm
|-
! colspan="5" | Boss Music
|-
| Dino Piranha || BGM_BOSS_03_A || STM_BOSS_03_A || MBGM_BOSS_03_A || SMG_boss03a_strm
|-
| Dino Piranha (Fast) || BGM_BOSS_03_B || STM_BOSS_03_B || MBGM_BOSS_03_B || SMG_boss03b_strm
|-
| King Kaliente || BGM_BOSS_01_A || STM_BOSS_01_A || MBGM_BOSS_01_A || SMG_boss01a_strm
|-
| King Kaliente (Fast) || BGM_BOSS_01_B || STM_BOSS_01_B || MBGM_BOSS_01_B || SMG_boss01b_strm
|-
| Megaleg || BGM_BOSS_02_A || STM_BOSS_02_A || MBGM_BOSS_02_A || SMG_boss02a_strm
|-
| Megaleg (Fast) || BGM_BOSS_02_B || STM_BOSS_02_B || MBGM_BOSS_02_B || SMG_boss02b_strm
|-
| Kamella || BGM_BOSS_04 || STM_BOSS_04 || MBGM_BOSS_04 || SMG_boss04_strm
|-
| Bowser || BGM_BOSS_KOOPA || STM_BOSS_KOOPA || MBGM_BOSS_KOOPA || SMG_boss07_multi
|-
| Bouldergeist || BGM_BOSS_09_A || STM_BOSS_09_A || MBGM_BOSS_09_A || SMG_boss09a_multi
|-
| Bouldergeist (Fast) || BGM_BOSS_09_B || STM_BOSS_09_B || MBGM_BOSS_09_B || SMG_boss09b_multi
|-
| Bowser Jr. || BGM_BOSS_06_A || STM_BOSS_06_A || MBGM_BOSS_06_A || SMG_boss06a_strm
|-
| Bowser Jr. (Fast) || BGM_BOSS_06_B || STM_BOSS_06_B || MBGM_BOSS_06_B || SMG_boss06b_strm
|-
| Major Burrows Chases Star Bunny || BGM_PINCH_3 || || ||
|-
| Major Burrows || BGM_BOSS_05_A || STM_BOSS_05_A || MBGM_BOSS_05_A || SMG_boss05a_strm
|-
| Major Burrows (Fast) || BGM_BOSS_05_B || STM_BOSS_05_B || MBGM_BOSS_05_B || SMG_boss05b_strm
|-
| Mecha-Bowser || BGM_BOSS_MECHA_KOOPA || STM_BOSS_MECHA_KOOPA || MBGM_BOSS_MECHA_KOOPA || SMG_boss08_strm
|-
| Final Bowser || BGM_BOSS_KOOPA_FINAL || STM_BOSS_KOOPA_FINAL || MBGM_BOSS_KOOPA_FINAL || SMG_boss10_strm
|-
! colspan="5" | Comet Observatory
|-
| Comet Observatory 1 || || STM_ASTRO_OUT || || SMG_astroout01_strm
|-
| Comet Observatory 2 || || STM_ASTRO_OUT_2 || || SMG_astroout02_strm
|-
| Comet Observatory 3 || || STM_ASTRO_OUT_3 || || SMG_astroout03_strm
|-
| Dome || BGM_ASTRO_DOME || STM_ASTRO_DOME || MBGM_ASTRO_DOME || SMG_astrodome_multi
|-
| Dome (Bowser) || BGM_ASTRO_DOME_2 || STM_ASTRO_DOME_2 || MBGM_ASTRO_DOME_2 || SMG_astrodome02_strm
|-
| Dome (Garden) || BGM_ASTRO_DOME_LOFT || STM_ASTRO_DOME_LOFT || MBGM_ASTRO_DOME_LOFT || SMG_astrodome03_strm
|-
| Library || BGM_LIBRARY || STM_LIBRARY || MBGM_LIBRARY || SMG_astrodome04_strm
|-
! colspan="5" | Power-Up Music
|-
| Rainbow Power-Up || BGM_MUTEKI_A || || ||
|-
| Rainbow Power-Up (first time) || BGM_MUTEKI_B || || ||
|-
| Fire Power-Up || BGM_FIRE_A || || ||
|-
| Fire Power-Up (first time) || BGM_FIRE_B || || ||
|-
| Ice Power-Up || BGM_ICE_A || || ||
|-
| Ice Power-Up (first time) || BGM_ICE_B || || ||
|-
| Flying Power-Up || BGM_FLYING_A || || ||
|-
| Flying Power-Up (first time) || BGM_FLYING_B || || ||
|-
| || BGM_FIRST_MORPH_A || || ||
|-
| || BGM_FIRST_MORPH_B || || ||
|-
! colspan="5" | Other Music
|-
| Title Music || || STM_TITLE || || SMG_title_strm
|-
| File Select || BGM_FILE_SELECT || STM_FILE_SELECT || MBGM_FILE_SELECT || SMG_fileselect_strm
|-
| Credits || || STM_STAFF_ROLL || || SMG_staffroll_strm
|-
| Picture Book || || STM_PROLOGUE_01 || || SMG_ev_prolo01_strm
|-
| Picture Book (Sad) || || STM_PROLOGUE_01_B || || SMG_ev_prolo01_b_strm
|-
| Mushroom Kingdom || BGM_PROLOGUE_02 || STM_PROLOGUE_02 || MBGM_PROLOGUE_02 || SMG_ev_prolo02_strm
|-
| Attack of the Airships || BGM_PROLOGUE_03 || STM_PROLOGUE_03 || MBGM_PROLOGUE_03 || SMG_ev_prolo03_strm
|-
| Catastrophe || || STM_PROLOGUE_04 || || SMG_ev_prolo04_strm
|-
| Mushroom Kingdom (After Attack) || || STM_PROLOGUE_05 || || SMG_ev_prolo05_strm
|-
| Star Child || || STM_EPILOGUE_B || || SMG_ev_epilogue_b_strm
|-
| Star Select Screen (When entering from a Dome) || BGM_SENARIO_SEL || || ||
|-
| Star Select Screen (When not entering from a Dome) || BGM_SENARIO_SEL_2 || || ||
|-
| Preparing to go to the Center of the Universe || BGM_SENARIO_SEL_3 || || ||
|-
| Galaxy Intro || BGM_START_DEMO || || ||
|-
| Gateway Intro || BGM_MEET_TICO_ZOOM_OUT || || ||
|-
| Bowser Jr. Intro || BGM_KOOPA_JR_APPEAR || || ||
|-
| Final Bowser Intro || BGM_KOOPA_VS3_SUN || || ||
|-
| First Grand Star Collected || || STM_FIRST_ASTRO || || SMG_first_astro_strm
|-
| Another Grand Star Collected || || STM_SECOND_ASTRO || || SMG_second_astro_strm
|-
| E3 2006 Bubble || BGM_IN_BUBBLE || || ||
|-
! colspan="5" | Jingles
|-
| Death || BGM_MISS || || ||
|-
| Game Over || BGM_GAMEOVER || || ||
|-
| Got Power Star || BGM_STAR_POW_GET || || ||
|-
| Got Grand Star || BGM_GRAND_STAR_GET || || ||
|-
| Got Final Grand Star || BGM_GRAND_STAR_GET_2 || || ||
|-
| Countdown || BGM_MINIGAME_START || || ||
|-
| Won Race || BGM_RACE_WIN || || ||
|-
| Lost Race || BGM_RACE_LOSE || || ||
|-
| New Galaxy || BGM_NEW_GALAXY || || ||
|-
| Planet Appeared || BGM_APPEAR_PLANET || || ||
|-
| Pedestal Appeared in Gateway || BGM_APPEAR_HD_TOWER || || ||
|-
| New High Score || BGM_HIGH_SCORE || || ||
|-
| Galaxy Completed || BGM_GALAXY_COMPLETE || || ||
|-
! colspan="5" | Uncategorized
|-
| || BGM_ASTRO_RETURN || || ||
|-
| || BGM_JINGLE_LIGHT_1 || || ||
|-
| || BGM_KOOPA_APPEAR || || ||
|-
| || BGM_KOOPA_GRAND_STAR_1 || || ||
|-
| || BGM_KOOPA_GRAND_STAR_3 || || ||
|-
| || BGM_PINCH_1 || || ||
|-
| || BGM_PINCH_2 || || ||
|-
| || BGM_RED_COMET_APPEAR || || ||
|}

==Super Mario Galaxy 2==
{| class="wikitable"
! Description !! BGM Name !! Stream Name !! Combined Name !! Stream File
|-
| No music || BGM_CLEAR || || ||
|-
! colspan="5" | General Galaxy Music
|-
| Sky Station Galaxy || BGM_SMG2_GALAXY_06 || STM_SMG2_GALAXY_06 || MBGM_SMG2_GALAXY_06 || SMG2_galaxy06_strm
|-
| Sky Station Galaxy 2 || BGM_SMG2_GALAXY_05 || STM_SMG2_GALAXY_05 || MBGM_SMG2_GALAXY_05 || SMG2_galaxy05_strm
|-
| Yoshi Star Galaxy || BGM_SMG2_GALAXY_32 || STM_SMG2_GALAXY_32 || MBGM_SMG2_GALAXY_32 || SMG2_galaxy32_strm
|-
| Spin-Dig Galaxy || BGM_SMG2_GALAXY_09 || STM_SMG2_GALAXY_09 || MBGM_SMG2_GALAXY_09 || SMG2_galaxy09_strm
|-
| Fluffy Bluff Galaxy || BGM_SMG2_GALAXY_07 || STM_SMG2_GALAXY_07 || MBGM_SMG2_GALAXY_07 || SMG2_galaxy07_strm
|-
| Rightside Down Galaxy || BGM_SMG2_GALAXY_03 || STM_SMG2_GALAXY_03 || MBGM_SMG2_GALAXY_03 || SMG2_galaxy03_multi
|-
| Flip-Swap Galaxy || BGM_SMG2_GALAXY_04 || STM_SMG2_GALAXY_04 || MBGM_SMG2_GALAXY_04 || SMG2_galaxy04_strm
|-
| Bowser Jr.'s Fiery Flotilla || BGM_SMG2_GALAXY31 || STM_SMG2_GALAXY31 || MBGM_SMG2_GALAXY31 || SMG2_galaxy31_strm
|-
| Puzzle Plank Galaxy || BGM_SMG2_GALAXY_29 || STM_SMG2_GALAXY_29 || MBGM_SMG2_GALAXY_29 || SMG2_galaxy29_strm
|-
| Hightail Falls Galaxy || BGM_DASH_YOSHI || || ||
|-
| Cosmic Cove Galaxy || BGM_SMG2_GALAXY_02 || STM_SMG2_GALAXY_02 || MBGM_SMG2_GALAXY_02 || SMG2_galaxy02_strm
|-
| Wild Glide Galaxy || BGM_GLIDER || STM_GLIDER || MBGM_GLIDER || SMG2_ev_glider_strm
|-
| Honeybloom Galaxy || BGM_SMG2_GALAXY_13 || STM_SMG2_GALAXY_13 || MBGM_SMG2_GALAXY_13 || SMG2_galaxy13_strm
|-
| Bowser's Lava Lair || BGM_SMG2_GALAXY_15 || STM_SMG2_GALAXY_15 || MBGM_SMG2_GALAXY_15 || SMG2_galaxy15_strm
|-
| Tall Trunk Galaxy Slide || BGM_SLIDER || || ||
|-
| Haunty Halls Galaxy || BGM_SMG2_GALAXY_11 || STM_SMG2_GALAXY_11 || MBGM_SMG2_GALAXY_11 || SMG2_galaxy11_strm
|-
| Freezy Flake Galaxy || BGM_SMG2_GALAXY_19 || STM_SMG2_GALAXY_19 || MBGM_SMG2_GALAXY_19 || SMG2_galaxy19_strm
|-
| Beat Block Galaxy || BGM_REPEAT_TIMER || || ||
|-
| Supermassive Galaxy || BGM_SMG2_GALAXY_23 || STM_SMG2_GALAXY_23 || MBGM_SMG2_GALAXY_23 || SMG2_galaxy23_strm
|-
| Flipsville Galaxy || BGM_SMG2_GALAXY_14 || STM_SMG2_GALAXY_14 || MBGM_SMG2_GALAXY_14 || SMG2_galaxy14_strm
|-
| Starshine Beach Galaxy || BGM_SMG2_GALAXY_27 || STM_SMG2_GALAXY_27 || MBGM_SMG2_GALAXY_27 || SMG2_galaxy27_multi
|-
| Sweet Mystery Galaxy || BGM_SMG2_GALAXY_10 || STM_SMG2_GALAXY_10 || MBGM_SMG2_GALAXY_10 || SMG2_galaxy10_strm
|-
| Space Storm Galaxy || BGM_SMG2_GALAXY_12 || STM_SMG2_GALAXY_12 || MBGM_SMG2_GALAXY_12 || SMG2_galaxy12_strm
|-
| Space Storm Galaxy 2 || BGM_SMG2_GALAXY_17 || STM_SMG2_GALAXY_17 || MBGM_SMG2_GALAXY_17 || SMG_galaxy17_multi
|-
| Slipsand Galaxy || BGM_SMG2_GALAXY_01 || STM_SMG2_GALAXY_01 || MBGM_SMG2_GALAXY_01 || SMG2_galaxy01_multi
|-
| Shiverburn Galaxy || BGM_SMG2_GALAXY_16 || STM_SMG2_GALAXY_16 || MBGM_SMG2_GALAXY_16 || SMG2_galaxy16_multi
|-
| Fleet Glide Galaxy || BGM_SMG2_GALAXY_28 || STM_SMG2_GALAXY_28 || MBGM_SMG2_GALAXY_28 || SMG2_galaxy28_strm
|-
| Melty Monster Galaxy || BGM_SMG2_GALAXY_30 || STM_SMG2_GALAXY_30 || MBGM_SMG2_GALAXY_30 || SMG2_galaxy30_strm
|-
| Throwback Galaxy || BGM_SMG2_GALAXY_21 || STM_SMG2_GALAXY_21 || MBGM_SMG2_GALAXY_21 || SMG2_galaxy21_strm
|-
| Slimy Spring Galaxy || BGM_SMG2_GALAXY_24 || STM_SMG2_GALAXY_24 || MBGM_SMG2_GALAXY_24 || SMG2_galaxy24_strm
|-
| Slimy Spring Galaxy (Ambience) || BGM_SMG2_GALAXY_24B || STM_SMG2_GALAXY_24B || MBGM_SMG2_GALAXY_24B || SMG2_galaxy24b_strm
|-
| Bowser's Galaxy Generator || BGM_SMG2_GALAXY_20 || STM_SMG2_GALAXY_20 || MBGM_SMG2_GALAXY_20 || SMG2_galaxy20_strm
|-
| Stone Cyclone Galaxy || BGM_SMG2_GALAXY_22 || STM_SMG2_GALAXY_22 || MBGM_SMG2_GALAXY_22 || SMG2_galaxy22_multi
|-
| Boss Blitz Galaxy || BGM_EV_BOSSRUSH || || ||
|-
| Boss Blitz Galaxy (with fade-in) || BGM_EV_BOSSRUSH02 || || ||
|-
| Unused Galaxy Theme || BGM_SMG2_GALAXY_08 || STM_SMG2_GALAXY_08 || MBGM_SMG2_GALAXY_08 || SMG2_galaxy08_strm
|-
| Gateway Galaxy || BGM_SMG2_GALAXY_25 || STM_SMG2_GALAXY_25 || MBGM_SMG2_GALAXY_25 || SMG2_galaxy25_strm
|-
| Good Egg Galaxy || BGM_SMG_GALAXY_01 || STM_SMG_GALAXY_01 || MBGM_SMG_GALAXY_01 || SMG_galaxy01_strm
|-
| Gusty Garden Galaxy || BGM_SMG_GALAXY_14 || STM_SMG_GALAXY_14 || MBGM_SMG_GALAXY_14 || SMG_galaxy14_strm
|-
| Bowser's Galaxy Reactor || BGM_SMG_GALAXY_28 || STM_SMG_GALAXY_28 || MBGM_SMG_GALAXY_28 || SMG_galaxy28_strm
|-
! colspan="5" | Miscellaneous Stage Music
|-
| Unknown Star || BGM_SMG2_GALAXY_INTER || STM_SMG2_GALAXY_INTER || MBGM_SMG2_GALAXY_INTER || SMG2_galaxy_inter_strm
|-
| Speedy Comet || BGM_SMG2_GALAXY_HURRY || STM_SMG2_GALAXY_HURRY || MBGM_SMG2_GALAXY_HURRY || SMG2_galaxy_hurry_strm
|-
| Daredevil Comet || BGM_SMG2_GALAXY_DANGER || STM_SMG2_GALAXY_DANGER || MBGM_SMG2_GALAXY_DANGER || SMG2_galaxy_danger_strm
|-
| Purple Comet || BGM_SMG2_GALAXY_26 || STM_SMG2_GALAXY_26 || MBGM_SMG2_GALAXY_26 || SMG2_galaxy26_strm
|-
| Pipe Interior || BGM_SMG2_GALAXY_18 || STM_SMG2_GALAXY_18 || MBGM_SMG2_GALAXY_18 || SMG2_galaxy18_strm
|-
| Bonus Room || BGM_GAMBLE || || ||
|-
| Teleporter || BGM_SMG2_EV_PORTER || || ||
|-
| Minigame || BGM_MINI_GAME || STM_MINI_GAME || MBGM_MINI_GAME || SMG2_ev_minigame_strm
|-
| Star Ball (Rolling Masterpiece) || BGM_TAMAKORO || || ||
|-
| Star Ball (Rolling Coaster) || BGM_TAMAKORO_2 || || ||
|-
| Tip Network || BGM_DREAM01 || || ||
|-
| Captain Toad's Theme || BGM_EV_KINOTAN || STM_EV_KINOTAN || MBGM_EV_KINOTAN || SMG2_ev_kinotan_strm
|-
| Star Bunny Theme || BGM_EV_RABBIT || STM_EV_RABBIT || MBGM_EV_RABBIT || SMG2_ev_rabbit_strm
|-
| Whittle Theme || BGM_SMG2_EV_MOKKU || STM_SMG2_EV_MOKKU || MBGM_SMG2_EV_MOKKU || SMG2_ev_mokku_strm
|-
| Bowser Appears || || STM_SMG2_EV_KUPPABT01 || || SMG2_ev_kuppabt01_strm
|-
| A Chance to Grab a Star! 1 || BGM_STAR_CHANCE || STM_STAR_CHANCE || MBGM_STAR_CHANCE || SMG2_ev_starchance_strm
|-
| A Chance to Grab a Star! 2 || BGM_STAR_CHANCE_2 || STM_STAR_CHANCE_2 || MBGM_STAR_CHANCE_2 || SMG2_ev_starchance02_strm
|-
| A Chance to Grab a Star! 3 || || STM_STAR_CHANCE_3 || || SMG2_ev_starchance03_strm
|-
! colspan="5" | Boss Music
|-
| Peewee Piranha || BGM_SMG2_BOSS_05A || STM_SMG2_BOSS_05A || MBGM_SMG2_BOSS_05A || SMG2_boss05a_strm
|-
| Peewee Piranha (Fast) || || STM_SMG2_BOSS_05B || || SMG2_boss05b_strm
|-
| Giga-Lakitu || BGM_PINCH_01 || || ||
|-
| Digga-Leg || BGM_SMG2_BOSS_08A || STM_SMG2_BOSS_08A || MBGM_SMG2_BOSS_08A || SMG2_boss08a_strm
|-
| Digga-Leg (Fast) || || STM_SMG2_BOSS08B || || SMG2_boss08b_strm
|-
| Gobblegut || BGM_SMG2_BOSS_01A || STM_SMG2_BOSS_01A || MBGM_SMG2_BOSS_01A || SMG2_boss01a_strm
|-
| Gobblegut (Fast) || || STM_SMG2_BOSS_01B || || SMG2_boss01b_strm
|-
| Bowser || BGM_SMG2_BOSS_07 || STM_SMG2_BOSS_07 || MBGM_SMG2_BOSS_07 || SMG2_boss07_multi
|-
| Bowser (Fast) || BGM_SMG2_BOSS_07B || STM_SMG2_BOSS_07B || MBGM_SMG2_BOSS_07B || SMG2_boss07b_multi
|-
| Megahammer || BGM_SMG2_BOSS_03A || STM_SMG2_BOSS_03A || MBGM_SMG2_BOSS_03A || SMG2_boss03a_multi
|-
| Megahammer (Fast) || || STM_SMG2_BOSS_03B || || SMG2_boss03b_strm
|-
| Glamdozer || BGM_SMG2_BOSS_02A || STM_SMG2_BOSS_02A || MBGM_SMG2_BOSS_02A || SMG2_boss02a_strm
|-
| Glamdozer (Fast) || || STM_SMG2_BOSS_02B || || SMG2_boss02b_strm
|-
| Squizzard || BGM_SMG2_BOSS_04A || || ||
|-
| Boomsday Machine || BGM_SMG2_BOSS_06A || STM_SMG2_BOSS_06A || MBGM_SMG2_BOSS_06A || SMG2_boss06a_strm
|-
| Boomsday Machine (Fast) || BGM_SMG2_BOSS_06B || STM_SMG2_BOSS_06B || MBGM_SMG2_BOSS_06B || SMG2_boss06b_strm
|-
| Final Bowser || BGM_SMG2_BOSS_10 || STM_SMG2_BOSS_10 || MBGM_SMG2_BOSS_10 || SMG2_boss10_multi
|-
| Final Bowser (Without Ambience) || || STM_SMG2_BOSS10 || || SMG2_boss10_strm
|-
| Dino Piranha || BGM_SMG_BOSS_03A || STM_SMG_BOSS_03A || MBGM_SMG_BOSS_03A || SMG_boss03a_strm
|-
| Dino Piranha (Fast) || BGM_SMG_BOSS_03B || STM_SMG_BOSS_03B || MBGM_SMG_BOSS_03B || SMG_boss03b_strm
|-
| King Kaliente || BGM_SMG_BOSS_01A || STM_SMG_BOSS_01A || MBGM_SMG_BOSS_01A || SMG_boss01a_strm
|-
| King Kaliente (Fast) || BGM_SMG_BOSS_01B || STM_SMG_BOSS_01B || MBGM_SMG_BOSS_01B || SMG_boss01b_strm
|-
| Major Burrows || BGM_SMG_BOSS_05A || STM_SMG_BOSS_05A || MBGM_SMG_BOSS_05A || SMG_boss05a_strm
|-
| Major Burrows (Fast) || BGM_SMG_BOSS_05B || STM_SMG_BOSS_05B || MBGM_SMG_BOSS_05B || SMG_boss05b_strm
|-
| Bouldergeist || BGM_SMG_BOSS_09A || STM_SMG_BOSS_09A || MBGM_SMG_BOSS_09A || SMG_boss09a_multi
|-
| Bouldergeist (Fast) || BGM_SMG_BOSS_09B || STM_SMG_BOSS_09B || MBGM_SMG_BOSS_09B || SMG_boss09b_multi
|-
! colspan="5" | HUB & World Map Music
|-
| World 1 & 2 || BGM_SMG2_WORLDMAP_06 || STM_SMG2_WORLDMAP_06 || MBGM_SMG2_WORLDMAP_06 || SMG2_worldmap06_multi
|-
| World 3 || BGM_SMG2_WORLDMAP_00 || STM_SMG2_WORLDMAP_00 || MBGM_SMG2_WORLDMAP_00 || SMG2_worldmap00_multi
|-
| World 4 || BGM_SMG2_WORLDMAP_04 || STM_SMG2_WORLDMAP_04 || MBGM_SMG2_WORLDMAP_04 || SMG2_worldmap04_multi
|-
| World 5 || BGM_SMG2_WORLDMAP_08 || STM_SMG2_WORLDMAP_08 || MBGM_SMG2_WORLDMAP_08 || SMG2_worldmap08_multi
|-
| World 6 || BGM_SMG2_WORLDMAP_07 || STM_SMG2_WORLDMAP_07 || MBGM_SMG2_WORLDMAP_07 || SMG2_worldmap07_multi
|-
| World S || BGM_SMG2_WORLDMAP_03 || STM_SMG2_WORLDMAP_03 || MBGM_SMG2_WORLDMAP_03 || SMG2_worldmap03_multi
|-
| Green Star World || BGM_SMG2_WORLDMAP_05 || STM_SMG2_WORLDMAP_05 || MBGM_SMG2_WORLDMAP_05 || SMG2_worldmap05_multi
|-
| Starship Mario 1 || BGM_SMG2_MARIO_SHIP01 || STM_SMG2_MARIO_SHIP01 || MBGM_SMG2_MARIO_SHIP01 || SMG2_mario_ship01_strm
|-
| Starship Mario 2 || BGM_SMG2_MARIO_SHIP02 || STM_SMG2_MARIO_SHIP02 || MBGM_SMG2_MARIO_SHIP02 || SMG2_mario_ship02_strm
|-
| Starship Mario 3 || BGM_SMG2_MARIO_SHIP03 || STM_SMG2_MARIO_SHIP03 || MBGM_SMG2_MARIO_SHIP03 || SMG2_mario_ship03_strm
|-
| Comet Observatory 2 || || STM_SMG_ASTROOUT02 || || SMG_astroout02_strm
|-
| Comet Observatory 3 || || STM_SMG_ASTROOUT03 || || SMG_astroout03_strm
|-
! colspan="5" | Power-Up Music
|-
| Rainbow Power-Up || BGM_MUTEKI_A || || ||
|-
| Rainbow Power-Up (first time) || BGM_MUTEKI_B || || ||
|-
| Fire Power-Up || BGM_FIRE_A || || ||
|-
| Fire Power-Up (first time) || BGM_FIRE_B || || ||
|-
| Ice Power-Up || BGM_ICE_A || || ||
|-
| Ice Power-Up (first time) || BGM_ICE_B || || ||
|-
| Flying Power-Up || BGM_FLYING_A || || ||
|-
| Flying Power-Up (first time) || BGM_FLYING_B || || ||
|-
| || BGM_FIRST_MORPH_A || || ||
|-
| || BGM_FIRST_MORPH_B || || ||
|-
! colspan="5" | Other Music
|-
| Title Music (Duplicate) || BGM_TITLE || STM_TITLE || MBGM_TITLE || SMG2_title_strm
|-
| Credits || BGM_SMG2_STAFFROLL || STM_SMG2_STAFFROLL || MBGM_SMG2_STAFFROLL || SMG2_staffroll_strm
|-
| Mushroom Kingdom || || STM_SMG2_EV_PROLOGUE_02 || || SMG2_ev_prolo02_strm
|-
| Master Luma's Theme || BGM_SMG2_EV_PROLO_03 || || ||
|-
| Bowser Attacks || || STM_SMG2_EV_PROLOGUE_05 || || SMG2_ev_prolo05_strm
|-
| First Grand Star Collected || || STM_SMG2_FIRST_ASTRO || || SMG2_first_astro_strm
|-
| Entering World 1 || || STM_SMG2_FIRST_ASTRO2 || || SMG2_first_astro2_strm
|-
| Another Grand Star Collected || || STM_SMG2_SECOND_ASTRO || || SMG2_second_astro_strm
|-
| First Star Select || BGM_SMG2_EV_DEPART01 || || ||
|-
| Star Select || BGM_SMG2_COURSESELECT02 || || ||
|-
| The Luma and the Hat || || STM_SMG2_EV_ENDING01 || || SMG2_ev_ending01_strm
|-
| Precious One || || STM_SMG2_EV_EPILOGUE_01 || || SMG2_ev_epilogue01_strm
|-
| E3 2006 Bubble || BGM_IN_BUBBLE || || ||
|-
| || BGM_KOOPA_JR_APPEAR || || ||
|-
| || BGM_PINCH_02 || || ||
|-
! colspan="5" | Jingles
|-
| Death || BGM_MISS || || ||
|-
| Game Over || BGM_GAMEOVER || || ||
|-
| Countdown || BGM_MINIGAME_START || || ||
|-
| Won Race || BGM_RACE_WIN || || ||
|-
| Lost Race || BGM_RACE_LOSE || || ||
|-
| New Galaxy || BGM_JG_NEW_GALAXY || || ||
|-
| Planet Appeared || BGM_JG_APPEAR_PLANET || || ||
|-
| Got Grand Star || BGM_JG_GRAND_STAR_GET || || ||
|-
| New High Score || BGM_JG_HIGH_SCORE || || ||
|-
| Galaxy Completed || BGM_JG_GALAXY_COMPLETE || || ||
|-
| || BGM_JG_RETURN_HOME || || ||
|-
| || BGM_JG_START_CAMERA_DEMO || || ||
|-
| || || STM_SMG2_JG_COMETSE || || SMG2_jg_cometse_strm
|-
| || BGM_SMG2_JG_COMET || || ||
|-
| || BGM_SMG2_JG_DECIDE || || ||
|-
| || BGM_SMG2_JG_GREENSTAR1 || || ||
|-
| || BGM_SMG2_JG_GSTAR1 || || ||
|-
| || BGM_SMG2_JG_GSTAR2 || || ||
|-
| || BGM_SMG2_JG_M_PLANET01 || || ||
|-
| || BGM_SMG2_JG_MEETCHIKO || || ||
|-
| || BGM_SMG2_JG_MEETYOSHI || || ||
|-
| || BGM_SMG2_JG_PAMATA || || ||
|-
| || BGM_SMG2_JG_TIME || || ||
|}

Cutscenes

2024-03-16T14:11:03Z

Super Hackio: Add Action Types for SMG1 (apparently they are just shifted mostly...)

[[Category:Files]]
[[Category:Lists]]
{{WIP}}
'''Todo:'''
*Finish the hardcoded cutscene names.
*More info and research on the use of canm and supported objects.

Cutscenes are flexible, complex scenes, which can execute more freedom in contrast to the SimpleDemoExecutor.
These scenes consist of individual sequences that are played in order. In each sequence, several actions can be executed from certain frames, such as changing the player's position, camera movements, sound effects, and more. To each sequence (and subsequence) different actions are linked, which are then executed at the time of this sequence.

You can best visualize this in a kind of timeline. The timeline consists of the individual sequences, which consist of several actions. At the same time single subscequences can be executed together with the actual sequences.

==Structure==
[[File:Cutscene_Visual-Representation.png|thumb|A visual representation of the first Yoshi Meets cutscene.]]
A cutscene is activated by a demo object via SW_APPEAR within the map and loads several sheet BCSV files located in the demo.arc archive of the respective galaxy/zone. The demo object loads the bcsv files using its defined sheet name and additional "Demo" in front of the file name of the BSCV attached and a respective sheet type at the end of the file name (e.g. '''Demo'''AfterGameOver'''Time''').

In addition, the demo object has its own cutscene name, which is only used in certain cases (e.g. to load certain sequences for [[Starship Mario]]) and also for camera codes. Certain names can be recognized by the game and then loads additional hardcoded settings such as behavior after scene completion. A list of these names [[Cutscenes#Hardcoded_Cutscene_Names|can be found below]].

Objects other than the player object itself can be linked to the cutscene. These then use a cutscene group ID, which on the one hand must match the demo object ID and on the other hand must be entered in the action sheet together with the Japanese name of the object (defined in [[ObjNameTable]]).

If there are several identical objects that are part of a cutscene, you can also define a cast group id for one specific object to distinguish it from the other identical objects for the scene.

===Time===
Defines the individual sequences with their names and length. They are played in the order they are in the list.
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| PartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the sequence
|-
| TotalStep
| style="font-size:12px;" | LONG
| Duration of the sequence in frames
|-
| SuspendFlag
| style="font-size:12px;" | LONG
| If set to 1, pauses the cutscene and resumes gameplay. The cutscene will continue from here next time it is activated.
|-
| WaitUserInputFlag
| style="font-size:12px;" | LONG
|
|}

===SubPart===
Runs additional subsequences in parallel during a sequence.
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| SubPartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the sub sequence
|-
| SubPartTotalStep
| style="font-size:12px;" | LONG
| The length of the sub sequence
|-
| MainPartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the main sequence this sub sequence belongs to
|-
| MainPartStep
| style="font-size:12px;" | LONG
| The frame of the main sequence this sub sequence starts at
|}

===Action===
Picks up objects and can position them to a given GeneralPos and play an animation.

All animation types are supported. For more control you can use [[ActorInfo#ActorInfo|ActorAnimCtrl.bcsv]] for your objects to define multiple animation names of different animation types to the animation name defined in the cutscene.
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| PartName
| style="font-size:12px;" | STRING_OFFSET
| Sequence Name
|-
| CastName
| style="font-size:12px;" | STRING_OFFSET
| Japanese Name of the object (defined in [[ObjNameTable]])
|-
| CastID
| style="font-size:12px;" | LONG
| Cast ID of the object
|-
| ActionType
| style="font-size:12px;" | LONG
| Pick an Action Type from the table below.
|-
| PosName
| style="font-size:12px;" | STRING_OFFSET
| Name of the GeneralPos object for destination location
|-
| AnimName
| style="font-size:12px;" | STRING_OFFSET
| Name of the animation, which can be loaded either from the ARC archive object or from a separate ARC archive with the additional name "Anim".
|}
====Action Types====
Note that these action types are not available for any object that registers as a "Simple Demo Cast".

===== SMG1 =====
{| class="wikitable"
! ID !! Name !! Description
|-
| 0 || Apppear || Makes the object Appear.
|-
| 1 || Kill || Makes the object Disappear (using it's Kill function).
|-
| 2 || Special Function || Executes a function that the object specifically registered to the cutscene. This is object specific, and not every object has one.
|-
| 3 || Special Nerve || Sets the objects Nerve to a nerve specifically registered to the cutscene. This is object specific, and not every object has one.
|-
| 4 || On SW_A || The SW_A of this object will be activated.
|-
| 5 || On SW_B || The SW_B of this object will be activated.
|-
| 6 || Show Model || The model of the object will be unhidden.
|-
| 7 || Hide Model || The model of the object will be hidden.
|-
| 8 || Start NPC Message || Start a conversation with an NPC. Effectively useless because NPC's do not register their text to cutscenes unless the cutscene has a specific name.
|-
| 9 || Start NPC Message (Alt) || Start a conversation with an NPC without stopping Mario's current animation. Effectively useless because NPC's do not register their text to cutscenes unless the cutscene has a specific name.
|-
| 10 || Duplicate of 9 || Duplicate of 9.
|-
| 11 || Play Animation || Plays the animation that "AnimName" is set to. This happens for all Action Types.
|-
| 12 || Off SW_A || The SW_A of this object will be deactivated.
|-
| 13 || Off SW_B || The SW_B of this object will be deactivated.
|}
===== SMG2 =====
{| class="wikitable"
! ID !! Name !! Description
|-
| 0 || Play Animation || Plays the animation that "AnimName" is set to. This happens for all Action Types.
|-
| 1 || Apppear || Makes the object Appear.
|-
| 2 || Kill || Makes the object Disappear (using it's Kill function).
|-
| 3 || Special Function || Executes a function that the object specifically registered to the cutscene. This is object specific, and not every object has one.
|-
| 4 || Special Nerve || Sets the objects Nerve to a nerve specifically registered to the cutscene. This is object specific, and not every object has one.
|-
| 5 || On SW_A || The SW_A of this object will be activated.
|-
| 6 || On SW_B || The SW_B of this object will be activated.
|-
| 7 || Show Model || The model of the object will be unhidden.
|-
| 8 || Hide Model || The model of the object will be hidden.
|-
| 9 || Start NPC Message || Start a conversation with an NPC. Effectively useless because NPC's do not register their text to cutscenes unless the cutscene has a specific name.
|-
| 10 || Start NPC Message (Alt) || Start a conversation with an NPC without stopping Mario's current animation. Effectively useless because NPC's do not register their text to cutscenes unless the cutscene has a specific name.
|-
| 11 || Duplicate of 10 || Duplicate of 10.
|-
| 12 || Off SW_A || The SW_A of this object will be deactivated.
|-
| 13 || Off SW_B || The SW_B of this object will be deactivated.
|-
| 14 || Request Movement Off || Tries to pause execution of this object.
|-
| 15 || Request Movement On || Tries to resume execution of this object.
|-
| 16 || StoryBookWarpDemo || Unknown. Related to StoryBookWarpDemo. Uses 1 as arg.
|-
| 17 || StoryBookWarpDemo || Unknown. Related to StoryBookWarpDemo. Uses 0 as arg.
|-
| 18 || StoryBookWarpDemo || Unknown. Related to StoryBookWarpDemo.
|-
| 19 || StoryBookWarpDemo || Unknown. Related to StoryBookWarpDemo.
|-
| 20 || ? || Unknown. Used at the end of the cutscene where Mario meets Yoshi for the first time.
|}

===Player===
Can position Mario/Luigi to a specific GeneralPos and play an animation.
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| PartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the sequence
|-
| PosName
| style="font-size:12px;" | STRING_OFFSET
| Name of the GeneralPos to teleport the player to
|-
| BckName
| style="font-size:12px;" | STRING_OFFSET
| Name of the animation from MarioAnim.arc to play. (All other animationtypes than BCK are also supported)
|-
| Visible
| style="font-size:12px;" | LONG
|
|}

===Camera===
Can play cameras, which can be played one after another. Can use either a camera code from the Map archive's [[Cameras|CameraParam.bcam]] file, or a key frame camera animation which are controlled via [[CANM]] files, which must be located in the object archive of the targeted object.
By default the camera is fixed on Mario/Luigi.

For BCAM usage, the Camera ID name to be used is composed of the ''PartName'' and the ''Cutscenename'' (not the sheet name): '''e:Cutscenename[PartName]'''.

For CANM usage, the name defined in ''AnimCameraName'' must match the CANM file's name and needs to be placed in the root of the targeted object's archive.
Seems to be supported only by certain objects. This has not yet been fully explored.

{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| PartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the sequence
|-
| CameraTargetName
| style="font-size:12px;" | STRING_OFFSET
| Japanese Name of the object the camera is focussed at.
|-
| CameraTargetCastID
| style="font-size:12px;" | LONG
| Cast ID of the object
|-
| AnimCameraName
| style="font-size:12px;" | STRING_OFFSET
| CANM file name (with ".canm" extension) which must be placed in the root of the targeted object's archive.
|-
| AnimCameraStartFrame
| style="font-size:12px;" | LONG
|
|-
| AnimCameraEndFrame
| style="font-size:12px;" | LONG
|
|-
| IsContinuous
| style="font-size:12px;" | LONG
|
|}

===Sound===
Can change music and play sound effects.
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| PartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the sequence
|-
| Bgm
| style="font-size:12px;" | STRING_OFFSET
|
|-
| SystemSe
| style="font-size:12px;" | STRING_OFFSET
|
|-
| ActionSe
| style="font-size:12px;" | STRING_OFFSET
|
|-
| ReturnBgm
| style="font-size:12px;" | LONG
|
|-
| BgmWipeoutFrame
| style="font-size:12px;" | LONG
|
|-
| AllSoundStopFrame
| style="font-size:12px;" | LONG
|
|}

===Wipe===
Can perform a fade out animation.
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| PartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the sequence
|-
| WipeName
| style="font-size:12px;" | STRING_OFFSET
| The wipe to use. See the [[#WipeName|WipeName]] table below.
|-
| WipeType
| style="font-size:12px;" | LONG
| The function for the Wipe to perform. See the [[#WipeType|WipeType]] table below.
|-
| WipeFrame
| style="font-size:12px;" | LONG
| The amount of frames that the wipe will move for. Higher values = Slower movement
|}

====WipeName====
Below is a list of available WipeName values:
{| class="wikitable"
|-
! Value !! Description
|-
| 円ワイプ || Circle Wipe
|-
| フェードワイプ || Black Fade
|-
| 白フェードワイプ || White Fade
|-
| ゲームオーバー || Game Over
|-
| クッパ || Bowser Face (Death wipe)
|}

''Note: The Mario wipe is missing because the Mario wipe is a System Wipe and not a Scene Wipe. DemoWipes can only be Scene Wipes.''

====WipeType====
Below is the list of Wipe functions. The table below uses the Black Fade as an example.
{| class="wikitable"
|-
! Value !! Description
|-
| 0 || Open Wipe (Fade to Gameplay)
|-
| 1 || Close Wipe (Fade to Black)
|-
| 2 || Force Open Wipe (Cut to Gameplay)
|-
| 3 || Force Close Wipe (Cut to Black)
|}

''Tip: If you need to change wipes while the wipe is closed, use Force Close before using Open for a smoother transition.''

===Hardcoded Cutscene Names===
'''Todo:''' Finish this.
{| class="wikitable"
|-
! Cutscene Name
! Meaning
! Notes
|-
| ベビチコ出会い
| Master Luma Meeting
| -Uses hardcoded cameras -Activates spin after completion when the galaxy uses the StageType "Storybook"
|}

==Tools==
Up to now, there are no tools that allow the cutscenes to be edited directly in a clear interface. Since the cutscenes sheet consists of [[BCSV]] files, they can be edited with any other BCSV editor, like Whitehole. They can also be converted to CSV files and vice versa with Pyjmap.

The tools can be found on the [[Tools_and_Resources|tools and ressources page]].

Stage files

2024-02-27T17:14:27Z

Super Hackio: Starting this page hooray

[[Category:Files]]
[[Category:Lists]]
{{WIP}}

=Super Mario Galaxy=

== Scenario.arc ==

== Map.arc ==

=Super Mario Galaxy 2=

== Scenario.arc ==

== Map.arc ==

== Sound.arc ==

== Design.arc ==

== Demo.arc ==

== Ghost.arc ==

== UseResource.arc ==

== ZoneInfo.arc ==

MSBF (File Format)

2024-02-24T14:24:11Z

Super Hackio: /* Condition Types */ Add notes

[[Category:File formats]]
'''MSBF''' stands for ''Message Binary Flow'', it contains control for the order of textboxes in '''Super Mario Galaxy 2'''.

== Header ==
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || String || ''MsgFlwBn'' in ASCII.
|-
| 0x08 || UInt16 || Endianess. 0xFEFF for Big Endian, 0xFFFE for Little Endian.
|-
| 0x0A || UInt32 || Version.
|-
| 0x0E || UInt16 || Number of sections.
|-
| 0x10 || UInt16 || Padding.
|-
| 0x12 || UInt32 || File length.
|-
| 0x16 || Byte[0xA] || Padding.
|}

= Sections =
After the header follows the sections. It is worth noting that these sections are padded to the nearest 0x10th byte with the value 0xAB.

== FLW2 ==

=== Header ===
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || String || ''FLW2'' in ASCII.
|-
| 0x04 || UInt32 || Section size. Does not account for this header or padding.
|-
| 0x08 || Byte[0x8] || Padding.
|}

=== Flow Node Entries ===

After the header come the flow node entries.
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || UInt16 || Node Entry Count.
|-
| 0x02 || Uint16 || Label Count.
|-
| 0x04 || byte[0x4] || Padding.
|}

A Node is defined by the following structure:
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || UInt16 || Node Type. See [[#Node_Types|Node Types]]
|-
| 0x0A || UInt16[0x5] || A collection of shorts. The shorts have varying uses depending on the Node Type.
|}

After the nodes, comes a list of UInt16's regarding Message Labels
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || UInt16[Label Count] || Label Value
|}

=== Node Types ===
{| class="wikitable"
! Value !! Name !! Description
|-
| 0x01 || MESSAGE || This node will display a MSBT entry. Message Labels are ignored, and are indexed by ID
|-
| 0x02 || CONDITION || This node will branch to another node based on if a condition is met or not
|-
| 0x03 || EVENT || This node will trigger an event, such as activating a switch, or spawning a star
|-
| 0x04 || ENTRY || This node should come first. It acts as the starting point, and simply has one value to point to the actual first Node.
|}

==== MESSAGE Node Format ====
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || UInt16 || Unused
|-
| 0x02 || UInt16 || Unused
|-
| 0x04 || UInt16 || Message ID
|-
| 0x06 || UInt16 || Next Flow Node ID
|-
| 0x08 || UInt16 || Unused
|}

==== CONDITION Node Format ====
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || UInt16 || Unused
|-
| 0x02 || UInt16 || '''Unknown''', always 0x0002
|-
| 0x04 || UInt16 || [[#Condition_Types|Condition Type]]
|-
| 0x06 || UInt16 || Condition Parameter. What this does depends on the [[#Condition_Types|Condition Type]] defined above
|-
| 0x08 || UInt16 || Index into the condition list. Indexes are always 1 apart (0x00, 0x02, 0x04, etc.).
|}

===== Condition Types =====
{| class="wikitable"
! ID !! Name !! Description
|-
| 0x00 || YesNo Result || Shows the YesNo Layout and displays one of the [[#YesNo_Results|YesNo Options]] '''Requires a Message Node to come before it, or else the game will crash'''.
|-
| 0x01 || BranchFunc || Object dependent. See [[#Branch_Functions|Branch Functions]]
|-
| 0x02 || Player Distance || Checks to see if the player is close enough to the NPC
|-
| 0x03 || SW_A || Checks to see if the NPC's SW_A has been activated
|-
| 0x04 || SW_B || Checks to see if the NPC's SW_B has been activated
|-
| 0x05 || Player Mode: Normal || Checks to see if the Player has no powerup
|-
| 0x06 || Player Mode: Bee || Checks to see if the Player has the Bee Mushroom
|-
| 0x07 || Player Mode: Boo || Checks to see if the Player has the Boo Mushroom
|-
| 0x08 || Power Star Appeared || Checks to see if the Power Star has spawned
|-
| 0x09 || Player || Checks to see if the Player is Luigi
|-
| 0x0A || Cutscene || Checks to see if a cutscene is currently active or not
|-
| 0x0B || Message Read Flag || Checks to see if the Player has already read this message (needs verification)
|-
| 0x0C || 120 Star Ending || Checks to see if the 120 star ending has been Achieved
|-
| 0x0D || '''Unknown''' || '''Unknown''' Only known to be used by King Whomp.
|-
| 0x0E || Player Mode: Yoshi || Checks to see if the Player is riding Yoshi
|-
| 0x0F || Player Mode: Cloud || Checks to see if the Player has the Cloud Flower
|-
| 0x10 || Player Mode: Rock || Checks to see if the Player has the Rock Mushroom
|-
|}

===== YesNo Results =====
Below is a complete list of YesNo Results, and their button text.
{| class="wikitable"
! ID !! Name !! Left Button Text (False) !! Right Button Text (True)
|-
| 0x00 || PichanRace || Quit || Race
|-
| 0x01 || TicoShopExchange || No thanks || Buy
|-
| 0x02 || TicoShopWhich || 1-Up || Life
|-
| 0x03 || Dreamer || No || Yes
|-
| 0x04 || SuperDreamer || No || Yes
|-
| 0x05 || MuimuiPlay || No thanks || OK
|-
| 0x06 || ScoreAttackPlay || No || Yes
|-
| 0x07 || ScoreAttackContinue || Start over || Continue
|-
| 0x08 || GliBirdRide || No thanks || Let's glide
|-
| 0x09 || TicoFatCoinGive || No || Yes
|-
| 0x0A || FireWoodBoxPlay || No thanks || Sure
|-
| 0x0B || GliBirdTutorial || No thanks || Tell me
|-
| 0x0C || LuigiTalkNPC || No thanks || OK
|-
| 0x0D || KinopioBank || No thanks || OK
|-
| 0x0E || LuckeyRoom || Quit || OK
|-
| 0x0F || MeisterTrade || That's right || Yes
|-
| 0x10 || TamakoroTutorial || That's OK || Tell me
|-
| 0x11 || MeisterConfirm || That's right || Yes
|-
|}

===== Branch Functions =====
Each branch function will take a single number as a parameter. if the table below lists the Parameter Name as "(none)" then you must pass in 0
{| class="wikitable"
! Object Name !! Function Name !! Parameter Name !! Description
|-
| Caretaker (Gearmo) || Caretaker::branchFuncComet || Check ID || Uses the parameter to determine which of 7 checks is performed on your current Purple Coin count. Valid values are 0, 1, 2, 3, 4, 5, and 6.
|-
| Caretaker (Gearmo) || Caretaker::branchFuncStar || (none) || Checks to see if the Geamo's SW_A has been activated
|-
| CaretakerHunter (Gearmo Hunter) || CaretakerHunter::branchFunc || (none) || '''Unknown'''
|-
| Kinopio (Toad) || Kinopio::branchFunc || Progress Check ID || See ''MR::branchFuncGameProgress'' at the bottom of the table
|-
| KinopioBank (Banktoad) || KinopioBank::branchFunc || Check ID || '''Unknown''', valid values are 0, 1, 2, 3....and something over 10000
|-
| KinopioPostman (Mailtoad) || KinopioPostman::branchFunc || Check ID || '''Unknown''', valid values are 0, and 1.
|-
| KinopioPostman (Mailtoad) || KinopioPostman::branchFuncLuigi || (none) || '''Unknown''', only activates if the player is Luigi
|-
| LuigiIntrusively (The Luigi you can play as) || LuigiIntrusively::branchFunc || (none) || '''Unknown''', checks to see if Luigi is in a specific state
|-
| LuigiTalkNPC (Luigi NPC) || LuigiTalkNPC::branchFunc || Progress Check ID || See ''MR::branchFuncGameProgress'' at the bottom of the table
|-
| MameMuimuiAttackMan (The Chimp [Ice Skating]) || MameMuimuiAttackMan::branchFunc || Check ID || 0 = Check the scorer object for '''Unknown1'''. 1 = Check the scorer object for '''Unknown2'''. 2 = Check the scorer object for a new high score.
|-
| Meister (Lubba) || Meister::branchFunc || '''Unknown''' || '''Unknown''', for some reason, this function is registered twice.
|-
| Moc (Whittle) || Moc::branchFunc || Check ID || 0 = '''Unknown''' 1 = '''Unknown''', Something related to how many purple coins you have
|-
| Pichan (Jibberjay) || Pichan::branchFunc || Check ID || 0 = '''Unknown''' 1 = Checks to see if you have completed the Glider Tutorial. 2 = '''Unknown'''
|-
| PichanRacer (Jibberjay Racer) || PichanRacer::branchFunc || Check ID || 0 = '''Unknown''' 1 = Checks to see if you have completed the Glider Tutorial. 2 = '''Unknown'''
|-
| ScoreAttackMan (The Chimp [Score Attack]) || ScoreAttackMan::branchFunc || Check ID || 0 = Checks to see if time is up. 1 = Checks to see if you have beaten the target score. 2 = Checks to see if you beat the high score. 3 = Checks to see if the stage is MokumokuValleyGalaxy (Fluffy Bluff). 4 = Checks to see if the stage is HoneyBeeVillageGalaxy (Honeyhop Galaxy).
|-
| Tico (Luma) || Tico::branchFunc || Progress Check ID || See ''MR::branchFuncGameProgress'' at the bottom of the table
|-
| TicoFatCoin (Hungry Luma [Coins]) || TicoFatCoin::branchFunc || (none) || Checks to see if you have the required amount of coins
|-
| TicoShop (Luma Shop) || TicoShop::branchFunc || (none) || Checks to see if you have the required amount of starbits
|-
| TicoShopDice (Luma Shop [Chance Cubes]) || TicoShopDice::branchFunc || (none) || Checks to see if you have the required amount of Currency (based on the object's arguments)
|-
| TogepinAttackMan (The Chimp [Bowling]) || TogepinAttackMan::branchFunc || Check ID || 0 = Check the scorer object for '''Unknown1'''. 1 = Check the scorer object for '''Unknown2'''. 2 = Check the scorer object for a new high score.
|-
| (none) || MR::branchFuncGameProgress || Progress Check ID || Valid Values are 0, 1, 2, 3, 4, 5, 6, 7, 8, and 9.
|-
|}

==== EVENT Node Format ====
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || UInt16 || Unused
|-
| 0x02 || UInt16 || [[#Event_Types|Event Type]]
|-
| 0x04 || UInt16 || Next Flow Node ID
|-
| 0x06 || UInt16 || Unused
|-
| 0x08 || UInt16 || Event Parameter. What this is used for depends on the [[#Event_Types|Event Type]]
|}

===== Event Types =====
{| class="wikitable"
! ID !! Name !! Description
|-
| 0x00 || EventFunc (With Advance) || Object Dependent. Will automatically advance to the next flow when the event completes.
|-
| 0x01 || EventFunc (No Advance) || Object Dependent. Will end the current talk session when the event completes.
|-
| 0x02 || (none) || There is no action mapped to 0x02, so it just goes to the next flow node
|-
| 0x03 || Forward Flow || Advances to the next node
|-
| 0x04 || AnimeFunc || Object Dependent
|-
| 0x05 || SW_A || Activate the NPC's SW_A
|-
| 0x06 || SW_B || Activate the NPC's SW_B
|-
| 0x07 || KillFunc || Object Dependent
|-
| 0x08 || SW_A || Deactivate the NPC's SW_A
|-
| 0x09 || SW_B || Deactivate the NPC's SW_B
|-
| 0x0A || Hide Talk Bubble Pointer || Hides the little triangle that indicates the position of the speaker
|-
| 0x0B || Show Talk Bubble Pointer || Shows the little triangle that indicates the position of the speaker
|}

==== ENTRY Node Format ====
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || UInt16 || Unused
|-
| 0x02 || UInt16 || Next Flow Node ID
|-
| 0x04 || UInt16 || Unused
|-
| 0x06 || UInt16 || Unused
|-
| 0x08 || UInt16 || Unused
|}

== FEN1 ==

=== Header ===
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || String || ''FEN1'' in ASCII.
|-
| 0x04 || UInt32 || Section size. Does not account for this header or padding.
|-
| 0x08 || Byte[0x8] || Padding.
|}

=== Data ===
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || UInt32 || Entry Count
|-
| 0x04 || Byte[0x8] || Padding
|-
| 0x08 || UInt32[Entry Count] || Data Offsets.
|}

After the data is written, there is a collection of Message Label Strings. After each string is padding to the nearest 0x04.
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || byte || String Length
|-
| 0x01 || String[String Length] || Text
|}

MSBF (File Format)

2024-02-08T02:01:21Z

Super Hackio: /* Event Types */

[[Category:File formats]]
'''MSBF''' stands for ''Message Binary Flow'', it contains control for the order of textboxes in '''Super Mario Galaxy 2'''.

== Header ==
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || String || ''MsgFlwBn'' in ASCII.
|-
| 0x08 || UInt16 || Endianess. 0xFEFF for Big Endian, 0xFFFE for Little Endian.
|-
| 0x0A || UInt32 || Version.
|-
| 0x0E || UInt16 || Number of sections.
|-
| 0x10 || UInt16 || Padding.
|-
| 0x12 || UInt32 || File length.
|-
| 0x16 || Byte[0xA] || Padding.
|}

= Sections =
After the header follows the sections. It is worth noting that these sections are padded to the nearest 0x10th byte with the value 0xAB.

== FLW2 ==

=== Header ===
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || String || ''FLW2'' in ASCII.
|-
| 0x04 || UInt32 || Section size. Does not account for this header or padding.
|-
| 0x08 || Byte[0x8] || Padding.
|}

=== Flow Node Entries ===

After the header come the flow node entries.
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || UInt16 || Node Entry Count.
|-
| 0x02 || Uint16 || Label Count.
|-
| 0x04 || byte[0x4] || Padding.
|}

A Node is defined by the following structure:
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || UInt16 || Node Type. See [[#Node_Types|Node Types]]
|-
| 0x0A || UInt16[0x5] || A collection of shorts. The shorts have varying uses depending on the Node Type.
|}

After the nodes, comes a list of UInt16's regarding Message Labels
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || UInt16[Label Count] || Label Value
|}

=== Node Types ===
{| class="wikitable"
! Value !! Name !! Description
|-
| 0x01 || MESSAGE || This node will display a MSBT entry. Message Labels are ignored, and are indexed by ID
|-
| 0x02 || CONDITION || This node will branch to another node based on if a condition is met or not
|-
| 0x03 || EVENT || This node will trigger an event, such as activating a switch, or spawning a star
|-
| 0x04 || ENTRY || This node should come first. It acts as the starting point, and simply has one value to point to the actual first Node.
|}

==== MESSAGE Node Format ====
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || UInt16 || Unused
|-
| 0x02 || UInt16 || Unused
|-
| 0x04 || UInt16 || Message ID
|-
| 0x06 || UInt16 || Next Flow Node ID
|-
| 0x08 || UInt16 || Unused
|}

==== CONDITION Node Format ====
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || UInt16 || Unused
|-
| 0x02 || UInt16 || '''Unknown''', always 0x0002
|-
| 0x04 || UInt16 || [[#Condition_Types|Condition Type]]
|-
| 0x06 || UInt16 || Condition Parameter. What this does depends on the [[#Condition_Types|Condition Type]] defined above
|-
| 0x08 || UInt16 || Index into the condition list. Indexes are always 1 apart (0x00, 0x02, 0x04, etc.).
|}

===== Condition Types =====
{| class="wikitable"
! ID !! Name !! Description
|-
| 0x00 || YesNo Result || Shows the YesNo Layout and displays one of the [[#YesNo_Results|YesNo Options]]
|-
| 0x01 || BranchFunc || Object dependent. See [[#Branch_Functions|Branch Functions]]
|-
| 0x02 || Player Distance || Checks to see if the player is close enough to the NPC
|-
| 0x03 || SW_A || Checks to see if the NPC's SW_A has been activated
|-
| 0x04 || SW_B || Checks to see if the NPC's SW_B has been activated
|-
| 0x05 || Player Mode: Normal || Checks to see if the Player has no powerup
|-
| 0x06 || Player Mode: Bee || Checks to see if the Player has the Bee Mushroom
|-
| 0x07 || Player Mode: Boo || Checks to see if the Player has the Boo Mushroom
|-
| 0x08 || Power Star Appeared || Checks to see if the Power Star has spawned
|-
| 0x09 || Player || Checks to see if the Player is Luigi
|-
| 0x0A || Cutscene || Checks to see if a cutscene is currently active or not
|-
| 0x0B || Message Read Flag || Checks to see if the Player has already read this message
|-
| 0x0C || 120 Star Ending || Checks to see if the 120 star ending has been Achieved
|-
| 0x0D || '''Unknown''' || '''Unknown'''
|-
| 0x0E || Player Mode: Yoshi || Checks to see if the Player is riding Yoshi
|-
| 0x0F || Player Mode: Cloud || Checks to see if the Player has the Cloud Flower
|-
| 0x10 || Player Mode: Rock || Checks to see if the Player has the Rock Mushroom
|-
|}

===== YesNo Results =====
Below is a complete list of YesNo Results, and their button text.
{| class="wikitable"
! ID !! Name !! Left Button Text (False) !! Right Button Text (True)
|-
| 0x00 || PichanRace || Quit || Race
|-
| 0x01 || TicoShopExchange || No thanks || Buy
|-
| 0x02 || TicoShopWhich || 1-Up || Life
|-
| 0x03 || Dreamer || No || Yes
|-
| 0x04 || SuperDreamer || No || Yes
|-
| 0x05 || MuimuiPlay || No thanks || OK
|-
| 0x06 || ScoreAttackPlay || No || Yes
|-
| 0x07 || ScoreAttackContinue || Start over || Continue
|-
| 0x08 || GliBirdRide || No thanks || Let's glide
|-
| 0x09 || TicoFatCoinGive || No || Yes
|-
| 0x0A || FireWoodBoxPlay || No thanks || Sure
|-
| 0x0B || GliBirdTutorial || No thanks || Tell me
|-
| 0x0C || LuigiTalkNPC || No thanks || OK
|-
| 0x0D || KinopioBank || No thanks || OK
|-
| 0x0E || LuckeyRoom || Quit || OK
|-
| 0x0F || MeisterTrade || That's right || Yes
|-
| 0x10 || TamakoroTutorial || That's OK || Tell me
|-
| 0x11 || MeisterConfirm || That's right || Yes
|-
|}

===== Branch Functions =====
Each branch function will take a single number as a parameter. if the table below lists the Parameter Name as "(none)" then you must pass in 0
{| class="wikitable"
! Object Name !! Function Name !! Parameter Name !! Description
|-
| Caretaker (Gearmo) || Caretaker::branchFuncComet || Check ID || Uses the parameter to determine which of 7 checks is performed on your current Purple Coin count. Valid values are 0, 1, 2, 3, 4, 5, and 6.
|-
| Caretaker (Gearmo) || Caretaker::branchFuncStar || (none) || Checks to see if the Geamo's SW_A has been activated
|-
| CaretakerHunter (Gearmo Hunter) || CaretakerHunter::branchFunc || (none) || '''Unknown'''
|-
| Kinopio (Toad) || Kinopio::branchFunc || Progress Check ID || See ''MR::branchFuncGameProgress'' at the bottom of the table
|-
| KinopioBank (Banktoad) || KinopioBank::branchFunc || Check ID || '''Unknown''', valid values are 0, 1, 2, 3....and something over 10000
|-
| KinopioPostman (Mailtoad) || KinopioPostman::branchFunc || Check ID || '''Unknown''', valid values are 0, and 1.
|-
| KinopioPostman (Mailtoad) || KinopioPostman::branchFuncLuigi || (none) || '''Unknown''', only activates if the player is Luigi
|-
| LuigiIntrusively (The Luigi you can play as) || LuigiIntrusively::branchFunc || (none) || '''Unknown''', checks to see if Luigi is in a specific state
|-
| LuigiTalkNPC (Luigi NPC) || LuigiTalkNPC::branchFunc || Progress Check ID || See ''MR::branchFuncGameProgress'' at the bottom of the table
|-
| MameMuimuiAttackMan (The Chimp [Ice Skating]) || MameMuimuiAttackMan::branchFunc || Check ID || 0 = Check the scorer object for '''Unknown1'''. 1 = Check the scorer object for '''Unknown2'''. 2 = Check the scorer object for a new high score.
|-
| Meister (Lubba) || Meister::branchFunc || '''Unknown''' || '''Unknown''', for some reason, this function is registered twice.
|-
| Moc (Whittle) || Moc::branchFunc || Check ID || 0 = '''Unknown''' 1 = '''Unknown''', Something related to how many purple coins you have
|-
| Pichan (Jibberjay) || Pichan::branchFunc || Check ID || 0 = '''Unknown''' 1 = Checks to see if you have completed the Glider Tutorial. 2 = '''Unknown'''
|-
| PichanRacer (Jibberjay Racer) || PichanRacer::branchFunc || Check ID || 0 = '''Unknown''' 1 = Checks to see if you have completed the Glider Tutorial. 2 = '''Unknown'''
|-
| ScoreAttackMan (The Chimp [Score Attack]) || ScoreAttackMan::branchFunc || Check ID || 0 = Checks to see if time is up. 1 = Checks to see if you have beaten the target score. 2 = Checks to see if you beat the high score. 3 = Checks to see if the stage is MokumokuValleyGalaxy (Fluffy Bluff). 4 = Checks to see if the stage is HoneyBeeVillageGalaxy (Honeyhop Galaxy).
|-
| Tico (Luma) || Tico::branchFunc || Progress Check ID || See ''MR::branchFuncGameProgress'' at the bottom of the table
|-
| TicoFatCoin (Hungry Luma [Coins]) || TicoFatCoin::branchFunc || (none) || Checks to see if you have the required amount of coins
|-
| TicoShop (Luma Shop) || TicoShop::branchFunc || (none) || Checks to see if you have the required amount of starbits
|-
| TicoShopDice (Luma Shop [Chance Cubes]) || TicoShopDice::branchFunc || (none) || Checks to see if you have the required amount of Currency (based on the object's arguments)
|-
| TogepinAttackMan (The Chimp [Bowling]) || TogepinAttackMan::branchFunc || Check ID || 0 = Check the scorer object for '''Unknown1'''. 1 = Check the scorer object for '''Unknown2'''. 2 = Check the scorer object for a new high score.
|-
| (none) || MR::branchFuncGameProgress || Progress Check ID || Valid Values are 0, 1, 2, 3, 4, 5, 6, 7, 8, and 9.
|-
|}

==== EVENT Node Format ====
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || UInt16 || Unused
|-
| 0x02 || UInt16 || [[#Event_Types|Event Type]]
|-
| 0x04 || UInt16 || Next Flow Node ID
|-
| 0x06 || UInt16 || Unused
|-
| 0x08 || UInt16 || Event Parameter. What this is used for depends on the [[#Event_Types|Event Type]]
|}

===== Event Types =====
{| class="wikitable"
! ID !! Name !! Description
|-
| 0x00 || EventFunc (With Advance) || Object Dependent. Will automatically advance to the next flow when the event completes.
|-
| 0x01 || EventFunc (No Advance) || Object Dependent. Will end the current talk session when the event completes.
|-
| 0x02 || (none) || There is no action mapped to 0x02, so it just goes to the next flow node
|-
| 0x03 || Forward Flow || Advances to the next node
|-
| 0x04 || AnimeFunc || Object Dependent
|-
| 0x05 || SW_A || Activate the NPC's SW_A
|-
| 0x06 || SW_B || Activate the NPC's SW_B
|-
| 0x07 || KillFunc || Object Dependent
|-
| 0x08 || SW_A || Deactivate the NPC's SW_A
|-
| 0x09 || SW_B || Deactivate the NPC's SW_B
|-
| 0x0A || Hide Talk Bubble Pointer || Hides the little triangle that indicates the position of the speaker
|-
| 0x0B || Show Talk Bubble Pointer || Shows the little triangle that indicates the position of the speaker
|}

==== ENTRY Node Format ====
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || UInt16 || Unused
|-
| 0x02 || UInt16 || Next Flow Node ID
|-
| 0x04 || UInt16 || Unused
|-
| 0x06 || UInt16 || Unused
|-
| 0x08 || UInt16 || Unused
|}

== FEN1 ==

=== Header ===
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || String || ''FEN1'' in ASCII.
|-
| 0x04 || UInt32 || Section size. Does not account for this header or padding.
|-
| 0x08 || Byte[0x8] || Padding.
|}

=== Data ===
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || UInt32 || Entry Count
|-
| 0x04 || Byte[0x8] || Padding
|-
| 0x08 || UInt32[Entry Count] || Data Offsets.
|}

After the data is written, there is a collection of Message Label Strings. After each string is padding to the nearest 0x04.
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || byte || String Length
|-
| 0x01 || String[String Length] || Text
|}

Cameras

2024-01-31T01:18:20Z

Super Hackio: /* Contexts */

[[Category:Files]]
[[Category:Lists]]
{{WIP}}

The ''Galaxy'' games use cameras to create a good view of the game's 3D scene. There are many different types to fulfill this purpose, all of which are detailed on this page. Each stage (galaxies, zones, ...) comes with a file that specifies all the camera setups to be used. The format of these files is specified [[#BCAM Format|below]].

==Contexts==
Cameras are used in a lot of different contexts and may be triggered through various means, including:
* Camera areas (''CameraArea'', ''CubeCameraBox'', etc.) once they are entered. More information [[#Cube|below]].
* Spawn points (''Mario'' entries in a zone's ''StartInfo'' file) once the player respawns there. More information [[#Start|below]].
* Warp Pipes once they are being exited.
* When the player rides Launch Stars, Sling Stars, Vines and more.
* When the player swims underwater or on the water's surface.
* When the player uses the Flying Power-Up.
* While talking to an NPC.
* Various objects and enemies use special cameras, such as ''SimpleDemoExecutor'', ''JumpBeamer'', ''Poihana'' and ''BegomanSpring''.
* Cutscenes use various cameras to change the view.

==BCAM Format==
All camera parameters for a zone (and some objects) are stored in a special [[BCSV (File format)|BCSV]] file called ''CameraParam.bcam''. For zones, the file is located in ''Stage/camera'' of a ''Map'' archive. Not all files will contain all known camera fields in order to save some space. These optional fields are only added when a camera wants to use a value other than the default one. The following table lists all fields, their default values, data type, camera type exclusivity, and whether they are always required or not.

{| class="wikitable"
|-
! Field !! Type !! Default value !! Exclusivity !! Required?
|-
| version||LONG||196630 (SMG1) 196631 (SMG2)|| ||✓
|-
| camtype||STRING_OFFSET||''(empty string)''|| ||✓
|-
| id||STRING_OFFSET||''(empty string)''|| ||✓
|-
| angleB||FLOAT||0.3|| ||✗
|-
| angleA||FLOAT||1200.0|| ||✗
|-
| dist||FLOAT||0.0|| ||✗
|-
| vpanaxis.X||FLOAT||0.0|| ||✗
|-
| vpanaxis.Y||FLOAT||1.0|| ||✗
|-
| vpanaxis.Z||FLOAT||0.0|| ||✗
|-
| vpanuse||LONG||1|| ||✗
|-
| udown||LONG||120|| ||✗
|-
| pushdelaylow||LONG||120|| ||✗
|-
| pushdelay||LONG||120|| ||✗
|-
| lplay||FLOAT||800.0|| ||✗
|-
| uplay||FLOAT||300.0|| ||✗
|-
| gndint||LONG||160|| ||✗
|-
| lower||FLOAT||0.1|| ||✗
|-
| upper||FLOAT||0.3|| ||✗
|-
| camint||LONG||120|| ||✗
|-
| fovy||FLOAT||45.0|| ||✗
|-
| roll||FLOAT||0.0|| ||✗
|-
| loffsetv||FLOAT||0.0|| ||✗
|-
| loffset||FLOAT||0.0|| ||✗
|-
| woffset.X||FLOAT||0.0|| ||✗
|-
| woffset.Y||FLOAT||100.0 (SMG1) 0.0 (SMG2)|| ||✗
|-
| woffset.Z||FLOAT||0.0|| ||✗
|-
| num1||LONG||0 (SMG1) 1 (SMG2)|| ||✗
|-
| num2||LONG||0|| ||✗
|-
| string||STRING_OFFSET||''(empty string)''|| ||✗
|-
| axis.X||FLOAT||0.0|| ||✗
|-
| axis.Y||FLOAT||1.0|| ||✗
|-
| axis.Z||FLOAT||0.0|| ||✗
|-
| up.X||FLOAT||0.0|| ||✗
|-
| up.Y||FLOAT||0.0 (SMG1) 1.0 (SMG2)|| ||✗
|-
| up.Z||FLOAT||0.0|| ||✗
|-
| wpoint.X||FLOAT||0.0|| ||✗
|-
| wpoint.Y||FLOAT||0.0|| ||✗
|-
| wpoint.Z||FLOAT||0.0|| ||✗
|-
| flag.noreset||LONG||0|| ||✗
|-
| flag.nofovy||LONG||0|| ||✗
|-
| flag.lofserpoff||LONG||0|| ||✗
|-
| flag.antibluroff||LONG||0|| ||✗
|-
| flag.collisionoff||LONG||0|| ||✗
|-
| flag.subjectiveoff||LONG||0|| ||✗
|-
| gflag.thru||LONG||0||'''c:''' '''g:''' '''s:'''||✗
|-
| gflag.enableEndErpFrame||LONG||0||'''c:''' '''g:''' '''s:'''||✗
|-
| gflag.camendint||LONG||0||'''c:''' '''g:''' '''s:'''||✗
|-
| eflag.enableErpFrame||LONG||0||'''e:'''||✗
|-
| eflag.enableEndErpFrame||LONG||0||'''e:'''||✗
|-
| camendint||LONG||0||'''e:'''||✗
|-
| evfrm||LONG||0||'''e:'''||✗
|-
| evpriority||LONG||1||'''e:'''||✗
|}

==Camera ID Names==
The ''id'' field of a camera parameter entry is a special ID name that specifies the camera's usage context. Every entry should have a unique ID name. The camera ID is categorized into five different categories which are described below.

===Cube===
Cube cameras are cameras which are referenced from a camera area (''CameraArea'' in Super Mario Galaxy 2, ''CubeCamera'', ''CubeCameraBox'' etc in Super Mario Galaxy). When the player is inside a camera area, it activate the referenced camera. If multiple camera areas interesect, the area with the highest priority (''Obj_arg2'') will be selected. The camera area's ''Obj_arg0'' value specifies the ID number of the camera to be used. Using this value, the game generates an identifier string using the [https://en.wikipedia.org/wiki/Printf_format_string printf format string] '''c:%04x'''. For example, if your camera area has an ''Obj_arg0'' of 15, the corresponding camera ID name would be ''c:000f''. Note that the hexadecimal digits must be lowercase.

===Start===
Start cameras are used when a camera is referenced from a start point. Every player spawn point (''Mario'' entries in a zone's ''StartInfo'') can activate a camera once the player respawns there. Just like camera areas, the game constructs an identifier string from the spawn point's ''CameraSetId'' which will be used to locate the parameters for the camera. The [https://en.wikipedia.org/wiki/Printf_format_string printf format string] is '''s:%04x'''. For example, if your ''Mario'' entry has a ''CameraSetId'' of 60, the corresponding camera ID name would be ''s:003c''. The hexadecimal digits must be lowercase. If the ''CameraSetId'' is negative, no camera will be used.

===Event===
Event cameras are cameras which are used for different events. One example of an event camera is Mario's intro flying, which is shown when entering all galaxies. Event cameras have the format "e:S:XXX:YYY" where S is the event name, XXX is the camera set ID in lowercase hex and YY is the event index, also in lowercase hex. Most event consists of multiple cameras, which is what YY is used for. For example, the camera for the second Mario's intro flying, with the camera set ID 5 would be "e:シナリオスターター:005:01番目". The following table shows known event cameras:

{| class="wikitable"
|-
! ID !! Description
|-
| e:シナリオスターター:XXX:YY番目 || Scenario start camera YY.
|-
| e:スーパースピンドライバー:XXX:YY番目 || Super spin driver camera YY. Camera 00 is used when Mario enters the launch star, and 01 and up are used for when Mario is flying.
|-
| e:スーパースピンドライバー固有出現イベント用XXX || Super spin driver appearance event camera for camera set ID XXX.
|}

===Group===
Group cameras have unknown usage, but has the format "g:S" where S is the group name.

===Other===
Other cameras are used for various cameras which does not belong to any of the previously described categories. The ID follows the format "o:S" where S is the name. The following table shows known other cameras:

{| class="wikitable"
|-
! ID !! Description
|-
| o:デフォルトカメラ || Default camera to be used if no other camera is active or available.
|-
| o:デフォルト水中カメラ || Default camera to be used when the player is swimming underwater.
|-
| o:デフォルト水面カメラ || Default camera to be used when the player is swimming on water surface.
|-
| o:デフォルトフーファイターカメラ || Camera to be used when the player is using the Flying Power-Up.
|-
| o:ズームカメラ || The first person's view camera.
|}

==Camera Classes==
There are ''many'' fine-tuned camera classes to choose from. The ''camtype'' field of a camera entry specifies what class to use. The available classes in the ''Galaxy'' games are:

{| class="wikitable"
|-
! Identifier !! Japanese Name !! Class Name !! Used in SMG1? !! Used in SMG2? !! Description !! Parameters
|-
| CAM_TYPE_XZ_PARA||並行||CameraParallel||✓||✓|| This camera moves parallel to Mario's position using fixed angles and distance.
||
* '''dist''': Distance from Mario's position.
* '''angleB''': Horizontal angle in radians.
* '''angleA''': Vertical angle in radians.
* '''num1''': Enables resetting and rounding if non-zero.
|-
| CAM_TYPE_WONDER_PLANET||プラネット||CameraWonderPlanet||✓||✓||
||
* angleA
* axis.X
* axis.Y
|-
| CAM_TYPE_TOWER||塔||CameraTower||✓||✓|| This camera is focused at a set coordinate and rotates around this point based on Mario's position.
||
* '''dist''': Distance from fixpoint position.
* '''angleA''': Vertical angle in radians.
* '''angleB''': Size of the radius area at which the camera stops rotating. The higher the more restricted.
* '''wpoint''': Fixed point coordinate
* '''axis''':Which Axis to use for rotating
|-
| CAM_TYPE_TOWER_POS||塔（サブターゲット付き）||CameraTowerPos||✓||✓||
||
* angleB
* angleA
* up.X
* up.Y
* wpoint
* axis
|-
| CAM_TYPE_INWARD_TOWER||塔内部||CameraInwardTower||✓||✗||
||
* axis
* angleB
* angleA
* dist
* wpoint
|-
| CAM_TYPE_INWARD_SPHERE||球内部||CameraInwardSphere||✓||✗||
||
* angleA
* angleB
* dist
|-
| CAM_TYPE_POINT_FIX||完全固定||CameraFix||✓||✓||
||
* dist
* axis.X
* axis.Y
* wpoint
* up
|-
| CAM_TYPE_EYEPOS_FIX||定点||CameraFixedPoint||✓||✓|| Fixed camera which looks at Mario.
||
* '''wpoint''': Position of the camera.
* num1
* '''roll''': Z rotation in radians.
|-
| CAM_TYPE_EYEPOS_FIX_THERE||その場定点||CameraFixedThere||✓||✓|| Stops the camera in the position of the last camera used and focuses on Mario. Mostly used for the landing sequence of flying stars.
||
* num2
* num1
|-
| CAM_TYPE_TRUNDLE||トランドル||CameraTrundle||✓||✓||
||
* up.X
* angleA
* angleB
* dist
* wpoint
* axis
|-
| CAM_TYPE_SPHERE_TRUNDLE||球トランドル||CameraSphereTrundle||n/a||✓||
|| ?
|-
| CAM_TYPE_INNER_CYLINDER||円筒内部||CameraInnerCylinder||✓||✗||
||
* axis
* angleA
* angleB
* dist
* up.X
* wpoint
|-
| CAM_TYPE_CUBE_PLANET||キューブ惑星||CameraCubePlanet||✓||✓|| Variant of camera type follow in which the camera rotates along based on Mario's current gravitational frame.
||
* dist
* angleA
* angleB
|-
| CAM_TYPE_CHARMED_FIX||サンボ||CameraCharmedFix||✓||✓||
||
* up
* axis
* wpoint
|-
| CAM_TYPE_CHARMED_VECREG||ベクトルレジスタ注目||CameraCharmedVecReg||✓||✓||
||
* angleA
* angleB
* axis
* dist
* string
|-
| CAM_TYPE_CHARMED_VECREG_TOWER||VecReg角度補正塔カメラ||CameraCharmedVecRegTower||✓||✓||
||
* axis
* dist
* angleA
* angleB
* string
* wpoint
* num1
|-
| CAM_TYPE_MEDIAN_PLANET||中点注目プラネット||CameraMedianPlanet||✓||✓||
||
* wpoint.X
* dist
* angleB
* angleA
* axis
* string
|-
| CAM_TYPE_MEDIAN_TOWER||中点塔カメラ||CameraMedianTower||✓||✓||
||
* string
* up
* angleA
* wpoint
* axis
|-
| CAM_TYPE_FOLLOW||フォロー||CameraFollow||✓||✓||
||
* axis.X
* axis.Y
* angleA
* angleB
* dist
* num1
|-
| CAM_TYPE_RACE_FOLLOW||レース用フォロー||CameraRaceFollow||✓||✓||
||
* angleA
* wpoint
* num1
|-
| CAM_TYPE_WATER_FOLLOW||水中フォロー||CameraWaterFollow||✓||✓||
||
* dist
* axis.Y
* axis.Y
|-
| CAM_TYPE_WATER_PLANET||水中プラネット||CameraWaterPlanet||✓||✓||
||
* angleA
* axis.X
* axis.Y
|-
| CAM_TYPE_WATER_PLANET_BOSS||水中プラネットボス||CameraWaterPlanetBoss||✓||✗||
||
* up
* num1
* wpoint
* axis
* dist
|-
| CAM_TYPE_TRIPOD_PLANET||三脚惑星||CameraTripodPlanet||✓||✓||
||
* up
* dist
* wpoint
* axis
|-
| CAM_TYPE_TRIPOD_BOSS||三脚ボス||CameraTripodBoss||✗||n/a||
||
* up
* dist
* axis
* wpoint
|-
| CAM_TYPE_TRIPOD_BOSS_JOINT||三脚ボスジョイント||CameraTripodBossJoint||✓||n/a||
||
* num1
* dist
* angleA
* angleB
* axis
|-
| CAM_TYPE_CHARMED_TRIPOD_BOSS||三脚ボスジョイント注視||CameraCharmedTripodBoss||✓||n/a||
||
* up
* axis.X
* axis.Y
* num1
* wpoint
|-
| CAM_TYPE_FOO_FIGHTER||フーファイター||CameraFooFighter||✓||✗||
||
* dist
* axis.X
* axis.Y
|-
| CAM_TYPE_FOO_FIGHTER_PLANET||フーファイタープラネット||CameraFooFighterPlanet||✓||✗||
||
* dist
* axis.X
* axis.Y
|-
| CAM_TYPE_RAIL_WATCH||レール注目||CameraRailWatch||✓||✓||
||
* num1
* num2
* axis.X
* dist
* angleA
|-
| CAM_TYPE_RAIL_DEMO||レールデモ||CameraRailDemo||✗||✗||
||
* num1
* num2
* dist
|-
| CAM_TYPE_RAIL_FOLLOW||レールフォロー||CameraRailFollow||✓||✗||
||
* num1
* num2
* dist
* wpoint.X
* wpoint.Y
|-
| CAM_TYPE_OBJ_PARALLEL||オブジェ並行||CameraObjParallel||✓||✓||
||
* dist
* '''angleA''': Pitch in radians.
* angleB
|-
| CAM_TYPE_MTXREG_PARALLEL||マトリクスレジスタ並行||CameraMtxRegParallel||✓||✓||
||
* string
* angleA
* angleB
* dist
|-
| CAM_TYPE_SLIDER||スライダー||CameraBehind||✗||✗||
||
* angleA
* angleB
* dist
* axis.X
|-
| CAM_TYPE_2D_SLIDE||２Ｄスライド||CameraSlide||✓||✓||
||
* axis
* up
* dist
* angleA
* wpoint
|-
| CAM_TYPE_GROUND||地面||CameraGround||✓||✗||
||
* angleA
* angleB
* dist
* up
|-
| CAM_TYPE_SPIRAL_DEMO||螺旋デモ||CameraSpiral||✓||✓||
||
* num1
* num2
* axis
* wpoint
|-
| CAM_TYPE_TWISTED_PASSAGE||ねじれ回廊||CameraTwistedPassage||✓||✗||
||
* num1
* axis.X
* axis.Y
|-
| CAM_TYPE_FRONT_AND_BACK||表裏カメラ||CameraFrontAndBack||✓||✓||
||
* axis
* angleA
* angleB
* dist
* wpoint
|-
| CAM_TYPE_FREEZE||その場完全固定||CameraFreeze||n/a||✓|| Stops and freezes the camera completely based on the last camera position and rotation.
|| ?
|-
| CAM_TYPE_TALK||会話||CameraTalk||✗||✗||
||
* wpoint
* up
* axis.X
* axis.Y
|-
| CAM_TYPE_ANIM||アニメ||CameraAnim||✗||✗||
||
* num1
* dist
|-
| CAM_TYPE_DEAD||通常死亡||CameraDead||✗||✗||
||
* num1
* num2
* dist
|-
| CAM_TYPE_BLACK_HOLE||ブラックホール||CameraBlackHole||✗||✗||
||
* axis
* wpoint
|-
| CAM_TYPE_DPD||ＤＰＤ||CameraDPD||✗||✗||
||
* num2
* up.X
* wpoint
* angleA
* angleB
* dist
* num1
|-
| CAM_TYPE_SUBJECTIVE||主観||CameraSubjective||✗||✗|| ||n/a
|}

===Aliases===
Likely for the purpose of preserving compatibility with test camera files, the developers added aliases for some camera classes. These exist in both ''Galaxy'' games. However, these aliases only apply if the camera version is greater or equal to the required version. Interestingly, it also contains an alias for ''CAM_TYPE_BOSS_DONKETSU'', a camera class that has been removed from the actual game.

{| class="wikitable"
|-
! Alias Name !! Actual Name !! Required Version
|-
| CAM_TYPE_DONKETSU_TEST || CAM_TYPE_BOSS_DONKETSU || 196612
|-
| CAM_TYPE_BEHIND_DEBUG || CAM_TYPE_SLIDER || 196614
|-
| CAM_TYPE_INWARD_TOWER_TEST || CAM_TYPE_INWARD_TOWER || 196614
|-
| CAM_TYPE_EYE_FIXED_THERE_TEST || CAM_TYPE_EYEPOS_FIX_THERE || 196614
|-
| CAM_TYPE_ICECUBE_PLANET || CAM_TYPE_CUBE_PLANET || 196617
|}

==Common Properties==
{| class="wikitable"
|-
! Property !! Description
|-
! colspan="2" | General
|-
| version || Camera engine version. Usually 196630 in ''Super Mario Galaxy 1'' and 196631 in ''Super Mario Galaxy 2''.
|-
| camtype || Class identifier name. See the tables above for possible values.
|-
| id || The camera's identifier name. See the [[#Camera ID Names|respective section]] for more details.
|-
| woffset.X woffset.Y woffset.Z ||A constant offset from the target relative to the Zone the camera belongs to.
|-
| loffset ||An offset from the target's forward vector. Higher values move the camera further in front of the target and lower values move it behind the target.
|-
| loffsetv ||An offset from the target's upward vector. Higher values move the camera further above the target and lower values move it below the target.
|-
| roll ||Rotates the camera. 180 will flip the camera upside down
|-
| fovy || The [https://en.wikipedia.org/wiki/Field_of_view field of view] angle in degrees. Huge numbers cause visual issues, so it's best to keep this between 0 and 179.9
|-
| camint || The amount of time in frames it takes for the camera to get into it's active position
|-
| upper || Upper screen bound relative to the center of the screen
|-
| lower || Lower screen bound relative to the cetner of the screen
|-
| gndint ||
|-
| uplay || How high in the world the target needs to go before the camera physically starts moving upwards
|-
| lplay || How low in the world the target needs to go before the camera physically starts moving downwards
|-
| pushdelay || The activation time in frames for when the Upper bound activates
|-
| pushdelaylow || The activation time in frames for when the Lower bound activates
|-
| udown ||
|-
| vpanuse || Enables the use of the Camera Height Arrangement
|-
| vpanaxis.X vpanaxis.Y vpanaxis.Z ||
|-
| flag.noreset ||
|-
| flag.nofovy || If enabled, the FoV can be changed
|-
| flag.lofserpoff || If enabled, the loffset and loffsetv will not interpolate into position and snap to where it needs to be.
|-
| flag.antibluroff || If enabled, rotating the camera will be not be smooth
|-
| flag.collisionoff || Disables collision with map geometry if enabled. This means that the camera will move through collision if necessary.
|-
| flag.subjectiveoff || Disables the first-person camera if enabled.
|-
! colspan="2" | ''Game''
|-
| gflag.thru ||
|-
| gflag.enableEndErpFrame || If enabled, a "Camera deactivation time" (gflag.camendint) will be enabled, and deactivating this camera will have this time be used instead of the new camera's time
|-
| gflag.camendint || Determines the time in frames that this camera will need to deactivate
|-
! colspan="2" | ''Event''
|-
| eflag.enableErpFrame ||
|-
| eflag.enableEndErpFrame ||
|-
| camendint ||
|-
| evfrm || The time in frames that this event camera is active for
|-
| evpriority || Always 1.
|}

==Trivia==
* The oldest available camera version is 196617 and can be found in ''HellLavaFloatingZone''.
* The function ''CameraParamChunk::load'' references a removed camera class labeled as ''CAM_TYPE_PLANET''.
* Intro cameras dynamically create a ''CAM_TYPE_ANIM'' camera with the ID ''o:スタートアニメカメラ''. It is not possible to overwrite this in a BCAM file.

UseResource

2024-01-27T17:14:28Z

Super Hackio: Added basic information on UseResource

[[Category:Files]]
{{WIP}}

This page only applies to ''Super Mario Galaxy 2''

UseResource is an archive that only the main galaxy can have. It provides the game with a list of items from the disc that will be loaded into memory asynchronously, which makes loading faster.

It is important to note that if a file that is inside UseResource doesn't exist, the game will hang while loading the scene.

== Naming Convention ==
These UseResource files use the following naming convention:
{| class="wikitable"
|-
! Scenario Target !! Filename !! Examples
|-
| All Scenarios || common || common.bcsv, sound_common.bcsv
|-
| Scenario X || scenario_X || scenario_1.bcsv, sound_scenario_3.bcsv (basically just replace the "X" with the scenario number)
|}

== File Lists ==
=== Standard Files ===
A UseResource BCSV to load files into memory.
{| class="wikitable"
|-
! Field !! Type !! Description
|-
| ResourceName || STRING || Put the game disc path to a file that you want to load here. Example: '''/ObjectData/Kuribo.arc'''
|}
=== Sounds ===
A UseResource BCSV to load sounds by name into memory. Be aware that there is an unknown maximum to how many sounds that can be loaded at once.
{| class="wikitable"
|-
! Field !! Type !! Description
|-
| SoundName || STRING || Put the name of the sfx you want to load here. Example: '''SE_PM_SPIN_ATTACK'''
|}

== Unused Files ==
Inside a UseResource are files named "wave_arc_<Scenario>.bcsv". These are not used by the game for anything, and can be deleted freely. It is assumed that they used to load specific .aw files during development. For completeness, the BCSV is documented below.
{| class="wikitable"
|-
! Field !! Type
|-
| WaveArcName|| STRING
|}

Cameras

2024-01-27T03:41:47Z

Super Hackio: /* Common Properties */ Add descriptions for most properties

[[Category:Files]]
[[Category:Lists]]
{{WIP}}

The ''Galaxy'' games use cameras to create a good view of the game's 3D scene. There are many different types to fulfill this purpose, all of which are detailed on this page. Each stage (galaxies, zones, ...) comes with a file that specifies all the camera setups to be used. The format of these files is specified [[#BCAM Format|below]].

==Contexts==
Cameras are used in a lot of different contexts and may be triggered through various means, including:
* Camera areas (''CameraArea'', ''CubeCameraBox'', etc.) once they are entered. More information [[#Cube|below]].
* Spawn points (''Mario'' entries in a zone's ''StartInfo'' file) once the player respawns there. More information [[#Start|below]].
* Warp Pipes once they are entered or left.
* When the player rides Launch Stars or Sling Stars.
* When the player swims underwater or on the water's surface.
* When the player uses the Flying Power-Up.
* While talking to an NPC.
* Various objects and enemies use special cameras, such as ''SimpleDemoExecutor'', ''JumpBeamer'', ''Poihana'' and ''BegomanSpring''.
* Cutscenes use various cameras to change the view.

==BCAM Format==
All camera parameters for a zone (and some objects) are stored in a special [[BCSV (File format)|BCSV]] file called ''CameraParam.bcam''. For zones, the file is located in ''Stage/camera'' of a ''Map'' archive. Not all files will contain all known camera fields in order to save some space. These optional fields are only added when a camera wants to use a value other than the default one. The following table lists all fields, their default values, data type, camera type exclusivity, and whether they are always required or not.

{| class="wikitable"
|-
! Field !! Type !! Default value !! Exclusivity !! Required?
|-
| version||LONG||196630 (SMG1) 196631 (SMG2)|| ||✓
|-
| camtype||STRING_OFFSET||''(empty string)''|| ||✓
|-
| id||STRING_OFFSET||''(empty string)''|| ||✓
|-
| angleB||FLOAT||0.3|| ||✗
|-
| angleA||FLOAT||1200.0|| ||✗
|-
| dist||FLOAT||0.0|| ||✗
|-
| vpanaxis.X||FLOAT||0.0|| ||✗
|-
| vpanaxis.Y||FLOAT||1.0|| ||✗
|-
| vpanaxis.Z||FLOAT||0.0|| ||✗
|-
| vpanuse||LONG||1|| ||✗
|-
| udown||LONG||120|| ||✗
|-
| pushdelaylow||LONG||120|| ||✗
|-
| pushdelay||LONG||120|| ||✗
|-
| lplay||FLOAT||800.0|| ||✗
|-
| uplay||FLOAT||300.0|| ||✗
|-
| gndint||LONG||160|| ||✗
|-
| lower||FLOAT||0.1|| ||✗
|-
| upper||FLOAT||0.3|| ||✗
|-
| camint||LONG||120|| ||✗
|-
| fovy||FLOAT||45.0|| ||✗
|-
| roll||FLOAT||0.0|| ||✗
|-
| loffsetv||FLOAT||0.0|| ||✗
|-
| loffset||FLOAT||0.0|| ||✗
|-
| woffset.X||FLOAT||0.0|| ||✗
|-
| woffset.Y||FLOAT||100.0 (SMG1) 0.0 (SMG2)|| ||✗
|-
| woffset.Z||FLOAT||0.0|| ||✗
|-
| num1||LONG||0 (SMG1) 1 (SMG2)|| ||✗
|-
| num2||LONG||0|| ||✗
|-
| string||STRING_OFFSET||''(empty string)''|| ||✗
|-
| axis.X||FLOAT||0.0|| ||✗
|-
| axis.Y||FLOAT||1.0|| ||✗
|-
| axis.Z||FLOAT||0.0|| ||✗
|-
| up.X||FLOAT||0.0|| ||✗
|-
| up.Y||FLOAT||0.0 (SMG1) 1.0 (SMG2)|| ||✗
|-
| up.Z||FLOAT||0.0|| ||✗
|-
| wpoint.X||FLOAT||0.0|| ||✗
|-
| wpoint.Y||FLOAT||0.0|| ||✗
|-
| wpoint.Z||FLOAT||0.0|| ||✗
|-
| flag.noreset||LONG||0|| ||✗
|-
| flag.nofovy||LONG||0|| ||✗
|-
| flag.lofserpoff||LONG||0|| ||✗
|-
| flag.antibluroff||LONG||0|| ||✗
|-
| flag.collisionoff||LONG||0|| ||✗
|-
| flag.subjectiveoff||LONG||0|| ||✗
|-
| gflag.thru||LONG||0||'''c:''' '''g:''' '''s:'''||✗
|-
| gflag.enableEndErpFrame||LONG||0||'''c:''' '''g:''' '''s:'''||✗
|-
| gflag.camendint||LONG||0||'''c:''' '''g:''' '''s:'''||✗
|-
| eflag.enableErpFrame||LONG||0||'''e:'''||✗
|-
| eflag.enableEndErpFrame||LONG||0||'''e:'''||✗
|-
| camendint||LONG||0||'''e:'''||✗
|-
| evfrm||LONG||0||'''e:'''||✗
|-
| evpriority||LONG||1||'''e:'''||✗
|}

==Camera ID Names==
The ''id'' field of a camera parameter entry is a special ID name that specifies the camera's usage context. Every entry should have a unique ID name. The camera ID is categorized into five different categories which are described below.

===Cube===
Cube cameras are cameras which are referenced from a camera area (''CameraArea'' in Super Mario Galaxy 2, ''CubeCamera'', ''CubeCameraBox'' etc in Super Mario Galaxy). When the player is inside a camera area, it activate the referenced camera. If multiple camera areas interesect, the area with the highest priority (''Obj_arg2'') will be selected. The camera area's ''Obj_arg0'' value specifies the ID number of the camera to be used. Using this value, the game generates an identifier string using the [https://en.wikipedia.org/wiki/Printf_format_string printf format string] '''c:%04x'''. For example, if your camera area has an ''Obj_arg0'' of 15, the corresponding camera ID name would be ''c:000f''. Note that the hexadecimal digits must be lowercase.

===Start===
Start cameras are used when a camera is referenced from a start point. Every player spawn point (''Mario'' entries in a zone's ''StartInfo'') can activate a camera once the player respawns there. Just like camera areas, the game constructs an identifier string from the spawn point's ''CameraSetId'' which will be used to locate the parameters for the camera. The [https://en.wikipedia.org/wiki/Printf_format_string printf format string] is '''s:%04x'''. For example, if your ''Mario'' entry has a ''CameraSetId'' of 60, the corresponding camera ID name would be ''s:003c''. The hexadecimal digits must be lowercase. If the ''CameraSetId'' is negative, no camera will be used.

===Event===
Event cameras are cameras which are used for different events. One example of an event camera is Mario's intro flying, which is shown when entering all galaxies. Event cameras have the format "e:S:XXX:YYY" where S is the event name, XXX is the camera set ID in lowercase hex and YY is the event index, also in lowercase hex. Most event consists of multiple cameras, which is what YY is used for. For example, the camera for the second Mario's intro flying, with the camera set ID 5 would be "e:シナリオスターター:005:01番目". The following table shows known event cameras:

{| class="wikitable"
|-
! ID !! Description
|-
| e:シナリオスターター:XXX:YY番目 || Scenario start camera YY.
|-
| e:スーパースピンドライバー:XXX:YY番目 || Super spin driver camera YY. Camera 00 is used when Mario enters the launch star, and 01 and up are used for when Mario is flying.
|-
| e:スーパースピンドライバー固有出現イベント用XXX || Super spin driver appearance event camera for camera set ID XXX.
|}

===Group===
Group cameras have unknown usage, but has the format "g:S" where S is the group name.

===Other===
Other cameras are used for various cameras which does not belong to any of the previously described categories. The ID follows the format "o:S" where S is the name. The following table shows known other cameras:

{| class="wikitable"
|-
! ID !! Description
|-
| o:デフォルトカメラ || Default camera to be used if no other camera is active or available.
|-
| o:デフォルト水中カメラ || Default camera to be used when the player is swimming underwater.
|-
| o:デフォルト水面カメラ || Default camera to be used when the player is swimming on water surface.
|-
| o:デフォルトフーファイターカメラ || Camera to be used when the player is using the Flying Power-Up.
|-
| o:ズームカメラ || The first person's view camera.
|}

==Camera Classes==
There are ''many'' fine-tuned camera classes to choose from. The ''camtype'' field of a camera entry specifies what class to use. The available classes in the ''Galaxy'' games are:

{| class="wikitable"
|-
! Identifier !! Japanese Name !! Class Name !! Used in SMG1? !! Used in SMG2? !! Description !! Parameters
|-
| CAM_TYPE_XZ_PARA||並行||CameraParallel||✓||✓|| This camera moves parallel to Mario's position using fixed angles and distance.
||
* '''dist''': Distance from Mario's position.
* '''angleB''': Horizontal angle in radians.
* '''angleA''': Vertical angle in radians.
* '''num1''': Enables resetting and rounding if non-zero.
|-
| CAM_TYPE_WONDER_PLANET||プラネット||CameraWonderPlanet||✓||✓||
||
* angleA
* axis.X
* axis.Y
|-
| CAM_TYPE_TOWER||塔||CameraTower||✓||✓|| This camera is focused at a set coordinate and rotates around this point based on Mario's position.
||
* '''dist''': Distance from fixpoint position.
* '''angleA''': Vertical angle in radians.
* '''angleB''': Size of the radius area at which the camera stops rotating. The higher the more restricted.
* '''wpoint''': Fixed point coordinate
* '''axis''':Which Axis to use for rotating
|-
| CAM_TYPE_TOWER_POS||塔（サブターゲット付き）||CameraTowerPos||✓||✓||
||
* angleB
* angleA
* up.X
* up.Y
* wpoint
* axis
|-
| CAM_TYPE_INWARD_TOWER||塔内部||CameraInwardTower||✓||✗||
||
* axis
* angleB
* angleA
* dist
* wpoint
|-
| CAM_TYPE_INWARD_SPHERE||球内部||CameraInwardSphere||✓||✗||
||
* angleA
* angleB
* dist
|-
| CAM_TYPE_POINT_FIX||完全固定||CameraFix||✓||✓||
||
* dist
* axis.X
* axis.Y
* wpoint
* up
|-
| CAM_TYPE_EYEPOS_FIX||定点||CameraFixedPoint||✓||✓|| Fixed camera which looks at Mario.
||
* '''wpoint''': Position of the camera.
* num1
* '''roll''': Z rotation in radians.
|-
| CAM_TYPE_EYEPOS_FIX_THERE||その場定点||CameraFixedThere||✓||✓|| Stops the camera in the position of the last camera used and focuses on Mario. Mostly used for the landing sequence of flying stars.
||
* num2
* num1
|-
| CAM_TYPE_TRUNDLE||トランドル||CameraTrundle||✓||✓||
||
* up.X
* angleA
* angleB
* dist
* wpoint
* axis
|-
| CAM_TYPE_SPHERE_TRUNDLE||球トランドル||CameraSphereTrundle||n/a||✓||
|| ?
|-
| CAM_TYPE_INNER_CYLINDER||円筒内部||CameraInnerCylinder||✓||✗||
||
* axis
* angleA
* angleB
* dist
* up.X
* wpoint
|-
| CAM_TYPE_CUBE_PLANET||キューブ惑星||CameraCubePlanet||✓||✓|| Variant of camera type follow in which the camera rotates along based on Mario's current gravitational frame.
||
* dist
* angleA
* angleB
|-
| CAM_TYPE_CHARMED_FIX||サンボ||CameraCharmedFix||✓||✓||
||
* up
* axis
* wpoint
|-
| CAM_TYPE_CHARMED_VECREG||ベクトルレジスタ注目||CameraCharmedVecReg||✓||✓||
||
* angleA
* angleB
* axis
* dist
* string
|-
| CAM_TYPE_CHARMED_VECREG_TOWER||VecReg角度補正塔カメラ||CameraCharmedVecRegTower||✓||✓||
||
* axis
* dist
* angleA
* angleB
* string
* wpoint
* num1
|-
| CAM_TYPE_MEDIAN_PLANET||中点注目プラネット||CameraMedianPlanet||✓||✓||
||
* wpoint.X
* dist
* angleB
* angleA
* axis
* string
|-
| CAM_TYPE_MEDIAN_TOWER||中点塔カメラ||CameraMedianTower||✓||✓||
||
* string
* up
* angleA
* wpoint
* axis
|-
| CAM_TYPE_FOLLOW||フォロー||CameraFollow||✓||✓||
||
* axis.X
* axis.Y
* angleA
* angleB
* dist
* num1
|-
| CAM_TYPE_RACE_FOLLOW||レース用フォロー||CameraRaceFollow||✓||✓||
||
* angleA
* wpoint
* num1
|-
| CAM_TYPE_WATER_FOLLOW||水中フォロー||CameraWaterFollow||✓||✓||
||
* dist
* axis.Y
* axis.Y
|-
| CAM_TYPE_WATER_PLANET||水中プラネット||CameraWaterPlanet||✓||✓||
||
* angleA
* axis.X
* axis.Y
|-
| CAM_TYPE_WATER_PLANET_BOSS||水中プラネットボス||CameraWaterPlanetBoss||✓||✗||
||
* up
* num1
* wpoint
* axis
* dist
|-
| CAM_TYPE_TRIPOD_PLANET||三脚惑星||CameraTripodPlanet||✓||✓||
||
* up
* dist
* wpoint
* axis
|-
| CAM_TYPE_TRIPOD_BOSS||三脚ボス||CameraTripodBoss||✗||n/a||
||
* up
* dist
* axis
* wpoint
|-
| CAM_TYPE_TRIPOD_BOSS_JOINT||三脚ボスジョイント||CameraTripodBossJoint||✓||n/a||
||
* num1
* dist
* angleA
* angleB
* axis
|-
| CAM_TYPE_CHARMED_TRIPOD_BOSS||三脚ボスジョイント注視||CameraCharmedTripodBoss||✓||n/a||
||
* up
* axis.X
* axis.Y
* num1
* wpoint
|-
| CAM_TYPE_FOO_FIGHTER||フーファイター||CameraFooFighter||✓||✗||
||
* dist
* axis.X
* axis.Y
|-
| CAM_TYPE_FOO_FIGHTER_PLANET||フーファイタープラネット||CameraFooFighterPlanet||✓||✗||
||
* dist
* axis.X
* axis.Y
|-
| CAM_TYPE_RAIL_WATCH||レール注目||CameraRailWatch||✓||✓||
||
* num1
* num2
* axis.X
* dist
* angleA
|-
| CAM_TYPE_RAIL_DEMO||レールデモ||CameraRailDemo||✗||✗||
||
* num1
* num2
* dist
|-
| CAM_TYPE_RAIL_FOLLOW||レールフォロー||CameraRailFollow||✓||✗||
||
* num1
* num2
* dist
* wpoint.X
* wpoint.Y
|-
| CAM_TYPE_OBJ_PARALLEL||オブジェ並行||CameraObjParallel||✓||✓||
||
* dist
* '''angleA''': Pitch in radians.
* angleB
|-
| CAM_TYPE_MTXREG_PARALLEL||マトリクスレジスタ並行||CameraMtxRegParallel||✓||✓||
||
* string
* angleA
* angleB
* dist
|-
| CAM_TYPE_SLIDER||スライダー||CameraBehind||✗||✗||
||
* angleA
* angleB
* dist
* axis.X
|-
| CAM_TYPE_2D_SLIDE||２Ｄスライド||CameraSlide||✓||✓||
||
* axis
* up
* dist
* angleA
* wpoint
|-
| CAM_TYPE_GROUND||地面||CameraGround||✓||✗||
||
* angleA
* angleB
* dist
* up
|-
| CAM_TYPE_SPIRAL_DEMO||螺旋デモ||CameraSpiral||✓||✓||
||
* num1
* num2
* axis
* wpoint
|-
| CAM_TYPE_TWISTED_PASSAGE||ねじれ回廊||CameraTwistedPassage||✓||✗||
||
* num1
* axis.X
* axis.Y
|-
| CAM_TYPE_FRONT_AND_BACK||表裏カメラ||CameraFrontAndBack||✓||✓||
||
* axis
* angleA
* angleB
* dist
* wpoint
|-
| CAM_TYPE_FREEZE||その場完全固定||CameraFreeze||n/a||✓|| Stops and freezes the camera completely based on the last camera position and rotation.
|| ?
|-
| CAM_TYPE_TALK||会話||CameraTalk||✗||✗||
||
* wpoint
* up
* axis.X
* axis.Y
|-
| CAM_TYPE_ANIM||アニメ||CameraAnim||✗||✗||
||
* num1
* dist
|-
| CAM_TYPE_DEAD||通常死亡||CameraDead||✗||✗||
||
* num1
* num2
* dist
|-
| CAM_TYPE_BLACK_HOLE||ブラックホール||CameraBlackHole||✗||✗||
||
* axis
* wpoint
|-
| CAM_TYPE_DPD||ＤＰＤ||CameraDPD||✗||✗||
||
* num2
* up.X
* wpoint
* angleA
* angleB
* dist
* num1
|-
| CAM_TYPE_SUBJECTIVE||主観||CameraSubjective||✗||✗|| ||n/a
|}

===Aliases===
Likely for the purpose of preserving compatibility with test camera files, the developers added aliases for some camera classes. These exist in both ''Galaxy'' games. However, these aliases only apply if the camera version is greater or equal to the required version. Interestingly, it also contains an alias for ''CAM_TYPE_BOSS_DONKETSU'', a camera class that has been removed from the actual game.

{| class="wikitable"
|-
! Alias Name !! Actual Name !! Required Version
|-
| CAM_TYPE_DONKETSU_TEST || CAM_TYPE_BOSS_DONKETSU || 196612
|-
| CAM_TYPE_BEHIND_DEBUG || CAM_TYPE_SLIDER || 196614
|-
| CAM_TYPE_INWARD_TOWER_TEST || CAM_TYPE_INWARD_TOWER || 196614
|-
| CAM_TYPE_EYE_FIXED_THERE_TEST || CAM_TYPE_EYEPOS_FIX_THERE || 196614
|-
| CAM_TYPE_ICECUBE_PLANET || CAM_TYPE_CUBE_PLANET || 196617
|}

==Common Properties==
{| class="wikitable"
|-
! Property !! Description
|-
! colspan="2" | General
|-
| version || Camera engine version. Usually 196630 in ''Super Mario Galaxy 1'' and 196631 in ''Super Mario Galaxy 2''.
|-
| camtype || Class identifier name. See the tables above for possible values.
|-
| id || The camera's identifier name. See the [[#Camera ID Names|respective section]] for more details.
|-
| woffset.X woffset.Y woffset.Z ||A constant offset from the target relative to the Zone the camera belongs to.
|-
| loffset ||An offset from the target's forward vector. Higher values move the camera further in front of the target and lower values move it behind the target.
|-
| loffsetv ||An offset from the target's upward vector. Higher values move the camera further above the target and lower values move it below the target.
|-
| roll ||Rotates the camera. 180 will flip the camera upside down
|-
| fovy || The [https://en.wikipedia.org/wiki/Field_of_view field of view] angle in degrees. Huge numbers cause visual issues, so it's best to keep this between 0 and 179.9
|-
| camint || The amount of time in frames it takes for the camera to get into it's active position
|-
| upper || Upper screen bound relative to the center of the screen
|-
| lower || Lower screen bound relative to the cetner of the screen
|-
| gndint ||
|-
| uplay || How high in the world the target needs to go before the camera physically starts moving upwards
|-
| lplay || How low in the world the target needs to go before the camera physically starts moving downwards
|-
| pushdelay || The activation time in frames for when the Upper bound activates
|-
| pushdelaylow || The activation time in frames for when the Lower bound activates
|-
| udown ||
|-
| vpanuse || Enables the use of the Camera Height Arrangement
|-
| vpanaxis.X vpanaxis.Y vpanaxis.Z ||
|-
| flag.noreset ||
|-
| flag.nofovy || If enabled, the FoV can be changed
|-
| flag.lofserpoff || If enabled, the loffset and loffsetv will not interpolate into position and snap to where it needs to be.
|-
| flag.antibluroff || If enabled, rotating the camera will be not be smooth
|-
| flag.collisionoff || Disables collision with map geometry if enabled. This means that the camera will move through collision if necessary.
|-
| flag.subjectiveoff || Disables the first-person camera if enabled.
|-
! colspan="2" | ''Game''
|-
| gflag.thru ||
|-
| gflag.enableEndErpFrame || If enabled, a "Camera deactivation time" (gflag.camendint) will be enabled, and deactivating this camera will have this time be used instead of the new camera's time
|-
| gflag.camendint || Determines the time in frames that this camera will need to deactivate
|-
! colspan="2" | ''Event''
|-
| eflag.enableErpFrame ||
|-
| eflag.enableEndErpFrame ||
|-
| camendint ||
|-
| evfrm || The time in frames that this event camera is active for
|-
| evpriority || Always 1.
|}

==Trivia==
* The oldest available camera version is 196617 and can be found in ''HellLavaFloatingZone''.
* The function ''CameraParamChunk::load'' references a removed camera class labeled as ''CAM_TYPE_PLANET''.
* Intro cameras dynamically create a ''CAM_TYPE_ANIM'' camera with the ID ''o:スタートアニメカメラ''. It is not possible to overwrite this in a BCAM file.