Katana SDK - Revision history

PkR at 05:04, 26 October 2025

2025-10-26T05:04:13Z

← Older revision		Revision as of 05:04, 26 October 2025
Line 6:		Line 6:
	* The '''Shinobi''' library set interfaced with the CPU, cache and memory.		* The '''Shinobi''' library set interfaced with the CPU, cache and memory.
	* The '''Kamui''' API (low level) and the '''Ninja''' library (high level) provided access to graphics.		* The '''Kamui''' API (low level) and the '''Ninja''' library (high level) provided access to graphics.
	* The '''Manatee''' and '''Audio64''' subsystems interfaced with sound hardware.		* The [[Katana SDK/Audio\|'''Manatee''' and '''Audio64''']] subsystems interfaced with sound hardware.

	Over the years there have been multiple SDK leaks, including parts of source code for older revisions. For modding purposes, we should focus on the Ninja library, which is used by the Sonic Adventure games.		Over the years there have been multiple SDK leaks, including parts of source code for older revisions. For modding purposes, we should focus on the Ninja library, which is used by the Sonic Adventure games.

PkR at 10:22, 17 October 2025

2025-10-17T10:22:17Z

← Older revision		Revision as of 10:22, 17 October 2025
Line 1,374:		Line 1,374:

	=== Ginja ===		=== Ginja ===
	In addition to Ninja Chunk (Big Endian), some Gamecube games (and their ports to PC) use a proprietary model format that is a mix of Ninja Chunk and Nintendo's model formats. This format is used in Phantasy Star Online (Gamecube and PC, alongside with Ninja Chunk Big Endian), Sonic Adventure 2: Battle (Gamecube and PC) and Billy Hatcher (Gamecube and PC). The Ginja format has variations between games. [[SA Tools]] support the format used in SA2 and may be able to open models from other games, although not guaranteed.		In addition to Ninja Chunk (Big Endian), some Gamecube games and their ports to PC use a proprietary model format that is a mix of Ninja Chunk and Nintendo's model formats. This format, also known as "GC models" or "SA2B format", is used in Phantasy Star Online (Gamecube and PC, alongside with Ninja Chunk Big Endian), Sonic Adventure 2: Battle (Gamecube and PC) and Billy Hatcher (Gamecube and PC). The Ginja format has variations between games. [[SA Tools]] support the format used in SA2 and may be able to open models from other games, although not guaranteed.

	=== Xinja ===		=== Xinja ===

PkR at 10:16, 17 October 2025

2025-10-17T10:16:31Z

← Older revision		Revision as of 10:16, 17 October 2025
Line 1,369:		Line 1,369:

	==== Ninja Chunk (Big Endian) ====		==== Ninja Chunk (Big Endian) ====
	Skies of Arcadia Legends and Phantasy Star Online on the Gamecube use a Big Endian variation of Ninja Chunk models. No major changes were made to the Ninja Chunk model specification as far as we could tell. The byte order for Ninja Binary is inconsistent between different games (the binary chunk size value is stored in the Little Endian format in PSO but not in Skies). [[SA Tools]] can open and save both variations (for the most part).		Sonic Adventure 2 Battle, Skies of Arcadia Legends and Phantasy Star Online on the Gamecube use a Big Endian variation of Ninja Chunk models. No major changes were made to the Ninja Chunk model specification as far as we could tell. The byte order for Ninja Binary is inconsistent between different games (the binary chunk size value is stored in the Little Endian format in PSO but not in Skies). [[SA Tools]] can open and save both variations (for the most part).

	Some specific chunk models in SA2B Gamecube and SA2 PC (such as Chao Garden trees) can store vertex colors as either <code>RGBA</code> (SA2B GC) or <code>ARGB</code> (SA2 PC). The PC version has different rendering functions for different color byte orders.		Some specific chunk models in SA2B Gamecube and SA2 PC (such as Chao Garden trees) can store vertex colors as either <code>RGBA</code> (SA2B GC) or <code>ARGB</code> (SA2 PC). The PC version has different rendering functions for different color byte orders.

PkR at 10:16, 17 October 2025

2025-10-17T10:16:07Z

← Older revision		Revision as of 10:16, 17 October 2025
Line 1,362:		Line 1,362:
	[[SA Tools]] have full support for both Basic and Basic+ formats.		[[SA Tools]] have full support for both Basic and Basic+ formats.

	=== Ninja Chunk (Big Endian) ===		=== Ninja for Gamecube ===
			The byte values for material and vertex colors are stored in the order <code>RGBA</code> instead of <code>ABGR</code> in regular Ninja.

			==== Ninja Basic differences ====
			In the Gamecube version of SADX, the order of fields in <code>NJS_TEX</code> is swapped: V comes before U.

			==== Ninja Chunk (Big Endian) ====
	Skies of Arcadia Legends and Phantasy Star Online on the Gamecube use a Big Endian variation of Ninja Chunk models. No major changes were made to the Ninja Chunk model specification as far as we could tell. The byte order for Ninja Binary is inconsistent between different games (the binary chunk size value is stored in the Little Endian format in PSO but not in Skies). [[SA Tools]] can open and save both variations (for the most part).		Skies of Arcadia Legends and Phantasy Star Online on the Gamecube use a Big Endian variation of Ninja Chunk models. No major changes were made to the Ninja Chunk model specification as far as we could tell. The byte order for Ninja Binary is inconsistent between different games (the binary chunk size value is stored in the Little Endian format in PSO but not in Skies). [[SA Tools]] can open and save both variations (for the most part).

			Some specific chunk models in SA2B Gamecube and SA2 PC (such as Chao Garden trees) can store vertex colors as either <code>RGBA</code> (SA2B GC) or <code>ARGB</code> (SA2 PC). The PC version has different rendering functions for different color byte orders.

	=== Ginja ===		=== Ginja ===

