AINB - Revision history

Watertoon: Multi-Input corrections.

2026-01-08T03:39:09Z

Multi-Input corrections.

← Older revision		Revision as of 03:39, 8 January 2026
Line 1,378:		Line 1,378:
	\|0x02		\|0x02
	\|u16		\|u16
	\|~~Node Index~~		\|Input Element Id
	\|-		\|-
	\|0x02		\|0x02
	\|0x02		\|0x02
	\|u16		\|u16
	\|Input/Output ~~Source Parameter Index~~		\|Input Element Output Plug Id
	\|-		\|-
	\|0x04		\|0x04

Watertoon: Minor corrections

2026-01-08T03:38:15Z

Minor corrections

← Older revision		Revision as of 03:38, 8 January 2026
Line 40:		Line 40:
	# Property Parameters		# Property Parameters
	# Input/Output Parameters		# Input/Output Parameters
	# Multi-~~Parameters~~		# Multi-Inputs
	# Jump Array		# Jump Array
	# 0x50 Section (Unused in ''TotK'')		# 0x50 Section (Unused in ''TotK'')
Line 104:		Line 104:
	\|0x08		\|0x08
	\|0x04		\|0x04
	\|~~u32~~		\|AinbString
	\|Filename ~~Offset~~		\|Filename
	\|-		\|-
	\|0x0C		\|0x0C
Line 225:		Line 225:
	\|0x04		\|0x04
	\|AinbPtr<AinbArray<External Action>>		\|AinbPtr<AinbArray<External Action>>
	\|External Action Array ~~Offset~~		\|External Action Array
	\|-		\|-
	\|0x6C		\|0x6C
Line 799:		Line 799:
	\|0x02		\|0x02
	\|u16		\|u16
	\|Multi-~~Param~~ Count		\|Multi-Input Count
	\|-		\|-
	\|0x1E		\|0x1E
Line 1,057:		Line 1,057:
	\|-		\|-
	\|1		\|1
	\|Is Query Multi-~~Param~~		\|Is Query Multi-Input
	\|-		\|-
	\|4		\|4
Line 1,366:		Line 1,366:
	{\| class="wikitable"		{\| class="wikitable"
	\|}		\|}

			=== Multi-Input ===
	{\| class="wikitable"		{\| class="wikitable"
	\|+Multi-Input Entry		\|+Multi-Input Entry

Watertoon: Renaming pass, rewrite parameter tables.

2026-01-08T03:32:40Z

Renaming pass, rewrite parameter tables.

Show changes

Aster: Specified that only the first version of the NSO Playtest Program uses 0x407

2025-07-26T16:05:51Z

Specified that only the first version of the NSO Playtest Program uses 0x407

← Older revision		Revision as of 16:05, 26 July 2025
Line 1:		Line 1:
	'''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.		'''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). 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 ===		=== File Structure ===

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

2025-02-11T23:33:55Z

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

Show changes

Watertoon: Rewrite head of article to clarify information.

2025-02-08T18:46:21Z

Rewrite head of article to clarify information.

← Older revision		Revision as of 18:46, 8 February 2025
Line 1:		Line 1:
	'''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~~.		'''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 ===		=== 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).		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 types for AINB parameters: int (signed 32-bit integer), bool, float (32-bit), vector3f, and pointer. Pointer parameters are pointers to objects.		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 ====		==== Section Order ====
Line 168:		Line 168:
	\|0x04		\|0x04
	\|u32		\|u32
	\|File Category (0 = AI, 1 = Logic, 2 = Sequence) ~~- only ''TotK''~~ ( ~~for~~ ''Splatoon 3'', 3 = UniqueSequenceSPL)		\|File Category (0 = AI, 1 = Logic, 2 = Sequence) (''Splatoon 3'' game specific, 3 = UniqueSequenceSPL)
	\|-		\|-
	\|0x68		\|0x68

Dt12345: update resident update stuff -> active node

2025-01-09T04:19:03Z

update resident update stuff -> active node

← Older revision		Revision as of 04:19, 9 January 2025
Line 17:		Line 17:
	# Input/Output Parameters		# Input/Output Parameters
	# Multi-Parameters		# Multi-Parameters
	# ~~Resident~~ Update Array		# Active Node Update Array
	# 0x50 Section (Unused in ''TotK'')		# 0x50 Section (Unused in ''TotK'')
	# Precondition Nodes		# Precondition Nodes
