NN Chunk Format - Revision history

Hyper at 21:17, 1 May 2026

2026-05-01T21:17:28Z

← Older revision		Revision as of 21:17, 1 May 2026
Line 507:		Line 507:
	};		};
	</syntaxhighlight>}}		</syntaxhighlight>}}
			[[Category:File Formats]]

Hyper at 19:51, 1 May 2026

2026-05-01T19:51:41Z

← Older revision		Revision as of 19:51, 1 May 2026
Line 6:		Line 6:
	* <b>Shadowth117</b> for a ton of extremely useful information and help throughout, especially with regards to the PSO2 variants of the formats!		* <b>Shadowth117</b> for a ton of extremely useful information and help throughout, especially with regards to the PSO2 variants of the formats!
	* <b>SEGA</b>: For making these games, and for letting us freely mod them. Seriously, not many companies let us do this stuff openly, and I think it's awesome. (Also, for releasing that awful version of Sonic 4 Episode I on Windows Phone 7 which had all the symbols in it. Thanks guys, you're the best!! <3)}}		* <b>SEGA</b>: For making these games, and for letting us freely mod them. Seriously, not many companies let us do this stuff openly, and I think it's awesome. (Also, for releasing that awful version of Sonic 4 Episode I on Windows Phone 7 which had all the symbols in it. Thanks guys, you're the best!! <3)}}

	The NN Chunk Format is a generic "container" format developed by SEGA Creative Center's Graphics Section.		The NN Chunk Format is a generic "container" format developed by SEGA Creative Center's Graphics Section.

Hyper at 19:51, 1 May 2026

2026-05-01T19:51:20Z

