EPD Wiki - User contributions [en]

Bphsh

2026-02-20T12:02:51Z

Watertoon: /* Layer Hit Mask Array (Not Fully Confirmed) */

Bphsh is a "shape" file format. Responsible for storing the underlying physics engine's collision mesh data as well as relevant phive specific data. This page is focused on the version found in Nintendo Switch Online: Playtest Program (021), and Havok 2023.2.

== File Structure ==

# Header
# Havok Tag File
# Material Array
# Unknown Array

== Structures (phive) ==

=== Header ===
[[Common Phive|Common phive]] header for shape. The sections consist of the Havok tagfile containing an hknpMeshShape, an array of phive materials, and a currently unknown section.

=== Material Array ===
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Material Id. The PhiveConfig byaml stores an application's materials under MaterialCollection.
|-
|0x4
|0x4
|u32
|Sub Material. The PhiveConfig byaml stores an application's sub materials under SubMaterialCollection.
|-
|0x8
|0x8
|u64
|User Shape Tag Mask. Up to 64 tags can be present, each bit denotes whether a tag exists. The PhiveConfig byaml stores an application's tags under UserShapeTagCollection.
|}

=== Layer Hit Mask Array (Not Fully Confirmed) ===
In previous titles from NSO PT the layer hit masks were 32-bits each, making each element 0x8 bytes. A bphsh may have different counts for materials and layer hit masks. Phive clamps the size of the material array and layer hit mask array to the smaller of the two. HknpMeshShape shapeTags are presumably used to map Havok's geometry to Phive's material and layer hit masks.
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|u64
|Layer Hit Mask.The PhiveConfig byaml stores an application's layers under LayerEntityCollection for entity rigid bodies and LayerSensorCollection for sensor rigid bodies. Each bit in the mask corresponds to a layer in the order they are defined by PhiveConfig.
|-
|0x8
|0x8
|u64
|Sub Layer Hit Mask.The PhiveConfig byaml stores an application's sub layers under SubLayerEntityCollection for entity rigid bodies and SubLayerSensorCollection for sensor rigid bodies. Each bit in the mask corresponds to a layer in the order they are defined by PhiveConfig.
|}

== Structures (Havok Physics) ==

=== Common ===

==== hkEnum<T,B>, hkFlags<T,B> ====
Enum of type T, with underlying storage of type B.

==== hkRelPtr<T> ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|hkInt64
|m_offset; Offset relative to the base address of this object to the template type T.
|}

==== hkRelArrayView<T,B> ====
B is an integer type.
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|sizeof(B)
|B
|m_offset; Offset relative to the base address of this object to the array of template type T.
|-
|sizeof(B)
|sizeof(B)
|B
|m_size; Count of elements in the array
|}

==== hkRelArray<T> ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|hkInt64
|m_offset; Offset relative to the base address of this object to the array of template type T.
|-
|0x8
|0x4
|int
|m_size; Count of elements in the array
|-
|0xc
|0x4
|int
|m_capacityAndFlags; Max capacity of elements the array can store, also flags.
|}

=== hknpMeshShape ===
Stores a collision mesh geometry and acceleration structures.

Note; hkBaseObject has an alignment of 8, but hknpMeshShape promotes the alignment to 0x10 due to containing an hkVector4. Unmarked space is padding.
{| class="wikitable"
|+hkBaseObject
!Offset
!Size
!Type
!Description
|-
|0x0
|u64
|0x8
|_vft_reserve; Vtable pointer, resolved at runtime.
|}
{| class="wikitable"
|+hkReferencedObject : hkBaseObject
!Offset
!Size
!Type
!Description
|-
|0x8
|0x8
|hkUlong
|m_sizeAndFlags
|-
|0x10
|0x8
|hkUlong
|m_refCount
|}
{| class="wikitable"
|+hknpShape : hkReferencedObject
!Offset
!Size
!Type
!Description
|-
|0x18
|0x1
|hkEnum<hknpShapeType::Enum, hkUint8>
|m_type; Should always be "MESH" (0x8) for an hknpMeshShape.
|-
|0x19
|0x1
|hkEnum<hknpCollisionDispatchType::Enum, hkUint8>
|m_dispatchType
|-
|0x1a
|0x2
|hkFlags<hknpShape::FlagsEnum, hkUint16>
|m_flags
|-
|0x1c
|0x1
|hkUint8
|m_numShapeKeyBits
|-
|0x1d
|0x3
|
|
|-
|0x20
|0x4
|hkReal
|m_convexRadius
|-
|0x24
|0x4
|
|
|-
|0x28
|0x8
|hkUint64
|m_userData, this is set at runtime to a phive structure containing references to the material and unknown array.
|-
|0x30
|0x10
|hknpShapeProperties
|m_properties
|}
{| class="wikitable"
|+hknpCompositeShape : hknpShape
!Offset
!Size
!Type
!Description
|-
|0x40
|0x4
|hkUint32
|m_shapeTagCodecInfo
|-
|0x44
|0x4
|
|
|}
{| class="wikitable"
|+hknpMeshShape : hknpCompositeShape
!Offset
!Size
!Type
!Description
|-
|0x48
|0x8
|
|
|-
|0x50
|0x20
|hknpMeshShapeVertexConversionUtil
|m_vertexConversionUtil
|-
|0x70
|0x8
|hkRelArrayView<hknpMeshShape::ShapeTagTableEntry, int>
|m_shapeTagTable
|-
|0x78
|0x18
|hkcdSimdTreeNamespace::hkcdSimdTree<hkcdSimdTreeNamespace::RelArrayStorage<hkcdSimdTreeNamespace::Node>>
|m_topLevelTree
|-
|0x90
|0x8
|hkRelArrayView<hknpMeshShape::GeometrySection, int>
|m_geometrySections; Appears to be a convex decomposition, or at least partitioning, of the mesh shape.
|-
|0x98
|0x8
|hkRelPtr<hknpMeshShapePrimitiveMapping>
|m_primitiveMapping
|}

==== hknpShapeType::Enum ====
{| class="wikitable"
|+
!Name
!Value
!Description
|-
|CONVEX
|0x0
|
|-
|SPHERE
|0x1
|
|-
|CAPSULE
|0x2
|
|-
|CYLINDER
|0x3
|
|-
|TRIANGLE
|0x4
|
|-
|BOX
|0x5
|
|-
|COMPOSITE
|0x6
|
|-
|MESH
|0x7
|
|-
|EXTERN_MESH
|0x8
|
|-
|COMPOUND
|0x9
|
|-
|DISTANCE_FIELD_BASE
|0xa
|
|-
|HEIGHT_FIELD
|0xb
|
|-
|DISTANCE_FIELD
|0xc
|
|-
|PARTICLE_SYSTEM
|0xd
|
|-
|TRANSFORMED
|0xe
|
|-
|MASKED
|0xf
|
|-
|MASKED_COMPOUND
|0x10
|
|-
|BREAKABLE_COMPOUND
|0x11
|
|-
|LOD
|0x12
|
|-
|DUMMY
|0x13
|
|-
|LEGACY_COMPRESSED_MESH
|0x14
|
|-
|USER_0
|0x15
|
|-
|USER_1
|0x16
|
|-
|USER_2
|0x17
|
|-
|USER_3
|0x18
|
|-
|USER_4
|0x19
|
|-
|USER_5
|0x1b
|
|-
|USER_6
|0x1b
|
|-
|USER_7
|0x1c
|
|-
|NUM_SHAPE_TYPES
|0x1d
|
|-
|INVALID
|0x1e
|
|}

==== hknpCollisionDispatchType::Enum ====
{| class="wikitable"
|+
!Name
!Value
!Description
|-
|NONE
|0x0
|
|-
|CONVEX
|0x1
|
|-
|COMPOSITE
|0x2
|
|-
|DISTANCE_FIELD
|0x3
|
|-
|USER_0
|0x4
|
|-
|USER_1
|0x5
|
|-
|USER_2
|0x6
|
|-
|USER_3
|0x7
|
|-
|USER_4
|0x8
|
|-
|USER_5
|0x9
|
|-
|USER_6
|0xa
|
|-
|USER_7
|0xb
|
|-
|NUM_TYPES
|0xc
|
|}

==== hknpShape::FlagsEnum ====
{| class="wikitable"
|+
!Name
!Value
!Description
|-
|IS_CONVEX_SHAPE
|0x1
|
|-
|IS_CONVEX_POLYTOPE_SHAPE
|0x2
|
|-
|IS_COMPOSITE_SHAPE
|0x4
|
|-
|IS_HEIGHT_FIELD_SHAPE
|0x8
|
|-
|USE_SINGLE_POINT_MANIFOLD
|0x10
|
|-
|IS_INTERIOR_TRIANGLE
|0x20
|
|-
|SUPPORTS_COLLISIONS_WITH_INTERIOR_TRIANGLES
|0x40
|
|-
|USE_NORMAL_TO_FIND_SUPPORT_PLANE
|0x80
|
|-
|IS_TRIANGLE_OR_QUAD_SHAPE
|0x100
|
|-
|IS_QUAD_SHAPE
|0x200
|
|-
|IS_SDF_EDGE_COLLISION_ENABLED
|0x400
|
|-
|HAS_SURFACE_VELOCITY
|0x800
|
|-
|USER_FLAG_0
|0x1000
|
|-
|USER_FLAG_1
|0x2000
|
|-
|USER_FLAG_2
|0x4000
|
|}

==== hknpShapeProperties ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x10
|hkRelArray<hknpShapeProperties::Entry>
|Optional shape properties.
|}

===== hknpShapeProperties::Entry =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|hkRelPtr<hknpShapePropertyBase>
|Pointer to shape property. If present, likely a derived class such as hknpShapeConnectivityGraph, hknpRefDragProperties, hknpShapeMassProperties, hknpShapeMassPropertiesTree, hknpShapeMassConfigProperty, or hknpMaterialPalette.
|}

====== hknpShapePropertyBase ======
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x2
|hkUint16
|m_propertyKey; Appears to be a derived class unique identifier.
|}

==== hknpMeshShapeVertexConversionUtil ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x10
|hkVector4
|m_bitScale16; Appears to be vertex compression parameters.
|-
|0x10
|0x10
|hkVector4
|m_bitScale16Inv
|}

==== hknpMeshShape::ShapeTagTableEntry ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|hkUint32
|m_meshPrimitiveKey
|-
|0x4
|0x2
|hkUint16
|m_shapeTag
|-
|0x6
|0x2
|
|
|}

==== hkcdSimdTreeNamespace::hkcdSimdTree<hkcdSimdTreeNamespace::RelArrayStorage<hkcdSimdTreeNamespace::Node>> ====
{| class="wikitable"
|+hkcdSimdTreeNamespace::RelArrayStorage<hkcdSimdTreeNamespace::Node>
!Offset
!Size
!Type
!Description
|-
|0x0
|0x10
|hkRelArray<hkcdSimdTreeNamespace::Node>
|m_nodes
|}
{| class="wikitable"
|+hkcdSimdTreeNamespace::hkcdSimdTree : hkcdSimdTreeNamespace::RelArrayStorage<hkcdSimdTreeNamespace::Node>
!Offset
!Size
!Type
!Description
|-
|0x10
|0x4
|hkUint32
|m_firstFreeIndex
|-
|0x14
|0x1
|bool
|m_isCompact
|-
|0x15
|0x3
|
|
|}

===== hkcdSimdTreeNamespace::Node =====
{| class="wikitable"
|+hkcdFourAabb
!Offset
!Size
!Type
!Description
|-
|0x0
|0x10
|hkVector4
|m_lx
|-
|0x10
|0x10
|hkVector4
|m_hx
|-
|0x20
|0x10
|hkVector4
|m_ly
|-
|0x30
|0x10
|hkVector4
|m_hy
|-
|0x40
|0x10
|hkVector4
|m_lz
|-
|0x50
|0x10
|hkVector4
|m_hz
|}
{| class="wikitable"
|+hkcdSimdTreeNamespace::Node : hkcdFourAabb
!Offset
!Size
!Type
!Description
|-
|0x60
|0x10
|hkUint32[4]
|m_data
|-
|0x70
|0x4
|hkUint8[4]
|m_filterMasks
|-
|0x74
|0x1
|hkFlags<hkcdSimdTreeNamespace::Node::FlagsEnum, unsigned char>
|m_flags
|-
|0x75
|0x1
|hkUint8
|m_maxDepth
|-
|0x76
|0x1
|hkUint8
|m_splittingAxisCache
|-
|0x77
|0x1
|hkUint8
|m_numAddRemoveOperationsSinceLastRebalance
|-
|0x78
|0x4
|hkUint32
|m_parent
|-
|0x7c
|0x4
|hkUint32
|m_numLeaves
|}

===== hkcdSimdTreeNamespace::Node::FlagsEnum =====
{| class="wikitable"
|+
!Name
!Value
!Description
|-
|NODE_IS_LEAF
|0x1
|
|-
|NODE_IS_FREE
|0x2
|
|-
|INCREMENTAL_OPTIMIZER_NODES_ARE_REBALANCED
|0x4
|
|-
|INCREMENTAL_OPTIMIZER_REINSERT_PASS_DID_NOP
|0x8
|
|-
|INCREMENTAL_OPTIMIZER_LEAVES_ARE_REBALANCED
|0x10
|
|-
|USER_FLAG_0
|0x20
|
|-
|USER_FLAG_1
|0x40
|
|-
|USER_FLAG_2
|0x80
|
|}

==== hknpMeshShape::GeometrySection ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|hkRelArrayView<hknpAabb8TreeNode, int>
|m_sectionBvh
|-
|0x8
|0x8
|hkRelArrayView<hknpMeshShape::GeometrySection::Primitive, int>
|m_primitives
|-
|0x10
|0x8
|hkRelArrayView<hkUint8, int>
|m_vertexBuffer
|-
|0x18
|0x8
|hkRelArrayView<hkUint8, int>
|m_interiorPrimitiveBitField
|-
|0x20
|0xc
|hkUint32[3]
|m_sectionOffset
|-
|0x2c
|0xc
|hkFloat3
|m_bitScale8Inv
|-
|0x38
|0x6
|hkInt16[3]
|m_bitOffset
|-
|0x3e
|0x2
|
|
|}

===== hknpAabb8TreeNode =====
{| class="wikitable"
|+hknpTransposedFourAabbs8
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|hkUint32
|m_lx
|-
|0x4
|0x4
|hkUint32
|m_hx
|-
|0x8
|0x4
|hkUint32
|m_ly
|-
|0xc
|0x4
|hkUint32
|m_hy
|-
|0x10
|0x4
|hkUint32
|m_lz
|-
|0x14
|0x4
|hkUint32
|m_hz
|}
{| class="wikitable"
|+hknpAabb8TreeNode : hknpTransposedFourAabbs8
!Offset
!Size
!Type
!Description
|-
|0x18
|0x3
|hkUint8[3]
|m_data
|-
|0x1b
|0x1
|
|
|}

===== hknpMeshShape::GeometrySection::Primitive =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x1
|hkUint8
|m_aId
|-
|0x1
|0x1
|hkUint8
|m_bId
|-
|0x2
|0x1
|hkUint8
|m_cId
|-
|0x3
|0x1
|hkUint8
|m_dId
|}

===== hknpMeshShape::GeometrySection::Vertex16_3 =====
While m_vertexBuffer is untyped in later versions, in previous version it assumed this vertex format struct, which still appears to be the case (u8 mainly forces the m_vertexBuffer.m_size to be in bytes)
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x2
|hkUint16
|m_x
|-
|0x2
|0x2
|hkUint16
|m_y
|-
|0x4
|0x2
|hkUint16
|m_z
|}

==== hknpMeshShapePrimitiveMapping ====
{| class="wikitable"
|+hknpMeshShapePrimitiveMapping : hkReferencedObject
!Offset
!Size
!Type
!Description
|-
|0x0
|0x10
|hkRelArray<hkUint32>
|m_sectionStart
|-
|0x10
|0x10
|hkRelArray<unsigned int>
|m_bitString
|-
|0x20
|0x4
|hkUint32
|m_bitsPerEntry
|-
|0x24
|0x4
|hkUint32
|m_triangleIndexBitMask
|}
[[Category:File formats]]

Bphsh

2026-02-20T12:02:10Z

Watertoon: Add very likely (but not fully confirmed through code yet) guess for second array with caveat. Evidence includes: layer hit mask size change between games, layer hit masks being included in PhiveConfig MaterialPreset, clamping of size to material array

Bphsh is a "shape" file format. Responsible for storing the underlying physics engine's collision mesh data as well as relevant phive specific data. This page is focused on the version found in Nintendo Switch Online: Playtest Program (021), and Havok 2023.2.

== File Structure ==

# Header
# Havok Tag File
# Material Array
# Unknown Array

== Structures (phive) ==

=== Header ===
[[Common Phive|Common phive]] header for shape. The sections consist of the Havok tagfile containing an hknpMeshShape, an array of phive materials, and a currently unknown section.

=== Material Array ===
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Material Id. The PhiveConfig byaml stores an application's materials under MaterialCollection.
|-
|0x4
|0x4
|u32
|Sub Material. The PhiveConfig byaml stores an application's sub materials under SubMaterialCollection.
|-
|0x8
|0x8
|u64
|User Shape Tag Mask. Up to 64 tags can be present, each bit denotes whether a tag exists. The PhiveConfig byaml stores an application's tags under UserShapeTagCollection.
|}

=== Layer Hit Mask Array (Not Fully Confirmed) ===
In previous titles from NSO PT the layer hit masks were 32-bits each, making each element 0x8 bytes. A bphsh may have different counts for materials and layer hit masks. Phive clamps the size of the material array and layer hit mask array to the smaller of the two. HknpMeshShape shapeTags are presumably used to map Havok's geometry to Phive's material and layer hit masks.
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|u64
|Layer Hit Mask.The PhiveConfig byaml stores an application's layers under LayerEntityCollection for entity rigid bodies and LayerSensorCollection for sensor rigid bodies. Each bit in the mask corresponds to a layer in the order they are defined by PhiveConfig.
|-
|0x8
|0x8
|u64
|Sub Layer Hit Mask.The PhiveConfig byaml stores an application's layers under SubLayerEntityCollection for entity rigid bodies and SubLayerSensorCollection for sensor rigid bodies. Each bit in the mask corresponds to a layer in the order they are defined by PhiveConfig.
|}

== Structures (Havok Physics) ==

=== Common ===

==== hkEnum<T,B>, hkFlags<T,B> ====
Enum of type T, with underlying storage of type B.

==== hkRelPtr<T> ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|hkInt64
|m_offset; Offset relative to the base address of this object to the template type T.
|}

==== hkRelArrayView<T,B> ====
B is an integer type.
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|sizeof(B)
|B
|m_offset; Offset relative to the base address of this object to the array of template type T.
|-
|sizeof(B)
|sizeof(B)
|B
|m_size; Count of elements in the array
|}

==== hkRelArray<T> ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|hkInt64
|m_offset; Offset relative to the base address of this object to the array of template type T.
|-
|0x8
|0x4
|int
|m_size; Count of elements in the array
|-
|0xc
|0x4
|int
|m_capacityAndFlags; Max capacity of elements the array can store, also flags.
|}

=== hknpMeshShape ===
Stores a collision mesh geometry and acceleration structures.

Note; hkBaseObject has an alignment of 8, but hknpMeshShape promotes the alignment to 0x10 due to containing an hkVector4. Unmarked space is padding.
{| class="wikitable"
|+hkBaseObject
!Offset
!Size
!Type
!Description
|-
|0x0
|u64
|0x8
|_vft_reserve; Vtable pointer, resolved at runtime.
|}
{| class="wikitable"
|+hkReferencedObject : hkBaseObject
!Offset
!Size
!Type
!Description
|-
|0x8
|0x8
|hkUlong
|m_sizeAndFlags
|-
|0x10
|0x8
|hkUlong
|m_refCount
|}
{| class="wikitable"
|+hknpShape : hkReferencedObject
!Offset
!Size
!Type
!Description
|-
|0x18
|0x1
|hkEnum<hknpShapeType::Enum, hkUint8>
|m_type; Should always be "MESH" (0x8) for an hknpMeshShape.
|-
|0x19
|0x1
|hkEnum<hknpCollisionDispatchType::Enum, hkUint8>
|m_dispatchType
|-
|0x1a
|0x2
|hkFlags<hknpShape::FlagsEnum, hkUint16>
|m_flags
|-
|0x1c
|0x1
|hkUint8
|m_numShapeKeyBits
|-
|0x1d
|0x3
|
|
|-
|0x20
|0x4
|hkReal
|m_convexRadius
|-
|0x24
|0x4
|
|
|-
|0x28
|0x8
|hkUint64
|m_userData, this is set at runtime to a phive structure containing references to the material and unknown array.
|-
|0x30
|0x10
|hknpShapeProperties
|m_properties
|}
{| class="wikitable"
|+hknpCompositeShape : hknpShape
!Offset
!Size
!Type
!Description
|-
|0x40
|0x4
|hkUint32
|m_shapeTagCodecInfo
|-
|0x44
|0x4
|
|
|}
{| class="wikitable"
|+hknpMeshShape : hknpCompositeShape
!Offset
!Size
!Type
!Description
|-
|0x48
|0x8
|
|
|-
|0x50
|0x20
|hknpMeshShapeVertexConversionUtil
|m_vertexConversionUtil
|-
|0x70
|0x8
|hkRelArrayView<hknpMeshShape::ShapeTagTableEntry, int>
|m_shapeTagTable
|-
|0x78
|0x18
|hkcdSimdTreeNamespace::hkcdSimdTree<hkcdSimdTreeNamespace::RelArrayStorage<hkcdSimdTreeNamespace::Node>>
|m_topLevelTree
|-
|0x90
|0x8
|hkRelArrayView<hknpMeshShape::GeometrySection, int>
|m_geometrySections; Appears to be a convex decomposition, or at least partitioning, of the mesh shape.
|-
|0x98
|0x8
|hkRelPtr<hknpMeshShapePrimitiveMapping>
|m_primitiveMapping
|}

==== hknpShapeType::Enum ====
{| class="wikitable"
|+
!Name
!Value
!Description
|-
|CONVEX
|0x0
|
|-
|SPHERE
|0x1
|
|-
|CAPSULE
|0x2
|
|-
|CYLINDER
|0x3
|
|-
|TRIANGLE
|0x4
|
|-
|BOX
|0x5
|
|-
|COMPOSITE
|0x6
|
|-
|MESH
|0x7
|
|-
|EXTERN_MESH
|0x8
|
|-
|COMPOUND
|0x9
|
|-
|DISTANCE_FIELD_BASE
|0xa
|
|-
|HEIGHT_FIELD
|0xb
|
|-
|DISTANCE_FIELD
|0xc
|
|-
|PARTICLE_SYSTEM
|0xd
|
|-
|TRANSFORMED
|0xe
|
|-
|MASKED
|0xf
|
|-
|MASKED_COMPOUND
|0x10
|
|-
|BREAKABLE_COMPOUND
|0x11
|
|-
|LOD
|0x12
|
|-
|DUMMY
|0x13
|
|-
|LEGACY_COMPRESSED_MESH
|0x14
|
|-
|USER_0
|0x15
|
|-
|USER_1
|0x16
|
|-
|USER_2
|0x17
|
|-
|USER_3
|0x18
|
|-
|USER_4
|0x19
|
|-
|USER_5
|0x1b
|
|-
|USER_6
|0x1b
|
|-
|USER_7
|0x1c
|
|-
|NUM_SHAPE_TYPES
|0x1d
|
|-
|INVALID
|0x1e
|
|}

==== hknpCollisionDispatchType::Enum ====
{| class="wikitable"
|+
!Name
!Value
!Description
|-
|NONE
|0x0
|
|-
|CONVEX
|0x1
|
|-
|COMPOSITE
|0x2
|
|-
|DISTANCE_FIELD
|0x3
|
|-
|USER_0
|0x4
|
|-
|USER_1
|0x5
|
|-
|USER_2
|0x6
|
|-
|USER_3
|0x7
|
|-
|USER_4
|0x8
|
|-
|USER_5
|0x9
|
|-
|USER_6
|0xa
|
|-
|USER_7
|0xb
|
|-
|NUM_TYPES
|0xc
|
|}

==== hknpShape::FlagsEnum ====
{| class="wikitable"
|+
!Name
!Value
!Description
|-
|IS_CONVEX_SHAPE
|0x1
|
|-
|IS_CONVEX_POLYTOPE_SHAPE
|0x2
|
|-
|IS_COMPOSITE_SHAPE
|0x4
|
|-
|IS_HEIGHT_FIELD_SHAPE
|0x8
|
|-
|USE_SINGLE_POINT_MANIFOLD
|0x10
|
|-
|IS_INTERIOR_TRIANGLE
|0x20
|
|-
|SUPPORTS_COLLISIONS_WITH_INTERIOR_TRIANGLES
|0x40
|
|-
|USE_NORMAL_TO_FIND_SUPPORT_PLANE
|0x80
|
|-
|IS_TRIANGLE_OR_QUAD_SHAPE
|0x100
|
|-
|IS_QUAD_SHAPE
|0x200
|
|-
|IS_SDF_EDGE_COLLISION_ENABLED
|0x400
|
|-
|HAS_SURFACE_VELOCITY
|0x800
|
|-
|USER_FLAG_0
|0x1000
|
|-
|USER_FLAG_1
|0x2000
|
|-
|USER_FLAG_2
|0x4000
|
|}

==== hknpShapeProperties ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x10
|hkRelArray<hknpShapeProperties::Entry>
|Optional shape properties.
|}

===== hknpShapeProperties::Entry =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|hkRelPtr<hknpShapePropertyBase>
|Pointer to shape property. If present, likely a derived class such as hknpShapeConnectivityGraph, hknpRefDragProperties, hknpShapeMassProperties, hknpShapeMassPropertiesTree, hknpShapeMassConfigProperty, or hknpMaterialPalette.
|}

====== hknpShapePropertyBase ======
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x2
|hkUint16
|m_propertyKey; Appears to be a derived class unique identifier.
|}

==== hknpMeshShapeVertexConversionUtil ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x10
|hkVector4
|m_bitScale16; Appears to be vertex compression parameters.
|-
|0x10
|0x10
|hkVector4
|m_bitScale16Inv
|}

==== hknpMeshShape::ShapeTagTableEntry ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|hkUint32
|m_meshPrimitiveKey
|-
|0x4
|0x2
|hkUint16
|m_shapeTag
|-
|0x6
|0x2
|
|
|}

==== hkcdSimdTreeNamespace::hkcdSimdTree<hkcdSimdTreeNamespace::RelArrayStorage<hkcdSimdTreeNamespace::Node>> ====
{| class="wikitable"
|+hkcdSimdTreeNamespace::RelArrayStorage<hkcdSimdTreeNamespace::Node>
!Offset
!Size
!Type
!Description
|-
|0x0
|0x10
|hkRelArray<hkcdSimdTreeNamespace::Node>
|m_nodes
|}
{| class="wikitable"
|+hkcdSimdTreeNamespace::hkcdSimdTree : hkcdSimdTreeNamespace::RelArrayStorage<hkcdSimdTreeNamespace::Node>
!Offset
!Size
!Type
!Description
|-
|0x10
|0x4
|hkUint32
|m_firstFreeIndex
|-
|0x14
|0x1
|bool
|m_isCompact
|-
|0x15
|0x3
|
|
|}

===== hkcdSimdTreeNamespace::Node =====
{| class="wikitable"
|+hkcdFourAabb
!Offset
!Size
!Type
!Description
|-
|0x0
|0x10
|hkVector4
|m_lx
|-
|0x10
|0x10
|hkVector4
|m_hx
|-
|0x20
|0x10
|hkVector4
|m_ly
|-
|0x30
|0x10
|hkVector4
|m_hy
|-
|0x40
|0x10
|hkVector4
|m_lz
|-
|0x50
|0x10
|hkVector4
|m_hz
|}
{| class="wikitable"
|+hkcdSimdTreeNamespace::Node : hkcdFourAabb
!Offset
!Size
!Type
!Description
|-
|0x60
|0x10
|hkUint32[4]
|m_data
|-
|0x70
|0x4
|hkUint8[4]
|m_filterMasks
|-
|0x74
|0x1
|hkFlags<hkcdSimdTreeNamespace::Node::FlagsEnum, unsigned char>
|m_flags
|-
|0x75
|0x1
|hkUint8
|m_maxDepth
|-
|0x76
|0x1
|hkUint8
|m_splittingAxisCache
|-
|0x77
|0x1
|hkUint8
|m_numAddRemoveOperationsSinceLastRebalance
|-
|0x78
|0x4
|hkUint32
|m_parent
|-
|0x7c
|0x4
|hkUint32
|m_numLeaves
|}

===== hkcdSimdTreeNamespace::Node::FlagsEnum =====
{| class="wikitable"
|+
!Name
!Value
!Description
|-
|NODE_IS_LEAF
|0x1
|
|-
|NODE_IS_FREE
|0x2
|
|-
|INCREMENTAL_OPTIMIZER_NODES_ARE_REBALANCED
|0x4
|
|-
|INCREMENTAL_OPTIMIZER_REINSERT_PASS_DID_NOP
|0x8
|
|-
|INCREMENTAL_OPTIMIZER_LEAVES_ARE_REBALANCED
|0x10
|
|-
|USER_FLAG_0
|0x20
|
|-
|USER_FLAG_1
|0x40
|
|-
|USER_FLAG_2
|0x80
|
|}

==== hknpMeshShape::GeometrySection ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|hkRelArrayView<hknpAabb8TreeNode, int>
|m_sectionBvh
|-
|0x8
|0x8
|hkRelArrayView<hknpMeshShape::GeometrySection::Primitive, int>
|m_primitives
|-
|0x10
|0x8
|hkRelArrayView<hkUint8, int>
|m_vertexBuffer
|-
|0x18
|0x8
|hkRelArrayView<hkUint8, int>
|m_interiorPrimitiveBitField
|-
|0x20
|0xc
|hkUint32[3]
|m_sectionOffset
|-
|0x2c
|0xc
|hkFloat3
|m_bitScale8Inv
|-
|0x38
|0x6
|hkInt16[3]
|m_bitOffset
|-
|0x3e
|0x2
|
|
|}

===== hknpAabb8TreeNode =====
{| class="wikitable"
|+hknpTransposedFourAabbs8
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|hkUint32
|m_lx
|-
|0x4
|0x4
|hkUint32
|m_hx
|-
|0x8
|0x4
|hkUint32
|m_ly
|-
|0xc
|0x4
|hkUint32
|m_hy
|-
|0x10
|0x4
|hkUint32
|m_lz
|-
|0x14
|0x4
|hkUint32
|m_hz
|}
{| class="wikitable"
|+hknpAabb8TreeNode : hknpTransposedFourAabbs8
!Offset
!Size
!Type
!Description
|-
|0x18
|0x3
|hkUint8[3]
|m_data
|-
|0x1b
|0x1
|
|
|}

===== hknpMeshShape::GeometrySection::Primitive =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x1
|hkUint8
|m_aId
|-
|0x1
|0x1
|hkUint8
|m_bId
|-
|0x2
|0x1
|hkUint8
|m_cId
|-
|0x3
|0x1
|hkUint8
|m_dId
|}

===== hknpMeshShape::GeometrySection::Vertex16_3 =====
While m_vertexBuffer is untyped in later versions, in previous version it assumed this vertex format struct, which still appears to be the case (u8 mainly forces the m_vertexBuffer.m_size to be in bytes)
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x2
|hkUint16
|m_x
|-
|0x2
|0x2
|hkUint16
|m_y
|-
|0x4
|0x2
|hkUint16
|m_z
|}

==== hknpMeshShapePrimitiveMapping ====
{| class="wikitable"
|+hknpMeshShapePrimitiveMapping : hkReferencedObject
!Offset
!Size
!Type
!Description
|-
|0x0
|0x10
|hkRelArray<hkUint32>
|m_sectionStart
|-
|0x10
|0x10
|hkRelArray<unsigned int>
|m_bitString
|-
|0x20
|0x4
|hkUint32
|m_bitsPerEntry
|-
|0x24
|0x4
|hkUint32
|m_triangleIndexBitMask
|}
[[Category:File formats]]

Shaft::baseproc

2026-02-16T08:58:21Z

Watertoon: Remove "base procedure" for lack of source

Shaft::baseproc implements a concurrent actor framework based on scheduling units called a "BaseProc". BaseProcs can be asynchronously created by an application and later inserted into the system and modified via requests.

=== BaseProcMgr ===
Manages BaseProcs and BaseProc related sub-managers. BaseProcs with the Calc, Sleeping, or Paused states create a job graph spanning 4 "stages" with 8 "priorities" each, for 32 separate job graphs. The job graphs are processed one after the other, following the priorities from highest (0) to lowest (7) before advancing to the next stage. The jobs within each graph are processed concurrently with respect to their dependencies.

==== Lifecycle ====
BaseProcMgr has 5 main states it can move between by various api calls.

===== Idle =====
The system is at rest. Accessing BaseProcs through BaseProcLinks outside the system is legal.

===== Building =====
The system is building the job graph. BaseProcs in the Calc state will insert their jobs, and paused or sleeping BaseProcs will instead insert their sleep job if they have one.

===== BaseProc Processing =====
The system is running the current job graph. Accessing BaseProcs through BaseProcLinks outside the system is illegal.

===== Removal Processing =====
The system is processing removal requests. Successfully removed BaseProcs are scheduled for asynchronous deletion.

===== Request Processing =====
The system is processing BaseProc requests. It may be illegal to access a BaseProc outside the system at this time.

=== BaseProc ===
Harbors up to 1 job for each stage and priority. As well as up to 1 sleep job. Is a member of the BaseProc tree. Has global meta-data for being referenced by BaseProcLinks. Can have dependency relations with other BaseProcs.

==== Lifecycle ====
A BaseProc has 12 states one can logically group into 4 "cycles"; initialization (3), live (4), removal (3), and finalization (2).

===== Initialization =====
This group of states is progressed linearly along the creation of a BaseProc.

====== Uninitialized ======
The default state on creation.

====== PendingInitialize ======
The BaseProc is in the state of being initialized.

====== Initialized ======
The BaseProc has been initialized. Next request processing a "PostInitialize" function will be called once per processing, if it fails the BaseProc may be deleted, or the system may try again under certain conditions. Trying again may not be intended.

===== Live =====
This group of states represents a BaseProc that is "live" in the system. The initial state after "PostInitialize" succeeds is Ready, from there a BaseProc can move between Calc, Sleeping, or Paused.

====== Ready ======
The initial "Live" state of a BaseProc. RequestCancelSleep or RequestCancelPause can be used to attempt to change the BaseProc to Calc.

====== Calc ======
The quintessential "Live" state. All of the BaseProc's Calc jobs will be used in job graph building.

====== Sleeping ======
A heavyweight break in a BaseProc's processing. The BaseProc's sleep job will be used in job graph building. RequestCancelSleep will attempt to change the BaseProc to Calc.

====== Paused ======
A lighter break in a BaseProc's processing. The BaseProc's sleep job will be used in job graph building. RequestCancelPause will unpause the BaseProc.

===== Removal =====
After a delete request is processed, a BaseProc is transitioned to the PendingRemoval state.

====== PendingRemoval ======
The BaseProc is removing itself from the application's subsystems. When the OnRemove callback succeeds the BaseProc immediately transitions to the Removal state.

====== Removal ======
The BaseProc removes it's BaseProcLink meta data, invalidating all BaseProcLinks to it, calls the OnStateRemoval callback, and then immediately transitions to the Removed state.

====== Removed ======
Next time there is space the BaseProc will be added to the asynchronous deletion queue and transitioned to the PendingFinalize state.

===== Finalization =====
This group of states to track a BaseProc's asynchronous finalization up to it's deletion.

====== PendingFinalization ======
The BaseProc will call it's PreFinalize callback, remove itself from the BaseProcMgr lists and trees, and then call it's PostFinalize callback before immediate transitioning to the Finalized state.

====== Finalized ======
The BaseProc has completed finalization and will imminently be deleted, with it's memory freed back to it's parent heap.

=== BaseProcBinder ===
Allows watching for the asynchronous creation of a BaseProc. On completion a BaseProcLink to that BaseProc can be retrieved.

=== BaseProcLink ===
A "hyperlink" reference to a BaseProc. Used to retrieve scoped "read" or "write" accessors to a BaseProc. The accessors follow the C++ "optional" pattern, where retrieving one can fail to retrieve the underlying BaseProc. There are a few rules regarding when an accessor is legal to acquire. Read accessors are the least strict, and succeed as long as the BaseProc has not processed a delete request. Write accessors have 3 different rulesets for anywhere, outside the system, and a strict inside the system.

Common nn::util

2026-02-16T06:57:17Z

Watertoon: Cleanup, add NWPtr<T> and NWString to use as helpers in the other NW file format pages.

These are file structures common to multiple NintendoWare file formats. Namely the nn::gfx file formats [[Bntx]] and [[Bnsh]], the nn::g3d file formats [[Bfres]], and [[Bfsha]], the nn::vg file format [[Bnvg]], and the nn::bezel file formats [[Bea]], [[Bnbshpk]], and [[Nbmap]].

== Headers ==

=== nn::util::BinaryFileHeader ===
The base struct of almost if not every file format using nn::util file structures.
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|u64
|Magic (dependent on file type)
|-
|0x8
|0x1
|u8
|Micro version (no code breaking changes)
|-
|0x9
|0x1
|u8
|Minor version
|-
|0xa
|0x2
|u16
|Major version
|-
|0xc
|0x2
|u16
|Endianess (0xfffe in big endian)
|-
|0xe
|0x1
|u8
|Packed alignment (alignment = 1 << packed alignment)
|-
|0xf
|0x1
|u8
|Always 64 (address size?)
|-
|0x10
|0x4
|u32
|File name offset
|-
|0x14
|0x2
|u16
|Is relocated (set on runtime by nn::util::RelocationTable::Relocate to prevent double relocation)
|-
|0x16
|0x2
|u16
|First BinaryBlockHeader offset relative to this header
|-
|0x18
|0x4
|u32
|RelocationTable offset relative to this header
|-
|0x1c
|0x4
|u32
|File size
|}

=== nn::util::BinaryBlockHeader ===
A common base struct of sub sections in nn::util based files.
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Magic (dependent on file block type)
|-
|0x4
|0x4
|u32
|Next BinaryBlockHeader offset relative to this header
|-
|0x8
|0x4
|u32
|Size of sub section
|-
|0xc
|0x4
|u32
|Reserved
|}

== Relocation Table ==
Relocation tables are iterated to relocate pointers all throughout the BinaryFileHeader derived file. Converting the file into just a collection of structs in memory.

=== NWPtr<T> ===
A template type to a pointer to type T that is relocatable by the relocation table. The size should match the address size in the file header, in Switch games this is almost always 64-bits.

=== nn::util::RelocationTable ===
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Magic ("_RLT" in big-endian)
|-
|0x4
|0x4
|u32
|Offset of this table relative to the binary file header
|-
|0x8
|0x4
|u32
|Section count
|-
|0xc
|0x4
|u32
|Reserved
|}

==== nn::util::RelocationTable::Section ====
Immediately following the RelocationTable header is an array of section information. Which can divide up the file into distinct regions relative to a base offset.
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|void *
|Base pointer for file region offsets, if null the file region is relative to the BinaryFileHeader)
|-
|0x8
|0x4
|u32
|File region offset (relative to BinaryFileHeader or Base pointer)
|-
|0xc
|0x4
|u32
|File region size
|-
|0x10
|0x4
|u32
|Base entry index
|-
|0x14
|0x4
|u32
|Entry count
|}

===== nn::util::RelocationTable::Entry (unofficial name) =====
Immediately following the Section array is an array of information about relocation entries. Each entry defines a set of continuous pointer arrays with a stride between each array.
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|File region offset (relative to section file region offset)
|-
|0x4
|0x2
|u16
|Array count
|-
|0x6
|0x1
|u8
|Per array pointer count
|-
|0x7
|0x1
|u8
|Array stride (in pointer count, so (stride * sizeof(void*))
|}

== Dictionary ==

=== nn::util::ResDic ===
A dictionary, each element must have a unique string key.
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Magic ("_DIC" in big-endian or 0x0)
|-
|0x4
|0x4
|u32
|Count (does not count root node, which is part of the header)
|-
|0x8
|0x10
|nn::util::ResDic::Node
|Root node (null key)
|-
|0x18
|0x10 * Count
|nn::util::ResDic::Node[Count]
|Node array
|}

==== nn::util::ResDic::Node (unofficial name) ====
The ref bit is used for a radix tree style lookup.
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Ref bit (bit 0-2 = right shift, bit 2-31 = length)
|-
|0x4
|0x2
|u16
|Left node index
|-
|0x6
|0x2
|u16
|Right node index
|-
|0x8
|0x8
|const char * (NW)
|String key
|}

== StringPool ==

=== NWString ===
NintendoWare file string pointers are preceded by a u16 string length. The strings are also aligned to 2 bytes.
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x2
|u16
|String Length
|-
|0x2
|0x1 * String Length
|char[String Length]
|String Data
|}

=== nn::util::StringPool ===
Header that precedes the deduplicated string table.
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Magic ("_STR" in big-endian)
|-
|0x4
|0x4
|u32
|Next BinaryBlockHeader offset relative to this header
|-
|0c8
|0x8
|void*
|Reserved
|-
|0xc
|0x4
|u32
|String Count
|-
|0x10
|0x4
|u32
|Empty String entry (0x0000, 0x00)
|-
|0x14
|
|NWString[StringCount]
|String region
|}
[[Category:File formats]]

Rsizetable

2026-02-16T06:29:22Z

Watertoon: Cleanup

[[Ares]] implements a "resource size table" file format managed by ares::ResourceSizeTable. '''The earliest revision has no header''', only containing the crc32b array, the size of array is implicitly calculated. The first revision adds a 0xc byte header and an optional array of fixed size file path + resource size pairs for file paths that produce a hash collision (default fixed size of that game's max path). The second and most common revision uses a 0x16 byte header, the 0x6 byte magic makes all subsequent u32 values unaligned.

== File Structure ==

=== Header (revision 1) ===
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Magic ("RSTB" in big-endian)
|-
|0x4
|0x4
|u32
|Crc32b resource size pair count
|-
|0x8
|0x4
|u32
|Path resource size pair count
|}

=== Header (revision 2) ===
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x6
|u32
|Magic ("RESTBL" in big-endian)
|-
|0x6
|0x4
|u32
|Version
|-
|0xa
|0x4
|u32
|Size of paths in collision table (0x80 and 0xa0 have been used)
|-
|0xe
|0x4
|u32
|Crc32b resource size pair count
|-
|0x12
|0x4
|u32
|Path resource size pair count
|}

=== Crc32b Array ===
Array of hash + size pairs immediately following the header, if the header exists. Sorted by hash.
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Crc32b of file path
|-
|0x4
|0x4
|u32
|Size required by file resource in ares
|}

=== Path Array ===
Array of path + size pairs immediately following the Crc32b array, if the file path array exists. Sorted by path.
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|ares MaxPath
|char[ares MaxPath]
|Fixed size file path
|-
|ares MaxPath
|0x4
|u32
|Size required by file resource in ares
|}
[[Category:File formats]]

Shaft::baseproc

2026-02-12T06:27:19Z

Watertoon: Change name of PendingActive and Active to Ready and Calc based on totk ai nodes QueryGenericIsSleepOrReady and QueryActorHolderIsCalcOrPauseState

Shaft::baseproc implements a concurrent actor framework based on scheduling units called a "base procedure". BaseProcs can be asynchronously created by an application and later inserted into the system and modified via requests.

=== BaseProcMgr ===
Manages BaseProcs and BaseProc related sub-managers. BaseProcs with the Calc, Sleeping, or Paused states create a job graph spanning 4 "stages" with 8 "priorities" each, for 32 separate job graphs. The job graphs are processed one after the other, following the priorities from highest (0) to lowest (7) before advancing to the next stage. The jobs within each graph are processed concurrently with respect to their dependencies.

==== Lifecycle ====
BaseProcMgr has 5 main states it can move between by various api calls.

===== Idle =====
The system is at rest. Accessing BaseProcs through BaseProcLinks outside the system is legal.

===== Building =====
The system is building the job graph. BaseProcs in the Calc state will insert their jobs, and paused or sleeping BaseProcs will instead insert their sleep job if they have one.

===== BaseProc Processing =====
The system is running the current job graph. Accessing BaseProcs through BaseProcLinks outside the system is illegal.

===== Removal Processing =====
The system is processing removal requests. Successfully removed BaseProcs are scheduled for asynchronous deletion.

===== Request Processing =====
The system is processing BaseProc requests. It may be illegal to access a BaseProc outside the system at this time.

=== BaseProc ===
Harbors up to 1 job for each stage and priority. As well as up to 1 sleep job. Is a member of the BaseProc tree. Has global meta-data for being referenced by BaseProcLinks. Can have dependency relations with other BaseProcs.

==== Lifecycle ====
A BaseProc has 12 states one can logically group into 4 "cycles"; initialization (3), live (4), removal (3), and finalization (2).

===== Initialization =====
This group of states is progressed linearly along the creation of a BaseProc.

====== Uninitialized ======
The default state on creation.

====== PendingInitialize ======
The BaseProc is in the state of being initialized.

====== Initialized ======
The BaseProc has been initialized. Next request processing a "PostInitialize" function will be called once per processing, if it fails the BaseProc may be deleted, or the system may try again under certain conditions. Trying again may not be intended.

===== Live =====
This group of states represents a BaseProc that is "live" in the system. The initial state after "PostInitialize" succeeds is Ready, from there a BaseProc can move between Calc, Sleeping, or Paused.

====== Ready ======
The initial "Live" state of a BaseProc. RequestCancelSleep or RequestCancelPause can be used to attempt to change the BaseProc to Calc.

====== Calc ======
The quintessential "Live" state. All of the BaseProc's Calc jobs will be used in job graph building.

====== Sleeping ======
A heavyweight break in a BaseProc's processing. The BaseProc's sleep job will be used in job graph building. RequestCancelSleep will attempt to change the BaseProc to Calc.

====== Paused ======
A lighter break in a BaseProc's processing. The BaseProc's sleep job will be used in job graph building. RequestCancelPause will unpause the BaseProc.

===== Removal =====
After a delete request is processed, a BaseProc is transitioned to the PendingRemoval state.

====== PendingRemoval ======
The BaseProc is removing itself from the application's subsystems. When the OnRemove callback succeeds the BaseProc immediately transitions to the Removal state.

====== Removal ======
The BaseProc removes it's BaseProcLink meta data, invalidating all BaseProcLinks to it, calls the OnStateRemoval callback, and then immediately transitions to the Removed state.

====== Removed ======
Next time there is space the BaseProc will be added to the asynchronous deletion queue and transitioned to the PendingFinalize state.

===== Finalization =====
This group of states to track a BaseProc's asynchronous finalization up to it's deletion.

====== PendingFinalization ======
The BaseProc will call it's PreFinalize callback, remove itself from the BaseProcMgr lists and trees, and then call it's PostFinalize callback before immediate transitioning to the Finalized state.

====== Finalized ======
The BaseProc has completed finalization and will imminently be deleted, with it's memory freed back to it's parent heap.

=== BaseProcBinder ===
Allows watching for the asynchronous creation of a BaseProc. On completion a BaseProcLink to that BaseProc can be retrieved.

=== BaseProcLink ===
A "hyperlink" reference to a BaseProc. Used to retrieve scoped "read" or "write" accessors to a BaseProc. The accessors follow the C++ "optional" pattern, where retrieving one can fail to retrieve the underlying BaseProc. There are a few rules regarding when an accessor is legal to acquire. Read accessors are the least strict, and succeed as long as the BaseProc has not processed a delete request. Write accessors have 3 different rulesets for anywhere, outside the system, and a strict inside the system.

Bphsh

2026-01-13T10:50:02Z

Watertoon: Initial page for bphsh

Bphsh is a "shape" file format. Responsible for storing the underlying physics engine's collision mesh data as well as relevant phive specific data. This page is focused on the version found in Nintendo Switch Online: Playtest Program (021), and Havok 2023.2.

== File Structure ==

# Header
# Havok Tag File
# Material Array
# Unknown Array

== Structures (phive) ==

=== Header ===
[[Common Phive|Common phive]] header for shape. The sections consist of the Havok tagfile containing an hknpMeshShape, an array of phive materials, and a currently unknown section.

=== Material Array ===
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Material Id. The PhiveConfig byaml stores an application's materials under MaterialCollection.
|-
|0x4
|0x4
|u32
|Sub Material. The PhiveConfig byaml stores an application's sub materials under SubMaterialCollection.
|-
|0x8
|0x8
|u64
|User Shape Tag Mask. Up to 64 tags can be present, each bit denotes whether a tag exists. The PhiveConfig byaml stores an application's tags under UserShapeTagCollection.
|}

=== Unknown ===
0x10 sized per structure.

== Structures (Havok Physics) ==

=== Common ===

==== hkEnum<T,B>, hkFlags<T,B> ====
Enum of type T, with underlying storage of type B.

==== hkRelPtr<T> ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|hkInt64
|m_offset; Offset relative to the base address of this object to the template type T.
|}

==== hkRelArrayView<T,B> ====
B is an integer type.
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|sizeof(B)
|B
|m_offset; Offset relative to the base address of this object to the array of template type T.
|-
|sizeof(B)
|sizeof(B)
|B
|m_size; Count of elements in the array
|}

==== hkRelArray<T> ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|hkInt64
|m_offset; Offset relative to the base address of this object to the array of template type T.
|-
|0x8
|0x4
|int
|m_size; Count of elements in the array
|-
|0xc
|0x4
|int
|m_capacityAndFlags; Max capacity of elements the array can store, also flags.
|}

=== hknpMeshShape ===
Stores a collision mesh geometry and acceleration structures.

Note; hkBaseObject has an alignment of 8, but hknpMeshShape promotes the alignment to 0x10 due to containing an hkVector4. Unmarked space is padding.
{| class="wikitable"
|+hkBaseObject
!Offset
!Size
!Type
!Description
|-
|0x0
|u64
|0x8
|_vft_reserve; Vtable pointer, resolved at runtime.
|}
{| class="wikitable"
|+hkReferencedObject
!Offset
!Size
!Type
!Description
|-
|0x8
|0x8
|hkUlong
|m_sizeAndFlags
|-
|0x10
|0x8
|hkUlong
|m_refCount
|}
{| class="wikitable"
|+hknpShape : hkReferencedObject
!Offset
!Size
!Type
!Description
|-
|0x18
|0x1
|hkEnum<hknpShapeType::Enum, hkUint8>
|m_type; Should always be "MESH" (0x8) for an hknpMeshShape.
|-
|0x19
|0x1
|hkEnum<hknpCollisionDispatchType::Enum, hkUint8>
|m_dispatchType
|-
|0x1a
|0x2
|hkFlags<hknpShape::FlagsEnum, hkUint16>
|m_flags
|-
|0x1c
|0x1
|hkUint8
|m_numShapeKeyBits
|-
|0x1d
|0x3
|
|
|-
|0x20
|0x4
|hkReal
|m_convexRadius
|-
|0x24
|0x4
|
|
|-
|0x28
|0x8
|hkUint64
|m_userData, this is set at runtime to a phive structure containing references to the material and unknown array.
|-
|0x30
|0x10
|hknpShapeProperties
|m_properties
|}
{| class="wikitable"
|+hknpCompositeShape : hknpShape
!Offset
!Size
!Type
!Description
|-
|0x40
|0x4
|hkUint32
|m_shapeTagCodecInfo
|-
|0x44
|0x4
|
|
|}
{| class="wikitable"
|+hknpMeshShape : hknpCompositeShape
!Offset
!Size
!Type
!Description
|-
|0x48
|0x8
|
|
|-
|0x50
|0x20
|hknpMeshShapeVertexConversionUtil
|m_vertexConversionUtil
|-
|0x70
|0x8
|hkRelArrayView<hknpMeshShape::ShapeTagTableEntry, int>
|m_shapeTagTable
|-
|0x78
|0x18
|hkcdSimdTreeNamespace::hkcdSimdTree<hkcdSimdTreeNamespace::RelArrayStorage<hkcdSimdTreeNamespace::Node>>
|m_topLevelTree
|-
|0x90
|0x8
|hkRelArrayView<hknpMeshShape::GeometrySection, int>
|m_geometrySections; Appears to be a convex decomposition, or at least partitioning, of the mesh shape.
|-
|0x98
|0x8
|hkRelPtr<hknpMeshShapePrimitiveMapping>
|m_primitiveMapping
|}

==== hknpShapeType::Enum ====
{| class="wikitable"
|+
!Name
!Value
!Description
|-
|CONVEX
|0x0
|
|-
|SPHERE
|0x1
|
|-
|CAPSULE
|0x2
|
|-
|CYLINDER
|0x3
|
|-
|TRIANGLE
|0x4
|
|-
|BOX
|0x5
|
|-
|COMPOSITE
|0x6
|
|-
|MESH
|0x7
|
|-
|EXTERN_MESH
|0x8
|
|-
|COMPOUND
|0x9
|
|-
|DISTANCE_FIELD_BASE
|0xa
|
|-
|HEIGHT_FIELD
|0xb
|
|-
|DISTANCE_FIELD
|0xc
|
|-
|PARTICLE_SYSTEM
|0xd
|
|-
|TRANSFORMED
|0xe
|
|-
|MASKED
|0xf
|
|-
|MASKED_COMPOUND
|0x10
|
|-
|BREAKABLE_COMPOUND
|0x11
|
|-
|LOD
|0x12
|
|-
|DUMMY
|0x13
|
|-
|LEGACY_COMPRESSED_MESH
|0x14
|
|-
|USER_0
|0x15
|
|-
|USER_1
|0x16
|
|-
|USER_2
|0x17
|
|-
|USER_3
|0x18
|
|-
|USER_4
|0x19
|
|-
|USER_5
|0x1b
|
|-
|USER_6
|0x1b
|
|-
|USER_7
|0x1c
|
|-
|NUM_SHAPE_TYPES
|0x1d
|
|-
|INVALID
|0x1e
|
|}

==== hknpCollisionDispatchType::Enum ====
{| class="wikitable"
|+
!Name
!Value
!Description
|-
|NONE
|0x0
|
|-
|CONVEX
|0x1
|
|-
|COMPOSITE
|0x2
|
|-
|DISTANCE_FIELD
|0x3
|
|-
|USER_0
|0x4
|
|-
|USER_1
|0x5
|
|-
|USER_2
|0x6
|
|-
|USER_3
|0x7
|
|-
|USER_4
|0x8
|
|-
|USER_5
|0x9
|
|-
|USER_6
|0xa
|
|-
|USER_7
|0xb
|
|-
|NUM_TYPES
|0xc
|
|}

==== hknpShape::FlagsEnum ====
{| class="wikitable"
|+
!Name
!Value
!Description
|-
|IS_CONVEX_SHAPE
|0x1
|
|-
|IS_CONVEX_POLYTOPE_SHAPE
|0x2
|
|-
|IS_COMPOSITE_SHAPE
|0x4
|
|-
|IS_HEIGHT_FIELD_SHAPE
|0x8
|
|-
|USE_SINGLE_POINT_MANIFOLD
|0x10
|
|-
|IS_INTERIOR_TRIANGLE
|0x20
|
|-
|SUPPORTS_COLLISIONS_WITH_INTERIOR_TRIANGLES
|0x40
|
|-
|USE_NORMAL_TO_FIND_SUPPORT_PLANE
|0x80
|
|-
|IS_TRIANGLE_OR_QUAD_SHAPE
|0x100
|
|-
|IS_QUAD_SHAPE
|0x200
|
|-
|IS_SDF_EDGE_COLLISION_ENABLED
|0x400
|
|-
|HAS_SURFACE_VELOCITY
|0x800
|
|-
|USER_FLAG_0
|0x1000
|
|-
|USER_FLAG_1
|0x2000
|
|-
|USER_FLAG_2
|0x4000
|
|}

==== hknpShapeProperties ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x10
|hkRelArray<hknpShapeProperties::Entry>
|Optional shape properties.
|}

===== hknpShapeProperties::Entry =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|hkRelPtr<hknpShapePropertyBase>
|Pointer to shape property. If present, likely a derived class such as hknpShapeConnectivityGraph, hknpRefDragProperties, hknpShapeMassProperties, hknpShapeMassPropertiesTree, hknpShapeMassConfigProperty, or hknpMaterialPalette.
|}

====== hknpShapePropertyBase ======
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x2
|hkUint16
|m_propertyKey; Appears to be a derived class unique identifier.
|}

==== hknpMeshShapeVertexConversionUtil ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x10
|hkVector4
|m_bitScale16; Appears to be vertex compression parameters.
|-
|0x10
|0x10
|hkVector4
|m_bitScale16Inv
|}

==== hknpMeshShape::ShapeTagTableEntry ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|hkUint32
|m_meshPrimitiveKey
|-
|0x4
|0x2
|hkUint16
|m_shapeTag
|-
|0x6
|0x2
|
|
|}

==== hkcdSimdTreeNamespace::hkcdSimdTree<hkcdSimdTreeNamespace::RelArrayStorage<hkcdSimdTreeNamespace::Node>> ====
{| class="wikitable"
|+hkcdSimdTreeNamespace::RelArrayStorage<hkcdSimdTreeNamespace::Node>
!Offset
!Size
!Type
!Description
|-
|0x0
|0x10
|hkRelArray<hkcdSimdTreeNamespace::Node>
|m_nodes
|}
{| class="wikitable"
|+hkcdSimdTreeNamespace::hkcdSimdTree : hkcdSimdTreeNamespace::RelArrayStorage<hkcdSimdTreeNamespace::Node>
!Offset
!Size
!Type
!Description
|-
|0x10
|0x4
|hkUint32
|m_firstFreeIndex
|-
|0x14
|0x1
|bool
|m_isCompact
|-
|0x15
|0x3
|
|
|}

===== hkcdSimdTreeNamespace::Node =====
{| class="wikitable"
|+hkcdFourAabb
!Offset
!Size
!Type
!Description
|-
|0x0
|0x10
|hkVector4
|m_lx
|-
|0x10
|0x10
|hkVector4
|m_hx
|-
|0x20
|0x10
|hkVector4
|m_ly
|-
|0x30
|0x10
|hkVector4
|m_hy
|-
|0x40
|0x10
|hkVector4
|m_lz
|-
|0x50
|0x10
|hkVector4
|m_hz
|}
{| class="wikitable"
|+hkcdSimdTreeNamespace::Node : hkcdFourAabb
!Offset
!Size
!Type
!Description
|-
|0x60
|0x10
|hkUint32[4]
|m_data
|-
|0x70
|0x4
|hkUint8[4]
|m_filterMasks
|-
|0x74
|0x1
|hkFlags<hkcdSimdTreeNamespace::Node::FlagsEnum, unsigned char>
|m_flags
|-
|0x75
|0x1
|hkUint8
|m_maxDepth
|-
|0x76
|0x1
|hkUint8
|m_splittingAxisCache
|-
|0x77
|0x1
|hkUint8
|m_numAddRemoveOperationsSinceLastRebalance
|-
|0x78
|0x4
|hkUint32
|m_parent
|-
|0x7c
|0x4
|hkUint32
|m_numLeaves
|}

===== hkcdSimdTreeNamespace::Node::FlagsEnum =====
{| class="wikitable"
|+
!Name
!Value
!Description
|-
|NODE_IS_LEAF
|0x1
|
|-
|NODE_IS_FREE
|0x2
|
|-
|INCREMENTAL_OPTIMIZER_NODES_ARE_REBALANCED
|0x4
|
|-
|INCREMENTAL_OPTIMIZER_REINSERT_PASS_DID_NOP
|0x8
|
|-
|INCREMENTAL_OPTIMIZER_LEAVES_ARE_REBALANCED
|0x10
|
|-
|USER_FLAG_0
|0x20
|
|-
|USER_FLAG_1
|0x40
|
|-
|USER_FLAG_2
|0x80
|
|}

==== hknpMeshShape::GeometrySection ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|hkRelArrayView<hknpAabb8TreeNode, int>
|m_sectionBvh
|-
|0x8
|0x8
|hkRelArrayView<hknpMeshShape::GeometrySection::Primitive, int>
|m_primitives
|-
|0x10
|0x8
|hkRelArrayView<hkUint8, int>
|m_vertexBuffer
|-
|0x18
|0x8
|hkRelArrayView<hkUint8, int>
|m_interiorPrimitiveBitField
|-
|0x20
|0xc
|hkUint32[3]
|m_sectionOffset
|-
|0x2c
|0xc
|hkFloat3
|m_bitScale8Inv
|-
|0x38
|0x6
|hkInt16[3]
|m_bitOffset
|-
|0x3e
|0x2
|
|
|}

===== hknpAabb8TreeNode =====
{| class="wikitable"
|+hknpTransposedFourAabbs8
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|hkUint32
|m_lx
|-
|0x4
|0x4
|hkUint32
|m_hx
|-
|0x8
|0x4
|hkUint32
|m_ly
|-
|0xc
|0x4
|hkUint32
|m_hy
|-
|0x10
|0x4
|hkUint32
|m_lz
|-
|0x14
|0x4
|hkUint32
|m_hz
|}
{| class="wikitable"
|+hknpAabb8TreeNode : hknpTransposedFourAabbs8
!Offset
!Size
!Type
!Description
|-
|0x18
|0x3
|hkUint8[3]
|m_data
|-
|0x1b
|0x1
|
|
|}

===== hknpMeshShape::GeometrySection::Primitive =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x1
|hkUint8
|m_aId
|-
|0x1
|0x1
|hkUint8
|m_bId
|-
|0x2
|0x1
|hkUint8
|m_cId
|-
|0x3
|0x1
|hkUint8
|m_dId
|}

===== hknpMeshShape::GeometrySection::Vertex16_3 =====
While m_vertexBuffer is untyped in later versions, in previous version it assumed this vertex format struct, which still appears to be the case (u8 mainly forces the m_vertexBuffer.m_size to be in bytes)
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x2
|hkUint16
|m_x
|-
|0x2
|0x2
|hkUint16
|m_y
|-
|0x4
|0x2
|hkUint16
|m_z
|}

==== hknpMeshShapePrimitiveMapping ====
{| class="wikitable"
|+hknpMeshShapePrimitiveMapping : hkReferencedObject
!Offset
!Size
!Type
!Description
|-
|0x0
|0x10
|hkRelArray<hkUint32>
|m_sectionStart
|-
|0x10
|0x10
|hkRelArray<unsigned int>
|m_bitString
|-
|0x20
|0x4
|hkUint32
|m_bitsPerEntry
|-
|0x24
|0x4
|hkUint32
|m_triangleIndexBitMask
|}
[[Category:File formats]]

AINB

2026-01-08T03:39:09Z

Watertoon: Multi-Input corrections.

'''AINB''' ('''AI''' '''N'''ode '''B'''inary) is a file format implementing behavior trees for game-specific code. At time of writing it has only appeared in titles on the ModuleSystem game engine. This article is primarily aimed at the version that appears in ''Tears of the Kingdom,'' ''Super Mario Bros. Wonder, Mario vs Donkey Kong,'' and the original October 2024 version of ''Nintendo Switch Online: Playtest Program'' (v0x407). ModuleSystem provides 3 built-in file categories that appear in their own dedicated folders in a title's romfs, being "AI" for actor behavior, "Logic" for actor ai group behavior, and "Sequence" for scene behavior, individual games are free to create their own file categories.

=== Version Table ===
{| class="wikitable"
|+
!Version
!Applications
!Differences From Previous
|-
|0x404
|''Nintendo Switch Sports, Splatoon 3''
|
|-
|0x407
|''The Legend of Zelda: Tears of the Kingdom, Super Mario Bros. Wonder, Mario Vs Donkey Kong, Nintendo Switch Online: Playtest Program (010)''
|
|-
|0x408
|''Nintendo Switch Online: Playtest Program (021)''
|>Now uses exb version 3 (u32 support)
>Added u32 type to blackboard
|}

== File Structure ==
AINB assumes little endian. Hashes can be assumed to be 32-bit Murmur3 unless otherwise specified.

An AINB file defines a set of commands to evaluate a tree of built-in or game-specific node classes. The built-in "Element_ModuleCaller" node and supporting structures allow a "root" AINB file to call out to an external "module" AINB file, module's can call further modules, allowing AINB files to form a tree of tree's. An AINB's file extension typically designates whether it is a root <code>.root.ainb</code> or module <code>.module.ainb</code>. For AI and Sequence files, the file's entry point is one or more commands which is linked to one or two child nodes. All nodes are accessed by their index (references to query nodes will use their query node index which is local to the amount of query nodes in the file).

All string offsets in the file are relative to the beginning of the string pool and name hashes are 32-bit murmur3 hashes. There are six possible data types for AINB parameters: int (signed 32-bit integer), bool, float (32-bit), vector3f, and pointer. Pointer parameters are pointers to objects.

=== Section Order ===

==== Version 0x407 ====
# File Header (0x74)
# Command Array
# Element Array
# Blackboard
# Element Param Region
# Attachment Parameters
# Property Parameters
# Input/Output Parameters
# Multi-Inputs
# Jump Array
# 0x50 Section (Unused in ''TotK'')
# Query Id Array
# Expression Binary
# AINB Modules
# External Action Array
# File Hashes
# Child Replacement Table
# 0x6C Section
# Enum Resolve Array
# String Pool

== Structures ==

=== Helpers ===

==== AinbString ====
Represents a u32 offset relative to a null-terminated string from the start of the file's string pool.

==== AinbPtr<T> ====
Represents a u32 absolute offset from the start of the file to the struct of type "T" enclosed by <>.

==== AinbArray<T> ====
Represents a u32 absolute offset from the start of the file to:
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Count
|-
|0x4
|
|T[Count]
|Array of struct of type T. Note; asb files only use 32-bit aligned types.
|}

=== File Header ===
AINB files begin with a 0x74 byte header. If the offset for a given section is empty, that section is not present in the file.
{| class="wikitable"
|+File Header
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|char[4]
|Magic - “AIB “
|-
|0x04
|0x04
|u32
|Version
|-
|0x08
|0x04
|AinbString
|Filename
|-
|0x0C
|0x04
|u32
|Command Count
|-
|0x10
|0x04
|u32
|Element Count
|-
|0x14
|0x04
|u32
|Query Element Count
|-
|0x18
|0x04
|u32
|Attachment Count
|-
|0x1C
|0x04
|u32
|Output Element Count
|-
|0x20
|0x04
|AinbPtr<Blackboard>
|Blackboard
|-
|0x24
|0x04
|AinbPtr<char>
|String Pool
|-
|0x28
|0x04
|AinbPtr<AinbArray<Enum Relocation>>
|Enum Relocation Array
|-
|0x2C
|0x04
|AinbPtr<Property Table>
|Property Table
|-
|0x30
|0x04
|AinbPtr<Jump[]>
|Jump Table
|-
|0x34
|0x04
|AinbPtr<Input Output Table>
|Input/Output Table
|-
|0x38
|0x04
|AinbPtr<Multi Input[]>
|Multi-Input Array
|-
|0x3C
|0x04
|AinbPtr<Attachment[Attachment Count]>
|Attachment Array
|-
|0x40
|0x04
|AinbPtr<u32[]>
|Attachment Id Array
|-
|0x44
|0x04
|AinbPtr<Exb>
|Expression Binary
|-
|0x48
|0x04
|u32
|Child Replacement Table
|-
|0x4C
|0x04
|AinbPtr<u32[]>
|Query Element Id Array
|-
|0x50
|0x04
|u32
|Unknown (unused in ''TotK'', always the same as the Active Node Update Array Offset)
|-
|0x54
|0x04
|u32
|Unknown (always 0)
|-
|0x58
|0x04
|u32
|Unknown (always 0, used in ''Splatoon 3''/''Nintendo Switch Sports'')
|-
|0x5C
|0x04
|AinbPtr<AinbArray<Module Caller>>
|Module Caller Array
|-
|0x60
|0x04
|AinbString
|File Category Name
|-
|0x64
|0x04
|u32
|File Category? (0 = AI, 1 = Logic, 2 = Sequence) (''Splatoon 3'' game specific, 3 = UniqueSequenceSPL)
|-
|0x68
|0x04
|AinbPtr<AinbArray<External Action>>
|External Action Array
|-
|0x6C
|0x04
|u32
|Unknown (Unused in ''TotK'')
|-
|0x70
|0x04
|AinbPtr<Module Caller Link>
|Module Caller Link
|}

=== Command Array ===
The command array immediately follows the file header and is an array of all commands in the file.
{| class="wikitable"
|+Command Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|AinbString
|Name
|-
|0x04
|0x10
|Guid
|Guid
|-
|0x14
|0x02
|u16
|Main Element Id
|-
|0x16
|0x02
|u16
|Secondary Element Id (value offset by 1, 0 is reserved for invalid)
|}
Unlike asb, command GUIDs only appear to be used for debug messages. Secondary Element Id will be -1 if the command only has one child element.

=== Property Table ===
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|AsbPtr<Property<s32>[]>
|Property Array
|-
|0x04
|0x04
|AsbPtr<Property<bool>[]>
|Property Array
|-
|0x08
|0x04
|AsbPtr<Property<float>[]>
|Property Array
|-
|0x0c
|0x04
|AsbPtr<Property<AinbString>[]>
|Property Array
|-
|0x10
|0x04
|AsbPtr<Property<Vector3f>[]>
|Property Array
|-
|0x14
|0x04
|AsbPtr<PropertyPointer[]>
|Property Array
|}

==== Property<T> ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|AinbString
|Name
|-
|0x4
|0x4
|Property Flags
|Flags
|-
|0x8
|0x4, or 0xc
|T
|Immediate Value
|}

===== Property Flags =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32 : 16
|Index
|-
|
|
|u32 : 1
|Is Use Index
|-
|
|
|u32 : 1
|Is Not Local Blackboard Index
|-
|
|
|u32 : 1
|
|-
|
|
|u32 : 1
|
|-
|
|
|u32 : 1
|
|-
|
|
|u32 : 1
|
|-
|
|
|u32 : 1
|Is EXB Index
|-
|
|
|u32 : 1
|Pulse Thread Local Storage
|-
|
|
|u32 : 1
|Set Pointer Flag Bit Zero
|-
|
|
|u32 : 7
|
|}

==== PropertyPointer ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|AinbString
|Name
|-
|0x4
|0x4
|AinbString
|Class Name
|-
|0x8
|0x4
|Property Flags
|Flags
|}

==== Property Entries ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property Type Entry
|S32 Entries
|-
|0x8
|0x8
|Property Type Entry
|Bool Entries
|-
|0x10
|0x8
|Property Type Entry
|Float Entries
|-
|0x18
|0x8
|Property Type Entry
|String Entries
|-
|0x20
|0x8
|Property Type Entry
|Vector3f Entries
|-
|0x28
|0x8
|Property Type Entry
|Pointer Entries
|}

===== Property Type Entry =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Base Index - base index into the Property Table's Property Array for the specified type
|-
|0x4
|0x4
|u32
|Count
|}

=== Input Output Table ===
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|AsbPtr<Input<s32>[]>
|Input Array
|-
|0x04
|0x04
|AsbPtr<Output<s32>[]>
|Output Array
|-
|0x08
|0x04
|AsbPtr<Input<bool>[]>
|Input Array
|-
|0x0c
|0x04
|AsbPtr<Output<bool[]>
|Output Array
|-
|0x10
|0x04
|AsbPtr<Input<float>[]>
|Input Array
|-
|0x14
|0x04
|AsbPtr<Output<float>[]>
|Output Array
|-
|0x18
|0x04
|AsbPtr<Input<AinbString>[]>
|Input Array
|-
|0x1c
|0x04
|AsbPtr<Output<AinbString>[]>
|Output Array
|-
|0x20
|0x04
|AsbPtr<Input<Vector3f>[]>
|Input Array
|-
|0x24
|0x04
|AsbPtr<Output<Vector3f>[]>
|Output Array
|-
|0x28
|0x04
|AsbPtr<InputPointer[]>
|Input Array
|-
|0x2c
|0x04
|AsbPtr<OutputPointer[]>
|Output Array
|}

==== Input<T> ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|AinbString
|Name
|-
|0x4
|0x2
|s16
|Input Element Id or Base Multi-Input Id
|-
|0x6
|0x2
|s16
|Input Element Output Plug Id or Multi-Input Count
|-
|0x8
|0x4
|Property Flags
|Flags
|-
|0xc
|0x4, or 0xc
|T
|Immediate Value
|}
If the input element id is between -32768 and -100, then the input uses a multi-input. The multi-input id can be calculated as follows: <code>BaseMultiInputIndex = -100 - Index</code>.

==== InputPointer ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|AinbString
|Name
|-
|0x4
|0x4
|AinbString
|Class Name
|-
|0x8
|0x2
|s16
|Input Element Id or Base Multi-Input Id
|-
|0xa
|0x2
|s16
|Input Element Output Plug Id or Multi-Input Count
|-
|0xc
|0x4
|Property Flags
|Flags
|-
|0x10
|0x4
|u32
|
|}

==== Output<T> ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|AinbString : 31
|Name
|-
|
|
|u32 : 1
|
|}

==== OutputPointer ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|AinbString : 31
|Name
|-
|
|
|u32 : 1
|
|-
|0x4
|0x4
|AinbString
|Class Name
|}

==== Input Output Entries ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x10
|Input Output Type Entry
|S32 Entries
|-
|0x10
|0x10
|Input Output Type Entry
|Bool Entries
|-
|0x20
|0x10
|Input Output Type Entry
|Float Entries
|-
|0x30
|0x10
|Input Output Type Entry
|String Entries
|-
|0x40
|0x10
|Input Output Type Entry
|Vector3f Entries
|-
|0x50
|0x10
|Input Output Type Entry
|Pointer Entries
|}

===== Input Output Type Entry =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Input Base Index - base index into the Input Output Table's Input<T> array for the specified type
|-
|0x4
|0x4
|u32
|Input Count
|-
|0x8
|0x4
|u32
|Output Base Index - base index into the Input Output Table's Output<T> array for the specified type
|-
|0x10
|0x4
|u32
|Output Count
|}

=== Element Array ===
The node array immediately follows the command array and is an array of all nodes in the file.
{| class="wikitable"
|+Node Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x02
|u16
|Element Type
|-
|0x02
|0x02
|u16
|Element Id - Index of this element within the element array
|-
|0x04
|0x02
|u16
|Attachment Count
|-
|0x06
|0x01
|bitfield
|Element Flags
|-
|0x07
|0x01
|u8
|
|-
|0x08
|0x04
|AinbString
|Element Type Name (for ApplicationDefined nodes)
|-
|0x0C
|0x04
|u32
|Name Hash (version 0x407+)
|-
|0x10
|0x04
|u32
|
|-
|0x14
|0x04
|AinbPtr<ElementParam<Element Type>>
|Element Param
|-
|0x18
|0x02
|u16
|EXB Function Count
|-
|0x1A
|0x02
|u16
|EXB Input/Output Field Size
|-
|0x1C
|0x02
|u16
|Multi-Input Count
|-
|0x1E
|0x02
|u16
|
|-
|0x20
|0x04
|u32
|Base Attachment Id
|-
|0x24
|0x02
|u16
|Base Query Element Id
|-
|0x26
|0x02
|u16
|Query Element Count
|-
|0x28
|0x02
|u16
|0x58 Section Entry Offset (relative to the start of the file)
|-
|0x2A
|0x02
|u16
|
|-
|0x2C
|0x10
|Guid
|Guid
|}
Just like with commands, node GUIDs are only used for debug messages. The 0x58 section entry offset will be empty if unused.

==== Element Type ====
{| class="wikitable"
|+Element Types
!Value (Hex)
!Value (Dec)
!Node Type
|-
|0x00
|0
|Application Defined
|-
|0x01
|1
|Element_S32Selector
|-
|0x02
|2
|Element_Sequential
|-
|0x03
|3
|Element_Simultaneous
|-
|0x04
|4
|Element_F32Selector
|-
|0x05
|5
|Element_StringSelector
|-
|0x06
|6
|Element_RandomSelector
|-
|0x07
|7
|Element_BoolSelector
|-
|0x08
|8
|Element_Fork
|-
|0x09
|9
|Element_Join
|-
|0x0A
|10
|Element_Alert
|-
|0x14
|20
|Element_Expression
|-
|0x64
|100
|Element_ModuleIF_Input_S32
|-
|0x65
|101
|Element_ModuleIF_Input_F32
|-
|0x66
|102
|Element_ModuleIF_Input_Vec3f
|-
|0x67
|103
|Element_ModuleIF_Input_String
|-
|0x68
|104
|Element_ModuleIF_Input_Bool
|-
|0x69
|105
|Element_ModuleIF_Input_Ptr
|-
|0xC8
|200
|Element_ModuleIF_Output_S32
|-
|0xC9
|201
|Element_ModuleIF_Output_F32
|-
|0xCA
|202
|Element_ModuleIF_Output_Vec3f
|-
|0xCB
|203
|Element_ModuleIF_Output_String
|-
|0xCC
|204
|Element_ModuleIF_Output_Bool
|-
|0xCD
|205
|Element_ModuleIF_Output_Ptr
|-
|0x012C
|300
|Element_ModuleIF_Child
|-
|0x0190
|400
|Element_StateEnd
|-
|0x01F4
|500
|Element_SplitTiming
|}
Element type names are official (outside ApplicationDefined). For ApplicationDefined elements, definitions can be found in a node definition file for the respective file category. This file is located at <code>NodeDefinition/Node.Product.[ver].aidefn.byml.zs</code> in the corresponding file category folder.
{| class="wikitable"
|+Node Type Descriptions
!Type
!Description
|-
|UserDefined
|Custom node type, definition in NodeDefinition
|-
|Element_S32Selector
|Conditionally links to a node depending on the value of a signed int
|-
|Element_Sequential
|Links to nodes sequentially in the order listed
|-
|Element_Simultaneous
|Links simultaneously to multiple nodes
|-
|Element_F32Selector
|Conditionally links to a node depending on the value of 32-bit float
|-
|Element_StringSelector
|Conditionally links to a node depending on the value of a string
|-
|Element_RandomSelector
|Links to a node randomly
|-
|Element_BoolSelector
|Conditionally links to a node depending on the value of a bool
|-
|Element_Fork
|See Active Node Update Array
|-
|Element_Join
|See Active Node Update Array
|-
|Element_Alert
|Displays a debug message
|-
|Element_Expression
|Passes values to and from EXB commands
|-
|Element_ModuleIF_Input_S32
|Receives a signed int input from the calling AINB file
|-
|Element_ModuleIF_Input_F32
|Receives a 32-bit float input from the calling AINB file
|-
|Element_ModuleIF_Input_Vec3f
|Receives a vector3f input from the calling AINB file
|-
|Element_ModuleIF_Input_String
|Receives a string input from the calling AINB file
|-
|Element_ModuleIF_Input_Bool
|Receives a bool input from the calling AINB file
|-
|Element_ModuleIF_Input_Ptr
|Receives an object pointer input from the calling AINB file
|-
|Element_ModuleIF_Output_S32
|Returns a signed int output from the module to the calling AINB file
|-
|Element_ModuleIF_Output_F32
|Returns a 32-bit float output from the module to the calling AINB file
|-
|Element_ModuleIF_Output_Vec3f
|Returns a vector3f output from the module to the calling AINB file
|-
|Element_ModuleIF_Output_String
|Returns a string output from the module to the calling AINB file
|-
|Element_ModuleIF_Output_Bool
|Returns a bool output from the module to the calling AINB file
|-
|Element_ModuleIF_Output_Ptr
|Returns an object pointer output from the module to the calling AINB file
|-
|Element_ModuleIF_Child
|Returns the node connection name from the module to the calling AINB file
|-
|Element_StateEnd
|Termination node, specifies what resident node to return to in the calling AINB file
|-
|Element_SplitTiming
|Changes when child nodes are run (Enter - first time visiting a node, Update - every frame, Leave - ran upon leaving the node)
|}

==== Element Flags ====
{| class="wikitable"
|+Element Flags
!Bits
!Description
|-
|1
|Is Query Element
|-
|1
|Is Module Caller
|-
|1
|Is Resident Initialized
|-
|1
|Is Query Multi-Input
|-
|4
|
|}

==== ElementParam<T> ====
Each element contains a table into the 4 parameter types, properties, inputs, outputs, and plugs. The child plugs inform the structure of the element tree.
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x30
|Property Entries
|Entries into the Property Table.
|-
|0x30
|0x60
|Input Output Entries
|Entries into the Input Output Table.
|-
|0x90
|0x14
|Plug Entries
|Entries into the following plug pointer array.
|-
|0xa4
|AsbPtr<>[Total Plug Count]
|Plug Data
|Plug Data Pointer Array.
|}

===== Plug Entries =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x2
|Plug Type Entry
|Bool/float Input Source/Output Source
|-
|0x2
|0x2
|Plug Type Entry
|
|-
|0x4
|0x2
|Plug Type Entry
|Child Plugs
|-
|0x6
|0x2
|Plug Type Entry
|Jump Plugs
|-
|0x8
|0x2
|Plug Type Entry
|String Input Source
|-
|0xa
|0x2
|Plug Type Entry
|Int Input Source
|-
|0xc
|0x2
|Plug Type Entry
|
|-
|0xe
|0x2
|Plug Type Entry
|
|-
|0x10
|0x2
|Plug Type Entry
|
|-
|0x12
|0x2
|Plug Type Entry
|
|}

====== Plug Type Entry ======
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x1
|u8
|Count
|-
|0x1
|0x1
|u8
|Base Index - base index into Plug Pointer Array
|}

====== Plugs ======
{| class="wikitable"
|+
Typical Plug Data
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Element Id
|-
|0x04
|0x04
|u32
|Value
|}
The interpretation of the value depends on the connection type. For input or output connections, the value is a string of the parameter name. For standard connections, the value is a string of the connection name. For jump connections, the value is an id into the Jump Table. Elements are free to extend the plug data with their own element specific values. For built-in element selector-types, excluding <code>Element_BoolSelector</code> and <code>Element_F32Selector</code>, an extra four bytes stores data used to select the child plug. For <code>Element_S32Selector</code>, this is an immediate value. For <code>Element_RandomSelector</code>, this is a weight and for <code>Element_StringSelector</code> it is a string. The condition for <code>Element_BoolSelector</code> is the entry's value string. <code>Element_F32Selector</code> adds 24 bytes to each entry, consisting of four eight-byte sub-entries.
{| class="wikitable"
|+<code>Element_F32Selector Condition Entry</code>
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Local Blackboard Parameter Index and Flags
|-
|0x04
|0x04
|float
|Condition Value
|}
The first two bytes of the four bytes at offset 0x00 are the blackboard parameter index while the last bit is whether or not the index is used or not. The first entry for <code>Element_F32Selector</code> is the minimum value condition while the second entry is the maximum value condition. The last two entries appear to be unused. The last child element entry for Selector-type nodes is the default case. The condition for this case is either the string その他 ("Other") or 0 (in the case of <code>Element_S32Selector</code>). Input elements that are Selector-type elements also appear to have an additional eight bytes (purpose unknown). <code>Element_Expression</code> has an additional eight bytes per input element (16 bytes in the case of vector3f entries). The purpose of these bytes is unknown.

=== Blackboard ===
This section contains an array of the Blackboard parameters used by file. These parameters may be sourced from external Blackboards or parameter files. The section begins with a 0x30 byte section header followed by the array of parameters, an array of default values of said parameters, and an array of file references if applicable. The order of parameters is in the order of string, int, float, bool, vector3f, and pointer. The section header contains six entries, one for each type.
{| class="wikitable"
|+Section Header Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x02
|u16
|Number of Entries of the Corresponding Data Type
|-
|0x02
|0x02
|u16
|Parameter Index of the First Entry of the Corresponding Data Type
|-
|0x04
|0x02
|u16
|Relative Offset of the First Entry of the Corresponding Data Type
|-
|0x06
|0x02
|u16
|
|}
{| class="wikitable"
|+Local Blackboard Parameter Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|bitfield
|Name Offset and Flags
|-
|0x04
|0x04
|u32
|String Offset (Notes)
|}
{| class="wikitable"
|+Name Offset Flags
!Bits
!Description
|-
|22
|Name Offset
|-
|1
|
|-
|1
|Does Not Have File Reference
|-
|7
|File Reference Index
|-
|1
|Is File Reference Valid
|}
The default value entries vary based on the parameter's data type. For int, float, and bool parameters, the entry is a four byte immediate value. String entries are a four byte string value offset. Vector3f entries are 12 bytes. Note that pointer parameters do not have default value entries and do not have default values.
{| class="wikitable"
|+File Reference Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|File Path Offset
|-
|0x04
|0x04
|u32
|File Path Hash
|-
|0x08
|0x04
|u32
|Filename Hash (no extension)
|-
|0x0C
|0x04
|u32
|File Extension Hash (no .)
|}

=== Attachments ===
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|AinbString
|Name
|-
|0x04
|0x04
|AinbPtr<Attachment Param>
|Parameters Entry Offset
|-
|0x08
|0x02
|u16
|EXB Function Count
|-
|0x0A
|0x02
|u16
|EXB Input/Output Field Size
|-
|0x0C
|0x04
|u32
|Name Hash (version 0x407+)
|}

==== Attachment Param ====
{| class="wikitable"
|}
{| class="wikitable"
|+Parameter Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x1
|u8
|Unknown (possibly related to debug)
|-
|0x01
|0x3
|u24
|
|-
|0x4
|0x30
|Property Entries
|Property Entries
|}
{| class="wikitable"
|}

=== Multi-Input ===
{| class="wikitable"
|+Multi-Input Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x02
|u16
|Input Element Id
|-
|0x02
|0x02
|u16
|Input Element Output Plug Id
|-
|0x04
|0x04
|u32
|Flags
|}

=== Jump ===
{| class="wikitable"
|+
!Bits
!Description
|-
|8
|Is Valid Update
|-
|23
|
|-
|1
|Update Post Calc
|}
If the first byte of the flags is set to false, then the entry contains another four bytes with a string offset (purpose unknown). Otherwise, the entry is considered valid if the first byte equals 1. When evaluating the behavior trees, the game maintains an array of each root element. When a command is set, the root element of the command is set to this context. A jump will change that root element to the element specified by the jump plug's element id. This usually happens right before the next command's calculation occurs, but if the top bit is set, then it will occur immediately after the current command's calculation finishes (if the source element is an Element_Join, it will always update the root elements post current command calculation). This is primarily used for "subroutines" that run a single time then return to the main execution routine. Element_Fork and Element_Join are the main mechanism to manage multiple root elements. An Element_Fork will replace the current root elements with the element id's of it's jump plugs, possibly "forking" execution into multiple roots. The element at the end of a root element specified by an Element_Fork will optionally have a jump plug referencing a specific Element_Join. Each of these elements will push the Element_Join into the root element array. However, Element_Join has a property parameter called InFlowNum, and until that element has been pushed onto the root element array that many times in a single calculation, it will not activate and remain dormant. However, once this threshold is reached, it will begin execution (with a guard to make sure only one of the instances added to the array will execute).

=== 0x50 Section ===
This section is unused in ''Tears of the Kingdom''.

=== Query Element Id Array ===
This section is an array of entries of query element ids present in the file.
{| class="wikitable"
|+Query Node Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x02
|u16
|Query Element Id (local to number of query nodes)
|-
|0x02
|0x02
|u16
|
|}

=== Expression Binary ===
The '''EXB''' ('''Ex'''pression '''B'''inary) section is a completely self-contained section that stores custom instructions for a simple command processor. These instructions are grouped into functions that can be called by nodes to perform calculations. Because the section is self-contained, all offsets in this section are local to the section. The EXB section is shared with ASB files ('''A'''nimation '''S'''equence '''B'''inary).

===== Section Structure =====
EXB is essentially its own format and allows for the storage of custom functions in files.

====== Section Order ======

# 0x2C-Byte Header
# Command Info Table
# Instructions Table
# Parameter Region
# Signature Table
# String Pool

===== Sub-Sections =====

====== Header ======
{| class="wikitable"
|+EXB Header
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|char[4]
|Magic - “EXB “
|-
|0x04
|0x04
|u32
|Version (0x02)
|-
|0x08
|0x04
|u32
|Static Memory Allocation Size
|-
|0x0C
|0x04
|u32
|Parameter EXB Field Entry Count
|-
|0x10
|0x04
|u32
|32-bit Scratch Allocation Size
|-
|0x14
|0x04
|u32
|64-bit Scratch Allocation Size
|-
|0x18
|0x04
|u32
|Command Info Offset
|-
|0x1C
|0x04
|u32
|Command Table Offset
|-
|0x20
|0x04
|u32
|Signature Table Offset
|-
|0x24
|0x04
|u32
|Parameter Region Offset
|-
|0x28
|0x04
|u32
|String Pool Offset
|}

====== Command Info Table ======
This section contains an array of command (function) info entries. The first four bytes specify the entry count.
{| class="wikitable"
|+Command Info Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|s32
|Base Index Pre-Command Entry
|-
|0x04
|0x04
|u32
|Pre-Entry Static Memory Usage
|-
|0x08
|0x04
|u32
|Instruction Base Index
|-
|0x0C
|0x04
|u32
|Instruction Count
|-
|0x10
|0x04
|u32
|Static Memory Size
|-
|0x14
|0x02
|u16
|32-bit Scratch Memory Size
|-
|0x16
|0x02
|u16
|64-bit Scratch Memory Size
|-
|0x18
|0x02
|u16
|Output Data Type Enum
|-
|0x1A
|0x02
|u16
|Input Data Type Enum
|}
{| class="wikitable"
|+Data Type Enum
!Value (Hex)
!Value (Dec)
!Data Type
|-
|0x0
|0
|No Data
|-
|0x1
|1
|Immediate Value/From User
|-
|0x02
|2
|bool
|-
|0x03
|3
|int
|-
|0x04
|4
|float
|-
|0x05
|5
|string
|-
|0x06
|6
|vector3f
|}

====== Instructions Table ======
This section contains an array of instruction entries which are read by the EXB command processor. The first four bytes specify the entry count.
{| class="wikitable"
|+Instruction Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x01
|u8
|Instruction Type
|-
|0x01
|0x01
|u8
|Data Type Enum
|-
|0x02
|0x01
|u8
|Left-Hand Side Parameter Source Enum
|-
|0x03
|0x01
|u8
|Right-Hand Side Parameter Source Enum
|-
|0x04
|0x02
|u16
|Left-Hand Side Parameter Value
|-
|0x06
|0x02
|u16
|Right-Hand Side Parameter Value
|}
For UserDefined type instructions, the bytes at offset 0x02-0x04 become a u16 static memory index and the bytes at 0x04-0x08 become a u32 index into the function signatures table.
{| class="wikitable"
|+Instruction Types
!Value (Hex)
!Value (Dec)
!Instruction Type
|-
|0x01
|1
|Terminator
|-
|0x02
|2
|Store
|-
|0x03
|3
|Negate
|-
|0x04
|4
|NegateBool
|-
|0x05
|5
|Add
|-
|0x06
|6
|Subtract
|-
|0x07
|7
|Multiply
|-
|0x08
|8
|Divide
|-
|0x09
|9
|Modulus
|-
|0x0A
|10
|Increment
|-
|0x0B
|11
|Decrement
|-
|0x0C
|12
|ScalarMultiplyVec3f
|-
|0x0D
|13
|ScalarDivideVec3f
|-
|0x0E
|14
|LeftShift
|-
|0x0F
|15
|RightShift
|-
|0x10
|16
|LessThan
|-
|0x11
|17
|LessThanEqual
|-
|0x12
|18
|GreaterThan
|-
|0x13
|19
|GreaterThanEqual
|-
|0x14
|20
|Equal
|-
|0x15
|21
|NotEqual
|-
|0x16
|22
|AND
|-
|0x17
|23
|XOR
|-
|0x18
|24
|OR
|-
|0x19
|25
|LogicalAND
|-
|0x1A
|26
|LogicalOR
|-
|0x1B
|27
|UserFunction
|-
|0x1C
|28
|JumpIfLHSZero
|-
|0x1D
|29
|Jump
|}
UserFunctions are mapped to a function in the executable by function signature. There are two types of these functions: direct and object. Direct functions are straightforward functions that take up to two arguments and are matched using the function signature. Function objects can take additional arguments and are indexed at runtime.

{| class="wikitable"
|+Data Type Enum
!Value (Hex)
!Value (Dec)
!Data Type
|-
|0x0
|0
|No Data
|-
|0x1
|1
|Immediate Value/From User
|-
|0x02
|2
|bool
|-
|0x03
|3
|int
|-
|0x04
|4
|float
|-
|0x05
|5
|string
|-
|0x06
|6
|vector3f
|}
{| class="wikitable"
|+Parameter Source Enum
!Value (Hex)
!Value (Dec)
!Parameter Source
|-
|0x00
|0
|Immediate Parameters
|-
|0x01
|1
|Immediate Parameters (String)
|-
|0x02
|2
|Static Memory
|-
|0x03
|3
|Parameters Region
|-
|0x04
|4
|Parameters Region (String)
|-
|0x05
|5
|Output Value
|-
|0x06
|6
|Input Value
|-
|0x07
|7
|32-bit Scratch
|-
|0x08
|8
|64-bit Scratch
|-
|0x09
|9
|UserOutput
|-
|0x0A
|10
|UserInput
|}
UserCallback is a class that contains virtual functions providing memory allocation. The input value is passed from the calling node and the output value is passed back.

====== Parameter Region ======
The parameter region is a region that stores the values for parameters values that are too large to fit into two bytes. Parameters that get their values from this section instead store an offset relative to the beginning of the parameter region to the start of the value.

====== Signatures Table ======
This section is an array of u32 string offsets for each function signature.

====== String Pool ======
The string pool is an array of null-terminated strings encoded with UTF-8. All string offsets in this section are relative to the beginning of the string pool.

=== Module Caller ===
This section contains an array of all AINB modules linked to the current AINB file. The first four bytes specify the entry count.
{| class="wikitable"
|+AINB Module Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|File Path Offset
|-
|0x04
|0x04
|u32
|File Category Offset
|-
|0x08
|0x04
|u32
|AINB File Count
|}

=== External Action Array ===
This section appears to interact with XLink. The first four bytes specify the entry count.
{| class="wikitable"
|+Entry String Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Node Index
|-
|0x04
|0x04
|u32
|String 1 Offset (always メインステート ("Main State"))
|-
|0x08
|0x04
|u32
|State Name Offset
|}

=== Module Caller Link ===
This section contains two 32-bit file hashes. The first hash is a hash for the file itself and the second hash appears to be a hash for that file's parent file. These are used by Element_ModuleCaller.

=== Child Replacement Table ===
This section is used to remove or replace specific elements or attachments at runtime. This is used to toggle off debug elements/attachments in release builds. The section begins with an eight-byte section header.
{| class="wikitable"
|+Child Replacement Section Header
!Offset
!Size
!Type
!Description
|-
|0x00
|0x01
|u8
|Initialization Guard (Is Initialized)
|-
|0x01
|0x01
|u8
|
|-
|0x02
|0x02
|u16
|Replacement Count
|-
|0x04
|0x02
|s16
|Override Element Count
|-
|0x06
|0x02
|s16
|Override Attachment Parameter Count
|}
{| class="wikitable"
|+Child Replacement Table Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x01
|u8
|Replacement Type Enum (0 = remove child element, 1 = replace child element, 2 = remove attachment)
|-
|0x01
|0x01
|u8
|
|-
|0x02
|0x02
|u16
|Element Id
|-
|0x04
|0x02
|u16
|Child Element Id/Attachment Id
|-
|0x06
|0x02
|u16
|New Element Id (for child element replacements)
|}

=== 0x6C Section ===
This section is unused in ''Tears of the Kingdom''.

=== Enum Relocation ===
This section is used to resolve enum values at runtime. This section is unused in ''Tears of the Kingdom'' as all enum values are statically present in the file. However, in ''Splatoon 3'', this section is used extensively as all enum values are stored in the main executable. The first four bytes of this section specifies the number of entries in the section.
{| class="wikitable"
|+Enum Resolve Array Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Enum Value Offset
|-
|0x04
|0x04
|u32
|Enum Class Name Offset
|-
|0x08
|0x04
|u32
|Enum Value Name Offset
|}

=== String Pool ===
The string pool is an array of null-terminated strings encoded with UTF-8. All string offsets in the file are relative to the first byte of this section. Note that this section also contains some unreferenced strings which are the enums for certain parameters.
[[Category:File formats]]

AINB

2026-01-08T03:38:15Z

Watertoon: Minor corrections

'''AINB''' ('''AI''' '''N'''ode '''B'''inary) is a file format implementing behavior trees for game-specific code. At time of writing it has only appeared in titles on the ModuleSystem game engine. This article is primarily aimed at the version that appears in ''Tears of the Kingdom,'' ''Super Mario Bros. Wonder, Mario vs Donkey Kong,'' and the original October 2024 version of ''Nintendo Switch Online: Playtest Program'' (v0x407). ModuleSystem provides 3 built-in file categories that appear in their own dedicated folders in a title's romfs, being "AI" for actor behavior, "Logic" for actor ai group behavior, and "Sequence" for scene behavior, individual games are free to create their own file categories.

=== Version Table ===
{| class="wikitable"
|+
!Version
!Applications
!Differences From Previous
|-
|0x404
|''Nintendo Switch Sports, Splatoon 3''
|
|-
|0x407
|''The Legend of Zelda: Tears of the Kingdom, Super Mario Bros. Wonder, Mario Vs Donkey Kong, Nintendo Switch Online: Playtest Program (010)''
|
|-
|0x408
|''Nintendo Switch Online: Playtest Program (021)''
|>Now uses exb version 3 (u32 support)
>Added u32 type to blackboard
|}

== File Structure ==
AINB assumes little endian. Hashes can be assumed to be 32-bit Murmur3 unless otherwise specified.

An AINB file defines a set of commands to evaluate a tree of built-in or game-specific node classes. The built-in "Element_ModuleCaller" node and supporting structures allow a "root" AINB file to call out to an external "module" AINB file, module's can call further modules, allowing AINB files to form a tree of tree's. An AINB's file extension typically designates whether it is a root <code>.root.ainb</code> or module <code>.module.ainb</code>. For AI and Sequence files, the file's entry point is one or more commands which is linked to one or two child nodes. All nodes are accessed by their index (references to query nodes will use their query node index which is local to the amount of query nodes in the file).

All string offsets in the file are relative to the beginning of the string pool and name hashes are 32-bit murmur3 hashes. There are six possible data types for AINB parameters: int (signed 32-bit integer), bool, float (32-bit), vector3f, and pointer. Pointer parameters are pointers to objects.

=== Section Order ===

==== Version 0x407 ====
# File Header (0x74)
# Command Array
# Element Array
# Blackboard
# Element Param Region
# Attachment Parameters
# Property Parameters
# Input/Output Parameters
# Multi-Inputs
# Jump Array
# 0x50 Section (Unused in ''TotK'')
# Query Id Array
# Expression Binary
# AINB Modules
# External Action Array
# File Hashes
# Child Replacement Table
# 0x6C Section
# Enum Resolve Array
# String Pool

== Structures ==

=== Helpers ===

==== AinbString ====
Represents a u32 offset relative to a null-terminated string from the start of the file's string pool.

==== AinbPtr<T> ====
Represents a u32 absolute offset from the start of the file to the struct of type "T" enclosed by <>.

==== AinbArray<T> ====
Represents a u32 absolute offset from the start of the file to:
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Count
|-
|0x4
|
|T[Count]
|Array of struct of type T. Note; asb files only use 32-bit aligned types.
|}

=== File Header ===
AINB files begin with a 0x74 byte header. If the offset for a given section is empty, that section is not present in the file.
{| class="wikitable"
|+File Header
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|char[4]
|Magic - “AIB “
|-
|0x04
|0x04
|u32
|Version
|-
|0x08
|0x04
|AinbString
|Filename
|-
|0x0C
|0x04
|u32
|Command Count
|-
|0x10
|0x04
|u32
|Element Count
|-
|0x14
|0x04
|u32
|Query Element Count
|-
|0x18
|0x04
|u32
|Attachment Count
|-
|0x1C
|0x04
|u32
|Output Element Count
|-
|0x20
|0x04
|AinbPtr<Blackboard>
|Blackboard
|-
|0x24
|0x04
|AinbPtr<char>
|String Pool
|-
|0x28
|0x04
|AinbPtr<AinbArray<Enum Relocation>>
|Enum Relocation Array
|-
|0x2C
|0x04
|AinbPtr<Property Table>
|Property Table
|-
|0x30
|0x04
|AinbPtr<Jump[]>
|Jump Table
|-
|0x34
|0x04
|AinbPtr<Input Output Table>
|Input/Output Table
|-
|0x38
|0x04
|AinbPtr<Multi Input[]>
|Multi-Input Array
|-
|0x3C
|0x04
|AinbPtr<Attachment[Attachment Count]>
|Attachment Array
|-
|0x40
|0x04
|AinbPtr<u32[]>
|Attachment Id Array
|-
|0x44
|0x04
|AinbPtr<Exb>
|Expression Binary
|-
|0x48
|0x04
|u32
|Child Replacement Table
|-
|0x4C
|0x04
|AinbPtr<u32[]>
|Query Element Id Array
|-
|0x50
|0x04
|u32
|Unknown (unused in ''TotK'', always the same as the Active Node Update Array Offset)
|-
|0x54
|0x04
|u32
|Unknown (always 0)
|-
|0x58
|0x04
|u32
|Unknown (always 0, used in ''Splatoon 3''/''Nintendo Switch Sports'')
|-
|0x5C
|0x04
|AinbPtr<AinbArray<Module Caller>>
|Module Caller Array
|-
|0x60
|0x04
|AinbString
|File Category Name
|-
|0x64
|0x04
|u32
|File Category? (0 = AI, 1 = Logic, 2 = Sequence) (''Splatoon 3'' game specific, 3 = UniqueSequenceSPL)
|-
|0x68
|0x04
|AinbPtr<AinbArray<External Action>>
|External Action Array
|-
|0x6C
|0x04
|u32
|Unknown (Unused in ''TotK'')
|-
|0x70
|0x04
|AinbPtr<Module Caller Link>
|Module Caller Link
|}

=== Command Array ===
The command array immediately follows the file header and is an array of all commands in the file.
{| class="wikitable"
|+Command Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|AinbString
|Name
|-
|0x04
|0x10
|Guid
|Guid
|-
|0x14
|0x02
|u16
|Main Element Id
|-
|0x16
|0x02
|u16
|Secondary Element Id (value offset by 1, 0 is reserved for invalid)
|}
Unlike asb, command GUIDs only appear to be used for debug messages. Secondary Element Id will be -1 if the command only has one child element.

=== Property Table ===
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|AsbPtr<Property<s32>[]>
|Property Array
|-
|0x04
|0x04
|AsbPtr<Property<bool>[]>
|Property Array
|-
|0x08
|0x04
|AsbPtr<Property<float>[]>
|Property Array
|-
|0x0c
|0x04
|AsbPtr<Property<AinbString>[]>
|Property Array
|-
|0x10
|0x04
|AsbPtr<Property<Vector3f>[]>
|Property Array
|-
|0x14
|0x04
|AsbPtr<PropertyPointer[]>
|Property Array
|}

==== Property<T> ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|AinbString
|Name
|-
|0x4
|0x4
|Property Flags
|Flags
|-
|0x8
|0x4, or 0xc
|T
|Immediate Value
|}

===== Property Flags =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32 : 16
|Index
|-
|
|
|u32 : 1
|Is Use Index
|-
|
|
|u32 : 1
|Is Not Local Blackboard Index
|-
|
|
|u32 : 1
|
|-
|
|
|u32 : 1
|
|-
|
|
|u32 : 1
|
|-
|
|
|u32 : 1
|
|-
|
|
|u32 : 1
|Is EXB Index
|-
|
|
|u32 : 1
|Pulse Thread Local Storage
|-
|
|
|u32 : 1
|Set Pointer Flag Bit Zero
|-
|
|
|u32 : 7
|
|}

==== PropertyPointer ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|AinbString
|Name
|-
|0x4
|0x4
|AinbString
|Class Name
|-
|0x8
|0x4
|Property Flags
|Flags
|}

==== Property Entries ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property Type Entry
|S32 Entries
|-
|0x8
|0x8
|Property Type Entry
|Bool Entries
|-
|0x10
|0x8
|Property Type Entry
|Float Entries
|-
|0x18
|0x8
|Property Type Entry
|String Entries
|-
|0x20
|0x8
|Property Type Entry
|Vector3f Entries
|-
|0x28
|0x8
|Property Type Entry
|Pointer Entries
|}

===== Property Type Entry =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Base Index - base index into the Property Table's Property Array for the specified type
|-
|0x4
|0x4
|u32
|Count
|}

=== Input Output Table ===
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|AsbPtr<Input<s32>[]>
|Input Array
|-
|0x04
|0x04
|AsbPtr<Output<s32>[]>
|Output Array
|-
|0x08
|0x04
|AsbPtr<Input<bool>[]>
|Input Array
|-
|0x0c
|0x04
|AsbPtr<Output<bool[]>
|Output Array
|-
|0x10
|0x04
|AsbPtr<Input<float>[]>
|Input Array
|-
|0x14
|0x04
|AsbPtr<Output<float>[]>
|Output Array
|-
|0x18
|0x04
|AsbPtr<Input<AinbString>[]>
|Input Array
|-
|0x1c
|0x04
|AsbPtr<Output<AinbString>[]>
|Output Array
|-
|0x20
|0x04
|AsbPtr<Input<Vector3f>[]>
|Input Array
|-
|0x24
|0x04
|AsbPtr<Output<Vector3f>[]>
|Output Array
|-
|0x28
|0x04
|AsbPtr<InputPointer[]>
|Input Array
|-
|0x2c
|0x04
|AsbPtr<OutputPointer[]>
|Output Array
|}

==== Input<T> ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|AinbString
|Name
|-
|0x4
|0x2
|s16
|Input Element Id or Base Multi-Input Id
|-
|0x6
|0x2
|s16
|Input Element Output Plug Id or Multi-Input Count
|-
|0x8
|0x4
|Property Flags
|Flags
|-
|0xc
|0x4, or 0xc
|T
|Immediate Value
|}
If the input element id is between -32768 and -100, then the input uses a multi-input. The multi-input id can be calculated as follows: <code>BaseMultiInputIndex = -100 - Index</code>.

==== InputPointer ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|AinbString
|Name
|-
|0x4
|0x4
|AinbString
|Class Name
|-
|0x8
|0x2
|s16
|Input Element Id or Base Multi-Input Id
|-
|0xa
|0x2
|s16
|Input Element Output Plug Id or Multi-Input Count
|-
|0xc
|0x4
|Property Flags
|Flags
|-
|0x10
|0x4
|u32
|
|}

==== Output<T> ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|AinbString : 31
|Name
|-
|
|
|u32 : 1
|
|}

==== OutputPointer ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|AinbString : 31
|Name
|-
|
|
|u32 : 1
|
|-
|0x4
|0x4
|AinbString
|Class Name
|}

==== Input Output Entries ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x10
|Input Output Type Entry
|S32 Entries
|-
|0x10
|0x10
|Input Output Type Entry
|Bool Entries
|-
|0x20
|0x10
|Input Output Type Entry
|Float Entries
|-
|0x30
|0x10
|Input Output Type Entry
|String Entries
|-
|0x40
|0x10
|Input Output Type Entry
|Vector3f Entries
|-
|0x50
|0x10
|Input Output Type Entry
|Pointer Entries
|}

===== Input Output Type Entry =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Input Base Index - base index into the Input Output Table's Input<T> array for the specified type
|-
|0x4
|0x4
|u32
|Input Count
|-
|0x8
|0x4
|u32
|Output Base Index - base index into the Input Output Table's Output<T> array for the specified type
|-
|0x10
|0x4
|u32
|Output Count
|}

=== Element Array ===
The node array immediately follows the command array and is an array of all nodes in the file.
{| class="wikitable"
|+Node Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x02
|u16
|Element Type
|-
|0x02
|0x02
|u16
|Element Id - Index of this element within the element array
|-
|0x04
|0x02
|u16
|Attachment Count
|-
|0x06
|0x01
|bitfield
|Element Flags
|-
|0x07
|0x01
|u8
|
|-
|0x08
|0x04
|AinbString
|Element Type Name (for ApplicationDefined nodes)
|-
|0x0C
|0x04
|u32
|Name Hash (version 0x407+)
|-
|0x10
|0x04
|u32
|
|-
|0x14
|0x04
|AinbPtr<ElementParam<Element Type>>
|Element Param
|-
|0x18
|0x02
|u16
|EXB Function Count
|-
|0x1A
|0x02
|u16
|EXB Input/Output Field Size
|-
|0x1C
|0x02
|u16
|Multi-Input Count
|-
|0x1E
|0x02
|u16
|
|-
|0x20
|0x04
|u32
|Base Attachment Id
|-
|0x24
|0x02
|u16
|Base Query Element Id
|-
|0x26
|0x02
|u16
|Query Element Count
|-
|0x28
|0x02
|u16
|0x58 Section Entry Offset (relative to the start of the file)
|-
|0x2A
|0x02
|u16
|
|-
|0x2C
|0x10
|Guid
|Guid
|}
Just like with commands, node GUIDs are only used for debug messages. The 0x58 section entry offset will be empty if unused.

==== Element Type ====
{| class="wikitable"
|+Element Types
!Value (Hex)
!Value (Dec)
!Node Type
|-
|0x00
|0
|Application Defined
|-
|0x01
|1
|Element_S32Selector
|-
|0x02
|2
|Element_Sequential
|-
|0x03
|3
|Element_Simultaneous
|-
|0x04
|4
|Element_F32Selector
|-
|0x05
|5
|Element_StringSelector
|-
|0x06
|6
|Element_RandomSelector
|-
|0x07
|7
|Element_BoolSelector
|-
|0x08
|8
|Element_Fork
|-
|0x09
|9
|Element_Join
|-
|0x0A
|10
|Element_Alert
|-
|0x14
|20
|Element_Expression
|-
|0x64
|100
|Element_ModuleIF_Input_S32
|-
|0x65
|101
|Element_ModuleIF_Input_F32
|-
|0x66
|102
|Element_ModuleIF_Input_Vec3f
|-
|0x67
|103
|Element_ModuleIF_Input_String
|-
|0x68
|104
|Element_ModuleIF_Input_Bool
|-
|0x69
|105
|Element_ModuleIF_Input_Ptr
|-
|0xC8
|200
|Element_ModuleIF_Output_S32
|-
|0xC9
|201
|Element_ModuleIF_Output_F32
|-
|0xCA
|202
|Element_ModuleIF_Output_Vec3f
|-
|0xCB
|203
|Element_ModuleIF_Output_String
|-
|0xCC
|204
|Element_ModuleIF_Output_Bool
|-
|0xCD
|205
|Element_ModuleIF_Output_Ptr
|-
|0x012C
|300
|Element_ModuleIF_Child
|-
|0x0190
|400
|Element_StateEnd
|-
|0x01F4
|500
|Element_SplitTiming
|}
Element type names are official (outside ApplicationDefined). For ApplicationDefined elements, definitions can be found in a node definition file for the respective file category. This file is located at <code>NodeDefinition/Node.Product.[ver].aidefn.byml.zs</code> in the corresponding file category folder.
{| class="wikitable"
|+Node Type Descriptions
!Type
!Description
|-
|UserDefined
|Custom node type, definition in NodeDefinition
|-
|Element_S32Selector
|Conditionally links to a node depending on the value of a signed int
|-
|Element_Sequential
|Links to nodes sequentially in the order listed
|-
|Element_Simultaneous
|Links simultaneously to multiple nodes
|-
|Element_F32Selector
|Conditionally links to a node depending on the value of 32-bit float
|-
|Element_StringSelector
|Conditionally links to a node depending on the value of a string
|-
|Element_RandomSelector
|Links to a node randomly
|-
|Element_BoolSelector
|Conditionally links to a node depending on the value of a bool
|-
|Element_Fork
|See Active Node Update Array
|-
|Element_Join
|See Active Node Update Array
|-
|Element_Alert
|Displays a debug message
|-
|Element_Expression
|Passes values to and from EXB commands
|-
|Element_ModuleIF_Input_S32
|Receives a signed int input from the calling AINB file
|-
|Element_ModuleIF_Input_F32
|Receives a 32-bit float input from the calling AINB file
|-
|Element_ModuleIF_Input_Vec3f
|Receives a vector3f input from the calling AINB file
|-
|Element_ModuleIF_Input_String
|Receives a string input from the calling AINB file
|-
|Element_ModuleIF_Input_Bool
|Receives a bool input from the calling AINB file
|-
|Element_ModuleIF_Input_Ptr
|Receives an object pointer input from the calling AINB file
|-
|Element_ModuleIF_Output_S32
|Returns a signed int output from the module to the calling AINB file
|-
|Element_ModuleIF_Output_F32
|Returns a 32-bit float output from the module to the calling AINB file
|-
|Element_ModuleIF_Output_Vec3f
|Returns a vector3f output from the module to the calling AINB file
|-
|Element_ModuleIF_Output_String
|Returns a string output from the module to the calling AINB file
|-
|Element_ModuleIF_Output_Bool
|Returns a bool output from the module to the calling AINB file
|-
|Element_ModuleIF_Output_Ptr
|Returns an object pointer output from the module to the calling AINB file
|-
|Element_ModuleIF_Child
|Returns the node connection name from the module to the calling AINB file
|-
|Element_StateEnd
|Termination node, specifies what resident node to return to in the calling AINB file
|-
|Element_SplitTiming
|Changes when child nodes are run (Enter - first time visiting a node, Update - every frame, Leave - ran upon leaving the node)
|}

==== Element Flags ====
{| class="wikitable"
|+Element Flags
!Bits
!Description
|-
|1
|Is Query Element
|-
|1
|Is Module Caller
|-
|1
|Is Resident Initialized
|-
|1
|Is Query Multi-Input
|-
|4
|
|}

==== ElementParam<T> ====
Each element contains a table into the 4 parameter types, properties, inputs, outputs, and plugs. The child plugs inform the structure of the element tree.
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x30
|Property Entries
|Entries into the Property Table.
|-
|0x30
|0x60
|Input Output Entries
|Entries into the Input Output Table.
|-
|0x90
|0x14
|Plug Entries
|Entries into the following plug pointer array.
|-
|0xa4
|AsbPtr<>[Total Plug Count]
|Plug Data
|Plug Data Pointer Array.
|}

===== Plug Entries =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x2
|Plug Type Entry
|Bool/float Input Source/Output Source
|-
|0x2
|0x2
|Plug Type Entry
|
|-
|0x4
|0x2
|Plug Type Entry
|Child Plugs
|-
|0x6
|0x2
|Plug Type Entry
|Jump Plugs
|-
|0x8
|0x2
|Plug Type Entry
|String Input Source
|-
|0xa
|0x2
|Plug Type Entry
|Int Input Source
|-
|0xc
|0x2
|Plug Type Entry
|
|-
|0xe
|0x2
|Plug Type Entry
|
|-
|0x10
|0x2
|Plug Type Entry
|
|-
|0x12
|0x2
|Plug Type Entry
|
|}

====== Plug Type Entry ======
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x1
|u8
|Count
|-
|0x1
|0x1
|u8
|Base Index - base index into Plug Pointer Array
|}

====== Plugs ======
{| class="wikitable"
|+
Typical Plug Data
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Element Id
|-
|0x04
|0x04
|u32
|Value
|}
The interpretation of the value depends on the connection type. For input or output connections, the value is a string of the parameter name. For standard connections, the value is a string of the connection name. For jump connections, the value is an id into the Jump Table. Elements are free to extend the plug data with their own element specific values. For built-in element selector-types, excluding <code>Element_BoolSelector</code> and <code>Element_F32Selector</code>, an extra four bytes stores data used to select the child plug. For <code>Element_S32Selector</code>, this is an immediate value. For <code>Element_RandomSelector</code>, this is a weight and for <code>Element_StringSelector</code> it is a string. The condition for <code>Element_BoolSelector</code> is the entry's value string. <code>Element_F32Selector</code> adds 24 bytes to each entry, consisting of four eight-byte sub-entries.
{| class="wikitable"
|+<code>Element_F32Selector Condition Entry</code>
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Local Blackboard Parameter Index and Flags
|-
|0x04
|0x04
|float
|Condition Value
|}
The first two bytes of the four bytes at offset 0x00 are the blackboard parameter index while the last bit is whether or not the index is used or not. The first entry for <code>Element_F32Selector</code> is the minimum value condition while the second entry is the maximum value condition. The last two entries appear to be unused. The last child element entry for Selector-type nodes is the default case. The condition for this case is either the string その他 ("Other") or 0 (in the case of <code>Element_S32Selector</code>). Input elements that are Selector-type elements also appear to have an additional eight bytes (purpose unknown). <code>Element_Expression</code> has an additional eight bytes per input element (16 bytes in the case of vector3f entries). The purpose of these bytes is unknown.

=== Blackboard ===
This section contains an array of the Blackboard parameters used by file. These parameters may be sourced from external Blackboards or parameter files. The section begins with a 0x30 byte section header followed by the array of parameters, an array of default values of said parameters, and an array of file references if applicable. The order of parameters is in the order of string, int, float, bool, vector3f, and pointer. The section header contains six entries, one for each type.
{| class="wikitable"
|+Section Header Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x02
|u16
|Number of Entries of the Corresponding Data Type
|-
|0x02
|0x02
|u16
|Parameter Index of the First Entry of the Corresponding Data Type
|-
|0x04
|0x02
|u16
|Relative Offset of the First Entry of the Corresponding Data Type
|-
|0x06
|0x02
|u16
|
|}
{| class="wikitable"
|+Local Blackboard Parameter Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|bitfield
|Name Offset and Flags
|-
|0x04
|0x04
|u32
|String Offset (Notes)
|}
{| class="wikitable"
|+Name Offset Flags
!Bits
!Description
|-
|22
|Name Offset
|-
|1
|
|-
|1
|Does Not Have File Reference
|-
|7
|File Reference Index
|-
|1
|Is File Reference Valid
|}
The default value entries vary based on the parameter's data type. For int, float, and bool parameters, the entry is a four byte immediate value. String entries are a four byte string value offset. Vector3f entries are 12 bytes. Note that pointer parameters do not have default value entries and do not have default values.
{| class="wikitable"
|+File Reference Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|File Path Offset
|-
|0x04
|0x04
|u32
|File Path Hash
|-
|0x08
|0x04
|u32
|Filename Hash (no extension)
|-
|0x0C
|0x04
|u32
|File Extension Hash (no .)
|}

=== Attachments ===
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|AinbString
|Name
|-
|0x04
|0x04
|AinbPtr<Attachment Param>
|Parameters Entry Offset
|-
|0x08
|0x02
|u16
|EXB Function Count
|-
|0x0A
|0x02
|u16
|EXB Input/Output Field Size
|-
|0x0C
|0x04
|u32
|Name Hash (version 0x407+)
|}

==== Attachment Param ====
{| class="wikitable"
|}
{| class="wikitable"
|+Parameter Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x1
|u8
|Unknown (possibly related to debug)
|-
|0x01
|0x3
|u24
|
|-
|0x4
|0x30
|Property Entries
|Property Entries
|}
{| class="wikitable"
|}

=== Multi-Input ===
{| class="wikitable"
|+Multi-Input Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x02
|u16
|Node Index
|-
|0x02
|0x02
|u16
|Input/Output Source Parameter Index
|-
|0x04
|0x04
|u32
|Flags
|}

=== Jump ===
{| class="wikitable"
|+
!Bits
!Description
|-
|8
|Is Valid Update
|-
|23
|
|-
|1
|Update Post Calc
|}
If the first byte of the flags is set to false, then the entry contains another four bytes with a string offset (purpose unknown). Otherwise, the entry is considered valid if the first byte equals 1. When evaluating the behavior trees, the game maintains an array of each root element. When a command is set, the root element of the command is set to this context. A jump will change that root element to the element specified by the jump plug's element id. This usually happens right before the next command's calculation occurs, but if the top bit is set, then it will occur immediately after the current command's calculation finishes (if the source element is an Element_Join, it will always update the root elements post current command calculation). This is primarily used for "subroutines" that run a single time then return to the main execution routine. Element_Fork and Element_Join are the main mechanism to manage multiple root elements. An Element_Fork will replace the current root elements with the element id's of it's jump plugs, possibly "forking" execution into multiple roots. The element at the end of a root element specified by an Element_Fork will optionally have a jump plug referencing a specific Element_Join. Each of these elements will push the Element_Join into the root element array. However, Element_Join has a property parameter called InFlowNum, and until that element has been pushed onto the root element array that many times in a single calculation, it will not activate and remain dormant. However, once this threshold is reached, it will begin execution (with a guard to make sure only one of the instances added to the array will execute).

=== 0x50 Section ===
This section is unused in ''Tears of the Kingdom''.

=== Query Element Id Array ===
This section is an array of entries of query element ids present in the file.
{| class="wikitable"
|+Query Node Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x02
|u16
|Query Element Id (local to number of query nodes)
|-
|0x02
|0x02
|u16
|
|}

=== Expression Binary ===
The '''EXB''' ('''Ex'''pression '''B'''inary) section is a completely self-contained section that stores custom instructions for a simple command processor. These instructions are grouped into functions that can be called by nodes to perform calculations. Because the section is self-contained, all offsets in this section are local to the section. The EXB section is shared with ASB files ('''A'''nimation '''S'''equence '''B'''inary).

===== Section Structure =====
EXB is essentially its own format and allows for the storage of custom functions in files.

====== Section Order ======

# 0x2C-Byte Header
# Command Info Table
# Instructions Table
# Parameter Region
# Signature Table
# String Pool

===== Sub-Sections =====

====== Header ======
{| class="wikitable"
|+EXB Header
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|char[4]
|Magic - “EXB “
|-
|0x04
|0x04
|u32
|Version (0x02)
|-
|0x08
|0x04
|u32
|Static Memory Allocation Size
|-
|0x0C
|0x04
|u32
|Parameter EXB Field Entry Count
|-
|0x10
|0x04
|u32
|32-bit Scratch Allocation Size
|-
|0x14
|0x04
|u32
|64-bit Scratch Allocation Size
|-
|0x18
|0x04
|u32
|Command Info Offset
|-
|0x1C
|0x04
|u32
|Command Table Offset
|-
|0x20
|0x04
|u32
|Signature Table Offset
|-
|0x24
|0x04
|u32
|Parameter Region Offset
|-
|0x28
|0x04
|u32
|String Pool Offset
|}

====== Command Info Table ======
This section contains an array of command (function) info entries. The first four bytes specify the entry count.
{| class="wikitable"
|+Command Info Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|s32
|Base Index Pre-Command Entry
|-
|0x04
|0x04
|u32
|Pre-Entry Static Memory Usage
|-
|0x08
|0x04
|u32
|Instruction Base Index
|-
|0x0C
|0x04
|u32
|Instruction Count
|-
|0x10
|0x04
|u32
|Static Memory Size
|-
|0x14
|0x02
|u16
|32-bit Scratch Memory Size
|-
|0x16
|0x02
|u16
|64-bit Scratch Memory Size
|-
|0x18
|0x02
|u16
|Output Data Type Enum
|-
|0x1A
|0x02
|u16
|Input Data Type Enum
|}
{| class="wikitable"
|+Data Type Enum
!Value (Hex)
!Value (Dec)
!Data Type
|-
|0x0
|0
|No Data
|-
|0x1
|1
|Immediate Value/From User
|-
|0x02
|2
|bool
|-
|0x03
|3
|int
|-
|0x04
|4
|float
|-
|0x05
|5
|string
|-
|0x06
|6
|vector3f
|}

====== Instructions Table ======
This section contains an array of instruction entries which are read by the EXB command processor. The first four bytes specify the entry count.
{| class="wikitable"
|+Instruction Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x01
|u8
|Instruction Type
|-
|0x01
|0x01
|u8
|Data Type Enum
|-
|0x02
|0x01
|u8
|Left-Hand Side Parameter Source Enum
|-
|0x03
|0x01
|u8
|Right-Hand Side Parameter Source Enum
|-
|0x04
|0x02
|u16
|Left-Hand Side Parameter Value
|-
|0x06
|0x02
|u16
|Right-Hand Side Parameter Value
|}
For UserDefined type instructions, the bytes at offset 0x02-0x04 become a u16 static memory index and the bytes at 0x04-0x08 become a u32 index into the function signatures table.
{| class="wikitable"
|+Instruction Types
!Value (Hex)
!Value (Dec)
!Instruction Type
|-
|0x01
|1
|Terminator
|-
|0x02
|2
|Store
|-
|0x03
|3
|Negate
|-
|0x04
|4
|NegateBool
|-
|0x05
|5
|Add
|-
|0x06
|6
|Subtract
|-
|0x07
|7
|Multiply
|-
|0x08
|8
|Divide
|-
|0x09
|9
|Modulus
|-
|0x0A
|10
|Increment
|-
|0x0B
|11
|Decrement
|-
|0x0C
|12
|ScalarMultiplyVec3f
|-
|0x0D
|13
|ScalarDivideVec3f
|-
|0x0E
|14
|LeftShift
|-
|0x0F
|15
|RightShift
|-
|0x10
|16
|LessThan
|-
|0x11
|17
|LessThanEqual
|-
|0x12
|18
|GreaterThan
|-
|0x13
|19
|GreaterThanEqual
|-
|0x14
|20
|Equal
|-
|0x15
|21
|NotEqual
|-
|0x16
|22
|AND
|-
|0x17
|23
|XOR
|-
|0x18
|24
|OR
|-
|0x19
|25
|LogicalAND
|-
|0x1A
|26
|LogicalOR
|-
|0x1B
|27
|UserFunction
|-
|0x1C
|28
|JumpIfLHSZero
|-
|0x1D
|29
|Jump
|}
UserFunctions are mapped to a function in the executable by function signature. There are two types of these functions: direct and object. Direct functions are straightforward functions that take up to two arguments and are matched using the function signature. Function objects can take additional arguments and are indexed at runtime.

{| class="wikitable"
|+Data Type Enum
!Value (Hex)
!Value (Dec)
!Data Type
|-
|0x0
|0
|No Data
|-
|0x1
|1
|Immediate Value/From User
|-
|0x02
|2
|bool
|-
|0x03
|3
|int
|-
|0x04
|4
|float
|-
|0x05
|5
|string
|-
|0x06
|6
|vector3f
|}
{| class="wikitable"
|+Parameter Source Enum
!Value (Hex)
!Value (Dec)
!Parameter Source
|-
|0x00
|0
|Immediate Parameters
|-
|0x01
|1
|Immediate Parameters (String)
|-
|0x02
|2
|Static Memory
|-
|0x03
|3
|Parameters Region
|-
|0x04
|4
|Parameters Region (String)
|-
|0x05
|5
|Output Value
|-
|0x06
|6
|Input Value
|-
|0x07
|7
|32-bit Scratch
|-
|0x08
|8
|64-bit Scratch
|-
|0x09
|9
|UserOutput
|-
|0x0A
|10
|UserInput
|}
UserCallback is a class that contains virtual functions providing memory allocation. The input value is passed from the calling node and the output value is passed back.

====== Parameter Region ======
The parameter region is a region that stores the values for parameters values that are too large to fit into two bytes. Parameters that get their values from this section instead store an offset relative to the beginning of the parameter region to the start of the value.

====== Signatures Table ======
This section is an array of u32 string offsets for each function signature.

====== String Pool ======
The string pool is an array of null-terminated strings encoded with UTF-8. All string offsets in this section are relative to the beginning of the string pool.

=== Module Caller ===
This section contains an array of all AINB modules linked to the current AINB file. The first four bytes specify the entry count.
{| class="wikitable"
|+AINB Module Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|File Path Offset
|-
|0x04
|0x04
|u32
|File Category Offset
|-
|0x08
|0x04
|u32
|AINB File Count
|}

=== External Action Array ===
This section appears to interact with XLink. The first four bytes specify the entry count.
{| class="wikitable"
|+Entry String Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Node Index
|-
|0x04
|0x04
|u32
|String 1 Offset (always メインステート ("Main State"))
|-
|0x08
|0x04
|u32
|State Name Offset
|}

=== Module Caller Link ===
This section contains two 32-bit file hashes. The first hash is a hash for the file itself and the second hash appears to be a hash for that file's parent file. These are used by Element_ModuleCaller.

=== Child Replacement Table ===
This section is used to remove or replace specific elements or attachments at runtime. This is used to toggle off debug elements/attachments in release builds. The section begins with an eight-byte section header.
{| class="wikitable"
|+Child Replacement Section Header
!Offset
!Size
!Type
!Description
|-
|0x00
|0x01
|u8
|Initialization Guard (Is Initialized)
|-
|0x01
|0x01
|u8
|
|-
|0x02
|0x02
|u16
|Replacement Count
|-
|0x04
|0x02
|s16
|Override Element Count
|-
|0x06
|0x02
|s16
|Override Attachment Parameter Count
|}
{| class="wikitable"
|+Child Replacement Table Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x01
|u8
|Replacement Type Enum (0 = remove child element, 1 = replace child element, 2 = remove attachment)
|-
|0x01
|0x01
|u8
|
|-
|0x02
|0x02
|u16
|Element Id
|-
|0x04
|0x02
|u16
|Child Element Id/Attachment Id
|-
|0x06
|0x02
|u16
|New Element Id (for child element replacements)
|}

=== 0x6C Section ===
This section is unused in ''Tears of the Kingdom''.

=== Enum Relocation ===
This section is used to resolve enum values at runtime. This section is unused in ''Tears of the Kingdom'' as all enum values are statically present in the file. However, in ''Splatoon 3'', this section is used extensively as all enum values are stored in the main executable. The first four bytes of this section specifies the number of entries in the section.
{| class="wikitable"
|+Enum Resolve Array Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Enum Value Offset
|-
|0x04
|0x04
|u32
|Enum Class Name Offset
|-
|0x08
|0x04
|u32
|Enum Value Name Offset
|}

=== String Pool ===
The string pool is an array of null-terminated strings encoded with UTF-8. All string offsets in the file are relative to the first byte of this section. Note that this section also contains some unreferenced strings which are the enums for certain parameters.
[[Category:File formats]]

AINB

2026-01-08T03:32:40Z

Watertoon: Renaming pass, rewrite parameter tables.

'''AINB''' ('''AI''' '''N'''ode '''B'''inary) is a file format implementing behavior trees for game-specific code. At time of writing it has only appeared in titles on the ModuleSystem game engine. This article is primarily aimed at the version that appears in ''Tears of the Kingdom,'' ''Super Mario Bros. Wonder, Mario vs Donkey Kong,'' and the original October 2024 version of ''Nintendo Switch Online: Playtest Program'' (v0x407). ModuleSystem provides 3 built-in file categories that appear in their own dedicated folders in a title's romfs, being "AI" for actor behavior, "Logic" for actor ai group behavior, and "Sequence" for scene behavior, individual games are free to create their own file categories.

=== Version Table ===
{| class="wikitable"
|+
!Version
!Applications
!Differences From Previous
|-
|0x404
|''Nintendo Switch Sports, Splatoon 3''
|
|-
|0x407
|''The Legend of Zelda: Tears of the Kingdom, Super Mario Bros. Wonder, Mario Vs Donkey Kong, Nintendo Switch Online: Playtest Program (010)''
|
|-
|0x408
|''Nintendo Switch Online: Playtest Program (021)''
|>Now uses exb version 3 (u32 support)
>Added u32 type to blackboard
|}

== File Structure ==
AINB assumes little endian. Hashes can be assumed to be 32-bit Murmur3 unless otherwise specified.

An AINB file defines a set of commands to evaluate a tree of built-in or game-specific node classes. The built-in "Element_ModuleCaller" node and supporting structures allow a "root" AINB file to call out to an external "module" AINB file, module's can call further modules, allowing AINB files to form a tree of tree's. An AINB's file extension typically designates whether it is a root <code>.root.ainb</code> or module <code>.module.ainb</code>. For AI and Sequence files, the file's entry point is one or more commands which is linked to one or two child nodes. All nodes are accessed by their index (references to query nodes will use their query node index which is local to the amount of query nodes in the file).

All string offsets in the file are relative to the beginning of the string pool and name hashes are 32-bit murmur3 hashes. There are six possible data types for AINB parameters: int (signed 32-bit integer), bool, float (32-bit), vector3f, and pointer. Pointer parameters are pointers to objects.

=== Section Order ===

==== Version 0x407 ====
# File Header (0x74)
# Command Array
# Element Array
# Blackboard
# Element Param Region
# Attachment Parameters
# Property Parameters
# Input/Output Parameters
# Multi-Parameters
# Jump Array
# 0x50 Section (Unused in ''TotK'')
# Query Id Array
# Expression Binary
# AINB Modules
# External Action Array
# File Hashes
# Child Replacement Table
# 0x6C Section
# Enum Resolve Array
# String Pool

== Structures ==

=== Helpers ===

==== AinbString ====
Represents a u32 offset relative to a null-terminated string from the start of the file's string pool.

==== AinbPtr<T> ====
Represents a u32 absolute offset from the start of the file to the struct of type "T" enclosed by <>.

==== AinbArray<T> ====
Represents a u32 absolute offset from the start of the file to:
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Count
|-
|0x4
|
|T[Count]
|Array of struct of type T. Note; asb files only use 32-bit aligned types.
|}

=== File Header ===
AINB files begin with a 0x74 byte header. If the offset for a given section is empty, that section is not present in the file.
{| class="wikitable"
|+File Header
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|char[4]
|Magic - “AIB “
|-
|0x04
|0x04
|u32
|Version
|-
|0x08
|0x04
|u32
|Filename Offset
|-
|0x0C
|0x04
|u32
|Command Count
|-
|0x10
|0x04
|u32
|Element Count
|-
|0x14
|0x04
|u32
|Query Element Count
|-
|0x18
|0x04
|u32
|Attachment Count
|-
|0x1C
|0x04
|u32
|Output Element Count
|-
|0x20
|0x04
|AinbPtr<Blackboard>
|Blackboard
|-
|0x24
|0x04
|AinbPtr<char>
|String Pool
|-
|0x28
|0x04
|AinbPtr<AinbArray<Enum Relocation>>
|Enum Relocation Array
|-
|0x2C
|0x04
|AinbPtr<Property Table>
|Property Table
|-
|0x30
|0x04
|AinbPtr<Jump[]>
|Jump Table
|-
|0x34
|0x04
|AinbPtr<Input Output Table>
|Input/Output Table
|-
|0x38
|0x04
|AinbPtr<Multi Input[]>
|Multi-Input Array
|-
|0x3C
|0x04
|AinbPtr<Attachment[Attachment Count]>
|Attachment Array
|-
|0x40
|0x04
|AinbPtr<u32[]>
|Attachment Id Array
|-
|0x44
|0x04
|AinbPtr<Exb>
|Expression Binary
|-
|0x48
|0x04
|u32
|Child Replacement Table
|-
|0x4C
|0x04
|AinbPtr<u32[]>
|Query Element Id Array
|-
|0x50
|0x04
|u32
|Unknown (unused in ''TotK'', always the same as the Active Node Update Array Offset)
|-
|0x54
|0x04
|u32
|Unknown (always 0)
|-
|0x58
|0x04
|u32
|Unknown (always 0, used in ''Splatoon 3''/''Nintendo Switch Sports'')
|-
|0x5C
|0x04
|AinbPtr<AinbArray<Module Caller>>
|Module Caller Array
|-
|0x60
|0x04
|AinbString
|File Category Name
|-
|0x64
|0x04
|u32
|File Category? (0 = AI, 1 = Logic, 2 = Sequence) (''Splatoon 3'' game specific, 3 = UniqueSequenceSPL)
|-
|0x68
|0x04
|AinbPtr<AinbArray<External Action>>
|External Action Array Offset
|-
|0x6C
|0x04
|u32
|Unknown (Unused in ''TotK'')
|-
|0x70
|0x04
|AinbPtr<Module Caller Link>
|Module Caller Link
|}

=== Command Array ===
The command array immediately follows the file header and is an array of all commands in the file.
{| class="wikitable"
|+Command Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|AinbString
|Name
|-
|0x04
|0x10
|Guid
|Guid
|-
|0x14
|0x02
|u16
|Main Element Id
|-
|0x16
|0x02
|u16
|Secondary Element Id (value offset by 1, 0 is reserved for invalid)
|}
Unlike asb, command GUIDs only appear to be used for debug messages. Secondary Element Id will be -1 if the command only has one child element.

=== Property Table ===
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|AsbPtr<Property<s32>[]>
|Property Array
|-
|0x04
|0x04
|AsbPtr<Property<bool>[]>
|Property Array
|-
|0x08
|0x04
|AsbPtr<Property<float>[]>
|Property Array
|-
|0x0c
|0x04
|AsbPtr<Property<AinbString>[]>
|Property Array
|-
|0x10
|0x04
|AsbPtr<Property<Vector3f>[]>
|Property Array
|-
|0x14
|0x04
|AsbPtr<PropertyPointer[]>
|Property Array
|}

==== Property<T> ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|AinbString
|Name
|-
|0x4
|0x4
|Property Flags
|Flags
|-
|0x8
|0x4, or 0xc
|T
|Immediate Value
|}

===== Property Flags =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32 : 16
|Index
|-
|
|
|u32 : 1
|Is Use Index
|-
|
|
|u32 : 1
|Is Not Local Blackboard Index
|-
|
|
|u32 : 1
|
|-
|
|
|u32 : 1
|
|-
|
|
|u32 : 1
|
|-
|
|
|u32 : 1
|
|-
|
|
|u32 : 1
|Is EXB Index
|-
|
|
|u32 : 1
|Pulse Thread Local Storage
|-
|
|
|u32 : 1
|Set Pointer Flag Bit Zero
|-
|
|
|u32 : 7
|
|}

==== PropertyPointer ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|AinbString
|Name
|-
|0x4
|0x4
|AinbString
|Class Name
|-
|0x8
|0x4
|Property Flags
|Flags
|}

==== Property Entries ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property Type Entry
|S32 Entries
|-
|0x8
|0x8
|Property Type Entry
|Bool Entries
|-
|0x10
|0x8
|Property Type Entry
|Float Entries
|-
|0x18
|0x8
|Property Type Entry
|String Entries
|-
|0x20
|0x8
|Property Type Entry
|Vector3f Entries
|-
|0x28
|0x8
|Property Type Entry
|Pointer Entries
|}

===== Property Type Entry =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Base Index - base index into the Property Table's Property Array for the specified type
|-
|0x4
|0x4
|u32
|Count
|}

=== Input Output Table ===
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|AsbPtr<Input<s32>[]>
|Input Array
|-
|0x04
|0x04
|AsbPtr<Output<s32>[]>
|Output Array
|-
|0x08
|0x04
|AsbPtr<Input<bool>[]>
|Input Array
|-
|0x0c
|0x04
|AsbPtr<Output<bool[]>
|Output Array
|-
|0x10
|0x04
|AsbPtr<Input<float>[]>
|Input Array
|-
|0x14
|0x04
|AsbPtr<Output<float>[]>
|Output Array
|-
|0x18
|0x04
|AsbPtr<Input<AinbString>[]>
|Input Array
|-
|0x1c
|0x04
|AsbPtr<Output<AinbString>[]>
|Output Array
|-
|0x20
|0x04
|AsbPtr<Input<Vector3f>[]>
|Input Array
|-
|0x24
|0x04
|AsbPtr<Output<Vector3f>[]>
|Output Array
|-
|0x28
|0x04
|AsbPtr<InputPointer[]>
|Input Array
|-
|0x2c
|0x04
|AsbPtr<OutputPointer[]>
|Output Array
|}

==== Input<T> ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|AinbString
|Name
|-
|0x4
|0x2
|s16
|Input Element Id or Base Multi-Input Id
|-
|0x6
|0x2
|s16
|Input Element Output Plug Id or Multi-Input Count
|-
|0x8
|0x4
|Property Flags
|Flags
|-
|0xc
|0x4, or 0xc
|T
|Immediate Value
|}
If the input element id is between -32768 and -100, then the input uses a multi-input. The multi-input id can be calculated as follows: <code>BaseMultiInputIndex = -100 - Index</code>.

==== InputPointer ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|AinbString
|Name
|-
|0x4
|0x4
|AinbString
|Class Name
|-
|0x8
|0x2
|s16
|Input Element Id or Base Multi-Input Id
|-
|0xa
|0x2
|s16
|Input Element Output Plug Id or Multi-Input Count
|-
|0xc
|0x4
|Property Flags
|Flags
|-
|0x10
|0x4
|u32
|
|}

==== Output<T> ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|AinbString : 31
|Name
|-
|
|
|u32 : 1
|
|}

==== OutputPointer ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|AinbString : 31
|Name
|-
|
|
|u32 : 1
|
|-
|0x4
|0x4
|AinbString
|Class Name
|}

==== Input Output Entries ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x10
|Input Output Type Entry
|S32 Entries
|-
|0x10
|0x10
|Input Output Type Entry
|Bool Entries
|-
|0x20
|0x10
|Input Output Type Entry
|Float Entries
|-
|0x30
|0x10
|Input Output Type Entry
|String Entries
|-
|0x40
|0x10
|Input Output Type Entry
|Vector3f Entries
|-
|0x50
|0x10
|Input Output Type Entry
|Pointer Entries
|}

===== Input Output Type Entry =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Input Base Index - base index into the Input Output Table's Input<T> array for the specified type
|-
|0x4
|0x4
|u32
|Input Count
|-
|0x8
|0x4
|u32
|Output Base Index - base index into the Input Output Table's Output<T> array for the specified type
|-
|0x10
|0x4
|u32
|Output Count
|}

=== Element Array ===
The node array immediately follows the command array and is an array of all nodes in the file.
{| class="wikitable"
|+Node Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x02
|u16
|Element Type
|-
|0x02
|0x02
|u16
|Element Id - Index of this element within the element array
|-
|0x04
|0x02
|u16
|Attachment Count
|-
|0x06
|0x01
|bitfield
|Element Flags
|-
|0x07
|0x01
|u8
|
|-
|0x08
|0x04
|AinbString
|Element Type Name (for ApplicationDefined nodes)
|-
|0x0C
|0x04
|u32
|Name Hash (version 0x407+)
|-
|0x10
|0x04
|u32
|
|-
|0x14
|0x04
|AinbPtr<ElementParam<Element Type>>
|Element Param
|-
|0x18
|0x02
|u16
|EXB Function Count
|-
|0x1A
|0x02
|u16
|EXB Input/Output Field Size
|-
|0x1C
|0x02
|u16
|Multi-Param Count
|-
|0x1E
|0x02
|u16
|
|-
|0x20
|0x04
|u32
|Base Attachment Id
|-
|0x24
|0x02
|u16
|Base Query Element Id
|-
|0x26
|0x02
|u16
|Query Element Count
|-
|0x28
|0x02
|u16
|0x58 Section Entry Offset (relative to the start of the file)
|-
|0x2A
|0x02
|u16
|
|-
|0x2C
|0x10
|Guid
|Guid
|}
Just like with commands, node GUIDs are only used for debug messages. The 0x58 section entry offset will be empty if unused.

==== Element Type ====
{| class="wikitable"
|+Element Types
!Value (Hex)
!Value (Dec)
!Node Type
|-
|0x00
|0
|Application Defined
|-
|0x01
|1
|Element_S32Selector
|-
|0x02
|2
|Element_Sequential
|-
|0x03
|3
|Element_Simultaneous
|-
|0x04
|4
|Element_F32Selector
|-
|0x05
|5
|Element_StringSelector
|-
|0x06
|6
|Element_RandomSelector
|-
|0x07
|7
|Element_BoolSelector
|-
|0x08
|8
|Element_Fork
|-
|0x09
|9
|Element_Join
|-
|0x0A
|10
|Element_Alert
|-
|0x14
|20
|Element_Expression
|-
|0x64
|100
|Element_ModuleIF_Input_S32
|-
|0x65
|101
|Element_ModuleIF_Input_F32
|-
|0x66
|102
|Element_ModuleIF_Input_Vec3f
|-
|0x67
|103
|Element_ModuleIF_Input_String
|-
|0x68
|104
|Element_ModuleIF_Input_Bool
|-
|0x69
|105
|Element_ModuleIF_Input_Ptr
|-
|0xC8
|200
|Element_ModuleIF_Output_S32
|-
|0xC9
|201
|Element_ModuleIF_Output_F32
|-
|0xCA
|202
|Element_ModuleIF_Output_Vec3f
|-
|0xCB
|203
|Element_ModuleIF_Output_String
|-
|0xCC
|204
|Element_ModuleIF_Output_Bool
|-
|0xCD
|205
|Element_ModuleIF_Output_Ptr
|-
|0x012C
|300
|Element_ModuleIF_Child
|-
|0x0190
|400
|Element_StateEnd
|-
|0x01F4
|500
|Element_SplitTiming
|}
Element type names are official (outside ApplicationDefined). For ApplicationDefined elements, definitions can be found in a node definition file for the respective file category. This file is located at <code>NodeDefinition/Node.Product.[ver].aidefn.byml.zs</code> in the corresponding file category folder.
{| class="wikitable"
|+Node Type Descriptions
!Type
!Description
|-
|UserDefined
|Custom node type, definition in NodeDefinition
|-
|Element_S32Selector
|Conditionally links to a node depending on the value of a signed int
|-
|Element_Sequential
|Links to nodes sequentially in the order listed
|-
|Element_Simultaneous
|Links simultaneously to multiple nodes
|-
|Element_F32Selector
|Conditionally links to a node depending on the value of 32-bit float
|-
|Element_StringSelector
|Conditionally links to a node depending on the value of a string
|-
|Element_RandomSelector
|Links to a node randomly
|-
|Element_BoolSelector
|Conditionally links to a node depending on the value of a bool
|-
|Element_Fork
|See Active Node Update Array
|-
|Element_Join
|See Active Node Update Array
|-
|Element_Alert
|Displays a debug message
|-
|Element_Expression
|Passes values to and from EXB commands
|-
|Element_ModuleIF_Input_S32
|Receives a signed int input from the calling AINB file
|-
|Element_ModuleIF_Input_F32
|Receives a 32-bit float input from the calling AINB file
|-
|Element_ModuleIF_Input_Vec3f
|Receives a vector3f input from the calling AINB file
|-
|Element_ModuleIF_Input_String
|Receives a string input from the calling AINB file
|-
|Element_ModuleIF_Input_Bool
|Receives a bool input from the calling AINB file
|-
|Element_ModuleIF_Input_Ptr
|Receives an object pointer input from the calling AINB file
|-
|Element_ModuleIF_Output_S32
|Returns a signed int output from the module to the calling AINB file
|-
|Element_ModuleIF_Output_F32
|Returns a 32-bit float output from the module to the calling AINB file
|-
|Element_ModuleIF_Output_Vec3f
|Returns a vector3f output from the module to the calling AINB file
|-
|Element_ModuleIF_Output_String
|Returns a string output from the module to the calling AINB file
|-
|Element_ModuleIF_Output_Bool
|Returns a bool output from the module to the calling AINB file
|-
|Element_ModuleIF_Output_Ptr
|Returns an object pointer output from the module to the calling AINB file
|-
|Element_ModuleIF_Child
|Returns the node connection name from the module to the calling AINB file
|-
|Element_StateEnd
|Termination node, specifies what resident node to return to in the calling AINB file
|-
|Element_SplitTiming
|Changes when child nodes are run (Enter - first time visiting a node, Update - every frame, Leave - ran upon leaving the node)
|}

==== Element Flags ====
{| class="wikitable"
|+Element Flags
!Bits
!Description
|-
|1
|Is Query Element
|-
|1
|Is Module Caller
|-
|1
|Is Resident Initialized
|-
|1
|Is Query Multi-Param
|-
|4
|
|}

==== ElementParam<T> ====
Each element contains a table into the 4 parameter types, properties, inputs, outputs, and plugs. The child plugs inform the structure of the element tree.
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x30
|Property Entries
|Entries into the Property Table.
|-
|0x30
|0x60
|Input Output Entries
|Entries into the Input Output Table.
|-
|0x90
|0x14
|Plug Entries
|Entries into the following plug pointer array.
|-
|0xa4
|AsbPtr<>[Total Plug Count]
|Plug Data
|Plug Data Pointer Array.
|}

===== Plug Entries =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x2
|Plug Type Entry
|Bool/float Input Source/Output Source
|-
|0x2
|0x2
|Plug Type Entry
|
|-
|0x4
|0x2
|Plug Type Entry
|Child Plugs
|-
|0x6
|0x2
|Plug Type Entry
|Jump Plugs
|-
|0x8
|0x2
|Plug Type Entry
|String Input Source
|-
|0xa
|0x2
|Plug Type Entry
|Int Input Source
|-
|0xc
|0x2
|Plug Type Entry
|
|-
|0xe
|0x2
|Plug Type Entry
|
|-
|0x10
|0x2
|Plug Type Entry
|
|-
|0x12
|0x2
|Plug Type Entry
|
|}

====== Plug Type Entry ======
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x1
|u8
|Count
|-
|0x1
|0x1
|u8
|Base Index - base index into Plug Pointer Array
|}

====== Plugs ======
{| class="wikitable"
|+
Typical Plug Data
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Element Id
|-
|0x04
|0x04
|u32
|Value
|}
The interpretation of the value depends on the connection type. For input or output connections, the value is a string of the parameter name. For standard connections, the value is a string of the connection name. For jump connections, the value is an id into the Jump Table. Elements are free to extend the plug data with their own element specific values. For built-in element selector-types, excluding <code>Element_BoolSelector</code> and <code>Element_F32Selector</code>, an extra four bytes stores data used to select the child plug. For <code>Element_S32Selector</code>, this is an immediate value. For <code>Element_RandomSelector</code>, this is a weight and for <code>Element_StringSelector</code> it is a string. The condition for <code>Element_BoolSelector</code> is the entry's value string. <code>Element_F32Selector</code> adds 24 bytes to each entry, consisting of four eight-byte sub-entries.
{| class="wikitable"
|+<code>Element_F32Selector Condition Entry</code>
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Local Blackboard Parameter Index and Flags
|-
|0x04
|0x04
|float
|Condition Value
|}
The first two bytes of the four bytes at offset 0x00 are the blackboard parameter index while the last bit is whether or not the index is used or not. The first entry for <code>Element_F32Selector</code> is the minimum value condition while the second entry is the maximum value condition. The last two entries appear to be unused. The last child element entry for Selector-type nodes is the default case. The condition for this case is either the string その他 ("Other") or 0 (in the case of <code>Element_S32Selector</code>). Input elements that are Selector-type elements also appear to have an additional eight bytes (purpose unknown). <code>Element_Expression</code> has an additional eight bytes per input element (16 bytes in the case of vector3f entries). The purpose of these bytes is unknown.

=== Blackboard ===
This section contains an array of the Blackboard parameters used by file. These parameters may be sourced from external Blackboards or parameter files. The section begins with a 0x30 byte section header followed by the array of parameters, an array of default values of said parameters, and an array of file references if applicable. The order of parameters is in the order of string, int, float, bool, vector3f, and pointer. The section header contains six entries, one for each type.
{| class="wikitable"
|+Section Header Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x02
|u16
|Number of Entries of the Corresponding Data Type
|-
|0x02
|0x02
|u16
|Parameter Index of the First Entry of the Corresponding Data Type
|-
|0x04
|0x02
|u16
|Relative Offset of the First Entry of the Corresponding Data Type
|-
|0x06
|0x02
|u16
|
|}
{| class="wikitable"
|+Local Blackboard Parameter Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|bitfield
|Name Offset and Flags
|-
|0x04
|0x04
|u32
|String Offset (Notes)
|}
{| class="wikitable"
|+Name Offset Flags
!Bits
!Description
|-
|22
|Name Offset
|-
|1
|
|-
|1
|Does Not Have File Reference
|-
|7
|File Reference Index
|-
|1
|Is File Reference Valid
|}
The default value entries vary based on the parameter's data type. For int, float, and bool parameters, the entry is a four byte immediate value. String entries are a four byte string value offset. Vector3f entries are 12 bytes. Note that pointer parameters do not have default value entries and do not have default values.
{| class="wikitable"
|+File Reference Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|File Path Offset
|-
|0x04
|0x04
|u32
|File Path Hash
|-
|0x08
|0x04
|u32
|Filename Hash (no extension)
|-
|0x0C
|0x04
|u32
|File Extension Hash (no .)
|}

=== Attachments ===
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|AinbString
|Name
|-
|0x04
|0x04
|AinbPtr<Attachment Param>
|Parameters Entry Offset
|-
|0x08
|0x02
|u16
|EXB Function Count
|-
|0x0A
|0x02
|u16
|EXB Input/Output Field Size
|-
|0x0C
|0x04
|u32
|Name Hash (version 0x407+)
|}

==== Attachment Param ====
{| class="wikitable"
|}
{| class="wikitable"
|+Parameter Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x1
|u8
|Unknown (possibly related to debug)
|-
|0x01
|0x3
|u24
|
|-
|0x4
|0x30
|Property Entries
|Property Entries
|}
{| class="wikitable"
|}
{| class="wikitable"
|+Multi-Input Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x02
|u16
|Node Index
|-
|0x02
|0x02
|u16
|Input/Output Source Parameter Index
|-
|0x04
|0x04
|u32
|Flags
|}

=== Jump ===
{| class="wikitable"
|+
!Bits
!Description
|-
|8
|Is Valid Update
|-
|23
|
|-
|1
|Update Post Calc
|}
If the first byte of the flags is set to false, then the entry contains another four bytes with a string offset (purpose unknown). Otherwise, the entry is considered valid if the first byte equals 1. When evaluating the behavior trees, the game maintains an array of each root element. When a command is set, the root element of the command is set to this context. A jump will change that root element to the element specified by the jump plug's element id. This usually happens right before the next command's calculation occurs, but if the top bit is set, then it will occur immediately after the current command's calculation finishes (if the source element is an Element_Join, it will always update the root elements post current command calculation). This is primarily used for "subroutines" that run a single time then return to the main execution routine. Element_Fork and Element_Join are the main mechanism to manage multiple root elements. An Element_Fork will replace the current root elements with the element id's of it's jump plugs, possibly "forking" execution into multiple roots. The element at the end of a root element specified by an Element_Fork will optionally have a jump plug referencing a specific Element_Join. Each of these elements will push the Element_Join into the root element array. However, Element_Join has a property parameter called InFlowNum, and until that element has been pushed onto the root element array that many times in a single calculation, it will not activate and remain dormant. However, once this threshold is reached, it will begin execution (with a guard to make sure only one of the instances added to the array will execute).

=== 0x50 Section ===
This section is unused in ''Tears of the Kingdom''.

=== Query Element Id Array ===
This section is an array of entries of query element ids present in the file.
{| class="wikitable"
|+Query Node Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x02
|u16
|Query Element Id (local to number of query nodes)
|-
|0x02
|0x02
|u16
|
|}

=== Expression Binary ===
The '''EXB''' ('''Ex'''pression '''B'''inary) section is a completely self-contained section that stores custom instructions for a simple command processor. These instructions are grouped into functions that can be called by nodes to perform calculations. Because the section is self-contained, all offsets in this section are local to the section. The EXB section is shared with ASB files ('''A'''nimation '''S'''equence '''B'''inary).

===== Section Structure =====
EXB is essentially its own format and allows for the storage of custom functions in files.

====== Section Order ======

# 0x2C-Byte Header
# Command Info Table
# Instructions Table
# Parameter Region
# Signature Table
# String Pool

===== Sub-Sections =====

====== Header ======
{| class="wikitable"
|+EXB Header
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|char[4]
|Magic - “EXB “
|-
|0x04
|0x04
|u32
|Version (0x02)
|-
|0x08
|0x04
|u32
|Static Memory Allocation Size
|-
|0x0C
|0x04
|u32
|Parameter EXB Field Entry Count
|-
|0x10
|0x04
|u32
|32-bit Scratch Allocation Size
|-
|0x14
|0x04
|u32
|64-bit Scratch Allocation Size
|-
|0x18
|0x04
|u32
|Command Info Offset
|-
|0x1C
|0x04
|u32
|Command Table Offset
|-
|0x20
|0x04
|u32
|Signature Table Offset
|-
|0x24
|0x04
|u32
|Parameter Region Offset
|-
|0x28
|0x04
|u32
|String Pool Offset
|}

====== Command Info Table ======
This section contains an array of command (function) info entries. The first four bytes specify the entry count.
{| class="wikitable"
|+Command Info Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|s32
|Base Index Pre-Command Entry
|-
|0x04
|0x04
|u32
|Pre-Entry Static Memory Usage
|-
|0x08
|0x04
|u32
|Instruction Base Index
|-
|0x0C
|0x04
|u32
|Instruction Count
|-
|0x10
|0x04
|u32
|Static Memory Size
|-
|0x14
|0x02
|u16
|32-bit Scratch Memory Size
|-
|0x16
|0x02
|u16
|64-bit Scratch Memory Size
|-
|0x18
|0x02
|u16
|Output Data Type Enum
|-
|0x1A
|0x02
|u16
|Input Data Type Enum
|}
{| class="wikitable"
|+Data Type Enum
!Value (Hex)
!Value (Dec)
!Data Type
|-
|0x0
|0
|No Data
|-
|0x1
|1
|Immediate Value/From User
|-
|0x02
|2
|bool
|-
|0x03
|3
|int
|-
|0x04
|4
|float
|-
|0x05
|5
|string
|-
|0x06
|6
|vector3f
|}

====== Instructions Table ======
This section contains an array of instruction entries which are read by the EXB command processor. The first four bytes specify the entry count.
{| class="wikitable"
|+Instruction Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x01
|u8
|Instruction Type
|-
|0x01
|0x01
|u8
|Data Type Enum
|-
|0x02
|0x01
|u8
|Left-Hand Side Parameter Source Enum
|-
|0x03
|0x01
|u8
|Right-Hand Side Parameter Source Enum
|-
|0x04
|0x02
|u16
|Left-Hand Side Parameter Value
|-
|0x06
|0x02
|u16
|Right-Hand Side Parameter Value
|}
For UserDefined type instructions, the bytes at offset 0x02-0x04 become a u16 static memory index and the bytes at 0x04-0x08 become a u32 index into the function signatures table.
{| class="wikitable"
|+Instruction Types
!Value (Hex)
!Value (Dec)
!Instruction Type
|-
|0x01
|1
|Terminator
|-
|0x02
|2
|Store
|-
|0x03
|3
|Negate
|-
|0x04
|4
|NegateBool
|-
|0x05
|5
|Add
|-
|0x06
|6
|Subtract
|-
|0x07
|7
|Multiply
|-
|0x08
|8
|Divide
|-
|0x09
|9
|Modulus
|-
|0x0A
|10
|Increment
|-
|0x0B
|11
|Decrement
|-
|0x0C
|12
|ScalarMultiplyVec3f
|-
|0x0D
|13
|ScalarDivideVec3f
|-
|0x0E
|14
|LeftShift
|-
|0x0F
|15
|RightShift
|-
|0x10
|16
|LessThan
|-
|0x11
|17
|LessThanEqual
|-
|0x12
|18
|GreaterThan
|-
|0x13
|19
|GreaterThanEqual
|-
|0x14
|20
|Equal
|-
|0x15
|21
|NotEqual
|-
|0x16
|22
|AND
|-
|0x17
|23
|XOR
|-
|0x18
|24
|OR
|-
|0x19
|25
|LogicalAND
|-
|0x1A
|26
|LogicalOR
|-
|0x1B
|27
|UserFunction
|-
|0x1C
|28
|JumpIfLHSZero
|-
|0x1D
|29
|Jump
|}
UserFunctions are mapped to a function in the executable by function signature. There are two types of these functions: direct and object. Direct functions are straightforward functions that take up to two arguments and are matched using the function signature. Function objects can take additional arguments and are indexed at runtime.

{| class="wikitable"
|+Data Type Enum
!Value (Hex)
!Value (Dec)
!Data Type
|-
|0x0
|0
|No Data
|-
|0x1
|1
|Immediate Value/From User
|-
|0x02
|2
|bool
|-
|0x03
|3
|int
|-
|0x04
|4
|float
|-
|0x05
|5
|string
|-
|0x06
|6
|vector3f
|}
{| class="wikitable"
|+Parameter Source Enum
!Value (Hex)
!Value (Dec)
!Parameter Source
|-
|0x00
|0
|Immediate Parameters
|-
|0x01
|1
|Immediate Parameters (String)
|-
|0x02
|2
|Static Memory
|-
|0x03
|3
|Parameters Region
|-
|0x04
|4
|Parameters Region (String)
|-
|0x05
|5
|Output Value
|-
|0x06
|6
|Input Value
|-
|0x07
|7
|32-bit Scratch
|-
|0x08
|8
|64-bit Scratch
|-
|0x09
|9
|UserOutput
|-
|0x0A
|10
|UserInput
|}
UserCallback is a class that contains virtual functions providing memory allocation. The input value is passed from the calling node and the output value is passed back.

====== Parameter Region ======
The parameter region is a region that stores the values for parameters values that are too large to fit into two bytes. Parameters that get their values from this section instead store an offset relative to the beginning of the parameter region to the start of the value.

====== Signatures Table ======
This section is an array of u32 string offsets for each function signature.

====== String Pool ======
The string pool is an array of null-terminated strings encoded with UTF-8. All string offsets in this section are relative to the beginning of the string pool.

=== Module Caller ===
This section contains an array of all AINB modules linked to the current AINB file. The first four bytes specify the entry count.
{| class="wikitable"
|+AINB Module Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|File Path Offset
|-
|0x04
|0x04
|u32
|File Category Offset
|-
|0x08
|0x04
|u32
|AINB File Count
|}

=== External Action Array ===
This section appears to interact with XLink. The first four bytes specify the entry count.
{| class="wikitable"
|+Entry String Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Node Index
|-
|0x04
|0x04
|u32
|String 1 Offset (always メインステート ("Main State"))
|-
|0x08
|0x04
|u32
|State Name Offset
|}

=== Module Caller Link ===
This section contains two 32-bit file hashes. The first hash is a hash for the file itself and the second hash appears to be a hash for that file's parent file. These are used by Element_ModuleCaller.

=== Child Replacement Table ===
This section is used to remove or replace specific elements or attachments at runtime. This is used to toggle off debug elements/attachments in release builds. The section begins with an eight-byte section header.
{| class="wikitable"
|+Child Replacement Section Header
!Offset
!Size
!Type
!Description
|-
|0x00
|0x01
|u8
|Initialization Guard (Is Initialized)
|-
|0x01
|0x01
|u8
|
|-
|0x02
|0x02
|u16
|Replacement Count
|-
|0x04
|0x02
|s16
|Override Element Count
|-
|0x06
|0x02
|s16
|Override Attachment Parameter Count
|}
{| class="wikitable"
|+Child Replacement Table Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x01
|u8
|Replacement Type Enum (0 = remove child element, 1 = replace child element, 2 = remove attachment)
|-
|0x01
|0x01
|u8
|
|-
|0x02
|0x02
|u16
|Element Id
|-
|0x04
|0x02
|u16
|Child Element Id/Attachment Id
|-
|0x06
|0x02
|u16
|New Element Id (for child element replacements)
|}

=== 0x6C Section ===
This section is unused in ''Tears of the Kingdom''.

=== Enum Relocation ===
This section is used to resolve enum values at runtime. This section is unused in ''Tears of the Kingdom'' as all enum values are statically present in the file. However, in ''Splatoon 3'', this section is used extensively as all enum values are stored in the main executable. The first four bytes of this section specifies the number of entries in the section.
{| class="wikitable"
|+Enum Resolve Array Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Enum Value Offset
|-
|0x04
|0x04
|u32
|Enum Class Name Offset
|-
|0x08
|0x04
|u32
|Enum Value Name Offset
|}

=== String Pool ===
The string pool is an array of null-terminated strings encoded with UTF-8. All string offsets in the file are relative to the first byte of this section. Note that this section also contains some unreferenced strings which are the enums for certain parameters.
[[Category:File formats]]

ASB

2026-01-07T23:28:50Z

Watertoon: Add rest of what I got for now. Rename "parts" to "attachments". Correct header again.

'''ASB''' ('''A'''nimation '''S'''equence '''B'''inary) is a file format used to store "animation sequences" for populating "animation slots" of a model. This article is primarily aimed at version 0x41b. In ModuleSystem titles ASB files are typically found in under the "AS" folder, which can appear in the root of a title's romfs or the root of an archive file.

=== Version Table ===
{| class="wikitable"
|+
!Version
!Applications
!Differences From Previous
|-
|0x304
|''Ring Fit Adventure''
|
|-
|0x3fb
|''Labo Toy-Con 04, Game Builder Garage''
|
|-
|0x407
|''Animal Crossing: New Horizons''
|
|-
|0x40f
|''Nintendo Switch Sports''
|
|-
|0x410
|''Splatoon 3''
|
|-
|0x417
|''The Legend of Zelda: Tears of the Kingdom, Mario Vs Donkey Kong''
|
|-
|0x418
|''Super Mario Bros. Wonder''
|
|-
|0x41A
|''Nintendo Switch Online: Playtest Program''
|
|-
|0x41B
|''Nintendo Switch Online: Playtest Program''
|>Now uses exb version 3 (u32 support)

>Added u32 type to blackboard
|}

== File Structure ==
ASB assumes little endian. Hashes can be assumed to be 32-bit Murmur3 unless otherwise specified.

Documentation is still sparse, refer to [https://github.com/dt-12345/asb this repository] for more details (names may not match exactly).

=== Section Order ===

==== Version 0x417 ====
# File Header (0x6C bytes in version 0x417, 0x68 bytes in version 0x40F)
# AS Commands
# Nodes
# Event Entry Offsets
# Node Bodies
# Sync Data Entry Indices
# Sync Data
# State Transitions
# Events (in games that use BAEV, these events are non-functional)
# Transitions
# Command Groups
# AS Blackboard Parameters
# Partials
# Bone Groups
# Calculation Result Cache
# Valid Tag List
# Tag Groups
# Expression Binary
# AS Markings
# Material Blend Settings
# Enum Resolve Table
# String Pool

==== Version 0x41b ====

# File Header (0x80)
# Command Array
# Element Array
# Element Param Region
# Attachment Index Array
# Attachment Array
# State Array
# Transition Array
# Transition Data Region
# Blackboard
# Partial Skeleton Array
# Partial
# Bone Blend Array
# Transition Partial Skeleton Id Array
# Float Property Ex Array
# Tag Array
# Exb
# External Action Array
# Material Blend Array
# Enum Relocation Array
# String Pool

== Structures ==

=== Helpers ===

==== AsbString ====
Represents a u32 offset relative to the start of the file's string pool.

==== AsbPtr <T> ====
Represents a u32 absolute offset from the start of the file to the struct of type "T" enclosed by <>.

==== AsbArray <T> ====
Represents a u32 absolute offset from the start of the file to:
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Count
|-
|0x4
|
|T[Count]
|Array of struct of type T. Note; asb files only use 32-bit aligned types.
|}

=== File Header ===
{| class="wikitable"
|+File Header (0x417)
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|char[4]
|Magic - "ASB "
|-
|0x04
|0x04
|u32
|Version (0x0417 in ''Tears of the Kingdom'')
|-
|0x08
|0x04
|u32
|Filename Offset
|-
|0x0C
|0x04
|u32
|AS Command Count
|-
|0x10
|0x04
|u32
|Node Count
|-
|0x14
|0x04
|u32
|Event Count
|-
|0x18
|0x04
|u32
|Partial Count
|-
|0x1C
|0x04
|u32
|Sync Data Entry Count
|-
|0x20
|0x04
|u32
|AS Blackboard Parameters Offset
|-
|0x24
|0x04
|u32
|String Pool Offset
|-
|0x28
|0x04
|u32
|Enum Resolve Table Offset
|-
|0x2C
|0x04
|u32
|State Transitions Offset
|-
|0x30
|0x04
|u32
|Event Entries Offset Array Offset
|-
|0x34
|0x04
|u32
|Partials Offset
|-
|0x38
|0x04
|u32
|Sync Data Offset
|-
|0x3C
|0x04
|u32
|Sync Data Indices Array Offset
|-
|0x40
|0x04
|u32
|Calculation Result Cache Offset
|-
|0x44
|0x04
|u32
|Calculation Result Cache Count
|-
|0x48
|0x04
|u32
|Bone Groups Offset
|-
|0x4C
|0x04
|u32
|Bone Group Count
|-
|0x50
|0x04
|u32
|String Pool Size
|-
|0x54
|0x04
|u32
|Transitions Offset
|-
|0x58
|0x04
|u32
|Tag List Offset
|-
|0x5C
|0x04
|u32
|String Triplets Offset
|-
|0x60
|0x04
|u32
|Expression Offset (empty if section does not exist)
|-
|0x64
|0x04
|u32
|Command Groups Offset (empty if section does not exist)
|-
|0x68
|0x04
|u32
|Material Blend Settings Offset (version 0x417 only)
|}
{| class="wikitable"
|+File Header (0x41b)
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Magic - "ASB "
|-
|0x4
|0x4
|u32
|Version - (0x41b in Nintendo Switch Online: Playtest version 021)
|-
|0x8
|0x4
|AsbString
|Name
|-
|0xc
|0x4
|u32
|Command Count
|-
|0x10
|0x4
|AsbPtr<Command[Command Count]>
|Command Array
|-
|0x14
|0x4
|u32
|Element Count
|-
|0x18
|0x4
|AsbPtr<Element[Element Count]>
|Element Array
|-
|0x1c
|0x4
|u32
|Event Count - The pointer and count are erroneously present, but the section is not actually written in applications that support the baev file format.
|-
|0x20
|0x4
|AsbPtr<Event[Event Count]>
|Event Array
|-
|0x24
|0x4
|u32
|Partial Count
|-
|0x28
|0x4
|AsbPtr<Partial[ParitalCount]>
|Partial Array
|-
|0x2c
|0x4
|u32
|Attachment Count
|-
|0x30
|0x4
|AsbPtr<Attachment>
|Attachment Array
|-
|0x34
|0x4
|AsbPtr<u32[Attachment Count]>
|Attachment Index Array - Array of indices to parts
|-
|0x38
|0x4
|AsbPtr<Blackboard>
|Blackboard
|-
|0x3c
|0x4
|AsbPtr<char>
|String Pool
|-
|0x40
|0x4
|AsbPtr<AsbArray<Enum Relocation>>
|Enum Relocation Array
|-
|0x44
|0x4
|AsbPtr<AsbArray<State>>
|State Array
|-
|0x48
|0x4
|u32
|Float Property Ex Count
|-
|0x4c
|0x4
|AsbPtr<Float Property Ex[Float Property Ex Count]>
|Float Property Ex Array
|-
|0x50
|0x4
|u32
|Bone Blend Count
|-
|0x54
|0x4
|AsbPtr<Bone Blend[Bone Blend Count]>
|Bone Blend Array
|-
|0x58
|0x4
|u32
|Partial Skeleton Count
|-
|0x5c
|0x4
|AsbPtr<Partial Skeleton[Partial Skeleton Count]>
|Partial Skeleton Array
|-
|0x60
|0x4
|u32
|String Pool Size
|-
|0x64
|0x4
|AsbPtr<Transition Array>
|Transition Array
|-
|0x68
|0x4
|AsbPtr<AsbArray<u32>>
|Transition Partial Skeleton Array
|-
|0x6c
|0x4
|AsbPtr<AsbArray<AsbString>>
|Tag Array
|-
|0x70
|0x4
|AsbPtr<AsbArray<External Action>>
|External Action Array
|-
|0x74
|0x4
|AsbPtr<Exb>
|Exb
|-
|0x78
|0x4
|u32
|Transition Group Array
|-
|0x7c
|0x4
|AsbPtr<AsbArray<Material Blend>>
|Material Blend Array
|}

=== Property<T> ===
Property types include s32 (can be an enum), bool(32-bit), float, AsbString, and Vector3f.
{| class="wikitable"
|+ Property<T>
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Flags and Index
|-
|0x04
|0x04 or 0x0C
|T
|Value
|}

If the top bit of the flags is set, then the bottom two bytes of the flags become an index value. If it is not set, then the provided value is value of the parameter. If <code>flags & 1 << 0x18 != 0</code>, then the index is an expression index (EXB) and the normal value field becomes the input value for the expression. If <code>flags & 1 << 0x1e != 0</code>, then the index is a calculation result cache index (this stores the previously evaluated value and calculates the new value from the cached value on subsequent accesses). Note, this is only applicable if the parameter is a float. Otherwise, if <code>flags & 1 << 0x19 != 0</code>, then the index specifies the command data type. 0 is the current frame normalized (i.e. <code>(current_frame - start_frame)/total_duration</code>), 1 and 2 are random float values between 0.0 and 1.0, 3 is an unknown string value, 4 is the command's fade in frame, and 6 is an unknown float value. Note, this only applies if the parameter is a float or a string. In all other cases, the index is a blackboard index and value of the parameter is the value of the corresponding blackboard parameter. For float parameters specifically, <code>flags >> 0x1a & 3</code> specifies the exact parameter source. 0 is a float blackboard parameter while 1, 2, or 3 are a vector3f blackboard parameter with 1, 2, and 3 being the x, y, and z components respectively.

=== Command ===
Defines a command that can be evaluated by an as::Controller to set and play model animations. A command references the start of a behavior tree of elements to be evaluated at runtime. A simple update mode exists to continue playback of animation without always evaluating the command. A bypass mode also exists to play model animations directly from an as::Controller without a defined command.
{| class="wikitable"
|+Command (0x417)
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Name Offset
|-
|0x04
|0x04
|u32
|Tag Entry Offset (version 0x417+)
|-
|0x08
|0x08
|Property<float>
|
|-
|0x10
|0x08
|Property<bool>
|Is Ignore Same Command
|-
|0x18
|0x04
|u32
|Interpolation Type (uncertain, but 0 = unspecified, 1 = no model morph, 3 = enable local bone morph, 4 = enable inertial blend)
|-
| rowspan="5" |0x1C
| rowspan="5" |0x10
|u32
| rowspan="5" |GUID
|-
|u16
|-
|u16
|-
|u8[2]
|-
|u8[6]
|-
|0x2C
|0x02
|u16
|Child Node Index
|-
|0x2E
|0x02
|u16
|
|}
{| class="wikitable"
|+Command (0x41b)
!Offset
!Size
!Type
!Description
|-
|0x00
|0x4
|AsbString
|Name
|-
|0x04
|0x4
|AsbPtr<AsbArray<AsbString>>
|Tag Array
|-
|0x08
|0x8
|Property<float>
|Frame Count
|-
|0x10
|0x4
|u32
|Debug flag for host io?
|-
|0x14
|0x8
|Property<InterpolationType>
|Default Interpolation Type
|-
|0x1c
|0x10
|Guid
|Guid
|-
|0x2c
|0x2
|u16
|Element Id
|-
|0x2e
|0x2
|u16
|
|}

==== Interpolation Type ====
Enum for (known) interpolation types.
{| class="wikitable"
|+Interpolation Type
!Name
!Value
!Description
|-
|Default
|0
|
|-
|None
|1
|
|-
|Cross Fade
|2
|
|-
|Local Bone
|3
|
|-
|Inertia Local Bone
|4
|
|-
|Parts
|5
|
|}

=== Element ===
{| class="wikitable"
|+Element (0x417)
!Offset
!Size
!Type
!Description
|-
|0x00
|0x02
|AsbNodeType
|Node Type
|-
|0x02
|0x01
|u8
|Sync Data Count
|-
|0x03
|0x01
|u8
|Does Not Have State Transition
|-
|0x04
|0x04
|u32
|Tag Entry Offset
|-
|0x08
|0x04
|u32
|Node Body Offset
|-
|0x0C
|0x02
|u16
|Calculation Result Cache Index
|-
|0x0E
|0x02
|u16
|Calculation Result Cache Count
|-
|0x10
|0x02
|u16
|Sync Data Index Array Index
|-
|0x12
|0x02
|u16
|AS Markings Index (-1 for index)
|-
| rowspan="5" |0x14
| rowspan="5" |0x10
|u32
| rowspan="5" |GUID
|-
|u16
|-
|u16
|-
|u8[2]
|-
|u8[6]
|}
{| class="wikitable"
|+Element (0x41b)
!Offset
!Size
!Type
!Description
|-
|0x0
|0x2
|u16
|Element Type
|-
|0x2
|0x1
|u8
|Attachment Count
|-
|0x3
|0x1
|u8
|Is No State End
|-
|0x4
|0x4
|AsbPtr<AsbArray<AsbString>>
|Tag Array
|-
|0x8
|0x4
|AsbPtr<ElementParam<Element Type>>
|Element Param
|-
|0xc
|0x2
|u16
|Float Property Ex Flags
|-
|0xe
|0x2
|u16
|Float Property Ex Count
|-
|0x10
|0x2
|u16
|Base Attachment Index Id
|-
|0x12
|0x2
|u16
|External Action Id
|-
|0x14
|0x10
|Guid
|
|}

==== Element Type ====
Enum of element types.
{| class="wikitable"
|+Element Type
!Value (Hex)
!Value (Dec)
!Node Type
|-
|0x01
|1
|FloatSelector
|-
|0x02
|2
|StringSelector
|-
|0x03
|3
|SkeletalAnimation
|-
|0x04
|4
|State
|-
|0x05
|5
|StateEnd
|-
|0x06
|6
|OneDimensionalBlender
|-
|0x07
|7
|Sequential
|-
|0x08
|8
|IntSelector
|-
|0x09
|9
|Simultaneous
|-
|0x0A
|10
|Event
|-
|0x0B
|11
|MaterialAnimation
|-
|0x0C
|12
|FrameController
|-
|0x0D
|13
|DummyAnimation
|-
|0x0E
|14
|RandomSelector
|-
|0x0F
|15
|StateEnd
|-
|0x10
|16
|PreviousTagSelector
|-
|0x11
|17
|BonePositionSelector
|-
|0x12
|18
|BoneVisibilityAnimation
|-
|0x13
|19
|InitialFrame
|-
|0x14
|20
|BoneBlender
|-
|0x15
|21
|BoolSelector
|-
|0x16
|22
|Alert
|-
|0x17
|23
|SubtractAnimation
|-
|0x18
|24
|ShapeAnimation
|-
|0x19
|25
|
|-
|0x1a
|26
|TwoDimensionalBlender
|-
|0x1b
|27
|
|}

==== ElementPlugs ====
The plug struct provides relative offsets to "plug" data.
{| class="wikitable"
|+ElementPlugs (0x41b)
!Offset
!Size
!Type
!Description
|-
|0x0
|0x1
|u8
|State Count
|-
|0x1
|0x1
|u8
|State Base Index
|-
|0x2
|0x1
|u8
|Unknown Count
|-
|0x3
|0x1
|u8
|Unknown Base Index
|-
|0x4
|0x1
|u8
|Child Count
|-
|0x5
|0x1
|u8
|Child Base Index
|-
|0x6
|0x1
|u8
|Exb Count
|-
|0x7
|0x1
|u8
|Exb Base Index
|-
|0x8
|0x1
|u8
|Event Count
|-
|0x9
|0x1
|u8
|Event Base Index
|-
|0xa
|0x1
|u8
|Frame Controller Count
|-
|0xb
|0x1
|u8
|Frame Controller Base Index
|-
|0xc
|0x4 * Frame Controller Base Index + Frame Controller Count
|u32[]
|Plug Data Offset Array - Offsets relative to start of plug table
|}

===== Child Plug =====
Only known are listed.

====== Default ======
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Child Element Id
|}

====== FloatSelector, OneDimensionalBlender, BonePositionSelector Elements ======
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<float>
|Min
|-
|0x8
|0x8
|Property<float>
|Max
|-
|0x10
|0x4
|u32
|Child Element Id
|}

====== StringSelector Element ======
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<AsbString>
|Value
|-
|0x8
|0x4
|u32
|Child Element Id
|}

====== IntSelector Element ======
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<s32>
|Value
|-
|0x8
|0x4
|u32
|Child Element Id
|}

====== RandomSelector Element ======
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<float>
|Value
|-
|0x8
|0x4
|u32
|Child Element Id
|}

====== PreviousTagSelector Element ======
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|AsbPtr<AsbArray<AsbString>>
|Tag Array
|-
|0x8
|0x4
|u32
|Child Element Id
|}

===== Event Plug =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Event Element Id
|}

===== Frame Controller Plug =====
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Frame Controller Element Id
|}

==== ElementParam<Element Type> ====

===== FloatSelector Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<float>
|Select Value
|-
|0x8
|0x8
|Property<bool>
|Is Slot Sync
|-
|0x10
|0x4
|u32
|
|-
|0x14
|0xc + N
|ElementPlugs
|Plugs
|}

===== StringSelector Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<float>
|Select Value
|-
|0x8
|0x8
|Property<bool>
|Is Slot Sync
|-
|0x10
|0x4
|u32
|
|-
|0x14
|0xc + N
|ElementPlugs
|Plugs
|}

===== SkeletalAnimation Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<AsbString>
|Animation Name
|-
|0x8
|0x4
|u32
|
|-
|0xc
|0x4
|u32
|
|-
|0x10
|0x8
|Property<bool>
|Is Offset Frame
|-
|0x18
|0x8
|Property<float>
|Frame Offset
|-
|0x20
|0xc + N
|ElementPlugs
|Plugs
|}

===== State Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0xc + N
|ElementPlugs
|Plugs
|}

===== OneDimensionalBlender Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<float>
|Selector weight
|-
|0x8
|0x4
|u32
|Easing Type (1 = ease)
|-
|0xc
|0xc + N
|ElementPlugs
|Plugs
|}

===== Sequential Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<bool>
|
|-
|0x8
|0x8
|Property<s32>
|
|-
|0x10
|0x8
|Property<bool>
|
|-
|0x18
|0xc + N
|ElementPlugs
|Plugs
|}

===== IntSelector Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<s32>
|Select Value
|-
|0x8
|0x8
|Property<bool>
|Is Slot Sync
|-
|0x10
|0x4
|u32
|
|-
|0x14
|0xc + N
|ElementPlugs
|Plugs
|}

===== Simultaneous Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|State End Type (0 = no children, 1 = first child state end)
|-
|0x8
|0xc + N
|ElementPlugs
|Plugs
|}

===== Event Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|
|-
|0x8
|0xc + N
|ElementPlugs
|Plugs
|}

===== MaterialAnimation Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Material Blend Id
|-
|0x4
|0x8
|Property<AsbString>
|Animation Name
|-
|0xc
|0x8
|Property<bool>
|
|-
|0x14
|0xc + N
|ElementPlugs
|Plugs
|}

===== FrameController Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<float>
|Play Rate
|-
|0x8
|0x8
|Property<float>
|Loop Start
|-
|0x10
|0x8
|Property<float>
|Loop End
|-
|0x18
|0x4
|u32
|
|-
|0x1c
|0x8
|Property<bool>
|Is Kill Loop
|-
|0x24
|0x8
|Property<bool>
|
|-
|0x2c
|0x8
|Property<s32>
|Frame Count
|-
|0x34
|0x8
|Property<s32>
|Random Range
|-
|0x3c
|0x8
|Property<bool>
|Is Local Random
|-
|0x44
|0x8
|Property<float>
|Frame Offset
|-
|0x4c
|0x8
|Property<float>
|Current Frame
|-
|0x54
|0x8
|Property<float>
|
|-
|0x5c
|0x4
|u32
|
|-
|0x60
|0x8
|Property<float>
|
|-
|0x68
|0x8
|Property<bool>
|
|-
|0x70
|0x8
|Property<bool>
|Is Retarget Play Rate
|-
|0x78
|0xc + N
|ElementPlugs
|Plugs
|}

===== DummyAnimation Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<float>
|Frame Count
|-
|0x8
|0x8
|Property<bool>
|Is Looping
|-
|0x10
|0xc + N
|ElementPlugs
|Plugs
|}

===== RandomSelector Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Judge Timing
|-
|0x4
|0x8
|Property<bool>
|Is Slot Sync
|-
|0xc
|0x8
|Property<s32>
|
|-
|0x14
|0x8
|Property<>
|Unknown
|-
|0x1c
|0x4
|u32
|
|-
|0x20
|0xc + N
|ElementPlugs
|Plugs
|}

===== PreviousTagSelector Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|
|-
|0x4
|0xc + N
|ElementPlugs
|Plugs
|}

===== BonePositionSelector Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<AsbString>
|Left Bone Name
|-
|0x8
|0x8
|Property<AsbString>
|Right Bone Name
|-
|0xc
|0x4
|u32
|Component Id - (0 = X, 1 = Y, 2 = Z) component to generate bone position difference from
|-
|0x10
|0x4
|u32
|Judge Timing
|-
|0x14
|0x8
|Property<bool>
|Is Slot Sync
|-
|0x1c
|0xc + N
|ElementPlugs
|Plugs
|}

===== BoneVisibilityAnimation Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<AsbString>
|Animation Name
|-
|0x8
|0x8
|Property<bool>
|
|-
|0x10
|0x8
|Property<bool>
|Is Offset Frame
|-
|0x18
|0x8
|Property<float>
|Frame Offset
|-
|0x20
|0xc + N
|ElementPlugs
|Plugs
|}

===== InitialFrame Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Initial Frame Type
|-
|0x4
|0x4
|AsbPtr<AsbArray<AsbString>>
|Tag Array
|-
|0x8
|0x8
|Property<bool>
|Is Share By Same Anim key
|-
|0x10
|0x8
|Property<AsbString>
|Left Bone Name
|-
|0x18
|0x8
|Property<AsbString>
|Right Bone Name
|-
|0x20
|0x4
|u32
|Component Id
|-
|0x24
|0x8
|Property<bool>
|Is Random
|-
|0x2c
|0x8
|Property<bool>
|Is Fixed Random
|-
|0x34
|0xc + N
|ElementPlugs
|Plugs
|}

====== Initial Frame Type ======
{| class="wikitable"
|+
!Name
|-
|Start
|-
|FrameOffset
|-
|InvFrameOffset
|-
|Random
|-
|BonePosition
|-
|End
|-
|Frame
|-
|InvFrame
|-
|SlotSync
|}

===== BoneBlender Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<AsbString>
|Bone Blend Name
|-
|0x8
|0x4
|u32
|Sync Child Id
|-
|0xc
|0x8
|Property<float>
|Bone Blend Mode Value
|-
|0x14
|0x4
|u32
|Bone Blend Mode
|-
|0x18
|0x4
|u32
|State End Mode (0 = all, 1 = child 0, 2 = child 1)
|-
|0x1c
|0xc + N
|ElementPlugs
|Plugs
|}

===== BoolSelector Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<bool>
|Select Value
|-
|0x8
|0x8
|Property<bool>
|Is Slot Sync
|-
|0x10
|0x4
|u32
|
|-
|0x14
|0xc + N
|ElementPlugs
|Plugs
|}

===== Alert =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<AsbString>
|Alert
|-
|0x8
|0xc + N
|ElementPlugs
|Plugs
|}

===== SubtractAnimation Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0xc + N
|ElementPlugs
|Plugs
|}

===== ShapeAnimation Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<AsbString>
|Animation Name
|-
|0x8
|0xc + N
|ElementPlugs
|Plugs
|}

===== TwoDimensionalBlender Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<float>
|Selector Weight 0
|-
|0x8
|0x8
|Property<float>
|Selector Weight 1
|-
|0x10
|0x4
|u32
|Offset to key frame array relative to 0x10 of this struct?
|-
|0x14
|0x4
|u32
|Offset to key data array relative to 0x10 of this struct?
|-
|0x18
|0xc + N
|ElementPlugs
|Plugs
|}

=== Partial ===
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|AsbString
|Name
|-
|0x4
|0x4
|u32
|Partial Skeleton Id
|-
|0x8
|0x4
|AsbString
|
|-
|0xc
|0x4
|u32
|
|}

=== Attachment ===
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x2
|u16
|Attachment Type
|-
|0x2
|0x2
|u16
|
|-
|0x4
|0x4
|AsbPtr<>
|Type specific data
|-
|0x8
|0x10
|Guid
|Guid
|}

=== Blackboard ===
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Blackboard Type Offset
|String
|-
|0x8
|0x8
|Blackboard Type Offset
|Int
|-
|0x10
|0x8
|Blackboard Type Offset
|UInt
|-
|0x18
|0x8
|Blackboard Type Offset
|Float
|-
|0x20
|0x8
|Blackboard Type Offset
|Bool
|-
|0x28
|0x8
|Blackboard Type Offset
|Vector3f
|-
|0x30
|0x8
|Blackboard Type Offset
|Pointer
|-
|0x38
|0x4 * N
|Blackboard Entry
|Entry Array
|-
|
|
|
|Default Value Region
|}

==== Blackboard Type Offset ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x2
|u16
|Count
|-
|0x2
|0x2
|u16
|Entry Base Index
|-
|0x4
|0x2
|u16
|Default Value Base Offset
|-
|0x6
|0x2
|u16
|
|}

==== Blackboard Entry ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|AsbString : 24
|Name
|-
|
|
|u32 : 7
|Extra Info Index
|-
|
|
|u32 : 1
|Is Extra Info
|}

=== Enum Relocation ===
This feature appears to be for applications that want to be able to change enum class definitions without updating all the relevant asb files. Applications can choose to bake the enum values, in which this section is omitted, but the class name and enum value name will still be emitted to the string pool, unreferenced.
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|AsbPtr<s32>
|Value to replace
|-
|0x4
|0x4
|AsbString
|Enum Class Name
|-
|0x8
|0x4
|AsbString
|Enum Value Name
|}

=== State ===

=== Float Property Ex ===
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<float>
|Value
|-
|0x8
|0x4
|u32
|Curve Type
|-
|0xc
|0xc
|float[3]
|Curve Data
|-
|0x18
|0x4
|float
|Min
|-
|0x1c
|0x4
|float
|Max
|}

=== Bone Blend ===

=== Partial Skeleton ===
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|AsbPtr<Partial Bone[Partial Bone Count]>
|Partial Bone Array
|-
|0x4
|0x4
|AsbString
|Partial Skeleton Name
|-
|0x8
|0x4
|u32
|Partial Bone Count
|}

==== Partial Bone ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|AsbString
|Bone Name
|-
|0x4
|0x2
|s16
|Bind Flags
|-
|0x6
|0x1
|u8
|Is Recursive (recursively adds all child bones)
|-
|0x7
|0x1
|u8
|
|}

=== Transition ===

=== External Action ===
Used to call "external actions". In ModuleSystem titles this appears to typically correspond to an xlink command.
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|AsbString
|Type?
|-
|0x4
|0x4
|AsbString
|Slot?
|-
|0x8
|0x4
|AsbString
|Action
|}

=== Material Blend ===
Blend weight for material animations.
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|AsbString
|Name
|-
|0x4
|0x4
|float
|Weight
|}
[[Category:File formats]]

ASB

2026-01-07T12:51:07Z

Watertoon: Correct file header

'''ASB''' ('''A'''nimation '''S'''equence '''B'''inary) is a file format used to store animation sequences for actors in recent Nintendo EPD games such as ''The Legend of Zelda: Tears of the Kingdom'' and ''Nintendo Switch Sports''. This article is primarily aimed at the version that appears in ''Tears of the Kingdom'' and ''Mario vs Donkey Kong'' (v0x0417). Other ASB versions include 0x304 (''Ring Fit Adventure''), 0x3FB (''Labo Toy-Con 04'' and ''Game Builder Garage''), 0x407 (''Animal Crossing: New Horizons''), 0x40F (''Nintendo Switch Sports''), 0x410 (''Splatoon 3''), 0x418 (''Super Mario Bros. Wonder''), and 0x41A/0x41B (''Nintendo Switch Online: Playtest Program''). ASB files can be found in the AS folder of the romfs as well as the AS folder of certain pack files.

== File Structure ==
ASB is a little endian format which consists of node pathways triggered by AS commands. When an AS command is called, it runs the sequence of nodes connected to it which trigger and control animations and animation logic. Nodes are arranged in an array and referenced and accessed by their array index. Despite the presence of animation events in ASB files, these events do not appear to be used by the game.

All string offsets in the file are relative to the start of the string pool and name hashes are 32-bit murmur3 hashes. There are six possible parameter types: string, int (32-bit signed integer), float (32-bit floating point number), bool, vector3f, and pointer (object pointer, this is not actually possible in ASB, only usable in AINB).

Documentation is still sparse, refer to [https://github.com/dt-12345/asb this repository] for more details (names may not match exactly).

=== Section Order ===

==== Version 0x417 ====
# File Header (0x6C bytes in version 0x417, 0x68 bytes in version 0x40F)
# AS Commands
# Nodes
# Event Entry Offsets
# Node Bodies
# Sync Data Entry Indices
# Sync Data
# State Transitions
# Events (in games that use BAEV, these events are non-functional)
# Transitions
# Command Groups
# AS Blackboard Parameters
# Partials
# Bone Groups
# Calculation Result Cache
# Valid Tag List
# Tag Groups
# Expression Binary
# AS Markings
# Material Blend Settings
# Enum Resolve Table
# String Pool

== Structures ==

=== Helpers ===

==== AsbString ====
Represents a u32 offset relative to the start of the file's string pool.

==== AsbPtr <T> ====
Represents a u32 absolute offset from the start of the file to the struct of type "T" enclosed by <>.

==== AsbArray <T> ====
Represents a u32 absolute offset from the start of the file to:
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Count
|-
|0x4
|
|T[Count]
|Array of struct of type T. Note; asb files only use 32-bit aligned types.
|}

=== File Header ===
{| class="wikitable"
|+File Header (0x417)
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|char[4]
|Magic - "ASB "
|-
|0x04
|0x04
|u32
|Version (0x0417 in ''Tears of the Kingdom'')
|-
|0x08
|0x04
|u32
|Filename Offset
|-
|0x0C
|0x04
|u32
|AS Command Count
|-
|0x10
|0x04
|u32
|Node Count
|-
|0x14
|0x04
|u32
|Event Count
|-
|0x18
|0x04
|u32
|Partial Count
|-
|0x1C
|0x04
|u32
|Sync Data Entry Count
|-
|0x20
|0x04
|u32
|AS Blackboard Parameters Offset
|-
|0x24
|0x04
|u32
|String Pool Offset
|-
|0x28
|0x04
|u32
|Enum Resolve Table Offset
|-
|0x2C
|0x04
|u32
|State Transitions Offset
|-
|0x30
|0x04
|u32
|Event Entries Offset Array Offset
|-
|0x34
|0x04
|u32
|Partials Offset
|-
|0x38
|0x04
|u32
|Sync Data Offset
|-
|0x3C
|0x04
|u32
|Sync Data Indices Array Offset
|-
|0x40
|0x04
|u32
|Calculation Result Cache Offset
|-
|0x44
|0x04
|u32
|Calculation Result Cache Count
|-
|0x48
|0x04
|u32
|Bone Groups Offset
|-
|0x4C
|0x04
|u32
|Bone Group Count
|-
|0x50
|0x04
|u32
|String Pool Size
|-
|0x54
|0x04
|u32
|Transitions Offset
|-
|0x58
|0x04
|u32
|Tag List Offset
|-
|0x5C
|0x04
|u32
|String Triplets Offset
|-
|0x60
|0x04
|u32
|Expression Offset (empty if section does not exist)
|-
|0x64
|0x04
|u32
|Command Groups Offset (empty if section does not exist)
|-
|0x68
|0x04
|u32
|Material Blend Settings Offset (version 0x417 only)
|}
{| class="wikitable"
|+File Header (0x41b)
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Magic - "ASB "
|-
|0x4
|0x4
|u32
|Version - (0x41b in Nintendo Switch Online: Playtest version 021)
|-
|0x8
|0x4
|AsbString
|Name
|-
|0xc
|0x4
|u32
|Command Count
|-
|0x10
|0x4
|AsbPtr<Command[Command Count]>
|Command Array
|-
|0x14
|0x4
|u32
|Element Count
|-
|0x18
|0x4
|AsbPtr<Element[Element Count]>
|Element Array
|-
|0x1c
|0x4
|u32
|Event Count - The pointer and count are erroneously present, but the section is not actually written in applications that support the baev file format.
|-
|0x20
|0x4
|AsbPtr<Event[Event Count]>
|Event Array
|-
|0x24
|0x4
|u32
|Parts Count
|-
|0x28
|0x4
|AsbPtr<Parts>
|Parts Region - Pointer to start of parts region.
|-
|0x2c
|0x4
|AsbPtr<u32[Parts Count]>
|Parts Index Array - Array of indices to parts
|-
|0x30
|0x4
|AsbPtr<Blackboard>
|Blackboard
|-
|0x34
|0x4
|AsbPtr<char>
|String Pool
|-
|0x38
|0x4
|AsbPtr<AsbArray<Enum Relocation>>
|Enum Relocation Array
|-
|0x3c
|0x4
|AsbPtr<AsbArray<State>>
|State Array
|-
|0x40
|0x4
|u32
|Float Property Ex Count
|-
|0x44
|0x4
|AsbPtr<Float Property Ex[Float Property Ex Count]>
|Float Property Ex Array
|-
|0x48
|0x4
|u32
|Bone Blend Count
|-
|0x4c
|0x4
|AsbPtr<Bone Blend[Bone Blend Count]>
|Bone Blend Array
|-
|0x50
|0x4
|u32
|Partial Skeleton Count
|-
|0x54
|0x4
|AsbPtr<Partial Skeleton[Partial Skeleton Count]>
|Partial Skeleton Array
|-
|0x58
|0x4
|u32
|String Pool Size
|-
|0x5c
|0x4
|AsbPtr<Transition Array>
|Transition Array
|-
|0x60
|0x4
|AsbPtr<AsbArray<u32>>
|Transition Partial Skeleton Array
|-
|0x64
|0x4
|AsbPtr<AsbArray<AsbString>>
|Tag Array
|-
|0x68
|0x4
|AsbPtr<AsbArray<External Action>>
|External Action Array
|-
|0x6c
|0x4
|AsbPtr<Exb>
|Exb
|-
|0x70
|0x4
|u32
|Transition Group Array
|-
|0x78
|0x4
|AsbPtr<AsbArray<Material Blend>>
|Material Blend Array
|}

=== Property<T> ===
Property types include s32 (can be an enum), bool(32-bit), float, AsbString, and Vector3f.
{| class="wikitable"
|+ Property<T>
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Flags and Index
|-
|0x04
|0x04 or 0x0C
|T
|Value
|}

If the top bit of the flags is set, then the bottom two bytes of the flags become an index value. If it is not set, then the provided value is value of the parameter. If <code>flags & 1 << 0x18 != 0</code>, then the index is an expression index (EXB) and the normal value field becomes the input value for the expression. If <code>flags & 1 << 0x1e != 0</code>, then the index is a calculation result cache index (this stores the previously evaluated value and calculates the new value from the cached value on subsequent accesses). Note, this is only applicable if the parameter is a float. Otherwise, if <code>flags & 1 << 0x19 != 0</code>, then the index specifies the command data type. 0 is the current frame normalized (i.e. <code>(current_frame - start_frame)/total_duration</code>), 1 and 2 are random float values between 0.0 and 1.0, 3 is an unknown string value, 4 is the command's fade in frame, and 6 is an unknown float value. Note, this only applies if the parameter is a float or a string. In all other cases, the index is a blackboard index and value of the parameter is the value of the corresponding blackboard parameter. For float parameters specifically, <code>flags >> 0x1a & 3</code> specifies the exact parameter source. 0 is a float blackboard parameter while 1, 2, or 3 are a vector3f blackboard parameter with 1, 2, and 3 being the x, y, and z components respectively.

=== Command ===
Defines a command that can be played by an as::Controller. The command is composed of a behavior tree of elements.
{| class="wikitable"
|+Command (0x417)
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Name Offset
|-
|0x04
|0x04
|u32
|Tag Entry Offset (version 0x417+)
|-
|0x08
|0x08
|Property<float>
|
|-
|0x10
|0x08
|Property<bool>
|Is Ignore Same Command
|-
|0x18
|0x04
|u32
|Interpolation Type (uncertain, but 0 = unspecified, 1 = no model morph, 3 = enable local bone morph, 4 = enable inertial blend)
|-
| rowspan="5" |0x1C
| rowspan="5" |0x10
|u32
| rowspan="5" |GUID
|-
|u16
|-
|u16
|-
|u8[2]
|-
|u8[6]
|-
|0x2C
|0x02
|u16
|Child Node Index
|-
|0x2E
|0x02
|u16
|
|}
{| class="wikitable"
|+Command (0x41b)
!Offset
!Size
!Type
!Description
|-
|0x00
|0x4
|AsbString
|Name
|-
|0x04
|0x4
|AsbPtr<AsbArray<AsbString>>
|Tag Array
|-
|0x08
|0x8
|Property<float>
|Frame Count
|-
|0x10
|0x4
|u32
|Debug flag for host io?
|-
|0x14
|0x8
|Property<InterpolationType>
|Default Interpolation Type
|-
|0x1c
|0x10
|Guid
|Guid
|-
|0x2c
|0x2
|u16
|Element Id
|-
|0x2e
|0x2
|u16
|
|}

==== Interpolation Type ====
Enum for (known) interpolation types.
{| class="wikitable"
|+Interpolation Type
!Name
!Value
!Description
|-
|Default
|0
|
|-
|None
|1
|
|-
|Cross Fade
|2
|
|-
|Local Bone
|3
|
|-
|Inertia Local Bone
|4
|
|-
|Parts
|5
|
|}

=== Element ===
{| class="wikitable"
|+Element (0x417)
!Offset
!Size
!Type
!Description
|-
|0x00
|0x02
|AsbNodeType
|Node Type
|-
|0x02
|0x01
|u8
|Sync Data Count
|-
|0x03
|0x01
|u8
|Does Not Have State Transition
|-
|0x04
|0x04
|u32
|Tag Entry Offset
|-
|0x08
|0x04
|u32
|Node Body Offset
|-
|0x0C
|0x02
|u16
|Calculation Result Cache Index
|-
|0x0E
|0x02
|u16
|Calculation Result Cache Count
|-
|0x10
|0x02
|u16
|Sync Data Index Array Index
|-
|0x12
|0x02
|u16
|AS Markings Index (-1 for index)
|-
| rowspan="5" |0x14
| rowspan="5" |0x10
|u32
| rowspan="5" |GUID
|-
|u16
|-
|u16
|-
|u8[2]
|-
|u8[6]
|}
{| class="wikitable"
|+Element (0x41b)
!Offset
!Size
!Type
!Description
|-
|0x0
|0x2
|u16
|Element Type
|-
|0x2
|0x1
|u8
|Parts Count
|-
|0x3
|0x1
|u8
|Is No State End
|-
|0x4
|0x4
|AsbPtr<AsbArray<AsbString>>
|Tag Array
|-
|0x8
|0x4
|AsbPtr<ElementParam<Element Type>>
|Element Param
|-
|0xc
|0x2
|u16
|Float Property Ex Flags
|-
|0xe
|0x2
|u16
|Float Property Ex Count
|-
|0x10
|0x2
|u16
|Base Parts Index Id
|-
|0x12
|0x2
|u16
|External Action Id
|-
|0x14
|0x10
|Guid
|
|}

==== Element Type ====
Enum of element types.
{| class="wikitable"
|+Element Type
!Value (Hex)
!Value (Dec)
!Node Type
|-
|0x01
|1
|FloatSelector
|-
|0x02
|2
|StringSelector
|-
|0x03
|3
|SkeletalAnimation
|-
|0x04
|4
|State
|-
|0x05
|5
|StateEnd
|-
|0x06
|6
|OneDimensionalBlender
|-
|0x07
|7
|Sequential
|-
|0x08
|8
|IntSelector
|-
|0x09
|9
|Simultaneous
|-
|0x0A
|10
|Event
|-
|0x0B
|11
|MaterialAnimation
|-
|0x0C
|12
|FrameController
|-
|0x0D
|13
|DummyAnimation
|-
|0x0E
|14
|RandomSelector
|-
|0x0F
|15
|StateEnd
|-
|0x10
|16
|PreviousTagSelector
|-
|0x11
|17
|BonePositionSelector
|-
|0x12
|18
|BoneVisibilityAnimation
|-
|0x13
|19
|InitialFrame
|-
|0x14
|20
|BoneBlender
|-
|0x15
|21
|BoolSelector
|-
|0x16
|22
|Alert
|-
|0x17
|23
|SubtractAnimation
|-
|0x18
|24
|ShapeAnimation
|-
|0x19
|25
|
|-
|0x1a
|26
|TwoDimensionalBlender
|-
|0x1b
|27
|
|}

==== ElementPlugs ====
The plug struct provides relative offsets to "plug" data.
{| class="wikitable"
|+ElementPlugs (0x41b)
!Offset
!Size
!Type
!Description
|-
|0x0
|0x1
|u8
|State Count
|-
|0x1
|0x1
|u8
|State Base Index
|-
|0x2
|0x1
|u8
|Unknown Count
|-
|0x3
|0x1
|u8
|Unknown Base Index
|-
|0x4
|0x1
|u8
|Child Count
|-
|0x5
|0x1
|u8
|Child Base Index
|-
|0x6
|0x1
|u8
|Exb Count
|-
|0x7
|0x1
|u8
|Exb Base Index
|-
|0x8
|0x1
|u8
|Event Count
|-
|0x9
|0x1
|u8
|Event Base Index
|-
|0xa
|0x1
|u8
|Frame Controller Count
|-
|0xb
|0x1
|u8
|Frame Controller Base Index
|-
|0xc
|0x4 * Frame Controller Base Index + Frame Controller Count
|u32[]
|Plug Data Offset Array - Offsets relative to start of plug table
|}

===== Child Plug =====
Only known are listed.

====== Default ======
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Child Element Id
|}

====== FloatSelector, OneDimensionalBlender, BonePositionSelector Elements ======
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<float>
|Min
|-
|0x8
|0x8
|Property<float>
|Max
|-
|0x10
|0x4
|u32
|Child Element Id
|}

====== StringSelector Element ======
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<AsbString>
|Value
|-
|0x8
|0x4
|u32
|Child Element Id
|}

====== IntSelector Element ======
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<s32>
|Value
|-
|0x8
|0x4
|u32
|Child Element Id
|}

====== RandomSelector Element ======
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<float>
|Value
|-
|0x8
|0x4
|u32
|Child Element Id
|}

====== PreviousTagSelector Element ======
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|AsbPtr<AsbArray<AsbString>>
|Tag Array
|-
|0x8
|0x4
|u32
|Child Element Id
|}

===== Event Plug =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Event Element Id
|}

===== Frame Controller Plug =====
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Frame Controller Element Id
|}

==== ElementParam<Element Type> ====

===== FloatSelector Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<float>
|Select Value
|-
|0x8
|0x8
|Property<bool>
|Is Slot Sync
|-
|0x10
|0x4
|u32
|
|-
|0x14
|0xc + N
|ElementPlugs
|Plugs
|}

===== StringSelector Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<float>
|Select Value
|-
|0x8
|0x8
|Property<bool>
|Is Slot Sync
|-
|0x10
|0x4
|u32
|
|-
|0x14
|0xc + N
|ElementPlugs
|Plugs
|}

===== SkeletalAnimation Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<AsbString>
|Animation Name
|-
|0x8
|0x4
|u32
|
|-
|0xc
|0x4
|u32
|
|-
|0x10
|0x8
|Property<bool>
|Is Offset Frame
|-
|0x18
|0x8
|Property<float>
|Frame Offset
|-
|0x20
|0xc + N
|ElementPlugs
|Plugs
|}

===== State Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0xc + N
|ElementPlugs
|Plugs
|}

===== OneDimensionalBlender Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<float>
|Selector weight
|-
|0x8
|0x4
|u32
|Easing Type (1 = ease)
|-
|0xc
|0xc + N
|ElementPlugs
|Plugs
|}

===== Sequential Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<bool>
|
|-
|0x8
|0x8
|Property<s32>
|
|-
|0x10
|0x8
|Property<bool>
|
|-
|0x18
|0xc + N
|ElementPlugs
|Plugs
|}

===== IntSelector Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<s32>
|Select Value
|-
|0x8
|0x8
|Property<bool>
|Is Slot Sync
|-
|0x10
|0x4
|u32
|
|-
|0x14
|0xc + N
|ElementPlugs
|Plugs
|}

===== Simultaneous Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|State End Type (0 = no children, 1 = first child state end)
|-
|0x8
|0xc + N
|ElementPlugs
|Plugs
|}

===== Event Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|
|-
|0x8
|0xc + N
|ElementPlugs
|Plugs
|}

===== MaterialAnimation Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Material Blend Id
|-
|0x4
|0x8
|Property<AsbString>
|Animation Name
|-
|0xc
|0x8
|Property<bool>
|
|-
|0x14
|0xc + N
|ElementPlugs
|Plugs
|}

===== FrameController Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<float>
|Play Rate
|-
|0x8
|0x8
|Property<float>
|Loop Start
|-
|0x10
|0x8
|Property<float>
|Loop End
|-
|0x18
|0x4
|u32
|
|-
|0x1c
|0x8
|Property<bool>
|Is Kill Loop
|-
|0x24
|0x8
|Property<bool>
|
|-
|0x2c
|0x8
|Property<s32>
|Frame Count
|-
|0x34
|0x8
|Property<s32>
|Random Range
|-
|0x3c
|0x8
|Property<bool>
|Is Local Random
|-
|0x44
|0x8
|Property<float>
|Frame Offset
|-
|0x4c
|0x8
|Property<float>
|Current Frame
|-
|0x54
|0x8
|Property<float>
|
|-
|0x5c
|0x4
|u32
|
|-
|0x60
|0x8
|Property<float>
|
|-
|0x68
|0x8
|Property<bool>
|
|-
|0x70
|0x8
|Property<bool>
|Is Retarget Play Rate
|-
|0x78
|0xc + N
|ElementPlugs
|Plugs
|}

===== DummyAnimation Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<float>
|Frame Count
|-
|0x8
|0x8
|Property<bool>
|Is Looping
|-
|0x10
|0xc + N
|ElementPlugs
|Plugs
|}

===== RandomSelector Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Judge Timing
|-
|0x4
|0x8
|Property<bool>
|Is Slot Sync
|-
|0xc
|0x8
|Property<s32>
|
|-
|0x14
|0x8
|Property<>
|Unknown
|-
|0x1c
|0x4
|u32
|
|-
|0x20
|0xc + N
|ElementPlugs
|Plugs
|}

===== PreviousTagSelector Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|
|-
|0x4
|0xc + N
|ElementPlugs
|Plugs
|}

===== BonePositionSelector Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<AsbString>
|Left Bone Name
|-
|0x8
|0x8
|Property<AsbString>
|Right Bone Name
|-
|0xc
|0x4
|u32
|Component Id - (0 = X, 1 = Y, 2 = Z) component to generate bone position difference from
|-
|0x10
|0x4
|u32
|Judge Timing
|-
|0x14
|0x8
|Property<bool>
|Is Slot Sync
|-
|0x1c
|0xc + N
|ElementPlugs
|Plugs
|}

===== BoneVisibilityAnimation Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<AsbString>
|Animation Name
|-
|0x8
|0x8
|Property<bool>
|
|-
|0x10
|0x8
|Property<bool>
|Is Offset Frame
|-
|0x18
|0x8
|Property<float>
|Frame Offset
|-
|0x20
|0xc + N
|ElementPlugs
|Plugs
|}

===== InitialFrame Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Initial Frame Type
|-
|0x4
|0x4
|AsbPtr<AsbArray<AsbString>>
|Tag Array
|-
|0x8
|0x8
|Property<bool>
|Is Share By Same Anim key
|-
|0x10
|0x8
|Property<AsbString>
|Left Bone Name
|-
|0x18
|0x8
|Property<AsbString>
|Right Bone Name
|-
|0x20
|0x4
|u32
|Component Id
|-
|0x24
|0x8
|Property<bool>
|Is Random
|-
|0x2c
|0x8
|Property<bool>
|Is Fixed Random
|-
|0x34
|0xc + N
|ElementPlugs
|Plugs
|}

====== Initial Frame Type ======
{| class="wikitable"
|+
!Name
|-
|Start
|-
|FrameOffset
|-
|InvFrameOffset
|-
|Random
|-
|BonePosition
|-
|End
|-
|Frame
|-
|InvFrame
|-
|SlotSync
|}

===== BoneBlender Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<AsbString>
|Bone Blend Name
|-
|0x8
|0x4
|u32
|Sync Child Id
|-
|0xc
|0x8
|Property<float>
|Bone Blend Mode Value
|-
|0x14
|0x4
|u32
|Bone Blend Mode
|-
|0x18
|0x4
|u32
|State End Mode (0 = all, 1 = child 0, 2 = child 1)
|-
|0x1c
|0xc + N
|ElementPlugs
|Plugs
|}

===== BoolSelector Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<bool>
|Select Value
|-
|0x8
|0x8
|Property<bool>
|Is Slot Sync
|-
|0x10
|0x4
|u32
|
|-
|0x14
|0xc + N
|ElementPlugs
|Plugs
|}

===== Alert =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<AsbString>
|Alert
|-
|0x8
|0xc + N
|ElementPlugs
|Plugs
|}

===== SubtractAnimation Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0xc + N
|ElementPlugs
|Plugs
|}

===== ShapeAnimation Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<AsbString>
|Animation Name
|-
|0x8
|0xc + N
|ElementPlugs
|Plugs
|}

===== TwoDimensionalBlender Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<float>
|Selector Weight 0
|-
|0x8
|0x8
|Property<float>
|Selector Weight 1
|-
|0x10
|0x4
|u32
|Offset to key frame array relative to 0x10 of this struct?
|-
|0x14
|0x4
|u32
|Offset to key data array relative to 0x10 of this struct?
|-
|0x18
|0xc + N
|ElementPlugs
|Plugs
|}
[[Category:File formats]]

ASB

2026-01-07T12:43:54Z

Watertoon: Correct exb pointer field type in header

'''ASB''' ('''A'''nimation '''S'''equence '''B'''inary) is a file format used to store animation sequences for actors in recent Nintendo EPD games such as ''The Legend of Zelda: Tears of the Kingdom'' and ''Nintendo Switch Sports''. This article is primarily aimed at the version that appears in ''Tears of the Kingdom'' and ''Mario vs Donkey Kong'' (v0x0417). Other ASB versions include 0x304 (''Ring Fit Adventure''), 0x3FB (''Labo Toy-Con 04'' and ''Game Builder Garage''), 0x407 (''Animal Crossing: New Horizons''), 0x40F (''Nintendo Switch Sports''), 0x410 (''Splatoon 3''), 0x418 (''Super Mario Bros. Wonder''), and 0x41A (''Nintendo Switch Online: Playtest Program''). ASB files can be found in the AS folder of the romfs as well as the AS folder of certain pack files.

== File Structure ==
ASB is a little endian format which consists of node pathways triggered by AS commands. When an AS command is called, it runs the sequence of nodes connected to it which trigger and control animations and animation logic. Nodes are arranged in an array and referenced and accessed by their array index. Despite the presence of animation events in ASB files, these events do not appear to be used by the game.

All string offsets in the file are relative to the start of the string pool and name hashes are 32-bit murmur3 hashes. There are six possible parameter types: string, int (32-bit signed integer), float (32-bit floating point number), bool, vector3f, and pointer (object pointer, this is not actually possible in ASB, only usable in AINB).

Documentation is still sparse, refer to [https://github.com/dt-12345/asb this repository] for more details (names may not match exactly).

=== Section Order ===

==== Version 0x417 ====
# File Header (0x6C bytes in version 0x417, 0x68 bytes in version 0x40F)
# AS Commands
# Nodes
# Event Entry Offsets
# Node Bodies
# Sync Data Entry Indices
# Sync Data
# State Transitions
# Events (in games that use BAEV, these events are non-functional)
# Transitions
# Command Groups
# AS Blackboard Parameters
# Partials
# Bone Groups
# Calculation Result Cache
# Valid Tag List
# Tag Groups
# Expression Binary
# AS Markings
# Material Blend Settings
# Enum Resolve Table
# String Pool

== Structures ==

=== Helpers ===

==== AsbString ====
Represents a u32 offset relative to the start of the file's string pool.

==== AsbPtr <T> ====
Represents a u32 absolute offset from the start of the file to the struct of type "T" enclosed by <>.

==== AsbArray <T> ====
Represents a u32 absolute offset from the start of the file to:
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Count
|-
|0x4
|
|T[Count]
|Array of struct of type T. Note; asb files only use 32-bit aligned types.
|}

=== File Header ===
{| class="wikitable"
|+File Header (0x417)
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|char[4]
|Magic - "ASB "
|-
|0x04
|0x04
|u32
|Version (0x0417 in ''Tears of the Kingdom'')
|-
|0x08
|0x04
|u32
|Filename Offset
|-
|0x0C
|0x04
|u32
|AS Command Count
|-
|0x10
|0x04
|u32
|Node Count
|-
|0x14
|0x04
|u32
|Event Count
|-
|0x18
|0x04
|u32
|Partial Count
|-
|0x1C
|0x04
|u32
|Sync Data Entry Count
|-
|0x20
|0x04
|u32
|AS Blackboard Parameters Offset
|-
|0x24
|0x04
|u32
|String Pool Offset
|-
|0x28
|0x04
|u32
|Enum Resolve Table Offset
|-
|0x2C
|0x04
|u32
|State Transitions Offset
|-
|0x30
|0x04
|u32
|Event Entries Offset Array Offset
|-
|0x34
|0x04
|u32
|Partials Offset
|-
|0x38
|0x04
|u32
|Sync Data Offset
|-
|0x3C
|0x04
|u32
|Sync Data Indices Array Offset
|-
|0x40
|0x04
|u32
|Calculation Result Cache Offset
|-
|0x44
|0x04
|u32
|Calculation Result Cache Count
|-
|0x48
|0x04
|u32
|Bone Groups Offset
|-
|0x4C
|0x04
|u32
|Bone Group Count
|-
|0x50
|0x04
|u32
|String Pool Size
|-
|0x54
|0x04
|u32
|Transitions Offset
|-
|0x58
|0x04
|u32
|Tag List Offset
|-
|0x5C
|0x04
|u32
|String Triplets Offset
|-
|0x60
|0x04
|u32
|Expression Offset (empty if section does not exist)
|-
|0x64
|0x04
|u32
|Command Groups Offset (empty if section does not exist)
|-
|0x68
|0x04
|u32
|Material Blend Settings Offset (version 0x417 only)
|}
{| class="wikitable"
|+File Header (0x41b)
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Magic - "ASB "
|-
|0x4
|0x4
|u32
|Version - (0x41b in Nintendo Switch Online: Playtest version 021)
|-
|0x8
|0x4
|AsbString
|Name Offset
|-
|0xc
|0x4
|u32
|Command Count
|-
|0x10
|0x4
|AsbPtr<Command[Command Count]>
|Command Array
|-
|0x14
|0x4
|u32
|Element Count
|-
|0x18
|0x4
|AsbPtr<Element[Element Count]>
|Element Array
|-
|0x1c
|0x4
|u32
|Event Count - The pointer and count are erroneously present, but the section is not actually written in applications that support the baev file format.
|-
|0x20
|0x4
|AsbPtr<Event[Event Count]>
|Event Array
|-
|0x24
|0x4
|u32
|Parts Count
|-
|0x28
|0x4
|AsbPtr<Parts>
|Parts Region - Pointer to start of parts region.
|-
|0x2c
|0x4
|AsbPtr<u32[Parts Count]>
|Parts Index Array - Array of indices to parts
|-
|0x30
|0x4
|AsbPtr<Blackboard>
|Blackboard
|-
|0x34
|0x4
|AsbPtr<char>
|String Pool
|-
|0x38
|0x4
|u32
|Float Property Ex Count
|-
|0x3c
|0x4
|AsbPtr<Float Property Ex[Float Property Ex Count]>
|Float Property Ex Array
|-
|0x40
|0x4
|u32
|Bone Blend Count
|-
|0x44
|0x4
|AsbPtr<Bone Blend[Bone Blend Count]>
|Bone Blend Array
|-
|0x48
|0x4
|u32
|Partial Skeleton Count
|-
|0x4c
|0x4
|AsbPtr<Partial Skeleton[Partial Skeleton Count]>
|Partial Skeleton Array
|-
|0x50
|0x4
|u32
|String Pool Size
|-
|0x54
|0x4
|AsbPtr<Transition Array>
|Transition Array
|-
|0x58
|0x4
|AsbPtr<AsbArray<u32>>
|Transition Partial Skeleton Array
|-
|0x5c
|0x4
|AsbPtr<AsbArray<AsbString>>
|Tag Array
|-
|0x60
|0x4
|AsbPtr<AsbArray<External Action>>
|External Action Array
|-
|0x64
|0x4
|AsbPtr<Exb>
|Exb
|-
|0x68
|0x4
|u32
|Transition Group Array
|-
|0x6c
|0x4
|AsbPtr<AsbArray<Material Blend>>
|Material Blend Array
|}

=== Property<T> ===
Property types include s32 (can be an enum), bool(32-bit), float, AsbString, and Vector3f.
{| class="wikitable"
|+ Property<T>
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Flags and Index
|-
|0x04
|0x04 or 0x0C
|T
|Value
|}

If the top bit of the flags is set, then the bottom two bytes of the flags become an index value. If it is not set, then the provided value is value of the parameter. If <code>flags & 1 << 0x18 != 0</code>, then the index is an expression index (EXB) and the normal value field becomes the input value for the expression. If <code>flags & 1 << 0x1e != 0</code>, then the index is a calculation result cache index (this stores the previously evaluated value and calculates the new value from the cached value on subsequent accesses). Note, this is only applicable if the parameter is a float. Otherwise, if <code>flags & 1 << 0x19 != 0</code>, then the index specifies the command data type. 0 is the current frame normalized (i.e. <code>(current_frame - start_frame)/total_duration</code>), 1 and 2 are random float values between 0.0 and 1.0, 3 is an unknown string value, 4 is the command's fade in frame, and 6 is an unknown float value. Note, this only applies if the parameter is a float or a string. In all other cases, the index is a blackboard index and value of the parameter is the value of the corresponding blackboard parameter. For float parameters specifically, <code>flags >> 0x1a & 3</code> specifies the exact parameter source. 0 is a float blackboard parameter while 1, 2, or 3 are a vector3f blackboard parameter with 1, 2, and 3 being the x, y, and z components respectively.

=== Command ===
Defines a command that can be played by an as::Controller. The command is composed of a behavior tree of elements.
{| class="wikitable"
|+Command (0x417)
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Name Offset
|-
|0x04
|0x04
|u32
|Tag Entry Offset (version 0x417+)
|-
|0x08
|0x08
|Property<float>
|
|-
|0x10
|0x08
|Property<bool>
|Is Ignore Same Command
|-
|0x18
|0x04
|u32
|Interpolation Type (uncertain, but 0 = unspecified, 1 = no model morph, 3 = enable local bone morph, 4 = enable inertial blend)
|-
| rowspan="5" |0x1C
| rowspan="5" |0x10
|u32
| rowspan="5" |GUID
|-
|u16
|-
|u16
|-
|u8[2]
|-
|u8[6]
|-
|0x2C
|0x02
|u16
|Child Node Index
|-
|0x2E
|0x02
|u16
|
|}
{| class="wikitable"
|+Command (0x41b)
!Offset
!Size
!Type
!Description
|-
|0x00
|0x4
|AsbString
|Name
|-
|0x04
|0x4
|AsbPtr<AsbArray<AsbString>>
|Tag Array
|-
|0x08
|0x8
|Property<float>
|Frame Count
|-
|0x10
|0x4
|u32
|Debug flag for host io?
|-
|0x14
|0x8
|Property<InterpolationType>
|Default Interpolation Type
|-
|0x1c
|0x10
|Guid
|Guid
|-
|0x2c
|0x2
|u16
|Element Id
|-
|0x2e
|0x2
|u16
|
|}

==== Interpolation Type ====
Enum for (known) interpolation types.
{| class="wikitable"
|+Interpolation Type
!Name
!Value
!Description
|-
|Default
|0
|
|-
|None
|1
|
|-
|Cross Fade
|2
|
|-
|Local Bone
|3
|
|-
|Inertia Local Bone
|4
|
|-
|Parts
|5
|
|}

=== Element ===
{| class="wikitable"
|+Element (0x417)
!Offset
!Size
!Type
!Description
|-
|0x00
|0x02
|AsbNodeType
|Node Type
|-
|0x02
|0x01
|u8
|Sync Data Count
|-
|0x03
|0x01
|u8
|Does Not Have State Transition
|-
|0x04
|0x04
|u32
|Tag Entry Offset
|-
|0x08
|0x04
|u32
|Node Body Offset
|-
|0x0C
|0x02
|u16
|Calculation Result Cache Index
|-
|0x0E
|0x02
|u16
|Calculation Result Cache Count
|-
|0x10
|0x02
|u16
|Sync Data Index Array Index
|-
|0x12
|0x02
|u16
|AS Markings Index (-1 for index)
|-
| rowspan="5" |0x14
| rowspan="5" |0x10
|u32
| rowspan="5" |GUID
|-
|u16
|-
|u16
|-
|u8[2]
|-
|u8[6]
|}
{| class="wikitable"
|+Element (0x41b)
!Offset
!Size
!Type
!Description
|-
|0x0
|0x2
|u16
|Element Type
|-
|0x2
|0x1
|u8
|Parts Count
|-
|0x3
|0x1
|u8
|Is No State End
|-
|0x4
|0x4
|AsbPtr<AsbArray<AsbString>>
|Tag Array
|-
|0x8
|0x4
|AsbPtr<ElementParam<Element Type>>
|Element Param
|-
|0xc
|0x2
|u16
|Float Property Ex Flags
|-
|0xe
|0x2
|u16
|Float Property Ex Count
|-
|0x10
|0x2
|u16
|Base Parts Index Id
|-
|0x12
|0x2
|u16
|External Action Id
|-
|0x14
|0x10
|Guid
|
|}

==== Element Type ====
Enum of element types.
{| class="wikitable"
|+Element Type
!Value (Hex)
!Value (Dec)
!Node Type
|-
|0x01
|1
|FloatSelector
|-
|0x02
|2
|StringSelector
|-
|0x03
|3
|SkeletalAnimation
|-
|0x04
|4
|State
|-
|0x05
|5
|StateEnd
|-
|0x06
|6
|OneDimensionalBlender
|-
|0x07
|7
|Sequential
|-
|0x08
|8
|IntSelector
|-
|0x09
|9
|Simultaneous
|-
|0x0A
|10
|Event
|-
|0x0B
|11
|MaterialAnimation
|-
|0x0C
|12
|FrameController
|-
|0x0D
|13
|DummyAnimation
|-
|0x0E
|14
|RandomSelector
|-
|0x0F
|15
|StateEnd
|-
|0x10
|16
|PreviousTagSelector
|-
|0x11
|17
|BonePositionSelector
|-
|0x12
|18
|BoneVisibilityAnimation
|-
|0x13
|19
|InitialFrame
|-
|0x14
|20
|BoneBlender
|-
|0x15
|21
|BoolSelector
|-
|0x16
|22
|Alert
|-
|0x17
|23
|SubtractAnimation
|-
|0x18
|24
|ShapeAnimation
|-
|0x19
|25
|
|-
|0x1a
|26
|TwoDimensionalBlender
|-
|0x1b
|27
|
|}

==== ElementPlugs ====
The plug struct provides relative offsets to "plug" data.
{| class="wikitable"
|+ElementPlugs (0x41b)
!Offset
!Size
!Type
!Description
|-
|0x0
|0x1
|u8
|State Count
|-
|0x1
|0x1
|u8
|State Base Index
|-
|0x2
|0x1
|u8
|Unknown Count
|-
|0x3
|0x1
|u8
|Unknown Base Index
|-
|0x4
|0x1
|u8
|Child Count
|-
|0x5
|0x1
|u8
|Child Base Index
|-
|0x6
|0x1
|u8
|Exb Count
|-
|0x7
|0x1
|u8
|Exb Base Index
|-
|0x8
|0x1
|u8
|Event Count
|-
|0x9
|0x1
|u8
|Event Base Index
|-
|0xa
|0x1
|u8
|Frame Controller Count
|-
|0xb
|0x1
|u8
|Frame Controller Base Index
|-
|0xc
|0x4 * Frame Controller Base Index + Frame Controller Count
|u32[]
|Plug Data Offset Array - Offsets relative to start of plug table
|}

===== Child Plug =====
Only known are listed.

====== Default ======
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Child Element Id
|}

====== FloatSelector, OneDimensionalBlender, BonePositionSelector Elements ======
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<float>
|Min
|-
|0x8
|0x8
|Property<float>
|Max
|-
|0x10
|0x4
|u32
|Child Element Id
|}

====== StringSelector Element ======
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<AsbString>
|Value
|-
|0x8
|0x4
|u32
|Child Element Id
|}

====== IntSelector Element ======
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<s32>
|Value
|-
|0x8
|0x4
|u32
|Child Element Id
|}

====== RandomSelector Element ======
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<float>
|Value
|-
|0x8
|0x4
|u32
|Child Element Id
|}

====== PreviousTagSelector Element ======
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|AsbPtr<AsbArray<AsbString>>
|Tag Array
|-
|0x8
|0x4
|u32
|Child Element Id
|}

===== Event Plug =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Event Element Id
|}

===== Frame Controller Plug =====
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Frame Controller Element Id
|}

==== ElementParam<Element Type> ====

===== FloatSelector Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<float>
|Select Value
|-
|0x8
|0x8
|Property<bool>
|Is Slot Sync
|-
|0x10
|0x4
|u32
|
|-
|0x14
|0xc + N
|ElementPlugs
|Plugs
|}

===== StringSelector Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<float>
|Select Value
|-
|0x8
|0x8
|Property<bool>
|Is Slot Sync
|-
|0x10
|0x4
|u32
|
|-
|0x14
|0xc + N
|ElementPlugs
|Plugs
|}

===== SkeletalAnimation Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<AsbString>
|Animation Name
|-
|0x8
|0x4
|u32
|
|-
|0xc
|0x4
|u32
|
|-
|0x10
|0x8
|Property<bool>
|Is Offset Frame
|-
|0x18
|0x8
|Property<float>
|Frame Offset
|-
|0x20
|0xc + N
|ElementPlugs
|Plugs
|}

===== State Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0xc + N
|ElementPlugs
|Plugs
|}

===== OneDimensionalBlender Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<float>
|Selector weight
|-
|0x8
|0x4
|u32
|Easing Type (1 = ease)
|-
|0xc
|0xc + N
|ElementPlugs
|Plugs
|}

===== Sequential Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<bool>
|
|-
|0x8
|0x8
|Property<s32>
|
|-
|0x10
|0x8
|Property<bool>
|
|-
|0x18
|0xc + N
|ElementPlugs
|Plugs
|}

===== IntSelector Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<s32>
|Select Value
|-
|0x8
|0x8
|Property<bool>
|Is Slot Sync
|-
|0x10
|0x4
|u32
|
|-
|0x14
|0xc + N
|ElementPlugs
|Plugs
|}

===== Simultaneous Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|State End Type (0 = no children, 1 = first child state end)
|-
|0x8
|0xc + N
|ElementPlugs
|Plugs
|}

===== Event Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|
|-
|0x8
|0xc + N
|ElementPlugs
|Plugs
|}

===== MaterialAnimation Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Material Blend Id
|-
|0x4
|0x8
|Property<AsbString>
|Animation Name
|-
|0xc
|0x8
|Property<bool>
|
|-
|0x14
|0xc + N
|ElementPlugs
|Plugs
|}

===== FrameController Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<float>
|Play Rate
|-
|0x8
|0x8
|Property<float>
|Loop Start
|-
|0x10
|0x8
|Property<float>
|Loop End
|-
|0x18
|0x4
|u32
|
|-
|0x1c
|0x8
|Property<bool>
|Is Kill Loop
|-
|0x24
|0x8
|Property<bool>
|
|-
|0x2c
|0x8
|Property<s32>
|Frame Count
|-
|0x34
|0x8
|Property<s32>
|Random Range
|-
|0x3c
|0x8
|Property<bool>
|Is Local Random
|-
|0x44
|0x8
|Property<float>
|Frame Offset
|-
|0x4c
|0x8
|Property<float>
|Current Frame
|-
|0x54
|0x8
|Property<float>
|
|-
|0x5c
|0x4
|u32
|
|-
|0x60
|0x8
|Property<float>
|
|-
|0x68
|0x8
|Property<bool>
|
|-
|0x70
|0x8
|Property<bool>
|Is Retarget Play Rate
|-
|0x78
|0xc + N
|ElementPlugs
|Plugs
|}

===== DummyAnimation Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<float>
|Frame Count
|-
|0x8
|0x8
|Property<bool>
|Is Looping
|-
|0x10
|0xc + N
|ElementPlugs
|Plugs
|}

===== RandomSelector Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Judge Timing
|-
|0x4
|0x8
|Property<bool>
|Is Slot Sync
|-
|0xc
|0x8
|Property<s32>
|
|-
|0x14
|0x8
|Property<>
|Unknown
|-
|0x1c
|0x4
|u32
|
|-
|0x20
|0xc + N
|ElementPlugs
|Plugs
|}

===== PreviousTagSelector Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|
|-
|0x4
|0xc + N
|ElementPlugs
|Plugs
|}

===== BonePositionSelector Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<AsbString>
|Left Bone Name
|-
|0x8
|0x8
|Property<AsbString>
|Right Bone Name
|-
|0xc
|0x4
|u32
|Component Id - (0 = X, 1 = Y, 2 = Z) component to generate bone position difference from
|-
|0x10
|0x4
|u32
|Judge Timing
|-
|0x14
|0x8
|Property<bool>
|Is Slot Sync
|-
|0x1c
|0xc + N
|ElementPlugs
|Plugs
|}

===== BoneVisibilityAnimation Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<AsbString>
|Animation Name
|-
|0x8
|0x8
|Property<bool>
|
|-
|0x10
|0x8
|Property<bool>
|Is Offset Frame
|-
|0x18
|0x8
|Property<float>
|Frame Offset
|-
|0x20
|0xc + N
|ElementPlugs
|Plugs
|}

===== InitialFrame Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Initial Frame Type
|-
|0x4
|0x4
|AsbPtr<AsbArray<AsbString>>
|Tag Array
|-
|0x8
|0x8
|Property<bool>
|Is Share By Same Anim key
|-
|0x10
|0x8
|Property<AsbString>
|Left Bone Name
|-
|0x18
|0x8
|Property<AsbString>
|Right Bone Name
|-
|0x20
|0x4
|u32
|Component Id
|-
|0x24
|0x8
|Property<bool>
|Is Random
|-
|0x2c
|0x8
|Property<bool>
|Is Fixed Random
|-
|0x34
|0xc + N
|ElementPlugs
|Plugs
|}

====== Initial Frame Type ======
{| class="wikitable"
|+
!Name
|-
|Start
|-
|FrameOffset
|-
|InvFrameOffset
|-
|Random
|-
|BonePosition
|-
|End
|-
|Frame
|-
|InvFrame
|-
|SlotSync
|}

===== BoneBlender Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<AsbString>
|Bone Blend Name
|-
|0x8
|0x4
|u32
|Sync Child Id
|-
|0xc
|0x8
|Property<float>
|Bone Blend Mode Value
|-
|0x14
|0x4
|u32
|Bone Blend Mode
|-
|0x18
|0x4
|u32
|State End Mode (0 = all, 1 = child 0, 2 = child 1)
|-
|0x1c
|0xc + N
|ElementPlugs
|Plugs
|}

===== BoolSelector Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<bool>
|Select Value
|-
|0x8
|0x8
|Property<bool>
|Is Slot Sync
|-
|0x10
|0x4
|u32
|
|-
|0x14
|0xc + N
|ElementPlugs
|Plugs
|}

===== Alert =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<AsbString>
|Alert
|-
|0x8
|0xc + N
|ElementPlugs
|Plugs
|}

===== SubtractAnimation Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0xc + N
|ElementPlugs
|Plugs
|}

===== ShapeAnimation Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<AsbString>
|Animation Name
|-
|0x8
|0xc + N
|ElementPlugs
|Plugs
|}

===== TwoDimensionalBlender Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<float>
|
|-
|0x8
|0x8
|Property<float>
|
|-
|0x10
|0x4
|u32
|Offset to key frame array relative to 0x10 of this struct?
|-
|0x14
|0x4
|u32
|Offset to key data array relative to 0x10 of this struct?
|-
|0x18
|0xc + N
|ElementPlugs
|Plugs
|}
[[Category:File formats]]

ASB

2026-01-07T12:42:14Z

Watertoon: Correct fields in element struct.

'''ASB''' ('''A'''nimation '''S'''equence '''B'''inary) is a file format used to store animation sequences for actors in recent Nintendo EPD games such as ''The Legend of Zelda: Tears of the Kingdom'' and ''Nintendo Switch Sports''. This article is primarily aimed at the version that appears in ''Tears of the Kingdom'' and ''Mario vs Donkey Kong'' (v0x0417). Other ASB versions include 0x304 (''Ring Fit Adventure''), 0x3FB (''Labo Toy-Con 04'' and ''Game Builder Garage''), 0x407 (''Animal Crossing: New Horizons''), 0x40F (''Nintendo Switch Sports''), 0x410 (''Splatoon 3''), 0x418 (''Super Mario Bros. Wonder''), and 0x41A (''Nintendo Switch Online: Playtest Program''). ASB files can be found in the AS folder of the romfs as well as the AS folder of certain pack files.

== File Structure ==
ASB is a little endian format which consists of node pathways triggered by AS commands. When an AS command is called, it runs the sequence of nodes connected to it which trigger and control animations and animation logic. Nodes are arranged in an array and referenced and accessed by their array index. Despite the presence of animation events in ASB files, these events do not appear to be used by the game.

All string offsets in the file are relative to the start of the string pool and name hashes are 32-bit murmur3 hashes. There are six possible parameter types: string, int (32-bit signed integer), float (32-bit floating point number), bool, vector3f, and pointer (object pointer, this is not actually possible in ASB, only usable in AINB).

Documentation is still sparse, refer to [https://github.com/dt-12345/asb this repository] for more details (names may not match exactly).

=== Section Order ===

==== Version 0x417 ====
# File Header (0x6C bytes in version 0x417, 0x68 bytes in version 0x40F)
# AS Commands
# Nodes
# Event Entry Offsets
# Node Bodies
# Sync Data Entry Indices
# Sync Data
# State Transitions
# Events (in games that use BAEV, these events are non-functional)
# Transitions
# Command Groups
# AS Blackboard Parameters
# Partials
# Bone Groups
# Calculation Result Cache
# Valid Tag List
# Tag Groups
# Expression Binary
# AS Markings
# Material Blend Settings
# Enum Resolve Table
# String Pool

== Structures ==

=== Helpers ===

==== AsbString ====
Represents a u32 offset relative to the start of the file's string pool.

==== AsbPtr <T> ====
Represents a u32 absolute offset from the start of the file to the struct of type "T" enclosed by <>.

==== AsbArray <T> ====
Represents a u32 absolute offset from the start of the file to:
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Count
|-
|0x4
|
|T[Count]
|Array of struct of type T. Note; asb files only use 32-bit aligned types.
|}

=== File Header ===
{| class="wikitable"
|+File Header (0x417)
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|char[4]
|Magic - "ASB "
|-
|0x04
|0x04
|u32
|Version (0x0417 in ''Tears of the Kingdom'')
|-
|0x08
|0x04
|u32
|Filename Offset
|-
|0x0C
|0x04
|u32
|AS Command Count
|-
|0x10
|0x04
|u32
|Node Count
|-
|0x14
|0x04
|u32
|Event Count
|-
|0x18
|0x04
|u32
|Partial Count
|-
|0x1C
|0x04
|u32
|Sync Data Entry Count
|-
|0x20
|0x04
|u32
|AS Blackboard Parameters Offset
|-
|0x24
|0x04
|u32
|String Pool Offset
|-
|0x28
|0x04
|u32
|Enum Resolve Table Offset
|-
|0x2C
|0x04
|u32
|State Transitions Offset
|-
|0x30
|0x04
|u32
|Event Entries Offset Array Offset
|-
|0x34
|0x04
|u32
|Partials Offset
|-
|0x38
|0x04
|u32
|Sync Data Offset
|-
|0x3C
|0x04
|u32
|Sync Data Indices Array Offset
|-
|0x40
|0x04
|u32
|Calculation Result Cache Offset
|-
|0x44
|0x04
|u32
|Calculation Result Cache Count
|-
|0x48
|0x04
|u32
|Bone Groups Offset
|-
|0x4C
|0x04
|u32
|Bone Group Count
|-
|0x50
|0x04
|u32
|String Pool Size
|-
|0x54
|0x04
|u32
|Transitions Offset
|-
|0x58
|0x04
|u32
|Tag List Offset
|-
|0x5C
|0x04
|u32
|String Triplets Offset
|-
|0x60
|0x04
|u32
|Expression Offset (empty if section does not exist)
|-
|0x64
|0x04
|u32
|Command Groups Offset (empty if section does not exist)
|-
|0x68
|0x04
|u32
|Material Blend Settings Offset (version 0x417 only)
|}
{| class="wikitable"
|+File Header (0x41b)
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Magic - "ASB "
|-
|0x4
|0x4
|u32
|Version - (0x41b in Nintendo Switch Online: Playtest version 021)
|-
|0x8
|0x4
|AsbString
|Name Offset
|-
|0xc
|0x4
|u32
|Command Count
|-
|0x10
|0x4
|AsbPtr<Command[Command Count]>
|Command Array
|-
|0x14
|0x4
|u32
|Element Count
|-
|0x18
|0x4
|AsbPtr<Element[Element Count]>
|Element Array
|-
|0x1c
|0x4
|u32
|Event Count - The pointer and count are erroneously present, but the section is not actually written in applications that support the baev file format.
|-
|0x20
|0x4
|AsbPtr<Event[Event Count]>
|Event Array
|-
|0x24
|0x4
|u32
|Parts Count
|-
|0x28
|0x4
|AsbPtr<Parts>
|Parts Region - Pointer to start of parts region.
|-
|0x2c
|0x4
|AsbPtr<u32[Parts Count]>
|Parts Index Array - Array of indices to parts
|-
|0x30
|0x4
|AsbPtr<Blackboard>
|Blackboard
|-
|0x34
|0x4
|AsbPtr<char>
|String Pool
|-
|0x38
|0x4
|u32
|Float Property Ex Count
|-
|0x3c
|0x4
|AsbPtr<Float Property Ex[Float Property Ex Count]>
|Float Property Ex Array
|-
|0x40
|0x4
|u32
|Bone Blend Count
|-
|0x44
|0x4
|AsbPtr<Bone Blend[Bone Blend Count]>
|Bone Blend Array
|-
|0x48
|0x4
|u32
|Partial Skeleton Count
|-
|0x4c
|0x4
|AsbPtr<Partial Skeleton[Partial Skeleton Count]>
|Partial Skeleton Array
|-
|0x50
|0x4
|u32
|String Pool Size
|-
|0x54
|0x4
|AsbPtr<Transition Array>
|Transition Array
|-
|0x58
|0x4
|AsbPtr<AsbArray<u32>>
|Transition Partial Skeleton Array
|-
|0x5c
|0x4
|AsbPtr<AsbArray<AsbString>>
|Tag Array
|-
|0x60
|0x4
|AsbPtr<AsbArray<External Action>>
|External Action Array
|-
|0x64
|0x4
|AsbPtr<AsbArray<Exb>>
|Exb
|-
|0x68
|0x4
|u32
|Transition Group Array
|-
|0x6c
|0x4
|AsbPtr<AsbArray<Material Blend>>
|Material Blend Array
|}

=== Property<T> ===
Property types include s32 (can be an enum), bool(32-bit), float, AsbString, and Vector3f.
{| class="wikitable"
|+ Property<T>
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Flags and Index
|-
|0x04
|0x04 or 0x0C
|T
|Value
|}

If the top bit of the flags is set, then the bottom two bytes of the flags become an index value. If it is not set, then the provided value is value of the parameter. If <code>flags & 1 << 0x18 != 0</code>, then the index is an expression index (EXB) and the normal value field becomes the input value for the expression. If <code>flags & 1 << 0x1e != 0</code>, then the index is a calculation result cache index (this stores the previously evaluated value and calculates the new value from the cached value on subsequent accesses). Note, this is only applicable if the parameter is a float. Otherwise, if <code>flags & 1 << 0x19 != 0</code>, then the index specifies the command data type. 0 is the current frame normalized (i.e. <code>(current_frame - start_frame)/total_duration</code>), 1 and 2 are random float values between 0.0 and 1.0, 3 is an unknown string value, 4 is the command's fade in frame, and 6 is an unknown float value. Note, this only applies if the parameter is a float or a string. In all other cases, the index is a blackboard index and value of the parameter is the value of the corresponding blackboard parameter. For float parameters specifically, <code>flags >> 0x1a & 3</code> specifies the exact parameter source. 0 is a float blackboard parameter while 1, 2, or 3 are a vector3f blackboard parameter with 1, 2, and 3 being the x, y, and z components respectively.

=== Command ===
Defines a command that can be played by an as::Controller. The command is composed of a behavior tree of elements.
{| class="wikitable"
|+Command (0x417)
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Name Offset
|-
|0x04
|0x04
|u32
|Tag Entry Offset (version 0x417+)
|-
|0x08
|0x08
|Property<float>
|
|-
|0x10
|0x08
|Property<bool>
|Is Ignore Same Command
|-
|0x18
|0x04
|u32
|Interpolation Type (uncertain, but 0 = unspecified, 1 = no model morph, 3 = enable local bone morph, 4 = enable inertial blend)
|-
| rowspan="5" |0x1C
| rowspan="5" |0x10
|u32
| rowspan="5" |GUID
|-
|u16
|-
|u16
|-
|u8[2]
|-
|u8[6]
|-
|0x2C
|0x02
|u16
|Child Node Index
|-
|0x2E
|0x02
|u16
|
|}
{| class="wikitable"
|+Command (0x41b)
!Offset
!Size
!Type
!Description
|-
|0x00
|0x4
|AsbString
|Name
|-
|0x04
|0x4
|AsbPtr<AsbArray<AsbString>>
|Tag Array
|-
|0x08
|0x8
|Property<float>
|Frame Count
|-
|0x10
|0x4
|u32
|Debug flag for host io?
|-
|0x14
|0x8
|Property<InterpolationType>
|Default Interpolation Type
|-
|0x1c
|0x10
|Guid
|Guid
|-
|0x2c
|0x2
|u16
|Element Id
|-
|0x2e
|0x2
|u16
|
|}

==== Interpolation Type ====
Enum for (known) interpolation types.
{| class="wikitable"
|+Interpolation Type
!Name
!Value
!Description
|-
|Default
|0
|
|-
|None
|1
|
|-
|Cross Fade
|2
|
|-
|Local Bone
|3
|
|-
|Inertia Local Bone
|4
|
|-
|Parts
|5
|
|}

=== Element ===
{| class="wikitable"
|+Element (0x417)
!Offset
!Size
!Type
!Description
|-
|0x00
|0x02
|AsbNodeType
|Node Type
|-
|0x02
|0x01
|u8
|Sync Data Count
|-
|0x03
|0x01
|u8
|Does Not Have State Transition
|-
|0x04
|0x04
|u32
|Tag Entry Offset
|-
|0x08
|0x04
|u32
|Node Body Offset
|-
|0x0C
|0x02
|u16
|Calculation Result Cache Index
|-
|0x0E
|0x02
|u16
|Calculation Result Cache Count
|-
|0x10
|0x02
|u16
|Sync Data Index Array Index
|-
|0x12
|0x02
|u16
|AS Markings Index (-1 for index)
|-
| rowspan="5" |0x14
| rowspan="5" |0x10
|u32
| rowspan="5" |GUID
|-
|u16
|-
|u16
|-
|u8[2]
|-
|u8[6]
|}
{| class="wikitable"
|+Element (0x41b)
!Offset
!Size
!Type
!Description
|-
|0x0
|0x2
|u16
|Element Type
|-
|0x2
|0x1
|u8
|Parts Count
|-
|0x3
|0x1
|u8
|Is No State End
|-
|0x4
|0x4
|AsbPtr<AsbArray<AsbString>>
|Tag Array
|-
|0x8
|0x4
|AsbPtr<ElementParam<Element Type>>
|Element Param
|-
|0xc
|0x2
|u16
|Float Property Ex Flags
|-
|0xe
|0x2
|u16
|Float Property Ex Count
|-
|0x10
|0x2
|u16
|Base Parts Index Id
|-
|0x12
|0x2
|u16
|External Action Id
|-
|0x14
|0x10
|Guid
|
|}

==== Element Type ====
Enum of element types.
{| class="wikitable"
|+Element Type
!Value (Hex)
!Value (Dec)
!Node Type
|-
|0x01
|1
|FloatSelector
|-
|0x02
|2
|StringSelector
|-
|0x03
|3
|SkeletalAnimation
|-
|0x04
|4
|State
|-
|0x05
|5
|StateEnd
|-
|0x06
|6
|OneDimensionalBlender
|-
|0x07
|7
|Sequential
|-
|0x08
|8
|IntSelector
|-
|0x09
|9
|Simultaneous
|-
|0x0A
|10
|Event
|-
|0x0B
|11
|MaterialAnimation
|-
|0x0C
|12
|FrameController
|-
|0x0D
|13
|DummyAnimation
|-
|0x0E
|14
|RandomSelector
|-
|0x0F
|15
|StateEnd
|-
|0x10
|16
|PreviousTagSelector
|-
|0x11
|17
|BonePositionSelector
|-
|0x12
|18
|BoneVisibilityAnimation
|-
|0x13
|19
|InitialFrame
|-
|0x14
|20
|BoneBlender
|-
|0x15
|21
|BoolSelector
|-
|0x16
|22
|Alert
|-
|0x17
|23
|SubtractAnimation
|-
|0x18
|24
|ShapeAnimation
|-
|0x19
|25
|
|-
|0x1a
|26
|TwoDimensionalBlender
|-
|0x1b
|27
|
|}

==== ElementPlugs ====
The plug struct provides relative offsets to "plug" data.
{| class="wikitable"
|+ElementPlugs (0x41b)
!Offset
!Size
!Type
!Description
|-
|0x0
|0x1
|u8
|State Count
|-
|0x1
|0x1
|u8
|State Base Index
|-
|0x2
|0x1
|u8
|Unknown Count
|-
|0x3
|0x1
|u8
|Unknown Base Index
|-
|0x4
|0x1
|u8
|Child Count
|-
|0x5
|0x1
|u8
|Child Base Index
|-
|0x6
|0x1
|u8
|Exb Count
|-
|0x7
|0x1
|u8
|Exb Base Index
|-
|0x8
|0x1
|u8
|Event Count
|-
|0x9
|0x1
|u8
|Event Base Index
|-
|0xa
|0x1
|u8
|Frame Controller Count
|-
|0xb
|0x1
|u8
|Frame Controller Base Index
|-
|0xc
|0x4 * Frame Controller Base Index + Frame Controller Count
|u32[]
|Plug Data Offset Array - Offsets relative to start of plug table
|}

===== Child Plug =====
Only known are listed.

====== Default ======
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Child Element Id
|}

====== FloatSelector, OneDimensionalBlender, BonePositionSelector Elements ======
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<float>
|Min
|-
|0x8
|0x8
|Property<float>
|Max
|-
|0x10
|0x4
|u32
|Child Element Id
|}

====== StringSelector Element ======
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<AsbString>
|Value
|-
|0x8
|0x4
|u32
|Child Element Id
|}

====== IntSelector Element ======
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<s32>
|Value
|-
|0x8
|0x4
|u32
|Child Element Id
|}

====== RandomSelector Element ======
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<float>
|Value
|-
|0x8
|0x4
|u32
|Child Element Id
|}

====== PreviousTagSelector Element ======
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|AsbPtr<AsbArray<AsbString>>
|Tag Array
|-
|0x8
|0x4
|u32
|Child Element Id
|}

===== Event Plug =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Event Element Id
|}

===== Frame Controller Plug =====
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Frame Controller Element Id
|}

==== ElementParam<Element Type> ====

===== FloatSelector Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<float>
|Select Value
|-
|0x8
|0x8
|Property<bool>
|Is Slot Sync
|-
|0x10
|0x4
|u32
|
|-
|0x14
|0xc + N
|ElementPlugs
|Plugs
|}

===== StringSelector Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<float>
|Select Value
|-
|0x8
|0x8
|Property<bool>
|Is Slot Sync
|-
|0x10
|0x4
|u32
|
|-
|0x14
|0xc + N
|ElementPlugs
|Plugs
|}

===== SkeletalAnimation Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<AsbString>
|Animation Name
|-
|0x8
|0x4
|u32
|
|-
|0xc
|0x4
|u32
|
|-
|0x10
|0x8
|Property<bool>
|Is Offset Frame
|-
|0x18
|0x8
|Property<float>
|Frame Offset
|-
|0x20
|0xc + N
|ElementPlugs
|Plugs
|}

===== State Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0xc + N
|ElementPlugs
|Plugs
|}

===== OneDimensionalBlender Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<float>
|Selector weight
|-
|0x8
|0x4
|u32
|Easing Type (1 = ease)
|-
|0xc
|0xc + N
|ElementPlugs
|Plugs
|}

===== Sequential Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<bool>
|
|-
|0x8
|0x8
|Property<s32>
|
|-
|0x10
|0x8
|Property<bool>
|
|-
|0x18
|0xc + N
|ElementPlugs
|Plugs
|}

===== IntSelector Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<s32>
|Select Value
|-
|0x8
|0x8
|Property<bool>
|Is Slot Sync
|-
|0x10
|0x4
|u32
|
|-
|0x14
|0xc + N
|ElementPlugs
|Plugs
|}

===== Simultaneous Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|State End Type (0 = no children, 1 = first child state end)
|-
|0x8
|0xc + N
|ElementPlugs
|Plugs
|}

===== Event Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|
|-
|0x8
|0xc + N
|ElementPlugs
|Plugs
|}

===== MaterialAnimation Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Material Blend Id
|-
|0x4
|0x8
|Property<AsbString>
|Animation Name
|-
|0xc
|0x8
|Property<bool>
|
|-
|0x14
|0xc + N
|ElementPlugs
|Plugs
|}

===== FrameController Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<float>
|Play Rate
|-
|0x8
|0x8
|Property<float>
|Loop Start
|-
|0x10
|0x8
|Property<float>
|Loop End
|-
|0x18
|0x4
|u32
|
|-
|0x1c
|0x8
|Property<bool>
|Is Kill Loop
|-
|0x24
|0x8
|Property<bool>
|
|-
|0x2c
|0x8
|Property<s32>
|Frame Count
|-
|0x34
|0x8
|Property<s32>
|Random Range
|-
|0x3c
|0x8
|Property<bool>
|Is Local Random
|-
|0x44
|0x8
|Property<float>
|Frame Offset
|-
|0x4c
|0x8
|Property<float>
|Current Frame
|-
|0x54
|0x8
|Property<float>
|
|-
|0x5c
|0x4
|u32
|
|-
|0x60
|0x8
|Property<float>
|
|-
|0x68
|0x8
|Property<bool>
|
|-
|0x70
|0x8
|Property<bool>
|Is Retarget Play Rate
|-
|0x78
|0xc + N
|ElementPlugs
|Plugs
|}

===== DummyAnimation Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<float>
|Frame Count
|-
|0x8
|0x8
|Property<bool>
|Is Looping
|-
|0x10
|0xc + N
|ElementPlugs
|Plugs
|}

===== RandomSelector Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Judge Timing
|-
|0x4
|0x8
|Property<bool>
|Is Slot Sync
|-
|0xc
|0x8
|Property<s32>
|
|-
|0x14
|0x8
|Property<>
|Unknown
|-
|0x1c
|0x4
|u32
|
|-
|0x20
|0xc + N
|ElementPlugs
|Plugs
|}

===== PreviousTagSelector Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|
|-
|0x4
|0xc + N
|ElementPlugs
|Plugs
|}

===== BonePositionSelector Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<AsbString>
|Left Bone Name
|-
|0x8
|0x8
|Property<AsbString>
|Right Bone Name
|-
|0xc
|0x4
|u32
|Component Id - (0 = X, 1 = Y, 2 = Z) component to generate bone position difference from
|-
|0x10
|0x4
|u32
|Judge Timing
|-
|0x14
|0x8
|Property<bool>
|Is Slot Sync
|-
|0x1c
|0xc + N
|ElementPlugs
|Plugs
|}

===== BoneVisibilityAnimation Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<AsbString>
|Animation Name
|-
|0x8
|0x8
|Property<bool>
|
|-
|0x10
|0x8
|Property<bool>
|Is Offset Frame
|-
|0x18
|0x8
|Property<float>
|Frame Offset
|-
|0x20
|0xc + N
|ElementPlugs
|Plugs
|}

===== InitialFrame Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Initial Frame Type
|-
|0x4
|0x4
|AsbPtr<AsbArray<AsbString>>
|Tag Array
|-
|0x8
|0x8
|Property<bool>
|Is Share By Same Anim key
|-
|0x10
|0x8
|Property<AsbString>
|Left Bone Name
|-
|0x18
|0x8
|Property<AsbString>
|Right Bone Name
|-
|0x20
|0x4
|u32
|Component Id
|-
|0x24
|0x8
|Property<bool>
|Is Random
|-
|0x2c
|0x8
|Property<bool>
|Is Fixed Random
|-
|0x34
|0xc + N
|ElementPlugs
|Plugs
|}

====== Initial Frame Type ======
{| class="wikitable"
|+
!Name
|-
|Start
|-
|FrameOffset
|-
|InvFrameOffset
|-
|Random
|-
|BonePosition
|-
|End
|-
|Frame
|-
|InvFrame
|-
|SlotSync
|}

===== BoneBlender Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<AsbString>
|Bone Blend Name
|-
|0x8
|0x4
|u32
|Sync Child Id
|-
|0xc
|0x8
|Property<float>
|Bone Blend Mode Value
|-
|0x14
|0x4
|u32
|Bone Blend Mode
|-
|0x18
|0x4
|u32
|State End Mode (0 = all, 1 = child 0, 2 = child 1)
|-
|0x1c
|0xc + N
|ElementPlugs
|Plugs
|}

===== BoolSelector Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<bool>
|Select Value
|-
|0x8
|0x8
|Property<bool>
|Is Slot Sync
|-
|0x10
|0x4
|u32
|
|-
|0x14
|0xc + N
|ElementPlugs
|Plugs
|}

===== Alert =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<AsbString>
|Alert
|-
|0x8
|0xc + N
|ElementPlugs
|Plugs
|}

===== SubtractAnimation Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0xc + N
|ElementPlugs
|Plugs
|}

===== ShapeAnimation Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<AsbString>
|Animation Name
|-
|0x8
|0xc + N
|ElementPlugs
|Plugs
|}

===== TwoDimensionalBlender Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<float>
|
|-
|0x8
|0x8
|Property<float>
|
|-
|0x10
|0x4
|u32
|Offset to key frame array relative to 0x10 of this struct?
|-
|0x14
|0x4
|u32
|Offset to key data array relative to 0x10 of this struct?
|-
|0x18
|0xc + N
|ElementPlugs
|Plugs
|}
[[Category:File formats]]

ASB

2026-01-07T12:36:03Z

Watertoon: Begin adding some information on asb version 0x41b

'''ASB''' ('''A'''nimation '''S'''equence '''B'''inary) is a file format used to store animation sequences for actors in recent Nintendo EPD games such as ''The Legend of Zelda: Tears of the Kingdom'' and ''Nintendo Switch Sports''. This article is primarily aimed at the version that appears in ''Tears of the Kingdom'' and ''Mario vs Donkey Kong'' (v0x0417). Other ASB versions include 0x304 (''Ring Fit Adventure''), 0x3FB (''Labo Toy-Con 04'' and ''Game Builder Garage''), 0x407 (''Animal Crossing: New Horizons''), 0x40F (''Nintendo Switch Sports''), 0x410 (''Splatoon 3''), 0x418 (''Super Mario Bros. Wonder''), and 0x41A (''Nintendo Switch Online: Playtest Program''). ASB files can be found in the AS folder of the romfs as well as the AS folder of certain pack files.

== File Structure ==
ASB is a little endian format which consists of node pathways triggered by AS commands. When an AS command is called, it runs the sequence of nodes connected to it which trigger and control animations and animation logic. Nodes are arranged in an array and referenced and accessed by their array index. Despite the presence of animation events in ASB files, these events do not appear to be used by the game.

All string offsets in the file are relative to the start of the string pool and name hashes are 32-bit murmur3 hashes. There are six possible parameter types: string, int (32-bit signed integer), float (32-bit floating point number), bool, vector3f, and pointer (object pointer, this is not actually possible in ASB, only usable in AINB).

Documentation is still sparse, refer to [https://github.com/dt-12345/asb this repository] for more details (names may not match exactly).

=== Section Order ===

==== Version 0x417 ====
# File Header (0x6C bytes in version 0x417, 0x68 bytes in version 0x40F)
# AS Commands
# Nodes
# Event Entry Offsets
# Node Bodies
# Sync Data Entry Indices
# Sync Data
# State Transitions
# Events (in games that use BAEV, these events are non-functional)
# Transitions
# Command Groups
# AS Blackboard Parameters
# Partials
# Bone Groups
# Calculation Result Cache
# Valid Tag List
# Tag Groups
# Expression Binary
# AS Markings
# Material Blend Settings
# Enum Resolve Table
# String Pool

== Structures ==

=== Helpers ===

==== AsbString ====
Represents a u32 offset relative to the start of the file's string pool.

==== AsbPtr <T> ====
Represents a u32 absolute offset from the start of the file to the struct of type "T" enclosed by <>.

==== AsbArray <T> ====
Represents a u32 absolute offset from the start of the file to:
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Count
|-
|0x4
|
|T[Count]
|Array of struct of type T. Note; asb files only use 32-bit aligned types.
|}

=== File Header ===
{| class="wikitable"
|+File Header (0x417)
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|char[4]
|Magic - "ASB "
|-
|0x04
|0x04
|u32
|Version (0x0417 in ''Tears of the Kingdom'')
|-
|0x08
|0x04
|u32
|Filename Offset
|-
|0x0C
|0x04
|u32
|AS Command Count
|-
|0x10
|0x04
|u32
|Node Count
|-
|0x14
|0x04
|u32
|Event Count
|-
|0x18
|0x04
|u32
|Partial Count
|-
|0x1C
|0x04
|u32
|Sync Data Entry Count
|-
|0x20
|0x04
|u32
|AS Blackboard Parameters Offset
|-
|0x24
|0x04
|u32
|String Pool Offset
|-
|0x28
|0x04
|u32
|Enum Resolve Table Offset
|-
|0x2C
|0x04
|u32
|State Transitions Offset
|-
|0x30
|0x04
|u32
|Event Entries Offset Array Offset
|-
|0x34
|0x04
|u32
|Partials Offset
|-
|0x38
|0x04
|u32
|Sync Data Offset
|-
|0x3C
|0x04
|u32
|Sync Data Indices Array Offset
|-
|0x40
|0x04
|u32
|Calculation Result Cache Offset
|-
|0x44
|0x04
|u32
|Calculation Result Cache Count
|-
|0x48
|0x04
|u32
|Bone Groups Offset
|-
|0x4C
|0x04
|u32
|Bone Group Count
|-
|0x50
|0x04
|u32
|String Pool Size
|-
|0x54
|0x04
|u32
|Transitions Offset
|-
|0x58
|0x04
|u32
|Tag List Offset
|-
|0x5C
|0x04
|u32
|String Triplets Offset
|-
|0x60
|0x04
|u32
|Expression Offset (empty if section does not exist)
|-
|0x64
|0x04
|u32
|Command Groups Offset (empty if section does not exist)
|-
|0x68
|0x04
|u32
|Material Blend Settings Offset (version 0x417 only)
|}
{| class="wikitable"
|+File Header (0x41b)
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Magic - "ASB "
|-
|0x4
|0x4
|u32
|Version - (0x41b in Nintendo Switch Online: Playtest version 021)
|-
|0x8
|0x4
|AsbString
|Name Offset
|-
|0xc
|0x4
|u32
|Command Count
|-
|0x10
|0x4
|AsbPtr<Command[Command Count]>
|Command Array
|-
|0x14
|0x4
|u32
|Element Count
|-
|0x18
|0x4
|AsbPtr<Element[Element Count]>
|Element Array
|-
|0x1c
|0x4
|u32
|Event Count - The pointer and count are erroneously present, but the section is not actually written in applications that support the baev file format.
|-
|0x20
|0x4
|AsbPtr<Event[Event Count]>
|Event Array
|-
|0x24
|0x4
|u32
|Parts Count
|-
|0x28
|0x4
|AsbPtr<Parts>
|Parts Region - Pointer to start of parts region.
|-
|0x2c
|0x4
|AsbPtr<u32[Parts Count]>
|Parts Index Array - Array of indices to parts
|-
|0x30
|0x4
|AsbPtr<Blackboard>
|Blackboard
|-
|0x34
|0x4
|AsbPtr<char>
|String Pool
|-
|0x38
|0x4
|u32
|Float Property Ex Count
|-
|0x3c
|0x4
|AsbPtr<Float Property Ex[Float Property Ex Count]>
|Float Property Ex Array
|-
|0x40
|0x4
|u32
|Bone Blend Count
|-
|0x44
|0x4
|AsbPtr<Bone Blend[Bone Blend Count]>
|Bone Blend Array
|-
|0x48
|0x4
|u32
|Partial Skeleton Count
|-
|0x4c
|0x4
|AsbPtr<Partial Skeleton[Partial Skeleton Count]>
|Partial Skeleton Array
|-
|0x50
|0x4
|u32
|String Pool Size
|-
|0x54
|0x4
|AsbPtr<Transition Array>
|Transition Array
|-
|0x58
|0x4
|AsbPtr<AsbArray<u32>>
|Transition Partial Skeleton Array
|-
|0x5c
|0x4
|AsbPtr<AsbArray<AsbString>>
|Tag Array
|-
|0x60
|0x4
|AsbPtr<AsbArray<External Action>>
|External Action Array
|-
|0x64
|0x4
|AsbPtr<AsbArray<Exb>>
|Exb
|-
|0x68
|0x4
|u32
|Transition Group Array
|-
|0x6c
|0x4
|AsbPtr<AsbArray<Material Blend>>
|Material Blend Array
|}

=== Property<T> ===
Property types include s32 (can be an enum), bool(32-bit), float, AsbString, and Vector3f.
{| class="wikitable"
|+ Property<T>
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Flags and Index
|-
|0x04
|0x04 or 0x0C
|T
|Value
|}

If the top bit of the flags is set, then the bottom two bytes of the flags become an index value. If it is not set, then the provided value is value of the parameter. If <code>flags & 1 << 0x18 != 0</code>, then the index is an expression index (EXB) and the normal value field becomes the input value for the expression. If <code>flags & 1 << 0x1e != 0</code>, then the index is a calculation result cache index (this stores the previously evaluated value and calculates the new value from the cached value on subsequent accesses). Note, this is only applicable if the parameter is a float. Otherwise, if <code>flags & 1 << 0x19 != 0</code>, then the index specifies the command data type. 0 is the current frame normalized (i.e. <code>(current_frame - start_frame)/total_duration</code>), 1 and 2 are random float values between 0.0 and 1.0, 3 is an unknown string value, 4 is the command's fade in frame, and 6 is an unknown float value. Note, this only applies if the parameter is a float or a string. In all other cases, the index is a blackboard index and value of the parameter is the value of the corresponding blackboard parameter. For float parameters specifically, <code>flags >> 0x1a & 3</code> specifies the exact parameter source. 0 is a float blackboard parameter while 1, 2, or 3 are a vector3f blackboard parameter with 1, 2, and 3 being the x, y, and z components respectively.

=== Command ===
Defines a command that can be played by an as::Controller. The command is composed of a behavior tree of elements.
{| class="wikitable"
|+Command (0x417)
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Name Offset
|-
|0x04
|0x04
|u32
|Tag Entry Offset (version 0x417+)
|-
|0x08
|0x08
|Property<float>
|
|-
|0x10
|0x08
|Property<bool>
|Is Ignore Same Command
|-
|0x18
|0x04
|u32
|Interpolation Type (uncertain, but 0 = unspecified, 1 = no model morph, 3 = enable local bone morph, 4 = enable inertial blend)
|-
| rowspan="5" |0x1C
| rowspan="5" |0x10
|u32
| rowspan="5" |GUID
|-
|u16
|-
|u16
|-
|u8[2]
|-
|u8[6]
|-
|0x2C
|0x02
|u16
|Child Node Index
|-
|0x2E
|0x02
|u16
|
|}
{| class="wikitable"
|+Command (0x41b)
!Offset
!Size
!Type
!Description
|-
|0x00
|0x4
|AsbString
|Name
|-
|0x04
|0x4
|AsbPtr<AsbArray<AsbString>>
|Tag Array
|-
|0x08
|0x8
|Property<float>
|Frame Count
|-
|0x10
|0x4
|u32
|Debug flag for host io?
|-
|0x14
|0x8
|Property<InterpolationType>
|Default Interpolation Type
|-
|0x1c
|0x10
|Guid
|Guid
|-
|0x2c
|0x2
|u16
|Element Id
|-
|0x2e
|0x2
|u16
|
|}

==== Interpolation Type ====
Enum for (known) interpolation types.
{| class="wikitable"
|+Interpolation Type
!Name
!Value
!Description
|-
|Default
|0
|
|-
|None
|1
|
|-
|Cross Fade
|2
|
|-
|Local Bone
|3
|
|-
|Inertia Local Bone
|4
|
|-
|Parts
|5
|
|}

=== Element ===
{| class="wikitable"
|+Element (0x417)
!Offset
!Size
!Type
!Description
|-
|0x00
|0x02
|AsbNodeType
|Node Type
|-
|0x02
|0x01
|u8
|Sync Data Count
|-
|0x03
|0x01
|u8
|Does Not Have State Transition
|-
|0x04
|0x04
|u32
|Tag Entry Offset
|-
|0x08
|0x04
|u32
|Node Body Offset
|-
|0x0C
|0x02
|u16
|Calculation Result Cache Index
|-
|0x0E
|0x02
|u16
|Calculation Result Cache Count
|-
|0x10
|0x02
|u16
|Sync Data Index Array Index
|-
|0x12
|0x02
|u16
|AS Markings Index (-1 for index)
|-
| rowspan="5" |0x14
| rowspan="5" |0x10
|u32
| rowspan="5" |GUID
|-
|u16
|-
|u16
|-
|u8[2]
|-
|u8[6]
|}
{| class="wikitable"
|+Element (0x41b)
!Offset
!Size
!Type
!Description
|-
|0x0
|0x2
|u16
|Element Type
|-
|0x2
|0x1
|u8
|Is Flag
|-
|0x3
|0x1
|u8
|Flag (unknown use)
|-
|0x4
|0x4
|AsbPtr<AsbArray<AsbString>>
|Tag Array
|-
|0x8
|0x4
|AsbPtr<ElementParam<Element Type>>
|Element Param
|-
|0xc
|0x2
|u16
|Float Property Ex Flags
|-
|0xe
|0x2
|u16
|Float Property Ex Count
|-
|0x10
|0x2
|u16
|Base Parts Index Id
|-
|0x12
|0x2
|u16
|External Action Id
|-
|0x14
|0x10
|Guid
|
|}

==== Element Type ====
Enum of element types.
{| class="wikitable"
|+Element Type
!Value (Hex)
!Value (Dec)
!Node Type
|-
|0x01
|1
|FloatSelector
|-
|0x02
|2
|StringSelector
|-
|0x03
|3
|SkeletalAnimation
|-
|0x04
|4
|State
|-
|0x05
|5
|StateEnd
|-
|0x06
|6
|OneDimensionalBlender
|-
|0x07
|7
|Sequential
|-
|0x08
|8
|IntSelector
|-
|0x09
|9
|Simultaneous
|-
|0x0A
|10
|Event
|-
|0x0B
|11
|MaterialAnimation
|-
|0x0C
|12
|FrameController
|-
|0x0D
|13
|DummyAnimation
|-
|0x0E
|14
|RandomSelector
|-
|0x0F
|15
|StateEnd
|-
|0x10
|16
|PreviousTagSelector
|-
|0x11
|17
|BonePositionSelector
|-
|0x12
|18
|BoneVisibilityAnimation
|-
|0x13
|19
|InitialFrame
|-
|0x14
|20
|BoneBlender
|-
|0x15
|21
|BoolSelector
|-
|0x16
|22
|Alert
|-
|0x17
|23
|SubtractAnimation
|-
|0x18
|24
|ShapeAnimation
|-
|0x19
|25
|
|-
|0x1a
|26
|TwoDimensionalBlender
|-
|0x1b
|27
|
|}

==== ElementPlugs ====
The plug struct provides relative offsets to "plug" data.
{| class="wikitable"
|+ElementPlugs (0x41b)
!Offset
!Size
!Type
!Description
|-
|0x0
|0x1
|u8
|State Count
|-
|0x1
|0x1
|u8
|State Base Index
|-
|0x2
|0x1
|u8
|Unknown Count
|-
|0x3
|0x1
|u8
|Unknown Base Index
|-
|0x4
|0x1
|u8
|Child Count
|-
|0x5
|0x1
|u8
|Child Base Index
|-
|0x6
|0x1
|u8
|Exb Count
|-
|0x7
|0x1
|u8
|Exb Base Index
|-
|0x8
|0x1
|u8
|Event Count
|-
|0x9
|0x1
|u8
|Event Base Index
|-
|0xa
|0x1
|u8
|Frame Controller Count
|-
|0xb
|0x1
|u8
|Frame Controller Base Index
|-
|0xc
|0x4 * Frame Controller Base Index + Frame Controller Count
|u32[]
|Plug Data Offset Array - Offsets relative to start of plug table
|}

===== Child Plug =====
Only known are listed.

====== Default ======
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Child Element Id
|}

====== FloatSelector, OneDimensionalBlender, BonePositionSelector Elements ======
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<float>
|Min
|-
|0x8
|0x8
|Property<float>
|Max
|-
|0x10
|0x4
|u32
|Child Element Id
|}

====== StringSelector Element ======
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<AsbString>
|Value
|-
|0x8
|0x4
|u32
|Child Element Id
|}

====== IntSelector Element ======
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<s32>
|Value
|-
|0x8
|0x4
|u32
|Child Element Id
|}

====== RandomSelector Element ======
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<float>
|Value
|-
|0x8
|0x4
|u32
|Child Element Id
|}

====== PreviousTagSelector Element ======
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|AsbPtr<AsbArray<AsbString>>
|Tag Array
|-
|0x8
|0x4
|u32
|Child Element Id
|}

===== Event Plug =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Event Element Id
|}

===== Frame Controller Plug =====
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Frame Controller Element Id
|}

==== ElementParam<Element Type> ====

===== FloatSelector Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<float>
|Select Value
|-
|0x8
|0x8
|Property<bool>
|Is Slot Sync
|-
|0x10
|0x4
|u32
|
|-
|0x14
|0xc + N
|ElementPlugs
|Plugs
|}

===== StringSelector Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<float>
|Select Value
|-
|0x8
|0x8
|Property<bool>
|Is Slot Sync
|-
|0x10
|0x4
|u32
|
|-
|0x14
|0xc + N
|ElementPlugs
|Plugs
|}

===== SkeletalAnimation Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<AsbString>
|Animation Name
|-
|0x8
|0x4
|u32
|
|-
|0xc
|0x4
|u32
|
|-
|0x10
|0x8
|Property<bool>
|Is Offset Frame
|-
|0x18
|0x8
|Property<float>
|Frame Offset
|-
|0x20
|0xc + N
|ElementPlugs
|Plugs
|}

===== State Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0xc + N
|ElementPlugs
|Plugs
|}

===== OneDimensionalBlender Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<float>
|Selector weight
|-
|0x8
|0x4
|u32
|Easing Type (1 = ease)
|-
|0xc
|0xc + N
|ElementPlugs
|Plugs
|}

===== Sequential Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<bool>
|
|-
|0x8
|0x8
|Property<s32>
|
|-
|0x10
|0x8
|Property<bool>
|
|-
|0x18
|0xc + N
|ElementPlugs
|Plugs
|}

===== IntSelector Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<s32>
|Select Value
|-
|0x8
|0x8
|Property<bool>
|Is Slot Sync
|-
|0x10
|0x4
|u32
|
|-
|0x14
|0xc + N
|ElementPlugs
|Plugs
|}

===== Simultaneous Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|State End Type (0 = no children, 1 = first child state end)
|-
|0x8
|0xc + N
|ElementPlugs
|Plugs
|}

===== Event Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|
|-
|0x8
|0xc + N
|ElementPlugs
|Plugs
|}

===== MaterialAnimation Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Material Blend Id
|-
|0x4
|0x8
|Property<AsbString>
|Animation Name
|-
|0xc
|0x8
|Property<bool>
|
|-
|0x14
|0xc + N
|ElementPlugs
|Plugs
|}

===== FrameController Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<float>
|Play Rate
|-
|0x8
|0x8
|Property<float>
|Loop Start
|-
|0x10
|0x8
|Property<float>
|Loop End
|-
|0x18
|0x4
|u32
|
|-
|0x1c
|0x8
|Property<bool>
|Is Kill Loop
|-
|0x24
|0x8
|Property<bool>
|
|-
|0x2c
|0x8
|Property<s32>
|Frame Count
|-
|0x34
|0x8
|Property<s32>
|Random Range
|-
|0x3c
|0x8
|Property<bool>
|Is Local Random
|-
|0x44
|0x8
|Property<float>
|Frame Offset
|-
|0x4c
|0x8
|Property<float>
|Current Frame
|-
|0x54
|0x8
|Property<float>
|
|-
|0x5c
|0x4
|u32
|
|-
|0x60
|0x8
|Property<float>
|
|-
|0x68
|0x8
|Property<bool>
|
|-
|0x70
|0x8
|Property<bool>
|Is Retarget Play Rate
|-
|0x78
|0xc + N
|ElementPlugs
|Plugs
|}

===== DummyAnimation Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<float>
|Frame Count
|-
|0x8
|0x8
|Property<bool>
|Is Looping
|-
|0x10
|0xc + N
|ElementPlugs
|Plugs
|}

===== RandomSelector Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Judge Timing
|-
|0x4
|0x8
|Property<bool>
|Is Slot Sync
|-
|0xc
|0x8
|Property<s32>
|
|-
|0x14
|0x8
|Property<>
|Unknown
|-
|0x1c
|0x4
|u32
|
|-
|0x20
|0xc + N
|ElementPlugs
|Plugs
|}

===== PreviousTagSelector Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|
|-
|0x4
|0xc + N
|ElementPlugs
|Plugs
|}

===== BonePositionSelector Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<AsbString>
|Left Bone Name
|-
|0x8
|0x8
|Property<AsbString>
|Right Bone Name
|-
|0xc
|0x4
|u32
|Component Id - (0 = X, 1 = Y, 2 = Z) component to generate bone position difference from
|-
|0x10
|0x4
|u32
|Judge Timing
|-
|0x14
|0x8
|Property<bool>
|Is Slot Sync
|-
|0x1c
|0xc + N
|ElementPlugs
|Plugs
|}

===== BoneVisibilityAnimation Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<AsbString>
|Animation Name
|-
|0x8
|0x8
|Property<bool>
|
|-
|0x10
|0x8
|Property<bool>
|Is Offset Frame
|-
|0x18
|0x8
|Property<float>
|Frame Offset
|-
|0x20
|0xc + N
|ElementPlugs
|Plugs
|}

===== InitialFrame Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Initial Frame Type
|-
|0x4
|0x4
|AsbPtr<AsbArray<AsbString>>
|Tag Array
|-
|0x8
|0x8
|Property<bool>
|Is Share By Same Anim key
|-
|0x10
|0x8
|Property<AsbString>
|Left Bone Name
|-
|0x18
|0x8
|Property<AsbString>
|Right Bone Name
|-
|0x20
|0x4
|u32
|Component Id
|-
|0x24
|0x8
|Property<bool>
|Is Random
|-
|0x2c
|0x8
|Property<bool>
|Is Fixed Random
|-
|0x34
|0xc + N
|ElementPlugs
|Plugs
|}

====== Initial Frame Type ======
{| class="wikitable"
|+
!Name
|-
|Start
|-
|FrameOffset
|-
|InvFrameOffset
|-
|Random
|-
|BonePosition
|-
|End
|-
|Frame
|-
|InvFrame
|-
|SlotSync
|}

===== BoneBlender Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<AsbString>
|Bone Blend Name
|-
|0x8
|0x4
|u32
|Sync Child Id
|-
|0xc
|0x8
|Property<float>
|Bone Blend Mode Value
|-
|0x14
|0x4
|u32
|Bone Blend Mode
|-
|0x18
|0x4
|u32
|State End Mode (0 = all, 1 = child 0, 2 = child 1)
|-
|0x1c
|0xc + N
|ElementPlugs
|Plugs
|}

===== BoolSelector Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<bool>
|Select Value
|-
|0x8
|0x8
|Property<bool>
|Is Slot Sync
|-
|0x10
|0x4
|u32
|
|-
|0x14
|0xc + N
|ElementPlugs
|Plugs
|}

===== Alert =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<AsbString>
|Alert
|-
|0x8
|0xc + N
|ElementPlugs
|Plugs
|}

===== SubtractAnimation Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0xc + N
|ElementPlugs
|Plugs
|}

===== ShapeAnimation Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<AsbString>
|Animation Name
|-
|0x8
|0xc + N
|ElementPlugs
|Plugs
|}

===== TwoDimensionalBlender Element =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property<float>
|
|-
|0x8
|0x8
|Property<float>
|
|-
|0x10
|0x4
|u32
|Offset to key frame array relative to 0x10 of this struct?
|-
|0x14
|0x4
|u32
|Offset to key data array relative to 0x10 of this struct?
|-
|0x18
|0xc + N
|ElementPlugs
|Plugs
|}
[[Category:File formats]]

Bwav

2026-01-07T09:37:18Z

Watertoon: Wording correction.

Bwav is an audio stream format used by the [[aal::atom]] library. It is primarily a lightweight header followed by audio sample data.

== File Structure ==
Bwav is little-endian. The file alignment is 4 bytes despite the sample data alignment. This page is based on version 1, which is the only currently known version.

# Header
# Channel Info Array
# Channel Sample Data Array

== Structures ==

=== Header ===
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Magic - "BWAV"
|-
|0x4
|0x2
|u16
|Byte Order Mark
|-
|0x6
|0x2
|u16
|Version
|-
|0x8
|0x4
|u32
|Samples Hash - Hash of sample data region?
|-
|0xc
|0x2
|u16
|Flags - Bit 0 indicates this is a prefetch bwav
|-
|0xe
|0x2
|u16
|Channel Count
|}

=== Channel Info ===
Immediately follows header. One channel info per channel, variable length though almost always 0x4c (with 1 loop point). Channel info is tightly packed one after the other.
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x2
|u16
|Encoding - 0 = Pcm16, 1 = DspAdpcm, 2 = Opus
|-
|0x2
|0x2
|u16
|Channel Pan - 0 = Left, 1 = Right, 2 = Center, 3 = LFE, 4 = LS, 5 = RS, 6 = Invalid?
|-
|0x4
|0x4
|u32
|Sample Rate
|-
|0x8
|0x4
|u32
|Non-Prefetch Sample Count
|-
|0xc
|0x4
|u32
|File Sample Count (identical to previous field when non-prefetch bwav)
|-
|0x10
|0x20
|u16[16]
|Dsp-Adpcm Coefficients
|-
|0x30
|0x4
|u32
|Non-Prefetch Sample Data Offset
|-
|0x34
|0x4
|u32
|Sample Data Offset
|-
|0x38
|0x2
|u16
|Loop Point Count - Only observed as 1 despite support for multiple
|-
|0x3a
|0x2
|u16
|Base Loop Point - Default loop point
|-
|0x3c
|0x4
|u32
|Loop End - base sample of end after final loop point, 0xffff'ffff suggests no loop
|-
|0x40
|0xc * Loop Point Count
|Loop Point
|Loop Point Array - variable sized array of loop points
|}

==== Loop Point ====
A loop point provides a seek point to a specific sample offset. Often only 1 loop point exists, it's role being the start of a single looping region.
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Loop Start - base sample of loop point start
|-
|0x4
|0x6
|Adpcm Context
|Adpcm Context - Snapshot of dsp-adpcm context at the sample offset of loop start
|-
|0xa
|0x2
|
|Zero-padding
|}

===== Adpcm Context =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x2
|u16
|Predictor Scale
|-
|0x2
|0x4
|s16[2]
|History Array
|}

=== Sample Data ===
The start of each channel's sample data is aligned up by 64 bytes in file, despite the 4-byte file alignment, outside the last channel, which is truncated to the last non-zero sample (including zeroed samples in a dsp-adpcm block).
{| class="wikitable"
|+
!Format
!Type
!Description
|-
|Pcm16
|2 bytes per sample
|16-bit signed PCM sample data.
|-
|Dsp-Adpcm
|8-byte block array, up to 14 samples per block
|8-bit header for decoding, followed by up to 14 4-bit compressed samples.
|-
|Opus
|
|Header followed by opus data.
|}
[[Category:File formats]]

Bwav

2026-01-07T09:35:36Z

Watertoon: Document bwav file format.

Bwav is an audio stream format used by the [[aal::atom]] library. It is primarily a lightweight header followed by audio sample data.

== File Structure ==
Bwav is little-endian. The file alignment is 4 bytes despite the sample data alignment. This page is based on version 1, which is the only currently known version.

# Header
# Channel Info Array
# Channel Sample Data Array

== Structures ==

=== Header ===
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Magic - "BWAV"
|-
|0x4
|0x2
|u16
|Byte Order Mark
|-
|0x6
|0x2
|u16
|Version
|-
|0x8
|0x4
|u32
|Samples Hash - Hash of sample data region?
|-
|0xc
|0x2
|u16
|Flags - Bit 0 indicates this is a prefetch bwav
|-
|0xe
|0x2
|u16
|Channel Count
|}

=== Channel Info ===
Immediately follows header. One channel info per channel, variable length though almost always 0x4c (with 1 loop point). Channel info is tightly packed one after the other.
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x2
|u16
|Encoding - 0 = Pcm16, 1 = DspAdpcm, 2 = Opus
|-
|0x2
|0x2
|u16
|Channel Pan - 0 = Left, 1 = Right, 2 = Center, 3 = LFE, 4 = LS, 5 = RS, 6 = Invalid?
|-
|0x4
|0x4
|u32
|Sample Rate
|-
|0x8
|0x4
|u32
|Non-Prefetch Sample Count
|-
|0xc
|0x4
|u32
|File Sample Count (identical to previous field when non-prefetch bwav)
|-
|0x10
|0x20
|u16[16]
|Dsp-Adpcm Coefficients
|-
|0x30
|0x4
|u32
|Non-Prefetch Sample Data Offset
|-
|0x34
|0x4
|u32
|Sample Data Offset
|-
|0x38
|0x2
|u16
|Loop Point Count - Only observed as 1 despite support for multiple
|-
|0x3a
|0x2
|u16
|Base Loop Point - Default loop point
|-
|0x3c
|0x4
|u32
|Loop End - base sample of end after final loop point, 0xffff'ffff suggests no loop
|-
|0x40
|0xc * Loop Point Count
|Loop Point
|Loop Point Array - variable sized array of loop points
|}

==== Loop Point ====
A loop point provides as a seek point to a specific sample offset. Often only 1 loop point exists, it's role being the start of a single looping region.
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Loop Start - base sample of loop point start
|-
|0x4
|0x6
|Adpcm Context
|Adpcm Context - Snapshot of dsp-adpcm context at the sample offset of loop start
|-
|0xa
|0x2
|
|Zero-padding
|}

===== Adpcm Context =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x2
|u16
|Predictor Scale
|-
|0x2
|0x4
|s16[2]
|History Array
|}

=== Sample Data ===
The start of each channel's sample data is aligned up by 64 bytes in file, despite the 4-byte file alignment, outside the last channel, which is truncated to the last non-zero sample (including zeroed samples in a dsp-adpcm block).
{| class="wikitable"
|+
!Format
!Type
!Description
|-
|Pcm16
|2 bytes per sample
|16-bit signed PCM sample data.
|-
|Dsp-Adpcm
|8-byte block array, up to 14 samples per block
|8-bit header for decoding, followed by up to 14 4-bit compressed samples.
|-
|Opus
|
|Header followed by opus data.
|}
[[Category:File formats]]

Engine::actor

2025-10-22T02:03:59Z

Watertoon: Renaming and corrections for shaft::baseproc knowledge.

This namespace houses [[ModuleSystem]]'s Actor system. Which is implemented on top of [[Shaft::baseproc]]. Treat names as unofficial unless otherwise stated.

=== ActorModule ===
The namespace's [[Engine::module#IModule|IModule]].

== Managers ==

=== ActorMgr ===
Houses a set of user callbacks for the actor system. Manages the ActorInstanceHeap which is by default responsible for most BaseProc and PreActor memory management. Maintains an array of factories for creating BaseProc class derivatives by name.

=== PreActorMgr ===
Houses the PreActorRenderer. A pool of ActorSystemSettings with active settings stored in a hash map. A pool of PreActorRenderInfo. Two pools of sets of PreActors. An array of all the sets of PreActors. A PreActor allocator managed by a linked list. Houses the ActorAIGroupMgr and LinkMgr.

==== PreActorRenderer ====
Houses 2 MassModels. An array of PreActorRenderInfo currently pending load. An array of PreActors to be drawn sorted by their actor settings accompanied by an array of batch info grouping similar models together. Houses the PreActorModelComposer thread.

===== PreActorModelComposer (TODO) =====

==== ActorAIGroupMgr ====
Maintains a set of ActorAIGroup.

==== LinkMgr ====
Manages an array of links for PreActors

== Units ==

=== PreActor ===
PreActors manage the state of an ActorBase before it's instantiation. Typically data comes from a bcett file parsed by a BancEntity. A PreActor stores a reference to it's [[Engine::banc#BancEntity|BancEntity]], a home transform, a hash of it's transform, a name, a hash to serve as a unique id, and a reference to it's ActorSystemSettings. If applicable it can contain the following. A ByamlIter to a dynamic section of data used to initialize the ActorBase's Blackboard or for user defined purposes. A ByamlIter to a set of phive specific parameters. A set of information used to initialize the ActorBase's Blackboard. A reference to the PreActor's ActorAIGroup with a set of user provided callbacks from the ActorAIGroup's ActorLogic. A reference to the PreActor's SimultaneousGroup. A reference to the PreActor's FarDeleteGroup. A handle to a set of link's in the LinkMgr. A handle to a StaticCompound referencing the PreActor's Phive PlacementID.

==== ActorSystemSettings (TODO) ====

==== ActorAIGroup (TODO) ====

==== SimultaneousGroup (TODO) ====

==== FarDeleteGroup (TODO) ====

=== ActorBase ===
ActorBase extends shaft::baseproc::BaseProc. It implements an active job for each of the 4 stages provided by the BaseProcMgr. These stages are named PreCalc, PostCalc, PostSensor, and FrameEndCalc. Notably, FrameStartCalc happens directly before PreCalc in the PreCalc job. The physics world for entities is calculated between PreCalc and PostCalc. The physics world for sensors is calculated between PostCalc and PostSensor. ActorBase has a single job priority value that represents only a subset of the priority range offered by BaseProcMgr and applies to each active job.

ActorBase maintains a home transform, a current transform, a request for the next transform, angular and linear velocites, an AABB, a Document reference to it's ActorParam, a reference to it's PreActor, a Transceiver, a BlackboardAccessor, an ActorBaseLink to an optional linked actor, and a pause key allocator for maintaining a more granular pause mask for various actor behavior while the actor is active. The majority of ActorBase behavior is implemented in a set of engine provided optional components (See [[Engine::component#IActorComponent|engine::component]]).

Shaft::baseproc

2025-10-22T01:53:54Z

Watertoon: Write a bit about shaft::baseproc lifecycles.

Shaft::baseproc implements a concurrent actor framework based on scheduling units called a "base procedure". BaseProcs can be asynchronously created by an application and later inserted into the system and modified via requests.

=== BaseProcMgr ===
Manages BaseProcs and BaseProc related sub-managers. Active and sleeping BaseProcs create a job graph spanning 4 "stages" with 8 "priorities" each, for 32 separate job graphs. The job graphs are processed one after the other, following the priorities from highest (0) to lowest (7) before advancing to the next stage. The jobs within each graph are processed concurrently with respect to their dependencies.

==== Lifecycle ====
BaseProcMgr has 5 main states it can move between by various api calls.

===== Idle =====
The system is at rest. Accessing BaseProcs through BaseProcLinks outside the system is legal.

===== Building =====
The system is building the job graph. Active BaseProcs will insert their jobs, and sleeping BaseProcs will instead insert their sleep job if they have one.

===== BaseProc Processing =====
The system is running the current job graph. Accessing BaseProcs through BaseProcLinks outside the system is illegal.

===== Removal Processing =====
The system is processing removal requests. Successfully removed BaseProcs are scheduled for asynchronous deletion.

===== Request Processing =====
The system is processing BaseProc requests. It may be illegal to access a BaseProc outside the system at this time.

=== BaseProc ===
Harbors up to 1 job for each stage and priority. As well as up to 1 sleep job. Is a member of the BaseProc tree. Has global meta-data for being referenced by BaseProcLinks. Can have dependency relations with other BaseProcs.

==== Lifecycle ====
A BaseProc has 12 states grouped into 4 "cycles"; initialization (3), live (4), removal (3), and finalization (2).

===== Initialization =====
This group of states is progressed linearly along the creation of a BaseProc.

====== Uninitialized ======
The default state on creation.

====== PendingInitialize ======
The BaseProc is in the state of being initialized.

====== Initialized ======
The BaseProc has been initialized. Next request processing a "PostInitialize" function will be called once per processing, if it fails the BaseProc may be deleted, or the system may try again under certain conditions. Trying again may not be intended.

===== Live =====
This group of states represents a BaseProc that is "live" in the system. The initial state after "PostInitialize" succeeds is PendingActive, from there a BaseProc can move between Active, Sleeping, or Paused.

====== PendingActive ======
The initial "Live" state of a BaseProc. RequestCancelSleep or RequestCancelPause can be used to attempt to activate the BaseProc.

====== Active ======
The quintessential "Live" state. All of the BaseProc's active jobs will be used in job graph building.

====== Sleeping ======
A heavyweight break in a BaseProc's processing. The BaseProc's sleep job will be used in job graph building. RequestCancelSleep will activate the BaseProc.

====== Paused ======
A lighter break in a BaseProc's processing. The BaseProc's sleep job will be used in job graph building. RequestCancelPause will unpause the BaseProc.

===== Removal =====
After a delete request is processed, a BaseProc is transitioned to the PendingRemoval state.

====== PendingRemoval ======
The BaseProc is removing itself from the application's subsystems. When the OnRemove callback succeeds the BaseProc immediately transitions to the Removal state.

====== Removal ======
The BaseProc removes it's BaseProcLink meta data, invalidating all BaseProcLinks to it, calls the OnStateRemoval callback, and then immediately transitions to the Removed state.

====== Removed ======
Next time there is space the BaseProc will be added to the asynchronous deletion queue and transitioned to the PendingFinalize state.

===== Finalization =====
This group of states to track a BaseProc's asynchronous finalization up to it's deletion.

====== PendingFinalization ======
The BaseProc will call it's PreFinalize callback, remove itself from the BaseProcMgr lists and trees, and then call it's PostFinalize callback before immediate transitioning to the Finalized state.

====== Finalized ======
The BaseProc has completed finalization and will imminently be deleted, with it's memory freed back to it's parent heap.

=== BaseProcBinder ===
Allows watching for the asynchronous creation of a BaseProc. On completion a BaseProcLink to that BaseProc can be retrieved.

=== BaseProcLink ===
A "hyperlink" reference to a BaseProc. Used to retrieve scoped "read" or "write" accessors to a BaseProc. The accessors follow the C++ "optional" pattern, where retrieving one can fail to retrieve the underlying BaseProc. There are a few rules regarding when an accessor is legal to acquire. Read accessors are the least strict, and succeed as long as the BaseProc has not processed a delete request. Write accessors have 3 different rulesets for anywhere, outside the system, and a strict inside the system.

ModuleSystem

2025-10-22T00:14:35Z

Watertoon: Wording changes and a minor note on NSO PT 1.1.0

ModuleSystem is the unofficial name of Nintendo EPD's latest game engine, based on the name of the singular sead::Task at the heart of the mainloop. It's actor system appears to be a sequel in design to KingSystem, the engine created for The Legend of Zelda: Breath of the Wild. ModuleSystem appears to have replaced both ActionLibrary and LunchPack2 as the new primary engine for Nintendo EPD's and NST's game development teams. While each game shares a common set of engine features, each series appears to have a custom fork extending the engine with varying degrees of game specific functionality.

=== Games ===
{| class="wikitable"
|+
!Name
!Extension/Differences summary
|-
|Nintendo Switch Sports
|Graphics Module contains a Mii data manager.
|-
|Splatoon 3
|ModuleSystem is extended to thunder::ModuleSystem, notably adding the ability to run the CPU side of the mainloop multiple times per frame. Omits gamedata for a custom save system.
|-
|The Legend of Zelda: Tears of the Kingdom
|Major version up from Splatoon 3 and Nintendo Switch Sports. Some engine namespaces were updated between version 1.0.0 and 1.1.0. Includes the TerrainModule and LODModule, while most other games only contain references to these systems.
|-
|Super Mario Wonder
|Some libraries are newer than Tears of the Kingdom, some are older.
|-
|Mario Vs Donkey Kong
|Appears to be slightly behind version of Tears of the Kingdom. shaft::baseproc::BaseProc has a new "Stasus" state used when swapping actors between "combined scenes". Uses a custom 2d physics engine under engine::coll2d, yet leaves the PhysicsModule with an unused version of the phive library implemented on top of PhysX 3.4 instead of Havok.
|-
|Nintendo Switch Online: Playtest Program
|A major version above Tears of the Kingdom. engine::module::IModule no longer inherits sead::Job and instead includes a job as a member. A new actor component called CppExecutorComponent was added to ActorBase. Actor system processing was slightly revised. Phive has many notable refactors and additions in this title, including a new locomotion behavior state machine and a new file format called bphnv (not appearing in this title).
The later 1.1.0 version further updated most libraries. Support for a new "bpvsts" file format was added to Phive, other "VolumeStats" leftovers strongly suggest the format is voxel related. The exb file format gained support for u32 typed arguments, as did ainb's blackboard. Sead now has an nn::util::ReferSymbol string "SDK MW+Nintendo+Sead-1_0_0_0". The engine received CSharp scripting support through engine::ecsharp similar to the engine's lua support, though this is stubbed in retail. 2 new actor components, NaviAnimatorComponent and BoneBindComponent were added to ActorBase.
|}

=== Namespaces ===
The top level namespace for ModuleSystem is engine. Sub-namespaces typically include a module wrapping a system for a dedicated purpose, whether unique to the engine or contracted out to an external library. Interfaces to the system are typically provided to Actors or Scenes.
{| class="wikitable"
|+
!Namespace
!Description
|-
|actor
|Implements the actor system on top of [[shaft::baseproc]].
|-
|ai
|Wraps the ai library. Integrates with PreActors through ActorAIGroups, ActorBase through the AIComponent, and IScene through the SequenceComponent.
|-
|as
|Wraps the as library. Integrates with ActorBase through the RetargetScaleComponent, ASInfoComponent, ASOptimizeComponent, and ASComponent.
|-
|bake
|Wraps the bake library.
|-
|banc
|Implements BancEntities via the BancModule. Banc handles the parsing of map units into PreActors, actor ai groups, rails, placement groups, far delete groups, and custom game extensions.
|-
|bb (Unofficial)
|Wraps the bb library, responsible for managing bb::Blackboards. Integrates with ActorBase through BlackboardComponentActor and IScene with BlackboardComponentScene.
|-
|camera
|Implements a camera system. Integrates with ActorBase via the CameraComponent.
|-
|component
|Houses all engine components from the other namespaces for engine::actor::ActorBase and engine::scene::IScene.
|-
|controller
|Implements a controller manager.
|-
|debug
|Stubbed in retail. Seemingly implements a debug menu called "ClickMenu".
|-
|ecsharp
|Stubbed in retail. Seemingly implements support for CSharp scripting for debugging.
|-
|effect
|Wraps shaft::effect for managing effect resources.
|-
|erepo (unofficial)
|Wraps the erepo library for PlayReport management.
|-
|event
|Implements an event system on top of the evfl library for Event Flows and Timelines, and the sdk movie library for prerendered video. Integrates with ActorBase through the BeforehandLoadEventComponent, EventMemberComponent, and EventPerformerComponent.
|-
|framework
|Implements a minor extension to sead::GameFrameworkNx, and the SpStepRateMgr.
|-
|gamedata
|Wraps the gmd library for managing a global, computable, and savable hash map of game data.
|-
|graphics (unofficial)
|Wraps the gsys library, which extends the agl library. Integrates with ActorBase through the ModelComponent and ModelBindComponent.
|-
|lod
|Implements a level of detail system. Integrates with ActorBase through the LODComponent.
|-
|lua
|Stubbed in retail. Seemingly implements support for lua scripting for debugging.
|-
|module
|Implements the ModuleSystem sead::Task, as well as the IModule interface.
|-
|physics
|Wraps the phive library. Integrates with ActorBase through the PhysicsComponent.
|-
|rail
|Implements the RailMgr, manages rails parsed from banc.
|-
|reaction
|Implements a system for triggering reactions through reaction actors and XLink commands somehow (unknown at time of writing). Integrates with ActorBase via the ReactionComponent.
|-
|resource
|Wraps the ares library and implements ares::IApplicationImpl to provide asynchronous file resource management through ResourceBinders. Also wraps the pp library and implements pp::GfMgrCallback to provide a general parameter system via hierarchical Documents.
|-
|rsdb
|Wraps the pp::rsdb sub library. Manages a set of engine as well as game extended resource databases.
|-
|rumble
|Implements a rumble call system to allow sending vibrations to controllers.
|-
|scene
|Implements the scene system.
|-
|sound
|Wraps the alto library, which extends the aal library, which extends the aal::atom sub library.
|-
|system
|Implements the RomConfigMgr and PauseMgr
|-
|terrain
|Wraps the tera library. Provides terrain management.
|-
|transceiver (unofficial)
|Implements a transceiver based message systems. Messages can be sent to directly to a destination, or to a whole set of listeners.
|-
|ui
|Wraps the eui library, which in turn extends nn::ui2d. Provides ui processing and resource management through a layout category based system.
|-
|xlink
|Wraps the xlink2 library. Implements an XLink PreActor Manager. Integrates with ActorBase through the ELinkComponent, SLinkComponent, XLinkComponent, and XLinkSubComponent.
|}

=== Game specific Namespaces ===
These are engine namespaces, that for one reason or another, appear to be game specific extensions.
{| class="wikitable"
|+
!Name
!Game(s)
!Description
|-
|coll2d
|Mario Vs Donkey Kong
|Implements a 2d collision system the game uses instead of phive.
|-
|level
|Mario Vs Donkey Kong
|
|-
|message
|Mario Vs Donkey Kong
|
|-
|move2d
|Mario Vs Donkey Kong
|Implements a 2d movement system.
|}

=== Main Loop ===
The mainloop is implemented as a single sead::Task in the standard sead::GameFrameworkNx mainloop. The mainloop consists of 4 sead::DependencyJobGraph's submitted and ran in a sead::DependencyJobWorkerMgr in succession. These are unofficially called as of writing BeforeActor, AfterActor, GSys, and GSysCalcGpu.
[[Category:Engines]]

Phive

2025-04-14T07:20:14Z

Watertoon: Add some NSO PT additions, rephrase a bit.

Phive is Nintendo's physics library built on top of an external physics library, either Havok or PhysX 3.4 have been observed. The PhysX branch doesn't implement the full feature set and is unused by the game it appears in. The library has an optional cloth and navigation mesh extension for when Havok Navigation and/or Animation are present. It's responsible for providing actors many different physics controllers in a ControllerSet.

=== PhiveBackEnd ===
Top-level manager responsible for bootstrapping and handling the memory management of the external physics library.

=== PhiveConfig ===
Global application settings for phive.

=== DynamicsFramework ===
This is the main application manager for phive. It provides an additional set of managers.

=== ControllerSetBinder ===
Loads all controller set resources.

=== ControllerSetConfig ===
Unpacks binder.

=== ControllerSet ===
This is a set of all physics controller for an actor. Wrapped by ModuleSystem's PhysicsComponent.

=== CharacterController ===
Character controllers provide a framework for kinematics controlled characters. The game can extend character controllers with Update, Result, MoveState, and External components.

==== CharacterProperty ====

==== CharacterMatterRigidBodyEntity ====
Extension of RigidBodyEntity for character controllers.
{| class="wikitable"
|+Matter Rigid Body Specific Request Types
!Name
!Function Arguments
!Description
|-
|ChangeIsRigidBodyMode
|
|Appears to toggle whether the rigid body is treated as such?
|-
|SetAngularVelocity
|
|Extension to base request.
|-
|SetLinearVelocity
|
|Extension to base request.
|-
|SetPositionAndRotation
|
|Extension to base request.
|}

==== CharacterParam ====

==== CharacterUpdate ====

==== CharacterMoveState ====

==== CharacterResult ====

==== CharacterExternal ====

=== BulletBodyControllerEntity ===

=== RigidBodyControllerEntity ===
Top level controller for a set of rigid body entities. Phive config defines the set of possible controller names under "RigidBodyControllerNameEntityCollection".

=== RigidBodyControllerSensor ===
Top level controller for a set of rigid body sensors. Phive config defines the set of possible controller names under "RigidBodyControllerNameSensorCollection".

=== RigidBody ===
The base RigidBody class. The game can file change requests for a RigidBody which will be applied in the next frame.
{| class="wikitable"
|+Known Request Types (unofficial)
!Name
!Function Arguments
!Description
|-
|AddToWorld
|
|Adds RigidBody as a member of their respective Physics world
|-
|RemoveFromWorld
|
|
|-
|NoHit
|
|
|-
|ChangeCollisionQuality
|
|
|-
|ChangeEnableHitRayCast
|
|
|-
|ChangeLayerMask
|
|
|-
|ChangeMotionType
|
|
|-
|ChangeShape
|
|
|-
|SetLayer
|
|
|-
|SetLayerMask
|
|
|-
|SetAngularVelocity
|
|
|-
|SetLinearVelocity
|
|
|-
|SetPositionAndRotation
|
|
|-
|SetSubLayer
|
|
|}

=== RigidBodyEntity ===
These are rigid bodies that exist for the purpose of being a physical object.

==== RigidBodyEntityForceField ====

=== RigidBodySensor ===
These are rigid bodies that exist for the purpose of sensing.

=== ContactCollectionEntity ===

=== ContactCollectionSensor ===

=== Shape ===
Shapes are used to provide form to a RigidBody. Each shape defines a material, sub material, and can be tagged with up to 64 tags, tags as named under phive config "UserShapeTagMaskCollection".
{| class="wikitable"
|+ShapeType Enum (official, from Tears of the Kingdom)
!Name
!Value
!Description
|-
|Sphere
|0
|
|-
|Capsule
|1
|
|-
|Polytope
|2
|A shape created out of an array of up to 255 vertices. Must be convex.
|-
|Box
|3
|
|-
|Cylinder
|4
|
|-
|Cone
|5
|
|-
|CharacterPrism
|6
|
|-
|Compound
|7
|"Instances" shapes into a single "compound" from a set of shapes
|-
|Mesh
|8
|A shape created from the mesh of a Bphsh file
|-
|HeightField
|9
|Base class for all height fields
|-
|HeightFieldBox
|10
|Used in Bphsc for Water
|-
|HeightFieldSphere
|11
|
|-
|HeightFieldCylinder
|12
|Used in Bphsc for Water
|-
|HeightFieldQuadrant
|13
|Used in Bphsc for Water
|-
|HeightFieldVertices
|14
|
|-
|StaticCompound
|15
|Used in Bphsc for compound shapes
|-
|SDFSurfaceOfRevolution
|16
|Shape created by the revolution of an up to 16 point 2d curve around a radius.
|-
|SDFHeightField
|17
|Height field for dynamic modification at runtime
|-
|Dummy
|18
|
|}
{| class="wikitable"
|+ShapeType Enum (official, from Nintendo Switch Online: Playtest Program)
!Name
!Value
!Description
|-
|Sphere
|0
|
|-
|Capsule
|1
|
|-
|Polytope
|2
|A shape created out of an array of up to 255 vertices. Must be convex.
|-
|Box
|3
|
|-
|Cylinder
|4
|
|-
|Cone
|5
|
|-
|CharacterPrism
|6
|
|-
|Compound
|7
|"Instances" shapes into a single "compound" from a set of shapes
|-
|Mesh
|8
|A shape created from the mesh of a Bphsh file
|-
|SDFHeightField
|9
|Height field for dynamic modification at runtime
|-
|HeightField
|10
|Base class for all height fields
|-
|HeightFieldBox
|11
|Used in Bphsc for Water
|-
|HeightFieldSphere
|12
|
|-
|HeightFieldCylinder
|13
|Used in Bphsc for Water
|-
|HeightFieldQuadrant
|14
|Used in Bphsc for Water
|-
|StaticCompound
|15
|Used in Bphsc for compound shapes
|-
|SDFSurfaceOfRevolution
|16
|Shape created by the revolution of an up to 16 point 2d curve around a radius.
|-
|Breakable
|17
|
|-
|Dummy
|18
|
|}

=== ConstraintController ===

=== Constraint ===
{| class="wikitable"
|+Constraint types (unofficial table)
!Name
!Description
|-
|BallAndSocket
|
|-
|CogWheel
|
|-
|Fixed
|
|-
|FreeSlider
|
|-
|Hinge
|
|-
|Pulley
|
|-
|RackAndPinion
|
|-
|Range
|
|-
|Slider
|
|-
|SpringDamper
|
|}

=== Placement ===

=== StaticCompoundController ===

=== Extension ===

==== RopeExtension ====

==== PhiveEntityControlExtension ====

==== InteractiveWaterControllerExtension ====

=== GraphicsControllerSet ===
This is a sub controller set of phive::ControllerSet responsible for physics controllers used for graphical effects.

=== LookingController ===

=== LookIKController ===

=== EyeTextureScrollController ===

=== EyeTexturePatternController ===

=== HelperBone ===

=== Cloth ===

=== RagdollStructure ===

=== FishBoneController ===

=== TailBoneController ===

=== FootIK ===

=== HandIK ===

=== SnakeIK ===

=== BoneModifier ===

=== ModelController ===

=== NavMeshCharacter ===
[[Category:Software stack]]

Bfres

2025-02-21T21:56:27Z

Watertoon: Add partial section order. Meshlet correction.

A bfres file collects a number of 3d-graphics related resources. This article details bfres version 10.0.0 and 10.2.0.

=== File Structure ===
Note this omits optional sections not currently found in at least one file. Such as the placement of user data in animations.

==== Section Order ====

* fres header
* fmdl header array
* fska header array
* fmaa header array
* fvbs header array
* fsha header array
* fscn header array
* memory pool info
* embed file array
* fmdl dictionary
* fska dictionary
* fmaa dictionary
* fvbs dictionary
* fsha dictionary
* fscn dictionary
* embed file dictionary
* fmdl data array:
** fvtx header array
** fmat header array
** reflection header array
** fshp header array
** fskl header
** fskl data:
*** bone header array
*** skin bone index table
*** inverse transform matrix array
*** mirror bone index table
*** bone dictionary
*** bone data array:
**** user data array
**** user data dictionary
**** user data
** shape dictionary
** material dictionary
** fshp data array:
*** mesh array
*** skin bone index array
*** bounding box array
*** bounding sphere array
*** mesh data array:
**** sub mesh array
**** runtime index buffer memory
**** index buffer info
** fvtx data array:
*** vertex attribute array
*** runtime vertex buffer memory array
*** vertex buffer info array
*** vertex buffer stride info array
*** runtime user vertex buffer pointer array
*** vertex attribute dictionary
** fmat data array:
*** render info value string array
*** render info value s32 array
*** render info value float array
*** render info value count array
*** render info value offset array
*** runtime texture view pointer array
*** sampler info array
*** runtime sampler array
*** shader param value array
*** runtime shader param uniform buffer offset array
*** shader param convert flag array
*** user data array
*** runtime sampler descriptor slot array
*** runtime texture view descriptor slot array
*** texture name array
*** static shader variation header
*** static shader variation data:
**** vertex attribute name array
**** vertex attribute variation to reflection array (only if different)
**** vertex attribute reflection to variation array (only if different)
**** sampler name array
**** sampler variation to reflection array (only if different)
**** sampler reflection to variation array (only if different)
**** static shader bool array
**** static shader string array
**** static shader option variation to reflection index array (only if different)
**** static shader option reflection to variation index array (only if different)
*** user data
*** sampler dictionary
*** user data dictionary
** reflection data array:
*** render info array
*** shader param array
*** shader param dictionary (deduplicated between reflections)
*** render info dictionary (deduplicated between reflections)
*** vertex attribute dictionary (deduplicated between reflections)
*** sampler dictionary (deduplicated between reflections)
*** static shader option dictionary (deduplicated between reflections)
* fska data array:
** fast bind table
** bone anim header array
** bone anim data array:
*** default result
*** anim curve header array
*** anim curve frame and value data array
* fvba data array:
** default result array
** fast bind array
** bone name array
** anim curve header array
** anim curve frame and value data array
* fmaa data array:
** fast bind array
** per material anim header array
** runtime texture view descriptor slot array
** runtime texture view pointer array
** texture name array
** per material anim data array:
*** shader param anim array
*** texture pattern anim array
*** constant array
*** anim curve header array
*** anim curve frame and value data array
* fsha data array:
** fast bind table
** vertex shape anim header array
** vertex shape anim data array:
*** key shape anim array
*** anim curve header array
*** default result array
*** anim curve frame and value data array
* fscn data array:
** fcam header array
** flit header array
** ffog header array
** fcam dictionary
** flit dictionary
** ffog dictionary
** fcam data array:
*** anim curve header array
*** default result
*** anim curve frame and value data array
** flit data array:
*** anim curve header array
*** default result
*** anim curve frame and value data array
** ffog data array:
*** anim curve header array
*** default result
*** anim curve frame and value data array
* string pool
* gpu region:
** index buffer data
** vertex buffer data
* runtime memory pool
* embed file region
* relocation table

=== Header (nn::g3d2::ResFile) ===
A bfres file header collects a number of optional resources that can be iterated through by array or looked up by name through dictionary. Resources include 3d model data, model animation data, scene animation data, and embedded files. A Bfres can contain a "GPU region", a block of memory meant to be made GPU visible, or reference an external GPU region.
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x20
|[[Common nn::util#nn::util::BinaryFileHeader|nn::util::BinaryFileHeader]]
|Base header with magic of "FRES ".
|-
|0x20
|0x8
|const char * (NW)
|File name
|-
|0x28
|0x8
|ResModel *
|Model array
|-
|0x30
|0x8
|[[Common nn::util#nn::util::ResDic|nn::util::ResDic]] *
|Model dictionary
|-
|0x38
|0x8
|void*[4]
|
|-
|0x58
|0x8
|ResSkeletalAnim *
|Skeletal animation array
|-
|0x60
|0x8
|[[Common nn::util#nn::util::ResDic|nn::util::ResDic]] *
|Skeletal animation dictionary
|-
|0x68
|0x8
|ResMaterialAnim *
|Material animation array
|-
|0x70
|0x8
|[[Common nn::util#nn::util::ResDic|nn::util::ResDic]] *
|Material animation dictionary
|-
|0x78
|0x8
|ResBoneVisibilityAnim *
|Bone visibility animation array
|-
|0x80
|0x8
|[[Common nn::util#nn::util::ResDic|nn::util::ResDic]] *
|Bone visibility animation dictionary
|-
|0x88
|0x8
|ResShapeAnim *
|Shape animation array
|-
|0x90
|0x8
|[[Common nn::util#nn::util::ResDic|nn::util::ResDic]] *
|Shape animation dictionary
|-
|0x98
|0x8
|ResSceneAnim *
|Scene animation array
|-
|0xa0
|0x8
|[[Common nn::util#nn::util::ResDic|nn::util::ResDic]] *
|Scene animation dictionary
|-
|0xa8
|0x8
|nn::gfx::TMemoryPool *
|Runtime MemoryPool (set by g3d)
|-
|0xb0
|0x8
|[[Common nn::gfx#nn::gfx::MemoryPoolInfo|nn::gfx::MemoryPoolInfo]]
|Pre-initialized MemoryPool info pointing to GPU region
|-
|0xb8
|0x8
|[[Common nn::gfx#nn::gfx::ResEmbedFile|nn::gfx::ResEmbedFile]] *
|Embed file array
|-
|0xc0
|0x8
|[[Common nn::util#nn::util::ResDic|nn::util::ResDic]] *
|Embed file dictionary
|-
|0xc8
|0x8
|void *
|User pointer in EPD software. (possibly a UI tree in nn::ui?)
|-
|0xd0
|0x8
|const char * (NW)
|
|-
|0xd8
|0x4
|u32
|
|-
|0xdc
|0x2
|u16
|Model array count
|-
|0xde
|0x2
|u16
|
|-
|0xe0
|0x2
|u16
|
|-
|0xe2
|0x2
|u16
|Skeletal animation array count
|-
|0xe4
|0x2
|u16
|Material animation array count
|-
|0xe6
|0x2
|u16
|Bone visibility animation count
|-
|0xe8
|0x2
|u16
|Shape animation count
|-
|0xea
|0x2
|u16
|Scene animation count
|-
|0xec
|0x2
|u16
|Embed file count
|-
|0xee
|0x2
|u16
|
|}

=== Model (nn::g3d2::ResModel) ===
A model represents a collection of 3d shape data, material data, and a skeleton.
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Magic, always "FMDL"
|-
|0x4
|0x4
|u32
|
|-
|0x8
|0x8
|const char* (NW)
|Model name
|-
|0x10
|0x8
|const char* (NW)
|
|-
|0x18
|0x8
|ResSkeleton*
|Skeleton
|-
|0x20
|0x8
|ResVertex*
|Vertex array
|-
|0x28
|0x8
|ResShape*
|Shape array
|-
|0x30
|0x8
|[[Common nn::util#nn::util::ResDic|nn::util::ResDic]]*
|Shape dictionary
|-
|0x38
|0x8
|ResMaterial*
|Material array
|-
|0x40
|0x8
|[[Common nn::util#nn::util::ResDic|nn::util::ResDic]]*
|Material dictionary
|-
|0x48
|0x8
|ResShaderReflection*
|Shader reflection array
|-
|0x50
|0x8
|Gfx User Data*
|User data array
|-
|0x58
|0x8
|[[Common nn::util#nn::util::ResDic|nn::util::ResDic]]*
|User data dictionary
|-
|0x60
|0x8
|void *
|Runtime user pointer
|-
|0x68
|0x2
|u16
|Vertex count
|-
|0x6a
|0x2
|u16
|Shape count
|-
|0x6c
|0x2
|u16
|Material count
|-
|0x6e
|0x2
|u16
|Shader reflection count
|-
|0x70
|0x2
|u16
|User data count
|-
|0x72
|0x6
|
|
|}

==== Vertex (nn::g3d2::ResVertex) ====
A ResVertex references a collection of vertex buffers in the GPU region. Reflection and settings are provided for the vertex buffers and attributes. Runtime object memory is provided to initialize graphics api objects for the vertex buffers.
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Magic "FVTX"
|-
|0x4
|0x4
|u32
|
|-
|0x8
|0x8
|ResVertexAttribute*
|Vertex atribute array
|-
|0x10
|0x8
|[[Common nn::util#nn::util::ResDic|nn::util::ResDic]]*
|Vertex attribute dictionary
|-
|0x18
|0x8
|void *
|Runtime memory pool pointer
|-
|0x20
|0x8
|void *
|Runtime vertex buffer array (0x48 bytes of zeroed memory per vertex buffer)
|-
|0x28
|0x8
|void **
|Runtime user vertex buffer array
|-
|0x30
|0x8
|nn::gfx::BufferInfo*
|Vertex buffer info array
|-
|0x38
|0x8
|ResVertexBufferStride*
|Vertex buffer stride array
|-
|0x40
|0x8
|void *
|Runtime user pointer
|-
|0x48
|0x4
|u32
|Base offset of vertex data in GPU region, relative to start of GPU region
|-
|0x4c
|0x1
|u8
|Vertex attribute count
|-
|0x4d
|0x1
|u8
|Vertex buffer count
|-
|0x4e
|0x2
|u16
|Index of this section in parent ResModel
|-
|0x50
|0x4
|u32
|Vertex count
|-
|0x54
|0x2
|u16
|
|-
|0x56
|0x2
|u16
|Alignment of vertex buffer data in GPU region
|}

===== ResVertexAttribute =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|const char* (NW)
|Attribute name
|-
|0x8
|0x4
|u32, nn::gfx::AttributeFormat
|Attribute format
|-
|0xc
|0x2
|u16
|Buffer offset
|-
|0xe
|0x1
|u8
|Buffer index
|-
|0xf
|0x1
|u8
|Indicates whether this is a dynamic vertex attribute for shape blending
|}

===== ResVertexBufferStride =====
Unused bytes might indicate nn::gfx::VertexBufferInfo.
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Stride
|-
|0x4
|0x4
|u32
|Divisor
|-
|0x8
|0x4
|u32
|
|-
|0xc
|0x4
|u32
|
|}

==== Shape (nn::g3d2::ResShape) ====
A shape represents 3d mesh data. Either via a set of level-of-detail meshes into the vertex buffers of a ResVertex, or alternatively in v10.2.0 onwards, a set of meshlet buffers.
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Magic "FSHP"
|-
|0x4
|0x4
|u32
|Flags
|-
|0x8
|0x8
|const char* (NW)
|Shape name
|-
|0x10
|0x8
|ResVertex*
|Referenced vertex
|-
|0x18
|0x8
|ResMesh* or ResMeshlet*
|Level-of-detail mesh array, or if flags bit 4 is set, a ResMeshlet
|-
|0x20
|0x8
|u16*
|Skinning bone index array
|-
|0x28
|0x8
|ResKeyShape*
|Key shape array
|-
|0x30
|0x8
|[[Common nn::util#nn::util::ResDic|nn::util::ResDic]]*
|Key shape dictionary
|-
|0x38
|0x8
|ResBounding*
|Bounding box array
|-
|0x40
|0x8
|ResBoundingSphere*
|Bounding sphere array
|-
|0x48
|0x8
|void *
|Runtime user pointer
|-
|0x50
|0x2
|u16
|Index of this section in parent ResModel
|-
|0x52
|0x2
|u16
|Material index
|-
|0x54
|0x2
|u16
|Base bone index
|-
|0x56
|0x2
|u16
|Vertex index
|-
|0x58
|0x2
|u16
|Skin bone index count
|-
|0x5a
|0x1
|u8
|Vertex skin weight count
|-
|0x5b
|0x1
|u8
|Mesh count
|-
|0x5c
|0x1
|u8
|Key shape count
|-
|0x5d
|0x1
|u8
|Target attribute count
|-
|0x5e
|0x2
|u16
|
|}

===== ResMesh =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|ResSubMeshRange*
|Array of sub mesh ranges
|-
|0x8
|0x8
|void *
|Runtime memory pool pointer
|-
|0x10
|0x8
|void *
|Runtime index buffer memory (0x48 bytes of zeroed memory)
|-
|0x18
|0x8
|nn::gfx::BufferInfo*
|Index buffer info
|-
|0x20
|0x4
|u32
|Offset of index buffer in GPU region relative to start of GPU region
|-
|0x24
|0x4
|u32, nn::gfx::PrimitiveTopology
|Primitive topology to use for drawing commands
|-
|0x28
|0x4
|u32, nn::gfx::IndexFormat
|Index format to use in drawing commands
|-
|0x2c
|0x4
|u32
|Index count
|-
|0x30
|0x4
|u32
|Base vertex
|-
|0x34
|0x2
|u16
|Sub mesh count
|-
|0x36
|0x2
|u16
|
|}

====== ResSubMeshRange ======
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Offset of sub mesh relative to start of index buffer
|-
|0x4
|0x4
|u32
|Index count of sub mesh
|}

===== ResKeyShape =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x12
|u8[18]
|Relative key shape attribute location array
|-
|0x12
|0x2
|u8[2]
|
|}

===== ResBounding =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0xc
|Float3
|Position
|-
|0xc
|0xc
|Float3
|Extent
|}

===== ResBoundingSphere =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0xc
|Float3
|Position
|-
|0xc
|0x4
|float
|Radius
|}

===== ResMeshlet =====
Currently only observed unused in Nintendo Switch Online: Playtest Program.
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|...
|
|-
|0x8
|0x8
|void *
|Runtime meshlet buffer array (0x48 bytes of zeroed memory per meshlet buffer)
|-
|0x10
|0x8
|nn::gfx::BufferInfo*
|Meshlet buffer info array
|-
|0x18
|0x8
|s64 *
|Meshlet buffer memory offset array, each entry relative to start of GPU region
|-
|0x20
|0x24
|...
|
|-
|0x44
|0x1
|u8
|Meshlet buffer count
|-
|0x45
|0x3
|...
|
|}

==== Shader Reflection ====
A ResShaderReflection provides reflection for resolving material parameter data for a shader inside a bfsha shader archive.
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|const char* (NW)
|Shader archive name
|-
|0x8
|0x8
|const char* (NW)
|Shader name
|-
|0x10
|0x8
|ResRenderInfo*
|Render info array
|-
|0x18
|0x8
|[[Common nn::util#nn::util::ResDic|nn::util::ResDic]]*
|Render info dictionary
|-
|0x20
|0x8
|ResShaderParam*
|Material shader parameter array
|-
|0x28
|0x8
|[[Common nn::util#nn::util::ResDic|nn::util::ResDic]]*
|Material shader parameter dictionary
|-
|0x30
|0x8
|[[Common nn::util#nn::util::ResDic|nn::util::ResDic]]*
|Vertex attribute dictionary
|-
|0x38
|0x8
|[[Common nn::util#nn::util::ResDic|nn::util::ResDic]]*
|Sampler dictionary
|-
|0x40
|0x8
|[[Common nn::util#nn::util::ResDic|nn::util::ResDic]]*
|Static shader option dictionary
|-
|0x48
|0x2
|u16
|Render info count
|-
|0x4a
|0x2
|u16
|Shader parameter count
|-
|0x4c
|0x2
|u16
|Shader parameter data size
|-
|0x4e
|0xa
|u8[10]
|
|}

===== ResRenderInfo =====
Render info provides reflection for CPU-side rendering parameters.
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|const char* (NW)
|Render info name
|-
|0x8
|0x1
|u8
|Render info data type
|-
|0x9
|0x7
|u8[7]
|
|}

====== Render info data type ======
{| class="wikitable"
|+
!Name
!Value
!Description
|-
|Int
|0
|Value is a 32-bit integer
|-
|Float
|1
|Value is a 32-bit float
|-
|String
|2
|Value is an NW string pointer
|}

===== ResShaderParam =====
ResShaderParam's compose a user generated structure layout for a material uniform buffer. Shader parameters can be animated through material animations.
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|u32(*)(void*,const void*,ResShaderParam*, void*)
|Runtime conversion function for data types requiring runtime conversion of a CPU representation to a GPU representation
|-
|0x8
|0x8
|const char* (NW)
|Shader parameter name
|-
|0x10
|0x2
|u16
|Shader parameter offset
|-
|0x12
|0x1
|u8
|Shader parameter data type
|-
|0x13
|0x5
|u8[5]
|
|}

====== Shader parameter data type ======
{| class="wikitable"
|+
!Name
!Value
!Description
|-
|Bool
|0
|
|-
|Bool2
|1
|
|-
|Bool3
|2
|
|-
|Bool4
|3
|
|-
|Int
|4
|
|-
|Int2
|5
|
|-
|Int3
|6
|
|-
|Int4
|7
|
|-
|UInt
|8
|
|-
|UInt2
|9
|
|-
|UInt3
|10
|
|-
|UInt4
|11
|
|-
|Float
|12
|
|-
|Float2
|13
|
|-
|Float3
|14
|
|-
|Float4
|15
|
|-
|Matrix2x2
|17
|
|-
|Matrix2x3
|18
|
|-
|Matrix2x4
|19
|
|-
|Matrix3x2
|20
|
|-
|Matrix3x3
|21
|
|-
|Matrix3x4
|22
|
|-
|Matrix4x2
|23
|
|-
|Matrix4x3
|24
|
|-
|Matrix4x4
|25
|
|-
|Srt2d
|26
|
|-
|Srt3d
|27
|
|-
|SrtTexture
|28
|
|}

==== Material (nn::g3d2::ResMaterial) ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Magic "FMAT"
|-
|0x4
|0x4
|u32
|Flags (bit 0 = is visible)
|-
|0x8
|0x8
|const char* (NW)
|Material name
|-
|0x10
|0x8
|ResStaticShaderVariation*
|Static shader variation
|-
|0x18
|0x8
|void**
|Runtime texture view pointer array
|-
|0x20
|0x8
|const char** (NW)
|Texture name array
|-
|0x28
|0x8
|void*
|Runtime sampler array (0x78 bytes of zeroed memory per sampler)
|-
|0x30
|0x8
|nn::gfx::SamplerInfo*
|Sampler info array
|-
|0x38
|0x8
|[[Common nn::util#nn::util::ResDic|nn::util::ResDic]]*
|Sampler dictionary
|-
|0x40
|0x8
|void*
|Render info value array
|-
|0x48
|0x8
|u16*
|Render info value count array
|-
|0x50
|0x8
|u16*
|Render info value offset array
|-
|0x58
|0x8
|void*
|Shader parameter value array
|-
|0x60
|0x8
|s32*
|Runtime shader parameter material uniform buffer offset array
|-
|0x68
|0x8
|u64
|
|-
|0x70
|0x8
|Gfx user data*
|User data array
|-
|0x78
|0x8
|[[Common nn::util#nn::util::ResDic|nn::util::ResDic]]*
|User data dictionary
|-
|0x80
|0x8
|u32 *
|Shader parameter runtime convert bit array
|-
|0x88
|0x8
|void*
|Runtime user pointer
|-
|0x90
|0x8
|u64*
|Runtime sampler descriptor slot array
|-
|0x98
|0x8
|u64*
|Runtime texture view descriptor slot array
|-
|0xa0
|0x2
|u16
|Index of this section in parent ResModel
|-
|0xa2
|0x1
|u8
|Sampler count
|-
|0xa3
|0x1
|u8
|Texture count
|-
|0xa4
|0x2
|u16
|Is force calculate material
|-
|0xa6
|0x2
|u16
|User data count
|-
|0xa8
|0x2
|u16
|Render info value size
|-
|0xaa
|0x2
|u16
|Runtime material uniform buffer size
|-
|0xac
|0x4
|u32
|
|}

===== ResStaticShaderVariation =====
A material references a ResStaticShaderVariation which selects the material's static shader variation out of the shader referenced by a ResShaderReflection.
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|ResShaderReflection*
|Shader reflection
|-
|0x8
|0x8
|const char** (NW)
|Vertex attribute name array, of those used in this specific static shader variation
|-
|0x10
|0x8
|u8*
|Vertex attribute index array
|-
|0x18
|0x8
|const char** (NW)
|Sampler name array, of those used in this specific static shader variation
|-
|0x20
|0x8
|u8*
|Sampler index array
|-
|0x28
|0x8
|u32*
|Static shader option choice packed bool array
|-
|0x30
|0x8
|const char** (NW)
|Static shader option choice string array
|-
|0x38
|0x8
|u16*
|Static shader option index array
|-
|0x40
|0x4
|u32
|
|-
|0x44
|0x1
|u8
|Vertex attribute count
|-
|0x45
|0x1
|u8
|Sampler count
|-
|0x46
|0x2
|u16
|Static shader option bool count
|-
|0x48
|0x2
|u16
|Total static shader option count
|-
|0x4a
|0x6
|u8[6]
|
|}
[[Category:File formats]]

AINB

2025-02-11T23:33:55Z

Watertoon: Update "precondition" to "query" and "internal" to "property" based on terminology found in NSO Playtest.

'''AINB''' ('''AI''' '''N'''ode '''B'''inary) is a file format implementing behavior trees for game-specific code. At time of writing it has only appeared in titles on the ModuleSystem game engine. This article is primarily aimed at the version that appears in ''Tears of the Kingdom,'' ''Super Mario Bros. Wonder, Mario vs Donkey Kong,'' and ''Nintendo Switch Online: Playtest Program'' (v0x407). An older version appears in ''Nintendo Switch Sports'' and ''Splatoon 3'' (v0x404). ModuleSystem provides 3 built-in file categories that appear in their own dedicated folders in a title's romfs, being "AI" for actor behavior, "Logic" for actor ai group behavior, and "Sequence" for scene behavior, individual games are free to create their own file categories.

=== File Structure ===
AINB is little endian. An AINB file defines a set of commands to evaluate a tree of built-in or game-specific node classes. The built-in "Element_ModuleCaller" node and supporting structures allow a "root" AINB file to call out to an external "module" AINB file, module's can call further modules, allowing AINB files to form a tree of tree's. An AINB's file extension typically designates whether it is a root <code>.root.ainb</code> or module <code>.module.ainb</code>. For AI and Sequence files, the file's entry point is one or more commands which is linked to one or two child nodes. All nodes are accessed by their index (references to query nodes will use their query node index which is local to the amount of query nodes in the file).

All string offsets in the file are relative to the beginning of the string pool and name hashes are 32-bit murmur3 hashes. There are six possible data types for AINB parameters: int (signed 32-bit integer), bool, float (32-bit), vector3f, and pointer. Pointer parameters are pointers to objects.

==== Section Order ====

# 0x74-Byte File Header
# Commands
# Nodes
# Local Blackboard Parameters
# Node Bodies
# Attachment Parameters
# Property Parameters
# Input/Output Parameters
# Multi-Parameters
# Active Node Update Array
# 0x50 Section (Unused in ''TotK'')
# Query Node Array
# Expression Binary
# AINB Modules
# External Action Array
# File Hashes
# Child Replacement Table
# 0x6C Section
# Enum Resolve Array
# String Pool

=== Sections ===

==== File Header ====
AINB files begin with a 0x74 byte header. If the offset for a given section is empty, that section is not present in the file.
{| class="wikitable"
|+File Header
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|char[4]
|Magic - “AIB “
|-
|0x04
|0x04
|u32
|Version (0x0407 in ''TotK'', 0x0404 in ''S3'' and ''NSS'')
|-
|0x08
|0x04
|u32
|Filename Offset
|-
|0x0C
|0x04
|u32
|Command Count
|-
|0x10
|0x04
|u32
|Node Count
|-
|0x14
|0x04
|u32
|Query Node Count
|-
|0x18
|0x04
|u32
|Attachment Parameter Count
|-
|0x1C
|0x04
|u32
|Output Node Count
|-
|0x20
|0x04
|u32
|Local Blackboard Parameters Offset
|-
|0x24
|0x04
|u32
|String Pool Offset
|-
|0x28
|0x04
|u32
|Enum Resolve Array Offset
|-
|0x2C
|0x04
|u32
|Property Parameters Offset
|-
|0x30
|0x04
|u32
|Active Node Update Array Offset
|-
|0x34
|0x04
|u32
|Input/Output Parameters Offset
|-
|0x38
|0x04
|u32
|Multi-Parameters Array Offset
|-
|0x3C
|0x04
|u32
|Attachment Parameters Offset
|-
|0x40
|0x04
|u32
|Attachment Parameters Index Array Offset
|-
|0x44
|0x04
|u32
|Expression Binary Section Offset
|-
|0x48
|0x04
|u32
|Child Replacement Table Offset
|-
|0x4C
|0x04
|u32
|Query Node Array Offset
|-
|0x50
|0x04
|u32
|Unknown (unused in ''TotK'', always the same as the Active Node Update Array Offset)
|-
|0x54
|0x04
|u32
|Unknown (always 0)
|-
|0x58
|0x04
|u32
|Unknown (always 0, used in ''Splatoon 3''/''Nintendo Switch Sports'')
|-
|0x5C
|0x04
|u32
|AINB Modules Array Offset
|-
|0x60
|0x04
|u32
|File Category Name Offset
|-
|0x64
|0x04
|u32
|File Category (0 = AI, 1 = Logic, 2 = Sequence) (''Splatoon 3'' game specific, 3 = UniqueSequenceSPL)
|-
|0x68
|0x04
|u32
|External Action Array Offset
|-
|0x6C
|0x04
|u32
|Unknown (Unused in ''TotK'')
|-
|0x70
|0x04
|u32
|File Identification Hashes Offset (Purpose Unknown)
|}

==== Command Array ====
The command array immediately follows the file header and is an array of all commands in the file.
{| class="wikitable"
|+Command Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Command Name Offset
|-
| rowspan="5" |0x04
| rowspan="5" |0x10
|u32
| rowspan="5" |GUID
|-
|u16
|-
|u16
|-
|u16
|-
|u8[6]
|-
|0x14
|0x02
|u16
|Main Node Index
|-
|0x16
|0x02
|u16
|Secondary Node Index (value offset by 1, 0 is reserved)
|}
Command GUIDs are only used for debug messages. Right Node Index will be -1 if the command only has one child node.

==== Node Array ====
The node array immediately follows the command array and is an array of all nodes in the file.
{| class="wikitable"
|+Node Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x02
|u16
|Node Type Enum (see below)
|-
|0x02
|0x02
|u16
|Node Index
|-
|0x04
|0x02
|u16
|Attachment Parameters Count
|-
|0x06
|0x01
|bitfield
|Node Flags
|-
|0x07
|0x01
|u8
|
|-
|0x08
|0x04
|u32
|Node Type Name Offset (for UserDefined nodes)
|-
|0x0C
|0x04
|u32
|Name Hash (version 0x407 only)
|-
|0x10
|0x04
|u32
|
|-
|0x14
|0x04
|u32
|Node Body Offset (relative to the start of the file)
|-
|0x18
|0x02
|u16
|EXB Function Count
|-
|0x1A
|0x02
|u16
|EXB Input/Output Field Size
|-
|0x1C
|0x02
|u16
|Multi-Param Count
|-
|0x1E
|0x02
|u16
|
|-
|0x20
|0x04
|u32
|Base Attachment Parameter Index
|-
|0x24
|0x02
|u16
|Base Query Node
|-
|0x26
|0x02
|u16
|Query Node Count
|-
|0x28
|0x02
|u16
|0x58 Section Entry Offset (relative to the start of the file)
|-
|0x2A
|0x02
|u16
|
|-
| rowspan="5" |0x2C
| rowspan="5" |0x10
|u32
| rowspan="5" |GUID
|-
|u16
|-
|u16
|-
|u16
|-
|u8[6]
|}
Just like with commands, node GUIDs are only used for debug messages. The 0x58 section entry offset will be empty if unused.
{| class="wikitable"
|+Node Types
!Value (Hex)
!Value (Dec)
!Node Type
|-
|0x00
|0
|UserDefined
|-
|0x01
|1
|Element_S32Selector
|-
|0x02
|2
|Element_Sequential
|-
|0x03
|3
|Element_Simultaneous
|-
|0x04
|4
|Element_F32Selector
|-
|0x05
|5
|Element_StringSelector
|-
|0x06
|6
|Element_RandomSelector
|-
|0x07
|7
|Element_BoolSelector
|-
|0x08
|8
|Element_Fork
|-
|0x09
|9
|Element_Join
|-
|0x0A
|10
|Element_Alert
|-
|0x14
|20
|Element_Expression
|-
|0x64
|100
|Element_ModuleIF_Input_S32
|-
|0x65
|101
|Element_ModuleIF_Input_F32
|-
|0x66
|102
|Element_ModuleIF_Input_Vec3f
|-
|0x67
|103
|Element_ModuleIF_Input_String
|-
|0x68
|104
|Element_ModuleIF_Input_Bool
|-
|0x69
|105
|Element_ModuleIF_Input_Ptr
|-
|0xC8
|200
|Element_ModuleIF_Output_S32
|-
|0xC9
|201
|Element_ModuleIF_Output_F32
|-
|0xCA
|202
|Element_ModuleIF_Output_Vec3f
|-
|0xCB
|203
|Element_ModuleIF_Output_String
|-
|0xCC
|204
|Element_ModuleIF_Output_Bool
|-
|0xCD
|205
|Element_ModuleIF_Output_Ptr
|-
|0x012C
|300
|Element_ModuleIF_Child
|-
|0x0190
|400
|Element_StateEnd
|-
|0x01F4
|500
|Element_SplitTiming
|}
Node type names are official. For UserDefined nodes, node definitions can be found in a node definition files. This file is located at <code>NodeDefinition/Node.Product.[ver].aidefn.byml.zs</code> in the corresponding file category folder.
{| class="wikitable"
|+Node Type Descriptions
!Type
!Description
|-
|UserDefined
|Custom node type, definition in NodeDefinition
|-
|Element_S32Selector
|Conditionally links to a node depending on the value of a signed int
|-
|Element_Sequential
|Links to nodes sequentially in the order listed
|-
|Element_Simultaneous
|Links simultaneously to multiple nodes
|-
|Element_F32Selector
|Conditionally links to a node depending on the value of 32-bit float
|-
|Element_StringSelector
|Conditionally links to a node depending on the value of a string
|-
|Element_RandomSelector
|Links to a node randomly
|-
|Element_BoolSelector
|Conditionally links to a node depending on the value of a bool
|-
|Element_Fork
|See Active Node Update Array
|-
|Element_Join
|See Active Node Update Array
|-
|Element_Alert
|Displays a debug message
|-
|Element_Expression
|Passes values to and from EXB commands
|-
|Element_ModuleIF_Input_S32
|Receives a signed int input from the calling AINB file
|-
|Element_ModuleIF_Input_F32
|Receives a 32-bit float input from the calling AINB file
|-
|Element_ModuleIF_Input_Vec3f
|Receives a vector3f input from the calling AINB file
|-
|Element_ModuleIF_Input_String
|Receives a string input from the calling AINB file
|-
|Element_ModuleIF_Input_Bool
|Receives a bool input from the calling AINB file
|-
|Element_ModuleIF_Input_Ptr
|Receives an object pointer input from the calling AINB file
|-
|Element_ModuleIF_Output_S32
|Returns a signed int output from the module to the calling AINB file
|-
|Element_ModuleIF_Output_F32
|Returns a 32-bit float output from the module to the calling AINB file
|-
|Element_ModuleIF_Output_Vec3f
|Returns a vector3f output from the module to the calling AINB file
|-
|Element_ModuleIF_Output_String
|Returns a string output from the module to the calling AINB file
|-
|Element_ModuleIF_Output_Bool
|Returns a bool output from the module to the calling AINB file
|-
|Element_ModuleIF_Output_Ptr
|Returns an object pointer output from the module to the calling AINB file
|-
|Element_ModuleIF_Child
|Returns the node connection name from the module to the calling AINB file
|-
|Element_StateEnd
|Termination node, specifies what resident node to return to in the calling AINB file
|-
|Element_SplitTiming
|Changes when child nodes are run (Enter - first time visiting a node, Update - every frame, Leave - ran upon leaving the node)
|}
{| class="wikitable"
|+Node Flags
!Bits
!Description
|-
|1
|Is Query Node
|-
|1
|Is Module
|-
|1
|Is Resident Node
|-
|1
|MultiParam Type 2
|-
|4
|
|}

==== Local Blackboard Parameters ====
This section contains an array of the Blackboard parameters used by file. These parameters may be sourced from external Blackboards or parameter files. The section begins with a 0x30 byte section header followed by the array of parameters, an array of default values of said parameters, and an array of file references if applicable. The order of parameters is in the order of string, int, float, bool, vector3f, and pointer. The section header contains six entries, one for each type.
{| class="wikitable"
|+Section Header Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x02
|u16
|Number of Entries of the Corresponding Data Type
|-
|0x02
|0x02
|u16
|Parameter Index of the First Entry of the Corresponding Data Type
|-
|0x04
|0x02
|u16
|Relative Offset of the First Entry of the Corresponding Data Type
|-
|0x06
|0x02
|u16
|
|}
{| class="wikitable"
|+Local Blackboard Parameter Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|bitfield
|Name Offset and Flags
|-
|0x04
|0x04
|u32
|String Offset (Notes)
|}
{| class="wikitable"
|+Name Offset Flags
!Bits
!Description
|-
|22
|Name Offset
|-
|1
|
|-
|1
|Does Not Have File Reference
|-
|7
|File Reference Index
|-
|1
|Is File Reference Valid
|}
The default value entries vary based on the parameter's data type. For int, float, and bool parameters, the entry is a four byte immediate value. String entries are a four byte string value offset. Vector3f entries are 12 bytes. Note that pointer parameters do not have default value entries and do not have default values.
{| class="wikitable"
|+File Reference Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|File Path Offset
|-
|0x04
|0x04
|u32
|File Path Hash
|-
|0x08
|0x04
|u32
|Filename Hash (no extension)
|-
|0x0C
|0x04
|u32
|File Extension Hash (no .)
|}

==== Node Bodies ====
Each node body is composed of two parts: a 0x90 byte parameter section and a 0x14 child node section header followed by said section if applicable. The child node section contains information about the child node and specific connection types. The following parameter indices are indices into the parameter array for that specific type and data type.
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Int Property Parameter Base Index
|-
|0x04
|0x04
|u32
|Int Property Parameter Count
|-
|0x08
|0x04
|u32
|Bool Property Parameter Base Index
|-
|0x0C
|0x04
|u32
|Bool Property Parameter Count
|-
|0x10
|0x04
|u32
|Float Property Parameter Base Index
|-
|0x14
|0x04
|u32
|Float Property Parameter Count
|-
|0x18
|0x04
|u32
|String Property Parameter Base Index
|-
|0x1C
|0x04
|u32
|String Property Parameter Count
|-
|0x20
|0x04
|u32
|Vector3f Property Parameter Base Index
|-
|0x24
|0x04
|u32
|Vector3f Property Parameter Count
|-
|0x28
|0x04
|u32
|Pointer Property Parameter Base Index
|-
|0x2C
|0x04
|u32
|Pointer Property Parameter Count
|-
|0x30
|0x04
|u32
|Int Input Parameter Base Index
|-
|0x34
|0x04
|u32
|Int Input Parameter Count
|-
|0x38
|0x04
|u32
|Int Output Parameter Base Index
|-
|0x3C
|0x04
|u32
|Int Output Parameter Count
|-
|0x40
|0x04
|u32
|Bool Input Parameter Base Index
|-
|0x44
|0x04
|u32
|Bool Input Parameter Count
|-
|0x48
|0x04
|u32
|Bool Output Parameter Base Index
|-
|0x4C
|0x04
|u32
|Bool Output Parameter Count
|-
|0x50
|0x04
|u32
|Float Input Parameter Base Index
|-
|0x54
|0x04
|u32
|Float Input Parameter Count
|-
|0x58
|0x04
|u32
|Float Output Parameter Base Index
|-
|0x5C
|0x04
|u32
|Float Output Parameter Count
|-
|0x60
|0x04
|u32
|String Input Parameter Base Index
|-
|0x64
|0x04
|u32
|String Input Parameter Count
|-
|0x68
|0x04
|u32
|String Output Parameter Base Index
|-
|0x6C
|0x04
|u32
|String Output Parameter Count
|-
|0x70
|0x04
|u32
|Vector3f Input Parameter Base Index
|-
|0x74
|0x04
|u32
|Vector3f Input Parameter Count
|-
|0x78
|0x04
|u32
|Vector3f Output Parameter Base Index
|-
|0x7C
|0x04
|u32
|Vector3f Output Parameter Count
|-
|0x80
|0x04
|u32
|Pointer Input Parameter Base Index
|-
|0x84
|0x04
|u32
|Pointer Input Parameter Count
|-
|0x88
|0x04
|u32
|Pointer Output Parameter Base Index
|-
|0x8C
|0x04
|u32
|Pointer Output Parameter Count
|}
{| class="wikitable"
|+Child Node Section Header
!Offset
!Size
!Type
!Description
|-
|0x00
|0x01
|u8
|Bool/float Input Source Node/Output Source Node Count
|-
|0x01
|0x01
|u8
|Bool/float Input Source Node/Output Source Node Base Index
|-
|0x02
|0x01
|u8
|Unknown Connection Type Count (Unused in ''TotK'')
|-
|0x03
|0x01
|u8
|Unknown Connection Type Base Index (Unused ''TotK'')
|-
|0x04
|0x01
|u8
|Standard Child Node Count
|-
|0x05
|0x01
|u8
|Standard Child Node Base Index
|-
|0x06
|0x01
|u8
|Active Node Update Count
|-
|0x07
|0x01
|u8
|Active Node Update Base Index
|-
|0x08
|0x01
|u8
|String Input Source Node Count
|-
|0x09
|0x01
|u8
|String Input Source Node Base Index
|-
|0x0A
|0x01
|u8
|Int Input Source Node Count
|-
|0x0B
|0x01
|u8
|Int Input Source Node Base Index
|-
|0x0C
|0x01
|u8
|Unknown Connection Type Count (Unused in ''TotK'')
|-
|0x0D
|0x01
|u8
|Unknown Connection Type Base Index (Unused ''TotK'')
|-
|0x0E
|0x01
|u8
|Unknown Connection Type Count (Unused in ''TotK'')
|-
|0x0F
|0x01
|u8
|Unknown Connection Type Base Index (Unused ''TotK'')
|-
|0x10
|0x01
|u8
|Unknown Connection Type Count (Unused in ''TotK'')
|-
|0x11
|0x01
|u8
|Unknown Connection Type Base Index (Unused ''TotK'')
|-
|0x12
|0x01
|u8
|Unknown Connection Type Count (Unused in ''TotK'')
|-
|0x13
|0x01
|u8
|Unknown Connection Type Base Index (Unused ''TotK'')
|}
If the node has any child nodes, the section header is followed by an array of u32 offsets to each of the child node entries. For most nodes, each entry is eight bytes.
{| class="wikitable"
|+Child Node Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Child Node Index
|-
|0x04
|0x04
|u32
|Value
|}
The interpretation of the value depends on the connection type. For input or output connections, the value is a string offset to the parameter name. For standard connections, the value is a string offset to the connection name. For active node update connections, the value is an index into the active node update array. Certain node/connection types will also extend the entry length. Selector-type nodes excluding <code>Element_BoolSelector</code> and <code>Element_F32Selector</code> will have an extra four bytes which stores the condition for to link to the child node. For <code>Element_S32Selector</code>, this is an immediate value. For <code>Element_RandomSelector</code>, this is a weight and for <code>Element_StringSelector</code> it is a u32 string offset. The condition for <code>Element_BoolSelector</code> is the entry's value string. <code>Element_F32Selector</code> adds 24 bytes to each entry, consisting of four eight-byte sub-entries.
{| class="wikitable"
|+<code>Element_F32Selector Condition Entry</code>
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Local Blackboard Parameter Index and Flags
|-
|0x04
|0x04
|float
|Condition Value
|}
The first two bytes of the four bytes at offset 0x00 are the local blackboard parameter index while the last bit is whether or not the index is used or not. The first entry for <code>Element_F32Selector</code> is the minimum value condition while the second entry is the maximum value condition. The last two entries appear to be unused. The last child node entry for Selector-type nodes is the default case. The condition for this case is either a string offset to the string その他 ("Other") or 0 (in the case of <code>Element_S32Selector</code>). Input nodes that are Selector-type nodes also appear to have an additional eight bytes (purpose unknown). <code>Element_Expression</code> have an additional eight bytes per input node (16 bytes in the case of vector3f entries). The purpose of these bytes is unknown.

==== Attachment Parameters ====
This section contains an array of attachments for nodes. This section is preceded by the attachment index array which is an array of u32 indices into the entries in this section. Nodes contain an index into the index array rather than directly into this section. The section contains an array of entries followed by an array of parameter entries.
{| class="wikitable"
|+Attachment Parameter Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Name Offset
|-
|0x04
|0x04
|u32
|Parameters Entry Offset
|-
|0x08
|0x02
|u16
|EXB Function Count
|-
|0x0A
|0x02
|u16
|EXB Input/Output Field Size
|-
|0x0C
|0x04
|u32
|Name Hash (version 0x0407 only)
|}
{| class="wikitable"
|+Parameter Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Unknown (possibly related to debug)
|-
|0x04
|0x04
|u32
|Int Property Parameter Base Index
|-
|0x08
|0x04
|u32
|Int Property Parameter Count
|-
|0x0C
|0x04
|u32
|Bool Property Parameter Base Index
|-
|0x10
|0x04
|u32
|Bool Property Parameter Count
|-
|0x14
|0x04
|u32
|Float Property Parameter Base Index
|-
|0x18
|0x04
|u32
|Float Property Parameter Count
|-
|0x1C
|0x04
|u32
|String Property Parameter Base Index
|-
|0x20
|0x04
|u32
|String Property Parameter Count
|-
|0x24
|0x04
|u32
|Vector3f Property Parameter Base Index
|-
|0x28
|0x04
|u32
|Vector3f Property Parameter Count
|-
|0x2C
|0x04
|u32
|Pointer Property Parameter Base Index
|-
|0x30
|0x04
|u32
|Pointer Property Parameter Count
|-
|0x34
|0x04
|u32
|
|-
|0x38
|0x04
|u32
|Unknown (contains address to next entry)
|-
|0x3C
|0x04
|u32
|
|-
|0x40
|0x04
|u32
|Unknown (contains address to next entry)
|-
|0x44
|0x04
|u32
|
|-
|0x48
|0x04
|u32
|Unknown (contains address to next entry)
|-
|0x4C
|0x04
|u32
|
|-
|0x50
|0x04
|u32
|Unknown (contains address to next entry)
|-
|0x54
|0x04
|u32
|
|-
|0x58
|0x04
|u32
|Unknown (contains address to next entry)
|-
|0x5C
|0x04
|u32
|
|-
|0x60
|0x04
|u32
|Unknown (contains address to next entry)
|}

==== Property Parameters ====
This section contains an array of property parameters for nodes. The section begins with a six u32 relative offsets to the first entry for each data type. The data type order for this section is int, bool, float, string, vector3f, and pointer.
{| class="wikitable"
|+Parameter Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Name Offset
|-
|0x04
|0x04
|u32
|Flags
|-
|0x08
|
|
|Value
|}
The value is an immediate value for the data type (excluding string which is a string offset and pointer which doesn't store a value). Pointer entries also have an additional u32 class name offset at offset 0x04, pushing the flags to offset 0x08.
{| class="wikitable"
|+Parameter Flags
!Bits
!Description
|-
|16
|Source Index
|-
|1
|Is Use Index
|-
|1
|Is Not Local Blackboard Index
|-
|1
|
|-
|1
|
|-
|1
|
|-
|1
|
|-
|1
|Is EXB Index
|-
|1
|Pulse Thread Local Storage
|-
|1
|Set Pointer Flag Bit Zero
|-
|2
|
|-
|2
|
|-
|2
|
|}

==== Input/Output Parameters ====
This section contains an array of input and output parameter entries. These appear to be canonically referred to as "plugs". Similarly to the property parameters section, the section begins with u32 relative offsets to the first entry of each data type. However, instead of six offsets, there are 12 - two for each data type (one input, one output). The order of parameters in this section is int input, int output, bool input, bool output, float intput, float output, string input, string output, vector3f input, vector3f output, pointer input, and pointer output.
{| class="wikitable"
|+Input Parameter Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Name Offset
|-
|0x04
|0x02
|s16
|Input Child Node Index / Multi-Parameter Array Base Index
|-
|0x06
|0x02
|s16
|Input/Output Source Node Index / Multi-Parameter Count
|-
|0x08
|0x04
|u32
|Flags
|-
|0x0C
|
|
|Default Value
|}
The default value is an immediate value for the data type (excluding string which is a string offset and pointer which is always an empty four bytes). Pointer entries also have an additional u32 class name offset at offset 0x04, pushing the rest of the entry back by four bytes. If the input child node index is between -32768 and -100, it corresponds to a multi-parameter array index. The multi-parameter index can be calculated as follows: <code>MultiParamIndex = -100 - Index</code>.
{| class="wikitable"
|+Parameter Flags
!Bits
!Description
|-
|16
|Source Index
|-
|1
|Is Use Index
|-
|1
|Is Not Local Blackboard Index
|-
|1
|
|-
|1
|
|-
|1
|
|-
|1
|
|-
|1
|Is EXB Index
|-
|1
|Pulse Thread Local Storage
|-
|1
|Set Pointer Flag Bit Zero
|-
|2
|
|-
|2
|
|-
|2
|
|}
Each output parameter entry is four bytes.
{| class="wikitable"
|+Output Parameter Entry
!Bits
!Description
|-
|31
|Name Offset
|-
|1
|Set Pointer Flag Bit Zero
|}

==== Multi-Parameters ====
This section contains entries specifying parameters that have multiple values and the sources of those values. Each entry is eight bytes.
{| class="wikitable"
|+Multi-Parameter Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x02
|u16
|Node Index
|-
|0x02
|0x02
|u16
|Input/Output Source Parameter Index
|-
|0x04
|0x04
|u32
|Flags
|}
{| class="wikitable"
|+Parameter Flags
!Bits
!Description
|-
|16
|Source Index
|-
|1
|Is Use Index
|-
|1
|Is Not Local Blackboard Index
|-
|1
|
|-
|1
|
|-
|1
|
|-
|1
|
|-
|1
|Is EXB Index
|-
|1
|Pulse Thread Local Storage
|-
|1
|Set Pointer Flag Bit Zero
|-
|2
|
|-
|2
|
|-
|2
|
|}

==== Active Node Update Array ====
This section is an array of entries for updates to the active node array. The first four bytes specify the number of entries. Each entry is four bytes.
{| class="wikitable"
|+
!Bits
!Description
|-
|8
|Is Valid Update
|-
|23
|
|-
|1
|Update Post Calc
|}
If the first byte of the flags is set to false, then the entry contains another four bytes with a string offset (purpose unknown). Otherwise, the entry is considered valid if the first byte equals 1. When processing a node graph, the game maintains an array of active root nodes. When a command calculated, the root node of the command is added to this array and it and its child nodes are calculated recursively. An active node update will change the current active root node to the specified node. This usually happens right before the next command's calculation occurs, but if the top bit is set, then it will occur immediately after the current command's calculation finishes (if the source node is an Element_Join nodes, it will always update the active node post current command calculation). This is primarily used for "subroutines" that run a single time then return to the main execution routine. This system is also used for Element_Fork and Element_Join nodes. An Element_Fork node, unlike normal nodes, will replace the entire current active node array with its array of active node updates (essentially forking execution into multiple different paths). The node at the end of each of these paths will optionally also have an active node update referencing a specific Element_Join node. Each of these nodes will push the Element_Join into the active node array. However, Element_Join nodes have an property parameter called InFlowNum and until it has been pushed onto the array that many times in a single calculation, it will not activate and remain dormant. However, once this threshold is reached, it will begin execution (with a guard to make sure only one of the instances added to the array will execute).

==== 0x50 Section ====
This section is unused in ''Tears of the Kingdom''.

==== Query Node Array ====
This section is an array of entries of query nodes present in the file.
{| class="wikitable"
|+Query Node Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x02
|u16
|Query Node Index (local to number of query nodes)
|-
|0x02
|0x02
|u16
|
|}

==== Expression Binary Section ====
The '''EXB''' ('''Ex'''pression '''B'''inary) section is a completely self-contained section that stores custom instructions for a simple command processor. These instructions are grouped into functions that can be called by nodes to perform calculations. Because the section is self-contained, all offsets in this section are local to the section. The EXB section is shared with ASB files ('''A'''nimation '''S'''equence '''B'''inary).

===== Section Structure =====
EXB is essentially its own format and allows for the storage of custom functions in files.

====== Section Order ======

# 0x2C-Byte Header
# Command Info Table
# Instructions Table
# Parameter Region
# Signature Table
# String Pool

===== Sub-Sections =====

====== Header ======
{| class="wikitable"
|+EXB Header
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|char[4]
|Magic - “EXB “
|-
|0x04
|0x04
|u32
|Version (0x02)
|-
|0x08
|0x04
|u32
|Static Memory Allocation Size
|-
|0x0C
|0x04
|u32
|Parameter EXB Field Entry Count
|-
|0x10
|0x04
|u32
|32-bit Scratch Allocation Size
|-
|0x14
|0x04
|u32
|64-bit Scratch Allocation Size
|-
|0x18
|0x04
|u32
|Command Info Offset
|-
|0x1C
|0x04
|u32
|Command Table Offset
|-
|0x20
|0x04
|u32
|Signature Table Offset
|-
|0x24
|0x04
|u32
|Parameter Region Offset
|-
|0x28
|0x04
|u32
|String Pool Offset
|}

====== Command Info Table ======
This section contains an array of command (function) info entries. The first four bytes specify the entry count.
{| class="wikitable"
|+Command Info Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|s32
|Base Index Pre-Command Entry
|-
|0x04
|0x04
|u32
|Pre-Entry Static Memory Usage
|-
|0x08
|0x04
|u32
|Instruction Base Index
|-
|0x0C
|0x04
|u32
|Instruction Count
|-
|0x10
|0x04
|u32
|Static Memory Size
|-
|0x14
|0x02
|u16
|32-bit Scratch Memory Size
|-
|0x16
|0x02
|u16
|64-bit Scratch Memory Size
|-
|0x18
|0x02
|u16
|Output Data Type Enum
|-
|0x1A
|0x02
|u16
|Input Data Type Enum
|}
{| class="wikitable"
|+Data Type Enum
!Value (Hex)
!Value (Dec)
!Data Type
|-
|0x0
|0
|No Data
|-
|0x1
|1
|Immediate Value/From User
|-
|0x02
|2
|bool
|-
|0x03
|3
|int
|-
|0x04
|4
|float
|-
|0x05
|5
|string
|-
|0x06
|6
|vector3f
|}

====== Instructions Table ======
This section contains an array of instruction entries which are read by the EXB command processor. The first four bytes specify the entry count.
{| class="wikitable"
|+Instruction Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x01
|u8
|Instruction Type
|-
|0x01
|0x01
|u8
|Data Type Enum
|-
|0x02
|0x01
|u8
|Left-Hand Side Parameter Source Enum
|-
|0x03
|0x01
|u8
|Right-Hand Side Parameter Source Enum
|-
|0x04
|0x02
|u16
|Left-Hand Side Parameter Value
|-
|0x06
|0x02
|u16
|Right-Hand Side Parameter Value
|}
For UserDefined type instructions, the bytes at offset 0x02-0x04 become a u16 static memory index and the bytes at 0x04-0x08 become a u32 index into the function signatures table.
{| class="wikitable"
|+Instruction Types
!Value (Hex)
!Value (Dec)
!Instruction Type
|-
|0x01
|1
|Terminator
|-
|0x02
|2
|Store
|-
|0x03
|3
|Negate
|-
|0x04
|4
|NegateBool
|-
|0x05
|5
|Add
|-
|0x06
|6
|Subtract
|-
|0x07
|7
|Multiply
|-
|0x08
|8
|Divide
|-
|0x09
|9
|Modulus
|-
|0x0A
|10
|Increment
|-
|0x0B
|11
|Decrement
|-
|0x0C
|12
|ScalarMultiplyVec3f
|-
|0x0D
|13
|ScalarDivideVec3f
|-
|0x0E
|14
|LeftShift
|-
|0x0F
|15
|RightShift
|-
|0x10
|16
|LessThan
|-
|0x11
|17
|LessThanEqual
|-
|0x12
|18
|GreaterThan
|-
|0x13
|19
|GreaterThanEqual
|-
|0x14
|20
|Equal
|-
|0x15
|21
|NotEqual
|-
|0x16
|22
|AND
|-
|0x17
|23
|XOR
|-
|0x18
|24
|OR
|-
|0x19
|25
|LogicalAND
|-
|0x1A
|26
|LogicalOR
|-
|0x1B
|27
|UserFunction
|-
|0x1C
|28
|JumpIfLHSZero
|-
|0x1D
|29
|Jump
|}
UserFunctions are mapped to a function in the executable by function signature. There are two types of these functions: direct and object. Direct functions are straightforward functions that take up to two arguments and are matched using the function signature. Function objects can take additional arguments and are indexed at runtime.

{| class="wikitable"
|+Data Type Enum
!Value (Hex)
!Value (Dec)
!Data Type
|-
|0x0
|0
|No Data
|-
|0x1
|1
|Immediate Value/From User
|-
|0x02
|2
|bool
|-
|0x03
|3
|int
|-
|0x04
|4
|float
|-
|0x05
|5
|string
|-
|0x06
|6
|vector3f
|}
{| class="wikitable"
|+Parameter Source Enum
!Value (Hex)
!Value (Dec)
!Parameter Source
|-
|0x00
|0
|Immediate Parameters
|-
|0x01
|1
|Immediate Parameters (String)
|-
|0x02
|2
|Static Memory
|-
|0x03
|3
|Parameters Region
|-
|0x04
|4
|Parameters Region (String)
|-
|0x05
|5
|Output Value
|-
|0x06
|6
|Input Value
|-
|0x07
|7
|32-bit Scratch
|-
|0x08
|8
|64-bit Scratch
|-
|0x09
|9
|UserOutput
|-
|0x0A
|10
|UserInput
|}
UserCallback is a class that contains virtual functions providing memory allocation. The input value is passed from the calling node and the output value is passed back.

====== Parameter Region ======
The parameter region is a region that stores the values for parameters values that are too large to fit into two bytes. Parameters that get their values from this section instead store an offset relative to the beginning of the parameter region to the start of the value.

====== Signatures Table ======
This section is an array of u32 string offsets for each function signature.

====== String Pool ======
The string pool is an array of null-terminated strings encoded with UTF-8. All string offsets in this section are relative to the beginning of the string pool.

==== AINB Modules ====
This section contains an array of all AINB modules linked to the current AINB file. The first four bytes specify the entry count.
{| class="wikitable"
|+AINB Module Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|File Path Offset
|-
|0x04
|0x04
|u32
|File Category Offset
|-
|0x08
|0x04
|u32
|AINB File Count
|}

==== External Action Array ====
This section appears to interact with XLink. The first four bytes specify the entry count.
{| class="wikitable"
|+Entry String Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Node Index
|-
|0x04
|0x04
|u32
|String 1 Offset (always メインステート ("Main State"))
|-
|0x08
|0x04
|u32
|State Name Offset
|}

==== File Hashes ====
This section contains two 32-bit file hashes. The first hash is a hash for the file itself and the second hash appears to be a hash for that file's parent file. The purpose of these hashes is unclear.

==== Child Replacement Table ====
This section is used to remove or replace specific nodes or attachments at runtime. This is used to toggle of debug nodes/attachments for release builds. The section begins with an eight-byte section header.
{| class="wikitable"
|+Child Replacement Section Header
!Offset
!Size
!Type
!Description
|-
|0x00
|0x01
|u8
|Initialization Guard (Is Initialized)
|-
|0x01
|0x01
|u8
|
|-
|0x02
|0x02
|u16
|Replacement Count
|-
|0x04
|0x02
|s16
|Override Node Count
|-
|0x06
|0x02
|s16
|Override Attachment Parameter Count
|}
{| class="wikitable"
|+Child Replacement Table Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x01
|u8
|Replacement Type Enum (0 = remove child node, 1 = replace child node, 2 = remove attachment)
|-
|0x01
|0x01
|u8
|
|-
|0x02
|0x02
|u16
|Node Index
|-
|0x04
|0x02
|u16
|Child Node Index/Attachment Index
|-
|0x06
|0x02
|u16
|New Node Index (for child node replacements)
|}

==== 0x6C Section ====
This section is unused in ''Tears of the Kingdom''.

==== Enum Resolve Array ====
This section is used to resolve enum values at runtime. This section is unused in ''Tears of the Kingdom'' as all enum values are statically present in the file. However, in ''Splatoon 3'', this section is used extensively as all enum values are stored in the main executable. The first four bytes of this section specifies the number of entries in the section.
{| class="wikitable"
|+Enum Resolve Array Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Enum Value Offset
|-
|0x04
|0x04
|u32
|Enum Class Name Offset
|-
|0x08
|0x04
|u32
|Enum Value Name Offset
|}

==== String Pool ====
The string pool is an array of null-terminated strings encoded with UTF-8. All string offsets in the file are relative to the first byte of this section. Note that this section also contains some unreferenced strings which are the enums for certain parameters.
[[Category:File formats]]

Common nn::gfx

2025-02-08T23:31:58Z

Watertoon: Correction to GpuAccessFlags

Structures and enums from nn::gfx appearing across nn::gfx file formats and nn::g3d file formats. Notably the nn::gfx formats [[Bnsh]] and [[Bntx]], as well as nn::g3d [[Bfres]].

=== nn::gfx::MemoryPoolFlags ===
Flags denoting how a memory pool can be accessed.
{| class="wikitable"
!Name (Unofficial)
!Value
!Description
|-
|CpuNoAccess
|0x1 (1 << 0)
|Memory is unable to be mapped to CPU
|-
|CpuUncached
|0x2 (1 << 1)
|Memory is coherent on CPU
|-
|CpuCached
|0x4 (1 << 2)
|Memory is cached on CPU
|-
|GpuNoAccess
|0x8 (1 << 3)
|Memory is unable to be read by the GPU
|-
|GpuUncached
|0x10 (1 << 4)
|Memory is coherent on GPU
|-
|GpuCached
|0x20 (1 << 5)
|Memory is cached on GPU
|-
|ShaderCode
|0x40 (1 << 6)
|Memory is shader code for the GPU
|-
|Compressible
|0x80 (1 << 7)
|???
|-
|Physical
|0x100 (1 << 8)
|???
|-
|Virtual
|0x200 (1 << 9)
|???
|}

=== nn::gfx::MemoryPoolInfo ===
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32 (nn::gfx::MemoryPoolFlags)
|MemoryPool flags
|-
|0x4
|0x4
|u32
|Memory size
|-
|0x8
|0x8
|void *
|Memory pointer (must be 0x1000 aka page aligned)
|}

=== nn::gfx::GpuAccessFlags ===
Flags denoting how a buffer or texture will be accessed.
{| class="wikitable"
!Name (Unofficial)
!Value
!Description
|-
|VertexBuffer
|0x4 (1 << 2)
|Vertex buffer
|-
|IndexBuffer
|0x8 (1 << 3)
|Index buffer
|-
|UniformBuffer
|0x10 (1 << 4)
|Uniform buffer
|-
|Texture
|0x20 (1 << 5)
|Texture
|-
|StorageBuffer
|0x40 (1 << 6)
|Storage buffer
|-
|RenderTargetColor
|0x80 (1 << 7)
|For render target colors
|-
|RenderTargetDepth
|0x100 (1 << 8)
|For render target depths
|-
|IndirectDraw
|0x200 (1 << 9)
|For indirect draw commands
|-
|DisplayTexture
|0x400 (1 << 10)
|For present
|-
|Counter
|0x800 (1 << 11)
|???
|}

=== nn::gfx::BufferInfo ===
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Buffer size
|-
|0x4
|0x4
|u32 (nn::gfx::GpuAccessFlags)
|GPU access flags
|-
|0x8
|0x4
|u32
|Reserved
|-
|0xc
|0x4
|u32
|Reserved
|}

=== nn::gfx:::ImageStorageDimension ===
{| class="wikitable"
!Name (Unofficial)
!Value
!Description
|-
|Type1D
|0x1
|
|-
|Type2D
|0x2
|
|-
|Type3D
|0x3
|
|}

=== nn::gfx::TileMode (Unofficial) ===
{| class="wikitable"
!Name (Unofficial)
!Value
!Description
|-
|Optimal
|0x0
|
|-
|Linear
|0x1
|
|}

=== nn::gfx::ChannelFormat ===
{| class="wikitable"
!Name (Unofficial)
!Value
!Description
|-
|None
|0x1
|
|-
|R8
|0x2
|
|-
|R4G4B4A4
|0x3
|
|-
|R5G5B5A1
|0x5
|
|-
|A1B5G5R5
|0x6
|
|-
|R5G6B5
|0x7
|
|-
|B5G6R5
|0x8
|
|-
|R8G8
|0x9
|
|-
|R16
|0xa
|
|-
|R8G8B8A8
|0xb
|
|-
|B8G8R8A8
|0xc
|
|-
|R9G9B9E5F
|0xd
|
|-
|R10G10B10A2
|0xe
|
|-
|R11G11B10F
|0xf
|
|-
|R16G16
|0x12
|
|-
|D24S8
|0x13
|
|-
|R32
|0x14
|
|-
|R16G16B16A16
|0x15
|
|-
|D32FS8
|0x16
|
|-
|R32G32
|0x17
|
|-
|R32G32B32
|0x18
|
|-
|R32G32B32A32
|0x19
|
|-
|BC1
|0x1a
|
|-
|BC2
|0x1b
|
|-
|BC3
|0x1c
|
|-
|BC4
|0x1d
|
|-
|BC5
|0x1e
|
|-
|BC6H
|0x1f
|
|-
|BC7U
|0x20
|
|-
|ASTC_4x4
|0x2d
|
|-
|ASTC_5x4
|0x2e
|
|-
|ASTC_5x5
|0x2f
|
|-
|ASTC_6x5
|0x30
|
|-
|ASTC_6x6
|0x31
|
|-
|ASTC_8x5
|0x32
|
|-
|ASTC_8x6
|0x33
|
|-
|ASTC_8x8
|0x34
|
|-
|ASTC_10x5
|0x35
|
|-
|ASTC_10x6
|0x26
|
|-
|ASTC_10x8
|0x37
|
|-
|ASTC_10x10
|0x38
|
|-
|ASTC_12x10
|0x39
|
|-
|ASTC_12x12
|0x3a
|
|-
|B5G5R5A1
|0x3b
|
|}

=== nn::gfx::TypeFormat ===
{| class="wikitable"
!Name (Unofficial)
!Value
!Description
|-
|Unorm
|0x1
|
|-
|Snorm
|0x2
|
|-
|UInt
|0x3
|
|-
|SInt
|0x4
|
|-
|Float
|0x5
|
|-
|SRGB
|0x6
|
|-
|Depth
|0x7
|
|-
|UScaled
|0x8
|
|-
|SScaled
|0x9
|
|-
|UFloat
|0xa
|
|}

=== nn::gfx::ImageFormat ===
Image formats are formed by a ChannelFormat and a TypeFormat. ImageFormat = (ChannelFormat << 8) | TypeFormat
{| class="wikitable"
!Name (Unofficial)
!Value
!Description
|-
|R8_Unorm
|
|
|-
|R8_Snorm
|
|
|-
|R8_UInt
|
|
|-
|R8_SInt
|
|
|-
|R4G4B4A4_Unorm
|
|
|-
|R5G5B5A1_Unorm
|
|
|-
|A1B5G5R5_Unorm
|
|
|-
|R5G6B5_Unorm
|
|
|-
|B5G6R5_Unorm
|
|
|-
|R8G8_Unorm
|
|
|-
|R8G8_Snorm
|
|
|-
|R8G8_UInt
|
|
|-
|R8G8_SInt
|
|
|-
|R16_Unorm
|
|
|-
|R16_Snorm
|
|
|-
|R16_UInt
|
|
|-
|R16_SInt
|
|
|-
|R16_Float
|
|
|-
|Z16_Depth
|
|
|-
|R8G8B8A8_Unorm
|
|
|-
|R8G8B8A8_Snorm
|
|
|-
|R8G8B8A8_UInt
|
|
|-
|R8G8B8A8_SInt
|
|
|-
|R8G8B8A8_SRGB
|
|
|-
|B8G8R8A8_Unorm
|
|
|-
|B8G8R8A8_SRGB
|
|
|-
|R9G9B9E5F_SharedFloat
|
|
|-
|R10G10B10A2_Unorm
|
|
|-
|R10G10B10A2_UInt
|
|
|-
|R11G11B10F_Float
|
|
|-
|R16G16_Unorm
|
|
|-
|R16G16_Snorm
|
|
|-
|R16G16_UInt
|
|
|-
|R16G16_SInt
|
|
|-
|R16G16_Float
|
|
|-
|D24S8_Depth
|
|
|-
|R32_UInt
|
|
|-
|R32_SInt
|
|
|-
|R32_Float
|
|
|-
|D32F_Depth
|
|
|-
|R16G16B16A16_Unorm
|
|
|-
|R16G16B16A16_Snorm
|
|
|-
|R16G16B16A16_UInt
|
|
|-
|R16G16B16A16_SInt
|
|
|-
|R16G16B16A16_Float
|
|
|-
|D32FS8_Depth
|
|
|-
|R32G32_UInt
|
|
|-
|R32G32_SInt
|
|
|-
|R32G32_Float
|
|
|-
|R32G32B32_UInt
|
|
|-
|R32G32B32_SInt
|
|
|-
|R32G32B32_Float
|
|
|-
|R32G32B32A32_UInt
|
|
|-
|R32G32B32A32_SInt
|
|
|-
|R32G32B32A32_Float
|
|
|-
|BC1_Unorm
|
|
|-
|BC1_SRGB
|
|
|-
|BC2_Unorm
|
|
|-
|BC2_SRGB
|
|
|-
|BC3_Unorm
|
|
|-
|BC3_SRGB
|
|
|-
|BC4_Unorm
|
|
|-
|BC4_Snorm
|
|
|-
|BC5_Unorm
|
|
|-
|BC5_Snorm
|
|
|-
|BC6H_SF16
|
|
|-
|BC6H_UF16
|
|
|-
|BC7U_Unorm
|
|
|-
|BC7U_SRGB
|
|
|-
|ASTC_4X4_Unorm
|
|
|-
|ASTC_4X4_SRGB
|
|
|-
|ASTC_5X4_Unorm
|
|
|-
|ASTC_5X4_SRGB
|
|
|-
|ASTC_5X5_Unorm
|
|
|-
|ASTC_5X5_SRGB
|
|
|-
|ASTC_6X5_Unorm
|
|
|-
|ASTC_6X5_SRGB
|
|
|-
|ASTC_6X6_Unorm
|
|
|-
|ASTC_6X6_SRGB
|
|
|-
|ASTC_8X5_Unorm
|
|
|-
|ASTC_8X5_SRGB
|
|
|-
|ASTC_8X6_Unorm
|
|
|-
|ASTC_8X6_SRGB
|
|
|-
|ASTC_8X8_Unorm
|
|
|-
|ASTC_8X8_SRGB
|
|
|-
|ASTC_10X5_Unorm
|
|
|-
|ASTC_10X5_SRGB
|
|
|-
|ASTC_10X6_Unorm
|
|
|-
|ASTC_10X6_SRGB
|
|
|-
|ASTC_10X8_Unorm
|
|
|-
|ASTC_10X8_SRGB
|
|
|-
|ASTC_10X10_Unorm
|
|
|-
|ASTC_10X10_SRGB
|
|
|-
|ASTC_12X10_Unorm
|
|
|-
|ASTC_12X10_SRGB
|
|
|-
|ASTC_12X12_Unorm
|
|
|-
|ASTC_12X12_SRGB
|
|
|-
|B5G5R5A1_Unorm
|
|
|}

=== nn::gfx::TextureInfo ===
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0:0
|1 bit
|u8
|Is Packaged Texture
|-
|0x0:1
|1 bit
|u8
|Is Sparse Binding
|-
|0x0:2
|1 bit
|u8
|Is Sparse
|-
|0x0:3
|1 bit
|u8
|Is ResTexture
|-
|0x0:4
|4 bit
|u8
|Reserved
|-
|0x1
|0x1
|u8
|Storage dimension (nn::gfx::ImageStorageDimension)
|-
|0x2
|0x2
|u16
|Tile mode (nn::gfx::TileMode)
|-
|0x4
|0x2
|u16
|Swizzle (???)
|-
|0x6
|0x2
|u16
|Mip levels
|-
|0x8
|0x2
|u16
|Sample count
|-
|0xa
|0x2
|u16
|Reserved
|-
|0xc
|0x4
|u32
|Image format (nn::gfx::ImageFormat)
|-
|0x10
|0x4
|u32
|Gpu access flags (nn::gfx::GpuAccessFlags)
|-
|0x14
|0x4
|u32
|Width
|-
|0x18
|0x4
|u32
|Height
|-
|0x1c
|0x4
|u32
|Depth
|-
|0x20
|0x4
|u32
|Array layers
|-
|0x24
|0x4
|u32
|Packaged texture layout (???)
|}

=== nn::gfx::TextureAddressMode ===
{| class="wikitable"
!Name (Unofficial)
!Value
!Description
|-
|Repeat
|0x0
|
|-
|MirrorRepeat
|0x1
|
|-
|ClampToEdge
|0x2
|
|-
|ClampToBorder
|0x3
|
|-
|MirrorClampToBorder
|0x4
|
|}

=== nn::gfx::ComparisonFunction ===
{| class="wikitable"
!Name (Unofficial)
!Value
!Description
|-
|Never
|0x0
|
|-
|LessThan
|0x1
|
|-
|Equal
|0x2
|
|-
|LessThanEqual
|0x3
|
|-
|GreateThan
|0x4
|
|-
|NotEqual
|0x5
|
|-
|GreaterThanEqual
|0x6
|
|-
|Always
|0x7
|
|}

=== nn::gfx::BorderColor (Unofficial) ===
{| class="wikitable"
!Name (Unofficial)
!Value
!Description
|-
|White
|0x0
|
|-
|TransparentBlack
|0x1
|
|-
|Black
|0x2
|
|}

=== nn::gfx::MipMapFilter (Unofficial) ===
{| class="wikitable"
!Name (Unofficial)
!Value
!Description
|-
|None
|0x0
|
|-
|Nearest
|0x1
|
|-
|Linear
|0x2
|
|}

=== nn::gfx::MagFilter (Unofficial) ===
{| class="wikitable"
!Name (Unofficial)
!Value
!Description
|-
|Invalid
|0x0
|
|-
|Nearest
|0x1
|
|-
|Linear
|0x2
|
|}

=== nn::gfx::MinFilter (Unofficial) ===
{| class="wikitable"
!Name (Unofficial)
!Value
!Description
|-
|Invalid
|0x0
|
|-
|Nearest
|0x1
|
|-
|Linear
|0x2
|
|}

=== nn::gfx::ReductionFilter (Unofficial) ===
{| class="wikitable"
!Name (Unofficial)
!Value
!Description
|-
|Average
|0x0
|
|-
|Min
|0x1
|
|-
|Max
|0x2
|
|}

=== nn::gfx::SamplerInfo ===
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x1
|u8
|Wrap Mode U (nn::gfx::TextureAddressMode)
|-
|0x1
|0x1
|u8
|Wrap Mode V (nn::gfx::TextureAddressMode)
|-
|0x2
|0x1
|u8
|Wrap Mode W (nn::gfx::TextureAddressMode)
|-
|0x3
|0x1
|u8
|CompareOp (nn::gfx::ComparisonFunction)
|-
|0x4
|0x1
|u8
|Border color (nn::gfx::BorderColor)
|-
|0x5
|0x1
|u8
|Max anisotropy
|-
|0x6:0
|2 bit
|u16
|MipMap filter (nn::gfx::MipMapFilter)
|-
|0x6:2
|2 bit
|u16
|Mag filter (nn::gfx::MagFilter)
|-
|0x6:4
|2 bit
|u16
|Min filter (nn::gfx::MinFilter)
|-
|0x6:6
|1 bit
|u16
|Enable anisotropy
|-
|0x6:7
|1 bit
|u16
|Enable CompareOp
|-
|0x6:8
|2 bit
|u16
|Reduction filter (nn::gfx::ReductionFilter)
|-
|0x6:a
|6 bit
|u16
|Reserved
|-
|0x8
|0x4
|Float
|Lod clamp min
|-
|0xc
|0x4
|Float
|Lod clamp max
|-
|0x10
|0x4
|Float
|Lod bias
|-
|0x14
|0x4
|u32
|Reserved
|-
|0x18
|0x4
|u32
|Reserved
|-
|0x1c
|0x4
|u32
|Reserved
|}

=== Gfx Embed File ===
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|void *
|Offset to file
|-
|0x8
|0x4
|u32
|Size of file
|-
|0xc
|0x4
|u32
|???
|}

=== Gfx User Data Type ===
{| class="wikitable"
!Name (Unofficial)
!Value
!Description
|-
|S32
|0x0
|
|-
|Float
|0x1
|
|-
|String
|0x2
|
|-
|Byte
|0x3
|Used for arbitrary binary data (other files)
|}

=== Gfx User Data ===
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|const char *
|User data name
|-
|0x8
|0x8
|void *
|User data (can be nullptr)
|-
|0x10
|0x4
|s32
|User data entries
|-
|0x14
|0x1
|u8
|User Data Type
|-
|0x15
|0x2b
|u8[0x2b]
|Reserved
|}
[[Category:File formats]]

Bfres

2025-02-08T20:40:33Z

Watertoon: Add some information on models, shapes, and materials.

A bfres file collects a number of 3d-graphics related resources. This article details bfres version 10.0.0 and 10.2.0.

=== Header (nn::g3d2::ResFile) ===
A bfres file header collects a number of optional resources that can be iterated through by array or looked up by name through dictionary. Resources include 3d model data, model animation data, scene animation data, and embedded files. A Bfres can contain a "GPU region", a block of memory meant to be made GPU visible, or reference an external GPU region.
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x20
|[[Common nn::util#nn::util::BinaryFileHeader|nn::util::BinaryFileHeader]]
|Base header with magic of "FRES ".
|-
|0x20
|0x8
|const char * (NW)
|File name
|-
|0x28
|0x8
|ResModel *
|Model array
|-
|0x30
|0x8
|[[Common nn::util#nn::util::ResDic|nn::util::ResDic]] *
|Model dictionary
|-
|0x38
|0x8
|void*[4]
|
|-
|0x58
|0x8
|ResSkeletalAnim *
|Skeletal animation array
|-
|0x60
|0x8
|[[Common nn::util#nn::util::ResDic|nn::util::ResDic]] *
|Skeletal animation dictionary
|-
|0x68
|0x8
|ResMaterialAnim *
|Material animation array
|-
|0x70
|0x8
|[[Common nn::util#nn::util::ResDic|nn::util::ResDic]] *
|Material animation dictionary
|-
|0x78
|0x8
|ResBoneVisibilityAnim *
|Bone visibility animation array
|-
|0x80
|0x8
|[[Common nn::util#nn::util::ResDic|nn::util::ResDic]] *
|Bone visibility animation dictionary
|-
|0x88
|0x8
|ResShapeAnim *
|Shape animation array
|-
|0x90
|0x8
|[[Common nn::util#nn::util::ResDic|nn::util::ResDic]] *
|Shape animation dictionary
|-
|0x98
|0x8
|ResSceneAnim *
|Scene animation array
|-
|0xa0
|0x8
|[[Common nn::util#nn::util::ResDic|nn::util::ResDic]] *
|Scene animation dictionary
|-
|0xa8
|0x8
|nn::gfx::TMemoryPool *
|Runtime MemoryPool (set by g3d)
|-
|0xb0
|0x8
|[[Common nn::gfx#nn::gfx::MemoryPoolInfo|nn::gfx::MemoryPoolInfo]]
|Pre-initialized MemoryPool info pointing to GPU region
|-
|0xb8
|0x8
|[[Common nn::gfx#nn::gfx::ResEmbedFile|nn::gfx::ResEmbedFile]] *
|Embed file array
|-
|0xc0
|0x8
|[[Common nn::util#nn::util::ResDic|nn::util::ResDic]] *
|Embed file dictionary
|-
|0xc8
|0x8
|void *
|User pointer in EPD software. (possibly a UI tree in nn::ui?)
|-
|0xd0
|0x8
|const char * (NW)
|
|-
|0xd8
|0x4
|u32
|
|-
|0xdc
|0x2
|u16
|Model array count
|-
|0xde
|0x2
|u16
|
|-
|0xe0
|0x2
|u16
|
|-
|0xe2
|0x2
|u16
|Skeletal animation array count
|-
|0xe4
|0x2
|u16
|Material animation array count
|-
|0xe6
|0x2
|u16
|Bone visibility animation count
|-
|0xe8
|0x2
|u16
|Shape animation count
|-
|0xea
|0x2
|u16
|Scene animation count
|-
|0xec
|0x2
|u16
|Embed file count
|-
|0xee
|0x2
|u16
|
|}

=== Model (nn::g3d2::ResModel) ===
A model represents a collection of 3d shape data, material data, and a skeleton.
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Magic, always "FMDL"
|-
|0x4
|0x4
|u32
|
|-
|0x8
|0x8
|const char* (NW)
|Model name
|-
|0x10
|0x8
|const char* (NW)
|
|-
|0x18
|0x8
|ResSkeleton*
|Skeleton
|-
|0x20
|0x8
|ResVertex*
|Vertex array
|-
|0x28
|0x8
|ResShape*
|Shape array
|-
|0x30
|0x8
|[[Common nn::util#nn::util::ResDic|nn::util::ResDic]]*
|Shape dictionary
|-
|0x38
|0x8
|ResMaterial*
|Material array
|-
|0x40
|0x8
|[[Common nn::util#nn::util::ResDic|nn::util::ResDic]]*
|Material dictionary
|-
|0x48
|0x8
|ResShaderReflection*
|Shader reflection array
|-
|0x50
|0x8
|Gfx User Data*
|User data array
|-
|0x58
|0x8
|[[Common nn::util#nn::util::ResDic|nn::util::ResDic]]*
|User data dictionary
|-
|0x60
|0x8
|void *
|Runtime user pointer
|-
|0x68
|0x2
|u16
|Vertex count
|-
|0x6a
|0x2
|u16
|Shape count
|-
|0x6c
|0x2
|u16
|Material count
|-
|0x6e
|0x2
|u16
|Shader reflection count
|-
|0x70
|0x2
|u16
|User data count
|-
|0x72
|0x6
|
|
|}

==== Vertex (nn::g3d2::ResVertex) ====
A ResVertex references a collection of vertex buffers in the GPU region. Reflection and settings are provided for the vertex buffers and attributes. Runtime object memory is provided to initialize graphics api objects for the vertex buffers.
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Magic "FVTX"
|-
|0x4
|0x4
|u32
|
|-
|0x8
|0x8
|ResVertexAttribute*
|Vertex atribute array
|-
|0x10
|0x8
|[[Common nn::util#nn::util::ResDic|nn::util::ResDic]]*
|Vertex attribute dictionary
|-
|0x18
|0x8
|void *
|Runtime memory pool pointer
|-
|0x20
|0x8
|void *
|Runtime vertex buffer array (0x48 bytes of zeroed memory per vertex buffer)
|-
|0x28
|0x8
|void **
|Runtime user vertex buffer array
|-
|0x30
|0x8
|nn::gfx::BufferInfo*
|Vertex buffer info array
|-
|0x38
|0x8
|ResVertexBufferStride*
|Vertex buffer stride array
|-
|0x40
|0x8
|void *
|Runtime user pointer
|-
|0x48
|0x4
|u32
|Base offset of vertex data in GPU region, relative to start of GPU region
|-
|0x4c
|0x1
|u8
|Vertex attribute count
|-
|0x4d
|0x1
|u8
|Vertex buffer count
|-
|0x4e
|0x2
|u16
|Index of this section in parent ResModel
|-
|0x50
|0x4
|u32
|Vertex count
|-
|0x54
|0x2
|u16
|
|-
|0x56
|0x2
|u16
|Alignment of vertex buffer data in GPU region
|}

===== ResVertexAttribute =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|const char* (NW)
|Attribute name
|-
|0x8
|0x4
|u32, nn::gfx::AttributeFormat
|Attribute format
|-
|0xc
|0x2
|u16
|Buffer offset
|-
|0xe
|0x1
|u8
|Buffer index
|-
|0xf
|0x1
|u8
|Indicates whether this is a dynamic vertex attribute for shape blending
|}

===== ResVertexBufferStride =====
Unused bytes might indicate nn::gfx::VertexBufferInfo.
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Stride
|-
|0x4
|0x4
|u32
|Divisor
|-
|0x8
|0x4
|u32
|
|-
|0xc
|0x4
|u32
|
|}

==== Shape (nn::g3d2::ResShape) ====
A shape represents 3d mesh data. Either via a set of level-of-detail meshes into the vertex buffers of a ResVertex, or alternatively in v10.2.0 onwards, a set of meshlet buffers.
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Magic "FSHP"
|-
|0x4
|0x4
|u32
|Flags
|-
|0x8
|0x8
|const char* (NW)
|Shape name
|-
|0x10
|0x8
|ResVertex*
|Referenced vertex
|-
|0x18
|0x8
|ResMesh* or ResMeshlet*
|Level-of-detail mesh array, or if flags bit 4 is set, a ResMeshlet
|-
|0x20
|0x8
|u16*
|Skinning bone index array
|-
|0x28
|0x8
|ResKeyShape*
|Key shape array
|-
|0x30
|0x8
|[[Common nn::util#nn::util::ResDic|nn::util::ResDic]]*
|Key shape dictionary
|-
|0x38
|0x8
|ResBounding*
|Bounding box array
|-
|0x40
|0x8
|ResBoundingSphere*
|Bounding sphere array
|-
|0x48
|0x8
|void *
|Runtime user pointer
|-
|0x50
|0x2
|u16
|Index of this section in parent ResModel
|-
|0x52
|0x2
|u16
|Material index
|-
|0x54
|0x2
|u16
|Base bone index
|-
|0x56
|0x2
|u16
|Vertex index
|-
|0x58
|0x2
|u16
|Skin bone index count
|-
|0x5a
|0x1
|u8
|Vertex skin weight count
|-
|0x5b
|0x1
|u8
|Mesh count
|-
|0x5c
|0x1
|u8
|Key shape count
|-
|0x5d
|0x1
|u8
|Target attribute count
|-
|0x5e
|0x2
|u16
|
|}

===== ResMesh =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|ResSubMeshRange*
|Array of sub mesh ranges
|-
|0x8
|0x8
|void *
|Runtime memory pool pointer
|-
|0x10
|0x8
|void *
|Runtime index buffer memory (0x48 bytes of zeroed memory)
|-
|0x18
|0x8
|nn::gfx::BufferInfo*
|Index buffer info
|-
|0x20
|0x4
|u32
|Offset of index buffer in GPU region relative to start of GPU region
|-
|0x24
|0x4
|u32, nn::gfx::PrimitiveTopology
|Primitive topology to use for drawing commands
|-
|0x28
|0x4
|u32, nn::gfx::IndexFormat
|Index format to use in drawing commands
|-
|0x2c
|0x4
|u32
|Index count
|-
|0x30
|0x4
|u32
|Base vertex
|-
|0x34
|0x2
|u16
|Sub mesh count
|-
|0x36
|0x2
|u16
|
|}

====== ResSubMeshRange ======
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Offset of sub mesh relative to start of index buffer
|-
|0x4
|0x4
|u32
|Index count of sub mesh
|}

===== ResKeyShape =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x12
|u8[18]
|Relative key shape attribute location array
|-
|0x12
|0x2
|u8[2]
|
|}

===== ResBounding =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0xc
|Float3
|Position
|-
|0xc
|0xc
|Float3
|Extent
|}

===== ResBoundingSphere =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0xc
|Float3
|Position
|-
|0xc
|0x4
|float
|Radius
|}

===== ResMeshlet =====
Currently only observed unused in Nintendo Switch Online: Playtest Program.
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|...
|
|-
|0x8
|0x8
|void *
|Runtime meshlet buffer array (0x48 bytes of zeroed memory per meshlet buffer)
|-
|0x10
|0x8
|nn::gfx::BufferInfo*
|Meshlet buffer info array
|-
|0x18
|0x8
|s64 *
|Meshlet buffer memory offset array, each entry relative to start of GPU region
|-
|0x20
|0x24
|...
|
|-
|0x2c
|0x1
|u8
|Meshlet buffer count
|-
|0x2d
|0x3
|...
|
|}

==== Shader Reflection ====
A ResShaderReflection provides reflection for resolving material parameter data for a shader inside a bfsha shader archive.
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|const char* (NW)
|Shader archive name
|-
|0x8
|0x8
|const char* (NW)
|Shader name
|-
|0x10
|0x8
|ResRenderInfo*
|Render info array
|-
|0x18
|0x8
|[[Common nn::util#nn::util::ResDic|nn::util::ResDic]]*
|Render info dictionary
|-
|0x20
|0x8
|ResShaderParam*
|Material shader parameter array
|-
|0x28
|0x8
|[[Common nn::util#nn::util::ResDic|nn::util::ResDic]]*
|Material shader parameter dictionary
|-
|0x30
|0x8
|[[Common nn::util#nn::util::ResDic|nn::util::ResDic]]*
|Vertex attribute dictionary
|-
|0x38
|0x8
|[[Common nn::util#nn::util::ResDic|nn::util::ResDic]]*
|Sampler dictionary
|-
|0x40
|0x8
|[[Common nn::util#nn::util::ResDic|nn::util::ResDic]]*
|Static shader option dictionary
|-
|0x48
|0x2
|u16
|Render info count
|-
|0x4a
|0x2
|u16
|Shader parameter count
|-
|0x4c
|0x2
|u16
|Shader parameter data size
|-
|0x4e
|0xa
|u8[10]
|
|}

===== ResRenderInfo =====
Render info provides reflection for CPU-side rendering parameters.
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|const char* (NW)
|Render info name
|-
|0x8
|0x1
|u8
|Render info data type
|-
|0x9
|0x7
|u8[7]
|
|}

====== Render info data type ======
{| class="wikitable"
|+
!Name
!Value
!Description
|-
|Int
|0
|Value is a 32-bit integer
|-
|Float
|1
|Value is a 32-bit float
|-
|String
|2
|Value is an NW string pointer
|}

===== ResShaderParam =====
ResShaderParam's compose a user generated structure layout for a material uniform buffer. Shader parameters can be animated through material animations.
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|u32(*)(void*,const void*,ResShaderParam*, void*)
|Runtime conversion function for data types requiring runtime conversion of a CPU representation to a GPU representation
|-
|0x8
|0x8
|const char* (NW)
|Shader parameter name
|-
|0x10
|0x2
|u16
|Shader parameter offset
|-
|0x12
|0x1
|u8
|Shader parameter data type
|-
|0x13
|0x5
|u8[5]
|
|}

====== Shader parameter data type ======
{| class="wikitable"
|+
!Name
!Value
!Description
|-
|Bool
|0
|
|-
|Bool2
|1
|
|-
|Bool3
|2
|
|-
|Bool4
|3
|
|-
|Int
|4
|
|-
|Int2
|5
|
|-
|Int3
|6
|
|-
|Int4
|7
|
|-
|UInt
|8
|
|-
|UInt2
|9
|
|-
|UInt3
|10
|
|-
|UInt4
|11
|
|-
|Float
|12
|
|-
|Float2
|13
|
|-
|Float3
|14
|
|-
|Float4
|15
|
|-
|Matrix2x2
|17
|
|-
|Matrix2x3
|18
|
|-
|Matrix2x4
|19
|
|-
|Matrix3x2
|20
|
|-
|Matrix3x3
|21
|
|-
|Matrix3x4
|22
|
|-
|Matrix4x2
|23
|
|-
|Matrix4x3
|24
|
|-
|Matrix4x4
|25
|
|-
|Srt2d
|26
|
|-
|Srt3d
|27
|
|-
|SrtTexture
|28
|
|}

==== Material (nn::g3d2::ResMaterial) ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Magic "FMAT"
|-
|0x4
|0x4
|u32
|Flags (bit 0 = is visible)
|-
|0x8
|0x8
|const char* (NW)
|Material name
|-
|0x10
|0x8
|ResStaticShaderVariation*
|Static shader variation
|-
|0x18
|0x8
|void**
|Runtime texture view pointer array
|-
|0x20
|0x8
|const char** (NW)
|Texture name array
|-
|0x28
|0x8
|void*
|Runtime sampler array (0x78 bytes of zeroed memory per sampler)
|-
|0x30
|0x8
|nn::gfx::SamplerInfo*
|Sampler info array
|-
|0x38
|0x8
|[[Common nn::util#nn::util::ResDic|nn::util::ResDic]]*
|Sampler dictionary
|-
|0x40
|0x8
|void*
|Render info value array
|-
|0x48
|0x8
|u16*
|Render info value count array
|-
|0x50
|0x8
|u16*
|Render info value offset array
|-
|0x58
|0x8
|void*
|Shader parameter value array
|-
|0x60
|0x8
|s32*
|Shader parameter uniform buffer offset array
|-
|0x68
|0x8
|u64
|
|-
|0x70
|0x8
|Gfx user data*
|User data array
|-
|0x78
|0x8
|[[Common nn::util#nn::util::ResDic|nn::util::ResDic]]*
|User data dictionary
|-
|0x80
|0x8
|u32 *
|Shader parameter runtime convert bit array
|-
|0x88
|0x8
|void*
|Runtime user pointer
|-
|0x90
|0x8
|u64*
|Runtime sampler descriptor slot array
|-
|0x98
|0x8
|u64*
|Runtime texture view descriptor slot array
|-
|0xa0
|0x2
|u16
|Index of this section in parent ResModel
|-
|0xa2
|0x1
|u8
|Sampler count
|-
|0xa3
|0x1
|u8
|Texture count
|-
|0xa4
|0x2
|u16
|Is force calculate material
|-
|0xa6
|0x2
|u16
|User data count
|-
|0xa8
|0x2
|u16
|Render info value size
|-
|0xaa
|0x2
|u16
|Runtime material uniform buffer size
|-
|0xac
|0x4
|u32
|
|}

===== ResStaticShaderVariation =====
A material references a ResStaticShaderVariation which selects the material's static shader variation out of the shader referenced by a ResShaderReflection.
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|ResShaderReflection*
|Shader reflection
|-
|0x8
|0x8
|const char** (NW)
|Vertex attribute name array, of those used in this specific static shader variation
|-
|0x10
|0x8
|u8*
|Vertex attribute index array
|-
|0x18
|0x8
|const char** (NW)
|Sampler name array, of those used in this specific static shader variation
|-
|0x20
|0x8
|u8*
|Sampler index array
|-
|0x28
|0x8
|u32*
|Static shader option choice packed bool array
|-
|0x30
|0x8
|const char** (NW)
|Static shader option choice string array
|-
|0x38
|0x8
|u16*
|Static shader option index array
|-
|0x40
|0x4
|u32
|
|-
|0x44
|0x1
|u8
|Vertex attribute count
|-
|0x45
|0x1
|u8
|Sampler count
|-
|0x46
|0x2
|u16
|Static shader option bool count
|-
|0x48
|0x2
|u16
|Total static shader option count
|-
|0x4a
|0x6
|u8[6]
|
|}
[[Category:File formats]]

AINB

2025-02-08T18:46:21Z

Watertoon: Rewrite head of article to clarify information.

'''AINB''' ('''AI''' '''N'''ode '''B'''inary) is a file format implementing behavior trees for game-specific code. At time of writing it has only appeared in titles on the ModuleSystem game engine. This article is primarily aimed at the version that appears in ''Tears of the Kingdom,'' ''Super Mario Bros. Wonder, Mario vs Donkey Kong,'' and ''Nintendo Switch Online: Playtest Program'' (v0x407). An older version appears in ''Nintendo Switch Sports'' and ''Splatoon 3'' (v0x404). ModuleSystem provides 3 built-in file categories that appear in their own dedicated folders in a title's romfs, being "AI" for actor behavior, "Logic" for actor ai group behavior, and "Sequence" for scene behavior, individual games are free to create their own file categories.

=== File Structure ===
AINB is little endian. An AINB file defines a set of commands to evaluate a tree of built-in or game-specific node classes. The built-in "Element_ModuleCaller" node and supporting structures allow a "root" AINB file to call out to an external "module" AINB file, module's can call further modules, allowing AINB files to form a tree of tree's. An AINB's file extension typically designates whether it is a root <code>.root.ainb</code> or module <code>.module.ainb</code>. For AI and Sequence files, the file's entry point is one or more commands which is linked to one or two child nodes. All nodes are accessed by their index (references to precondition nodes will use their precondition node index which is local to the amount of precondition nodes in the file).

All string offsets in the file are relative to the beginning of the string pool and name hashes are 32-bit murmur3 hashes. There are six possible data types for AINB parameters: int (signed 32-bit integer), bool, float (32-bit), vector3f, and pointer. Pointer parameters are pointers to objects.

==== Section Order ====

# 0x74-Byte File Header
# Commands
# Nodes
# Local Blackboard Parameters
# Node Bodies
# Attachment Parameters
# Internal Parameters
# Input/Output Parameters
# Multi-Parameters
# Active Node Update Array
# 0x50 Section (Unused in ''TotK'')
# Precondition Nodes
# Expression Binary
# AINB Modules
# External Action Array
# File Hashes
# Child Replacement Table
# 0x6C Section
# Enum Resolve Array
# String Pool

=== Sections ===

==== File Header ====
AINB files begin with a 0x74 byte header. If the offset for a given section is empty, that section is not present in the file.
{| class="wikitable"
|+File Header
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|char[4]
|Magic - “AIB “
|-
|0x04
|0x04
|u32
|Version (0x0407 in ''TotK'', 0x0404 in ''S3'' and ''NSS'')
|-
|0x08
|0x04
|u32
|Filename Offset
|-
|0x0C
|0x04
|u32
|Command Count
|-
|0x10
|0x04
|u32
|Node Count
|-
|0x14
|0x04
|u32
|Precondition Node Count
|-
|0x18
|0x04
|u32
|Attachment Parameter Count
|-
|0x1C
|0x04
|u32
|Output Node Count
|-
|0x20
|0x04
|u32
|Local Blackboard Parameters Offset
|-
|0x24
|0x04
|u32
|String Pool Offset
|-
|0x28
|0x04
|u32
|Enum Resolve Array Offset
|-
|0x2C
|0x04
|u32
|Internal Parameters Offset
|-
|0x30
|0x04
|u32
|Active Node Update Array Offset
|-
|0x34
|0x04
|u32
|Input/Output Parameters Offset
|-
|0x38
|0x04
|u32
|Multi-Parameters Array Offset
|-
|0x3C
|0x04
|u32
|Attachment Parameters Offset
|-
|0x40
|0x04
|u32
|Attachment Parameters Index Array Offset
|-
|0x44
|0x04
|u32
|Expression Binary Section Offset
|-
|0x48
|0x04
|u32
|Child Replacement Table Offset
|-
|0x4C
|0x04
|u32
|Precondition Node Array Offset
|-
|0x50
|0x04
|u32
|Unknown (unused in ''TotK'', always the same as the Active Node Update Array Offset)
|-
|0x54
|0x04
|u32
|Unknown (always 0)
|-
|0x58
|0x04
|u32
|Unknown (always 0, used in ''Splatoon 3''/''Nintendo Switch Sports'')
|-
|0x5C
|0x04
|u32
|AINB Modules Array Offset
|-
|0x60
|0x04
|u32
|File Category Name Offset
|-
|0x64
|0x04
|u32
|File Category (0 = AI, 1 = Logic, 2 = Sequence) (''Splatoon 3'' game specific, 3 = UniqueSequenceSPL)
|-
|0x68
|0x04
|u32
|External Action Array Offset
|-
|0x6C
|0x04
|u32
|Unknown (Unused in ''TotK'')
|-
|0x70
|0x04
|u32
|File Identification Hashes Offset (Purpose Unknown)
|}

==== Command Array ====
The command array immediately follows the file header and is an array of all commands in the file.
{| class="wikitable"
|+Command Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Command Name Offset
|-
| rowspan="5" |0x04
| rowspan="5" |0x10
|u32
| rowspan="5" |GUID
|-
|u16
|-
|u16
|-
|u16
|-
|u8[6]
|-
|0x14
|0x02
|u16
|Left Node Index
|-
|0x16
|0x02
|u16
|Right Node Index (one greater than the corresponding node index)
|}
Command GUIDs are only used for debug messages. Right Node Index will be -1 if the command only has one child node.

==== Node Array ====
The node array immediately follows the command array and is an array of all nodes in the file.
{| class="wikitable"
|+Node Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x02
|u16
|Node Type Enum (see below)
|-
|0x02
|0x02
|u16
|Node Index
|-
|0x04
|0x02
|u16
|Attachment Parameters Count
|-
|0x06
|0x01
|bitfield
|Node Flags
|-
|0x07
|0x01
|u8
|
|-
|0x08
|0x04
|u32
|Node Type Name Offset (for UserDefined nodes)
|-
|0x0C
|0x04
|u32
|Name Hash (version 0x407 only)
|-
|0x10
|0x04
|u32
|
|-
|0x14
|0x04
|u32
|Node Body Offset (relative to the start of the file)
|-
|0x18
|0x02
|u16
|EXB Function Count
|-
|0x1A
|0x02
|u16
|EXB Input/Output Field Size
|-
|0x1C
|0x02
|u16
|Multi-Param Count
|-
|0x1E
|0x02
|u16
|
|-
|0x20
|0x04
|u32
|Base Attachment Parameter Index
|-
|0x24
|0x02
|u16
|Base Precondition Node
|-
|0x26
|0x02
|u16
|Precondition Node Count
|-
|0x28
|0x02
|u16
|0x58 Section Entry Offset (relative to the start of the file)
|-
|0x2A
|0x02
|u16
|
|-
| rowspan="5" |0x2C
| rowspan="5" |0x10
|u32
| rowspan="5" |GUID
|-
|u16
|-
|u16
|-
|u16
|-
|u8[6]
|}
Just like with commands, node GUIDs are only used for debug messages. The 0x58 section entry offset will be empty if unused.
{| class="wikitable"
|+Node Types
!Value (Hex)
!Value (Dec)
!Node Type
|-
|0x00
|0
|UserDefined
|-
|0x01
|1
|Element_S32Selector
|-
|0x02
|2
|Element_Sequential
|-
|0x03
|3
|Element_Simultaneous
|-
|0x04
|4
|Element_F32Selector
|-
|0x05
|5
|Element_StringSelector
|-
|0x06
|6
|Element_RandomSelector
|-
|0x07
|7
|Element_BoolSelector
|-
|0x08
|8
|Element_Fork
|-
|0x09
|9
|Element_Join
|-
|0x0A
|10
|Element_Alert
|-
|0x14
|20
|Element_Expression
|-
|0x64
|100
|Element_ModuleIF_Input_S32
|-
|0x65
|101
|Element_ModuleIF_Input_F32
|-
|0x66
|102
|Element_ModuleIF_Input_Vec3f
|-
|0x67
|103
|Element_ModuleIF_Input_String
|-
|0x68
|104
|Element_ModuleIF_Input_Bool
|-
|0x69
|105
|Element_ModuleIF_Input_Ptr
|-
|0xC8
|200
|Element_ModuleIF_Output_S32
|-
|0xC9
|201
|Element_ModuleIF_Output_F32
|-
|0xCA
|202
|Element_ModuleIF_Output_Vec3f
|-
|0xCB
|203
|Element_ModuleIF_Output_String
|-
|0xCC
|204
|Element_ModuleIF_Output_Bool
|-
|0xCD
|205
|Element_ModuleIF_Output_Ptr
|-
|0x012C
|300
|Element_ModuleIF_Child
|-
|0x0190
|400
|Element_StateEnd
|-
|0x01F4
|500
|Element_SplitTiming
|}
Node type names are official. For UserDefined nodes, node definitions can be found in a node definition files. This file is located at <code>NodeDefinition/Node.Product.[ver].aidefn.byml.zs</code> in the corresponding file category folder.
{| class="wikitable"
|+Node Type Descriptions
!Type
!Description
|-
|UserDefined
|Custom node type, definition in NodeDefinition
|-
|Element_S32Selector
|Conditionally links to a node depending on the value of a signed int
|-
|Element_Sequential
|Links to nodes sequentially in the order listed
|-
|Element_Simultaneous
|Links simultaneously to multiple nodes
|-
|Element_F32Selector
|Conditionally links to a node depending on the value of 32-bit float
|-
|Element_StringSelector
|Conditionally links to a node depending on the value of a string
|-
|Element_RandomSelector
|Links to a node randomly
|-
|Element_BoolSelector
|Conditionally links to a node depending on the value of a bool
|-
|Element_Fork
|See Active Node Update Array
|-
|Element_Join
|See Active Node Update Array
|-
|Element_Alert
|Displays a debug message
|-
|Element_Expression
|Passes values to and from EXB commands
|-
|Element_ModuleIF_Input_S32
|Receives a signed int input from the calling AINB file
|-
|Element_ModuleIF_Input_F32
|Receives a 32-bit float input from the calling AINB file
|-
|Element_ModuleIF_Input_Vec3f
|Receives a vector3f input from the calling AINB file
|-
|Element_ModuleIF_Input_String
|Receives a string input from the calling AINB file
|-
|Element_ModuleIF_Input_Bool
|Receives a bool input from the calling AINB file
|-
|Element_ModuleIF_Input_Ptr
|Receives an object pointer input from the calling AINB file
|-
|Element_ModuleIF_Output_S32
|Returns a signed int output from the module to the calling AINB file
|-
|Element_ModuleIF_Output_F32
|Returns a 32-bit float output from the module to the calling AINB file
|-
|Element_ModuleIF_Output_Vec3f
|Returns a vector3f output from the module to the calling AINB file
|-
|Element_ModuleIF_Output_String
|Returns a string output from the module to the calling AINB file
|-
|Element_ModuleIF_Output_Bool
|Returns a bool output from the module to the calling AINB file
|-
|Element_ModuleIF_Output_Ptr
|Returns an object pointer output from the module to the calling AINB file
|-
|Element_ModuleIF_Child
|Returns the node connection name from the module to the calling AINB file
|-
|Element_StateEnd
|Termination node, specifies what resident node to return to in the calling AINB file
|-
|Element_SplitTiming
|Changes when child nodes are run (Enter - first time visiting a node, Update - every frame, Leave - ran upon leaving the node)
|}
{| class="wikitable"
|+Node Flags
!Bits
!Description
|-
|1
|Is Precondition Node
|-
|1
|Is Module
|-
|1
|Is Resident Node
|-
|1
|MultiParam Type 2
|-
|4
|
|}

==== Local Blackboard Parameters ====
This section contains an array of the Blackboard parameters used by file. These parameters may be sourced from external Blackboards or parameter files. The section begins with a 0x30 byte section header followed by the array of parameters, an array of default values of said parameters, and an array of file references if applicable. The order of parameters is in the order of string, int, float, bool, vector3f, and pointer. The section header contains six entries, one for each type.
{| class="wikitable"
|+Section Header Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x02
|u16
|Number of Entries of the Corresponding Data Type
|-
|0x02
|0x02
|u16
|Parameter Index of the First Entry of the Corresponding Data Type
|-
|0x04
|0x02
|u16
|Relative Offset of the First Entry of the Corresponding Data Type
|-
|0x06
|0x02
|u16
|
|}
{| class="wikitable"
|+Local Blackboard Parameter Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|bitfield
|Name Offset and Flags
|-
|0x04
|0x04
|u32
|String Offset (Notes)
|}
{| class="wikitable"
|+Name Offset Flags
!Bits
!Description
|-
|22
|Name Offset
|-
|1
|
|-
|1
|Does Not Have File Reference
|-
|7
|File Reference Index
|-
|1
|Is File Reference Valid
|}
The default value entries vary based on the parameter's data type. For int, float, and bool parameters, the entry is a four byte immediate value. String entries are a four byte string value offset. Vector3f entries are 12 bytes. Note that pointer parameters do not have default value entries and do not have default values.
{| class="wikitable"
|+File Reference Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|File Path Offset
|-
|0x04
|0x04
|u32
|File Path Hash
|-
|0x08
|0x04
|u32
|Filename Hash (no extension)
|-
|0x0C
|0x04
|u32
|File Extension Hash (no .)
|}

==== Node Bodies ====
Each node body is composed of two parts: a 0x90 byte parameter section and a 0x14 child node section header followed by said section if applicable. The child node section contains information about the child node and specific connection types. The following parameter indices are indices into the parameter array for that specific type and data type.
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Int Internal Parameter Base Index
|-
|0x04
|0x04
|u32
|Int Internal Parameter Count
|-
|0x08
|0x04
|u32
|Bool Internal Parameter Base Index
|-
|0x0C
|0x04
|u32
|Bool Internal Parameter Count
|-
|0x10
|0x04
|u32
|Float Internal Parameter Base Index
|-
|0x14
|0x04
|u32
|Float Internal Parameter Count
|-
|0x18
|0x04
|u32
|String Internal Parameter Base Index
|-
|0x1C
|0x04
|u32
|String Internal Parameter Count
|-
|0x20
|0x04
|u32
|Vector3f Internal Parameter Base Index
|-
|0x24
|0x04
|u32
|Vector3f Internal Parameter Count
|-
|0x28
|0x04
|u32
|Pointer Internal Parameter Base Index
|-
|0x2C
|0x04
|u32
|Pointer Internal Parameter Count
|-
|0x30
|0x04
|u32
|Int Input Parameter Base Index
|-
|0x34
|0x04
|u32
|Int Input Parameter Count
|-
|0x38
|0x04
|u32
|Int Output Parameter Base Index
|-
|0x3C
|0x04
|u32
|Int Output Parameter Count
|-
|0x40
|0x04
|u32
|Bool Input Parameter Base Index
|-
|0x44
|0x04
|u32
|Bool Input Parameter Count
|-
|0x48
|0x04
|u32
|Bool Output Parameter Base Index
|-
|0x4C
|0x04
|u32
|Bool Output Parameter Count
|-
|0x50
|0x04
|u32
|Float Input Parameter Base Index
|-
|0x54
|0x04
|u32
|Float Input Parameter Count
|-
|0x58
|0x04
|u32
|Float Output Parameter Base Index
|-
|0x5C
|0x04
|u32
|Float Output Parameter Count
|-
|0x60
|0x04
|u32
|String Input Parameter Base Index
|-
|0x64
|0x04
|u32
|String Input Parameter Count
|-
|0x68
|0x04
|u32
|String Output Parameter Base Index
|-
|0x6C
|0x04
|u32
|String Output Parameter Count
|-
|0x70
|0x04
|u32
|Vector3f Input Parameter Base Index
|-
|0x74
|0x04
|u32
|Vector3f Input Parameter Count
|-
|0x78
|0x04
|u32
|Vector3f Output Parameter Base Index
|-
|0x7C
|0x04
|u32
|Vector3f Output Parameter Count
|-
|0x80
|0x04
|u32
|Pointer Input Parameter Base Index
|-
|0x84
|0x04
|u32
|Pointer Input Parameter Count
|-
|0x88
|0x04
|u32
|Pointer Output Parameter Base Index
|-
|0x8C
|0x04
|u32
|Pointer Output Parameter Count
|}
{| class="wikitable"
|+Child Node Section Header
!Offset
!Size
!Type
!Description
|-
|0x00
|0x01
|u8
|Bool/float Input Source Node/Output Source Node Count
|-
|0x01
|0x01
|u8
|Bool/float Input Source Node/Output Source Node Base Index
|-
|0x02
|0x01
|u8
|Unknown Connection Type Count (Unused in ''TotK'')
|-
|0x03
|0x01
|u8
|Unknown Connection Type Base Index (Unused ''TotK'')
|-
|0x04
|0x01
|u8
|Standard Child Node Count
|-
|0x05
|0x01
|u8
|Standard Child Node Base Index
|-
|0x06
|0x01
|u8
|Active Node Update Count
|-
|0x07
|0x01
|u8
|Active Node Update Base Index
|-
|0x08
|0x01
|u8
|String Input Source Node Count
|-
|0x09
|0x01
|u8
|String Input Source Node Base Index
|-
|0x0A
|0x01
|u8
|Int Input Source Node Count
|-
|0x0B
|0x01
|u8
|Int Input Source Node Base Index
|-
|0x0C
|0x01
|u8
|Unknown Connection Type Count (Unused in ''TotK'')
|-
|0x0D
|0x01
|u8
|Unknown Connection Type Base Index (Unused ''TotK'')
|-
|0x0E
|0x01
|u8
|Unknown Connection Type Count (Unused in ''TotK'')
|-
|0x0F
|0x01
|u8
|Unknown Connection Type Base Index (Unused ''TotK'')
|-
|0x10
|0x01
|u8
|Unknown Connection Type Count (Unused in ''TotK'')
|-
|0x11
|0x01
|u8
|Unknown Connection Type Base Index (Unused ''TotK'')
|-
|0x12
|0x01
|u8
|Unknown Connection Type Count (Unused in ''TotK'')
|-
|0x13
|0x01
|u8
|Unknown Connection Type Base Index (Unused ''TotK'')
|}
If the node has any child nodes, the section header is followed by an array of u32 offsets to each of the child node entries. For most nodes, each entry is eight bytes.
{| class="wikitable"
|+Child Node Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Child Node Index
|-
|0x04
|0x04
|u32
|Value
|}
The interpretation of the value depends on the connection type. For input or output connections, the value is a string offset to the parameter name. For standard connections, the value is a string offset to the connection name. For active node update connections, the value is an index into the active node update array. Certain node/connection types will also extend the entry length. Selector-type nodes excluding <code>Element_BoolSelector</code> and <code>Element_F32Selector</code> will have an extra four bytes which stores the condition for to link to the child node. For <code>Element_S32Selector</code>, this is an immediate value. For <code>Element_RandomSelector</code>, this is a weight and for <code>Element_StringSelector</code> it is a u32 string offset. The condition for <code>Element_BoolSelector</code> is the entry's value string. <code>Element_F32Selector</code> adds 24 bytes to each entry, consisting of four eight-byte sub-entries.
{| class="wikitable"
|+<code>Element_F32Selector Condition Entry</code>
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Local Blackboard Parameter Index and Flags
|-
|0x04
|0x04
|float
|Condition Value
|}
The first two bytes of the four bytes at offset 0x00 are the local blackboard parameter index while the last bit is whether or not the index is used or not. The first entry for <code>Element_F32Selector</code> is the minimum value condition while the second entry is the maximum value condition. The last two entries appear to be unused. The last child node entry for Selector-type nodes is the default case. The condition for this case is either a string offset to the string その他 ("Other") or 0 (in the case of <code>Element_S32Selector</code>). Input nodes that are Selector-type nodes also appear to have an additional eight bytes (purpose unknown). <code>Element_Expression</code> have an additional eight bytes per input node (16 bytes in the case of vector3f entries). The purpose of these bytes is unknown.

==== Attachment Parameters ====
This section contains an array of attachments for nodes. This section is preceded by the attachment index array which is an array of u32 indices into the entries in this section. Nodes contain an index into the index array rather than directly into this section. The section contains an array of entries followed by an array of parameter entries.
{| class="wikitable"
|+Attachment Parameter Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Name Offset
|-
|0x04
|0x04
|u32
|Parameters Entry Offset
|-
|0x08
|0x02
|u16
|EXB Function Count
|-
|0x0A
|0x02
|u16
|EXB Input/Output Field Size
|-
|0x0C
|0x04
|u32
|Name Hash (version 0x0407 only)
|}
{| class="wikitable"
|+Parameter Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Unknown (possibly related to debug)
|-
|0x04
|0x04
|u32
|Int Internal Parameter Base Index
|-
|0x08
|0x04
|u32
|Int Internal Parameter Count
|-
|0x0C
|0x04
|u32
|Bool Internal Parameter Base Index
|-
|0x10
|0x04
|u32
|Bool Internal Parameter Count
|-
|0x14
|0x04
|u32
|Float Internal Parameter Base Index
|-
|0x18
|0x04
|u32
|Float Internal Parameter Count
|-
|0x1C
|0x04
|u32
|String Internal Parameter Base Index
|-
|0x20
|0x04
|u32
|String Internal Parameter Count
|-
|0x24
|0x04
|u32
|Vector3f Internal Parameter Base Index
|-
|0x28
|0x04
|u32
|Vector3f Internal Parameter Count
|-
|0x2C
|0x04
|u32
|Pointer Internal Parameter Base Index
|-
|0x30
|0x04
|u32
|Pointer Internal Parameter Count
|-
|0x34
|0x04
|u32
|
|-
|0x38
|0x04
|u32
|Unknown (contains address to next entry)
|-
|0x3C
|0x04
|u32
|
|-
|0x40
|0x04
|u32
|Unknown (contains address to next entry)
|-
|0x44
|0x04
|u32
|
|-
|0x48
|0x04
|u32
|Unknown (contains address to next entry)
|-
|0x4C
|0x04
|u32
|
|-
|0x50
|0x04
|u32
|Unknown (contains address to next entry)
|-
|0x54
|0x04
|u32
|
|-
|0x58
|0x04
|u32
|Unknown (contains address to next entry)
|-
|0x5C
|0x04
|u32
|
|-
|0x60
|0x04
|u32
|Unknown (contains address to next entry)
|}

==== Internal Parameters ====
This section contains an array of internal parameters for nodes. The section begins with a six u32 relative offsets to the first entry for each data type. The data type order for this section is int, bool, float, string, vector3f, and pointer.
{| class="wikitable"
|+Parameter Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Name Offset
|-
|0x04
|0x04
|u32
|Flags
|-
|0x08
|
|
|Value
|}
The value is an immediate value for the data type (excluding string which is a string offset and pointer which doesn't store a value). Pointer entries also have an additional u32 class name offset at offset 0x04, pushing the flags to offset 0x08.
{| class="wikitable"
|+Parameter Flags
!Bits
!Description
|-
|16
|Source Index
|-
|1
|Is Use Index
|-
|1
|Is Not Local Blackboard Index
|-
|1
|
|-
|1
|
|-
|1
|
|-
|1
|
|-
|1
|Is EXB Index
|-
|1
|Pulse Thread Local Storage
|-
|1
|Set Pointer Flag Bit Zero
|-
|2
|
|-
|2
|
|-
|2
|
|}

==== Input/Output Parameters ====
This section contains an array of input and output parameter entries. These appear to be canonically referred to as "plugs". Similarly to the internal parameters section, the section begins with u32 relative offsets to the first entry of each data type. However, instead of six offsets, there are 12 - two for each data type (one input, one output). The order of parameters in this section is int input, int output, bool input, bool output, float intput, float output, string input, string output, vector3f input, vector3f output, pointer input, and pointer output.
{| class="wikitable"
|+Input Parameter Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Name Offset
|-
|0x04
|0x02
|s16
|Input Child Node Index / Multi-Parameter Array Base Index
|-
|0x06
|0x02
|s16
|Input/Output Source Node Index / Multi-Parameter Count
|-
|0x08
|0x04
|u32
|Flags
|-
|0x0C
|
|
|Default Value
|}
The default value is an immediate value for the data type (excluding string which is a string offset and pointer which is always an empty four bytes). Pointer entries also have an additional u32 class name offset at offset 0x04, pushing the rest of the entry back by four bytes. If the input child node index is between -32768 and -100, it corresponds to a multi-parameter array index. The multi-parameter index can be calculated as follows: <code>MultiParamIndex = -100 - Index</code>.
{| class="wikitable"
|+Parameter Flags
!Bits
!Description
|-
|16
|Source Index
|-
|1
|Is Use Index
|-
|1
|Is Not Local Blackboard Index
|-
|1
|
|-
|1
|
|-
|1
|
|-
|1
|
|-
|1
|Is EXB Index
|-
|1
|Pulse Thread Local Storage
|-
|1
|Set Pointer Flag Bit Zero
|-
|2
|
|-
|2
|
|-
|2
|
|}
Each output parameter entry is four bytes.
{| class="wikitable"
|+Output Parameter Entry
!Bits
!Description
|-
|31
|Name Offset
|-
|1
|Set Pointer Flag Bit Zero
|}

==== Multi-Parameters ====
This section contains entries specifying parameters that have multiple values and the sources of those values. Each entry is eight bytes.
{| class="wikitable"
|+Multi-Parameter Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x02
|u16
|Node Index
|-
|0x02
|0x02
|u16
|Input/Output Source Parameter Index
|-
|0x04
|0x04
|u32
|Flags
|}
{| class="wikitable"
|+Parameter Flags
!Bits
!Description
|-
|16
|Source Index
|-
|1
|Is Use Index
|-
|1
|Is Not Local Blackboard Index
|-
|1
|
|-
|1
|
|-
|1
|
|-
|1
|
|-
|1
|Is EXB Index
|-
|1
|Pulse Thread Local Storage
|-
|1
|Set Pointer Flag Bit Zero
|-
|2
|
|-
|2
|
|-
|2
|
|}

==== Active Node Update Array ====
This section is an array of entries for updates to the active node array. The first four bytes specify the number of entries. Each entry is four bytes.
{| class="wikitable"
|+
!Bits
!Description
|-
|8
|Is Valid Update
|-
|23
|
|-
|1
|Update Post Calc
|}
If the first byte of the flags is set to false, then the entry contains another four bytes with a string offset (purpose unknown). Otherwise, the entry is considered valid if the first byte equals 1. When processing a node graph, the game maintains an array of active root nodes. When a command calculated, the root node of the command is added to this array and it and its child nodes are calculated recursively. An active node update will change the current active root node to the specified node. This usually happens right before the next command's calculation occurs, but if the top bit is set, then it will occur immediately after the current command's calculation finishes (if the source node is an Element_Join nodes, it will always update the active node post current command calculation). This is primarily used for "subroutines" that run a single time then return to the main execution routine. This system is also used for Element_Fork and Element_Join nodes. An Element_Fork node, unlike normal nodes, will replace the entire current active node array with its array of active node updates (essentially forking execution into multiple different paths). The node at the end of each of these paths will optionally also have an active node update referencing a specific Element_Join node. Each of these nodes will push the Element_Join into the active node array. However, Element_Join nodes have an internal parameter called InFlowNum and until it has been pushed onto the array that many times in a single calculation, it will not activate and remain dormant. However, once this threshold is reached, it will begin execution (with a guard to make sure only one of the instances added to the array will execute).

==== 0x50 Section ====
This section is unused in ''Tears of the Kingdom''.

==== Precondition Nodes Array ====
This section is an array of entries of precondition nodes present in the file.
{| class="wikitable"
|+Precondition Node Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x02
|u16
|Precondition Node Index (local to number of precondition nodes)
|-
|0x02
|0x02
|u16
|
|}

==== Expression Binary Section ====
The '''EXB''' ('''Ex'''pression '''B'''inary) section is a completely self-contained section that stores custom instructions for a simple command processor. These instructions are grouped into functions that can be called by nodes to perform calculations. Because the section is self-contained, all offsets in this section are local to the section. The EXB section is shared with ASB files ('''A'''nimation '''S'''equence '''B'''inary).

===== Section Structure =====
EXB is essentially its own format and allows for the storage of custom functions in files.

====== Section Order ======

# 0x2C-Byte Header
# Command Info Table
# Instructions Table
# Parameter Region
# Signature Table
# String Pool

===== Sub-Sections =====

====== Header ======
{| class="wikitable"
|+EXB Header
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|char[4]
|Magic - “EXB “
|-
|0x04
|0x04
|u32
|Version (0x02)
|-
|0x08
|0x04
|u32
|Static Memory Allocation Size
|-
|0x0C
|0x04
|u32
|Parameter EXB Field Entry Count
|-
|0x10
|0x04
|u32
|32-bit Scratch Allocation Size
|-
|0x14
|0x04
|u32
|64-bit Scratch Allocation Size
|-
|0x18
|0x04
|u32
|Command Info Offset
|-
|0x1C
|0x04
|u32
|Command Table Offset
|-
|0x20
|0x04
|u32
|Signature Table Offset
|-
|0x24
|0x04
|u32
|Parameter Region Offset
|-
|0x28
|0x04
|u32
|String Pool Offset
|}

====== Command Info Table ======
This section contains an array of command (function) info entries. The first four bytes specify the entry count.
{| class="wikitable"
|+Command Info Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|s32
|Base Index Pre-Command Entry
|-
|0x04
|0x04
|u32
|Pre-Entry Static Memory Usage
|-
|0x08
|0x04
|u32
|Instruction Base Index
|-
|0x0C
|0x04
|u32
|Instruction Count
|-
|0x10
|0x04
|u32
|Static Memory Size
|-
|0x14
|0x02
|u16
|32-bit Scratch Memory Size
|-
|0x16
|0x02
|u16
|64-bit Scratch Memory Size
|-
|0x18
|0x02
|u16
|Output Data Type Enum
|-
|0x1A
|0x02
|u16
|Input Data Type Enum
|}
{| class="wikitable"
|+Data Type Enum
!Value (Hex)
!Value (Dec)
!Data Type
|-
|0x0
|0
|No Data
|-
|0x1
|1
|Immediate Value/From User
|-
|0x02
|2
|bool
|-
|0x03
|3
|int
|-
|0x04
|4
|float
|-
|0x05
|5
|string
|-
|0x06
|6
|vector3f
|}

====== Instructions Table ======
This section contains an array of instruction entries which are read by the EXB command processor. The first four bytes specify the entry count.
{| class="wikitable"
|+Instruction Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x01
|u8
|Instruction Type
|-
|0x01
|0x01
|u8
|Data Type Enum
|-
|0x02
|0x01
|u8
|Left-Hand Side Parameter Source Enum
|-
|0x03
|0x01
|u8
|Right-Hand Side Parameter Source Enum
|-
|0x04
|0x02
|u16
|Left-Hand Side Parameter Value
|-
|0x06
|0x02
|u16
|Right-Hand Side Parameter Value
|}
For UserDefined type instructions, the bytes at offset 0x02-0x04 become a u16 static memory index and the bytes at 0x04-0x08 become a u32 index into the function signatures table.
{| class="wikitable"
|+Instruction Types
!Value (Hex)
!Value (Dec)
!Instruction Type
|-
|0x01
|1
|Terminator
|-
|0x02
|2
|Store
|-
|0x03
|3
|Negate
|-
|0x04
|4
|NegateBool
|-
|0x05
|5
|Add
|-
|0x06
|6
|Subtract
|-
|0x07
|7
|Multiply
|-
|0x08
|8
|Divide
|-
|0x09
|9
|Modulus
|-
|0x0A
|10
|Increment
|-
|0x0B
|11
|Decrement
|-
|0x0C
|12
|ScalarMultiplyVec3f
|-
|0x0D
|13
|ScalarDivideVec3f
|-
|0x0E
|14
|LeftShift
|-
|0x0F
|15
|RightShift
|-
|0x10
|16
|LessThan
|-
|0x11
|17
|LessThanEqual
|-
|0x12
|18
|GreaterThan
|-
|0x13
|19
|GreaterThanEqual
|-
|0x14
|20
|Equal
|-
|0x15
|21
|NotEqual
|-
|0x16
|22
|AND
|-
|0x17
|23
|XOR
|-
|0x18
|24
|OR
|-
|0x19
|25
|LogicalAND
|-
|0x1A
|26
|LogicalOR
|-
|0x1B
|27
|UserFunction
|-
|0x1C
|28
|JumpIfLHSZero
|-
|0x1D
|29
|Jump
|}
UserFunctions are mapped to a function in the executable by function signature. There are two types of these functions: direct and object. Direct functions are straightforward functions that take up to two arguments and are matched using the function signature. Function objects can take additional arguments and are indexed at runtime.

{| class="wikitable"
|+Data Type Enum
!Value (Hex)
!Value (Dec)
!Data Type
|-
|0x0
|0
|No Data
|-
|0x1
|1
|Immediate Value/From User
|-
|0x02
|2
|bool
|-
|0x03
|3
|int
|-
|0x04
|4
|float
|-
|0x05
|5
|string
|-
|0x06
|6
|vector3f
|}
{| class="wikitable"
|+Parameter Source Enum
!Value (Hex)
!Value (Dec)
!Parameter Source
|-
|0x00
|0
|Immediate Parameters
|-
|0x01
|1
|Immediate Parameters (String)
|-
|0x02
|2
|Static Memory
|-
|0x03
|3
|Parameters Region
|-
|0x04
|4
|Parameters Region (String)
|-
|0x05
|5
|Output Value
|-
|0x06
|6
|Input Value
|-
|0x07
|7
|32-bit Scratch
|-
|0x08
|8
|64-bit Scratch
|-
|0x09
|9
|UserOutput
|-
|0x0A
|10
|UserInput
|}
UserCallback is a class that contains virtual functions providing memory allocation. The input value is passed from the calling node and the output value is passed back.

====== Parameter Region ======
The parameter region is a region that stores the values for parameters values that are too large to fit into two bytes. Parameters that get their values from this section instead store an offset relative to the beginning of the parameter region to the start of the value.

====== Signatures Table ======
This section is an array of u32 string offsets for each function signature.

====== String Pool ======
The string pool is an array of null-terminated strings encoded with UTF-8. All string offsets in this section are relative to the beginning of the string pool.

==== AINB Modules ====
This section contains an array of all AINB modules linked to the current AINB file. The first four bytes specify the entry count.
{| class="wikitable"
|+AINB Module Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|File Path Offset
|-
|0x04
|0x04
|u32
|File Category Offset
|-
|0x08
|0x04
|u32
|AINB File Count
|}

==== External Action Array ====
This section appears to interact with XLink. The first four bytes specify the entry count.
{| class="wikitable"
|+Entry String Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Node Index
|-
|0x04
|0x04
|u32
|String 1 Offset (always メインステート ("Main State"))
|-
|0x08
|0x04
|u32
|State Name Offset
|}

==== File Hashes ====
This section contains two 32-bit file hashes. The first hash is a hash for the file itself and the second hash appears to be a hash for that file's parent file. The purpose of these hashes is unclear.

==== Child Replacement Table ====
This section is used to remove or replace specific nodes or attachments at runtime. This is used to toggle of debug nodes/attachments for release builds. The section begins with an eight-byte section header.
{| class="wikitable"
|+Child Replacement Section Header
!Offset
!Size
!Type
!Description
|-
|0x00
|0x01
|u8
|Initialization Guard (Is Initialized)
|-
|0x01
|0x01
|u8
|
|-
|0x02
|0x02
|u16
|Replacement Count
|-
|0x04
|0x02
|s16
|Override Node Count
|-
|0x06
|0x02
|s16
|Override Attachment Parameter Count
|}
{| class="wikitable"
|+Child Replacement Table Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x01
|u8
|Replacement Type Enum (0 = remove child node, 1 = replace child node, 2 = remove attachment)
|-
|0x01
|0x01
|u8
|
|-
|0x02
|0x02
|u16
|Node Index
|-
|0x04
|0x02
|u16
|Child Node Index/Attachment Index
|-
|0x06
|0x02
|u16
|New Node Index (for child node replacements)
|}

==== 0x6C Section ====
This section is unused in ''Tears of the Kingdom''.

==== Enum Resolve Array ====
This section is used to resolve enum values at runtime. This section is unused in ''Tears of the Kingdom'' as all enum values are statically present in the file. However, in ''Splatoon 3'', this section is used extensively as all enum values are stored in the main executable. The first four bytes of this section specifies the number of entries in the section.
{| class="wikitable"
|+Enum Resolve Array Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Enum Value Offset
|-
|0x04
|0x04
|u32
|Enum Class Name Offset
|-
|0x08
|0x04
|u32
|Enum Value Name Offset
|}

==== String Pool ====
The string pool is an array of null-terminated strings encoded with UTF-8. All string offsets in the file are relative to the first byte of this section. Note that this section also contains some unreferenced strings which are the enums for certain parameters.
[[Category:File formats]]

ASB

2025-02-08T18:16:01Z

Watertoon: Add Mario vs Donkey Kong and NSO Playtest asb versions.

ModuleSystem

2024-10-24T23:10:39Z

Watertoon: Add a small entry for the NSO Playtest

ModuleSystem is the unofficial name of Nintendo EPD's latest game engine, based on the name of the singular sead::Task at the heart of the mainloop. It's actor system appears to be a sequel in design to KingSystem, the engine created for The Legend of Zelda: Breath of the Wild. ModuleSystem appears to have replaced both ActionLibrary and LunchPack2 as the new primary engine for Nintendo EPD's and NST's game development teams. While each game shares a common set of engine features, each series appears to have a custom fork extending the engine with varying degrees of game specific functionality.

=== Games ===
{| class="wikitable"
|+
!Name
!Extension/Differences summary
|-
|Nintendo Switch Sports
|Graphics Module contains a Mii data manager.
|-
|Splatoon 3
|ModuleSystem is extended to thunder::ModuleSystem, notably adding the ability to run the CPU side of the mainloop multiple times per frame. Omits gamedata for a custom save system.
|-
|The Legend of Zelda: Tears of the Kingdom
|Major version up from Splatoon 3 and Nintendo Switch Sports. Some engine namespaces were updated between version 1.0.0 and 1.1.0. Includes the TerrainModule and LODModule, while most other games only contain references to these systems.
|-
|Super Mario Wonder
|Some libraries are newer than Tears of the Kingdom, some are older.
|-
|Mario Vs Donkey Kong
|Appears to be slightly behind version of Tears of the Kingdom. IActor has a new Stasus state used when swapping actors between "combined scenes". Replaces physics handling with a custom 2d physics engine, yet leaves the PhysicsModule with an unused version of the phive library implemented on top of PhysX instead of Havok.
|-
|Nintendo Switch Online: Playtest Program
|A major version above Tears of the Kingdom. IModule no longer inherits sead job and instead includes a job as a member. A new actor component called CppExecutorComponent was added to ActorBase. Actor system processing was slightly revised. Phive has many notable refactors and additions in this title, including a new locomotion behavior state machine and a new file format called bphnv (not appearing in this title). Agl seems to have removed the GraphicsPipelineHolder and HardwareOptimizationMgr.
|}

=== Namespaces ===
The top level namespace for ModuleSystem is engine. Sub-namespaces typically include a module wrapping a system for a dedicated purpose, whether unique to the engine or contracted out to an external library. Interfaces to the system are typically provided to Actors or Scenes.
{| class="wikitable"
|+
!Namespace
!Description
|-
|actor
|Implements the actor system.
|-
|ai
|Wraps the ai library. Integrates with PreActors through ActorAIGroups, ActorBase through the AIComponent, and IScene through the SequenceComponent.
|-
|as
|Wraps the as library. Integrates with ActorBase through the RetargetScaleComponent, ASInfoComponent, ASOptimizeComponent, and ASComponent.
|-
|bake
|Wraps the bake library.
|-
|banc
|Implements BancEntities via the BancModule. Banc handles the parsing of map units into PreActors, actor ai groups, rails, placement groups, far delete groups, and custom game extensions.
|-
|bb (Unofficial)
|Wraps the bb library, responsible for managing bb::Blackboards. Integrates with ActorBase through BlackboardComponentActor and IScene with BlackboardComponentScene.
|-
|camera
|Implements a camera system. Integrates with ActorBase via the CameraComponent.
|-
|component
|Houses all engine components from the other namespaces for engine::actor::ActorBase and engine::scene::IScene.
|-
|controller
|Implements a controller manager.
|-
|debug
|Stubbed in retail. Seemingly implements a debug menu called "ClickMenu".
|-
|effect
|Wraps shaft::effect for managing effect resources.
|-
|erepo (unofficial)
|Wraps the erepo library for PlayReport management.
|-
|event
|Implements an event system on top of the evfl library for Event Flows and Timelines, and the sdk movie library for prerendered video. Integrates with ActorBase through the BeforehandLoadEventComponent, EventMemberComponent, and EventPerformerComponent.
|-
|framework
|Implements a minor extension to sead::GameFrameworkNx, and the SpStepRateMgr.
|-
|gamedata
|Wraps the gmd library for managing a global, computable, and savable hash map of game data.
|-
|graphics (unofficial)
|Wraps the gsys library, which extends the agl library. Integrates with ActorBase through the ModelComponent and ModelBindComponent.
|-
|lod
|Implements a level of detail system. Integrates with ActorBase through the LODComponent.
|-
|lua
|Stubbed in retail. Provides lua support for debugging purposes.
|-
|module
|Implements the ModuleSystem sead::Task, as well as the IModule interface.
|-
|physics
|Wraps the phive library. Integrates with ActorBase through the PhysicsComponent.
|-
|rail
|Implements the RailMgr, manages rails parsed from banc.
|-
|reaction
|Implements a system for triggering reactions through reaction actors and XLink commands somehow (unknown at time of writing). Integrates with ActorBase via the ReactionComponent.
|-
|resource
|Wraps the ares library and implements ares::IApplicationImpl to provide asynchronous file resource management through ResourceBinders. Also wraps the pp library and implements pp::GfMgrCallback to provide a general parameter system via hierarchical Documents.
|-
|rsdb
|Wraps the pp::rsdb sub library. Manages a set of engine as well as game extended resource databases.
|-
|rumble
|Implements a rumble call system to allow sending vibrations to controllers.
|-
|scene
|Implements the scene system.
|-
|sound
|Wraps the alto library, which extends the aal library, which extends the aal::atom sub library.
|-
|system
|Implements the RomConfigMgr and PauseMgr
|-
|terrain
|Wraps the tera library. Provides terrain management.
|-
|transceiver (unofficial)
|Implements a transceiver based message systems. Messages can be sent to directly to a destination, or to a whole set of listeners.
|-
|ui
|Wraps the eui library, which in turn extends nn::ui2d. Provides ui processing and resource management through a layout category based system.
|-
|xlink
|Wraps the xlink2 library. Implements an XLink PreActor Manager. Integrates with ActorBase through the ELinkComponent, SLinkComponent, XLinkComponent, and XLinkSubComponent.
|}

=== Non-Canon Namespaces ===
These are engine namespaces, that for one reason or another, appear to be game specific extensions.
{| class="wikitable"
|+
!Name
!Game(s)
!Description
|-
|coll2d
|Mario Vs Donkey Kong
|Implements a 2d collision system the game uses instead of phive.
|-
|level
|Mario Vs Donkey Kong
|
|-
|message
|Mario Vs Donkey Kong
|
|-
|move2d
|Mario Vs Donkey Kong
|Implements a 2d movement system.
|}

=== Main Loop ===
The mainloop is implemented as a single sead::Task in the standard sead::GameFrameworkNx mainloop. The mainloop consists of 4 sead::DependencyJobGraph's submitted and ran in a sead::DependencyJobWorkerMgr in succession. These are unofficially called as of writing BeforeActor, AfterActor, GSys, and GSysCalcGpu.
[[Category:Engines]]

Aal::atom

2024-05-04T01:33:41Z

Watertoon: Start a writeup on aal atom

Aal atom serves as a replacement for NintendoWare atk. As such, NintendoWare formats like Bfsar and Bfstm are replaced with EPD's simple Bwav format. This library extends functionality of nn::audio.

== Backend ==

=== AudioRendererController ===
The main manager of all aal atom managers.

==== AudioRendererThread ====
This thread is responsible for processing 3 of the CommandQueues for non-stream thread commands, processing is typically requested once a frame.

=== AudioDeviceNameManager ===
Manages the audio device names and volumes for the TV, Stereo Jack, and Built In Speakers.

=== BusManager ===
Manages audio buses. An IBus is implemented as either a SubMixBus or a FinalMixBus. There is a single FinalMixBus, which is responsible for outputting audio to the audio device. There is a handle table allocator for SubMixBus's. IBus are implemented on top of a RoutingNode, which is responsible for handling a bus's links to destination buses.

=== BusSendManager ===
Manages a handle table of BusSends used for objects sending audio data to a RoutingNode.

=== SourceManager ===
Manages audio sources. A Source is implemented on top of a RoutingNode, as the destination of it's audio is a bus. Sources can have multiple Voices.

=== CommandBufferManager ===
Manages 4 Command Queues with 16 usable Command List slots for scheduling ICommands.

=== CommandManager ===
Allocator for ICommands. ICommands have a Type which corresponds to a name, some types are shared by multiple classes.
{| class="wikitable"
|+Command Names
!Name
!Type Value
!Description
|-
|Invalid
|0
|Not used.
|-
|Reserve
|1
|Unknown.
|-
|Blank
|2
|The default dummy ICommand.
|-
|BlankWithCheck
|3
|
|-
|AcquireVoice
|4
|Triggers a Source to acquire the underlying nn::audio voice slots for every Voice
|-
|UpdateActiveSourceList
|5
|Rebuilds the SourceManager's active Source array
|-
|UpdateDeactiveSourceList
|6
|Frees inactive Sources from the SourceManager's active Source array
|-
|SetPlayState
|7
|Adjusts the PlayState for every Voice that is part of a Source
|-
|PrepareWave
|8
|
|-
|SetVolume
|9
|Adjusts the volume for every Voice that is part of a Source
|-
|SetPitch
|10
|Adjusts the pitch for every Voice that is part of a Source
|-
|SetPriority
|11
|Adjusts the priority for every Voice that is part of a Source
|-
|SetChannelVolume
|12
|Adjusts the mix volumes for a Source?
|-
|SetSourceVolume
|13
|
|-
|SetBiquadFilter
|14
|Adjusts the BiquadFilter parameters for every voice that is part of a Source
|-
|UpdateSourceConnection
|15
|Updates the IBus destinations for a Source
|-
|Unknown
|16
|Unused.
|-
|Unknown
|17
|Unused.
|-
|FileReadRequest
|18
|Tells the stream thread to read in the next part of an audio stream.
|-
|FileRegistrationRequest
|19
|Registers an audio stream to the stream thread.
|-
|FileUnregistrationRequest
|20
|Unregisters an audio stream from the stream thread.
|-
|AcquireBus
|21
|Triggers an IBus to acquire it's underlying nn::audio type
|-
|UpdateActiveBusList
|22
|Rebuilds the BusManager active IBus array and frees unused SubMixes
|-
|SetBusVolume
|23
|Adjusts the volume of an IBus
|-
|SetBusSendVolume
|24
|Adjusts the volume of a BusSendArray
|-
|UpdateBusConnection
|25
|Updates the IBus destinations for an IBus
|-
|AddEffect
|26
|Adds an IEffect to an IBus
|-
|RemoveEffect
|27
|Removes an IEffect from an IBus
|-
|UpdateEffect
|28
|Processes an IEffect
|}

=== ClipManager ===
Manages a handle table of Clips. Clips appear to wrap bwav.

=== FaderBufferManager ===
Manages a handle table of Faders.

=== StreamBufferManager ===

Pp

2024-04-12T12:10:23Z

Watertoon: Draft an outline of the non-rsdb parts of the library

pp is Nintendo's parameter library. It provides an address table, resource databases, and most notably, Documents containing TypedParams.

== Backend ==

=== GeneralFormatMgr ===
Manages a tree of documents. Houses the GfMgrCallback and HashRequestQueue.

=== GfMgrCallback ===
Applications can use GfMgrCallback to integrate Document management with their resource system, providing load and release options.

=== HashRequestQueue ===
A queue of pending document release requests.

=== Document ===
Meta-data for a TypedParam.

=== Composite ===
This is the base class for composite types. Allows initializing with the values of a ByamlIter, initializing with default values, resolving the composite's parent type, finalizing the composite, searching the composite for another composite, and creating a format string.

=== PropBuffer ===
Extends Composite. An array of property values.

=== PropMap ===
Extends Composite. A tree of property values.

=== TypedParamBuffer ===
Extends Composite. An array of TypedParams.

=== TypedParamMap ===
Extends Composite. A tree of TypedParams.

=== TypedParam ===
Extends Composite. Base class for application source auto-generated TypedParam derived classes. On initialize loops all property, embedded, and composite fields of the class to initialize them through either a ByamlIter or static default values baked into the derived class. Properties are basic data types readable from a byaml. Embeds are TypedParams that are embedded into the TypedParam. Composites are for container classes, arrays or maps of TypedParams or properties, but also Embeds. Each field in a TypedParam has an index that appears to correspond to it's initialize order, but this index does not line up with the order of fields in the structure layout.

== Controllers ==

=== DocumentBinder (unofficial) ===
An raii wrapper around a Document reference. Allows loading, releasing, and safely acquiring a TypedParam of a certain type from a Document.

=== TypedParam Derivitives ===
All TypedParam derivatives have auto-generated getter functions for reading a property or accessing a composite.

=== CombinationDataTable ===
Extends TypedParam. Contains a map of CombinationDataCells set up as a 2d table with a key for the column and a key for the row, not dissimilar to a labeled Excel spreadsheet.

=== CombinationDataCellBase ===
Extends TypedParam. Base class for data found in a CombinationDataTable. Contains a strings for a RowKey and ColumnKey.

=== CellIter (unofficial) ===
Helper for looping the TypedParams of a CombinationDataTable by row or by column.

=== ComponentListBase ===
Extends TypedParam.
{| class="wikitable"
|+
!Type
!Name
!Description
|-
|String
|Label
|A label, likely for external tools
|-
|String
|Category
|A category, likely for external tools
|-
|PropMap<sead::SafeStringBase<char>>
|Components
|A simple map of Key:Values
|}

=== Extenti ===
Extends TypedParam.
{| class="wikitable"
|+
!Type
!Name
!Description
|-
|S32
|Min
|Minimum value
|-
|S32
|Max
|Maximum value
|}

=== Extentf ===
Extends TypedParam.
{| class="wikitable"
!Type
!Name
!Description
|-
|Float
|Min
|Minimum value
|-
|Float
|Max
|Maximum value
|}

Ares

2024-04-12T11:31:45Z

Watertoon: Draft an outline of the library

Ares is Nintendo's Asynchronous Resource library. Meant for managing resources, primarily files and their memory asynchronously.

== Backend ==

=== System ===
Manages 3 thread types, a Control thread, a Memory thread, and a set of Load threads. Control primarily handles ResourceUnit management related tasks. Memory mainly handles memory management related tasks. While Load threads mainly handle file load operations. The System also maintains structures such as a list of ResourceSizeTables, MemoryMgrs, sets of decompressors, a ResourceUnit request queue, OnThreadUnitPools for allocating LoadOnThreadUnit and ClearCacheOnThreadUnits, as well as callbacks for OnThreadUnits and OnThreadUnits for internal use.

=== IApplicationSystem ===
Implemented by application. Provides callbacks to get the supported file extensions and which of those extensions use which of the 3 supported compression formats, a method to format the system thread initialize arguments, a method to look up a MemoryMgr based on resource size and path, and more.

=== MemoryMgr ===
Initialized by application. Manages memory and heap creation for resource units. The MemoryMgr's root heap can be a sead::ExpHeap, sead::VirtualAddressHeap, or a user provided heap type.

=== ThreadLocalArchiveMgr ===
Manages the thread local storage for the user set thread local archive resource via a pool of thread references.

=== ResourceSizeTable ===
Manages an [[rsizetable]]. Allows looking up a resource's size by a file path.

=== ResourceMgr ===
Manages a tree of resource units. Allows the System to iterate ResourceUnits under a file extension, and attempt to reference existing ResourceUnits during a load operation.

=== ResourceUnitPool ===
Allocator for ResourceUnits.

=== ResourceUnit ===
Resource meta data, such as the file path the resource came from, the Status, the FileDevice, the ResourceFactory, the MemoryMgr, the Resource itself, the ResourceMgr, as well as an Event and OnThreadUnit for background operations.

=== thread::ExeQueue ===
A queue for scheduling OnThreadUnits through a set of ExeQueueThreads with respect to their priority, amount of priority levels and ExeQueueThreads adjustable.

=== thread::CSExeQueue ===
A thread safe derivative of ExeQueue via CriticalSection, only addition, only ExeQueue class observed used.

=== thread::ExeQueueThread ===
A thread that processes OnThreadUnits asynchronously.

=== thread::OnThreadUnit ===
An encapsulation of a unit of work to be processed by an ExeQueue. Has 2 user provided callbacks at time of scheduling, Execute and Result, result can reschedule the current OnThreadUnit. Virtual callbacks are provided for derived OnThreadUnit types.

=== thread::OnThreadUnitPool ===
A pool of OnThreadUnits, allows the user to create pools of derived ForPoolOnThreadUnit classes.

=== thread::ForPoolOnThreadUnit ===
Extends OnThreadUnit with integration related to OnThreadUnitPool.

=== thread::OnThreadUnitWatcher ===
Allows a user to watch a ForPoolOnThreadUnit for completion.

=== LoadOnThreadUnit ===
Extends ForPoolOnThreadUnit with additional meta data and management related to loading files. Used to queue asynchronous load operations.

=== ClearCacheOnThreadUnit ===

== Controllers ==

=== ResourceBinder ===
Used to bind a resource. Stores a ResourceUnit reference and an OnThreadUnitWatcher. Supports loading a file asynchronously or synchronously, waiting for the load to complete, initializing the resource, acquiring the resource, and releasing the resource. Making requests from multiple threads on a single resource binder is not thread-safe, however it is thread-safe to attempt any operation even during resource loading.

=== Thread Local Archive Api ===
A scoped thread local archive setter is provided, as well as a direct function for setting the current local archive. A ResourceBinder binding an archive resource must be provided, else the current local archive will be unset.

=== Threading Api ===
An interface is provided to suspend, to resume, and to adjust the priority or core masks of the 3 thread types.

Engine::actor

2024-04-09T10:42:12Z

Watertoon: Throw together a draft of actor system related info

This namespace houses [[ModuleSystem]]'s Actor system. Treat names as unofficial unless otherwise stated.

=== ActorModule ===
The namespace's [[Engine::module#IModule|IModule]].

== Managers ==

=== ActorMgr ===
Maintains a tree of all IActors. A scheduler with 4 stages each with 8 priority levels for calculating IActors, with a customizable sleep calculate. A pool of actor relation links and an array of active actor relations, with a request queue to modify relations. Maintains request lists for changing an IActor's state. Houses the BaseProcMgr.

==== BaseProcMgr ====
Maintains BaseProcCreateAndDelete threads as well as user callbacks to create and delete IActors asynchronously via atomic request queues.

=== ActorInstanceMgr ===
Houses a set of user callbacks for the actor system. Manages the ActorInstanceHeap which is by default responsible for most IActor and PreActor memory management. Maintains an array of factories for creating IActor class derivatives by name.

=== PreActorMgr ===
Houses the PreActorRenderer. A pool of ActorSystemSettings with active settings stored in a hash map. A pool of PreActorRenderInfo. Two pools of sets of PreActors. An array of all the sets of PreActors. A PreActor allocator managed by a linked list. Houses the ActorAIGroupMgr and LinkMgr.

==== PreActorRenderer ====
Houses 2 MassModels. An array of PreActorRenderInfo currently pending load. An array of PreActors to be drawn sorted by their actor settings accompanied by an array of batch info grouping similar models together. Houses the PreActorModelComposer thread.

===== PreActorModelComposer (TODO) =====

==== ActorAIGroupMgr ====
Maintains a set of ActorAIGroup.

==== LinkMgr ====
Manages an array of links for PreActors

== Units ==

=== PreActor ===
PreActors manage the state of an ActorBase before it's instantiation. Typically data comes from a bcett file parsed by a BancEntity. A PreActor stores a reference to it's [[Engine::banc#BancEntity|BancEntity]], a home transform, a hash of it's transform, a name, a hash to serve as a unique id, and a reference to it's ActorSystemSettings. If applicable it can contain the following. A ByamlIter to a dynamic section of data used to initialize the ActorBase's Blackboard or for user defined purposes. A ByamlIter to a set of phive specific parameters. A set of information used to initialize the ActorBase's Blackboard. A reference to the PreActor's ActorAIGroup with a set of user provided callbacks from the ActorAIGroup's ActorLogic. A reference to the PreActor's SimultaneousGroup. A reference to the PreActor's FarDeleteGroup. A handle to a set of link's in the LinkMgr. A handle to a StaticCompound referencing the PreActor's Phive PlacementID.

==== ActorSystemSettings (TODO) ====

==== ActorAIGroup (TODO) ====

==== SimultaneousGroup (TODO) ====

==== FarDeleteGroup (TODO) ====

=== IActor ===
This is the base interface of an actor that can be scheduled in the actor system. Each IActor has a heap meant for all of it's memory management, a unique id, the name of it's actor settings, a user defined name, it's current state, a set of request slots for requesting changes to it's state. A set of job slots for all 32 stage and priority combinations in the actor scheduler, with an extra sleep job slot. A tree map node for the ActorMgr. A reference to a structure used to manage the state for "hyperlinks" to an actor. A reference to a watcher for signifying state changes during asynchronous creation. A ring of references to the actor's relationships.
{| class="wikitable"
|+State
!Name
!Enum Value
!Description
|-
|Uninitialized
|0
|
|-
|InInitialize
|1
|
|-
|PostInitialized
|2
|
|-
|Schedulable
|3
|
|-
|Calc
|4
|
|-
|Paused
|5
|
|-
|Sleeping
|6
|
|-
|PreFinalize
|7
|
|-
|Finalize
|8
|
|-
|PostFinalize
|9
|
|-
|ScheduledForDeletion
|10
|
|-
|Deleted
|11
|
|}

=== ActorBase ===
ActorBase extends IActor by implementing a job for each of the 4 calc stages provided by the ActorMgr's scheduler. These calc stages are named PreCalc, PostCalc, PostSensor, and FrameEndCalc. Notably, FrameStartCalc happens directly before PreCalc in the PreCalc job. ActorBase maintains a home transform, a current transform, a request for the next transform, angular and linear velocites, an AABB, a Document reference to it's ActorParam, a reference to it's PreActor, a Transceiver, a BlackboardAccessor, an ActorBaseLink to an optional linked actor, and a pause key allocator for maintaining a pause mask for calculate stages of the actor that can be individually paused. The majority of ActorBase behavior is implemented in a set of engine provided optional components (See [[Engine::component#IActorComponent|engine::component]]).

Bflyt

2024-04-09T07:24:20Z

Watertoon:

nn::ui2d provides the Binary Cafe Layout file format to define the layout of ui elements.

=== Header (FLYT) ===
[[Common nn::ui2d|Standard ui2d header.]]

There are 23 possible section types:
{| class="wikitable"
|+
!Name
!Magic
!Description
|-
|User Data
|usd1
|User Data for the previous section, can contain special SystemData structures that extend functionality
|-
|Layout
|lyt1
|The headlining section for the Layout
|-
|Texture List
|txl1
|A list of all textures used in the Layout
|-
|Font List
|fnl1
|A list of all fonts used in the Layout
|-
|Material List
|mat1
|All the materials used in the Layout
|-
|Capture Texture List
|ctl1
|A list of all capture textures used in the Layout
|-
|Vector Graphics Texture List
|vgl1
|A list of all vector graphics textures used in the Layout
|-
|Pane Start
|pas1
|The start of a tree of panes, panes become children of last pane
|-
|Pane End
|pae1
|The end of a tree of panes
|-
|Pane
|pan1
|A default pane
|-
|Picture Pane
|pic1
|A pane that can contain images
|-
|TextBox Pane
|txt1
|A pane that can contain text
|-
|Window Pane
|wnd1
|A pane that contain a frame and multiple images
|-
|Parts Pane
|prt1
|A pane that can contain a sub layout
|-
|Alignment Pane
|ali1
|A pane that aligns it's children
|-
|Capture Pane
|cpt1
|A pane that captures it's children
|-
|Bounding Pane
|bnd1
|A pane that can be used in hit detection
|-
|Scissor Pane
|scr1
|A pane that scissors it's children
|-
|Group Start
|grs1
|The start of a group
|-
|Group End
|gre1
|The end of a group
|-
|Group
|grp1
|A group
|-
|Control Source
|cnt1
|The control source class and related for the layout
|-
|State Machine
|stm1
|A state machine
|}

=== Layout (lyt1) ===
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Ui2d Section Header
|Magic: "lyt1"
|-
|0x8
|0x1
|u8
|Is Centered
|-
|0x9
|0x3
|u24
|Unknown/Reserved
|-
|0xc
|0x4
|float
|Width
|-
|0x10
|0x4
|float
|Height
|-
|0x14
|0x4
|float
|PartsWidth
|-
|0x18
|0x4
|float
|PartsHeight
|-
|0x1c
|variable
|char[]
|Name
|}

==== Layout SystemData ====
{| class="wikitable"
|+
!Name
!EnumValue
!Description
|-
|AnimTagName
|0x0
|Animation names?
|}

==== AnimTagName ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|String Count
|-
|0x4
|0x4 * String Count
|u32
|Anim Name String Offset Array
|}

=== Texture List (txl1) ===
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Ui2d Section Header
|Magic: "txl1"
|-
|0x8
|0x2
|u16
|Texture Count
|-
|0xa
|0x2
|u16
|Unknown/Reserved
|-
|0x4
|0x4 * Texture Count
|u32
|Texture Name Offset Array
|}

=== Font List (fnt1) ===
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Ui2d Section Header
|Magic: "fnt1"
|-
|0x8
|0x2
|u16
|Font Count
|-
|0xa
|0x2
|u16
|Unknown/Reserved
|-
|0x4
|0x4 * Font Count
|u32
|Font Name Offset Array
|}

=== Material List (mat1) ===
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Ui2d Section Header
|Magic: "mat1"
|-
|0x8
|0x2
|u16
|Material Count
|-
|0xa
|0x2
|u16
|Unknown/Reserved
|-
|0x4
|0x4 * Material Count
|u32
|Material Data Offset Array
|}

==== Material Memory ====
The layout of material memory is defined by this bitfield.
{| class="wikitable"
|+
!Bitfield Size
!Description
|-
|0x2
|Texture Map Count
|-
|0x2
|Texture SRT (Scale Rotation Translation) Count
|-
|0x2
|Texture Coordinate Gen Count
|-
|0x3
|Tev (Texture Environment) Combiner Count
|-
|0x1
|Alpha Compare Count
|-
|0x1
|Color Blend Mode Count
|-
|0x1
|Unknown/Reserved
|-
|0x1
|Color And Alpha Blend Mode Count
|-
|0x1
|Unknown/Reserved
|-
|0x1
|Rotate Vector Count
|-
|0x2
|Projection Texture Gen Count
|-
|0x1
|Font Color 2 Count
|-
|0x1
|Unknown/Reserved
|-
|0x1
|Detailed Combiner Count
|-
|0x1
|User Combiner Count
|-
|0x1
|Texture Extensions Count
|-
|0x2
|Vector Texture Info Count
|-
|0x2
|Brick Repeat Shader Info Count
|-
|0x6
|Unknown/Reserved
|}
The order of appearance of Material Data structures are as follows:
{| class="wikitable"
|+
!Structure
|-
|Material Data
|-
|Texture Map
|-
|Texture Extensions
|-
|Texture SRT
|-
|Texture Coordinate Gen
|-
|Tev Combiner
|-
|Alpha Compare
|-
|Blend Mode
|-
|Rotate Vector
|-
|Projection Texture Gen
|-
|Font Color 2
|-
|DetailedCombiner
|-
|User Combiner
|-
|Vector Texture Info
|-
|Brick Repeat Shader Info
|}

==== Material Color Type ====
{| class="wikitable"
|+
!Name
!EnumValue
!Description
|-
|Color4u8
|0x0
|Material Color data offsets point to a Color4u8
|-
|Color4f
|0x1
|Material Color data offsets point to a Color4f
|}

==== Material Color Data ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x1
|u8
|Color Type
|-
|0x1
|0x1
|u8
|Color Count
|-
|0x2
|0x1 * Color Count
|u8
|Color Offsets
|-
|
|(Color4u8) 0x4 * Color Count
(Color4f) 0xc * Color Count
|Color4u8
Color4f
|Color Array
|}

==== Material Data ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x1c
|char[0x1c]
|Material name
|-
|0x1c
|0x4
|Material Memory
|Material memory bitfield
|-
|0x20
|variable
|MaterialColorData
|Material color data
|}

==== Texture Map ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x2
|u16
|Texture Index
|-
|0x2
|0x1
|Texture UV Options
|U Options
|-
|0x3
|0x1
|Texture UV Options
|V Options
|}

===== Texture UV Options =====
{| class="wikitable"
!Bitfield Size
!Description
|-
|0x2
|Wrap Mode
|-
|0x2
|Filter
|-
|0x4
|Unknown/Reserved
|}

==== Texture Extensions ====
{| class="wikitable"
!Bitfield Size
!Description
|-
|0x1
|Is Capture Texture
|-
|0x1
|Is Vector Graphics Texture
|-
|0x1e
|Unknown/Reserved
|}

==== Texture SRT ====
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Vector2f
|Translation
|-
|0x8
|0x4
|float
|Rotation
|-
|0xc
|0x8
|Vector2f
|Scale
|}

==== Texture Coordinate Gen (TODO) ====

==== Tev Combiner (TODO) ====

==== Alpha Compare ====
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x1
|u8
|Alpha Test Function
|-
|0x1
|0x3
|u24
|Unknown/Reserved
|-
|0x4
|0x1
|float
|Alpha Compare Reference
|}

===== Alpha Test Function =====
{| class="wikitable"
!Name
!Enum Value
!Description
|-
|Never
|0x0
|
|-
|LessThan
|0x1
|
|-
|LessThanEqual
|0x2
|
|-
|Equal
|0x3
|
|-
|NotEqual
|0x4
|
|-
|GreaterEqual
|0x5
|
|-
|Greater
|0x6
|
|-
|Always
|0x7
|
|}

==== Blend Mode ====
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x1
|u8
|Blend Equation
|-
|0x1
|0x1
|u8
|Blend Function Source
|-
|0x2
|0x1
|u8
|Blend Function Destination
|-
|0x3
|0x1
|u8
|Logic Operation
|}

===== Blend Equation =====
{| class="wikitable"
!Name
!Enum Value
!Description
|-
|Invalid
|0x0
|
|-
|Add
|0x1
|
|-
|Sub
|0x2
|
|-
|ReverseSub
|0x3
|
|-
|Min
|0x4
|
|-
|Max
|0x5
|
|}

===== Blend Function =====
{| class="wikitable"
!Name
!Enum Value
!Description
|-
|Zero
|0x0
|
|-
|One
|0x1
|
|-
|Destination Color
|0x2
|
|-
|Destination Color Minus One
|0x3
|
|-
|Source Alpha
|0x4
|
|-
|Source Alpha Minus One
|0x5
|
|-
|Destination Alpha
|0x6
|
|-
|Destination Alpha Minus One
|0x7
|
|-
|Source Color
|0x8
|
|-
|Source Color Minus One
|0x9
|
|}

===== Logic Operation =====
{| class="wikitable"
!Name
!Enum Value
!Description
|-
|Invalid
|0x0
|
|-
|NoOp
|0x1
|
|-
|Clear
|0x2
|
|-
|Set
|0x3
|
|-
|Copy
|0x4
|
|-
|CopyInverted
|0x5
|
|-
|Invert
|0x6
|
|-
|And
|0x7
|
|-
|Nand
|0x8
|
|-
|Or
|0x9
|
|-
|Nor
|0xa
|
|-
|Xor
|0xb
|
|-
|Equivalent
|0xc
|
|-
|AndReverse
|0xd
|
|-
|AndInverted
|0xe
|
|-
|OrReverse
|0xf
|
|-
|OrInverted
|0x10
|
|}

==== Rotate Vector (TODO) ====

==== Projection Texture Gen (TODO) ====

==== Font Color 2 (TODO) ====

==== Detailed Combiner (TODO) ====

==== User Combiner (TODO) ====

==== Vector Texture Info (TODO) ====

==== Brick Repeat Shader Info (TODO) ====

=== Capture Texture List (TODO) ===

=== Vector Graphics Texture List (TODO) ===

=== Pane Start ===
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Ui2d Section Header
|Magic: "pas1"
|}

=== Pane End ===
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Ui2d Section Header
|Magic: "pae1"
|}

=== Pane (pan1) ===
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Ui2d Section Header
|Magic: "pan1"
|-
|0x8
|0x1
|u8
|Pane Flags
|-
|0x9
|0x1
|u8
|Origin Bitfield
|-
|0xa
|0x1
|u8
|Alpha
|-
|0xb
|0x1
|u8
|FlagEx
|-
|0xc
|0x18
|char[0x18]
|Pane name
|-
|0x24
|0x8
|char[0x8]
|User name
|-
|0x2c
|0xc
|Vector3f
|Translation
|-
|0x28
|0xc
|Vector3f
|Rotation
|-
|0x44
|0x8
|Vector2f
|Scale
|-
|0x4c
|0x8
|Vector2f
|Size
|}

==== Pane System Data ====
0x10 onwards is runtime appended user data.
{| class="wikitable"
|+Note; 0-2 use unofficial names
!Name
!Enum Value
!Description
|-
|QuadScale0
|0
|
|-
|QuadScale1
|1
|
|-
|AlignmentOptions
|2
|
|-
|MaskTexture
|3
|
|-
|DropShadow
|4
|
|-
|ProceduralShape
|6
|
|-
|PaneEffect
|0x11
|
|-
|ProceduralShapeRuntime
|0x12
|
|-
|StateMachine
|0x13
|
|-
|Reserve0
|0x14
|
|-
|Root
|0x15
|
|}

=== Picture Pane (pic1) ===
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x54
|Pane
|Magic: "pic1"
|-
|0x54
|0x4
|Color4u8
|Vertex Color Top Left
|-
|0x58
|0x4
|Color4u8
|Vertex Color Top Right
|-
|0x5c
|0x4
|Color4u8
|Vertex Color Bottom Left
|-
|0x60
|0x4
|Color4u8
|Vertex Color Bottom Right
|-
|0x64
|0x2
|u16
|Material Index
|-
|0x66
|0x1
|u8
|Texture Count
|-
|0x67
|0x1
|u8
|Is Shape
|-
|0x68
|0x20
|Texture UV
|Texture UV Array
|}

===== Texture UV =====
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Vector2f
|Top Left
|-
|0x8
|0x8
|Vector2f
|Top Right
|-
|0x10
|0x8
|Vector2f
|Bottom Left
|-
|0x18
|0x8
|Vector2f
|Bottom Right
|}

=== TextBox Pane (txt1) ===
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x54
|Pane
|Magic: "pic1"
|-
|0x54
|0x2
|u16
|Text Buffer Size
|-
|0x56
|0x2
|u16
|Text Length
|-
|0x58
|0x2
|u16
|Material Index
|-
|0x5a
|0x2
|u16
|Font Index
|-
|0x5c
|0x1
|u8
|Text Origin
|-
|0x5d
|0x1
|u8
|Line Alignment
|-
|0x5e
|0x2
|u16
|Flags
|-
|0x60
|0x4
|float
|Italic Tilt
|-
|0x64
|0x4
|u32
|Text Offset
|-
|0x68
|0x4
|Color4u8
|Font Top Color
|-
|0x6c
|0x4
|Color4u8
|Font Bottom Color
|-
|0x70
|0x8
|Vector2f
|Font Size
|-
|0x78
|0x4
|float
|Character Space
|-
|0x7c
|0x4
|float
|Line Space
|-
|0x80
|0x4
|u32
|Label Offset
|-
|0x84
|0x8
|Vector2f
|Shadow Translation
|-
|0x8c
|0x8
|Vector2f
|Shadow Size
|-
|0x94
|0x4
|Color4u8
|Shadow Top Color
|-
|0x98
|0x4
|Color4u8
|Shadow Bottom Color
|-
|0x9c
|0x4
|float
|Shadow Italic Tilt
|-
|0xa0
|0x4
|u32
|Line Transform Offset
|-
|0xa4
|0x4
|u32
|Per Character Transform Offset
|}

==== Line Transform (TODO) ====

==== Per Character Transform (TODO) ====

=== Window Pane (TODO) ===

=== Parts Pane ===
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x54
|Pane
|Magic: "prt1"
|-
|0x54
|0x4
|u32
|Property Count
|-
|0x58
|0x8
|Vector2f
|Magnification
|-
|0x60
|0x28 * Property Count
|Parts Property
|Property Array
|}

==== Parts Property ====
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x18
|char[0x18]
|Property Name
|-
|0x18
|0x1
|u8
|Usage Flag
|-
|0x19
|0x1
|u8
|Basic Usage Flag
|-
|0x1a
|0x1
|u8
|Material Usage Flag
|-
|0x1b
|0x1
|u8
|Reserved
|-
|0x1c
|0x4
|u32
|Pane Offset
|-
|0x20
|0x4
|u32
|User Data Offset
|-
|0x24
|0x4
|u32
|Pane Basic Info Offset
|}

==== Parts Pane Basic Info ====
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|char[0x8]
|User Name
|-
|0x8
|0xc
|Vector3f
|Position
|-
|0x14
|0xc
|Vector3f
|Rotation
|-
|0x20
|0x8
|Vector2f
|Scale
|-
|0x28
|0x8
|Vector2f
|Size
|-
|0x30
|0x1
|u8
|Pane Alpha
|}

=== Alignment Pane ===
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x54
|Pane
|Magic: "ali1"
|}

=== Capture Pane ===
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x54
|Pane
|Magic: "cpt1"
|}

=== Bounding Pane ===
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x54
|Pane
|Magic: "bnd1"
|}

=== Scissor Pane ===
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x54
|Pane
|Magic: "scr1"
|}

=== Group Start ===
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Ui2d Section Header
|Magic: "grs1"
|}

=== Group End ===
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Ui2d Section Header
|Magic: "gre1"
|}

=== Group ===
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Ui2d Section Header
|Magic: "grp1"
|-
|0x8
|0x21
|char[0x21]
|Group Name
|-
|0x29
|0x1
|u8
|Reserved
|-
|0x2a
|0x2
|u16
|Pane Count
|-
|0x2c
|0x18 * Pane Count
|char[ChildCount][0x18]
|Pane Name Array
|}

=== Control Source ===
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Ui2d Section Header
|Magic: "cnt1"
|-
|0x8
|0x4
|u32
|Name Offset
|-
|0xc
|0x4
|u32
|Name Array Offset
|-
|0x10
|0x2
|u16
|Pane Count
|-
|0x12
|0x2
|u16
|Anim Count
|-
|0x14
|0x4
|u32
|Pane Name Offset Array Offset
|-
|0x18
|0x4
|u32
|Anim Name Offset Array Offset
|-
|0x1c
|
|char[]
|Control Name
|}

AINB

2024-04-05T22:56:31Z

Watertoon: Change entry string to External Action

'''AINB''' ('''AI''' '''N'''ode '''B'''inary) is a file format used for AI and logic in ''Tears of the Kingdom'' as well as other recent Nintendo EPD games. This article is primarily aimed at the version that appears in ''Tears of the Kingdom'' and ''Super Mario Bros. Wonder'' (v0x0407). AINB files can be found in the AI, Logic, and Sequence folders of the romfs as well as within various packs.

=== File Structure ===
AINB is a little endian format similar to most Switch file formats. An AINB file consists of a set of interconnected nodes which act like a syntax tree and control the behavior of actors. These nodes can also be calls to external AINB files (known as modules), allowing AINB files to form entire trees of files. The root file of the tree will have <code>.root.ainb</code> as their extension while each module in the tree will have the extension <code>.module.ainb</code>. There are three primary categories of AINB files in ''TotK'': AI, Logic, and Sequence. For AI and Sequence files, the file's entry point is one or more commands which is linked to one or two child nodes. All nodes are accessed by their index (references to precondition nodes will use their precondition node index which is local to the amount of precondition nodes in the file).

All string offsets in the file are relative to the beginning of the string pool and name hashes are 32-bit murmur3 hashes. There are six possible types for AINB parameters: int (signed 32-bit integer), bool, float (32-bit), vector3f, and pointer. Pointer parameters are pointers to objects.

==== Section Order ====

# 0x74-Byte File Header
# Commands
# Nodes
# Local Blackboard Parameters
# Node Bodies
# Attachment Parameters
# Immediate Parameters
# Input/Output Parameters
# Multi-Parameters
# Resident Update Array
# 0x50 Section (Unused in ''TotK'')
# Precondition Nodes
# Expression Binary
# AINB Modules
# External Action Array
# File Hashes
# Child Replacement Table
# 0x6C Section
# Enum Resolve Array
# String Pool

=== Sections ===

==== File Header ====
AINB files begin with a 0x74 byte header. If the offset for a given section is empty, that section is not present in the file.
{| class="wikitable"
|+File Header
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|char[4]
|Magic - “AIB “
|-
|0x04
|0x04
|u32
|Version (0x0407 in ''TotK'', 0x0404 in ''S3'' and ''NSS'')
|-
|0x08
|0x04
|u32
|Filename Offset
|-
|0x0C
|0x04
|u32
|Command Count
|-
|0x10
|0x04
|u32
|Node Count
|-
|0x14
|0x04
|u32
|Precondition Node Count
|-
|0x18
|0x04
|u32
|Attachment Parameter Count
|-
|0x1C
|0x04
|u32
|Output Node Count
|-
|0x20
|0x04
|u32
|Local Blackboard Parameters Offset
|-
|0x24
|0x04
|u32
|String Pool Offset
|-
|0x28
|0x04
|u32
|Enum Resolve Array Offset
|-
|0x2C
|0x04
|u32
|Immediate Parameters Offset
|-
|0x30
|0x04
|u32
|Resident Update Array Offset
|-
|0x34
|0x04
|u32
|Input/Output Parameters Offset
|-
|0x38
|0x04
|u32
|Multi-Parameters Array Offset
|-
|0x3C
|0x04
|u32
|Attachment Parameters Offset
|-
|0x40
|0x04
|u32
|Attachment Parameters Index Array Offset
|-
|0x44
|0x04
|u32
|Expression Binary Section Offset
|-
|0x48
|0x04
|u32
|Child Replacement Table Offset
|-
|0x4C
|0x04
|u32
|Precondition Node Array Offset
|-
|0x50
|0x04
|u32
|Unknown (unused in ''TotK'', always the same as the Resident Update Array Offset)
|-
|0x54
|0x04
|u32
|Unknown (always 0)
|-
|0x58
|0x04
|u32
|Unknown (always 0, used in ''Splatoon 3''/''Nintendo Switch Sports'')
|-
|0x5C
|0x04
|u32
|AINB Modules Array Offset
|-
|0x60
|0x04
|u32
|File Category Name Offset
|-
|0x64
|0x04
|u32
|File Category (0 = AI, 1 = Logic, 2 = Sequence) - only ''TotK''
|-
|0x68
|0x04
|u32
|External Action Array Offset
|-
|0x6C
|0x04
|u32
|Unknown (Unused in ''TotK'')
|-
|0x70
|0x04
|u32
|File Identification Hashes Offset (Purpose Unknown)
|}

==== Command Array ====
The command array immediately follows the file header and is an array of all commands in the file.
{| class="wikitable"
|+Command Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Command Name Offset
|-
| rowspan="5" |0x04
| rowspan="5" |0x10
|u32
| rowspan="5" |GUID
|-
|u16
|-
|u16
|-
|u16
|-
|u8[6]
|-
|0x14
|0x02
|u16
|Left Node Index
|-
|0x16
|0x02
|u16
|Right Node Index (one greater than the corresponding node index)
|}
Command GUIDs are only used for debug messages. Right Node Index will be -1 if the command only has one child node.

==== Node Array ====
The node array immediately follows the command array and is an array of all nodes in the file.
{| class="wikitable"
|+Node Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x02
|u16
|Node Type Enum (see below)
|-
|0x02
|0x02
|u16
|Node Index
|-
|0x04
|0x02
|u16
|Attachment Parameters Count
|-
|0x06
|0x01
|bitfield
|Node Flags
|-
|0x07
|0x01
|u8
|
|-
|0x08
|0x04
|u32
|Node Type Name Offset (for UserDefined nodes)
|-
|0x0C
|0x04
|u32
|Name Hash (version 0x407 only)
|-
|0x10
|0x04
|u32
|
|-
|0x14
|0x04
|u32
|Node Body Offset (relative to the start of the file)
|-
|0x18
|0x02
|u16
|EXB Function Count
|-
|0x1A
|0x02
|u16
|EXB Input/Output Field Size
|-
|0x1C
|0x02
|u16
|Multi-Param Count
|-
|0x1E
|0x02
|u16
|
|-
|0x20
|0x04
|u32
|Base Attachment Parameter Index
|-
|0x24
|0x02
|u16
|Base Precondition Node
|-
|0x26
|0x02
|u16
|Precondition Node Count
|-
|0x28
|0x02
|u16
|0x58 Section Entry Offset (relative to the start of the file)
|-
|0x2A
|0x02
|u16
|
|-
| rowspan="5" |0x2C
| rowspan="5" |0x10
|u32
| rowspan="5" |GUID
|-
|u16
|-
|u16
|-
|u16
|-
|u8[6]
|}
Just like with commands, node GUIDs are only used for debug messages. The 0x58 section entry offset will be empty if unused.
{| class="wikitable"
|+Node Types
!Value (Hex)
!Value (Dec)
!Node Type
|-
|0x00
|0
|UserDefined
|-
|0x01
|1
|Element_S32Selector
|-
|0x02
|2
|Element_Sequential
|-
|0x03
|3
|Element_Simultaneous
|-
|0x04
|4
|Element_F32Selector
|-
|0x05
|5
|Element_StringSelector
|-
|0x06
|6
|Element_RandomSelector
|-
|0x07
|7
|Element_BoolSelector
|-
|0x08
|8
|Element_Fork
|-
|0x09
|9
|Element_Join
|-
|0x0A
|10
|Element_Alert
|-
|0x14
|20
|Element_Expression
|-
|0x64
|100
|Element_ModuleIF_Input_S32
|-
|0x65
|101
|Element_ModuleIF_Input_F32
|-
|0x66
|102
|Element_ModuleIF_Input_Vec3f
|-
|0x67
|103
|Element_ModuleIF_Input_String
|-
|0x68
|104
|Element_ModuleIF_Input_Bool
|-
|0x69
|105
|Element_ModuleIF_Input_Ptr
|-
|0xC8
|200
|Element_ModuleIF_Output_S32
|-
|0xC9
|201
|Element_ModuleIF_Output_F32
|-
|0xCA
|202
|Element_ModuleIF_Output_Vec3f
|-
|0xCB
|203
|Element_ModuleIF_Output_String
|-
|0xCC
|204
|Element_ModuleIF_Output_Bool
|-
|0xCD
|205
|Element_ModuleIF_Output_Ptr
|-
|0x012C
|300
|Element_ModuleIF_Child
|-
|0x0190
|400
|Element_StateEnd
|-
|0x01F4
|500
|Element_SplitTiming
|}
Node type names are official. For UserDefined nodes, node definitions can be found in a node definition files. This file is located at <code>NodeDefinition/Node.Product.[ver].aidefn.byml.zs</code> in the corresponding file category folder.
{| class="wikitable"
|+Node Type Descriptions
!Type
!Description
|-
|UserDefined
|Custom node type, definition in NodeDefinition
|-
|Element_S32Selector
|Conditionally links to a node depending on the value of a signed int
|-
|Element_Sequential
|Links to nodes sequentially in the order listed
|-
|Element_Simultaneous
|Links simultaneously to multiple nodes
|-
|Element_F32Selector
|Conditionally links to a node depending on the value of 32-bit float
|-
|Element_StringSelector
|Conditionally links to a node depending on the value of a string
|-
|Element_RandomSelector
|Links to a node randomly
|-
|Element_BoolSelector
|Conditionally links to a node depending on the value of a bool
|-
|Element_Fork
|See Resident Update Array
|-
|Element_Join
|See Resident Update Array
|-
|Element_Alert
|Displays a debug message
|-
|Element_Expression
|Passes values to and from EXB commands
|-
|Element_ModuleIF_Input_S32
|Receives a signed int input from the calling AINB file
|-
|Element_ModuleIF_Input_F32
|Receives a 32-bit float input from the calling AINB file
|-
|Element_ModuleIF_Input_Vec3f
|Receives a vector3f input from the calling AINB file
|-
|Element_ModuleIF_Input_String
|Receives a string input from the calling AINB file
|-
|Element_ModuleIF_Input_Bool
|Receives a bool input from the calling AINB file
|-
|Element_ModuleIF_Input_Ptr
|Receives an object pointer input from the calling AINB file
|-
|Element_ModuleIF_Output_S32
|Returns a signed int output from the module to the calling AINB file
|-
|Element_ModuleIF_Output_F32
|Returns a 32-bit float output from the module to the calling AINB file
|-
|Element_ModuleIF_Output_Vec3f
|Returns a vector3f output from the module to the calling AINB file
|-
|Element_ModuleIF_Output_String
|Returns a string output from the module to the calling AINB file
|-
|Element_ModuleIF_Output_Bool
|Returns a bool output from the module to the calling AINB file
|-
|Element_ModuleIF_Output_Ptr
|Returns an object pointer output from the module to the calling AINB file
|-
|Element_ModuleIF_Child
|Returns the node connection name from the module to the calling AINB file
|-
|Element_StateEnd
|Termination node, specifies what resident node to return to in the calling AINB file
|-
|Element_SplitTiming
|Changes when child nodes are run (Enter - first time visiting a node, Update - every frame, Leave - ran upon leaving the node)
|}
{| class="wikitable"
|+Node Flags
!Bits
!Description
|-
|1
|Is Precondition Node
|-
|1
|Is Module
|-
|1
|Is Resident Node
|-
|5
|
|}

==== Local Blackboard Parameters ====
This section contains an array of the Blackboard parameters used by file. These parameters may be sourced from external Blackboards or parameter files. The section begins with a 0x30 byte section header followed by the array of parameters, an array of default values of said parameters, and an array of file references if applicable. The order of parameters is in the order of string, int, float, bool, vector3f, and pointer. The section header contains six entries, one for each type.
{| class="wikitable"
|+Section Header Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x02
|u16
|Number of Entries of the Corresponding Data Type
|-
|0x02
|0x02
|u16
|Parameter Index of the First Entry of the Corresponding Data Type
|-
|0x04
|0x02
|u16
|Relative Offset of the First Entry of the Corresponding Data Type
|-
|0x06
|0x02
|u16
|
|}
{| class="wikitable"
|+Local Blackboard Parameter Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|bitfield
|Name Offset and Flags
|-
|0x04
|0x04
|u32
|String Offset (Notes)
|}
{| class="wikitable"
|+Name Offset Flags
!Bits
!Description
|-
|22
|Name Offset
|-
|1
|
|-
|1
|Does Not Have File Reference
|-
|7
|File Reference Index
|-
|1
|Is File Reference Valid
|}
The default value entries vary based on the parameter's data type. For int, float, and bool parameters, the entry is a four byte immediate value. String entries are a four byte string value offset. Vector3f entries are 12 bytes. Note that pointer parameters do not have default value entries and do not have default values.
{| class="wikitable"
|+File Reference Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|File Path Offset
|-
|0x04
|0x04
|u32
|File Path Hash
|-
|0x08
|0x04
|u32
|Filename Hash (no extension)
|-
|0x0C
|0x04
|u32
|File Extension Hash (no .)
|}

==== Node Bodies ====
Each node body is composed of two parts: a 0x90 byte parameter section and a 0x14 child node section header followed by said section if applicable. The child node section contains information about the child node and specific connection types. The following parameter indices are indices into the parameter array for that specific type and data type.
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Int Immediate Parameter Base Index
|-
|0x04
|0x04
|u32
|Int Immediate Parameter Count
|-
|0x08
|0x04
|u32
|Bool Immediate Parameter Base Index
|-
|0x0C
|0x04
|u32
|Bool Immediate Parameter Count
|-
|0x10
|0x04
|u32
|Float Immediate Parameter Base Index
|-
|0x14
|0x04
|u32
|Float Immediate Parameter Count
|-
|0x18
|0x04
|u32
|String Immediate Parameter Base Index
|-
|0x1C
|0x04
|u32
|String Immediate Parameter Count
|-
|0x20
|0x04
|u32
|Vector3f Immediate Parameter Base Index
|-
|0x24
|0x04
|u32
|Vector3f Immediate Parameter Count
|-
|0x28
|0x04
|u32
|Pointer Immediate Parameter Base Index
|-
|0x2C
|0x04
|u32
|Pointer Immediate Parameter Count
|-
|0x30
|0x04
|u32
|Int Input Parameter Base Index
|-
|0x34
|0x04
|u32
|Int Input Parameter Count
|-
|0x38
|0x04
|u32
|Int Output Parameter Base Index
|-
|0x3C
|0x04
|u32
|Int Output Parameter Count
|-
|0x40
|0x04
|u32
|Bool Input Parameter Base Index
|-
|0x44
|0x04
|u32
|Bool Input Parameter Count
|-
|0x48
|0x04
|u32
|Bool Output Parameter Base Index
|-
|0x4C
|0x04
|u32
|Bool Output Parameter Count
|-
|0x50
|0x04
|u32
|Float Input Parameter Base Index
|-
|0x54
|0x04
|u32
|Float Input Parameter Count
|-
|0x58
|0x04
|u32
|Float Output Parameter Base Index
|-
|0x5C
|0x04
|u32
|Float Output Parameter Count
|-
|0x60
|0x04
|u32
|String Input Parameter Base Index
|-
|0x64
|0x04
|u32
|String Input Parameter Count
|-
|0x68
|0x04
|u32
|String Output Parameter Base Index
|-
|0x6C
|0x04
|u32
|String Output Parameter Count
|-
|0x70
|0x04
|u32
|Vector3f Input Parameter Base Index
|-
|0x74
|0x04
|u32
|Vector3f Input Parameter Count
|-
|0x78
|0x04
|u32
|Vector3f Output Parameter Base Index
|-
|0x7C
|0x04
|u32
|Vector3f Output Parameter Count
|-
|0x80
|0x04
|u32
|Pointer Input Parameter Base Index
|-
|0x84
|0x04
|u32
|Pointer Input Parameter Count
|-
|0x88
|0x04
|u32
|Pointer Output Parameter Base Index
|-
|0x8C
|0x04
|u32
|Pointer Output Parameter Count
|}
{| class="wikitable"
|+Child Node Section Header
!Offset
!Size
!Type
!Description
|-
|0x00
|0x01
|u8
|Bool/float Input Source Node/Output Source Node Count
|-
|0x01
|0x01
|u8
|Bool/float Input Source Node/Output Source Node Base Index
|-
|0x02
|0x01
|u8
|Unknown Connection Type Count (Unused in ''TotK'')
|-
|0x03
|0x01
|u8
|Unknown Connection Type Base Index (Unused ''TotK'')
|-
|0x04
|0x01
|u8
|Standard Child Node Count
|-
|0x05
|0x01
|u8
|Standard Child Node Base Index
|-
|0x06
|0x01
|u8
|Resident Update Node Count
|-
|0x07
|0x01
|u8
|Resident Update Base Index
|-
|0x08
|0x01
|u8
|String Input Source Node Count
|-
|0x09
|0x01
|u8
|String Input Source Node Base Index
|-
|0x0A
|0x01
|u8
|Int Input Source Node Count
|-
|0x0B
|0x01
|u8
|Int Input Source Node Base Index
|-
|0x0C
|0x01
|u8
|Unknown Connection Type Count (Unused in ''TotK'')
|-
|0x0D
|0x01
|u8
|Unknown Connection Type Base Index (Unused ''TotK'')
|-
|0x0E
|0x01
|u8
|Unknown Connection Type Count (Unused in ''TotK'')
|-
|0x0F
|0x01
|u8
|Unknown Connection Type Base Index (Unused ''TotK'')
|-
|0x10
|0x01
|u8
|Unknown Connection Type Count (Unused in ''TotK'')
|-
|0x11
|0x01
|u8
|Unknown Connection Type Base Index (Unused ''TotK'')
|-
|0x12
|0x01
|u8
|Unknown Connection Type Count (Unused in ''TotK'')
|-
|0x13
|0x01
|u8
|Unknown Connection Type Base Index (Unused ''TotK'')
|}
If the node has any child nodes, the section header is followed by an array of u32 offsets to each of the child node entries. For most nodes, each entry is eight bytes.
{| class="wikitable"
|+Child Node Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Child Node Index
|-
|0x04
|0x04
|u32
|Value
|}
The interpretation of the value depends on the connection type. For input or output connections, the value is a string offset to the parameter name. For standard connections, the value is a string offset to the connection name. For resident update connections, the value is an index into the resident update array. Certain node/connection types will also extend the entry length. Selector-type nodes excluding <code>Element_BoolSelector</code> and <code>Element_F32Selector</code> will have an extra four bytes which stores the condition for to link to the child node. For <code>Element_S32Selector</code>, this is an immediate value. For <code>Element_RandomSelector</code>, this is a weight and for <code>Element_StringSelector</code> it is a u32 string offset. The condition for <code>Element_BoolSelector</code> is the entry's value string. <code>Element_F32Selector</code> adds 24 bytes to each entry, consisting of four eight-byte sub-entries.
{| class="wikitable"
|+<code>Element_F32Selector Condition Entry</code>
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Local Blackboard Parameter Index and Flags
|-
|0x04
|0x04
|float
|Condition Value
|}
The first two bytes of the four bytes at offset 0x00 are the local blackboard parameter index while the last bit is whether or not the index is used or not. The first entry for <code>Element_F32Selector</code> is the minimum value condition while the second entry is the maximum value condition. The last two entries appear to be unused. The last child node entry for Selector-type nodes is the default case. The condition for this case is either a string offset to the string その他 ("Other") or 0 (in the case of <code>Element_S32Selector</code>). Input nodes that are Selector-type nodes also appear to have an additional eight bytes (purpose unknown). <code>Element_Expression</code> have an additional eight bytes per input node (16 bytes in the case of vector3f entries). The purpose of these bytes is unknown.

==== Attachment Parameters ====
This section contains an array of attachments for nodes. This section is preceded by the attachment index array which is an array of u32 indices into the entries in this section. Nodes contain an index into the index array rather than directly into this section. The section contains an array of entries followed by an array of parameter entries.
{| class="wikitable"
|+Attachment Parameter Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Name Offset
|-
|0x04
|0x04
|u32
|Parameters Entry Offset
|-
|0x08
|0x02
|u16
|EXB Function Count
|-
|0x0A
|0x02
|u16
|EXB Input/Output Field Size
|-
|0x0C
|0x04
|u32
|Name Hash (version 0x0407 only)
|}
{| class="wikitable"
|+Parameter Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Unknown (possibly related to debug)
|-
|0x04
|0x04
|u32
|Int Immediate Parameter Base Index
|-
|0x08
|0x04
|u32
|Int Immediate Parameter Count
|-
|0x0C
|0x04
|u32
|Bool Immediate Parameter Base Index
|-
|0x10
|0x04
|u32
|Bool Immediate Parameter Count
|-
|0x14
|0x04
|u32
|Float Immediate Parameter Base Index
|-
|0x18
|0x04
|u32
|Float Immediate Parameter Count
|-
|0x1C
|0x04
|u32
|String Immediate Parameter Base Index
|-
|0x20
|0x04
|u32
|String Immediate Parameter Count
|-
|0x24
|0x04
|u32
|Vector3f Immediate Parameter Base Index
|-
|0x28
|0x04
|u32
|Vector3f Immediate Parameter Count
|-
|0x2C
|0x04
|u32
|Pointer Immediate Parameter Base Index
|-
|0x30
|0x04
|u32
|Pointer Immediate Parameter Count
|-
|0x34
|0x04
|u32
|
|-
|0x38
|0x04
|u32
|Unknown (contains address to next entry)
|-
|0x3C
|0x04
|u32
|
|-
|0x40
|0x04
|u32
|Unknown (contains address to next entry)
|-
|0x44
|0x04
|u32
|
|-
|0x48
|0x04
|u32
|Unknown (contains address to next entry)
|-
|0x4C
|0x04
|u32
|
|-
|0x50
|0x04
|u32
|Unknown (contains address to next entry)
|-
|0x54
|0x04
|u32
|
|-
|0x58
|0x04
|u32
|Unknown (contains address to next entry)
|-
|0x5C
|0x04
|u32
|
|-
|0x60
|0x04
|u32
|Unknown (contains address to next entry)
|}

==== Immediate Parameters ====
This section contains an array of immediate parameters for nodes. The section begins with a six u32 relative offsets to the first entry for each data type. The data type order for this section is int, bool, float, string, vector3f, and pointer.
{| class="wikitable"
|+Parameter Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Name Offset
|-
|0x04
|0x04
|u32
|Flags
|-
|0x08
|
|
|Value
|}
The value is an immediate value for the data type (excluding string which is a string offset and pointer which doesn't store a value). Pointer entries also have an additional u32 class name offset at offset 0x04, pushing the flags to offset 0x08.
{| class="wikitable"
|+Parameter Flags
!Bits
!Description
|-
|16
|Source Index
|-
|1
|Is Use Index
|-
|1
|Is Not Local Blackboard Index
|-
|1
|
|-
|1
|
|-
|1
|
|-
|1
|
|-
|1
|Is EXB Index
|-
|1
|Pulse Thread Local Storage
|-
|1
|Set Pointer Flag Bit Zero
|-
|2
|
|-
|2
|
|-
|2
|
|}

==== Input/Output Parameters ====
This section contains an array of input and output parameter entries. Similarly to the immediate parameters section, the section begins with u32 relative offsets to the first entry of each data type. However, instead of six offsets, there are 12 - two for each data type (one input, one output). The order of parameters in this section is int input, int output, bool input, bool output, float intput, float output, string input, string output, vector3f input, vector3f output, pointer input, and pointer output.
{| class="wikitable"
|+Input Parameter Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Name Offset
|-
|0x04
|0x02
|s16
|Input Child Node Index / Multi-Parameter Array Base Index
|-
|0x06
|0x02
|s16
|Input/Output Source Node Index / Multi-Parameter Count
|-
|0x08
|0x04
|u32
|Flags
|-
|0x0C
|
|
|Default Value
|}
The default value is an immediate value for the data type (excluding string which is a string offset and pointer which is always an empty four bytes). Pointer entries also have an additional u32 class name offset at offset 0x04, pushing the rest of the entry back by four bytes. If the input child node index is between -32768 and -100, it corresponds to a multi-parameter array index. The multi-parameter index can be calculated as follows: <code>MultiParamIndex = -100 - Index</code>.
{| class="wikitable"
|+Parameter Flags
!Bits
!Description
|-
|16
|Source Index
|-
|1
|Is Use Index
|-
|1
|Is Not Local Blackboard Index
|-
|1
|
|-
|1
|
|-
|1
|
|-
|1
|
|-
|1
|Is EXB Index
|-
|1
|Pulse Thread Local Storage
|-
|1
|Set Pointer Flag Bit Zero
|-
|2
|
|-
|2
|
|-
|2
|
|}
Each output parameter entry is four bytes.
{| class="wikitable"
|+Output Parameter Entry
!Bits
!Description
|-
|31
|Name Offset
|-
|1
|Set Pointer Flag Bit Zero
|}

==== Multi-Parameters ====
This section contains entries specifying parameters that have multiple values and the sources of those values. Each entry is eight bytes.
{| class="wikitable"
|+Multi-Parameter Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x02
|u16
|Node Index
|-
|0x02
|0x02
|u16
|Input/Output Source Parameter Index
|-
|0x04
|0x04
|u32
|Flags
|}
{| class="wikitable"
|+Parameter Flags
!Bits
!Description
|-
|16
|Source Index
|-
|1
|Is Use Index
|-
|1
|Is Not Local Blackboard Index
|-
|1
|
|-
|1
|
|-
|1
|
|-
|1
|
|-
|1
|Is EXB Index
|-
|1
|Pulse Thread Local Storage
|-
|1
|Set Pointer Flag Bit Zero
|-
|2
|
|-
|2
|
|-
|2
|
|}

==== Resident Update Array ====
This section is an array of entries for resident nodes that are updated mid-node update sequence. The first four bytes specify the number of entries. Each entry is four bytes.
{| class="wikitable"
|+
!Bits
!Description
|-
|8
|Is Valid Update
|-
|23
|
|-
|1
|Update Post Current Command Calculation
|}
If the first byte of the flags is set to false, then the entry contains another four bytes with a string offset (purpose unknown). By default, the node is scheduled to update pre-next command calculation, however, this can change depending on the flags set. Additionally, Fork and Join nodes behave differently. Fork nodes will append the node to the run array while Join nodes will update the node post-current command calculation.

==== 0x50 Section ====
This section is unused in ''Tears of the Kingdom''.

==== Precondition Nodes Array ====
This section is an array of entries of precondition nodes present in the file.
{| class="wikitable"
|+Precondition Node Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x02
|u16
|Precondition Node Index (local to number of precondition nodes)
|-
|0x02
|0x02
|u16
|
|}

==== Expression Binary Section ====
The '''EXB''' ('''Ex'''pression '''B'''inary) section is a completely self-contained section that stores custom instructions for a simple command processor. These instructions are grouped into functions that can be called by nodes to perform calculations. Because the section is self-contained, all offsets in this section are local to the section. The EXB section is shared with ASB files ('''A'''nimation '''S'''equence '''B'''inary).

===== Section Structure =====
EXB is essentially its own format and allows for the storage of custom functions in files.

====== Section Order ======

# 0x2C-Byte Header
# Command Info Table
# Instructions Table
# Parameter Region
# Signature Table
# String Pool

===== Sub-Sections =====

====== Header ======
{| class="wikitable"
|+EXB Header
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|char[4]
|Magic - “EXB “
|-
|0x04
|0x04
|u32
|Version (0x02)
|-
|0x08
|0x04
|u32
|Static Memory Allocation Size
|-
|0x0C
|0x04
|u32
|Parameter EXB Field Entry Count
|-
|0x10
|0x04
|u32
|32-bit Scratch Allocation Size
|-
|0x14
|0x04
|u32
|64-bit Scratch Allocation Size
|-
|0x18
|0x04
|u32
|Command Info Offset
|-
|0x1C
|0x04
|u32
|Command Table Offset
|-
|0x20
|0x04
|u32
|Signature Table Offset
|-
|0x24
|0x04
|u32
|Parameter Region Offset
|-
|0x28
|0x04
|u32
|String Pool Offset
|}

====== Command Info Table ======
This section contains an array of command (function) info entries. The first four bytes specify the entry count.
{| class="wikitable"
|+Command Info Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|s32
|Base Index Pre-Command Entry
|-
|0x04
|0x04
|u32
|Pre-Entry Static Memory Usage
|-
|0x08
|0x04
|u32
|Instruction Base Index
|-
|0x0C
|0x04
|u32
|Instruction Count
|-
|0x10
|0x04
|u32
|Static Memory Size
|-
|0x14
|0x02
|u16
|32-bit Scratch Memory Size
|-
|0x16
|0x02
|u16
|64-bit Scratch Memory Size
|-
|0x18
|0x02
|u16
|Output Data Type Enum
|-
|0x1A
|0x02
|u16
|Input Data Type Enum
|}
{| class="wikitable"
|+Data Type Enum
!Value (Hex)
!Value (Dec)
!Data Type
|-
|0x0
|0
|No Data
|-
|0x1
|1
|Immediate Value/From User
|-
|0x02
|2
|bool
|-
|0x03
|3
|int
|-
|0x04
|4
|float
|-
|0x05
|5
|string
|-
|0x06
|6
|vector3f
|}

====== Instructions Table ======
This section contains an array of instruction entries which are read by the EXB command processor. The first four bytes specify the entry count.
{| class="wikitable"
|+Instruction Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x01
|u8
|Instruction Type
|-
|0x01
|0x01
|u8
|Data Type Enum
|-
|0x02
|0x01
|u8
|Left-Hand Side Parameter Source Enum
|-
|0x03
|0x01
|u8
|Right-Hand Side Parameter Source Enum
|-
|0x04
|0x02
|u16
|Left-Hand Side Parameter Value
|-
|0x06
|0x02
|u16
|Right-Hand Side Parameter Value
|}
For UserDefined type instructions, the bytes at offset 0x02-0x04 become a u16 static memory index and the bytes at 0x04-0x08 become a u32 index into the function signatures table.
{| class="wikitable"
|+Instruction Types
!Value (Hex)
!Value (Dec)
!Instruction Type
|-
|0x01
|1
|Terminator
|-
|0x02
|2
|Store
|-
|0x03
|3
|Negate
|-
|0x04
|4
|NegateBool
|-
|0x05
|5
|Add
|-
|0x06
|6
|Subtract
|-
|0x07
|7
|Multiply
|-
|0x08
|8
|Divide
|-
|0x09
|9
|Modulus
|-
|0x0A
|10
|Increment
|-
|0x0B
|11
|Decrement
|-
|0x0C
|12
|ScalarMultiplyVec3f
|-
|0x0D
|13
|ScalarDivideVec3f
|-
|0x0E
|14
|LeftShift
|-
|0x0F
|15
|RightShift
|-
|0x10
|16
|LessThan
|-
|0x11
|17
|LessThanEqual
|-
|0x12
|18
|GreaterThan
|-
|0x13
|19
|GreaterThanEqual
|-
|0x14
|20
|Equal
|-
|0x15
|21
|NotEqual
|-
|0x16
|22
|AND
|-
|0x17
|23
|XOR
|-
|0x18
|24
|OR
|-
|0x19
|25
|LogicalAND
|-
|0x1A
|26
|LogicalOR
|-
|0x1B
|27
|UserFunction
|-
|0x1C
|28
|JumpIfLHSZero
|-
|0x1D
|29
|Jump
|}
UserFunctions are mapped to a function in the executable by function signature. There are two types of these functions: direct and object. Direct functions are straightforward functions that take up to two arguments and are matched using the function signature. Function objects can take additional arguments and are indexed at runtime.

{| class="wikitable"
|+Data Type Enum
!Value (Hex)
!Value (Dec)
!Data Type
|-
|0x0
|0
|No Data
|-
|0x1
|1
|Immediate Value/From User
|-
|0x02
|2
|bool
|-
|0x03
|3
|int
|-
|0x04
|4
|float
|-
|0x05
|5
|string
|-
|0x06
|6
|vector3f
|}
{| class="wikitable"
|+Parameter Source Enum
!Value (Hex)
!Value (Dec)
!Parameter Source
|-
|0x00
|0
|Immediate Parameters
|-
|0x01
|1
|Immediate Parameters (String)
|-
|0x02
|2
|Static Memory
|-
|0x03
|3
|Parameters Region
|-
|0x04
|4
|Parameters Region (String)
|-
|0x05
|5
|Output Value
|-
|0x06
|6
|Input Value
|-
|0x07
|7
|32-bit Scratch
|-
|0x08
|8
|64-bit Scratch
|-
|0x09
|9
|UserOutput
|-
|0x0A
|10
|UserInput
|}
UserCallback is a class that contains virtual functions providing memory allocation. The input value is passed from the calling node and the output value is passed back.

====== Parameter Region ======
The parameter region is a region that stores the values for parameters values that are too large to fit into two bytes. Parameters that get their values from this section instead store an offset relative to the beginning of the parameter region to the start of the value.

====== Signatures Table ======
This section is an array of u32 string offsets for each function signature.

====== String Pool ======
The string pool is an array of null-terminated strings encoded with UTF-8. All string offsets in this section are relative to the beginning of the string pool.

==== AINB Modules ====
This section contains an array of all AINB modules linked to the current AINB file. The first four bytes specify the entry count.
{| class="wikitable"
|+AINB Module Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|File Path Offset
|-
|0x04
|0x04
|u32
|File Category Offset
|-
|0x08
|0x04
|u32
|AINB File Count
|}

==== External Action Array ====
This section appears to interact with XLink. The first four bytes specify the entry count.
{| class="wikitable"
|+Entry String Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Node Index
|-
|0x04
|0x04
|u32
|String 1 Offset (always メインステート ("Main State"))
|-
|0x08
|0x04
|u32
|State Name Offset
|}

==== File Hashes ====
This section contains two 32-bit file hashes. The first hash is a hash for the file itself and the second hash appears to be a hash for that file's parent file. The purpose of these hashes is unclear.

==== Child Replacement Table ====
This section is used to remove or replace specific nodes or attachments at runtime. This is used to toggle of debug nodes/attachments for release builds. The section begins with an eight-byte section header.
{| class="wikitable"
|+Child Replacement Section Header
!Offset
!Size
!Type
!Description
|-
|0x00
|0x01
|u8
|Initialization Guard (Is Initialized)
|-
|0x01
|0x01
|u8
|
|-
|0x02
|0x02
|u16
|Replacement Count
|-
|0x04
|0x02
|s16
|Override Node Count
|-
|0x06
|0x02
|s16
|Override Attachment Parameter Count
|}
{| class="wikitable"
|+Child Replacement Table Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x01
|u8
|Replacement Type Enum (0 = remove child node, 1 = replace child node, 2 = remove attachment)
|-
|0x01
|0x01
|u8
|
|-
|0x02
|0x02
|u16
|Node Index
|-
|0x04
|0x02
|u16
|Child Node Index/Attachment Index
|-
|0x06
|0x02
|u16
|New Node Index (for child node replacements)
|}

==== 0x6C Section ====
This section is unused in ''Tears of the Kingdom''.

==== Enum Resolve Array ====
This section is used to resolve enum values at runtime. This section is unused in ''Tears of the Kingdom'' as all enum values are statically present in the file. However, in ''Splatoon 3'', this section is used extensively as all enum values are stored in the main executable. The first four bytes of this section specifies the number of entries in the section.
{| class="wikitable"
|+Enum Resolve Array Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Enum Value Offset
|-
|0x04
|0x04
|u32
|Enum Class Name Offset
|-
|0x08
|0x04
|u32
|Enum Value Name Offset
|}

==== String Pool ====
The string pool is an array of null-terminated strings encoded with UTF-8. All string offsets in the file are relative to the first byte of this section. Note that this section also contains some unreferenced strings which are the enums for certain parameters.
[[Category:File formats]]

Phive

2024-04-05T22:36:25Z

Watertoon: add category

Phive is Nintendo's physics library built on top of an external physics library, either Havok or PhysX 3.4 have been observed. The PhysX branch doesn't implement the full feature set and is unused by the game it appears in. The library has an optional cloth and navigation mesh extension. It's responsible for providing actors many different physics controllers in a ControllerSet.

=== PhiveBackEnd ===
This is a manager responsible for bootstrapping and handling the memory management of the external physics library.

=== PhiveConfig ===
This is a global manager of the application's phive settings.

=== DynamicsFramework ===
This is the main application manager for phive. It provides an additional set of managers.

=== ControllerSetBinder ===

=== ControllerSetConfig ===

=== ControllerSet ===
This is a set of all physics controller for an actor. Wrapped by ModuleSystem's PhysicsComponent.

=== CharacterController ===
Character controllers put the hands of physics into the game developers. The game can extend character controllers with Update, Result, MoveState, and External components.

==== CharacterProperty ====

==== CharacterMatterRigidBodyEntity ====
Extension of RigidBodyEntity for character controllers.
{| class="wikitable"
|+Matter Rigid Body Specific Request Types
!Name
!Function Arguments
!Description
|-
|ChangeIsRigidBodyMode
|
|Appears to toggle whether the rigid body is treated as such?
|-
|SetAngularVelocity
|
|Extension to base request.
|-
|SetLinearVelocity
|
|Extension to base request.
|-
|SetPositionAndRotation
|
|Extension to base request.
|}

==== CharacterParam ====

==== CharacterUpdate ====

==== CharacterMoveState ====

==== CharacterResult ====

==== CharacterExternal ====

=== RigidBodyControllerEntity ===
Top level controller for a RigidBodyEntity.

=== RigidBodyControllerSensor ===
Top level controller for a RigidBodySensor.

=== RigidBody ===
The base RigidBody class. The game can file change requests for a RigidBody which will be applied in the next frame.
{| class="wikitable"
|+Known Request Types (unofficial)
!Name
!Function Arguments
!Description
|-
|AddToWorld
|
|Adds RigidBody as a member of their respective Physics world
|-
|RemoveFromWorld
|
|
|-
|NoHit
|
|
|-
|ChangeCollisionQuality
|
|
|-
|ChangeEnableHitRayCast
|
|
|-
|ChangeLayerMask
|
|
|-
|ChangeMotionType
|
|
|-
|ChangeShape
|
|
|-
|SetLayer
|
|
|-
|SetLayerMask
|
|
|-
|SetAngularVelocity
|
|
|-
|SetLinearVelocity
|
|
|-
|SetPositionAndRotation
|
|
|-
|SetSubLayer
|
|
|}

=== RigidBodyEntity ===
These are rigid bodies that exist for the purpose of being a physical object.

=== RigidBodyEntityForceField ===

=== RigidBodySensor ===
These are rigid bodies that exist for the purpose of sensing.

=== ContactCollectionEntity ===

=== ContactCollectionSensor ===

=== Shape ===
Shapes are used to provide form to a RigidBody
{| class="wikitable"
|+ShapeType Enum (official)
!Name
!Value
!Description
|-
|Sphere
|0
|
|-
|Capsule
|1
|
|-
|Polytope
|2
|A shape created out of an array of vertices
|-
|Box
|3
|
|-
|Cylinder
|4
|
|-
|Cone
|5
|
|-
|CharacterPrism
|6
|
|-
|Compound
|7
|Combines other shapes into one
|-
|Mesh
|8
|A shape created from the mesh of a Bphsh file
|-
|HeightField
|9
|Base class for all height fields
|-
|HeightFieldBox
|10
|Used in Bphsc for Water
|-
|HeightFieldSphere
|11
|
|-
|HeightFieldCylinder
|12
|Used in Bphsc for Water
|-
|HeightFieldQuadrant
|13
|Used in Bphsc for Water
|-
|HeightFieldVertices
|14
|
|-
|StaticCompound
|15
|Used in Bphsc for compound shapes
|-
|SDFSurfaceOfRevolution
|16
|
|-
|SDFHeightField
|17
|
|-
|Dummy
|18
|
|}

=== ConstraintController ===

=== Constraint ===
{| class="wikitable"
|+Constraint types (unofficial table)
!Name
!Description
|-
|BallAndSocket
|
|-
|CogWheel
|
|-
|Fixed
|
|-
|FreeSlider
|
|-
|Hinge
|
|-
|Pulley
|
|-
|RackAndPinion
|
|-
|Range
|
|-
|Slider
|
|-
|SpringDamper
|
|}

=== Placement ===

=== StaticCompoundController ===

=== Extension ===

==== RopeExtension ====

==== PhiveEntityControlExtension ====

=== GraphicsControllerSet ===
This is a sub controller set of phive::ControllerSet responsible for physics controllers used for graphical effects.

=== LookingController ===

=== LookIKController ===

=== EyeTextureScrollController ===

=== EyeTexturePatternController ===

=== HelperBone ===

=== Cloth ===

=== RagdollStructure ===

=== FishBoneController ===

=== TailBoneController ===

=== FootIK ===

=== HandIK ===

=== SnakeIK ===

=== BoneModifier ===

=== ModelController ===

=== NavMeshCharacter ===
[[Category:Software stack]]

Phive

2024-04-05T22:34:51Z

Watertoon: Outline the classes of phive

Phive is Nintendo's physics library built on top of an external physics library, either Havok or PhysX 3.4 have been observed. The PhysX branch doesn't implement the full feature set and is unused by the game it appears in. The library has an optional cloth and navigation mesh extension. It's responsible for providing actors many different physics controllers in a ControllerSet.

=== PhiveBackEnd ===
This is a manager responsible for bootstrapping and handling the memory management of the external physics library.

=== PhiveConfig ===
This is a global manager of the application's phive settings.

=== DynamicsFramework ===
This is the main application manager for phive. It provides an additional set of managers.

=== ControllerSetBinder ===

=== ControllerSetConfig ===

=== ControllerSet ===
This is a set of all physics controller for an actor. Wrapped by ModuleSystem's PhysicsComponent.

=== CharacterController ===
Character controllers put the hands of physics into the game developers. The game can extend character controllers with Update, Result, MoveState, and External components.

==== CharacterProperty ====

==== CharacterMatterRigidBodyEntity ====
Extension of RigidBodyEntity for character controllers.
{| class="wikitable"
|+Matter Rigid Body Specific Request Types
!Name
!Function Arguments
!Description
|-
|ChangeIsRigidBodyMode
|
|Appears to toggle whether the rigid body is treated as such?
|-
|SetAngularVelocity
|
|Extension to base request.
|-
|SetLinearVelocity
|
|Extension to base request.
|-
|SetPositionAndRotation
|
|Extension to base request.
|}

==== CharacterParam ====

==== CharacterUpdate ====

==== CharacterMoveState ====

==== CharacterResult ====

==== CharacterExternal ====

=== RigidBodyControllerEntity ===
Top level controller for a RigidBodyEntity.

=== RigidBodyControllerSensor ===
Top level controller for a RigidBodySensor.

=== RigidBody ===
The base RigidBody class. The game can file change requests for a RigidBody which will be applied in the next frame.
{| class="wikitable"
|+Known Request Types (unofficial)
!Name
!Function Arguments
!Description
|-
|AddToWorld
|
|Adds RigidBody as a member of their respective Physics world
|-
|RemoveFromWorld
|
|
|-
|NoHit
|
|
|-
|ChangeCollisionQuality
|
|
|-
|ChangeEnableHitRayCast
|
|
|-
|ChangeLayerMask
|
|
|-
|ChangeMotionType
|
|
|-
|ChangeShape
|
|
|-
|SetLayer
|
|
|-
|SetLayerMask
|
|
|-
|SetAngularVelocity
|
|
|-
|SetLinearVelocity
|
|
|-
|SetPositionAndRotation
|
|
|-
|SetSubLayer
|
|
|}

=== RigidBodyEntity ===
These are rigid bodies that exist for the purpose of being a physical object.

=== RigidBodyEntityForceField ===

=== RigidBodySensor ===
These are rigid bodies that exist for the purpose of sensing.

=== ContactCollectionEntity ===

=== ContactCollectionSensor ===

=== Shape ===
Shapes are used to provide form to a RigidBody
{| class="wikitable"
|+ShapeType Enum (official)
!Name
!Value
!Description
|-
|Sphere
|0
|
|-
|Capsule
|1
|
|-
|Polytope
|2
|A shape created out of an array of vertices
|-
|Box
|3
|
|-
|Cylinder
|4
|
|-
|Cone
|5
|
|-
|CharacterPrism
|6
|
|-
|Compound
|7
|Combines other shapes into one
|-
|Mesh
|8
|A shape created from the mesh of a Bphsh file
|-
|HeightField
|9
|Base class for all height fields
|-
|HeightFieldBox
|10
|Used in Bphsc for Water
|-
|HeightFieldSphere
|11
|
|-
|HeightFieldCylinder
|12
|Used in Bphsc for Water
|-
|HeightFieldQuadrant
|13
|Used in Bphsc for Water
|-
|HeightFieldVertices
|14
|
|-
|StaticCompound
|15
|Used in Bphsc for compound shapes
|-
|SDFSurfaceOfRevolution
|16
|
|-
|SDFHeightField
|17
|
|-
|Dummy
|18
|
|}

=== ConstraintController ===

=== Constraint ===
{| class="wikitable"
|+Constraint types (unofficial table)
!Name
!Description
|-
|BallAndSocket
|
|-
|CogWheel
|
|-
|Fixed
|
|-
|FreeSlider
|
|-
|Hinge
|
|-
|Pulley
|
|-
|RackAndPinion
|
|-
|Range
|
|-
|Slider
|
|-
|SpringDamper
|
|}

=== Placement ===

=== StaticCompoundController ===

=== Extension ===

==== RopeExtension ====

==== PhiveEntityControlExtension ====

=== GraphicsControllerSet ===
This is a sub controller set of phive::ControllerSet responsible for physics controllers used for graphical effects.

=== LookingController ===

=== LookIKController ===

=== EyeTextureScrollController ===

=== EyeTexturePatternController ===

=== HelperBone ===

=== Cloth ===

=== RagdollStructure ===

=== FishBoneController ===

=== TailBoneController ===

=== FootIK ===

=== HandIK ===

=== SnakeIK ===

=== BoneModifier ===

=== ModelController ===

=== NavMeshCharacter ===

ModuleSystem

2024-04-05T10:31:00Z

Watertoon: Start a general synopsis

ModuleSystem is the unofficial name of Nintendo EPD's latest game engine, based on the name of the singular sead::Task at the heart of the mainloop. It's actor system appears to be a sequel in design to KingSystem, the engine created for The Legend of Zelda: Breath of the Wild. ModuleSystem appears to have replaced both ActionLibrary and LunchPack2 as the new primary engine for Nintendo EPD's and NST's game development teams. While each game shares a common set of engine features, each series appears to have a custom fork extending the engine with varying degrees of game specific functionality.

=== Games ===
{| class="wikitable"
|+
!Name
!Extension/Differences summary
|-
|Nintendo Switch Sports
|Graphics Module contains a Mii data manager.
|-
|Splatoon 3
|ModuleSystem is extended to thunder::ModuleSystem, notably adding the ability to run the CPU side of the mainloop multiple times per frame. Omits gamedata for a custom save system.
|-
|The Legend of Zelda: Tears of the Kingdom
|Major version up from Splatoon 3 and Nintendo Switch Sports. Some engine namespaces were updated between version 1.0.0 and 1.1.0. Includes the TerrainModule and LODModule, while most other games only contain references to these systems.
|-
|Super Mario Wonder
|Some libraries are newer than Tears of the Kingdom, some are older.
|-
|Mario Vs Donkey Kong
|Appears to be slightly behind version of Tears of the Kingdom. IActor has a new Stasus state used when swapping actors between "combined scenes". Replaces physics handling with a custom 2d physics engine, yet leaves the PhysicsModule with an unused version of the phive library implemented on top of PhysX instead of Havok.
|}

=== Namespaces ===
The top level namespace for ModuleSystem is engine. Sub-namespaces typically include a module wrapping a system for a dedicated purpose, whether unique to the engine or contracted out to an external library. Interfaces to the system are typically provided to Actors or Scenes.
{| class="wikitable"
|+
!Namespace
!Description
|-
|actor
|Implements the actor system.
|-
|ai
|Wraps the ai library. Integrates with PreActors through ActorAIGroups, ActorBase through the AIComponent, and IScene through the SequenceComponent.
|-
|as
|Wraps the as library. Integrates with ActorBase through the RetargetScaleComponent, ASInfoComponent, ASOptimizeComponent, and ASComponent.
|-
|bake
|Wraps the bake library.
|-
|banc
|Implements BancEntities via the BancModule. Banc handles the parsing of map units into PreActors, actor ai groups, rails, placement groups, far delete groups, and custom game extensions.
|-
|bb (Unofficial)
|Wraps the bb library, responsible for managing bb::Blackboards. Integrates with ActorBase through BlackboardComponentActor and IScene with BlackboardComponentScene.
|-
|camera
|Implements a camera system. Integrates with ActorBase via the CameraComponent.
|-
|component
|Houses all engine components from the other namespaces for engine::actor::ActorBase and engine::scene::IScene.
|-
|controller
|Implements a controller manager.
|-
|debug
|Stubbed in retail. Seemingly implements a debug menu called "ClickMenu".
|-
|effect
|Wraps shaft::effect for managing effect resources.
|-
|erepo (unofficial)
|Wraps the erepo library for PlayReport management.
|-
|event
|Implements an event system on top of the evfl library for Event Flows and Timelines, and the sdk movie library for prerendered video. Integrates with ActorBase through the BeforehandLoadEventComponent, EventMemberComponent, and EventPerformerComponent.
|-
|framework
|Implements a minor extension to sead::GameFrameworkNx, and the SpStepRateMgr.
|-
|gamedata
|Wraps the gmd library for managing a global, computable, and savable hash map of game data.
|-
|graphics (unofficial)
|Wraps the gsys library, which extends the agl library. Integrates with ActorBase through the ModelComponent and ModelBindComponent.
|-
|lod
|Implements a level of detail system. Integrates with ActorBase through the LODComponent.
|-
|lua
|Stubbed in retail. Provides lua support for debugging purposes.
|-
|module
|Implements the ModuleSystem sead::Task, as well as the IModule interface.
|-
|physics
|Wraps the phive library. Integrates with ActorBase through the PhysicsComponent.
|-
|rail
|Implements the RailMgr, manages rails parsed from banc.
|-
|reaction
|Implements a system for triggering reactions through reaction actors and XLink commands somehow (unknown at time of writing). Integrates with ActorBase via the ReactionComponent.
|-
|resource
|Wraps the ares library and implements ares::IApplicationImpl to provide asynchronous file resource management through ResourceBinders. Also wraps the pp library and implements pp::GfMgrCallback to provide a general parameter system via hierarchical Documents.
|-
|rsdb
|Wraps the pp::rsdb sub library. Manages a set of engine as well as game extended resource databases.
|-
|rumble
|Implements a rumble call system to allow sending vibrations to controllers.
|-
|scene
|Implements the scene system.
|-
|sound
|Wraps the alto library, which extends the aal library, which extends the aal::atom sub library.
|-
|system
|Implements the RomConfigMgr and PauseMgr
|-
|terrain
|Wraps the tera library. Provides terrain management.
|-
|transceiver (unofficial)
|Implements a transceiver based message systems. Messages can be sent to directly to a destination, or to a whole set of listeners.
|-
|ui
|Wraps the eui library, which in turn extends nn::ui2d. Provides ui processing and resource management through a layout category based system.
|-
|xlink
|Wraps the xlink2 library. Implements an XLink PreActor Manager. Integrates with ActorBase through the ELinkComponent, SLinkComponent, XLinkComponent, and XLinkSubComponent.
|}

=== Non-Canon Namespaces ===
These are engine namespaces, that for one reason or another, appear to be game specific extensions.
{| class="wikitable"
|+
!Name
!Game(s)
!Description
|-
|coll2d
|Mario Vs Donkey Kong
|Implements a 2d collision system the game uses instead of phive.
|-
|level
|Mario Vs Donkey Kong
|
|-
|message
|Mario Vs Donkey Kong
|
|-
|move2d
|Mario Vs Donkey Kong
|Implements a 2d movement system.
|}

=== Main Loop ===
The mainloop is implemented as a single sead::Task in the standard sead::GameFrameworkNx mainloop. The mainloop consists of 4 sead::DependencyJobGraph's submitted and ran in a sead::DependencyJobWorkerMgr in succession. These are unofficially called as of writing BeforeActor, AfterActor, GSys, and GSysCalcGpu.
[[Category:Engines]]

Rsizetable

2024-02-19T00:26:19Z

Watertoon: Improve wording

The resource size table is an ares file format managed by ares::ResourceSizeTable. '''The earliest revision has no header''', only containing the crc32b array, the size of array is implicitly calculated. Succeeded by a version with a 0xc byte header and an optional array of fixed size file path + resource size pairs for file paths that would produce a hash collision (default fixed size of that game's max path). Since succeeded by a version with a new 0x16 byte header, the 0x6 byte magic makes all subsequent u32 values unaligned.

=== Header (revision 1) ===
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Magic ("RSTB" in big-endian)
|-
|0x4
|0x4
|u32
|Crc32b resource size pair count
|-
|0x8
|0x4
|u32
|Path resource size pair count
|}

=== Header (revision 2) ===
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x6
|u32
|Magic ("RESTBL" in big-endian)
|-
|0x6
|0x4
|u32
|Version
|-
|0xa
|0x4
|u32
|Size of paths in collision table (0x80 and 0xa0 have been used)
|-
|0xe
|0x4
|u32
|Crc32b resource size pair count
|-
|0x12
|0x4
|u32
|Path resource size pair count
|}

=== Crc32b Array ===
Array of hash + size pairs immediately following the header, if the header exists. Sorted by hash.
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Crc32b of file path
|-
|0x4
|0x4
|u32
|Size required by file resource in ares
|}

=== Path Array ===
Array of path + size pairs immediately following the Crc32b array, if the file path array exists. Sorted by path.
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x80
|char[ares MaxPath]
|Fixed size file path
|-
|0x80
|0x4
|u32
|Size required by file resource in ares
|}
[[Category:File formats]]

Bflyt

2023-12-27T05:13:27Z

Watertoon: Start on bflyt

nn::ui2d provides the Binary Cafe Layout file format to define the layout of ui elements.

=== Header (FLYT) ===
[[Common nn::ui2d|Standard ui2d header.]]

There are 23 possible section types:
{| class="wikitable"
|+
!Name
!Magic
!Description
|-
|User Data
|usd1
|User Data for the previous section, can contain special SystemData structures that extend functionality
|-
|Layout
|lyt1
|The headlining section for the Layout
|-
|Texture List
|txl1
|A list of all textures used in the Layout
|-
|Font List
|fnl1
|A list of all fonts used in the Layout
|-
|Material List
|mat1
|All the materials used in the Layout
|-
|Capture Texture List
|ctl1
|A list of all capture textures used in the Layout
|-
|Vector Graphics Texture List
|vgl1
|A list of all vector graphics textures used in the Layout
|-
|Pane Start
|pas1
|The start of a tree of panes, panes become children of last pane
|-
|Pane End
|pae1
|The end of a tree of panes
|-
|Pane
|pan1
|The default pane
|-
|Picture Pane
|pic1
|A pane that can contain images
|-
|TextBox Pane
|txt1
|A pane that can contain text
|-
|Window Pane
|wnd1
|A pane that contain a frame and multiple images
|-
|Parts Pane
|prt1
|A pane that can contain a sub layout
|-
|Alignment Pane
|ali1
|A pane that aligns it's children
|-
|Capture Pane
|cpt1
|A pane that captures it's children
|-
|Bounding Pane
|bnd1
|A pane that can be used in hit detection
|-
|Scissor Pane
|scr1
|A pane the scissors it's children
|-
|Group Start
|grs1
|The start of a group
|-
|Group End
|gre1
|The end of a group
|-
|Group
|grp1
|A group
|-
|Control Source
|cnt1
|The control source class and related for the layout
|-
|State Machine
|stm1
|A state machine
|}

=== Layout (lyt1) ===
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Ui2d Section Header
|Magic: "lyt1"
|-
|0x8
|0x1
|u8
|Is Centered
|-
|0x9
|0x3
|u24
|Unknown/Reserved
|-
|0xc
|0x4
|float
|Width
|-
|0x10
|0x4
|float
|Height
|-
|0x14
|0x4
|float
|PartsWidth
|-
|0x18
|0x4
|float
|PartsHeight
|-
|0x1c
|variable
|char[]
|Name
|}

==== Layout SystemData ====
{| class="wikitable"
|+
!Name
!EnumValue
!Description
|-
|AnimTagName
|0x0
|Animation names?
|}

==== AnimTagName ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|String Count
|-
|0x4
|0x4 * String Count
|u32
|Anim Name String Offset Array
|}

=== Texture List (txl1) ===
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Ui2d Section Header
|Magic: "txl1"
|-
|0x8
|0x2
|u16
|Texture Count
|-
|0xa
|0x2
|u16
|Unknown/Reserved
|-
|0x4
|0x4 * Texture Count
|u32
|Texture Name Offset Array
|}

=== Font List (fnt1) ===
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Ui2d Section Header
|Magic: "fnt1"
|-
|0x8
|0x2
|u16
|Font Count
|-
|0xa
|0x2
|u16
|Unknown/Reserved
|-
|0x4
|0x4 * Font Count
|u32
|Font Name Offset Array
|}

=== Material List (mat1) ===
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Ui2d Section Header
|Magic: "mat1"
|-
|0x8
|0x2
|u16
|Material Count
|-
|0xa
|0x2
|u16
|Unknown/Reserved
|-
|0x4
|0x4 * Material Count
|u32
|Material Data Offset Array
|}

==== Material Memory ====
The layout of material memory is defined by this bitfield.
{| class="wikitable"
|+
!Bitfield Size
!Description
|-
|0x2
|Texture Map Count
|-
|0x2
|Texture SRT (Scale Rotation Translation) Count
|-
|0x2
|Texture Coordinate Gen Count
|-
|0x3
|Tev (Texture Environment) Combiner Count
|-
|0x1
|Alpha Compare Count
|-
|0x1
|Color Blend Mode Count
|-
|0x1
|Unknown/Reserved
|-
|0x1
|Color And Alpha Blend Mode Count
|-
|0x1
|Unknown/Reserved
|-
|0x1
|Unknown0
|-
|0x2
|Projection Texture Gen Count
|-
|0x1
|Unknown1
|-
|0x1
|Unknown/Reserved
|-
|0x1
|Detailed Combiner Count
|-
|0x1
|User Combiner Count
|-
|0x1
|Texture Extensions Count
|-
|0x2
|Vector Texture Info Count
|-
|0x2
|Brick Repeat Shader Info Count
|-
|0x6
|Unknown/Reserved
|}
The order of appearance of Material Data structures are as follows:
{| class="wikitable"
|+
!Structure
|-
|Material Data
|-
|Texture Map
|-
|Texture Extensions
|-
|Texture SRT
|-
|Texture Coordinate Gen
|-
|Tev Combiner
|-
|Alpha Compare
|-
|Blend Mode
|-
|Unknown0
|-
|Projection Texture Gen
|-
|Unknown1
|-
|DetailedCombiner
|-
|User Combiner
|-
|Vector Texture Info
|-
|Brick Repeat Shader Info
|}

==== Material Color Type ====
{| class="wikitable"
|+
!Name
!EnumValue
!Description
|-
|Color4u8
|0x0
|Material Color data offsets point to a Color4u8
|-
|Color4f
|0x1
|Material Color data offsets point to a Color4f
|}

==== Material Color Data ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x1
|u8
|Color Type
|-
|0x1
|0x1
|u8
|Color Count
|-
|0x2
|0x1 * Color Count
|u8
|Color Offsets
|-
|
|(Color4u8) 0x4 * Color Count
(Color4f) 0xc * Color Count
|Color4u8
Color4f
|Color Array
|}

==== Material Data ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x1c
|char[0x1c]
|Material name
|-
|0x1c
|0x4
|Material Memory
|Material memory bitfield
|-
|0x20
|variable
|MaterialColorData
|Material color data
|}

==== Texture Map ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x2
|u16
|Texture Index
|-
|0x2
|0x1
|Texture UV Options
|U Options
|-
|0x3
|0x1
|Texture UV Options
|V Options
|}

===== Texture UV Options =====
{| class="wikitable"
!Bitfield Size
!Description
|-
|0x2
|Wrap Mode
|-
|0x2
|Filter
|-
|0x4
|Unknown/Reserved
|}

==== Texture Extensions ====
{| class="wikitable"
!Bitfield Size
!Description
|-
|0x1
|Is Capture Texture
|-
|0x1
|Is Vector Graphics Texture
|-
|0x1e
|Unknown/Reserved
|}

==== Texture SRT ====
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Vector2f
|Translation
|-
|0x8
|0x4
|float
|Rotation
|-
|0xc
|0x8
|Vector2f
|Scale
|}

==== Texture Coordinate Gen (TODO) ====

==== Tev Combiner (TODO) ====

==== Alpha Compare ====
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x1
|u8
|Alpha Test Function
|-
|0x1
|0x3
|u24
|Unknown/Reserved
|-
|0x4
|0x1
|float
|Alpha Compare Reference
|}

===== Alpha Test Function =====
{| class="wikitable"
!Name
!Enum Value
!Description
|-
|Never
|0x0
|
|-
|LessThan
|0x1
|
|-
|LessThanEqual
|0x2
|
|-
|Equal
|0x3
|
|-
|NotEqual
|0x4
|
|-
|GreaterEqual
|0x5
|
|-
|Greater
|0x6
|
|-
|Always
|0x7
|
|}

==== Blend Mode ====
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x1
|u8
|Blend Equation
|-
|0x1
|0x1
|u8
|Blend Function Source
|-
|0x2
|0x1
|u8
|Blend Function Destination
|-
|0x3
|0x1
|u8
|Logic Operation
|}

===== Blend Equation =====
{| class="wikitable"
!Name
!Enum Value
!Description
|-
|Invalid
|0x0
|
|-
|Add
|0x1
|
|-
|Sub
|0x2
|
|-
|ReverseSub
|0x3
|
|-
|Min
|0x4
|
|-
|Max
|0x5
|
|}

===== Blend Function =====
{| class="wikitable"
!Name
!Enum Value
!Description
|-
|Zero
|0x0
|
|-
|One
|0x1
|
|-
|Destination Color
|0x2
|
|-
|Destination Color Minus One
|0x3
|
|-
|Source Alpha
|0x4
|
|-
|Source Alpha Minus One
|0x5
|
|-
|Destination Alpha
|0x6
|
|-
|Destination Alpha Minus One
|0x7
|
|-
|Source Color
|0x8
|
|-
|Source Color Minus One
|0x9
|
|}

===== Logic Operation =====
{| class="wikitable"
!Name
!Enum Value
!Description
|-
|Invalid
|0x0
|
|-
|NoOp
|0x1
|
|-
|Clear
|0x2
|
|-
|Set
|0x3
|
|-
|Copy
|0x4
|
|-
|CopyInverted
|0x5
|
|-
|Invert
|0x6
|
|-
|And
|0x7
|
|-
|Nand
|0x8
|
|-
|Or
|0x9
|
|-
|Nor
|0xa
|
|-
|Xor
|0xb
|
|-
|Equivalent
|0xc
|
|-
|AndReverse
|0xd
|
|-
|AndInverted
|0xe
|
|-
|OrReverse
|0xf
|
|-
|OrInverted
|0x10
|
|}

==== Unknown0 (TODO) ====

==== Projection Texture Gen (TODO) ====

==== Unknown1 (TODO) ====

==== Detailed Combiner (TODO) ====

==== User Combiner (TODO) ====

==== Vector Texture Info (TODO) ====

==== Brick Repeat Shader Info (TODO) ====

=== Capture Texture List (TODO) ===

=== Vector Graphics Texture List (TODO) ===

=== Pane Start (TODO) ===

=== Pane End (TODO) ===

=== Pane (pan1) ===
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Ui2d Section Header
|Magic: "pan1"
|-
|0x8
|0x1
|u8
|Pane Flags
|-
|0x9
|0x1
|u8
|Origin Bitfield
|-
|0xa
|0x1
|u8
|Alpha
|-
|0xb
|0x1
|u8
|FlagEx
|-
|0xc
|0x18
|char[0x18]
|Pane name
|-
|0x24
|0x8
|char[0x8]
|User name
|-
|0x2c
|0xc
|Vector3f
|Translation
|-
|0x28
|0xc
|Vector3f
|Rotation
|-
|0x44
|0x8
|Vector2f
|Scale
|-
|0x4c
|0x8
|Vector2f
|Size
|}

=== Picture Pane (pic1) ===
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x54
|Pane
|Magic: "pic1"
|-
|0x54
|0x4
|Color4u8
|Vertex Color Top Left
|-
|0x58
|0x4
|Color4u8
|Vertex Color Top Right
|-
|0x5c
|0x4
|Color4u8
|Vertex Color Bottom Left
|-
|0x60
|0x4
|Color4u8
|Vertex Color Bottom Right
|-
|0x64
|0x2
|u16
|Material Index
|-
|0x66
|0x1
|u8
|Texture Count
|-
|0x67
|0x1
|u8
|Is Shape
|-
|0x68
|0x20
|Texture UV
|Texture UV Array
|}

===== Texture UV =====
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Vector2f
|Top Left
|-
|0x8
|0x8
|Vector2f
|Top Right
|-
|0x10
|0x8
|Vector2f
|Bottom Left
|-
|0x18
|0x8
|Vector2f
|Bottom Right
|}

=== TextBox Pane (txt1) ===
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x54
|Pane
|Magic: "pic1"
|-
|0x54
|0x2
|u16
|Text Buffer Size
|-
|0x56
|0x2
|u16
|Text Length
|-
|0x58
|0x2
|u16
|Material Index
|-
|0x5a
|0x2
|u16
|Font Index
|-
|0x5c
|0x1
|u8
|Text Origin
|-
|0x5d
|0x1
|u8
|Line Alignment
|-
|0x5e
|0x2
|u16
|Flags
|-
|0x60
|0x4
|float
|Italic Tilt
|-
|0x64
|0x4
|u32
|Text Offset
|-
|0x68
|0x4
|Color4u8
|Font Top Color
|-
|0x6c
|0x4
|Color4u8
|Font Bottom Color
|-
|0x70
|0x8
|Vector2f
|Font Size
|-
|0x78
|0x4
|float
|Character Space
|-
|0x7c
|0x4
|float
|Line Space
|-
|0x80
|0x4
|u32
|Label Offset
|-
|0x84
|0x8
|Vector2f
|Shadow Translation
|-
|0x8c
|0x8
|Vector2f
|Shadow Size
|-
|0x94
|0x4
|Color4u8
|Shadow Top Color
|-
|0x98
|0x4
|Color4u8
|Shadow Bottom Color
|-
|0x9c
|0x4
|float
|Shadow Italic Tilt
|-
|0xa0
|0x4
|u32
|Line Transform Offset
|-
|0xa4
|0x4
|u32
|Per Character Transform Offset
|}

==== Line Transform (TODO) ====

==== Per Character Transform (TODO) ====

=== Window Pane (TODO) ===

=== Parts Pane (TODO) ===

=== Alignment Pane (TODO) ===

=== Capture Pane (TODO) ===

=== Bounding Pane (TODO) ===

=== Scissor Pane (TODO) ===

=== Group Start (TODO) ===

=== Group End (TODO) ===

=== Group (TODO) ===

=== Control Source (TODO) ===

Bffnt

2023-12-27T03:46:19Z

Watertoon: Early bffnt.

Binary Cafe Font. nn::font in addition to supporting Open Type Fonts supports this custom bitmap font file format.

=== Header ===
[[Common nn::ui2d|Standard ui2d header.]]

There are 5 section types, Font Information (FINF), Texture Glyph (TGLP), Character Width (CWDH), Code Map (CMAP), and Kerning (KRNG).

=== Font Information ===
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Ui2d Section Header
|Magic: "FINF"
|-
|0x8
|0x1
|u8
|Font Type
|-
|0x9
|0x1
|u8
|Height
|-
|0xa
|0x1
|u8
|Width
|-
|0xb
|0x1
|u8
|Ascent
|-
|0xc
|0x2
|u16
|Line Feed
|-
|0xe
|0x2
|u16
|Alternate Character Index
|-
|0x10
|0x3
|CharacterWidthData
|Default Character Widths
|-
|0x13
|0x1
|u8
|Character Encoding
|-
|0x14
|0x4
|u32
|Texture Glyph Offset (TGLP)
|-
|0x18
|0x4
|u32
|Character Width Offset (CWDH)
|-
|0x1c
|0x4
|u32
|Code Map Offset (CMAP)
|}

==== Font Type ====
{| class="wikitable"
|+
!Name
!Enum Value
!Description
|-
|Glyph
|0x0
|
|-
|Texture
|0x1
|Not witnessed by author
|-
|PackedTexture
|0x2
|Not witnessed by author
|}

==== Character Encoding ====
{| class="wikitable"
|+
!Name
!Enum Value
!Description
|-
|Utf16
|0x0
|
|-
|ShiftJis
|0x1
|
|-
|CP1252
|0x2
|
|}

==== Character Width Data ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x1
|s8
|Left Width
|-
|0x1
|0x1
|u8
|Glyph Width
|-
|0x2
|0x1
|u8
|Character Width
|}

=== Texture Glyph ===
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Ui2d Section Header
|Magic: "TGLP"
|-
|0x8
|0x1
|u8
|Cell Width
|-
|0x9
|0x1
|u8
|Cell Height
|-
|0xa
|0x1
|u8
|Texture Count
|-
|0xb
|0x1
|u8
|Max Character Width
|-
|0xc
|0x4
|u32
|Per Texture Size
|-
|0x10
|0x2
|u16
|Baseline Position
|-
|0x12
|0x2
|u16
|Image Format
|-
|0x14
|0x2
|u16
|Cells Per Row
|-
|0x16
|0x2
|u16
|Cells Per Column
|-
|0x18
|0x2
|u16
|Image Width
|-
|0x1a
|0x2
|u16
|Image Height
|-
|0x1c
|0x4
|u32
|Image Data Offset ([[Bntx]])
|}

==== Image Format ====
{| class="wikitable"
|+
!Name
!Enum Value
!Description
|-
|R8G8B8A8_Unorm
|0x0
|
|-
|R8G8B8_Unorm
|0x1
|
|-
|R5G5B5A1_Unorm
|0x2
|
|-
|R5G6B5_Unorm
|0x3
|
|-
|R4G4B4A4_Unorm
|0x4
|
|-
|LA8_Unorm
|0x5
|
|-
|LA4_Unorm
|0x6
|
|-
|A4_Unorm
|0x7
|
|-
|A8_Unorm
|0x8
|
|-
|BC1_Unorm
|0x9
|
|-
|BC2_Unorm
|0xa
|
|-
|BC3_Unorm
|0xb
|
|-
|BC4_Unorm
|0xc
|
|-
|BC5_Unorm
|0xd
|
|-
|R8G8B8A8_SRGB
|0xe
|
|-
|BC1_SRGB
|0xf
|
|-
|BC2_SRGB
|0x10
|
|-
|BC3_SRGB
|0x11
|
|-
|BC7_Unorm
|0x12
|
|-
|BC7_SRGB
|0x13
|
|}

=== Character Width ===
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Ui2d Section Header
|Magic: "CWDH"
|-
|0x8
|0x2
|u16
|First Entry Index
|-
|0xa
|0x2
|u16
|Last Entry Index
|-
|0xc
|0x4
|u32
|Next Character Width Offset (CWDH)
|-
|0x10
|0x3
|CharacterWidthData
|Character Width Array
|}

=== Code Map ===
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Ui2d Section Header
|Magic: "CMAP"
|-
|0x8
|0x4
|u32
|Code Range Begin
|-
|0xc
|0x4
|u32
|Code Range End
|-
|0x10
|0x2
|u16
|Map Method
|-
|0x12
|0x2
|u16
|Unknown/Reserved
|-
|0x14
|0x4
|u32
|Next Code Map Offset (CMAP)
|-
|0x18
|0x2
0x2 * Range
0x4 + 0x4 * Range
|Direct
Table
Scan
|See below
|}

==== Code Map Method ====
{| class="wikitable"
!Name
!Enum Value
!Description
|-
|Direct
|0x0
|
|-
|Table
|0x1
|
|-
|Scan
|0x2
|
|}

==== Direct ====
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x2
|u16
|Base Character
|}

==== Table ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x2 * Range
|u16
|Character
|}

==== Scan ====
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x2
|u16
|Scan Half Count
|-
|0x2
|0x2
|u16
|Unknown/Reserved
|-
|0x4
|0x4 * Range
|ScanEntry
|Scan Entry Array (sorted)
|}

===== Scan Entry =====
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x2
|u16
|Key
|-
|0x2
|0x2
|u16
|Code
|}

=== Kerning (TODO) ===
This section has not yet been witnessed by author.

Bflan

2023-12-27T03:13:15Z

Watertoon: Early Bflan page

nn::ui2d provides the Binary Cafe Layout Animation file format to store animations for Bflyt files.

=== Header ===
[[Common nn::ui2d|Standard ui2d header.]]

There are 3 top level sections, Animation Tag (pat1), Animation Info (pai1), and Animation Share (pah1).

=== Animation Tag ===
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Ui2d Section Header
|Magic: "pat1"
|-
|0x8
|0x2
|u16
|Tag Order
|-
|0xa
|0x2
|u16
|Group Count
|-
|0xc
|0x4
|u32
|Name Offset
|-
|0x10
|0x4
|u32
|Group Array Offset
|-
|0x14
|0x4
|u32
|User Data List Section Offset
|-
|0x18
|0x2
|u16
|Start Frame
|-
|0x1a
|0x2
|u16
|End Frame
|}

==== Animation Group ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x21
|char[0x21]
|GroupName
|-
|0x21
|0x1
|u8
|Unknown Flag
|-
|0x22
|0x2
|u16
|Unknown/Reserved
|}

=== Animation Info ===
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Ui2d Section Header
|Magic: "pai1"
|-
|0x8
|0x2
|u16
|Frame count
|-
|0xa
|0x1
|u8
|Is looping
|-
|0xb
|0x1
|u8
|Unknown/Reserved
|-
|0xc
|0x2
|u16
|Texture count
|-
|0xe
|0x2
|u16
|Animation Content count
|-
|0x10
|0x4
|u32
|Animation Content offset array offset (u32 array of offsets to AnimationContent)
|-
|0x14
|0x4 * Texture Count
|u32
|Texture name offset array
|}

==== Animation Target ====
{| class="wikitable"
|+
!Name
!Enum Value
!Description
|-
|Pane
|0x0
|Animation targets Panes
|-
|Material
|0x1
|Animation targets Materials
|-
|User
|0x2
|Animation targets UserData
|-
|PaneExt
|0x3
|Seems to duplicate as Pane sometimes?
|-
|StateMachine
|0x4
|Animation targets StateMachine
|}

==== Animation Content ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x1c
|char[0x1c]
|Animation Name
|-
|0x1c
|0x1
|u8
|Animation Info Count
|-
|0x1d
|0x1
|u8
|Animation Target
|-
|0x1e
|0x2
|u16
|Unknown/Reserved
|-
|0x20
|0x4 * Animation Info Count
|u32
|Animation Info Offset Array
|}

==== Animation Info Type ====
{| class="wikitable"
|+
!Name (unofficial)
!Magic Value
!Description
|-
|Per Character Transform Curve Anim
|FLCC
|
|-
|Extended User Data Anim
|FLEU
|
|-
|Per Character Transform Anim
|FLCT
|
|-
|Pane SRT (Scale Rotation Translation) Anim
|FLPA
|
|-
|Vertex Color Anim
|FLVC
|
|-
|Visibility Anim
|FLVI
|
|-
|Drop Shadow Anim
|FLDS
|
|-
|Mask Texture Anim
|FLMT
|
|-
|Procedural Shape Anim
|FLPS
|
|-
|Window Anim
|FLWN
|
|-
|State Machine Anim
|FSMA
|
|-
|Alpha Compare Anim
|FLAC
|
|-
|Font Shadow Anim
|FLFS
|
|-
|Indirect SRT Anim
|FLIM
|
|-
|Material Color Anim
|FLMC
|
|-
|Texture SRT Anim
|FLTS
|
|-
|Texture Pattern Anim
|FLTP
|
|-
|Brick Repeat Anim
|FTBR
|
|-
|Vector Graphics Anim
|FVGA
|
|}

==== Animation Info ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Animation Info Type Magic
|-
|0x4
|0x1
|u8
|Animation Target Count
|-
|0x5
|0x3
|u24
|Unknown/Reserved
|-
|0x8
|0x4 * Animation Target Count
|u32
|Animation Target Offset Array
|}

==== Animation Curve ====

===== Animation Curve Type =====
{| class="wikitable"
|+
!Name (unofficial)
!Enum Value
!Description
|-
|Constant
|0x0
|Plain float values
|-
|Step
|0x1
|Step key frames
|-
|Hermite
|0x2
|Hermite key frames
|}

===== Step Key =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|float
|Key Index
|-
|0x4
|0x2
|u16
|Value
|-
|0x6
|0x2
|u16
|Unknown/Reserved
|}

===== Hermite Key =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|float
|Key Index
|-
|0x4
|0x4
|float
|Value
|-
|0x8
|0x4
|float
|Slope
|}

==== Animation Target ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x1
|u8
|Unknown/Reserved
|-
|0x1
|0x1
|u8
|Target Index
|-
|0x2
|0x1
|u8
|Anim Curve Type
|-
|0x3
|0x1
|u8
|Unknown/Reserved
|-
|0x4
|0x2
|u16
|Frame Count
|-
|0x6
|0x2
|u16
|Unknown/Reserved
|-
|0x8
|0x4
|u32
|Key Array Offset
|}

=== Animation Share ===
Note; at time of writing author has not seen a Bflan with this section
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Ui2d Section Header
|Magic: "pah1"
|-
|0x8
|0x4
|u32
|Share Info Offset
|-
|0xc
|0x2
|u16
|Share Info Count
|-
|0xe
|0x2
|u16
|Unknown/Reserved
|}

Byaml

2023-12-27T02:20:10Z

Watertoon: Broken website moment (failed to delete apparently).

Byaml is Nintendo EPD's binary take on Yet Another Markup Language. It is handled by a dedicated library under the namespace "byaml" in later titles. Every version up to version 10 is supported by Nintendo's library as of Super Mario Wonder. Library supports both little and big endian.

=== Header ===
{| class="wikitable"
|+Version 4-7
!Offset
!Size
!Type
!Description
|-
|0x0
|0x2
|u16
|Magic ("YB" in little-endian, "BY" in big-endian)
|-
|0x2
|0x2
|u16
|Version (Up to 10 since Super Mario Wonder)
|-
|0x4
|0x4
|u32
|Key table offset (to ByamlContainer)
|-
|0x8
|0x4
|u32
|String table offset (to ByamlContainer)
|-
|0xc
|0x4
|u32
|Root data offset (to ByamlContainer)
|}
=== Byaml Container ===
{| class="wikitable"
|+Version 4-7
!Offset
!Size
!Type
!Description
|-
|0x0
|0x1
|u8 (NodeDataType Enum)
|Container data type
|-
|0x1
|0x3
|u24
|Count of container elements
|-
|
|
|
|NodeDataType specific data
|}
As of version 10 the root data of a header can point to a non-container type, in which case the ByamlContainer header will contain only the data type, with the single value stored directly after the ByamlContainer header.

=== Node Data Types ===
u8 enum of node data types that can appear. "Value" describes what the Value in a NodeDataType + Value pair means. These pairs are found in every container type.
{| class="wikitable"
|+Version 7
!Name(unofficial)
!Enum Value
!Container "Value" Description
|-
|HashArray
|0x20-0x2f
|Value is an absolute offset to a ByamlContainer of the Hash Array type
|-
|HashArrayWithRemap
|0x30-0x3f
|Same as above but when accessing elements by index that index is remapped
|-
|StringIndex
|0xa0
|Value is an index into the string table
|-
|BinaryData
|0xa1
|Value is an absolute offset from the header to size of binary data followed by the binary data
|-
|BinaryDataWithAlignment
|0xa2
|Same as above but pointing to the size of the binary data, followed by alignment, followed by binary data
|-
|Array
|0xc0
|Value is an absolute offset to a ByamlContainer of the Array type
|-
|Dictionary
|0xc1
|Value is an absolute offset to a ByamlContainer of the Dictionary type
|-
|Key/StringTable
|0xc2
|(Only found in ByamlContainer pointed to by header)
|-
|DictionaryWithRemap
|0xc4
|Value is an absolute offset to a ByamlContainer of the Dictionary with remap type
|-
|RelocatedKey/StringTable
|0xc5
|(Only found in ByamlContainer pointed to by header)
|-
|MonoTypedArray
|0xc8
|Value is an absolute offset to a ByamlContainer of the Array with remap type
|-
|Bool
|0xd0
|Value is a bool
|-
|S32
|0xd1
|Value is a signed 32-bit integer
|-
|F32
|0xd2
|Value is a 32-bit floating point number
|-
|U32
|0xd3
|Value is a unsigned 32-bit integer
|-
|S64
|0xd4
|Value is an absolute offset to a signed 64-bit integer
|-
|U64
|0xd5
|Value is an absolute offset to a unsigned 64-bit integer
|-
|F64
|0xd6
|Value is an absolute offset to a 64-bit floating point number
|-
|Null
|0xff
|Value is 0 (null)
|}

=== Key/String Tables (0xc2, 0xc5) ===
Only pointed to by the header, these tables are responsible for storing strings. The key table is used for dictionary containers and is sorted, the string table is for string data.

==== Key/String Table (0xc2) ====
{| class="wikitable"
|+Version 4-7
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|ByamlContainer
|
|-
|0x4
|0x4 * ByamlContainer count
|u32
|String offset array, offsets relative to string table header
|-
|
|
|string data
|Array of strings
|}

==== Relocated Key/String Table (0xc5) ====
{| class="wikitable"
|+Version 7
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|ByamlContainer
|
|-
|0x4
|0x4 * ByamlContainer count
|u32
|String offset array, except the first element, which is an offset to a u64 value to be added to the other string offsets
|}

=== Hash Array (0x20-0x2f) ===
Recent container types first noticed (to writer's knowledge) in the byaml library of the 3d All Stars menu. NodeDataType + Value pairs can be accessed through hash values and indices.

==== Hash Pair ====
{| class="wikitable"
|+Version 7
!Offset
!Size
!Type
!Description
|-
|0x0
|(container NodeDataType & 0xf) * 0x4
|u32[N]
|Hash
|-
|
|0x4
|u32
|Value
|}

==== Hash Array (0x20-0x2f) ====
{| class="wikitable"
|+Version 7
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|ByamlContainer
|
|-
|0x4
|0xN * ByamlContainer count
|HashPair
|Hash + value array sorted by hash
|-
|
|0x1 * ByamlContainer count
|u8
|NodeDataType for HashPair value
|}

==== Hash Array With Remap (0x30-0x3f) ====
{| class="wikitable"
|+Version 7
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|ByamlContainer
|
|-
|0x4
|0xN * ByamlContainer count
|HashPair
|Hash + value array sorted by hash
|-
|
|0x1 * ByamlContainer count
|u8
|NodeDataType for HashPair value
|-
|
|(if count < 0x100) 0x1 * ByamlContainer count
(if count < 0x10000) 0x2 * ByamlContainer count

(else) 0x4 * ByamlContainer count
|u8, u16, u32
|Index remap table
|}

=== Array (0xc0, 0xc8) ===
Container types where NodeDataType + Value pairs can be accessed through indices.

==== Array (0xc0) ====
{| class="wikitable"
|+Version 4-7
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|ByamlContainer
|
|-
|0x4
|0x1 * ByamlContainer count
|u8
|NodeDataType array matching index of value
|-
|
|0x4 * ByamlContainer count
|u32
|Value array
|}

==== Mono-Typed Array (0xc8) ====
{| class="wikitable"
|+Version 7
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|ByamlContainer
|
|-
|0x4
|0x1 (aligned up by 0x4)
|u8
|NodeDataType for every array value
|-
|0x8
|0x4 * ByamlContainer count
|u32
|Value array
|}

=== Dictionary (0xc1, 0xc4) ===
Container types where NodeDataType + Value pairs can be accessed through a string key or indices.

==== Byaml Dictionary Pair ====
{| class="wikitable"
|+Version 4-7
!Offset
!Size
!Type
!Description
|-
|0x0
|0x3
|u24
|Key table index
|-
|0x1
|0x1
|u8
|Node Data Type
|-
|0x4
|0x4
|u32
|Value
|}

==== Dictionary (0xc1) ====
{| class="wikitable"
|+Version 4-7
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|ByamlContainer
|
|-
|0x4
|0x8 * ByamlContainer count
|ByamlDictionaryPair
|Dictionary pair array sorted by key index
|}

==== Dictionary With Remap (0xc4) ====
{| class="wikitable"
|+Version 7
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|ByamlContainer
|
|-
|0x4
|0x8 * ByamlContainer count
|ByamlDictionaryPair
|Dictionary pair array sorted by key index
|-
|
|(if count < 0x100) 0x1 * ByamlContainer count
(if count < 0x10000) 0x2 * ByamlContainer count

(else) 0x4 * ByamlContainer count
|u8, u16, u32
|Index remap table
|}
[[Category:File formats]]

Byaml

2023-12-27T02:18:15Z

Watertoon: Minor update for version 10

Byaml is Nintendo EPD's binary take on Yet Another Markup Language. It is handled by a dedicated library under the namespace "byaml" in later titles. Every version up to version 10 is supported by Nintendo's library as of Super Mario Wonder. Library supports both little and big endian.

=== Header ===
{| class="wikitable"
|+Version 4-7
!Offset
!Size
!Type
!Description
|-
|0x0
|0x2
|u16
|Magic ("YB" in little-endian, "BY" in big-endian)
|-
|0x2
|0x2
|u16
|Version (Up to 10 since Super Mario Wonder)
|-
|0x4
|0x4
|u32
|Key table offset (to ByamlContainer)
|-
|0x8
|0x4
|u32
|String table offset (to ByamlContainer)
|-
|0xc
|0x4
|u32
|Root data offset (to ByamlContainer)
|}
As of version 10 the root data can point to a non-container type, in which the value will be stored directly after the ByamlContainer

=== Byaml Container ===
{| class="wikitable"
|+Version 4-7
!Offset
!Size
!Type
!Description
|-
|0x0
|0x1
|u8 (NodeDataType Enum)
|Container data type
|-
|0x1
|0x3
|u24
|Count of container elements
|-
|
|
|
|NodeDataType specific data
|}
As of version 10 the root data of a header can point to a non-container type, in which case the ByamlContainer header will contain only the data type, with the single value stored directly after the ByamlContainer header.

=== Node Data Types ===
u8 enum of node data types that can appear. "Value" describes what the Value in a NodeDataType + Value pair means. These pairs are found in every container type.
{| class="wikitable"
|+Version 7
!Name(unofficial)
!Enum Value
!Container "Value" Description
|-
|HashArray
|0x20-0x2f
|Value is an absolute offset to a ByamlContainer of the Hash Array type
|-
|HashArrayWithRemap
|0x30-0x3f
|Same as above but when accessing elements by index that index is remapped
|-
|StringIndex
|0xa0
|Value is an index into the string table
|-
|BinaryData
|0xa1
|Value is an absolute offset from the header to size of binary data followed by the binary data
|-
|BinaryDataWithAlignment
|0xa2
|Same as above but pointing to the size of the binary data, followed by alignment, followed by binary data
|-
|Array
|0xc0
|Value is an absolute offset to a ByamlContainer of the Array type
|-
|Dictionary
|0xc1
|Value is an absolute offset to a ByamlContainer of the Dictionary type
|-
|Key/StringTable
|0xc2
|(Only found in ByamlContainer pointed to by header)
|-
|DictionaryWithRemap
|0xc4
|Value is an absolute offset to a ByamlContainer of the Dictionary with remap type
|-
|RelocatedKey/StringTable
|0xc5
|(Only found in ByamlContainer pointed to by header)
|-
|MonoTypedArray
|0xc8
|Value is an absolute offset to a ByamlContainer of the Array with remap type
|-
|Bool
|0xd0
|Value is a bool
|-
|S32
|0xd1
|Value is a signed 32-bit integer
|-
|F32
|0xd2
|Value is a 32-bit floating point number
|-
|U32
|0xd3
|Value is a unsigned 32-bit integer
|-
|S64
|0xd4
|Value is an absolute offset to a signed 64-bit integer
|-
|U64
|0xd5
|Value is an absolute offset to a unsigned 64-bit integer
|-
|F64
|0xd6
|Value is an absolute offset to a 64-bit floating point number
|-
|Null
|0xff
|Value is 0 (null)
|}

=== Key/String Tables (0xc2, 0xc5) ===
Only pointed to by the header, these tables are responsible for storing strings. The key table is used for dictionary containers and is sorted, the string table is for string data.

==== Key/String Table (0xc2) ====
{| class="wikitable"
|+Version 4-7
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|ByamlContainer
|
|-
|0x4
|0x4 * ByamlContainer count
|u32
|String offset array, offsets relative to string table header
|-
|
|
|string data
|Array of strings
|}

==== Relocated Key/String Table (0xc5) ====
{| class="wikitable"
|+Version 7
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|ByamlContainer
|
|-
|0x4
|0x4 * ByamlContainer count
|u32
|String offset array, except the first element, which is an offset to a u64 value to be added to the other string offsets
|}

=== Hash Array (0x20-0x2f) ===
Recent container types first noticed (to writer's knowledge) in the byaml library of the 3d All Stars menu. NodeDataType + Value pairs can be accessed through hash values and indices.

==== Hash Pair ====
{| class="wikitable"
|+Version 7
!Offset
!Size
!Type
!Description
|-
|0x0
|(container NodeDataType & 0xf) * 0x4
|u32[N]
|Hash
|-
|
|0x4
|u32
|Value
|}

==== Hash Array (0x20-0x2f) ====
{| class="wikitable"
|+Version 7
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|ByamlContainer
|
|-
|0x4
|0xN * ByamlContainer count
|HashPair
|Hash + value array sorted by hash
|-
|
|0x1 * ByamlContainer count
|u8
|NodeDataType for HashPair value
|}

==== Hash Array With Remap (0x30-0x3f) ====
{| class="wikitable"
|+Version 7
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|ByamlContainer
|
|-
|0x4
|0xN * ByamlContainer count
|HashPair
|Hash + value array sorted by hash
|-
|
|0x1 * ByamlContainer count
|u8
|NodeDataType for HashPair value
|-
|
|(if count < 0x100) 0x1 * ByamlContainer count
(if count < 0x10000) 0x2 * ByamlContainer count

(else) 0x4 * ByamlContainer count
|u8, u16, u32
|Index remap table
|}

=== Array (0xc0, 0xc8) ===
Container types where NodeDataType + Value pairs can be accessed through indices.

==== Array (0xc0) ====
{| class="wikitable"
|+Version 4-7
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|ByamlContainer
|
|-
|0x4
|0x1 * ByamlContainer count
|u8
|NodeDataType array matching index of value
|-
|
|0x4 * ByamlContainer count
|u32
|Value array
|}

==== Mono-Typed Array (0xc8) ====
{| class="wikitable"
|+Version 7
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|ByamlContainer
|
|-
|0x4
|0x1 (aligned up by 0x4)
|u8
|NodeDataType for every array value
|-
|0x8
|0x4 * ByamlContainer count
|u32
|Value array
|}

=== Dictionary (0xc1, 0xc4) ===
Container types where NodeDataType + Value pairs can be accessed through a string key or indices.

==== Byaml Dictionary Pair ====
{| class="wikitable"
|+Version 4-7
!Offset
!Size
!Type
!Description
|-
|0x0
|0x3
|u24
|Key table index
|-
|0x1
|0x1
|u8
|Node Data Type
|-
|0x4
|0x4
|u32
|Value
|}

==== Dictionary (0xc1) ====
{| class="wikitable"
|+Version 4-7
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|ByamlContainer
|
|-
|0x4
|0x8 * ByamlContainer count
|ByamlDictionaryPair
|Dictionary pair array sorted by key index
|}

==== Dictionary With Remap (0xc4) ====
{| class="wikitable"
|+Version 7
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|ByamlContainer
|
|-
|0x4
|0x8 * ByamlContainer count
|ByamlDictionaryPair
|Dictionary pair array sorted by key index
|-
|
|(if count < 0x100) 0x1 * ByamlContainer count
(if count < 0x10000) 0x2 * ByamlContainer count

(else) 0x4 * ByamlContainer count
|u8, u16, u32
|Index remap table
|}
[[Category:File formats]]

Bntx

2023-05-09T21:04:11Z

Watertoon: Fix links 2.

Bntx is a texture archive file format implemented by nn::gfx.

=== Header (nn::gfx::ResTextureFile) ===
{| class="wikitable"
|+Version 4.1.0
!Offset
!Size
!Type
!Description
|-
|0x0
|0x20
|[[Common nn::util#nn::util::BinaryFileHeader|nn::util::BinaryFileHeader]]
|Magic ("BNTX " in big-endian)
|-
|0x20
|0x28
|[[Bntx#nn::gfx::ResTextureContainer|nn::gfx::ResTextureContainer]]
|
|}

=== nn::gfx::ResTextureContainer ===
Container for holding an array of texture info, and information about the GPU region containing textures
{| class="wikitable"
|+Version 4.1.0
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Magic ("NX ")
|-
|0x4
|0x4
|u32
|Texture count
|-
|0x8
|0x8
|[[Bntx#nn::gfx::ResTextureInfo|ResTextureInfo]] **
|Texture info array
|-
|0x10
|0x8
|[[Bntx#nn::gfx::ResTextureData|ResTextureData]] *
|Texture data gpu region header
|-
|0x18
|0x8
|[[Common nn::util#nn::util::ResDic|nn::util::ResDic]] *
|Texture info dictionary
|-
|0x20
|0x8
|nn::gfx::TMemoryPool *
|Points to reserved 0x100 byte region for an in-place MemoryPool
|-
|0x28
|0x8
|nn::gfx::TMemoryPool *
|User MemoryPool (initialized by nn::gfx to point to the in-place MemoryPool if one is not provided)
|-
|0x30
|0x4
|s32
|Base MemoryPool offset
|-
|0x34
|0x4
|u32
|Reserved
|}

=== nn::gfx::ResTextureInfo ===
Block contains all the data necessary to initialize a Texture and a TextureView object in nn::gfx.
{| class="wikitable"
|+Version 4.1.0
!Offset
!Size
!Type
!Description
|-
|0x0
|0x10
|[[Common nn::util#nn::util::BinaryBlockHeader|nn::util::BinaryBlockHeader]]
|Magic ("BRTI" in big-endian)
|-
|0x10
|0x28
|[[Common nn::gfx#nn::gfx::TextureInfo|nn::gfx::TextureInfo]]
|Texture info for nn::gfx
|-
|0x38
|0x4
|u8[4]
|Packaged texture layout?
|-
|0x3c
|0x14
|u8[0x14]
|Reserved
|-
|0x50
|0x4
|u32
|Total texture size (including all mip maps)
|-
|0x54
|0x4
|u32
|Texture data alignment
|-
|0x58
|0x4
|nn::gfx::ChannelSource[4]
|
|-
|0x5c
|0x1
|nn::gfx::ImageDimension
|
|-
|0x5d
|0x3
|u8[3]
|Reserved
|-
|0x60
|0x8
|const char * (NW)
|Texture name
|-
|0x68
|0x8
|[[Bntx#nn::gfx::ResTextureContainer|nn::gfx::ResTextureContainer]] *
|Pointer to parent texture container
|-
|0x70
|0x8
|void **
|Array of pointers to each texture mip map level
|-
|0x78
|0x8
|[[Common nn::gfx#Gfx User Data|Gfx User Data]] *
|User data array
|-
|0x80
|0x8
|nn::gfx::TTexture *
|Points to reserved 0x100 byte region for an in-place Texture
|-
|0x88
|0x8
|nn::gfx::TTextureView *
|Points to reserved 0x100 byte region for an in-place TextureView
|-
|0x90
|0x8
|nn::gfx::DescriptorSlot
|Runtime descriptor slot for the registered Texture + TextureView
|-
|0x98
|0x8
|[[Common nn::util#nn::util::ResDic|nn::util::ResDic]] *
|User data dictionary
|}

=== nn::gfx::ResTextureData ===
This block header directly precedes the 0x1000 byte page aligned GPU memory region.
{| class="wikitable"
|+Version 4.1.0
!Offset
!Size
!Type
!Description
|-
|0x0
|0x10
|[[Common nn::util#nn::util::BinaryBlockHeader|nn::util::BinaryBlockHeader]]
|Magic ("BRTD" in big-endian)
|}
[[Category:File formats]]

Bntx

2023-05-09T21:02:07Z

Watertoon: Create Bntx page.

Bntx is a texture archive file format implemented by nn::gfx.

=== Header (nn::gfx::ResTextureFile) ===
{| class="wikitable"
|+Version 4.1.0
!Offset
!Size
!Type
!Description
|-
|0x0
|0x20
|[[Common nn::util#nn::util::BinaryFileHeader|nn::util::BinaryFileHeader]]
|Magic ("BNTX " in big-endian)
|-
|0x20
|0x28
|[[Bntx#nn::gfx::ResTextureContainer|nn::gfx::ResTextureContainer]]
|
|}

=== nn::gfx::ResTextureContainer ===
Container for holding an array of texture info, and information about the GPU region containing textures
{| class="wikitable"
|+Version 4.1.0
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Magic ("NX ")
|-
|0x4
|0x4
|u32
|Texture count
|-
|0x8
|0x8
|[[Bntx#ResTextureInfo|ResTextureInfo]] **
|Texture info array
|-
|0x10
|0x8
|[[Bntx#ResTextureData|ResTextureData]] *
|Texture data gpu region header
|-
|0x18
|0x8
|[[Common nn::util#nn::util::ResDic|nn::util::ResDic]] *
|Texture info dictionary
|-
|0x20
|0x8
|nn::gfx::TMemoryPool *
|Points to reserved 0x100 byte region for an in-place MemoryPool
|-
|0x28
|0x8
|nn::gfx::TMemoryPool *
|User MemoryPool (initialized by nn::gfx to point to the in-place MemoryPool if one is not provided)
|-
|0x30
|0x4
|s32
|Base MemoryPool offset
|-
|0x34
|0x4
|u32
|Reserved
|}

=== nn::gfx::ResTextureInfo ===
Block contains all the data necessary to initialize a Texture and a TextureView object in nn::gfx.
{| class="wikitable"
|+Version 4.1.0
!Offset
!Size
!Type
!Description
|-
|0x0
|0x10
|[[Common nn::util#nn::util::BinaryBlockHeader|nn::util::BinaryBlockHeader]]
|Magic ("BRTI" in big-endian)
|-
|0x10
|0x28
|[[Common nn::gfx#nn::gfx::TextureInfo|nn::gfx::TextureInfo]]
|Texture info for nn::gfx
|-
|0x38
|0x4
|u8[4]
|Packaged texture layout?
|-
|0x3c
|0x14
|u8[0x14]
|Reserved
|-
|0x50
|0x4
|u32
|Total texture size (including all mip maps)
|-
|0x54
|0x4
|u32
|Texture data alignment
|-
|0x58
|0x4
|nn::gfx::ChannelSource[4]
|
|-
|0x5c
|0x1
|nn::gfx::ImageDimension
|
|-
|0x5d
|0x3
|u8[3]
|Reserved
|-
|0x60
|0x8
|const char * (NW)
|Texture name
|-
|0x68
|0x8
|[[Bntx#nn::gfx::ResTextureContainer|nn::gfx::ResTextureContainer]] *
|Pointer to parent texture container
|-
|0x70
|0x8
|void **
|Array of pointers to each texture mip map level
|-
|0x78
|0x8
|[[Common nn::gfx#Gfx User Data|Gfx User Data]] *
|User data array
|-
|0x80
|0x8
|nn::gfx::TTexture *
|Points to reserved 0x100 byte region for an in-place Texture
|-
|0x88
|0x8
|nn::gfx::TTextureView *
|Points to reserved 0x100 byte region for an in-place TextureView
|-
|0x90
|0x8
|nn::gfx::DescriptorSlot
|Runtime descriptor slot for the registered Texture + TextureView
|-
|0x98
|0x8
|[[Common nn::util#nn::util::ResDic|nn::util::ResDic]] *
|User data dictionary
|}

=== nn::gfx::ResTextureData ===
This block header directly precedes the 0x1000 byte page aligned GPU memory region.
{| class="wikitable"
|+Version 4.1.0
!Offset
!Size
!Type
!Description
|-
|0x0
|0x10
|[[Common nn::util#nn::util::BinaryBlockHeader|nn::util::BinaryBlockHeader]]
|Magic ("BRTD" in big-endian)
|}
[[Category:File formats]]

Common nn::gfx

2023-05-09T20:53:51Z

Watertoon: Spell check

Structures and enums from nn::gfx appearing across nn::gfx file formats and nn::g3d file formats. Notably the nn::gfx formats [[Bnsh]] and [[Bntx]], as well as nn::g3d [[Bfres]].

=== nn::gfx::MemoryPoolFlags ===
Flags denoting how a memory pool can be accessed.
{| class="wikitable"
!Name (Unofficial)
!Value
!Description
|-
|CpuNoAccess
|0x1 (1 << 0)
|Memory is unable to be mapped to CPU
|-
|CpuUncached
|0x2 (1 << 1)
|Memory is coherent on CPU
|-
|CpuCached
|0x4 (1 << 2)
|Memory is cached on CPU
|-
|GpuNoAccess
|0x8 (1 << 3)
|Memory is unable to be read by the GPU
|-
|GpuUncached
|0x10 (1 << 4)
|Memory is coherent on GPU
|-
|GpuCached
|0x20 (1 << 5)
|Memory is cached on GPU
|-
|ShaderCode
|0x40 (1 << 6)
|Memory is shader code for the GPU
|-
|Compressible
|0x80 (1 << 7)
|???
|-
|Physical
|0x100 (1 << 8)
|???
|-
|Virtual
|0x200 (1 << 9)
|???
|}

=== nn::gfx::MemoryPoolInfo ===
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32 (nn::gfx::MemoryPoolFlags)
|MemoryPool flags
|-
|0x4
|0x4
|u32
|Memory size
|-
|0x8
|0x8
|void *
|Memory pointer (must be 0x1000 aka page aligned)
|}

=== nn::gfx::GpuAccessFlags ===
Flags denoting how a buffer or texture will be accessed.
{| class="wikitable"
!Name (Unofficial)
!Value
!Description
|-
|VertexBuffer
|0x4 (1 << 2)
|Vertex buffer
|-
|IndexBuffer
|0x8 (1 << 3)
|Index buffer
|-
|UniformBuffer
|0x10 (1 << 4)
|Uniform/Storage buffer
|-
|Texture
|0x20 (1 << 5)
|Texture
|-
|TransferDestination
|0x40 (1 << 6)
|Transfer destination
|-
|RenderTargetColor
|0x80 (1 << 7)
|For render target colors
|-
|RenderTargetDepth
|0x100 (1 << 8)
|For render target depths
|-
|IndirectDraw
|0x200 (1 << 9)
|For indirect draw commands
|-
|DisplayTexture
|0x400 (1 << 10)
|For present
|-
|Counter
|0x800 (1 << 11)
|???
|}

=== nn::gfx::BufferInfo ===
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Buffer size
|-
|0x4
|0x4
|u32 (nn::gfx::GpuAccessFlags)
|GPU access flags
|-
|0x8
|0x4
|u32
|Reserved
|-
|0xc
|0x4
|u32
|Reserved
|}

=== nn::gfx:::ImageStorageDimension ===
{| class="wikitable"
!Name (Unofficial)
!Value
!Description
|-
|Type1D
|0x1
|
|-
|Type2D
|0x2
|
|-
|Type3D
|0x3
|
|}

=== nn::gfx::TileMode (Unofficial) ===
{| class="wikitable"
!Name (Unofficial)
!Value
!Description
|-
|Optimal
|0x0
|
|-
|Linear
|0x1
|
|}

=== nn::gfx::ChannelFormat ===
{| class="wikitable"
!Name (Unofficial)
!Value
!Description
|-
|None
|0x1
|
|-
|R8
|0x2
|
|-
|R4G4B4A4
|0x3
|
|-
|R5G5B5A1
|0x5
|
|-
|A1B5G5R5
|0x6
|
|-
|R5G6B5
|0x7
|
|-
|B5G6R5
|0x8
|
|-
|R8G8
|0x9
|
|-
|R16
|0xa
|
|-
|R8G8B8A8
|0xb
|
|-
|B8G8R8A8
|0xc
|
|-
|R9G9B9E5F
|0xd
|
|-
|R10G10B10A2
|0xe
|
|-
|R11G11B10F
|0xf
|
|-
|R16G16
|0x12
|
|-
|D24S8
|0x13
|
|-
|R32
|0x14
|
|-
|R16G16B16A16
|0x15
|
|-
|D32FS8
|0x16
|
|-
|R32G32
|0x17
|
|-
|R32G32B32
|0x18
|
|-
|R32G32B32A32
|0x19
|
|-
|BC1
|0x1a
|
|-
|BC2
|0x1b
|
|-
|BC3
|0x1c
|
|-
|BC4
|0x1d
|
|-
|BC5
|0x1e
|
|-
|BC6H
|0x1f
|
|-
|BC7U
|0x20
|
|-
|ASTC_4x4
|0x2d
|
|-
|ASTC_5x4
|0x2e
|
|-
|ASTC_5x5
|0x2f
|
|-
|ASTC_6x5
|0x30
|
|-
|ASTC_6x6
|0x31
|
|-
|ASTC_8x5
|0x32
|
|-
|ASTC_8x6
|0x33
|
|-
|ASTC_8x8
|0x34
|
|-
|ASTC_10x5
|0x35
|
|-
|ASTC_10x6
|0x26
|
|-
|ASTC_10x8
|0x37
|
|-
|ASTC_10x10
|0x38
|
|-
|ASTC_12x10
|0x39
|
|-
|ASTC_12x12
|0x3a
|
|-
|B5G5R5A1
|0x3b
|
|}

=== nn::gfx::TypeFormat ===
{| class="wikitable"
!Name (Unofficial)
!Value
!Description
|-
|Unorm
|0x1
|
|-
|Snorm
|0x2
|
|-
|UInt
|0x3
|
|-
|SInt
|0x4
|
|-
|Float
|0x5
|
|-
|SRGB
|0x6
|
|-
|Depth
|0x7
|
|-
|UScaled
|0x8
|
|-
|SScaled
|0x9
|
|-
|UFloat
|0xa
|
|}

=== nn::gfx::ImageFormat ===
Image formats are formed by a ChannelFormat and a TypeFormat. ImageFormat = (ChannelFormat << 8) | TypeFormat
{| class="wikitable"
!Name (Unofficial)
!Value
!Description
|-
|R8_Unorm
|
|
|-
|R8_Snorm
|
|
|-
|R8_UInt
|
|
|-
|R8_SInt
|
|
|-
|R4G4B4A4_Unorm
|
|
|-
|R5G5B5A1_Unorm
|
|
|-
|A1B5G5R5_Unorm
|
|
|-
|R5G6B5_Unorm
|
|
|-
|B5G6R5_Unorm
|
|
|-
|R8G8_Unorm
|
|
|-
|R8G8_Snorm
|
|
|-
|R8G8_UInt
|
|
|-
|R8G8_SInt
|
|
|-
|R16_Unorm
|
|
|-
|R16_Snorm
|
|
|-
|R16_UInt
|
|
|-
|R16_SInt
|
|
|-
|R16_Float
|
|
|-
|Z16_Depth
|
|
|-
|R8G8B8A8_Unorm
|
|
|-
|R8G8B8A8_Snorm
|
|
|-
|R8G8B8A8_UInt
|
|
|-
|R8G8B8A8_SInt
|
|
|-
|R8G8B8A8_SRGB
|
|
|-
|B8G8R8A8_Unorm
|
|
|-
|B8G8R8A8_SRGB
|
|
|-
|R9G9B9E5F_SharedFloat
|
|
|-
|R10G10B10A2_Unorm
|
|
|-
|R10G10B10A2_UInt
|
|
|-
|R11G11B10F_Float
|
|
|-
|R16G16_Unorm
|
|
|-
|R16G16_Snorm
|
|
|-
|R16G16_UInt
|
|
|-
|R16G16_SInt
|
|
|-
|R16G16_Float
|
|
|-
|D24S8_Depth
|
|
|-
|R32_UInt
|
|
|-
|R32_SInt
|
|
|-
|R32_Float
|
|
|-
|D32F_Depth
|
|
|-
|R16G16B16A16_Unorm
|
|
|-
|R16G16B16A16_Snorm
|
|
|-
|R16G16B16A16_UInt
|
|
|-
|R16G16B16A16_SInt
|
|
|-
|R16G16B16A16_Float
|
|
|-
|D32FS8_Depth
|
|
|-
|R32G32_UInt
|
|
|-
|R32G32_SInt
|
|
|-
|R32G32_Float
|
|
|-
|R32G32B32_UInt
|
|
|-
|R32G32B32_SInt
|
|
|-
|R32G32B32_Float
|
|
|-
|R32G32B32A32_UInt
|
|
|-
|R32G32B32A32_SInt
|
|
|-
|R32G32B32A32_Float
|
|
|-
|BC1_Unorm
|
|
|-
|BC1_SRGB
|
|
|-
|BC2_Unorm
|
|
|-
|BC2_SRGB
|
|
|-
|BC3_Unorm
|
|
|-
|BC3_SRGB
|
|
|-
|BC4_Unorm
|
|
|-
|BC4_Snorm
|
|
|-
|BC5_Unorm
|
|
|-
|BC5_Snorm
|
|
|-
|BC6H_SF16
|
|
|-
|BC6H_UF16
|
|
|-
|BC7U_Unorm
|
|
|-
|BC7U_SRGB
|
|
|-
|ASTC_4X4_Unorm
|
|
|-
|ASTC_4X4_SRGB
|
|
|-
|ASTC_5X4_Unorm
|
|
|-
|ASTC_5X4_SRGB
|
|
|-
|ASTC_5X5_Unorm
|
|
|-
|ASTC_5X5_SRGB
|
|
|-
|ASTC_6X5_Unorm
|
|
|-
|ASTC_6X5_SRGB
|
|
|-
|ASTC_6X6_Unorm
|
|
|-
|ASTC_6X6_SRGB
|
|
|-
|ASTC_8X5_Unorm
|
|
|-
|ASTC_8X5_SRGB
|
|
|-
|ASTC_8X6_Unorm
|
|
|-
|ASTC_8X6_SRGB
|
|
|-
|ASTC_8X8_Unorm
|
|
|-
|ASTC_8X8_SRGB
|
|
|-
|ASTC_10X5_Unorm
|
|
|-
|ASTC_10X5_SRGB
|
|
|-
|ASTC_10X6_Unorm
|
|
|-
|ASTC_10X6_SRGB
|
|
|-
|ASTC_10X8_Unorm
|
|
|-
|ASTC_10X8_SRGB
|
|
|-
|ASTC_10X10_Unorm
|
|
|-
|ASTC_10X10_SRGB
|
|
|-
|ASTC_12X10_Unorm
|
|
|-
|ASTC_12X10_SRGB
|
|
|-
|ASTC_12X12_Unorm
|
|
|-
|ASTC_12X12_SRGB
|
|
|-
|B5G5R5A1_Unorm
|
|
|}

=== nn::gfx::TextureInfo ===
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0:0
|1 bit
|u8
|Is Packaged Texture
|-
|0x0:1
|1 bit
|u8
|Is Sparse Binding
|-
|0x0:2
|1 bit
|u8
|Is Sparse
|-
|0x0:3
|1 bit
|u8
|Is ResTexture
|-
|0x0:4
|4 bit
|u8
|Reserved
|-
|0x1
|0x1
|u8
|Storage dimension (nn::gfx::ImageStorageDimension)
|-
|0x2
|0x2
|u16
|Tile mode (nn::gfx::TileMode)
|-
|0x4
|0x2
|u16
|Swizzle (???)
|-
|0x6
|0x2
|u16
|Mip levels
|-
|0x8
|0x2
|u16
|Sample count
|-
|0xa
|0x2
|u16
|Reserved
|-
|0xc
|0x4
|u32
|Image format (nn::gfx::ImageFormat)
|-
|0x10
|0x4
|u32
|Gpu access flags (nn::gfx::GpuAccessFlags)
|-
|0x14
|0x4
|u32
|Width
|-
|0x18
|0x4
|u32
|Height
|-
|0x1c
|0x4
|u32
|Depth
|-
|0x20
|0x4
|u32
|Array layers
|-
|0x24
|0x4
|u32
|Packaged texture layout (???)
|}

=== nn::gfx::TextureAddressMode ===
{| class="wikitable"
!Name (Unofficial)
!Value
!Description
|-
|Repeat
|0x0
|
|-
|MirrorRepeat
|0x1
|
|-
|ClampToEdge
|0x2
|
|-
|ClampToBorder
|0x3
|
|-
|MirrorClampToBorder
|0x4
|
|}

=== nn::gfx::ComparisonFunction ===
{| class="wikitable"
!Name (Unofficial)
!Value
!Description
|-
|Never
|0x0
|
|-
|LessThan
|0x1
|
|-
|Equal
|0x2
|
|-
|LessThanEqual
|0x3
|
|-
|GreateThan
|0x4
|
|-
|NotEqual
|0x5
|
|-
|GreaterThanEqual
|0x6
|
|-
|Always
|0x7
|
|}

=== nn::gfx::BorderColor (Unofficial) ===
{| class="wikitable"
!Name (Unofficial)
!Value
!Description
|-
|White
|0x0
|
|-
|TransparentBlack
|0x1
|
|-
|Black
|0x2
|
|}

=== nn::gfx::MipMapFilter (Unofficial) ===
{| class="wikitable"
!Name (Unofficial)
!Value
!Description
|-
|None
|0x0
|
|-
|Nearest
|0x1
|
|-
|Linear
|0x2
|
|}

=== nn::gfx::MagFilter (Unofficial) ===
{| class="wikitable"
!Name (Unofficial)
!Value
!Description
|-
|Invalid
|0x0
|
|-
|Nearest
|0x1
|
|-
|Linear
|0x2
|
|}

=== nn::gfx::MinFilter (Unofficial) ===
{| class="wikitable"
!Name (Unofficial)
!Value
!Description
|-
|Invalid
|0x0
|
|-
|Nearest
|0x1
|
|-
|Linear
|0x2
|
|}

=== nn::gfx::ReductionFilter (Unofficial) ===
{| class="wikitable"
!Name (Unofficial)
!Value
!Description
|-
|Average
|0x0
|
|-
|Min
|0x1
|
|-
|Max
|0x2
|
|}

=== nn::gfx::SamplerInfo ===
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x1
|u8
|Wrap Mode U (nn::gfx::TextureAddressMode)
|-
|0x1
|0x1
|u8
|Wrap Mode V (nn::gfx::TextureAddressMode)
|-
|0x2
|0x1
|u8
|Wrap Mode W (nn::gfx::TextureAddressMode)
|-
|0x3
|0x1
|u8
|CompareOp (nn::gfx::ComparisonFunction)
|-
|0x4
|0x1
|u8
|Border color (nn::gfx::BorderColor)
|-
|0x5
|0x1
|u8
|Max anisotropy
|-
|0x6:0
|2 bit
|u16
|MipMap filter (nn::gfx::MipMapFilter)
|-
|0x6:2
|2 bit
|u16
|Mag filter (nn::gfx::MagFilter)
|-
|0x6:4
|2 bit
|u16
|Min filter (nn::gfx::MinFilter)
|-
|0x6:6
|1 bit
|u16
|Enable anisotropy
|-
|0x6:7
|1 bit
|u16
|Enable CompareOp
|-
|0x6:8
|2 bit
|u16
|Reduction filter (nn::gfx::ReductionFilter)
|-
|0x6:a
|6 bit
|u16
|Reserved
|-
|0x8
|0x4
|Float
|Lod clamp min
|-
|0xc
|0x4
|Float
|Lod clamp max
|-
|0x10
|0x4
|Float
|Lod bias
|-
|0x14
|0x4
|u32
|Reserved
|-
|0x18
|0x4
|u32
|Reserved
|-
|0x1c
|0x4
|u32
|Reserved
|}

=== Gfx Embed File ===
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|void *
|Offset to file
|-
|0x8
|0x4
|u32
|Size of file
|-
|0xc
|0x4
|u32
|???
|}

=== Gfx User Data Type ===
{| class="wikitable"
!Name (Unofficial)
!Value
!Description
|-
|S32
|0x0
|
|-
|Float
|0x1
|
|-
|String
|0x2
|
|-
|Byte
|0x3
|Used for arbitrary binary data (other files)
|}

=== Gfx User Data ===
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|const char *
|User data name
|-
|0x8
|0x8
|void *
|User data (can be nullptr)
|-
|0x10
|0x4
|s32
|User data entries
|-
|0x14
|0x1
|u8
|User Data Type
|-
|0x15
|0x2b
|u8[0x2b]
|Reserved
|}
[[Category:File formats]]

Common nn::gfx

2023-05-09T20:35:02Z

Watertoon: Correct enum class names and mark unofficial ones.

Structures and enums from nn::gfx appearing across nn::gfx file formats and nn::g3d file formats. Notably the nn::gfx formats [[Bnsh]] and [[Bntx]], as well as nn::g3d [[Bfres]].

=== nn::gfx::MemoryPoolFlags ===
Flags denoting how a memory pool can be accessed.
{| class="wikitable"
!Name (Unofficial)
!Value
!Description
|-
|CpuNoAccess
|0x1 (1 << 0)
|Memory is unable to be mapped to CPU
|-
|CpuUncached
|0x2 (1 << 1)
|Memory is coherent on CPU
|-
|CpuCached
|0x4 (1 << 2)
|Memory is cached on CPU
|-
|GpuNoAccess
|0x8 (1 << 3)
|Memory is unable to be read by the GPU
|-
|GpuUncached
|0x10 (1 << 4)
|Memory is coherent on GPU
|-
|GpuCached
|0x20 (1 << 5)
|Memory is cached on GPU
|-
|ShaderCode
|0x40 (1 << 6)
|Memory is shader code for the GPU
|-
|Compressible
|0x80 (1 << 7)
|???
|-
|Physical
|0x100 (1 << 8)
|???
|-
|Virtual
|0x200 (1 << 9)
|???
|}

=== nn::gfx::MemoryPoolInfo ===
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32 (nn::gfx::MemoryPoolFlags)
|MemoryPool flags
|-
|0x4
|0x4
|u32
|Memory size
|-
|0x8
|0x8
|void *
|Memory pointer (must be 0x1000 aka page aligned)
|}

=== nn::gfx::GpuAccessFlags ===
Flags denoting how a buffer or texture will be accessed.
{| class="wikitable"
!Name (Unofficial)
!Value
!Description
|-
|VertexBuffer
|0x4 (1 << 2)
|Vertex buffer
|-
|IndexBuffer
|0x8 (1 << 3)
|Index buffer
|-
|UniformBuffer
|0x10 (1 << 4)
|Uniform/Storage buffer
|-
|Texture
|0x20 (1 << 5)
|Texture
|-
|TransferDestination
|0x40 (1 << 6)
|Transfer destination
|-
|RenderTargetColor
|0x80 (1 << 7)
|For render target colors
|-
|RenderTargetDepth
|0x100 (1 << 8)
|For render target depths
|-
|IndirectDraw
|0x200 (1 << 9)
|For indirect draw commands
|-
|DisplayTexture
|0x400 (1 << 10)
|For present
|-
|Counter
|0x800 (1 << 11)
|???
|}

=== nn::gfx::BufferInfo ===
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Buffer size
|-
|0x4
|0x4
|u32 (nn::gfx::GpuAccessFlags)
|GPU access flags
|-
|0x8
|0x4
|u32
|Reserved
|-
|0xc
|0x4
|u32
|Reserved
|}

=== nn::gfx:::ImageStorageDimension ===
{| class="wikitable"
!Name (Unofficial)
!Value
!Description
|-
|Type1D
|0x1
|
|-
|Type2D
|0x2
|
|-
|Type3D
|0x3
|
|}

=== nn::gfx::TileMode (Unofficial) ===
{| class="wikitable"
!Name (Unofficial)
!Value
!Description
|-
|Optimal
|0x0
|
|-
|Linear
|0x1
|
|}

=== nn::gfx::ChannelFormat ===
{| class="wikitable"
!Name (Unofficial)
!Value
!Description
|-
|None
|0x1
|
|-
|R8
|0x2
|
|-
|R4G4B4A4
|0x3
|
|-
|R5G5B5A1
|0x5
|
|-
|A1B5G5R5
|0x6
|
|-
|R5G6B5
|0x7
|
|-
|B5G6R5
|0x8
|
|-
|R8G8
|0x9
|
|-
|R16
|0xa
|
|-
|R8G8B8A8
|0xb
|
|-
|B8G8R8A8
|0xc
|
|-
|R9G9B9E5F
|0xd
|
|-
|R10G10B10A2
|0xe
|
|-
|R11G11B10F
|0xf
|
|-
|R16G16
|0x12
|
|-
|D24S8
|0x13
|
|-
|R32
|0x14
|
|-
|R16G16B16A16
|0x15
|
|-
|D32FS8
|0x16
|
|-
|R32G32
|0x17
|
|-
|R32G32B32
|0x18
|
|-
|R32G32B32A32
|0x19
|
|-
|BC1
|0x1a
|
|-
|BC2
|0x1b
|
|-
|BC3
|0x1c
|
|-
|BC4
|0x1d
|
|-
|BC5
|0x1e
|
|-
|BC6H
|0x1f
|
|-
|BC7U
|0x20
|
|-
|ASTC_4x4
|0x2d
|
|-
|ASTC_5x4
|0x2e
|
|-
|ASTC_5x5
|0x2f
|
|-
|ASTC_6x5
|0x30
|
|-
|ASTC_6x6
|0x31
|
|-
|ASTC_8x5
|0x32
|
|-
|ASTC_8x6
|0x33
|
|-
|ASTC_8x8
|0x34
|
|-
|ASTC_10x5
|0x35
|
|-
|ASTC_10x6
|0x26
|
|-
|ASTC_10x8
|0x37
|
|-
|ASTC_10x10
|0x38
|
|-
|ASTC_12x10
|0x39
|
|-
|ASTC_12x12
|0x3a
|
|-
|B5G5R5A1
|0x3b
|
|}

=== nn::gfx::TypeFormat ===
{| class="wikitable"
!Name (Unofficial)
!Value
!Description
|-
|Unorm
|0x1
|
|-
|Snorm
|0x2
|
|-
|UInt
|0x3
|
|-
|SInt
|0x4
|
|-
|Float
|0x5
|
|-
|SRGB
|0x6
|
|-
|Depth
|0x7
|
|-
|UScaled
|0x8
|
|-
|SScaled
|0x9
|
|-
|UFloat
|0xa
|
|}

=== nn::gfx::ImageFormat ===
Image formats are formed by a ChannelFormat and a TypeFormat. ImageFormat = (ChannelFormat << 8) | TypeFormat
{| class="wikitable"
!Name (Unofficial)
!Value
!Description
|-
|R8_Unorm
|
|
|-
|R8_Snorm
|
|
|-
|R8_UInt
|
|
|-
|R8_SInt
|
|
|-
|R4G4B4A4_Unorm
|
|
|-
|R5G5B5A1_Unorm
|
|
|-
|A1B5G5R5_Unorm
|
|
|-
|R5G6B5_Unorm
|
|
|-
|B5G6R5_Unorm
|
|
|-
|R8G8_Unorm
|
|
|-
|R8G8_Snorm
|
|
|-
|R8G8_UInt
|
|
|-
|R8G8_SInt
|
|
|-
|R16_Unorm
|
|
|-
|R16_Snorm
|
|
|-
|R16_UInt
|
|
|-
|R16_SInt
|
|
|-
|R16_Float
|
|
|-
|Z16_Depth
|
|
|-
|R8G8B8A8_Unorm
|
|
|-
|R8G8B8A8_Snorm
|
|
|-
|R8G8B8A8_UInt
|
|
|-
|R8G8B8A8_SInt
|
|
|-
|R8G8B8A8_SRGB
|
|
|-
|B8G8R8A8_Unorm
|
|
|-
|B8G8R8A8_SRGB
|
|
|-
|R9G9B9E5F_SharedFloat
|
|
|-
|R10G10B10A2_Unorm
|
|
|-
|R10G10B10A2_UInt
|
|
|-
|R11G11B10F_Float
|
|
|-
|R16G16_Unorm
|
|
|-
|R16G16_Snorm
|
|
|-
|R16G16_UInt
|
|
|-
|R16G16_SInt
|
|
|-
|R16G16_Float
|
|
|-
|D24S8_Depth
|
|
|-
|R32_UInt
|
|
|-
|R32_SInt
|
|
|-
|R32_Float
|
|
|-
|D32F_Depth
|
|
|-
|R16G16B16A16_Unorm
|
|
|-
|R16G16B16A16_Snorm
|
|
|-
|R16G16B16A16_UInt
|
|
|-
|R16G16B16A16_SInt
|
|
|-
|R16G16B16A16_Float
|
|
|-
|D32FS8_Depth
|
|
|-
|R32G32_UInt
|
|
|-
|R32G32_SInt
|
|
|-
|R32G32_Float
|
|
|-
|R32G32B32_UInt
|
|
|-
|R32G32B32_SInt
|
|
|-
|R32G32B32_Float
|
|
|-
|R32G32B32A32_UInt
|
|
|-
|R32G32B32A32_SInt
|
|
|-
|R32G32B32A32_Float
|
|
|-
|BC1_Unorm
|
|
|-
|BC1_SRGB
|
|
|-
|BC2_Unorm
|
|
|-
|BC2_SRGB
|
|
|-
|BC3_Unorm
|
|
|-
|BC3_SRGB
|
|
|-
|BC4_Unorm
|
|
|-
|BC4_Snorm
|
|
|-
|BC5_Unorm
|
|
|-
|BC5_Snorm
|
|
|-
|BC6H_SF16
|
|
|-
|BC6H_UF16
|
|
|-
|BC7U_Unorm
|
|
|-
|BC7U_SRGB
|
|
|-
|ASTC_4X4_Unorm
|
|
|-
|ASTC_4X4_SRGB
|
|
|-
|ASTC_5X4_Unorm
|
|
|-
|ASTC_5X4_SRGB
|
|
|-
|ASTC_5X5_Unorm
|
|
|-
|ASTC_5X5_SRGB
|
|
|-
|ASTC_6X5_Unorm
|
|
|-
|ASTC_6X5_SRGB
|
|
|-
|ASTC_6X6_Unorm
|
|
|-
|ASTC_6X6_SRGB
|
|
|-
|ASTC_8X5_Unorm
|
|
|-
|ASTC_8X5_SRGB
|
|
|-
|ASTC_8X6_Unorm
|
|
|-
|ASTC_8X6_SRGB
|
|
|-
|ASTC_8X8_Unorm
|
|
|-
|ASTC_8X8_SRGB
|
|
|-
|ASTC_10X5_Unorm
|
|
|-
|ASTC_10X5_SRGB
|
|
|-
|ASTC_10X6_Unorm
|
|
|-
|ASTC_10X6_SRGB
|
|
|-
|ASTC_10X8_Unorm
|
|
|-
|ASTC_10X8_SRGB
|
|
|-
|ASTC_10X10_Unorm
|
|
|-
|ASTC_10X10_SRGB
|
|
|-
|ASTC_12X10_Unorm
|
|
|-
|ASTC_12X10_SRGB
|
|
|-
|ASTC_12X12_Unorm
|
|
|-
|ASTC_12X12_SRGB
|
|
|-
|B5G5R5A1_Unorm
|
|
|}

=== nn::gfx::TextureInfo ===
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0:0
|1 bit
|u8
|Is Packaged Texture
|-
|0x0:1
|1 bit
|u8
|Is Sparse Binding
|-
|0x0:2
|1 bit
|u8
|Is Sparse
|-
|0x0:3
|1 bit
|u8
|Is ResTexture
|-
|0x0:4
|4 bit
|u8
|Reserved
|-
|0x1
|0x1
|u8
|Storage dimension (nn::gfx::ImageStorageDimension)
|-
|0x2
|0x2
|u16
|Tile mode (nn::gfx::TileMode)
|-
|0x4
|0x2
|u16
|Swizzle (???)
|-
|0x6
|0x2
|u16
|Mip levels
|-
|0x8
|0x2
|u16
|Sample count
|-
|0xa
|0x2
|u16
|Reserved
|-
|0xc
|0x4
|u32
|Image format (nn::gfx::ImageFormat)
|-
|0x10
|0x4
|u32
|Gpu access flags (nn::gfx::GpuAccessFlags)
|-
|0x14
|0x4
|u32
|Width
|-
|0x18
|0x4
|u32
|Height
|-
|0x1c
|0x4
|u32
|Depth
|-
|0x20
|0x4
|u32
|Array layers
|-
|0x24
|0x4
|u32
|Packaged texture layout (???)
|}

=== nn::gfx::TextureAddressMode ===
{| class="wikitable"
!Name (Unofficial)
!Value
!Description
|-
|Repeat
|0x0
|
|-
|MirrorRepeat
|0x1
|
|-
|ClampToEdge
|0x2
|
|-
|ClampToBorder
|0x3
|
|-
|MirrorClampToBorder
|0x4
|
|}

=== nn::gfx::ComparisonFunction ===
{| class="wikitable"
!Name (Unofficial)
!Value
!Description
|-
|Never
|0x0
|
|-
|LessThan
|0x1
|
|-
|Equal
|0x2
|
|-
|LessThanEqual
|0x3
|
|-
|GreateThan
|0x4
|
|-
|NotEqual
|0x5
|
|-
|GreaterThanEqual
|0x6
|
|-
|Always
|0x7
|
|}

=== nn::gfx::BorderColor (Unofficial) ===
{| class="wikitable"
!Name (Unofficial)
!Value
!Description
|-
|White
|0x0
|
|-
|TransparentBlack
|0x1
|
|-
|Black
|0x2
|
|}

=== nn::gfx::MipMapFilter (Unofficial) ===
{| class="wikitable"
!Name (Unofficial)
!Value
!Description
|-
|None
|0x0
|
|-
|Nearest
|0x1
|
|-
|Linear
|0x2
|
|}

=== nn::gfx::MagFilter (Unofficial) ===
{| class="wikitable"
!Name (Unofficial)
!Value
!Description
|-
|Invalid
|0x0
|
|-
|Nearest
|0x1
|
|-
|Linear
|0x2
|
|}

=== nn::gfx::MinFilter (Unofficial) ===
{| class="wikitable"
!Name (Unofficial)
!Value
!Description
|-
|Invalid
|0x0
|
|-
|Nearest
|0x1
|
|-
|Linear
|0x2
|
|}

=== nn::gfx::ReductionFilter (Unofficial) ===
{| class="wikitable"
!Name (Unofficial)
!Value
!Description
|-
|Average
|0x0
|
|-
|Min
|0x1
|
|-
|Max
|0x2
|
|}

=== nn::gfx::SamplerInfo ===
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x1
|u8
|Wrap Mode U (nn::gfx::TextureAddressMode)
|-
|0x1
|0x1
|u8
|Wrap Mode V (nn::gfx::TextureAddressMode)
|-
|0x2
|0x1
|u8
|Wrap Mode W (nn::gfx::TextureAddressMode)
|-
|0x3
|0x1
|u8
|CompareOp (nn::gfx::ComparisonFunction)
|-
|0x4
|0x1
|u8
|Border color (nn::gfx::BorderColor)
|-
|0x5
|0x1
|u8
|Max anisotropy
|-
|0x6:0
|2 bit
|u16
|MipMap filter (nn::gfx::MipMapFilter)
|-
|0x6:2
|2 bit
|u16
|Mag filter (nn::gfx::MagFilter)
|-
|0x6:4
|2 bit
|u16
|Min filter (nn::gfx::MinFilter)
|-
|0x6:6
|1 bit
|u16
|Enable anisotropy
|-
|0x6:7
|1 bit
|u16
|Enable CompareOp
|-
|0x6:8
|2 bit
|u16
|Reduction filter (nn::gfx::ReductionFilter)
|-
|0x6:a
|6 bit
|u16
|Reserved
|-
|0x8
|0x4
|Float
|Lod clamp min
|-
|0xc
|0x4
|Float
|Lod clamp max
|-
|0x10
|0x4
|Float
|Lod bias
|-
|0x14
|0x4
|u32
|Reserved
|-
|0x18
|0x4
|u32
|Reserved
|-
|0x1c
|0x4
|u32
|Reserved
|}

=== Gfx Embed File ===
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|void *
|Offset to file
|-
|0x8
|0x4
|u32
|Size of file
|-
|0xc
|0x4
|u32
|???
|}

=== Gfx User Data Type ===
{| class="wikitable"
!Name (Unofficial)
!Value
!Description
|-
|S32
|0x0
|
|-
|Float
|0x1
|
|-
|Strin
|0x2
|
|-
|Byte
|0x3
|Used for arbitrary binary data (other files)
|}

=== Gfx User Data ===
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|cosnt char *
|User data name
|-
|0x8
|0x8
|void *
|User data (can be nullptr)
|-
|0x10
|0x4
|s32
|User data entries
|-
|0x14
|0x1
|u8
|User Data Type
|-
|0x15
|0x2b
|u8[0x2b]
|Reserved
|}
[[Category:File formats]]

Sarc

2023-05-09T20:25:50Z

Watertoon:

Sarc is a file archive format. Files are typically accessed by a binary sorted by a hash value derived from a custom hash function. For a more detailed article, see: https://github.com/Kinnay/Nintendo-File-Formats/wiki/SARC-File-Format

=== Header ===
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Magic ("SARC" in big endian)
|-
|0x4
|0x2
|u16
|Size of header (0x14)
|-
|0x6
|0x2
|u16
|Endianess (Always reads as 0xfeff in platform's native endian)
|-
|0x8
|0x4
|u32
|Total file size
|-
|0xc
|0x4
|u32
|File array offset
|-
|0x10
|0x4
|u32
|Alignment
|-
|0x14
|0x2
|u16
|Version
|-
|0x16
|0x2
|u16
|Reserved
|}

=== Sfat Section ===
The sfat section follows after the sarc header (header + size of header).

==== Sfat Header ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Magic ("SFAT" in big endian)
|-
|0x4
|0x2
|u16
|Size of header (0x14)
|-
|0x6
|0x2
|u16
|File count
|-
|0x8
|0x4
|u32
|Hash seed
|}

==== Sfat Entry Array ====
The sfat entry array follows the sfat header (header + size of header). Array is sized by the sfat header file count, and is sorted by a custom hash derived from the hash seed in the sfat header.
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|File name hash
|-
|0x4
|0x3
|u24
|File name offset (may be invalid)
|-
|0x7
|0x1
|u8
|Number of file hash collisions
|-
|0x8
|0x4
|u32
|File array start offset
|-
|0xc
|0x4
|u32
|File array end offset
|}

=== Sfnt Section ===
Following the sfat section is the sfnt section, a header preceding an array of file path of null-terminated strings.
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Magic ("SFAT" in big endian)
|-
|0x4
|0x2
|u16
|Size of header (0x8)
|-
|0x6
|0x2
|u16
|Reserved
|}
[[Category:File formats]]

Sarc

2023-05-09T20:25:30Z

Watertoon: Link Kinnay's sarc documentation.

Sarc is a file archive format. Files are typically accessed by a binary sorted by a hash value derived from a custom hash function. See for a more detailed article: https://github.com/Kinnay/Nintendo-File-Formats/wiki/SARC-File-Format

=== Header ===
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Magic ("SARC" in big endian)
|-
|0x4
|0x2
|u16
|Size of header (0x14)
|-
|0x6
|0x2
|u16
|Endianess (Always reads as 0xfeff in platform's native endian)
|-
|0x8
|0x4
|u32
|Total file size
|-
|0xc
|0x4
|u32
|File array offset
|-
|0x10
|0x4
|u32
|Alignment
|-
|0x14
|0x2
|u16
|Version
|-
|0x16
|0x2
|u16
|Reserved
|}

=== Sfat Section ===
The sfat section follows after the sarc header (header + size of header).

==== Sfat Header ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Magic ("SFAT" in big endian)
|-
|0x4
|0x2
|u16
|Size of header (0x14)
|-
|0x6
|0x2
|u16
|File count
|-
|0x8
|0x4
|u32
|Hash seed
|}

==== Sfat Entry Array ====
The sfat entry array follows the sfat header (header + size of header). Array is sized by the sfat header file count, and is sorted by a custom hash derived from the hash seed in the sfat header.
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|File name hash
|-
|0x4
|0x3
|u24
|File name offset (may be invalid)
|-
|0x7
|0x1
|u8
|Number of file hash collisions
|-
|0x8
|0x4
|u32
|File array start offset
|-
|0xc
|0x4
|u32
|File array end offset
|}

=== Sfnt Section ===
Following the sfat section is the sfnt section, a header preceding an array of file path of null-terminated strings.
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Magic ("SFAT" in big endian)
|-
|0x4
|0x2
|u16
|Size of header (0x8)
|-
|0x6
|0x2
|u16
|Reserved
|}
[[Category:File formats]]

Sarc

2023-05-09T20:06:55Z

Watertoon:

Sarc is a file archive format. Files are typically accessed by a binary sorted by a hash value derived from a custom hash function.

=== Header ===
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Magic ("SARC" in big endian)
|-
|0x4
|0x2
|u16
|Size of header (0x14)
|-
|0x6
|0x2
|u16
|Endianess (Always reads as 0xfeff in platform's native endian)
|-
|0x8
|0x4
|u32
|Total file size
|-
|0xc
|0x4
|u32
|File array offset
|-
|0x10
|0x4
|u32
|Alignment
|-
|0x14
|0x2
|u16
|Version
|-
|0x16
|0x2
|u16
|Reserved
|}

=== Sfat Section ===
The sfat section follows after the sarc header (header + size of header).

==== Sfat Header ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Magic ("SFAT" in big endian)
|-
|0x4
|0x2
|u16
|Size of header (0x14)
|-
|0x6
|0x2
|u16
|File count
|-
|0x8
|0x4
|u32
|Hash seed
|}

==== Sfat Entry Array ====
The sfat entry array follows the sfat header (header + size of header). Array is sized by the sfat header file count, and is sorted by a custom hash derived from the hash seed in the sfat header.
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|File name hash
|-
|0x4
|0x3
|u24
|File name offset (may be invalid)
|-
|0x7
|0x1
|u8
|Number of file hash collisions
|-
|0x8
|0x4
|u32
|File array start offset
|-
|0xc
|0x4
|u32
|File array end offset
|}

=== Sfnt Section ===
Following the sfat section is the sfnt section, a header preceding an array of file path of null-terminated strings.
{| class="wikitable"
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Magic ("SFAT" in big endian)
|-
|0x4
|0x2
|u16
|Size of header (0x8)
|-
|0x6
|0x2
|u16
|Reserved
|}
[[Category:File formats]]