Line 103:		Line 103:
	\|0x04		\|0x04
	\|u32		\|u32
	\|~~Resident~~ Update Array Offset		\|Active Node Update Array Offset
	\|-		\|-
	\|0x34		\|0x34
Line 143:		Line 143:
	\|0x04		\|0x04
	\|u32		\|u32
	\|Unknown (unused in ''TotK'', always the same as the ~~Resident~~ Update Array Offset)		\|Unknown (unused in ''TotK'', always the same as the Active Node Update Array Offset)
	\|-		\|-
	\|0x54		\|0x54
Line 483:		Line 483:
	\|-		\|-
	\|Element_Fork		\|Element_Fork
	\|See ~~Resident~~ Update Array		\|See Active Node Update Array
	\|-		\|-
	\|Element_Join		\|Element_Join
	\|See ~~Resident~~ Update Array		\|See Active Node Update Array
	\|-		\|-
	\|Element_Alert		\|Element_Alert
Line 883:		Line 883:
	\|0x01		\|0x01
	\|u8		\|u8
	\|~~Resident~~ Update ~~Node~~ Count		\|Active Node Update Count
	\|-		\|-
	\|0x07		\|0x07
	\|0x01		\|0x01
	\|u8		\|u8
	\|~~Resident~~ Update Base Index		\|Active Node Update Base Index
	\|-		\|-
	\|0x08		\|0x08
Line 968:		Line 968:
	\|Value		\|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.		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"		{\| class="wikitable"
	\|+<code>Element_F32Selector Condition Entry</code>		\|+<code>Element_F32Selector Condition Entry</code>
Line 1,156:		Line 1,156:

	==== Internal Parameters ====		==== Internal Parameters ====
	This section contains an array of ~~internalparameters~~ 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.		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"		{\| class="wikitable"
	\|+Parameter Entry		\|+Parameter Entry
Line 1,226:		Line 1,226:

	==== Input/Output Parameters ====		==== Input/Output Parameters ====
	This section contains an array of input and output parameter entries. 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.		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"		{\| class="wikitable"
	\|+Input Parameter Entry		\|+Input Parameter Entry
Line 1,386:		Line 1,386:
	\|}		\|}

	==== ~~Resident~~ Update Array ====		==== Active Node 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.		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"		{\| class="wikitable"
	\|+		\|+
Line 1,400:		Line 1,400:
	\|-		\|-
	\|1		\|1
	\|Update Post ~~Current Command Calculation~~		\|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). ~~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.		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 ====		==== 0x50 Section ====

Dt12345: immediate param -> internal param and added node flag 3

2025-01-09T04:02:53Z

immediate param -> internal param and added node flag 3

Show changes

Bryn at 22:52, 8 January 2025

2025-01-08T22:52:55Z

← Older revision		Revision as of 22:52, 8 January 2025
Line 168:		Line 168:
	\|0x04		\|0x04
	\|u32		\|u32
	\|File Category (0 = AI, 1 = Logic, 2 = Sequence) - only ''TotK''		\|File Category (0 = AI, 1 = Logic, 2 = Sequence) - only ''TotK'' ( for ''Splatoon 3'', 3 = UniqueSequenceSPL)
	\|-		\|-
	\|0x68		\|0x68

Watertoon: Change entry string to External Action

2024-04-05T22:56:31Z

Change entry string to External Action

← Older revision		Revision as of 22:56, 5 April 2024
Line 22:		Line 22:
	# Expression Binary		# Expression Binary
	# AINB Modules		# AINB Modules
	# ~~Entry Strings~~		# External Action Array
	# File Hashes		# File Hashes
	# Child Replacement Table		# Child Replacement Table
Line 173:		Line 173:
	\|0x04		\|0x04
	\|u32		\|u32
	\|~~Entry Strings~~ Offset ~~(purpose unknown)~~		\|External Action Array Offset
	\|-		\|-
	\|0x6C		\|0x6C
Line 1,878:		Line 1,878:
	\|}		\|}

	==== ~~Entry Strings~~ ====		==== External Action Array ====
	~~The purpose of this~~ section ~~is unknown~~. The first four bytes specify the entry count.		This section appears to interact with XLink. The first four bytes specify the entry count.
	{\| class="wikitable"		{\| class="wikitable"
	\|+Entry String Entry		\|+Entry String Entry