PkR at 10:08, 17 October 2025

2025-10-17T10:08:44Z

← Older revision		Revision as of 10:08, 17 October 2025
Line 1,308:		Line 1,308:
	NJS_MOTION motion_yasi_mi = { mdata_yasi_mi, 20, NJD_MTYPE_POS_0 \| NJD_MTYPE_ANG_1, NJD_MTYPE_LINER \| 2 };		NJS_MOTION motion_yasi_mi = { mdata_yasi_mi, 20, NJD_MTYPE_POS_0 \| NJD_MTYPE_ANG_1, NJD_MTYPE_LINER \| 2 };
	</syntaxhighlight>The motion has 20 frames and uses position and rotation animation data (two elements), so <code>MDATA2</code> is used. The rotation data has five keyframes, and the position data has 20 keyframes.		</syntaxhighlight>The motion has 20 frames and uses position and rotation animation data (two elements), so <code>MDATA2</code> is used. The rotation data has five keyframes, and the position data has 20 keyframes.

			=== Motions and Actions ===
			The Ninja library has functions to draw animated models that use the Action structure (<code>NJS_ACTION</code>).

			An <code>NJS_ACTION</code> consists of two pointers: one to the <code>NJS_OBJECT</code> and the other to the <code>NJS_MOTION</code>.

			<code>NJS_ACTION myaction = { &myobject, &mymotion };</code>

	== Ninja Texture List ==		== Ninja Texture List ==

PkR at 10:02, 17 October 2025

2025-10-17T10:02:26Z

← Older revision		Revision as of 10:02, 17 October 2025
Line 1,016:		Line 1,016:
	== Ninja Animation Format ==		== Ninja Animation Format ==
	[[File:Katana SDK 1760683845026.png\|left\|thumb\|Eggman model nodes in SAMDL]]		[[File:Katana SDK 1760683845026.png\|left\|thumb\|Eggman model nodes in SAMDL]]
	Ninja models use a node-like hierarchy of <code>NJS_OBJECT</code>s that are linked together using parent-child-sibling relationships. In the [[SAMDL]] screenshot ~~below~~, the object <code>object_g_g0000_eggman_eggman</code> is the root node, which has a child node <code>object_g_g0000_eggman_body</code> (selected). The child node has a sibling node <code>object_g_g0000_eggman_ketu</code>. Both the child and the sibling nodes have their own children hierarchies (collapsed in the screenshot).		Ninja models use a node-like hierarchy of <code>NJS_OBJECT</code>s that are linked together using parent-child-sibling relationships. In the [[SAMDL]] screenshot, the object <code>object_g_g0000_eggman_eggman</code> is the root node, which has a child node <code>object_g_g0000_eggman_body</code> (selected). The child node has a sibling node <code>object_g_g0000_eggman_ketu</code>. Both the child and the sibling nodes have their own children hierarchies (collapsed in the screenshot).

	The root node makes the top of the hierarchy and is the only node without a parent. Although uncommon, the root node can sometimes have a sibling node.		The root node makes the top of the hierarchy and is the only node without a parent. Although uncommon, the root node can sometimes have a sibling node.
Line 1,145:		Line 1,145:

	==== Animation Data ====		==== Animation Data ====
	The animation data (motion data) structure can be <code>NJS_MDATA1</code>, <code>NJS_MDATA2</code>, <code>NJS_MDATA3</code> etc. depending on the number of animation elements. it consists of pointers to keyframe arrays and numbers of keyframes. The size of the MDATA structure is calculated as <code>8 * number of elements</code>.		The animation data (motion data) structure can be <code>NJS_MDATA1</code>, <code>NJS_MDATA2</code>, <code>NJS_MDATA3</code> etc. depending on the number of animation elements. it consists of pointers to keyframe arrays and numbers of keyframes. The size of the <code>MDATA</code> structure is calculated as <code>8 * number of elements</code>.

	''Support for <code>MDATA1</code> varies between different games and tools. It is common for motions with a single element to use the <code>MDATA2</code> type instead, leaving the second element empty.''		''Support for <code>MDATA1</code> varies between different games and tools. It is common for motions with a single element to use the <code>MDATA2</code> type instead, leaving the second element empty.''
Line 1,192:		Line 1,192:
	\|}		\|}
	\|}		\|}
	Basically, the only difference between the MDATA structures is the size of the arrays.		Basically, the only difference between the <code>MDATA</code> structures is the size of the arrays.

	==== Animation Keyframes ====		==== Animation Keyframes ====
