Model Data [Hack64 Wiki]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
======== Model Data ========

Banjo-Kazooie uses a file-system in which most resources are packed into file blocks throughout the ROM, and are unpacked into RAM when needed. Among these are the model files, each with their own syntax and load-lines. This page's purpose is to cover the syntax and properties of said model files.

===== Header =====

^ Address ^ Value/Syntax ^ Description ^
| 0x00000000 | [00 00 00 0B] | START |
| 0x00000004 | [<color #ed1c24>aa aa aa aa</color>] | Geometry Layout Offset |
| 0x00000008 | [<color #22b14c>bb bb</color> <color #00a2e8>cc cc</color>] | <color #22b14c>bb</color>=Texture Setup Offset (Usually 00 38), <color #00a2e8>cc</color>=Geo Type* |
| 0x0000000C | [<color #ed1c24>dd dd dd dd</color>] | Display List Setup Offset |
| 0x00000010 | [<color #22b14c>ee ee ee ee</color>] | Vertex Store Setup Offset |
| 0x00000014 | [00 00 00 00] | ? - Pertains to hitboxes |
| 0x00000018 | [<color #00a2e8>ff ff ff ff</color>] | Animation Setup |
| 0x0000001C | [<color #ed1c24>gg gg gg gg</color>] | Collision Setup |
| 0x00000020 | [<color #22b14c>hh hh hh hh</color>] | Effects Setup End Address |
| 0x00000024 | [<color #22b14c>hh hh hh hh</color>] | Effects Setup |
| 0x00000028 | [00 00 00 00] | ? |
| 0x0000002C | [<color #ed1c24>jj jj jj jj</color>] | Animated Textures Offset |
| 0x00000030 | [<color #22b14c>kk kk</color> <color #00a2e8>ll ll</color>] | <color #22b14c>kk</color>= Tri count, <color #00a2e8>ll</color>= vert count |
| 0x00000034 | [00 00 00 00] | ? |
''*Geo Types: 0000=normal, 0002= Trilinear MipMapping (RGBA16), 0004=Env mapping, 0006=Trilinear MipMapping (RGBA16) + Environment Mapping''

If a setup offset = 00 00 00 00, there is no data for that type.

----

===== Texture Setup =====
The Texture Setup begins with a Header of Size 0x08:
^ Offset within TexSetup ^ Value/Syntax ^ Description ^
| 0x00000000 | [<color #ff7f27>aa aa aa aa</color>] | Size of DataSection in Bytes |
| 0x00000004 | [<color #22b14c>cc cc</color>] 00 00 | Texture Count |

Afterwards, an array of Meta-Information Elements follows (Tex MetaSection), where Texture parameters are stored.\\
Each Meta Element is 0x10 Bytes large, and structured like this:

''[<color #A946F2>dd dd dd dd</color>] [<color #b5e61d>ee ee</color>] 00 00 [<color #00a2e8>ww</color>] [<color #ed1c24>hh</color>] 00 00 00 00 00 00''

^ Value/Syntax ^ Description ^
| [<color #A946F2>dd dd dd dd</color>] | Offset of TexData from Tex DataSection Start |
| [<color #b5e61d>ee ee</color>] | Type* of corresponding TexData |
| [<color #00a2e8>ww</color>] [<color #ed1c24>hh</color>] | <color #00a2e8>Width</color> and <color #ed1c24>Height</color> of TexData |

* the types used in BK are the following:
^ Value ^ TexType ^ Palette ^ Bits / Pixel ^ Color-Format ^
| 0x01 | CI4    | 0x20  | 4  | RGBA5551 |
| 0x02 | CI8    | 0x200 | 8  | RGBA5551 |
| 0x04 | RGBA16 | -     | 16 | RGBA5551 |
| 0x08 | RGBA32 | -     | 32 | RGBA8888 |
| 0x10 | IA8    | -     | 8  | I4A4     |

External texture indices start at FileID 0x1EF6, 0 indexed.

<code>

Example: 00 00 06 00 00 01 00 00 40 40 00 00 00 00 00 00

This sets up a 64x64 CI4 Texture from 0x600 Bytes after the DataSection starts.</code>

And finally, a List of the actual Data Elements follows (Tex DataSection).\\
Note that there might be additional Data Elements inbetween, if the Texture is mipmapped or animated.
----

===== Display List Setup =====
^ Offset from DLSetup Start ^ Value/Syntax ^ Description ^
| 0x00000000 | [<color #ed1c24>aa aa aa aa</color> 00 00 00 00] | F3DEX Command Count |
| 0x00000008 | [[http://hack64.net/wiki/doku.php?id=f3dex|F3DEX]] | F3DEX Display List |

----

===== Vertex Store Setup =====
^ Offset from VTXSetup Start ^ Value/Syntax ^ Description ^
| 0x00000000 | [<color #ed1c24>aa aa</color> <color #22b14c>bb bb</color> <color #00a2e8>cc cc</color>] | s16[3] Minimum Coords |
| 0x00000006 | [<color #ed1c24>dd dd</color> <color #22b14c>ee ee</color> <color #00a2e8>ff ff</color>] | s16[3] Maximum Coords |
| 0x0000000C | [<color #ed1c24>gg gg</color> <color #22b14c>hh hh</color> <color #00a2e8>ii ii</color>] | s16[3] Center Coords |
| 0x00000012 | [<color #22b14c>kk kk</color>] | s16 Largest Distance to Center |
| 0x00000014 | [<color #00a2e8>ll ll</color>] | u16 Vertex Count*2 |
| 0x00000016 | [<color #00a2e8>mm mm</color>] | s16 Largest Distance to Origin |

Each 16 byte line of the Vertex Setup following the Start denotes where a vertex is stored in 3D space, from where in 2D space its UVs begin being mapped, and which color and opacity alpha values will be applied to these vertices. Pulled from [[https://hack64.net/wiki/doku.php?id=rcpstructs#rsp_geometry_mode:~:text=Edit-,Vertex%20Structure,-Vertices%20are%20points|RCP Structures]] for context.

It is stored like this: 
''[<color #A946F2>xx xx</color> <color #00a2e8>yy yy</color> <color #f50569>zz zz</color> 00 00 <color #d1b219>uu uu</color> <color #ff5703>vv vv</color> <color #ed1c24>rr</color> <color #22b14c>gg</color> <color #3644f7>bb</color> <color #8f8f8f>aa</color>]''

^ Vertex Structure After Start ^ Value/Syntax ^ Description ^
| 0x00000000 | [<color #A946F2>xx xx</color>] | *s16 Vertex Position on X Axis |
| 0x00000002 | [<color #00a2e8>yy yy</color>] | s16 Vertex Position on Y Axis |
| 0x00000004 | [<color #f50569>zz zz</color>] | s16 Vertex Position on Z Axis |
| 0x00000006 | 00 00 | Padding(?) |
| 0x00000008 | [<color #d1b219>uu uu</color>] | s16 UV Coordinates: U Axis|
| 0x0000000A | [<color #ff5703>vv vv</color>] | s16  UV Coordinates: V Axis|
| 0x0000000C | [<color #ed1c24>rr</color>] | u8 Vertex Color Red Values |
| 0x0000000D | [<color #22b14c>gg</color>] | u8 Vertex Color Green Values |
| 0x0000000E | [<color #3644f7>bb</color>] | u8 Vertex Color Blue Values |
| 0x0000000F | [<color #8f8f8f>aa</color>] | u8 Vertex Color Alpha Values |

*Please note that ''s16'' refers to 'signed short'; a value which may be positive or negative and takes 16 bits of space. Positive signed values range from 0x0000 to 0x7FFF, negative signed values range from 0xFFFF to 0x8000. Whereas ''u8'' refers to an 'unsigned byte' value that may only be a positive integer from 0x00 to 0xFF.

<code>Example: 0014 0062 FFE7 0000 FFE0 0014 9292 92FF</code>

A vertex will be drawn at position (20, 98, -25). UV mapping will begin at -20 coordinates in the U axis and 20 coordinates in the V axis. This vertex will feature a color of #929292 with full opacity alpha of 0xFF or 255.

----
===== Animation Setup ======
The animation setup rigs bones to a model and anchors them to the origin, or the parent bone (0xFFFF). It is comprised of two sections: A header, and a bone setup.

**Animation Header**
^ Offset from Animation Setup ^ Value Syntax ^ Description ^
| 0x0000 | [<color #22b14c>aa aa aa aa</color>] | Scaling Factor (float) |
| 0x0004 | [<color #00a2e8>bb bb</color>] | Bone Count |
| 0x0006 | [00 00] | Padding / Unk |

**Example (74a8.bin, Slappa at address 0x2ca8):**

''<color #22b14c>42 34 00 00</color> <color #00a2e8>00 19</color> 00 00''

Sets the scaling factor as 45 (<color #22b14c>0x42340000</color>) and sets the bone count as 25 (<color #00a2e8>0x19</color>).

**Bone Setup**
^ Offset following Animation Header ^ Value Syntax ^ Description ^
| 0x0000 | [<color #A946F2>xx xx xx xx</color>] | X Position of Bone (float) |
| 0x0004 | [<color #00a2e8>yy yy yy yy</color>] | Y Position of Bone (float) |
| 0x0008 | [<color #f50569>zz zz zz zz</color>] | Z Position of Bone (float) |
| 0x000C | [<color #d1b219>ii ii</color>] | Internal Bone ID |
| 0x000E | [<color #ff5703>pp pp</color>] | Parent Bone ID |

**Example (74a8.bin, Slappa at address 0x2cb0):**

''<color #A946F2>BF 8E 23 70</color> <color #00a2e8>C3 2D 44 F0</color> <color #f50569>40 FC 92 09</color> <color #d1b219>00 05</color> <color #ff5703>FF FF</color>''

Assigns a bone to the model at coordinates (<color #A946F2>-1.11</color>, <color #00a2e8>-173.27</color>, <color #f50569>7.89</color>), gives it an Internal Bone ID of 5 (<color #d1b219>0x5</color>) and connects that bone to Parent Bone -1 (<color #ff5703>0xFFFF</color>). This case just so happens to be the origin.

----
===== Collision Setup =====
The Collision Setup begins with a Header of Size 0x18:
^ Offset within CollSetup ^ Value/Syntax ^ Description ^
| 0x00000000 | [''<color #A946F2>xx xx</color> <color #00a2e8>yy yy</color> <color #f50569>zz zz</color>''] | s16[3] Minimum GeoCube Index |
| 0x00000006 | [''<color #A946F2>xx xx</color> <color #00a2e8>yy yy</color> <color #f50569>zz zz</color>''] | s16[3] Maximum GeoCube Index |
| 0x0000000C | [''<color #d1b219>vv vv</color>''] | u16 Y Stride - GeoCubes per X-Row |
| 0x0000000E | [''<color #ff5703>ww ww</color>''] | u16 Z Stride - GeoCubes per XY-Layer |
| 0x00000010 | [''<color #00a2e8>cc cc</color>''] | u16 Total amount of GeoCubes |
| 0x00000012 | [''<color #22b14c>ss ss</color>''] | u16 GeoCube Scale |
| 0x00000014 | [''<color #ed1c24>tt tt</color>''] | u16 Total amount of Collision Tris |
| 0x00000016 | [''00 00''] | Padding |

The entire map is split up into 3D GeoCubes that all share the same scale ''0x<color #22b14c>SSSS</color>^3''. They are set up in a 3D matrix, such that the GeoCube (0,0,0) is stretching from the coordinates (0,0,0) to (0x<color #22b14c>SSSS</color>, 0x<color #22b14c>SSSS</color>, 0x<color #22b14c>SSSS</color>). In Memory, the GeoCubes are stored as a 1D array, where the Y and Z strides are used for the pointer arithmetic of referencing the correct cube:

<code>
   cube_arr[cube_x][cube_y][cube_z]
== cube_arr[cube_x + (cube_y * stride_y) + (cube_z * stride_z)]
== cube_arr[cube_ID]
</code>
Following the Header, we have a list of 0x<color #00a2e8>CCCC</color> GeoCube instances of Size 0x08, looking like this: 

^ Value/Syntax ^ Description ^
| [''<color #A946F2>aa aa</color>''] | u16 Starting Tri ID |
| [''<color #b5e61d>cc cc</color>''] | u16 Tri Count |

These are referring to a Subset ''[start : (start + count))'' of Collision Tris from the then following Collision Tri list. This list contains 0x<color #ed1c24>TTTT</color> Collision Triangles, of Size 0x0C, which are structured like this in BK:

^ Value/Syntax ^ Description ^
| [''<color #A946F2>aa aa</color>''] | u16 Vertex ID 1 |
| [''<color #00a2e8>bb bb</color>''] | u16 Vertex ID 2 |
| [''<color #f50569>cc cc</color>''] | u16 Vertex ID 3 |
| [''<color #808080>uu uu</color>''] | <color #808080>unknown</color> |
| [''<color #b5e61d>ii ii ii ii</color>''] | u32 Sound + Collision Flags |

Where every Triangle is defined by the 3 indices as 1-2-3, which is important to determine its front facing direction.

----
===== Effects Setup =====

The Effects Setup for Level and Actor bins functions very similar to the [[https://hack64.net/wiki/doku.php?id=banjo_tooie:model_data#:~:text=Edit-,Effects%20Setup,-Offset%20from%20Setup|Effects Setup used in Banjo-Tooie]] only with fewer effects to use. Effects types only go up to 10 types with several unknowns. Level models can have texture scroll, though actors and objects do not appear to have the same luxury. Some actors like Teehee & Twinklies have "specially assigned" effects. There may be more at play that determines how effects are activated.

^ Offset from Effects Setup ^ Value/Syntax ^ Description ^
| 0x00 | [<color #ed1c24>aa aa</color>] | Effect Count|
| 0x02 | [<color #22b14c>bb bb</color>] | Data Start + Param |
| 0x04 | [<color #00a2e8>cc cc</color>] | Vertex Count |
| 0x06 | [<color orange>dd dd</color>] | Vertex Referenced from Vtx Store following Start|

Effect IDs are <code>Data Start = 100*Type + Param  (decimal)</code> where param is used to 
control the speed or amplitude of the effect. For Data Start in the table, param used is 0 and can range from 0-63. Type is taken from
^Type^Data Start^Description^
| 0 | 0x000 | ?? - Used in the Sandcastle and Furnace Fun |
| 1 | 0x064 | Texture scrolling (along vertical axis). Param dictates speed [6A - Slow, 78 - Medium, A0 - Fast]| 
| 2 | 0x0C8 | Flickering vertex color, for fake lighting around flames |
| 3 | 0x12C | Oscillating texture scrolling + vertical bob. Param affects bob height. |
| 4 | 0x190 | Seems to trigger geometry to move (possibilities include squash, move). Additional param will crash game. |
| 5 | 0x1F4 | Vertex color regularly gets brighter and dimmer. Param dictates speed of glow. |
| 6 | 0x258 | ?? - Used in Furnace Fun |
| 7 | 0x2BC | Rippling wave generation, amplitude controlled by bounding box of affected vertices, speed of wave dictated by param. |
| 8 | 0x320 | Vertex alpha regularly gets brighter and dimmer. Param dictates speed of glow. |
| 9 | 0x384 | Adds lightning sound effect, no visible change. Param does not seem to affect sound speed. Could be alpha related. |


**Example (10238.bin, GV Model A):**

''<color #ed1c24>0003</color> <color #22b14c>0078</color> <color #00a2e8>006A</color> <color orange>0010 0011 0012 0013 0014 [...] 0605</color> <color #22b14c>00AA</color> <color #00a2e8>0015</color> <color orange>06AC [...] 06C0</color> <color #22b14c>0190</color> <color #00a2e8>0007</color> <color orange>0182 [...] 018A</color> 0000 0000 0000''

Loads 3 (<color #ed1c24>0x03</color>) effects: 
  * Medium scroll (<color #22b14c>0x78</color>) assigned to 106 (<color #00a2e8>0x6A</color>) vertices. Verts in the bin that scroll range from vertex lines 16 (<color orange>0x10</color>) to 122 (<color orange>0x605</color>).
  * Fast Scroll (<color #22b14c>0xAA</color>) assigned to 21 (<color #00a2e8>0x15</color>) vertices ranging from vertex lines 1708 (<color orange>0x6AC</color>) to 1729 (<color orange>0x6C0</color>).
  * Movement effect of Star Door (<color #22b14c>0x190</color>) across 7 vertices (<color #00a2e8>0x7</color>) ranging from vertices 386 (<color orange>0x182</color>) to 393 (<color orange>0x18A</color>). 
There is a 4 or 6 byte padding buffer at the end of most effects setups.
----

===== Animated Texture List ===
If the model's animated_textures_offset is non-zero, the animated texture list is an array of 4 of the following struct:
^ Offset ^ Value/Syntax ^ Type ^ Description ^
| 0x00 | [<color #ed1c24>aa aa</color>] | i16 | Frame size (bytes) : 0 if unused |
| 0x02 | [<color #22b14c>bb bb</color>] | i16 | Frame count |
| 0x04 | [<color #00a2e8>cc cc cc cc</color>] | f32 | Framerate (fps) |

Note that in order for textures to be animated, all texture data for each frame must be present in the texture section and stacked sequentially. Only the 1st texture in the data stack is displayed and animated, however it can animate through the texture data stack with 4 different framecounts/framerates. You can determine which textures are being animated by checking the [[https://hack64.net/wiki/doku.php?id=f3dex#:~:text=xx%5D%2000%2000%20%5B-,bb,-bb%20bb%20bb%5D|segmented value]] of the FD Set_T_Img display list command for that texture. For Banjo-Kazooie, the segmented value can be 
 ''0xF, 0xE, 0xD, or 0xC''.
----

===== GeoLayout Setup =====
This Setup consists of a List of [[https://hack64.net/wiki/doku.php?id=banjo_kazooie:geometry_layouts|GeoLayout Commands]]. There is no Header in this Setup.

The Reference-Point Command (''0x0A'') appears to be used to determine what Banjo should look at when solving a Jigsaw. The Reference-Point Index is set to ''0x1E'' in that case, and the Bone-Index is always ''0xFFFF'' (-1) connecting the Point to the origin. Therefor the XYZ Coordinates that are included in the Command represents the actual Position of the Reference-Point within the Map. If a second Jigsaw is in the same Room, it gets the Index ''0x1F'' instead, which is the case for the CC and RBB Jigsaws.
----
User Tools

Site Tools

Page Tools