← Older revision		Revision as of 19:51, 1 May 2026
Line 1:		Line 1:
	{{Notice\|type=warn\|content=This page is still a work in progress! Any additions and updates are greatly appreciated!}}{{Notice\|type=info\|content=HedgeDocs' initial NN documentation was written by: <b>Radfordhound</b>.		{{Notice\|type=warn\|content=This page is still a work in progress! Any additions and updates are greatly appreciated!}}{{Notice\|type=info\|content=HedgeDocs' initial NN documentation was written by: <b>Radfordhound</b>.<br>

	Thanks to:		Thanks to:

	* <b>ItsEasyActually</b>: For sharing his NN findings with me, which helped immensely in getting me started on my journey to reverse-engineer and document all of NN across all of its many crazy iterations and platforms.		* <b>ItsEasyActually</b>: For sharing his NN findings with me, which helped immensely in getting me started on my journey to reverse-engineer and document all of NN across all of its many crazy iterations and platforms.
	* <b>ArMM1998</b>: For sharing his documentation on some more obscure NN file types with me (specifically Puyo Puyo stuff, including DS games that used NN which I didn't know was a thing); I never would've known about these otherwise!		* <b>ArMM1998</b>: For sharing his documentation on some more obscure NN file types with me (specifically Puyo Puyo stuff, including DS games that used NN which I didn't know was a thing); I never would've known about these otherwise!

Hyper: Remove speculatory information

2026-05-01T19:50:29Z

Remove speculatory information

← Older revision		Revision as of 19:50, 1 May 2026
Line 1:		Line 1:
	{{Notice\|type=warn\|content=This page is still a work in progress! Any additions and updates are greatly appreciated!}}{{Notice\|type=info\|content=HedgeDocs' initial ~~Sega~~ NN documentation was written by: <b>Radfordhound</b>.		{{Notice\|type=warn\|content=This page is still a work in progress! Any additions and updates are greatly appreciated!}}{{Notice\|type=info\|content=HedgeDocs' initial NN documentation was written by: <b>Radfordhound</b>.

	Thanks to:		Thanks to:

	* <b>ItsEasyActually</b>: For sharing his ~~Sega~~ NN findings with me, which helped immensely in getting me started on my journey to reverse-engineer and document all of ~~Sega~~ NN across all of its many crazy iterations and platforms.		* <b>ItsEasyActually</b>: For sharing his NN findings with me, which helped immensely in getting me started on my journey to reverse-engineer and document all of NN across all of its many crazy iterations and platforms.
	* <b>ArMM1998</b>: For sharing his documentation on some more obscure NN file types with me (specifically Puyo Puyo stuff, including DS games that used NN which I didn't know was a thing); I never would've known about these otherwise!		* <b>ArMM1998</b>: For sharing his documentation on some more obscure NN file types with me (specifically Puyo Puyo stuff, including DS games that used NN which I didn't know was a thing); I never would've known about these otherwise!
	* <b>TGE</b> and <b>WamWooWam</b>: For decompiling SEGA's <s>unholy</s> port of Sonic 4 Episode I to Windows Phone 7, which used the ~~Sega~~ NN library, and just-so-happened to include complete symbols for everything (even enum values)! I can't understate how much this information has helped me!		* <b>TGE</b> and <b>WamWooWam</b>: For decompiling SEGA's <s>unholy</s> port of Sonic 4 Episode I to Windows Phone 7, which used the NN library, and just-so-happened to include complete symbols for everything (even enum values)! I can't understate how much this information has helped me!
	* <b>Shadowth117</b> for a ton of extremely useful information and help throughout, especially with regards to the PSO2 variants of the formats!		* <b>Shadowth117</b> for a ton of extremely useful information and help throughout, especially with regards to the PSO2 variants of the formats!
	* <b>SEGA</b>: For making these games, and for letting us freely mod them. Seriously, not many companies let us do this stuff openly, and I think it's awesome. (Also, for releasing that awful version of Sonic 4 Episode I on Windows Phone 7 which had all the symbols in it. Thanks guys, you're the best!! <3)}}		* <b>SEGA</b>: For making these games, and for letting us freely mod them. Seriously, not many companies let us do this stuff openly, and I think it's awesome. (Also, for releasing that awful version of Sonic 4 Episode I on Windows Phone 7 which had all the symbols in it. Thanks guys, you're the best!! <3)}}

	The ~~Sega~~ NN Chunk Format is a generic "container" format developed by ~~Sega~~'s ~~CS R&D Department, dating back to 2002. It originally appeared in 2004's "Sega Superstars" (to our knowledge), and has been heavily utilized in many Sega games released since~~.		The NN Chunk Format is a generic "container" format developed by SEGA Creative Center's Graphics Section.

	The format is heavily based on the older "~~Sega~~ Ninja Chunk Model" format, which was originally developed for the ~~Sega~~ Dreamcast and was utilized in many Dreamcast games (it was even included as part of the Dreamcast's "Katana" SDK).		The format is heavily based on the older "SEGA Ninja Chunk Model" format, which was originally developed for the SEGA Dreamcast and was utilized in many Dreamcast games (it was even included as part of the Dreamcast's "Katana" SDK).

	While the exact meaning of the "~~NN" in "Sega~~ NN" is still currently unknown, given that it is so heavily based off of the older Ninja format, it's almost certainly an acronym for something like "New Ninja" or "Ninja Next".		While the exact meaning of the "NN" is still currently unknown, given that it is so heavily based off of the older Ninja format, it's almost certainly an acronym for something like "New Ninja" or "Ninja Next".

	== Common Definitions ==		== Common Definitions ==
Line 21:		Line 21:
	The NN Chunk Format, much like the older Ninja format it's based on, is designed heavily around the specific hardware/software requirements of whatever platform it is intended to be used on.		The NN Chunk Format, much like the older Ninja format it's based on, is designed heavily around the specific hardware/software requirements of whatever platform it is intended to be used on.

	Unlike the older Ninja format, however (which only supports one platform: the ~~Sega~~ Dreamcast), the NN Chunk Format is "multi-platform", and therefore comes in many different platform-specific variants.		Unlike the older Ninja format, however (which only supports one platform: the SEGA Dreamcast), the NN Chunk Format is "multi-platform", and therefore comes in many different platform-specific variants.

	All known used platforms are listed in the following chart:		All known used platforms are listed in the following chart:
Line 56:		Line 56:
	\|NL		\|NL
	\|l		\|l
	\|~~Sega~~ Lindbergh		\|SEGA Lindbergh
	\|Little		\|Little
	\|16		\|16
Line 87:		Line 87:
	\|Little		\|Little
	\|16		\|16
	\|DirectX G2.0		\|DirectX G2.0 on XBOX360
	\|-		\|-
	\|NZ		\|NZ
Line 94:		Line 94:
	\|Little		\|Little
	\|16		\|16
	\|DirectX G2.0		\|DirectX G2.0 on WINDOWS
	\|-		\|-
	\|NI		\|NI
Line 368:		Line 368:
	</syntaxhighlight>Immediately following this struct comes an array of <code>uint32_t</code> values of size <code>[nData]</code>. These values represent the positions of every pointer in all of the data chunks in the file, relative to the <code>[OfsData]</code> field from the info chunk.		</syntaxhighlight>Immediately following this struct comes an array of <code>uint32_t</code> values of size <code>[nData]</code>. These values represent the positions of every pointer in all of the data chunks in the file, relative to the <code>[OfsData]</code> field from the info chunk.

	Most ~~Sega~~ NN games use this chunk to quickly "fix" all of the pointers within the data chunks (that is, to convert all of the offsets into absolute memory addresses that can then just be used as normal pointers).		Most NN games use this chunk to quickly "fix" all of the pointers within the data chunks (that is, to convert all of the offsets into absolute memory addresses that can then just be used as normal pointers).

	Some games, however, (namely: Sonic 4 Episode I for Windows Phone) ignore the values in this chunk, and instead, just manually add <code>[OfsData]</code> to each offset to get an absolute file position whenever they need to jump there.		Some games, however, (namely: Sonic 4 Episode I for Windows Phone) ignore the values in this chunk, and instead, just manually add <code>[OfsData]</code> to each offset to get an absolute file position whenever they need to jump there.
Line 406:		Line 406:

	== Text-Form File Format ==		== Text-Form File Format ==
	Text-form NN chunk files, just like the text-form Ninja chunk model files that precede them, are text files comprised of code in what is actually a very limited subset of the C programming language, heavily utilizing special NN types/preprocessor defines, which are, presumably, defined within the official ~~Sega~~ NN SDK.		Text-form NN chunk files, just like the text-form Ninja chunk model files that precede them, are text files comprised of code in what is actually a very limited subset of the C programming language, heavily utilizing special NN types/preprocessor defines, which are, presumably, defined within the official NN SDK.

	This allows them to both be parsable by tooling (it is unclear if they actually do this), and to be directly <code>#include</code>d within the C or C++ files which make up their game's source code, embedding the data directly within the game's executable!		This allows them to both be parsable by tooling (it is unclear if they actually do this), and to be directly <code>#include</code>d within the C or C++ files which make up their game's source code, embedding the data directly within the game's executable!
Line 486:		Line 486:
	Thus, the ordering of the data within each data chunk is generally written to the file in "reverse" order, such that any reference to a value will not be written until ''after'' the value it is referencing has been written, avoiding this problem.		Thus, the ordering of the data within each data chunk is generally written to the file in "reverse" order, such that any reference to a value will not be written until ''after'' the value it is referencing has been written, avoiding this problem.

	In some cases, the ~~Sega~~ NN exporters will instead declare the value early, and define it later on in the file, using an extern declaration like so:		In some cases, the NN exporters will instead declare the value early, and define it later on in the file, using an extern declaration like so:
	{{Notice\|type=example\|content=Here, the <code>nnvertex_plb_op_en_Kyozoress_head_l__2_w2_Eye</code> value is declared so that it can be referenced by the <code>VTX_LISTPTR</code> field in <code>nnvertexdesc_plb_op_en_Kyozoress_head_l__2_w2_Eye</code>:		{{Notice\|type=example\|content=Here, the <code>nnvertex_plb_op_en_Kyozoress_head_l__2_w2_Eye</code> value is declared so that it can be referenced by the <code>VTX_LISTPTR</code> field in <code>nnvertexdesc_plb_op_en_Kyozoress_head_l__2_w2_Eye</code>:

Hyper: Update NN Library Version strings

2026-05-01T02:13:46Z

Update NN Library Version strings

← Older revision		Revision as of 02:13, 1 May 2026
Line 38:		Line 38:
	\|Little		\|Little
	\|16		\|16
	\|~~PlayStation 2~~		\|PlayStation2
	\|-		\|-
	\|NG		\|NG
	\|g		\|g
	\|~~Gamecube~~/Wii		\|GameCube/Wii
	\|Big		\|Big
	\|32		\|32
	\|GAMECUBE		\|GAMECUBE/Wii
	\|-		\|-
	\|NX		\|NX
Line 87:		Line 87:
	\|Little		\|Little
	\|16		\|16
	\|DirectX G2.0 ~~on XBOX360~~		\|DirectX G2.0
	\|-		\|-
	\|NZ		\|NZ
Line 94:		Line 94:
	\|Little		\|Little
	\|16		\|16
	\|DirectX G2.0 ~~on WINDOWS~~		\|DirectX G2.0
	\|-		\|-
	\|NI		\|NI

Hyper at 01:37, 1 May 2026

2026-05-01T01:37:39Z

← Older revision		Revision as of 01:37, 1 May 2026
Line 56:		Line 56:
	\|NL		\|NL
	\|l		\|l
	\|Sega ~~Lindberg~~		\|Sega Lindbergh
	\|Little		\|Little
	\|16		\|16
	\|~~Lindberg~~		\|LINDBERGH
	\|-		\|-
	\|NU		\|NU

Hyper: Noted *.xni CC usage for light resources

2025-08-08T04:13:50Z

Noted *.xni CC usage for light resources

← Older revision		Revision as of 04:13, 8 August 2025
Line 152:		Line 152:
	\|j/o		\|j/o
	\|OBJECT		\|OBJECT
	\|A model. Uses o as its CC if its TEXLIST is embedded, and j otherwise.		\|A model. Uses 'o' as its CC if its TEXLIST is embedded, and 'j' otherwise.
	\|-		\|-
	\|MO		\|MO
Line 182:		Line 182:
	\|i/l		\|i/l
	\|LIGHT		\|LIGHT
	\|A light.		\|A light. Uses 'i' as its CC if its animation is embedded, and 'l' otherwise.
	\|-		\|-
	\|CA		\|CA

Hyper: Documented NN light file extension character codes

2025-08-06T22:54:20Z

Documented NN light file extension character codes

← Older revision		Revision as of 22:54, 6 August 2025
Line 170:		Line 170:
	\|-		\|-
	\|ML		\|ML
	\|?		\|i
	\|[[NN Chunk Format - MOTION\|MOTION]]		\|[[NN Chunk Format - MOTION\|MOTION]]
	\|A light animation.		\|A light animation.
Line 180:		Line 180:
	\|-		\|-
	\|LI		\|LI
	\|l		\|i/l
	\|LIGHT		\|LIGHT
	\|A light.		\|A light.

PTKay at 10:56, 21 February 2025

2025-02-21T10:56:49Z

← Older revision		Revision as of 10:56, 21 February 2025
Line 5:		Line 5:
	* <b>ItsEasyActually</b>: For sharing his Sega NN findings with me, which helped immensely in getting me started on my journey to reverse-engineer and document all of Sega NN across all of its many crazy iterations and platforms.		* <b>ItsEasyActually</b>: For sharing his Sega NN findings with me, which helped immensely in getting me started on my journey to reverse-engineer and document all of Sega NN across all of its many crazy iterations and platforms.
	* <b>ArMM1998</b>: For sharing his documentation on some more obscure NN file types with me (specifically Puyo Puyo stuff, including DS games that used NN which I didn't know was a thing); I never would've known about these otherwise!		* <b>ArMM1998</b>: For sharing his documentation on some more obscure NN file types with me (specifically Puyo Puyo stuff, including DS games that used NN which I didn't know was a thing); I never would've known about these otherwise!
	* <b>TGE</b> and <b<WamWooWam</b>: For decompiling SEGA's <s>unholy</s> port of Sonic 4 Episode I to Windows Phone 7, which used the Sega NN library, and just-so-happened to include complete symbols for everything (even enum values)! I can't understate how much this information has helped me!		* <b>TGE</b> and <b>WamWooWam</b>: For decompiling SEGA's <s>unholy</s> port of Sonic 4 Episode I to Windows Phone 7, which used the Sega NN library, and just-so-happened to include complete symbols for everything (even enum values)! I can't understate how much this information has helped me!
	* <b>Shadowth117</b> for a ton of extremely useful information and help throughout, especially with regards to the PSO2 variants of the formats!		* <b>Shadowth117</b> for a ton of extremely useful information and help throughout, especially with regards to the PSO2 variants of the formats!
	* <b>SEGA</b>: For making these games, and for letting us freely mod them. Seriously, not many companies let us do this stuff openly, and I think it's awesome. (Also, for releasing that awful version of Sonic 4 Episode I on Windows Phone 7 which had all the symbols in it. Thanks guys, you're the best!! <3)}}		* <b>SEGA</b>: For making these games, and for letting us freely mod them. Seriously, not many companies let us do this stuff openly, and I think it's awesome. (Also, for releasing that awful version of Sonic 4 Episode I on Windows Phone 7 which had all the symbols in it. Thanks guys, you're the best!! <3)}}

PTKay at 09:48, 21 February 2025

2025-02-21T09:48:20Z

← Older revision		Revision as of 09:48, 21 February 2025
Line 221:		Line 221:
	Just like with the older Ninja format, NN chunk files come in two forms:		Just like with the older Ninja format, NN chunk files come in two forms:

	* Binary-Form		* [[NN Chunk Format#Binary-Form File Format\|Binary-Form]]
	* Text-Form (aka "Ascii-Form")		* [[NN Chunk Format#Text-Form File Format\|Text-Form]] (aka "Ascii-Form")
	{{Notice\|type=info\|content=<b>The vast majority of NN chunk files in released games are in binary-form.</b>		{{Notice\|type=info\|content=<b>The vast majority of NN chunk files in released games are in binary-form.</b>

Line 230:		Line 230:
	File extensions for NN chunk files typically consist of three characters:		File extensions for NN chunk files typically consist of three characters:

	# The "CC" (character-code) of the platform.		# The "CC" (character-code) of the [[NN Chunk Format#Platforms\|platform]].
	# <code>n</code> for Binary-Form files, or <code>t</code> for Text-Form files.		# <code>n</code> for [[NN Chunk Format#Binary-Form File Format\|Binary-Form]] files, or <code>t</code> for [[NN Chunk Format#Text-Form File Format\|Text-Form]] files.
	# The "CC" (character-code) of the last data chunk contained within the file.		# The "CC" (character-code) of the last [[NN Chunk Format#Data Chunks\|data chunk]] contained within the file.

	=== Examples ===		=== Examples ===
Line 255:		Line 255:
	== Binary-Form File Format ==		== Binary-Form File Format ==
	Binary-Form NN chunk files are represented as a series of consecutive "binary chunks", each of which begins with the following data:		Binary-Form NN chunk files are represented as a series of consecutive "binary chunks", each of which begins with the following data:
	{{Notice\|type=note\|content=All instances of this struct (and ONLY this struct) are represented in <B>little-endian</b>, regardless of the endianness specified by the platform. <b>Everything else</b> in Binary-Form NN chunk files is represented in the endianness specified by the platform.}}{{Notice\|type=note\|content=A struct type with this name does not actually exist (to my knowledge) in real Sega NN implementations; these fields are just embedded directly within every NNS_BINCNK_ struct. This is just an easier way to think about it for our purposes.}}<syntaxhighlight lang="cpp">		{{Notice\|type=note\|content=All instances of this struct (and ONLY this struct) are represented in <B>little-endian</b>, regardless of the endianness specified by the [[#Platforms\|platform]]. <b>Everything else</b> in Binary-Form NN chunk files is represented in the endianness specified by the [[#Platforms\|platform]].}}{{Notice\|type=note\|content=A struct type with this name does not actually exist (to my knowledge) in real Sega NN implementations; these fields are just embedded directly within every NNS_BINCNK_ struct. This is just an easier way to think about it for our purposes.}}<syntaxhighlight lang="cpp">
	struct NNS_BINCNK_HEADER		struct NNS_BINCNK_HEADER
	{		{
Line 313:		Line 313:

	=== Data Chunk Header ===		=== Data Chunk Header ===
	After the Info Chunk, comes the main contents of the file: A sequence of one or more data chunks.		After the [[NN Chunk Format#Info Chunk\|Info Chunk]], comes the main contents of the file: A sequence of one or more [[NN Chunk Format#Data Chunks\|data chunks]].

	In binary-form NN chunk files, each data chunk begins with the following struct:<syntaxhighlight lang="cpp">		In binary-form NN chunk files, each data chunk begins with the following struct:<syntaxhighlight lang="cpp">
Line 340:		Line 340:
	</syntaxhighlight>Immediately following this struct comes all of the data (structs, strings, etc.) required to represent the data chunk. The format of this data depends on the value of the Id field.		</syntaxhighlight>Immediately following this struct comes all of the data (structs, strings, etc.) required to represent the data chunk. The format of this data depends on the value of the Id field.

	See the linked pages in the data chunks chart.		See the linked pages in the [[NN Chunk Format#Data Chunks\|data chunks chart]].

	=== Offsets List Chunk ===		=== Offsets List Chunk ===
Line 420:		Line 420:
	## The name and version number of the tool used to create this file.		## The name and version number of the tool used to create this file.
	## <code>Create\t:</code> followed by the date this file was created in the <code>ddd MMM dd HH:mm:ss yyyy</code> .NET DateTime format.		## <code>Create\t:</code> followed by the date this file was created in the <code>ddd MMM dd HH:mm:ss yyyy</code> .NET DateTime format.
	## The names of each of the root structs for every data chunk in the file, in this format: <code>TYPE\t: NAME</code>, where <code>TYPE</code> refers to the root struct's type (e.g. <code>NNS_TEXFILELIST</code>). See the linked pages in the data chunks chart.		## The names of each of the root structs for every data chunk in the file, in this format: <code>TYPE\t: NAME</code>, where <code>TYPE</code> refers to the root struct's type (e.g. <code>NNS_TEXFILELIST</code>). See the linked pages in the [[NN Chunk Format#Data Chunks\|data chunks chart]].
	# One or more data chunks, each of which is comprised of the following, in order:		# One or more data chunks, each of which is comprised of the following, in order:
	## A comment with the text: <code>TYPE START</code>, where <code>TYPE</code> refers to the data chunk's type (e.g. <code>TEXLIST</code>).		## A comment with the text: <code>TYPE START</code>, where <code>TYPE</code> refers to the [[NN Chunk Format#Data Chunks\|data chunk's type]] (e.g. <code>TEXLIST</code>).
	## All of the data used by this data chunk, represented as C code comprised heavily of special NN preprocessor macros. See the linked pages in the data chunks chart.		## All of the data used by this data chunk, represented as C code comprised heavily of special NN preprocessor macros. See the linked pages in the [[NN Chunk Format#Data Chunks\|data chunks chart]].
	## A comment with the text: <code>TYPE END</code>, where <code>TYPE</code> refers to the data chunk's type (e.g. <code>TEXLIST</code>).		## A comment with the text: <code>TYPE END</code>, where <code>TYPE</code> refers to the [[NN Chunk Format#Data Chunks\|data chunk's type]] (e.g. <code>TEXLIST</code>).
	# A (required?) comment with the text: <code>End of File</code>.		# A (required?) comment with the text: <code>End of File</code>.

Line 479:		Line 479:
	* TFL_TEXFILE		* TFL_TEXFILE

	For a complete list of all of these defines, please refer to the individual pages linked in the data chunks chart (for the ones used in this example, refer to the TEXLIST documentation).}}		For a complete list of all of these defines, please refer to the individual pages linked in the [[#Data Chunks\|data chunks chart]] (for the ones used in this example, refer to the [[NN Chunk Format - TEXTLIST\|TEXLIST]] documentation).}}
	Note that in C, code is parsed sequentially: left-to-right, top-to-bottom.		Note that in C, code is parsed sequentially: left-to-right, top-to-bottom.