Line 1,201:		Line 1,201:
	<code>NJS_MKEY_F</code> contains an array of three <code>Float</code> values. It is used for position and scale animations.		<code>NJS_MKEY_F</code> contains an array of three <code>Float</code> values. It is used for position and scale animations.

	<code>NJS_MKEY_A</code> contains an array of three <code>Angle</code> (<code>~~Uint32~~</code>) values. It is used for rotation animations.		<code>NJS_MKEY_A</code> contains an array of three <code>Angle</code> (<code>Sint32</code>) values. It is used for rotation animations.

	<code>NJS_MKEY_SA</code> contains an array of three <code>SAngle</code> (<code>Sint16</code>) values. It is used in some Chao animations in place of <code>MKEY_A</code> to store rotations in two bytes instead of four.		<code>NJS_MKEY_SA</code> contains an array of three <code>SAngle</code> (<code>Sint16</code>) values. It is used in some Chao animations in place of <code>MKEY_A</code> to store rotations in two bytes instead of four.

PkR: Motion, file extensions

2025-10-17T09:58:18Z

Motion, file extensions

Show changes

PkR at 05:20, 17 October 2025

2025-10-17T05:20:51Z

← Older revision		Revision as of 05:20, 17 October 2025
Line 148:		Line 148:
	\|BIT_23		\|BIT_23
	\|Double-sided mesh.		\|Double-sided mesh.
	\|~~May be~~ used for collision.		\|Also used for collision.
	\|-		\|-
	\|NJD_FLAG_USE_ENV		\|NJD_FLAG_USE_ENV
Line 297:		Line 297:
	4, 15, 14, 7, 6		4, 15, 14, 7, 6
	};		};
	</syntaxhighlight>The ~~number~~ of vertices can be ~~ORd with~~ <code>0x8000</code>, ~~which indicates a flipped surface~~. ~~TODO: Confirm this~~.		</syntaxhighlight>The direction of listing vertices can be clockwise or counter-clockwise. To use the clockwise winding direction, add the <code>0x8000</code> flag to the number of vertices:<syntaxhighlight lang="cpp">
			Sint16 poly_00000044[] = {
			0x8000u \| 5, 2, 1, 0, 7, 6,
			// And so on...
			};
			</syntaxhighlight>

	==== UV Array ====		==== UV Array ====
Line 319:		Line 324:
	// And so on...		// And so on...
	};		};
	</syntaxhighlight>		</syntaxhighlight>''Note: In SA1 Dreamcast, vertex colors are ignored and the pointer to the vertex colors array is null in all models.''

	==== Polynormal Array ====		==== Polynormal Array ====
Line 424:		Line 429:
	\|NJD_MESHSET_3		\|NJD_MESHSET_3
	\|0x0000		\|0x0000
	\|~~Default mesh type (three vertices). Technically identical to <code>NJD_MESHSET_TRIMESH</code>~~.		\|Triangle.
	\|-		\|-
	\|NJD_MESHSET_4		\|NJD_MESHSET_4
Line 436:		Line 441:
	\|NJD_MESHSET_TRIMESH		\|NJD_MESHSET_TRIMESH
	\|0xC000		\|0xC000
	\|Trimesh, the most common meshset type.		\|Trimesh (strips of connected triangles), the most common meshset type.
	\|-		\|-
	\|NJS_MESHSET_MASK		\|NJS_MESHSET_MASK

PkR at 01:05, 14 October 2025

2025-10-14T01:05:42Z

← Older revision		Revision as of 01:05, 14 October 2025
Line 1:		Line 1:
	== Dreamcast SDK ==		== Dreamcast SDK ==
	Katana SDK (Dreamcast SDK for SEGA Library) was the official SEGA development kit that came with Dreamcast development units. The Dreamcast SDK had a number of libraries and APIs that many developers used in their games. The SDK evolved together with the console, and earlier versions of the SDK had fewer features or targeted different hardware. Updates to the SDK continued after the Dreamcast's release, and some releases were as late as 2001.		Katana SDK (Dreamcast SDK for SEGA Library) was the official SEGA software development kit that came with Dreamcast development units. The Dreamcast SDK had a number of libraries and APIs that many developers used in their games. The SDK evolved together with the console, and earlier versions of the SDK had fewer features or targeted different hardware. Updates to the SDK continued after the Dreamcast's release, and some releases were as late as 2001.

	The Dreamcast SDK consisted of several subsystems:		The Dreamcast SDK consisted of several subsystems:
Line 65:		Line 65:
	\|Void		\|Void
	\|void		\|void
	\|		\|4
	\|Pointer		\|Pointer
	\|}		\|}
Line 103:		Line 103:
	\|Float		\|Float
	\|4		\|4
	\|~~Specular color strength~~.		\|Strength of specular light.
	\|		\|Can range from 0 to 300. Usage of it in Sonic Adventure games is not confirmed.
	\|-		\|-
	\|attr_texId		\|attr_texId

Kell: Start chunk model

2025-10-08T00:10:41Z

Start chunk model

Show changes