HedgeDocs - User contributions [en]

HedgeBake

2025-09-12T11:34:43Z

NextinHKRY: Create initial HedgeBake page

{{Notice|type=warn|content=This page is unfinished.}}{{ToolInfobox|title=HedgeBake|author=cosagets|website=https://github.com/cosagets/HedgeBake|download=https://github.com/cosagets/HedgeBake/releases/tag/v1.0.0}}'''HedgeBake''' is a Blender addon that allows you to bake global illumination and light-field data for Hedgehog Engine 1 games using the Cycles engine.

Tools

2025-09-12T11:31:44Z

NextinHKRY: Added HedgeBake

This section contains tools that aren't specific to any Sonic game. Below you can see the tools divided by the engine they target and their purpose.

== Various Engines ==

=== Audio ===

* [[SonicAudioTools]] (.csb / .acb)

== Hedgehog Engine ==

=== Animations ===

* [[Frontiers Animation Tools]] (.skl.pxd / .anm.pxd)
* [[KwasTools (Hedgehog Engine)|io_kwastools]] (.cam-anim / .uv-anim)
* [[Havok Animation Exporter]] (.skl.hkx / .anm.hkx)

=== Archives ===

* [[PackCpk]] (.cpk)
* [[YACpkTool]] (.cpk)

* [[HedgeArchiveEditor]] (.ar / .pfd / .pac)
* [[HedgeArcPack]] (.ar / .pfd / .pac)
* [[ar0pack-ar0unpack]] (.ar / .pfd)

=== Collision ===
* [[Havok Converter]] (.phy.hkx)

=== Level Editing ===

* [[SonicGLvl]]
* [[Meta Instancer]] (.mti)

=== Lighting ===
* [[GI Atlas Converter]]
* [[HedgeGI]]
* [[HedgeBake]]
* [[SonicLightTools]]

=== Shaders ===

* [[HE2 Shader Compiler]] (.vso / .pso / .cso / .hlsl)

=== Models ===

* [[Hedgehog Engine Blender I/O]]
* [[HedgeMatEdit]] (.material)
* [[Model Converter]] (.model)
* [[modelfbx]] (.model / .terrain-model / .skl.hkx / .anm.hkx)
* [[terrain2fbx]] (.terrain-model)
* [[terrain2fbx-png]] (.terrain-model)

=== Terrain ===

* [[Hedgehog Converter]]

=== Textures ===

* [[NeedleTextureStreamingUtility]] (.ntsp / .dds)

=== Text ===
* [[Converse]] (.fco / .fte)
* [[SonicColorsXTBConv]] (.xtb)

=== UI ===
* [[Shuriken]] (.xncp / .yncp)
* [[Kunai]] (.xncp / .yncp / .gncp / .sncp)

Sonic Colors

2025-09-06T13:27:57Z

NextinHKRY:

== Tools ==

=== Collision ===

* [[col2fbx]] (*_col.orc)

=== Lighting ===

* [[llightConverter]] (*_llight.orc)

=== Stages ===

* [[orc2xml]] (*.orc)

=== Text ===

* [[SonicColorsXTBConv]] (.xtb)

== Guides ==
N/A

== Documentation ==

=== File Formats ===

* [[Sonic Colors Light Field|Light Field]]
* [[Sonic Colors Set Object|Set Object]]

== Discoveries ==

=== Objects ===

* [[Sonic Colors Unused Objects|Unused Objects]]

SonicColorsXTBConv

2025-09-06T13:27:16Z

NextinHKRY: Created page with "{{ToolInfobox|title=SonicColorsXTBConv|author=TheExentist151|website=https://github.com/TheExentist151/SonicColorsXTBConv|download=https://github.com/TheExentist151/SonicColorsXTBConv/releases/tag/2.1.0|image=}} '''SonicColorsXTBConv''' is a tool to edit <code>.xtb</code> files from '''Sonic Colors, Sonic Unleashed, Sonic Generations''' and '''Mario & Sonic at the London 2012 Olympic Games'''. == Usage == <code>SonicColorsXTBConv.exe <input file> <format version> (or yo..."

{{ToolInfobox|title=SonicColorsXTBConv|author=TheExentist151|website=https://github.com/TheExentist151/SonicColorsXTBConv|download=https://github.com/TheExentist151/SonicColorsXTBConv/releases/tag/2.1.0|image=}}
'''SonicColorsXTBConv''' is a tool to edit <code>.xtb</code> files from '''Sonic Colors, Sonic Unleashed, Sonic Generations''' and '''Mario & Sonic at the London 2012 Olympic Games'''.

== Usage ==
<code>SonicColorsXTBConv.exe <input file> <format version> (or you can just drag and drop a file)</code>

Tools

2025-09-06T13:17:27Z

NextinHKRY:

This section contains tools that aren't specific to any Sonic game. Below you can see the tools divided by the engine they target and their purpose.

== Various Engines ==

=== Audio ===

* [[SonicAudioTools]] (.csb / .acb)

== Hedgehog Engine ==

=== Animations ===

* [[Frontiers Animation Tools]] (.skl.pxd / .anm.pxd)
* [[KwasTools (Hedgehog Engine)|io_kwastools]] (.cam-anim / .uv-anim)
* [[Havok Animation Exporter]] (.skl.hkx / .anm.hkx)

=== Archives ===

* [[PackCpk]] (.cpk)
* [[YACpkTool]] (.cpk)

* [[HedgeArchiveEditor]] (.ar / .pfd / .pac)
* [[HedgeArcPack]] (.ar / .pfd / .pac)
* [[ar0pack-ar0unpack]] (.ar / .pfd)

=== Collision ===
* [[Havok Converter]] (.phy.hkx)

=== Level Editing ===

* [[SonicGLvl]]
* [[Meta Instancer]] (.mti)

=== Lighting ===
* [[GI Atlas Converter]]
* [[HedgeGI]]
* [[SonicLightTools]]

=== Shaders ===

* [[HE2 Shader Compiler]] (.vso / .pso / .cso / .hlsl)

=== Models ===

* [[Hedgehog Engine Blender I/O]]
* [[HedgeMatEdit]] (.material)
* [[Model Converter]] (.model)
* [[modelfbx]] (.model / .terrain-model / .skl.hkx / .anm.hkx)
* [[terrain2fbx]] (.terrain-model)
* [[terrain2fbx-png]] (.terrain-model)

=== Terrain ===

* [[Hedgehog Converter]]

=== Textures ===

* [[NeedleTextureStreamingUtility]] (.ntsp / .dds)

=== Text ===
* [[Converse]] (.fco / .fte)
* [[SonicColorsXTBConv]] (.xtb)

=== UI ===
* [[Shuriken]] (.xncp / .yncp)
* [[Kunai]] (.xncp / .yncp / .gncp / .sncp)

ACB Audio Injection

2025-09-06T12:21:49Z

NextinHKRY: Formatting consistency changes

In this tutorial you will learn the basics of injecting audio (<code>HCA</code>, <code>ADX</code>) into CRIWARE's <code>ACB</code> files, it helps to cut down the size of mods by not shipping the entire <code>ACB</code> + <code>AWB</code>. The tutorial will be using <code>cri_utf_tool</code> from [[KwasTools (Hedgehog Engine)|KwasTools]] for ACB conversion to and from XML, additional software will be required such as the <code>HCA</code> audio converter and a text editor, in this tutorial we'll use [https://github.com/Thealexbarney/VGAudio VGAudioCli] and [https://notepad-plus-plus.org/ Notepad++]. You should also install [https://www.foobar2000.org/ foobar2000] with [https://vgmstream.org/ vgmstream component] for easy preview of audio, and it will also be useful to pinpoint file indices in the <code>AWB</code> archive.

For this tutorial, we will be replacing Cyber Space 1-1's music in [[Sonic Frontiers]].

== Converting the ACB to XML ==
Converting the <code>ACB</code> is as easy as drag and dropping it on the <code>cri_utf_tool</code> executable, if conversion was successful it'll create an XML file in the same directory as the <code>ACB</code>.[[File:Bgm cyber acb in xml form.png|center|638x638px|XML opened in a text editor|alt=XML opened in a text editor|thumb]]

== Creating an internal AWB file ==
Some <code>ACB</code>s do not have an internal <code>AWB</code> file, which is required to store audio we want to use. This is the case with <code>bgm_cyber</code>, it lacks one and we need to create it. The XML structure of <code>AWB</code> file is the same as one from <code>cri_awb_tool</code>. However, I will include a minimal example for Sonic Frontiers below to keep things straightforward.
{{Notice|type=warn|content=Keep in mind that parameters need to match the external AWB's, otherwise the game will crash!}}<syntaxhighlight lang="xml" line="1">
<AWB version="2" offset_size="4" id_size="2" alignment="32" subkey="0">
<entry id="0" path="audio.hca"/>
</AWB>
</syntaxhighlight>
=== Inserting the internal AWB structure ===
Search for <code><record value="" name="AwbFile"/></code> and you should find this:<syntaxhighlight lang="xml" line="1" start="5456">
<record value="" name="AutoModulationTable"/>
<record value="" name="StreamAwbTocWorkOld"/>
<record value="" name="AwbFile"/>
<record value="
ACB Format/PC Ver.1.37.0 Build:
" name="VersionString"/>
<record value="" name="CueLimitWorkTable"/>
</syntaxhighlight>We need to replace the <code>AwbFile</code> record with our own <code>AWB</code> structure.

After changes you should get something like this:<syntaxhighlight lang="xml" line="1" start="5456">
<record value="" name="AutoModulationTable"/>
<record value="" name="StreamAwbTocWorkOld"/>
<AWB version="2" offset_size="4" id_size="2" alignment="32" subkey="0">
<entry id="0" path="my_audio.hca"/>
<entry id="1" path="my_audio_boost.hca"/>
</AWB>
<record value="
ACB Format/PC Ver.1.37.0 Build:
" name="VersionString"/>
<record value="" name="CueLimitWorkTable"/>
</syntaxhighlight>ID starts at 0 and goes up. Paths are relative to XML's location.

== Modifying Waveform data ==
Next, we need to change data in the <code>Waveform</code> table for each track we want to replace, we have to change the <code>MemoryAwbId</code> and <code>Streaming</code> values.

=== Explanation of parameters ===
<code>MemoryAwbId</code> is the index in the internal <code>AWB</code> file. In our case, index <code>0</code> is the main track and index <code>1</code> is the boost version. Streaming is more interesting, it has three available options:
{| class="wikitable"
|+Streaming values
!Value
!Description
|-
|0
|Audio is streamed from internal <code>AWB</code> file, which resides in RAM
|-
|1
|Audio is streamed from external <code>AWB</code> file
|-
|2
|Short snippet of audio in internal <code>AWB</code> file to initialize the decoder, rest of the audio is streamed from external <code>AWB</code> file
|}
What we're looking for is the value of <code>0</code> - streaming from internal <code>AWB</code>.

=== Getting AWB IDs we want to replace ===
Cyber Space 1-1 stage name is <code>w6d01</code>. Opening <code>bgm_cyber.awb</code> in foobar2000 reveals that first two tracks are what we're looking for. However, foobar2000 lists all item indexes starting from <code>1</code>, so we need to subtract <code>1</code> from the desired index.
[[File:Bgm cyber awb in foobar.png|center|thumb|642x642px|<code>bgm_cyber.awb</code> playing in foobar2000, with Cyber Space 1-1 audio tracks selected.]]
So our IDs are <code>0</code> for main track and <code>1</code> for boost. With that we can finally proceed.

=== Modifying the parameters ===
Quick and easy way of finding a correct Waveform is searching for a string <code><record value="0" name="StreamAwbId"/></code>, where <code>value</code> is the external <code>AWB</code> track ID.<syntaxhighlight lang="xml" line="1" start="812">
<row>
<record value="65535" name="MemoryAwbId"/>
<record value="2" name="EncodeType"/>
<record value="1" name="Streaming"/>
<record value="2" name="NumChannels"/>
<record value="2" name="LoopFlag"/>
<record value="48000" name="SamplingRate"/>
<record value="4999086" name="NumSamples"/>
<record value="8" name="ExtensionData"/>
<record value="0" name="StreamAwbPortNo"/>
<record value="0" name="StreamAwbId"/>
<record value="65535" name="LipMorthIndex"/>
</row>
</syntaxhighlight>Waveform data for track <code>0</code>. After modifications (that is, changing <code>MemoryAwbId</code> and <code>Streaming</code> value) we get the following:<syntaxhighlight lang="xml" line="1" start="812">
<row>
<record value="0" name="MemoryAwbId"/>
<record value="2" name="EncodeType"/>
<record value="0" name="Streaming"/>
<record value="2" name="NumChannels"/>
<record value="2" name="LoopFlag"/>
<record value="48000" name="SamplingRate"/>
<record value="4999086" name="NumSamples"/>
<record value="8" name="ExtensionData"/>
<record value="0" name="StreamAwbPortNo"/>
<record value="0" name="StreamAwbId"/>
<record value="65535" name="LipMorthIndex"/>
</row>
</syntaxhighlight>After repeating the process for the boost track, we can now finally convert back to <code>ACB</code> and check results ingame.

== Converting the XML to ACB ==
Same as before, drag and drop the XML on the <code>cri_utf_tool</code>. It should output a big <code>ACB</code> file that's ready to be copied into a mod. The <code>ACB</code> we created should be playable in foobar2000 and will only show the audio files we injected into it.[[File:ACB with injected audio.png|center|thumb|660x660px|Resulting <code>ACB</code> playing in foobar2000]]

== Result ==
[[File:ACB Injection Result.webm|center|thumb|Result of ACB Injection|0x0px]]

ACB Audio Injection

2025-09-06T12:20:42Z

NextinHKRY: Wording and spacing changes

In this tutorial you will learn the basics of injecting audio (HCA, ADX) into CRIWARE's ACB files, it helps to cut down the size of mods by not shipping the entire ACB+AWB. The tutorial will be using <code>cri_utf_tool</code> from [[KwasTools (Hedgehog Engine)|KwasTools]] for ACB conversion to and from XML, additional software will be required such as the HCA audio converter and a text editor, in this tutorial we'll use [https://github.com/Thealexbarney/VGAudio VGAudioCli] and [https://notepad-plus-plus.org/ Notepad++]. You should also install [https://www.foobar2000.org/ foobar2000] with [https://vgmstream.org/ vgmstream component] for easy preview of audio, and it will also be useful to pinpoint file indices in the AWB archive.

For this tutorial, we will be replacing Cyber Space 1-1's music in [[Sonic Frontiers]].

== Converting the ACB to XML ==
Converting the <code>ACB</code> is as easy as drag and dropping it on the <code>cri_utf_tool</code> executable, if conversion was successful it'll create an XML file in the same directory as the <code>ACB</code>.[[File:Bgm cyber acb in xml form.png|center|638x638px|XML opened in a text editor|alt=XML opened in a text editor|thumb]]

== Creating an internal AWB file ==
Some <code>ACB</code>s do not have an internal <code>AWB</code> file, which is required to store audio we want to use. This is the case with <code>bgm_cyber</code>, it lacks one and we need to create it. The XML structure of <code>AWB</code> file is the same as one from <code>cri_awb_tool</code>. However, I will include a minimal example for Sonic Frontiers below to keep things straightforward.
{{Notice|type=warn|content=Keep in mind that parameters need to match the external AWB's, otherwise the game will crash!}}<syntaxhighlight lang="xml" line="1">
<AWB version="2" offset_size="4" id_size="2" alignment="32" subkey="0">
<entry id="0" path="audio.hca"/>
</AWB>
</syntaxhighlight>
=== Inserting the internal AWB structure ===
Search for <code><record value="" name="AwbFile"/></code> and you should find this:<syntaxhighlight lang="xml" line="1" start="5456">
<record value="" name="AutoModulationTable"/>
<record value="" name="StreamAwbTocWorkOld"/>
<record value="" name="AwbFile"/>
<record value="
ACB Format/PC Ver.1.37.0 Build:
" name="VersionString"/>
<record value="" name="CueLimitWorkTable"/>
</syntaxhighlight>We need to replace the <code>AwbFile</code> record with our own <code>AWB</code> structure.

After changes you should get something like this:<syntaxhighlight lang="xml" line="1" start="5456">
<record value="" name="AutoModulationTable"/>
<record value="" name="StreamAwbTocWorkOld"/>
<AWB version="2" offset_size="4" id_size="2" alignment="32" subkey="0">
<entry id="0" path="my_audio.hca"/>
<entry id="1" path="my_audio_boost.hca"/>
</AWB>
<record value="
ACB Format/PC Ver.1.37.0 Build:
" name="VersionString"/>
<record value="" name="CueLimitWorkTable"/>
</syntaxhighlight>ID starts at 0 and goes up. Paths are relative to XML's location.

== Modifying Waveform data ==
Next, we need to change data in the <code>Waveform</code> table for each track we want to replace, we have to change the <code>MemoryAwbId</code> and <code>Streaming</code> values.

=== Explanation of parameters ===
<code>MemoryAwbId</code> is the index in the internal <code>AWB</code> file. In our case, index <code>0</code> is the main track and index <code>1</code> is the boost version. Streaming is more interesting, it has three available options:
{| class="wikitable"
|+Streaming values
!Value
!Description
|-
|0
|Audio is streamed from internal <code>AWB</code> file, which resides in RAM
|-
|1
|Audio is streamed from external <code>AWB</code> file
|-
|2
|Short snippet of audio in internal <code>AWB</code> file to initialize the decoder, rest of the audio is streamed from external <code>AWB</code> file
|}
What we're looking for is the value of <code>0</code> - streaming from internal <code>AWB</code>.

=== Getting AWB IDs we want to replace ===
Cyber Space 1-1 stage name is <code>w6d01</code>. Opening <code>bgm_cyber.awb</code> in foobar2000 reveals that first two tracks are what we're looking for. However, foobar2000 lists all item indexes starting from <code>1</code>, so we need to subtract <code>1</code> from the desired index.
[[File:Bgm cyber awb in foobar.png|center|thumb|642x642px|<code>bgm_cyber.awb</code> playing in foobar2000, with Cyber Space 1-1 audio tracks selected.]]
So our IDs are <code>0</code> for main track and <code>1</code> for boost. With that we can finally proceed.

=== Modifying the parameters ===
Quick and easy way of finding a correct Waveform is searching for a string <code><record value="0" name="StreamAwbId"/></code>, where <code>value</code> is the external <code>AWB</code> track ID.<syntaxhighlight lang="xml" line="1" start="812">
<row>
<record value="65535" name="MemoryAwbId"/>
<record value="2" name="EncodeType"/>
<record value="1" name="Streaming"/>
<record value="2" name="NumChannels"/>
<record value="2" name="LoopFlag"/>
<record value="48000" name="SamplingRate"/>
<record value="4999086" name="NumSamples"/>
<record value="8" name="ExtensionData"/>
<record value="0" name="StreamAwbPortNo"/>
<record value="0" name="StreamAwbId"/>
<record value="65535" name="LipMorthIndex"/>
</row>
</syntaxhighlight>Waveform data for track <code>0</code>. After modifications (that is, changing <code>MemoryAwbId</code> and <code>Streaming</code> value) we get the following:<syntaxhighlight lang="xml" line="1" start="812">
<row>
<record value="0" name="MemoryAwbId"/>
<record value="2" name="EncodeType"/>
<record value="0" name="Streaming"/>
<record value="2" name="NumChannels"/>
<record value="2" name="LoopFlag"/>
<record value="48000" name="SamplingRate"/>
<record value="4999086" name="NumSamples"/>
<record value="8" name="ExtensionData"/>
<record value="0" name="StreamAwbPortNo"/>
<record value="0" name="StreamAwbId"/>
<record value="65535" name="LipMorthIndex"/>
</row>
</syntaxhighlight>After repeating the process for the boost track, we can now finally convert back to <code>ACB</code> and check results ingame.

== Converting the XML to ACB ==
Same as before, drag and drop the XML on the <code>cri_utf_tool</code>. It should output a big <code>ACB</code> file that's ready to be copied into a mod. The <code>ACB</code> we created should be playable in foobar2000 and will only show the audio files we injected into it.[[File:ACB with injected audio.png|center|thumb|660x660px|Resulting <code>ACB</code> playing in foobar2000]]

== Result ==
[[File:ACB Injection Result.webm|center|thumb|Result of ACB Injection|0x0px]]

Meta Instancer

2025-08-16T16:22:22Z

NextinHKRY:

{{Notice|type=warn|content=This Addon is not yet finished, as there are some issues with exporting rotations and the import function has not yet been implemented.}}
{{ToolInfobox|title=Meta Instancer|author=Hedgeturd|website=https://github.com/Hedgeturd/MetaInstancer-Blender/|image=|download=https://github.com/Hedgeturd/MetaInstancer-Blender/releases/latest}}
'''Meta Instancer''' is a Blender addon to modify meta-instancer files (.mti) from '''Hedgehog Engine 1''', which are primarily used for grass in levels.

== Usage ==

=== Scene Setup ===
Make a surface which has a Particle System set on it, use the settings from this image.
[[File:MetaInstancersettings1.png|thumb|Scene Setup|center]]

To have more randomized patches of grass, use these settings below.
<gallery mode="packed" widths="360" heights="240">
File:Metainstancersetting-2.png|Take note here that "Hair Length" is 4 metres, only use this value for previewing!
File:Metainstancersettings3.png|alt=
</gallery>

=== Painting ===

If you want more control over the placement you can add weight paints to the Particle Settings, use the settings below; "Group" being the vertex group that will be used to paint the grass onto the surface. After you set this up, you can now begin painting.<gallery mode="packed" widths="360" heights="200">
File:Metainstancersettings4.png
</gallery>

Once you're ready to export, make sure to go back to your Particle Emission Settings and reduce the Hair Length to 0, then go to '''File > Export > Meta Instancer (.mti)''' and finally name and export your MTI file.

Meta Instancer

2025-08-16T16:19:58Z

NextinHKRY:

{{ToolInfobox|title=Meta Instancer|author=Hedgeturd|website=https://github.com/Hedgeturd/MetaInstancer-Blender/|image=|download=https://github.com/Hedgeturd/MetaInstancer-Blender/releases/latest}}
'''Meta Instancer''' is a Blender addon to modify meta-instancer files (.mti) from '''Hedgehog Engine 1''', which are primarily used for grass in levels.

== Usage ==

=== Scene Setup ===
Make a surface which has a Particle System set on it, use the settings from this image.
[[File:MetaInstancersettings1.png|thumb|Scene Setup|center]]

To have more randomized patches of grass, use these settings below.
<gallery mode="packed" widths="360" heights="240">
File:Metainstancersetting-2.png|Take note here that "Hair Length" is 4 metres, only use this value for previewing!
File:Metainstancersettings3.png|alt=
</gallery>

=== Painting ===

If you want more control over the placement you can add weight paints to the Particle Settings, use the settings below; "Group" being the vertex group that will be used to paint the grass onto the surface. After you set this up, you can now begin painting.<gallery mode="packed" widths="360" heights="200">
File:Metainstancersettings4.png
</gallery>

Once you're ready to export, make sure to go back to your Particle Emission Settings and reduce the Hair Length to 0, then go to '''File > Export > Meta Instancer (.mti)''' and finally name and export your MTI file.

Meta Instancer

2025-08-16T16:18:56Z

NextinHKRY: Created page with "{{ToolInfobox|title=Meta Instancer|author=Hedgeturd|website=https://github.com/Hedgeturd/MetaInstancer-Blender/|image=|download=https://github.com/Hedgeturd/MetaInstancer-Blender/releases/latest}} '''Meta Instancer''' is a Blender addon to modify meta-instancer files (.mti) from '''Hedgehog Engine 1''', which are used primarily for grass in levels. == Usage == === Scene Setup === Make a surface which has a Particle System set on it, use the settings from this image. ..."

{{ToolInfobox|title=Meta Instancer|author=Hedgeturd|website=https://github.com/Hedgeturd/MetaInstancer-Blender/|image=|download=https://github.com/Hedgeturd/MetaInstancer-Blender/releases/latest}}
'''Meta Instancer''' is a Blender addon to modify meta-instancer files (.mti) from '''Hedgehog Engine 1''', which are used primarily for grass in levels.

== Usage ==

=== Scene Setup ===
Make a surface which has a Particle System set on it, use the settings from this image.
[[File:MetaInstancersettings1.png|thumb|Scene Setup|center]]

To have more randomized patches of grass, use these settings below.
<gallery mode="packed" widths="360" heights="240">
File:Metainstancersetting-2.png|Take note here that "Hair Length" is 4 metres, only use this value for previewing!
File:Metainstancersettings3.png|alt=
</gallery>

=== Painting ===

If you want more control over the placement you can add weight paints to the Particle Settings, use the settings below; "Group" being the vertex group that will be used to paint the grass onto the surface. After you set this up, you can now begin painting.<gallery mode="packed" widths="360" heights="200">
File:Metainstancersettings4.png
</gallery>

Once you're ready to export, make sure to go back to your Particle Emission Settings and reduce the Hair Length to 0, then go to '''File > Export > Meta Instancer (.mti)''' and finally name and export your MTI file.

File:Metainstancersettings4.png

2025-08-16T16:17:00Z

NextinHKRY:

Painting settings for metainstancer

File:Metainstancersettings3.png

2025-08-16T16:12:07Z

NextinHKRY:

Randomness settings for Metainstancer 2

File:Metainstancersetting-2.png

2025-08-16T16:10:44Z

NextinHKRY:

Randomness for Metainstancer

File:MetaInstancersettings1.png

2025-08-16T16:06:21Z

NextinHKRY:

Scene setup for Meta-instancer

Tools

2025-08-16T15:56:07Z

NextinHKRY: Add Meta instancer tool page

This section contains tools that aren't specific to any Sonic game. Below you can see the tools divided by the engine they target and their purpose.

== Various Engines ==

=== Audio ===

* [[SonicAudioTools]] (.csb / .acb)

== Hedgehog Engine ==

=== Animations ===

* [[Frontiers Animation Tools]] (.skl.pxd / .anm.pxd)
* [[KwasTools (Hedgehog Engine)|io_kwastools]] (.cam-anim / .uv-anim)
* [[Havok Animation Exporter]] (.skl.hkx / .anm.hkx)

=== Archives ===

* [[PackCpk]] (.cpk)
* [[YACpkTool]] (.cpk)

* [[HedgeArchiveEditor]] (.ar / .pfd / .pac)
* [[HedgeArcPack]] (.ar / .pfd / .pac)
* [[ar0pack-ar0unpack]] (.ar / .pfd)

=== Collision ===
* [[Havok Converter]] (.phy.hkx)

=== Level Editing ===

* [[SonicGLvl]]
* [[Meta Instancer]] (.mti)

=== Lighting ===
* [[GI Atlas Converter]]
* [[HedgeGI]]
* [[SonicLightTools]]

=== Shaders ===

* [[HE2 Shader Compiler]] (.vso / .pso / .cso / .hlsl)

=== Models ===

* [[Hedgehog Engine Blender I/O]]
* [[Model Converter]] (.model)
* [[modelfbx]] (.model / .terrain-model / .skl.hkx / .anm.hkx)
* [[terrain2fbx]] (.terrain-model)
* [[terrain2fbx-png]] (.terrain-model)

=== Terrain ===

* [[Hedgehog Converter]]

=== Textures ===

* [[NeedleTextureStreamingUtility]] (.ntsp / .dds)

=== Text ===
* [[Converse]] (.fco / .fte)

=== UI ===
* [[Shuriken]] (.xncp / .yncp)
* [[Kunai]] (.xncp / .yncp / .gncp / .sncp)

Sonic Unleashed

2025-08-16T15:51:32Z

NextinHKRY:

== Tools ==

=== Lighting ===
* [[pfdpackUnleashed]] (*.pfd)

=== Particles ===

* [[SU Particle Tool]] (*.part-bin, *.p-mat-bin, *.particle, *.p-material)

== Guides ==

=== Level Editing ===

* [[How To Use Sonic GLvl with Sonic Unleashed|SonicGLvl]]
* [[How To Import Custom Terrain in Sonic Generations/Sonic Unleashed|Importing Terrain]]
* [[How To Import Custom Collision in Sonic Generations/Sonic Unleashed|Importing Collision]]
* [[Troubleshooting Custom Level Issues in Sonic Generations/Sonic Unleashed|Troubleshooting]]

== Documentation ==
=== Game ===
* [[Sonic Unleashed Stage IDs|Stage IDs]]
* [[Sonic Unleashed Event IDs|Event IDs]]
* [[Unleashed-Generations Havok Collision Attributes|Havok Collision Attributes]]
* [[Sonic Unleashed Shaders|Shaders]]

== Discoveries ==

=== PlayStation 3 ===

* [[Sonic Unleashed Install Screen|Install Screen]]

SU Particle Tool

2025-08-16T15:50:44Z

NextinHKRY:

{{ToolInfobox|title=SU Particle Tool|author=Hedgeturd, NextinHKRY|website=https://github.com/Hedgeturd/SU-Particle-Tool|download=https://github.com/Hedgeturd/SU-Particle-Tool/releases/latest}}
'''SU Particle Tool''' is a command-line tool used to convert binary particle files from '''Sonic Unleashed''' (<code>.part-bin</code>, <code>.p-mat-bin</code>) into editable text files (<code>.particle</code>, <code>.p-material</code>).

== Usage ==
'''SU Particle Tool''' can convert from binary files to text files and vice-versa by dragging and dropping the corresponding files onto the tool, or by passing the path to the file in a command prompt. Converting text files back to binary files is not necessary, as the game recognizes both formats and will load them.
{{Notice|type=note|content=Using append archives (+Archive) with .particle and .p-material files is not recommended, as the game will sometimes load the binary variants instead based on when the append archive was loaded.}}

SU Particle Tool

2025-08-16T15:50:13Z

NextinHKRY: Create SU-Particle-Tool page

{{ToolInfobox|title=SU Particle Tool|author=Hedgeturd, NextinHKRY|website=https://github.com/Hedgeturd/SU-Particle-Tool|download=https://github.com/Hedgeturd/SU-Particle-Tool/releases/latest}}
'''SU Particle Tool''' is a command-line tool used to convert binary particle files from '''Sonic Unleashed''' (<code>.part-bin</code>, <code>.p-mat-bin</code>) into editable text files (<code>.particle</code>, <code>.p-material</code>).

== Usage ==
'''SU Particle Tool''' can convert from binary files to text files and vice-versa by dragging and dropping the corresponding files onto the tool, or by passing the path to the file in a command prompt. Converting text-based files back to binary files is not necessary, as the game recognizes both formats and will load them.
{{Notice|type=note|content=Using append archives (+Archive) with .particle and .p-material files is not recommended, as the game will sometimes load the binary variants instead based on when the append archive was loaded.}}

Sonic Unleashed

2025-08-16T15:37:13Z

NextinHKRY: Add SU particle tool

== Tools ==

=== Lighting ===
* [[pfdpackUnleashed]] (*.pfd)

=== Particles ===

* [[SU Particle Tool]]

== Guides ==

=== Level Editing ===

* [[How To Use Sonic GLvl with Sonic Unleashed|SonicGLvl]]
* [[How To Import Custom Terrain in Sonic Generations/Sonic Unleashed|Importing Terrain]]
* [[How To Import Custom Collision in Sonic Generations/Sonic Unleashed|Importing Collision]]
* [[Troubleshooting Custom Level Issues in Sonic Generations/Sonic Unleashed|Troubleshooting]]

== Documentation ==
=== Game ===
* [[Sonic Unleashed Stage IDs|Stage IDs]]
* [[Sonic Unleashed Event IDs|Event IDs]]
* [[Unleashed-Generations Havok Collision Attributes|Havok Collision Attributes]]
* [[Sonic Unleashed Shaders|Shaders]]

== Discoveries ==

=== PlayStation 3 ===

* [[Sonic Unleashed Install Screen|Install Screen]]

Troubleshooting Custom Level Issues in Sonic Generations/Sonic Unleashed

2025-05-03T10:40:17Z

NextinHKRY:

This page covers possible troubleshooting steps for custom levels in '''Sonic Generations''' and '''Sonic Unleashed.'''

== Visual Issues ==

=== Common ===

==== Black Textures ====
Textures must have power-of-two resolutions ''(e.g. 512x512, 1024x1024, 2048x2048, etc)''. Arbitrary resolutions like 507x631 are not supported when using compressed textures.

==== Randomly Switching Textures ====
The material doesn't have any textures assigned. The game expects at least a diffuse texture to be present for nearly every shader.

==== Missing Transparency On Textures ====
You might need <code>@LYR(trans)</code> or <code>@LYR(punch)</code> tags on your material names. See the [[How To Import Custom Terrain in Sonic Generations/Sonic Unleashed|terrain importing guide]] for more info. Your texture might be compressed using <code>BC1</code>/<code>DXT1</code>, which doesn't support alpha channels, you should use <code>BC3</code>/<code>DXT5</code> instead.

==== Missing Direct Light ====

If you add a new direct light, update <code>Terrain.stg.xml</code> (or <code>Stage.stg.xml</code> in Sonic Unleashed) with the name of the light:<syntaxhighlight lang="xml">
<Light>
<DataName>MyDirectLight</DataName>
</Light>
</syntaxhighlight>

==== Missing Sky Model ====

If you made a new sky model, update <code>Terrain.stg.xml</code> (or <code>Stage.stg.xml</code> in Sonic Unleashed) with the name of the sky model:<syntaxhighlight lang="xml">
<Sky>
<Model>MySkyModel</Model>
</Sky>
</syntaxhighlight>Make sure the sky model's materials use sky shaders like <code>Sky_d</code>.

==== Enemies From Other Stages Not Appearing ====

Some enemies are only loaded in specific stages. You can fix that by editing <code>EnemyArchiveTree.xml</code> inside <code>#Application.ar.00</code>. In this example, <code>ghz_cmn</code> entry was modified to include data from <code>EnemyEFighter</code>, allowing egg fighters to be used in both <code>ghz100</code> and <code>ghz200</code>:<syntaxhighlight lang="xml">
<DefAppend>
<Name>ghz_cmn</Name>
<Archive>EnemyCommon</Archive>
<Archive>EnemyBeeton</Archive>
<Archive>EnemyBatabata</Archive>
<Archive>EnemyGanigani</Archive>
<Archive>EnemyMotora</Archive>
<Archive>EnemyEFighter</Archive>
</DefAppend>
</syntaxhighlight>The same method applies to Sonic Unleashed.

<hr>
=== Sonic Unleashed ===

==== Missing Terrain Models ====
<code>Terrain.prm.xml</code> likely requires memory sizes to be higher. To fix this, edit <code>g_LimitSize</code> under <code>DynamicLoad</code> and <code>Terrain-Model</code> to values like '''100000000'''bytes or '''250000000'''bytes. Make sure to use sensible values as absurd values like '''999999999999''' are not going to work correctly. If editing the memory sizes does not work, you can try changing <code>g_EnableFrustumCulling</code> and <code>g_EnableOcclusionCulling</code> to <code>false</code> as a last resort. Note that disabling these two options might cause a performance hit in-game!

==== File Replacements Not Working ====
The title update and DLC override files in the base game archives by including them in a <code>work</code> folder. These files are going to always take priority over your modded files. This is a common problem with <code>Terrain.prm.xml</code> and<code>.set.xml</code> files. To override them, include the modified files in your mod in a <code>work</code> folder using the same file structure.

==== Invisible Materials ====
This happens when a material points to a shader that doesn't exist. To see all available shaders, unpack <code>shader.ar</code> in the base game directory and check for <code>.shader-list</code> files.

==== Low Quality or Missing GI Textures ====
<code>Terrain.prm.xml</code> likely requires memory sizes to be higher. To fix this, edit <code>g_LimitSize</code> under <code>DynamicLoad</code> and <code>GI-Texture</code> to values such as '''100000000'''bytes or '''250000000'''bytes. Make sure to use sensible values as absurd values like '''999999999''' are not going to work correctly. When DLC is enabled, the game looks inside the <code>Additional</code> folder to load HD GI, the parameter for it is named <code>g_Xbox360LimitSizeWithAdditional</code>, which you also should try to increase.

<hr>
=== Sonic Generations ===

==== Rainbow Flashing Textures ====
A rainbow flashing texture is displayed when a texture assigned to a material is missing. Ensure you included the texture in the archive and didn't make a typo in the material. Texture names are '''case-sensitive'''.

==== Missing Terrain Models ====
<code>Terrain.prm.xml</code> likely requires memory sizes to be higher. To fix this, edit <code>g_TerrainModelLimitSizeDefault</code> and <code>g_TerrainModelLimitSizeWin32</code> under <code>DynamicLoad</code> and <code>Terrain-Model</code> to values such as '''100'''mb or '''250'''mb. Make sure to use sensible values as absurd values like '''999999999''' are not going to work correctly.

==== Red Materials ====
This happens when a material points to a shader that doesn't exist. To see all available shaders, unpack <code>shader_r_add.ar.00</code> inside <code>bb3.cpk</code> and check for <code>.shader-list</code> files.

==== Low Quality or Missing GI Textures ====
<code>Terrain.prm.xml</code> likely requires memory sizes to be higher. To fix this, edit <code>g_GITextureLimitSizeDefault</code> and <code>g_GITextureLimitSizeWin32</code> under <code>DynamicLoad</code> and <code>GI-Texture</code> to values such as '''100'''mb or '''250'''mb. Make sure to use sensible values as absurd values like '''999999999''' are not going to work correctly.

== Crashes or Infinite Loading ==

=== Common ===

==== Missing Material Files ====
Unlike newer games, missing materials can crash Generations/Unleashed. For Sonic Unleashed, only having the <code>.material</code> file isn't enough, you also need the matching <code>.texset</code> and <code>.texture</code> files.

==== Periods in File Names ====
File names with extra periods break stuff. For example, <code>Material.000.material</code> gets read as <code>.000.material</code>, and the game won't recognize it properly.

==== Instance Names Starting with "ins" ====
Instances starting with <code>ins</code> are treated differently, and require specialized material shaders. Using any other shader causes a crash. Ensure that none of the instances in your stage start with this word.

==== Missing "gi-texture.gi-texture-group-info" File ====
Run [[GI Atlas Converter]] on Pre-Render mode to have this file created automatically.

==== Missing "light-list.light-list" File ====
Copy paste <code>.light</code> and <code>.light-list</code> files from another stage, or add a direct light to your level in the 3D software you use. Latest [[Hedgehog Converter]] can import direct lights, so ensure your tools are up to date. Use [[HedgeGI]] for advanced light editing.

==== Mismatching PFD/PFI Files ====
PFD files are loaded through PFI files. If the <code>Stage.pfi</code>/<code>Stage-Add.pfi</code> files don't match with the <code>Stage.pfd</code>/<code>Stage-Add.pfd</code> files in the stage, this causes a crash. Unpack the PFD files, and repack them back with [[HedgeArcPack]] using <code>-T=pfd</code> command-line option to generate matching PFI files.

==== Light Field File Too Large ====
Your game might crash randomly when booting your level if the level's light field (.lft) file is too large. Try increasing the minimum cell radius in HedgeGI to reduce the light field's file size.

<hr>
=== Sonic Unleashed ===

==== Incorrect Material Format ====
Unleashed uses a different material version (V1) compared to Generations (V3), and if you try to load a material from Generations in Unleashed, it'll crash. Check the version in a hex editor (7th byte), or look for <code>.texset</code>/<code>.texture</code>, those usually mean it's V1.

<hr>
=== Sonic Generations ===

==== Unloaded Sonic Animations ====

The game doesn't load certain Sonic animations to save memory if the gimmick in question is never used. For example, diving animations stored in <code>SonicDiving.ar.00</code> are only loaded in Chemical Plant, Speed Highway and Planet Wisp. If diving is used in any other stage, the game is going to crash due to unloaded animations. This behavior can be configured by editing <code>ArchiveTree.xml</code> inside <code>#Application.ar.00</code>. In this example, <code>SonicDiving</code> entry was edited to load in the <code>ghz200</code> stage slot:<syntaxhighlight lang="xml">
<Node>
<Name>SonicDiving</Name>
<Archive>SonicDiving</Archive>
<Order>0</Order>
<DefAppend>SonicDiving</DefAppend>
<Node>
<Name>bne</Name>
<Archive>bne</Archive>
<Order>0</Order>
</Node>
<Node>
<Name>cpz200</Name>
<Archive>cpz200</Archive>
<Order>0</Order>
</Node>
<Node>
<Name>pla200</Name>
<Archive>pla200</Archive>
<Order>0</Order>
</Node>
<Node>
<Name>sph200</Name>
<Archive>sph200</Archive>
<Order>0</Order>
</Node>
<Node>
<Name>ghz200</Name>
<Archive>ghz200</Archive>
<Order>0</Order>
</Node>
</Node>
</syntaxhighlight>

Troubleshooting Custom Level Issues in Sonic Generations/Sonic Unleashed

2025-05-02T20:30:59Z

NextinHKRY:

This page covers possible troubleshooting steps for custom levels in '''Sonic Generations''' and '''Sonic Unleashed.'''

== Visual Issues ==

=== Common ===

==== Black Textures ====
Textures must have power-of-two resolutions ''(e.g. 512x512, 1024x1024, 2048x2048, etc)''. Arbitrary resolutions like 507x631 are not supported when using compressed textures.

==== Randomly Switching Textures ====
The material doesn't have any textures assigned. The game expects at least a diffuse texture to be present for nearly every shader.

==== Missing Transparency On Textures ====
You might need <code>@LYR(trans)</code> or <code>@LYR(punch)</code> tags on your material names. See the [[How To Import Custom Terrain in Sonic Generations/Sonic Unleashed|terrain importing guide]] for more info. Your texture might be compressed using <code>BC1</code>/<code>DXT1</code>, which doesn't support alpha channels, you should use <code>BC3</code>/<code>DXT5</code> instead.

==== Missing Direct Light ====

If you add a new direct light, update <code>Terrain.stg.xml</code> (or <code>Stage.stg.xml</code> in Sonic Unleashed) with the name of the light:<syntaxhighlight lang="xml">
<Light>
<DataName>MyDirectLight</DataName>
</Light>
</syntaxhighlight>

==== Missing Sky Model ====

If you made a new sky model, update <code>Terrain.stg.xml</code> (or <code>Stage.stg.xml</code> in Sonic Unleashed) with the name of the sky model:<syntaxhighlight lang="xml">
<Sky>
<Model>MySkyModel</Model>
</Sky>
</syntaxhighlight>Make sure the sky model's materials use sky shaders like <code>Sky_d</code>.

==== Enemies From Other Stages Not Appearing ====

Some enemies are only loaded in specific stages. You can fix that by editing <code>EnemyArchiveTree.xml</code> inside <code>#Application.ar.00</code>. In this example, <code>ghz_cmn</code> entry was modified to include data from <code>EnemyEFighter</code>, allowing egg fighters to be used in both <code>ghz100</code> and <code>ghz200</code>:<syntaxhighlight lang="xml">
<DefAppend>
<Name>ghz_cmn</Name>
<Archive>EnemyCommon</Archive>
<Archive>EnemyBeeton</Archive>
<Archive>EnemyBatabata</Archive>
<Archive>EnemyGanigani</Archive>
<Archive>EnemyMotora</Archive>
<Archive>EnemyEFighter</Archive>
</DefAppend>
</syntaxhighlight>The same method applies to Sonic Unleashed.

<hr>
=== Sonic Unleashed ===

==== Missing Terrain Models ====
<code>Terrain.prm.xml</code> likely requires memory sizes to be higher. To fix this, edit <code>g_LimitSize</code> under <code>DynamicLoad</code> and <code>Terrain-Model</code> to values like '''100000000'''b or '''250000000'''b. Make sure to use sensible values as absurd values like '''999999999999''' are not going to work correctly. If editing the memory sizes does not work, you can try changing <code>g_EnableFrustumCulling</code> and <code>g_EnableOcclusionCulling</code> to <code>false</code> as a last resort. Note that disabling these two options might cause a performance hit in-game!

==== File Replacements Not Working ====
The title update and DLC override files in the base game archives by including them in a <code>work</code> folder. These files are going to always take priority over your modded files. This is a common problem with <code>Terrain.prm.xml</code> and<code>.set.xml</code> files. To override them, include the modified files in your mod in a <code>work</code> folder using the same file structure.

==== Invisible Materials ====
This happens when a material points to a shader that doesn't exist. To see all available shaders, unpack <code>shader.ar</code> in the base game directory and check for <code>.shader-list</code> files.

==== Low Quality or Missing GI Textures ====
<code>Terrain.prm.xml</code> likely requires memory sizes to be higher. To fix this, edit <code>g_LimitSize</code> under <code>DynamicLoad</code> and <code>GI-Texture</code> to values such as '''100000000'''b or '''250000000'''b. Make sure to use sensible values as absurd values like '''999999999''' are not going to work correctly. When DLC is enabled, the game looks inside the <code>Additional</code> folder to load HD GI, the parameter for it is named <code>g_Xbox360LimitSizeWithAdditional</code>, which you also should try to increase.

<hr>
=== Sonic Generations ===

==== Rainbow Flashing Textures ====
A rainbow flashing texture is displayed when a texture assigned to a material is missing. Ensure you included the texture in the archive and didn't make a typo in the material. Texture names are '''case-sensitive'''.

==== Missing Terrain Models ====
<code>Terrain.prm.xml</code> likely requires memory sizes to be higher. To fix this, edit <code>g_TerrainModelLimitSizeDefault</code> and <code>g_TerrainModelLimitSizeWin32</code> under <code>DynamicLoad</code> and <code>Terrain-Model</code> to values such as '''100'''mb or '''250'''mb. Make sure to use sensible values as absurd values like '''999999999''' are not going to work correctly.

==== Red Materials ====
This happens when a material points to a shader that doesn't exist. To see all available shaders, unpack <code>shader_r_add.ar.00</code> inside <code>bb3.cpk</code> and check for <code>.shader-list</code> files.

==== Low Quality or Missing GI Textures ====
<code>Terrain.prm.xml</code> likely requires memory sizes to be higher. To fix this, edit <code>g_GITextureLimitSizeDefault</code> and <code>g_GITextureLimitSizeWin32</code> under <code>DynamicLoad</code> and <code>GI-Texture</code> to values such as '''100'''mb or '''250'''mb. Make sure to use sensible values as absurd values like '''999999999''' are not going to work correctly.

== Crashes or Infinite Loading ==

=== Common ===

==== Missing Material Files ====
Unlike newer games, missing materials can crash Generations/Unleashed. For Sonic Unleashed, only having the <code>.material</code> file isn't enough, you also need the matching <code>.texset</code> and <code>.texture</code> files.

==== Periods in File Names ====
File names with extra periods break stuff. For example, <code>Material.000.material</code> gets read as <code>.000.material</code>, and the game won't recognize it properly.

==== Instance Names Starting with "ins" ====
Instances starting with <code>ins</code> are treated differently, and require specialized material shaders. Using any other shader causes a crash. Ensure that none of the instances in your stage start with this word.

==== Missing "gi-texture.gi-texture-group-info" File ====
Run [[GI Atlas Converter]] on Pre-Render mode to have this file created automatically.

==== Missing "light-list.light-list" File ====
Copy paste <code>.light</code> and <code>.light-list</code> files from another stage, or add a direct light to your level in the 3D software you use. Latest [[Hedgehog Converter]] can import direct lights, so ensure your tools are up to date. Use [[HedgeGI]] for advanced light editing.

==== Mismatching PFD/PFI Files ====
PFD files are loaded through PFI files. If the <code>Stage.pfi</code>/<code>Stage-Add.pfi</code> files don't match with the <code>Stage.pfd</code>/<code>Stage-Add.pfd</code> files in the stage, this causes a crash. Unpack the PFD files, and repack them back with [[HedgeArcPack]] using <code>-T=pfd</code> command-line option to generate matching PFI files.

==== Light Field File Too Large ====
Your game might crash randomly when booting your level if the level's light field (.lft) file is too large. Try increasing the minimum cell radius in HedgeGI to reduce the light field's file size.

<hr>
=== Sonic Unleashed ===

==== Incorrect Material Format ====
Unleashed uses a different material version (V1) compared to Generations (V3), and if you try to load a material from Generations in Unleashed, it'll crash. Check the version in a hex editor (7th byte), or look for <code>.texset</code>/<code>.texture</code>, those usually mean it's V1.

<hr>
=== Sonic Generations ===

==== Unloaded Sonic Animations ====

The game doesn't load certain Sonic animations to save memory if the gimmick in question is never used. For example, diving animations stored in <code>SonicDiving.ar.00</code> are only loaded in Chemical Plant, Speed Highway and Planet Wisp. If diving is used in any other stage, the game is going to crash due to unloaded animations. This behavior can be configured by editing <code>ArchiveTree.xml</code> inside <code>#Application.ar.00</code>. In this example, <code>SonicDiving</code> entry was edited to load in the <code>ghz200</code> stage slot:<syntaxhighlight lang="xml">
<Node>
<Name>SonicDiving</Name>
<Archive>SonicDiving</Archive>
<Order>0</Order>
<DefAppend>SonicDiving</DefAppend>
<Node>
<Name>bne</Name>
<Archive>bne</Archive>
<Order>0</Order>
</Node>
<Node>
<Name>cpz200</Name>
<Archive>cpz200</Archive>
<Order>0</Order>
</Node>
<Node>
<Name>pla200</Name>
<Archive>pla200</Archive>
<Order>0</Order>
</Node>
<Node>
<Name>sph200</Name>
<Archive>sph200</Archive>
<Order>0</Order>
</Node>
<Node>
<Name>ghz200</Name>
<Archive>ghz200</Archive>
<Order>0</Order>
</Node>
</Node>
</syntaxhighlight>

Troubleshooting Custom Level Issues in Sonic Generations/Sonic Unleashed

2025-05-02T20:27:28Z

NextinHKRY:

This page covers possible troubleshooting steps for custom levels in '''Sonic Generations''' and '''Sonic Unleashed.'''

== Visual Issues ==

=== Common ===

==== Black Textures ====
Textures must have power-of-two resolutions (like 512x512, 1024x1024, 2048x2048, etc). Arbitrary resolutions like 507x631 are not supported when using compressed textures.

==== Randomly Switching Textures ====
The material doesn't have any textures assigned. The game expects at least a diffuse texture to be present for nearly every shader.

==== Missing Transparency On Textures ====
You might need <code>@LYR(trans)</code> or <code>@LYR(punch)</code> tags on your material names. See the [[How To Import Custom Terrain in Sonic Generations/Sonic Unleashed|terrain importing guide]] for more info. Your texture might be compressed using <code>BC1</code>/<code>DXT1</code>, which doesn't support alpha channels, you should use <code>BC3</code>/<code>DXT5</code> instead.

==== Missing Direct Light ====

If you add a new direct light, update <code>Terrain.stg.xml</code> (or <code>Stage.stg.xml</code> in Sonic Unleashed) with the name of the light:<syntaxhighlight lang="xml">
<Light>
<DataName>MyDirectLight</DataName>
</Light>
</syntaxhighlight>

==== Missing Sky Model ====

If you made a new sky model, update <code>Terrain.stg.xml</code> (or <code>Stage.stg.xml</code> in Sonic Unleashed) with the name of the sky model:<syntaxhighlight lang="xml">
<Sky>
<Model>MySkyModel</Model>
</Sky>
</syntaxhighlight>Make sure the sky model's materials use sky shaders like <code>Sky_d</code>.

==== Enemies From Other Stages Not Appearing ====

Some enemies are only loaded in specific stages. You can fix that by editing <code>EnemyArchiveTree.xml</code> inside <code>#Application.ar.00</code>. In this example, <code>ghz_cmn</code> entry was modified to include data from <code>EnemyEFighter</code>, allowing egg fighters to be used in both <code>ghz100</code> and <code>ghz200</code>:<syntaxhighlight lang="xml">
<DefAppend>
<Name>ghz_cmn</Name>
<Archive>EnemyCommon</Archive>
<Archive>EnemyBeeton</Archive>
<Archive>EnemyBatabata</Archive>
<Archive>EnemyGanigani</Archive>
<Archive>EnemyMotora</Archive>
<Archive>EnemyEFighter</Archive>
</DefAppend>
</syntaxhighlight>The same method applies to Sonic Unleashed.

<hr>
=== Sonic Unleashed ===

==== Missing Terrain Models ====
<code>Terrain.prm.xml</code> likely requires memory sizes to be higher. To fix this, edit <code>g_LimitSize</code> under <code>DynamicLoad</code> and <code>Terrain-Model</code> to values like '''100000000'''b or '''250000000'''b. Make sure to use sensible values as absurd values like '''999999999999''' are not going to work correctly. If editing the memory sizes does not work, you can try changing <code>g_EnableFrustumCulling</code> and <code>g_EnableOcclusionCulling</code> to <code>false</code> as a last resort. Note that disabling these two options might cause a performance hit in-game!

==== File Replacements Not Working ====
The title update and DLC override files in the base game archives by including them in a <code>work</code> folder. These files are going to always take priority over your modded files. This is a common problem with <code>Terrain.prm.xml</code> and<code>.set.xml</code> files. To override them, include the modified files in your mod in a <code>work</code> folder using the same file structure.

==== Invisible Materials ====
This happens when a material points to a shader that doesn't exist. To see all available shaders, unpack <code>shader.ar</code> in the base game directory and check for <code>.shader-list</code> files.

==== Low Quality or Missing GI Textures ====
<code>Terrain.prm.xml</code> likely requires memory sizes to be higher. To fix this, edit <code>g_LimitSize</code> under <code>DynamicLoad</code> and <code>GI-Texture</code> to values such as '''100000000'''b or '''250000000'''b. Make sure to use sensible values as absurd values like '''999999999''' are not going to work correctly. When DLC is enabled, the game looks inside the <code>Additional</code> folder to load HD GI, the parameter for it is named <code>g_Xbox360LimitSizeWithAdditional</code>, which you also should try to increase.

<hr>
=== Sonic Generations ===

==== Rainbow Flashing Textures ====
A rainbow flashing texture is displayed when a texture assigned to a material is missing. Ensure you included the texture in the archive and didn't make a typo in the material. Texture names are '''case-sensitive'''.

==== Missing Terrain Models ====
<code>Terrain.prm.xml</code> likely requires memory sizes to be higher. To fix this, edit <code>g_TerrainModelLimitSizeDefault</code> and <code>g_TerrainModelLimitSizeWin32</code> under <code>DynamicLoad</code> and <code>Terrain-Model</code> to values such as '''100'''mb or '''250'''mb. Make sure to use sensible values as absurd values like '''999999999''' are not going to work correctly.

==== Red Materials ====
This happens when a material points to a shader that doesn't exist. To see all available shaders, unpack <code>shader_r_add.ar.00</code> inside <code>bb3.cpk</code> and check for <code>.shader-list</code> files.

==== Low Quality or Missing GI Textures ====
<code>Terrain.prm.xml</code> likely requires memory sizes to be higher. To fix this, edit <code>g_GITextureLimitSizeDefault</code> and <code>g_GITextureLimitSizeWin32</code> under <code>DynamicLoad</code> and <code>GI-Texture</code> to values such as '''100'''mb or '''250'''mb. Make sure to use sensible values as absurd values like '''999999999''' are not going to work correctly.

== Crashes or Infinite Loading ==

=== Common ===

==== Missing Material Files ====
Unlike newer games, missing materials can crash Generations/Unleashed. For Sonic Unleashed, only having the <code>.material</code> file isn't enough, you also need the matching <code>.texset</code> and <code>.texture</code> files.

==== Periods in File Names ====
File names with extra periods break stuff. For example, <code>Material.000.material</code> gets read as <code>.000.material</code>, and the game won't recognize it properly.

==== Instance Names Starting with "ins" ====
Instances starting with <code>ins</code> are treated differently, and require specialized material shaders. Using any other shader causes a crash. Ensure that none of the instances in your stage start with this word.

==== Missing "gi-texture.gi-texture-group-info" File ====
Run [[GI Atlas Converter]] on Pre-Render mode to have this file created automatically.

==== Missing "light-list.light-list" File ====
Copy paste <code>.light</code> and <code>.light-list</code> files from another stage, or add a direct light to your level in the 3D software you use. Latest [[Hedgehog Converter]] can import direct lights, so ensure your tools are up to date. Use [[HedgeGI]] for advanced light editing.

==== Mismatching PFD/PFI Files ====
PFD files are loaded through PFI files. If the <code>Stage.pfi</code>/<code>Stage-Add.pfi</code> files don't match with the <code>Stage.pfd</code>/<code>Stage-Add.pfd</code> files in the stage, this causes a crash. Unpack the PFD files, and repack them back with [[HedgeArcPack]] using <code>-T=pfd</code> command-line option to generate matching PFI files.

==== Light Field File Too Large ====
Your game might crash randomly when booting your level if the level's light field (.lft) file is too large. Try increasing the minimum cell radius in HedgeGI to reduce the light field's file size.

<hr>
=== Sonic Unleashed ===

==== Incorrect Material Format ====
Unleashed uses a different material version (V1) compared to Generations (V3), and if you try to load a material from Generations in Unleashed, it'll crash. Check the version in a hex editor (7th byte), or look for <code>.texset</code>/<code>.texture</code>, those usually mean it's V1.

<hr>
=== Sonic Generations ===

==== Unloaded Sonic Animations ====

The game doesn't load certain Sonic animations to save memory if the gimmick in question is never used. For example, diving animations stored in <code>SonicDiving.ar.00</code> are only loaded in Chemical Plant, Speed Highway and Planet Wisp. If diving is used in any other stage, the game is going to crash due to unloaded animations. This behavior can be configured by editing <code>ArchiveTree.xml</code> inside <code>#Application.ar.00</code>. In this example, <code>SonicDiving</code> entry was edited to load in the <code>ghz200</code> stage slot:<syntaxhighlight lang="xml">
<Node>
<Name>SonicDiving</Name>
<Archive>SonicDiving</Archive>
<Order>0</Order>
<DefAppend>SonicDiving</DefAppend>
<Node>
<Name>bne</Name>
<Archive>bne</Archive>
<Order>0</Order>
</Node>
<Node>
<Name>cpz200</Name>
<Archive>cpz200</Archive>
<Order>0</Order>
</Node>
<Node>
<Name>pla200</Name>
<Archive>pla200</Archive>
<Order>0</Order>
</Node>
<Node>
<Name>sph200</Name>
<Archive>sph200</Archive>
<Order>0</Order>
</Node>
<Node>
<Name>ghz200</Name>
<Archive>ghz200</Archive>
<Order>0</Order>
</Node>
</Node>
</syntaxhighlight>

Troubleshooting Custom Level Issues in Sonic Generations/Sonic Unleashed

2025-05-02T18:53:56Z

NextinHKRY:

This page covers possible troubleshooting steps for custom levels in '''Sonic Generations''' and '''Sonic Unleashed.'''

== Visual Issues ==

=== Common ===

==== Black Textures ====
Textures must have power-of-two resolutions (like 512x512, 1024x1024, 2048x2048, etc). Arbitrary resolutions like 507x631 are not supported when using compressed textures.

==== Randomly Switching Textures ====
The material doesn't have any textures assigned. The game expects at least a diffuse texture to be present for nearly every shader.

==== Missing Transparency On Textures ====
You might need <code>@LYR(trans)</code> or <code>@LYR(punch)</code> tags on your material names. See the [[How To Import Custom Terrain in Sonic Generations/Sonic Unleashed|terrain importing guide]] for more info. Your texture might be compressed using <code>BC1</code>/<code>DXT1</code>, which doesn't support alpha channels, you should use <code>BC3</code>/<code>DXT5</code> instead.

==== Missing Direct Light ====

If you add a new direct light, update <code>Terrain.stg.xml</code> (or <code>Stage.stg.xml</code> in Sonic Unleashed) with the name of the light:<syntaxhighlight lang="xml">
<Light>
<DataName>MyDirectLight</DataName>
</Light>
</syntaxhighlight>

==== Missing Sky Model ====

If you made a new sky model, update <code>Terrain.stg.xml</code> (or <code>Stage.stg.xml</code> in Sonic Unleashed) with the name of the sky model:<syntaxhighlight lang="xml">
<Sky>
<Model>MySkyModel</Model>
</Sky>
</syntaxhighlight>Make sure the sky model's materials use sky shaders like <code>Sky_d</code>.

==== Enemies From Other Stages Not Appearing ====

Some enemies are only loaded in specific stages. You can fix that by editing <code>EnemyArchiveTree.xml</code> inside <code>#Application.ar.00</code>. In this example, <code>ghz_cmn</code> entry was modified to include data from <code>EnemyEFighter</code>, allowing egg fighters to be used in both <code>ghz100</code> and <code>ghz200</code>:<syntaxhighlight lang="xml">
<DefAppend>
<Name>ghz_cmn</Name>
<Archive>EnemyCommon</Archive>
<Archive>EnemyBeeton</Archive>
<Archive>EnemyBatabata</Archive>
<Archive>EnemyGanigani</Archive>
<Archive>EnemyMotora</Archive>
<Archive>EnemyEFighter</Archive>
</DefAppend>
</syntaxhighlight>The same method applies to Sonic Unleashed.

<hr>
=== Sonic Unleashed ===

==== Missing Terrain Models ====
<code>Terrain.prm.xml</code> likely requires memory sizes to be higher. To fix this, edit <code>g_LimitSize</code> under <code>DynamicLoad</code> and <code>Terrain-Model</code> to values like '''100000000'''b or '''250000000'''b. Make sure to use sensible values as absurd values like '''999999999999''' are not going to work correctly. If editing the memory sizes does not work, you can try changing <code>g_EnableFrustumCulling</code> and <code>g_EnableOcclusionCulling</code> to <code>false</code> as a last resort. Note that disabling these two options might cause a performance hit in-game!

==== File Replacements Not Working ====
The title update and DLC override files in the base game archives by including them in a <code>work</code> folder. These files are going to always take priority over your modded files. This is a common problem with <code>Terrain.prm.xml</code> and<code>.set.xml</code> files. To override them, include the modified files in your mod in a <code>work</code> folder using the same file structure.

==== Invisible Materials ====
This happens when a material points to a shader that doesn't exist. To see all available shaders, unpack <code>shader.ar</code> in the base game directory and check for <code>.shader-list</code> files.

==== Low Quality or Missing GI Textures ====
<code>Terrain.prm.xml</code> likely requires memory sizes to be higher. To fix this, edit <code>g_LimitSize</code> under <code>DynamicLoad</code> and <code>GI-Texture</code> to values such as '''100000000'''b or '''250000000'''b. Make sure to use sensible values as absurd values like '''999999999''' are not going to work correctly. When DLC is enabled, the game looks inside the <code>Additional</code> folder to load HD GI, the parameter for it is named <code>g_Xbox360LimitSizeWithAdditional</code>, which you also should try to increase.

<hr>
=== Sonic Generations ===

==== Rainbow Flashing Textures ====
A rainbow flashing texture is displayed when a texture assigned to a material is missing. Ensure you included the texture in the archive and didn't make a typo in the material. Texture names are '''case-sensitive'''.

==== Missing Terrain Models ====
<code>Terrain.prm.xml</code> likely requires memory sizes to be higher. To fix this, edit <code>g_TerrainModelLimitSizeDefault</code> and <code>g_TerrainModelLimitSizeWin32</code> under <code>DynamicLoad</code> and <code>Terrain-Model</code> to values such as '''100'''mb or '''250'''mb. Make sure to use sensible values as absurd values like '''999999999''' are not going to work correctly.

==== Red Materials ====
This happens when a material points to a shader that doesn't exist. To see all available shaders, unpack <code>shader_r_add.ar.00</code> inside <code>bb3.cpk</code> and check for <code>.shader-list</code> files.

==== Low Quality or Missing GI Textures ====
<code>Terrain.prm.xml</code> likely requires memory sizes to be higher. To fix this, edit <code>g_GITextureLimitSizeDefault</code> and <code>g_GITextureLimitSizeWin32</code> under <code>DynamicLoad</code> and <code>GI-Texture</code> to values such as '''100'''mb or '''250'''mb. Make sure to use sensible values as absurd values like '''999999999''' are not going to work correctly.

== Crashes or Infinite Loading ==

=== Common ===

==== Missing Material Files ====
Unlike newer games, missing materials can crash Generations/Unleashed. For Sonic Unleashed, only having the <code>.material</code> file isn't enough, you also need the matching <code>.texset</code> and <code>.texture</code> files.

==== Periods in File Names ====
File names with extra periods break stuff. For example, <code>Material.000.material</code> gets read as <code>.000.material</code>, and the game won't recognize it properly.

==== Instance Names Starting with "ins" ====
Instances starting with <code>ins</code> are treated differently, and require specialized material shaders. Using any other shader causes a crash. Ensure that none of the instances in your stage start with this word.

==== Missing "gi-texture.gi-texture-group-info" File ====
Run [[GI Atlas Converter]] on Pre-Render mode to have this file created automatically.

==== Missing "light-list.light-list" File ====
Copy paste <code>.light</code> and <code>.light-list</code> files from another stage, or add a direct light to your level in the 3D software you use. Latest [[Hedgehog Converter]] can import direct lights, so ensure your tools are up to date. Use [[HedgeGI]] for advanced light editing.

==== Mismatching PFD/PFI Files ====
PFD files are loaded through PFI files. If the <code>Stage.pfi</code>/<code>Stage-Add.pfi</code> files don't match with the <code>Stage.pfd</code>/<code>Stage-Add.pfd</code> files in the stage, this causes a crash. Unpack the PFD files, and repack them back with [[HedgeArcPack]] using <code>-T=pfd</code> command-line option to generate matching PFI files.

==== Light Field File Too Large ====
Your game might crash randomly when booting your level if the level's light field (.lft) file is too large. Try increasing the minimum cell radius in HedgeGI to reduce the light field's file size.

<hr>
=== Sonic Unleashed ===

==== Incorrect Material Format ====
Unleashed uses V1 materials while Generations uses V3. If you try to load a V3 material in Unleashed, it'll crash. Check the version in a hex editor (7th byte), or look for <code>.texset</code>/<code>.texture</code>, those usually mean it's V1.

<hr>
=== Sonic Generations ===

==== Unloaded Sonic Animations ====

The game doesn't load certain Sonic animations to save memory if the gimmick in question is never used. For example, diving animations stored in <code>SonicDiving.ar.00</code> are only loaded in Chemical Plant, Speed Highway and Planet Wisp. If diving is used in any other stage, the game is going to crash due to unloaded animations. This behavior can be configured by editing <code>ArchiveTree.xml</code> inside <code>#Application.ar.00</code>. In this example, <code>SonicDiving</code> entry was edited to load in the <code>ghz200</code> stage slot:<syntaxhighlight lang="xml">
<Node>
<Name>SonicDiving</Name>
<Archive>SonicDiving</Archive>
<Order>0</Order>
<DefAppend>SonicDiving</DefAppend>
<Node>
<Name>bne</Name>
<Archive>bne</Archive>
<Order>0</Order>
</Node>
<Node>
<Name>cpz200</Name>
<Archive>cpz200</Archive>
<Order>0</Order>
</Node>
<Node>
<Name>pla200</Name>
<Archive>pla200</Archive>
<Order>0</Order>
</Node>
<Node>
<Name>sph200</Name>
<Archive>sph200</Archive>
<Order>0</Order>
</Node>
<Node>
<Name>ghz200</Name>
<Archive>ghz200</Archive>
<Order>0</Order>
</Node>
</Node>
</syntaxhighlight>

Troubleshooting Custom Level Issues in Sonic Generations/Sonic Unleashed

2025-05-02T18:50:04Z

NextinHKRY:

This page covers both '''Sonic Generations''' and '''Sonic Unleashed'''. If no game is specified, the explanation applies to both games.

== Visual Issues ==

=== Common ===

==== Black Textures ====
Textures must have power-of-two resolutions (like 512x512, 1024x1024, 2048x2048, etc). Arbitrary resolutions like 507x631 are not supported when using compressed textures.

==== Randomly Switching Textures ====
The material doesn't have any textures assigned. The game expects at least a diffuse texture to be present for nearly every shader.

==== Missing Transparency On Textures ====
You might need <code>@LYR(trans)</code> or <code>@LYR(punch)</code> tags on your material names. See the [[How To Import Custom Terrain in Sonic Generations/Sonic Unleashed|terrain importing guide]] for more info. Your texture might be compressed using <code>BC1</code>/<code>DXT1</code>, which doesn't support alpha channels, you should use <code>BC3</code>/<code>DXT5</code> instead.

==== Missing Direct Light ====

If you add a new direct light, update <code>Terrain.stg.xml</code> (or <code>Stage.stg.xml</code> in Sonic Unleashed) with the name of the light:<syntaxhighlight lang="xml">
<Light>
<DataName>MyDirectLight</DataName>
</Light>
</syntaxhighlight>

==== Missing Sky Model ====

If you made a new sky model, update <code>Terrain.stg.xml</code> (or <code>Stage.stg.xml</code> in Sonic Unleashed) with the name of the sky model:<syntaxhighlight lang="xml">
<Sky>
<Model>MySkyModel</Model>
</Sky>
</syntaxhighlight>Make sure the sky model's materials use sky shaders like <code>Sky_d</code>.

==== Enemies From Other Stages Not Appearing ====

Some enemies are only loaded in specific stages. You can fix that by editing <code>EnemyArchiveTree.xml</code> inside <code>#Application.ar.00</code>. In this example, <code>ghz_cmn</code> entry was modified to include data from <code>EnemyEFighter</code>, allowing egg fighters to be used in both <code>ghz100</code> and <code>ghz200</code>:<syntaxhighlight lang="xml">
<DefAppend>
<Name>ghz_cmn</Name>
<Archive>EnemyCommon</Archive>
<Archive>EnemyBeeton</Archive>
<Archive>EnemyBatabata</Archive>
<Archive>EnemyGanigani</Archive>
<Archive>EnemyMotora</Archive>
<Archive>EnemyEFighter</Archive>
</DefAppend>
</syntaxhighlight>The same method applies to Sonic Unleashed.

<hr>
=== Sonic Unleashed ===

==== Missing Terrain Models ====
<code>Terrain.prm.xml</code> likely requires memory sizes to be higher. To fix this, edit <code>g_LimitSize</code> under <code>DynamicLoad</code> and <code>Terrain-Model</code> to values like '''100000000'''b or '''250000000'''b. Make sure to use sensible values as absurd values like '''999999999999''' are not going to work correctly. If editing the memory sizes does not work, you can try changing <code>g_EnableFrustumCulling</code> and <code>g_EnableOcclusionCulling</code> to <code>false</code> as a last resort. Note that disabling these two options might cause a performance hit in-game!

==== File Replacements Not Working ====
The title update and DLC override files in the base game archives by including them in a <code>work</code> folder. These files are going to always take priority over your modded files. This is a common problem with <code>Terrain.prm.xml</code> and<code>.set.xml</code> files. To override them, include the modified files in your mod in a <code>work</code> folder using the same file structure.

==== Invisible Materials ====
This happens when a material points to a shader that doesn't exist. To see all available shaders, unpack <code>shader.ar</code> in the base game directory and check for <code>.shader-list</code> files.

==== Low Quality or Missing GI Textures ====
<code>Terrain.prm.xml</code> likely requires memory sizes to be higher. To fix this, edit <code>g_LimitSize</code> under <code>DynamicLoad</code> and <code>GI-Texture</code> to values such as '''100000000'''b or '''250000000'''b. Make sure to use sensible values as absurd values like '''999999999''' are not going to work correctly. When DLC is enabled, the game looks inside the <code>Additional</code> folder to load HD GI, the parameter for it is named <code>g_Xbox360LimitSizeWithAdditional</code>, which you also should try to increase.

<hr>
=== Sonic Generations ===

==== Rainbow Flashing Textures ====
A rainbow flashing texture is displayed when a texture assigned to a material is missing. Ensure you included the texture in the archive and didn't make a typo in the material. Texture names are '''case-sensitive'''.

==== Missing Terrain Models ====
<code>Terrain.prm.xml</code> likely requires memory sizes to be higher. To fix this, edit <code>g_TerrainModelLimitSizeDefault</code> and <code>g_TerrainModelLimitSizeWin32</code> under <code>DynamicLoad</code> and <code>Terrain-Model</code> to values such as '''100'''mb or '''250'''mb. Make sure to use sensible values as absurd values like '''999999999''' are not going to work correctly.

==== Red Materials ====
This happens when a material points to a shader that doesn't exist. To see all available shaders, unpack <code>shader_r_add.ar.00</code> inside <code>bb3.cpk</code> and check for <code>.shader-list</code> files.

==== Low Quality or Missing GI Textures ====
<code>Terrain.prm.xml</code> likely requires memory sizes to be higher. To fix this, edit <code>g_GITextureLimitSizeDefault</code> and <code>g_GITextureLimitSizeWin32</code> under <code>DynamicLoad</code> and <code>GI-Texture</code> to values such as '''100'''mb or '''250'''mb. Make sure to use sensible values as absurd values like '''999999999''' are not going to work correctly.

== Crashes or Infinite Loading ==

=== Common ===

==== Missing Material Files ====
Unlike newer games, missing materials can crash Generations/Unleashed. For Sonic Unleashed, only having the <code>.material</code> file isn't enough, you also need the matching <code>.texset</code> and <code>.texture</code> files.

==== Periods in File Names ====
File names with extra periods break stuff. For example, <code>Material.000.material</code> gets read as <code>.000.material</code>, and the game won't recognize it properly.

==== Instance Names Starting with "ins" ====
Instances starting with <code>ins</code> are treated differently, and require specialized material shaders. Using any other shader causes a crash. Ensure that none of the instances in your stage start with this word.

==== Missing "gi-texture.gi-texture-group-info" File ====
Run [[GI Atlas Converter]] on Pre-Render mode to have this file created automatically.

==== Missing "light-list.light-list" File ====
Copy paste <code>.light</code> and <code>.light-list</code> files from another stage, or add a direct light to your level in the 3D software you use. Latest [[Hedgehog Converter]] can import direct lights, so ensure your tools are up to date. Use [[HedgeGI]] for advanced light editing.

==== Mismatching PFD/PFI Files ====
PFD files are loaded through PFI files. If the <code>Stage.pfi</code>/<code>Stage-Add.pfi</code> files don't match with the <code>Stage.pfd</code>/<code>Stage-Add.pfd</code> files in the stage, this causes a crash. Unpack the PFD files, and repack them back with [[HedgeArcPack]] using <code>-T=pfd</code> command-line option to generate matching PFI files.

==== Light Field File Too Large ====
Your game might crash randomly when booting your level if the level's light field (.lft) file is too large. Try increasing the minimum cell radius in HedgeGI to reduce the light field's file size.

<hr>
=== Sonic Unleashed ===

==== Incorrect Material Format ====
Unleashed uses V1 materials while Generations uses V3. If you try to load a V3 material in Unleashed, it'll crash. Check the version in a hex editor (7th byte), or look for <code>.texset</code>/<code>.texture</code>, those usually mean it's V1.

<hr>
=== Sonic Generations ===

==== Unloaded Sonic Animations ====

The game doesn't load certain Sonic animations to save memory if the gimmick in question is never used. For example, diving animations stored in <code>SonicDiving.ar.00</code> are only loaded in Chemical Plant, Speed Highway and Planet Wisp. If diving is used in any other stage, the game is going to crash due to unloaded animations. This behavior can be configured by editing <code>ArchiveTree.xml</code> inside <code>#Application.ar.00</code>. In this example, <code>SonicDiving</code> entry was edited to load in the <code>ghz200</code> stage slot:<syntaxhighlight lang="xml">
<Node>
<Name>SonicDiving</Name>
<Archive>SonicDiving</Archive>
<Order>0</Order>
<DefAppend>SonicDiving</DefAppend>
<Node>
<Name>bne</Name>
<Archive>bne</Archive>
<Order>0</Order>
</Node>
<Node>
<Name>cpz200</Name>
<Archive>cpz200</Archive>
<Order>0</Order>
</Node>
<Node>
<Name>pla200</Name>
<Archive>pla200</Archive>
<Order>0</Order>
</Node>
<Node>
<Name>sph200</Name>
<Archive>sph200</Archive>
<Order>0</Order>
</Node>
<Node>
<Name>ghz200</Name>
<Archive>ghz200</Archive>
<Order>0</Order>
</Node>
</Node>
</syntaxhighlight>

Troubleshooting Custom Level Issues in Sonic Generations/Sonic Unleashed

2025-05-02T18:45:33Z

NextinHKRY: Formatting fixes

This page covers both '''Sonic Generations''' and '''Sonic Unleashed'''. If no game is specified, the explanation applies to both games.

== Visual Issues ==

=== Common ===

==== Black Textures ====
Textures must have power-of-two resolutions (like 512x512, 1024x1024, 2048x2048, etc). Arbitrary resolutions like 507x631 are not supported when using compressed textures.

==== Randomly Switching Textures ====
The material doesn't have any textures assigned. The game expects at least a diffuse texture to be present for nearly every shader.

==== Missing Transparency On Textures ====
You might need <code>@LYR(trans)</code> or <code>@LYR(punch)</code> tags on your material names. See the [[How To Import Custom Terrain in Sonic Generations/Sonic Unleashed|terrain importing guide]] for more info. Your texture might be compressed using <code>BC1</code>/<code>DXT1</code>, which doesn't support alpha channels, you should use <code>BC3</code>/<code>DXT5</code> instead.

==== Missing Direct Light ====

If you add a new direct light, update <code>Terrain.stg.xml</code> (or <code>Stage.stg.xml</code> in Sonic Unleashed) with the name of the light:<syntaxhighlight lang="xml">
<Light>
<DataName>MyDirectLight</DataName>
</Light>
</syntaxhighlight>

==== Missing Sky Model ====

If you made a new sky model, update <code>Terrain.stg.xml</code> (or <code>Stage.stg.xml</code> in Sonic Unleashed) with the name of the sky model:<syntaxhighlight lang="xml">
<Sky>
<Model>MySkyModel</Model>
</Sky>
</syntaxhighlight>Make sure the sky model's materials use sky shaders like <code>Sky_d</code>.

==== Enemies From Other Stages Not Appearing ====

Some enemies are only loaded in specific stages. You can fix that by editing <code>EnemyArchiveTree.xml</code> inside <code>#Application.ar.00</code>. In this example, <code>ghz_cmn</code> entry was modified to include data from <code>EnemyEFighter</code>, allowing egg fighters to be used in both <code>ghz100</code> and <code>ghz200</code>:<syntaxhighlight lang="xml">
<DefAppend>
<Name>ghz_cmn</Name>
<Archive>EnemyCommon</Archive>
<Archive>EnemyBeeton</Archive>
<Archive>EnemyBatabata</Archive>
<Archive>EnemyGanigani</Archive>
<Archive>EnemyMotora</Archive>
<Archive>EnemyEFighter</Archive>
</DefAppend>
</syntaxhighlight>The same method applies to Sonic Unleashed.

=== Sonic Unleashed ===

==== Missing Terrain Models ====
<code>Terrain.prm.xml</code> likely requires memory sizes to be higher. To fix this, edit <code>g_LimitSize</code> under <code>DynamicLoad</code> and <code>Terrain-Model</code> to values like '''100000000'''b or '''250000000'''b. Make sure to use sensible values as absurd values like '''999999999999''' are not going to work correctly. If editing the memory sizes does not work, you can try changing <code>g_EnableFrustumCulling</code> and <code>g_EnableOcclusionCulling</code> to <code>false</code> as a last resort. Note that disabling these two options might cause a performance hit in-game!

==== File Replacements Not Working ====
The title update and DLC override files in the base game archives by including them in a <code>work</code> folder. These files are going to always take priority over your modded files. This is a common problem with <code>Terrain.prm.xml</code> and<code>.set.xml</code> files. To override them, include the modified files in your mod in a <code>work</code> folder using the same file structure.

==== Invisible Materials ====
This happens when a material points to a shader that doesn't exist. To see all available shaders, unpack <code>shader.ar</code> in the base game directory and check for <code>.shader-list</code> files.

==== Low Quality or Missing GI Textures ====
<code>Terrain.prm.xml</code> likely requires memory sizes to be higher. To fix this, edit <code>g_LimitSize</code> under <code>DynamicLoad</code> and <code>GI-Texture</code> to values such as '''100000000'''b or '''250000000'''b. Make sure to use sensible values as absurd values like '''999999999''' are not going to work correctly. When DLC is enabled, the game looks inside the <code>Additional</code> folder to load HD GI, the parameter for it is named <code>g_Xbox360LimitSizeWithAdditional</code>, which you also should try to increase.

=== Sonic Generations ===

==== Rainbow Flashing Textures ====
A rainbow flashing texture is displayed when a texture assigned to a material is missing. Ensure you included the texture in the archive and didn't make a typo in the material. Texture names are '''case-sensitive'''.

==== Missing Terrain Models ====
<code>Terrain.prm.xml</code> likely requires memory sizes to be higher. To fix this, edit <code>g_TerrainModelLimitSizeDefault</code> and <code>g_TerrainModelLimitSizeWin32</code> under <code>DynamicLoad</code> and <code>Terrain-Model</code> to values such as '''100'''mb or '''250'''mb. Make sure to use sensible values as absurd values like '''999999999''' are not going to work correctly.

==== Red Materials ====
This happens when a material points to a shader that doesn't exist. To see all available shaders, unpack <code>shader_r_add.ar.00</code> inside <code>bb3.cpk</code> and check for <code>.shader-list</code> files.

==== Low Quality or Missing GI Textures ====
<code>Terrain.prm.xml</code> likely requires memory sizes to be higher. To fix this, edit <code>g_GITextureLimitSizeDefault</code> and <code>g_GITextureLimitSizeWin32</code> under <code>DynamicLoad</code> and <code>GI-Texture</code> to values such as '''100'''mb or '''250'''mb. Make sure to use sensible values as absurd values like '''999999999''' are not going to work correctly.

== Crashes or Infinite Loading ==

=== Common ===

==== Missing Material Files ====
Unlike newer games, missing materials can crash Generations/Unleashed. For Sonic Unleashed, only having the <code>.material</code> file isn't enough, you also need the matching <code>.texset</code> and <code>.texture</code> files.

==== Periods in File Names ====
File names with extra periods break stuff. For example, <code>Material.000.material</code> gets read as <code>.000.material</code>, and the game won't recognize it properly.

==== Instance Names Starting with "ins" ====
Instances starting with <code>ins</code> are treated differently, and require specialized material shaders. Using any other shader causes a crash. Ensure that none of the instances in your stage start with this word.

==== Missing "gi-texture.gi-texture-group-info" File ====
Run [[GI Atlas Converter]] on Pre-Render mode to have this file created automatically.

==== Missing "light-list.light-list" File ====
Copy paste <code>.light</code> and <code>.light-list</code> files from another stage, or add a direct light to your level in the 3D software you use. Latest [[Hedgehog Converter]] can import direct lights, so ensure your tools are up to date. Use [[HedgeGI]] for advanced light editing.

==== Mismatching PFD/PFI Files ====
PFD files are loaded through PFI files. If the <code>Stage.pfi</code>/<code>Stage-Add.pfi</code> files don't match with the <code>Stage.pfd</code>/<code>Stage-Add.pfd</code> files in the stage, this causes a crash. Unpack the PFD files, and repack them back with [[HedgeArcPack]] using <code>-T=pfd</code> command-line option to generate matching PFI files.

==== Light Field File Too Large ====
Your game might crash randomly when booting your level if the level's light field (.lft) file is too large. Try increasing the minimum cell radius in HedgeGI to reduce the light field's file size.

=== Sonic Unleashed ===

==== Incorrect Material Format ====
Unleashed uses V1 materials while Generations uses V3. If you try to load a V3 material in Unleashed, it'll crash. Check the version in a hex editor (7th byte), or look for <code>.texset</code>/<code>.texture</code>, those usually mean it's V1.

=== Sonic Generations ===

==== Unloaded Sonic Animations ====

The game doesn't load certain Sonic animations to save memory if the gimmick in question is never used. For example, diving animations stored in <code>SonicDiving.ar.00</code> are only loaded in Chemical Plant, Speed Highway and Planet Wisp. If diving is used in any other stage, the game is going to crash due to unloaded animations. This behavior can be configured by editing <code>ArchiveTree.xml</code> inside <code>#Application.ar.00</code>. In this example, <code>SonicDiving</code> entry was edited to load in the <code>ghz200</code> stage slot:<syntaxhighlight lang="xml">
<Node>
<Name>SonicDiving</Name>
<Archive>SonicDiving</Archive>
<Order>0</Order>
<DefAppend>SonicDiving</DefAppend>
<Node>
<Name>bne</Name>
<Archive>bne</Archive>
<Order>0</Order>
</Node>
<Node>
<Name>cpz200</Name>
<Archive>cpz200</Archive>
<Order>0</Order>
</Node>
<Node>
<Name>pla200</Name>
<Archive>pla200</Archive>
<Order>0</Order>
</Node>
<Node>
<Name>sph200</Name>
<Archive>sph200</Archive>
<Order>0</Order>
</Node>
<Node>
<Name>ghz200</Name>
<Archive>ghz200</Archive>
<Order>0</Order>
</Node>
</Node>
</syntaxhighlight>

Sonic Unleashed Event IDs

2025-05-02T16:37:54Z

NextinHKRY:

{{Notice|type=warn|content=This is a direct port from the old HedgeDocs, a new version of this page is being worked on by archxe.}}
{| class="wikitable"
!Cutscene Name
!Cutscene ID
|-
|Opening
|M0_01_05
|-
|A New Journey
|M0_06
|-
|Special Sundae
|M1_01
|-
|The First Night
|M1_02
|-
|Tails in Trouble!
|M1_03_1
|-
|To Spagonia!
|M1_03_2
|-
|Kidnapped
|M2_01
|-
|Same As Ever
|M2_02
|-
|Gaia Manuscripts
|M2_03
|-
|Eggman Again
|M3_01
|-
|The Egg Beetle
|M3_02
|-
|Temple Activated!
|M3_03
|-
|Planet Pieces
|M3_04
|-
|Tails' Report
|M3_05
|-
|Eggman's Idea
|M4_01
|-
|Guiding Pulse
|M5_01
|-
|The Dark Gaia Project
|M5_02
|-
|Chip's Change
|M6_01
|-
|Chip's Memories
|M6_02
|-
|No Reason
|M6_03
|-
|Eggmanland
|M7_01
|-
|The Final Temple
|M7_02
|-
|The 7th Continent
|M7_03
|-
|Congratulations
|M7_04
|-
|Pickle's Message
|M8_01
|-
|The Egg Dragoon
|M8_02
|-
|Planet's End
|M8_03
|-
|Dark Gaia Appears
|M8_04
|-
|Shrines in Flight
|M8_05
|-
|Hour of Awakening
|M8_06_1
|-
|Let's Finish This!
|M8_06_2
|-
|Speading Darkness
|M8_07
|-
|Dark World
|M8_08
|-
|Hope and Despair
|M8_09
|-
|The Final Form
|M8_10
|-
|Darkness and Light
|M8_11_1
|-
|Annihilation
|M8_11_2
|-
|A Score Settled
|M8_11_3
|-
|Rekindled Light
|M8_12
|-
|Begin Anew
|M8_13
|-
|Save the Speech
|M8_14
|-
|To the Surface
|M8_15
|-
|Always
|M8_16
|-
|The Divine Beast
|S1_03
|-
|The Key
|S1_04
|-
|Chun-Nan Temple
|S1_05
|-
|Back to Normal
|S1_06
|-
|Amy's Mistake
|S2_01
|-
|Midnight Dance
|S2_03
|-
|Rescuing Amy
|S2_04
|-
|A Monster on Ice
|S3_03
|-
|Holoskan Temple
|S3_04
|-
|Spagonian Temple
|T0_01
|-
|Shamaran Temple
|T0_02
|-
|Charge!
|T0_03
|-
|Temple Entrance
|T0_04
|-
|Sonic and Chip (in Chun-nan)
|CHN
|-
|Sonic and Chip (in Adabat)
|SEA
|-
|Sonic and Chip (in Holoska)
|SNW_gooON
|}

Sonic Unleashed

2025-05-02T16:37:30Z

NextinHKRY:

== Tools ==

=== Lighting ===
* [[pfdpackUnleashed]] (*.pfd)

== Guides ==

=== Level Editing ===

* [[How To Use Sonic GLvl with Sonic Unleashed|SonicGLvl]]
* [[How To Import Custom Terrain in Sonic Generations/Sonic Unleashed|Importing Terrain]]
* [[How To Import Custom Collision in Sonic Generations/Sonic Unleashed|Importing Collision]]

== Documentation ==

* [[Sonic Unleashed Stage IDs|Stage IDs]]
* [[Sonic Unleashed Event IDs|Event IDs]]
* [[Unleashed-Generations Havok Collision Attributes|Havok Collision Attributes]]

== Discoveries ==

=== PlayStation 3 ===

* [[Sonic Unleashed Install Screen|Install Screen]]

Sonic Unleashed Event IDs

2025-05-02T16:35:24Z

NextinHKRY: Created page with "{{Notice|type=warn|content=This is a direct port from HedgeDocs, a new version of this page is being worked on by archxe.}} {| class="wikitable" !Cutscene Name !Cutscene ID |- |Opening |M0_01_05 |- |A New Journey |M0_06 |- |Special Sundae |M1_01 |- |The First Night |M1_02 |- |Tails in Trouble! |M1_03_1 |- |To Spagonia! |M1_03_2 |- |Kidnapped |M2_01 |- |Same As Ever |M2_02 |- |Gaia Manuscripts |M2_03 |- |Eggman Again |M3_01 |- |The Egg Beetle |M3_02 |- |Temple Activated!..."

{{Notice|type=warn|content=This is a direct port from HedgeDocs, a new version of this page is being worked on by archxe.}}
{| class="wikitable"
!Cutscene Name
!Cutscene ID
|-
|Opening
|M0_01_05
|-
|A New Journey
|M0_06
|-
|Special Sundae
|M1_01
|-
|The First Night
|M1_02
|-
|Tails in Trouble!
|M1_03_1
|-
|To Spagonia!
|M1_03_2
|-
|Kidnapped
|M2_01
|-
|Same As Ever
|M2_02
|-
|Gaia Manuscripts
|M2_03
|-
|Eggman Again
|M3_01
|-
|The Egg Beetle
|M3_02
|-
|Temple Activated!
|M3_03
|-
|Planet Pieces
|M3_04
|-
|Tails' Report
|M3_05
|-
|Eggman's Idea
|M4_01
|-
|Guiding Pulse
|M5_01
|-
|The Dark Gaia Project
|M5_02
|-
|Chip's Change
|M6_01
|-
|Chip's Memories
|M6_02
|-
|No Reason
|M6_03
|-
|Eggmanland
|M7_01
|-
|The Final Temple
|M7_02
|-
|The 7th Continent
|M7_03
|-
|Congratulations
|M7_04
|-
|Pickle's Message
|M8_01
|-
|The Egg Dragoon
|M8_02
|-
|Planet's End
|M8_03
|-
|Dark Gaia Appears
|M8_04
|-
|Shrines in Flight
|M8_05
|-
|Hour of Awakening
|M8_06_1
|-
|Let's Finish This!
|M8_06_2
|-
|Speading Darkness
|M8_07
|-
|Dark World
|M8_08
|-
|Hope and Despair
|M8_09
|-
|The Final Form
|M8_10
|-
|Darkness and Light
|M8_11_1
|-
|Annihilation
|M8_11_2
|-
|A Score Settled
|M8_11_3
|-
|Rekindled Light
|M8_12
|-
|Begin Anew
|M8_13
|-
|Save the Speech
|M8_14
|-
|To the Surface
|M8_15
|-
|Always
|M8_16
|-
|The Divine Beast
|S1_03
|-
|The Key
|S1_04
|-
|Chun-Nan Temple
|S1_05
|-
|Back to Normal
|S1_06
|-
|Amy's Mistake
|S2_01
|-
|Midnight Dance
|S2_03
|-
|Rescuing Amy
|S2_04
|-
|A Monster on Ice
|S3_03
|-
|Holoskan Temple
|S3_04
|-
|Spagonian Temple
|T0_01
|-
|Shamaran Temple
|T0_02
|-
|Charge!
|T0_03
|-
|Temple Entrance
|T0_04
|-
|Sonic and Chip (in Chun-nan)
|CHN
|-
|Sonic and Chip (in Adabat)
|SEA
|-
|Sonic and Chip (in Holoska)
|SNW_gooON
|}

How To Import Custom Terrain in Sonic Generations/Sonic Unleashed

2025-05-02T14:56:47Z

NextinHKRY:

{{Notice|type=info|content=This guide uses the following tools:
* [[SonicGLvl]]
* [[Hedgehog Converter]]
* [https://www.blender.org Blender]
* [[HedgeArcPack]]
* [[PackCpk]]
* [[Model Converter]]
You can use a different 3D software of your choice as long as you export to a format that Hedgehog Converter supports.}}

== Part 1 (Creating Terrain in Blender) ==
First of all you need terrain for your level, you can create the terrain yourself or you can use pre-existing terrain. If your level contains transparent materials you will need to add a layer tag, pick the one that's best suited for your use case in order to avoid visual issues.
{| class="wikitable"
!Layers
!Usage
|-
|punch
|Used for materials which have binary transparency (one part is 100% opaque, another is 100% transparent). Useful for most kinds of textures, like leaves or grass
|-
|trans
|Used for translucent materials, as in, materials which are not 100% opaque but also not 100% transparent (ex. windows)
|}
In order to specify a layer for a material, use the <code>@LYR</code> prefix, with the layer name between parenthesis after it.
[[File:Transparent material example terrain import generations.png|center|thumb|357x357px|Example of a transparent material in Blender]]
You can then export your terrain from Blender into an Assimp compatible format (<code>fbx</code>, <code>dae</code>, <code>gltf</code> or <code>obj</code> work). When exporting it as <code>fbx</code>, make sure to set '''Apply Scalings''' to '''FBX Units Scale''', otherwise your level is going to appear 100x larger in-game.[[File:Blender FBX Units Scale.png|center|thumb|FBX Units Scale in FBX exporter window.]]

== Part 2 (Importing the Level to the Game) ==
Download [[Hedgehog Converter]] and run <code>bin/HedgehogConverter.exe</code>. Fill in the following fields:

* '''Game engine''' - The game you are converting for
* '''Source 3D model files''' - Your terrain model files
* '''Source textures directory''' - The directory containing the texture files for your terrain
* '''Terrain output directory''' - The directory that will contain the converted terrain
* '''Merge with existing files''' - Turn this off as we are creating a brand new stage

Make sure to create a folder inside the <code>Packed</code> directory, named according to your stage.

For example:

* For Green Hill Act 2, use the folder name <code>ghz200</code>
* For Windmill Isle Act 1 (Day), use the folder name <code>ActD_MykonosAct1</code>

You can refer to the [[Sonic Generations Stage IDs]] or [[Sonic Unleashed Stage IDs]] pages to find the ID of the stage you are going to replace.

It's recommended to first set up a mod and create these folders within it. If you've set up the folder structure correctly and browsed to it, the '''Terrain output directory''' should show something like the following examples:

* Sonic Generations: <code>D:\Steam\steamapps\common\Sonic Generations\mods\MyStageMod\disk\bb\Packed\ghz200</code>
* Sonic Unleashed: <code>C:\Games\UnleashedRecomp\mods\MyStageMod\Packed\ActD_MykonosAct1</code>

Make sure to also turn on the following options under '''Materials''':

* Generate materials
* Copy and convert materials
* Force tags from Source 3D models' material names as submesh layer

In the end, you should have something similar to this:
[[File:Hedgehog Converter Example.png|center|thumb|625x625px]]
Next, click the '''Convert''' button and wait.
{{Notice|type=warn|content=You should normally disable the '''Merge existing files''' option when creating a brand-new stage. However, if you're appending more terrain to a stage you've already created, make sure to enable this option, otherwise, '''you may permanently lose any changes''' you've previously made to your level. '''This action is irreversible''', so proceed with caution!}}

== Part 3 (Getting Missing Files) ==
Once the conversion is complete, you may need to add files that are missing from your stage. These are stored in the <code>#</code> archive, located next to the <code>Packed</code> folder.

For example:

* For Green Hill Act 2, the archive will be named <code>#ghz200.ar.00</code>
* For Windmill Isle Act 1 (Day), the archive will be named <code>#ActD_MykonosAct1.ar.00</code>

The <code>#</code> archive contains important data such as set data, stage settings, collision information, and more. '''Your level will not function correctly without it.'''

=== Sonic Generations ===
When creating a brand-new stage in Sonic Generations, Hedgehog Converter '''does not''' generate the <code>#</code> archive. To get started quickly, you can copy this archive from the base game. For example, if you are replacing ''Green Hill Act 2'', you can copy the <code>#ghz200.ar.00</code> and <code>#ghz200.arl</code> files from the <code>disk/bb.cpk</code> file (extracted using [[PackCpk]]) to your mod directory.

=== Sonic Unleashed ===
When creating a brand-new stage in Sonic Unleashed, Hedgehog Converter '''will''' create the <code>#</code> archive. That's because unlike Sonic Generations, Sonic Unleashed expects terrain-related files to be stored here. However, you can't just copy the <code>#</code> archive files from the base game into your mod, doing that will override your custom level and break it. Instead, you'll need to merge the base game files into your mod's <code>#</code> archive. You can use [[HedgeArcPack]] to unpack/pack the .ar.00 files.

You need to copy the following file types from the base game's archive:

* .xml
* .hkx

You can '''NOT''' copy the following, or your custom level will break completely:

* .gil
* .gi-texture-group-info
* .light
* .light-list
* .terrain
* .terrain-group
* .tbst

== Part 4 (SonicGLvl Basic Setup) ==
Next up, we need to do some very basic setup of your level's set data in [[SonicGLvl]]. Open the app, and open your stage's <code>#</code> archive from there. Once the level has been imported into SonicGLvl, press Ctrl+A and then Delete. This will delete all the objects that are present in your level's set data, which are the original objects from the stage we are replacing. Now, find <code>"SonicSpawn"</code> in the objects menu on the left, and place it anywhere you want. This will be where Sonic will spawn in your level. Also, be sure to set the "Active" property to "true" in the settings of the <code>"SonicSpawn"</code> object.
[[File:SonicSpawn SonicGLvl.png|center|thumb]]
After that, go to '''File''' and press '''Save Stage Data'''.

== Part 5 (Creating Skybox - Optional but Recommended) ==
Skyboxes are just regular .model files. Though not mandatory for the game to boot, they are recommended so that your level at least has a sky for you to look at. You can take these from the original levels or create one yourself.

=== Making one yourself ===
Export your skybox model from Blender into an Assimp compatible file format. Then, using [[Model Converter]], drag and drop the model file onto the respective game's .bat file. This will generate the .model file, as well as material files. You will need to convert the textures of your skybox manually into the DDS format.

=== Grabbing one from a level ===

==== Sonic Generations ====
Go to the <code>Packed</code> folder in bb/bb2, and open the folder corresponding to the level you want the skybox from. Then, extract the <code>.ar</code> archive, and look for the sky's <code>.model</code> file. The name should have something to do with "sky". If you don't manage to find it, look at the stage's <code>Terrain.stg.xml</code> file, as it will mention the skybox's model name there. You will need the .model file, the textures (<code>.dds</code> files) and the materials of the sky model.

=== Using the Skybox files ===
After getting the necessary skybox model files, place them inside your stage's resources file:

* Sonic Generations: <code>Packed/stageID/stage.ar.00</code>
* Sonic Unleashed: <code>StageID.ar.00</code>

Then, open <code>#</code> file of your stage, and open the respective <code>.stg.xml</code> file:

* Sonic Generations: <code>Terrain.stg.xml</code>
* Sonic Unleashed: <code>Stage.stg.xml</code>

You'll need to create a <code>Sky</code> tag and write the name of the <code>.model</code> file of your skybox, without the extension. Below is an example of how you should write this. In this example, the skybox has a model file named <code>MySkybox.model</code>:<syntaxhighlight lang="xml">
<Sky>
<Model>MySkybox</Model>
<Sky>
</syntaxhighlight>If you boot your stage now, you'll notice that you will fall through the ground. This is because you only ported the terrain, and not the collision. To do this, follow the guide [[How To Import Custom Collision in Sonic Generations/Sonic Unleashed|here]].

Mario & Sonic at the Rio 2016 Olympic Games

2025-05-02T13:58:51Z

NextinHKRY: Created page with "== Guides == N/A == Documentation == N/A == Discoveries == N/A"

== Guides ==
N/A

== Documentation ==
N/A

== Discoveries ==
N/A

How To Import Custom Terrain in Sonic Generations/Sonic Unleashed

2025-05-02T13:58:10Z

NextinHKRY: Flow changes

{{Notice|type=info|content=This guide uses the following tools:
* [[SonicGLvl]]
* [[Hedgehog Converter]]
* [https://www.blender.org Blender]
* [[HedgeArcPack]]
* [[PackCpk]]
* [[Model Converter]]
You can use a different 3D software of your choice as long as you export to a format that Hedgehog Converter supports.}}

== Part 1 (Creating Terrain in Blender) ==
First of all, you need terrain for your level, you can create the terrain yourself or you can use pre-existing terrain. If your level contains transparent materials you will need to add a layer tag, pick the one that's best suited for your use case in order to avoid visual issues.
{| class="wikitable"
!Layers
!Usage
|-
|punch
|Used for materials which have binary transparency (one part is 100% opaque, another is 100% transparent). Useful for most kinds of textures, like leaves or grass
|-
|trans
|Used for translucent materials, as in, materials which are not 100% opaque but also not 100% transparent (ex. windows)
|}
In order to specify a layer for a material, use the <code>@LYR</code> prefix, with the layer name between parenthesis after it.
[[File:Transparent material example terrain import generations.png|center|thumb|357x357px|Example of a transparent material in Blender]]
You can then export your terrain from Blender into an Assimp compatible format (<code>fbx</code>, <code>dae</code>, <code>gltf</code> or <code>obj</code> work). When exporting it as <code>fbx</code>, make sure to set '''Apply Scalings''' to '''FBX Units Scale''', otherwise your level is going to appear 100x larger in-game.[[File:Blender FBX Units Scale.png|center|thumb|FBX Units Scale in FBX exporter window.]]

== Part 2 (Importing the Level to the Game) ==
Download [[Hedgehog Converter]] and run <code>bin/HedgehogConverter.exe</code>. Fill in the following fields:

* '''Game engine''' - The game you are converting for
* '''Source 3D model files''' - Your terrain model files
* '''Source textures directory''' - The directory containing the texture files for your terrain
* '''Terrain output directory''' - The directory that will contain the converted terrain
* '''Merge with existing files''' - Turn this off as we are creating a brand new stage

Make sure to create a folder inside the <code>Packed</code> directory, named according to your stage.

For example:

* For Green Hill Act 2, use the folder name <code>ghz200</code>
* For Windmill Isle Act 1 (Day), use the folder name <code>ActD_MykonosAct1</code>

You can refer to the [[Sonic Generations Stage IDs]] or [[Sonic Unleashed Stage IDs]] pages to find the ID of the stage you are going to replace.

It's recommended to first set up a mod and create these folders within it. If you've set up the folder structure correctly and browsed to it, the '''Terrain output directory''' should show something like the following examples:

* Sonic Generations: <code>D:\Steam\steamapps\common\Sonic Generations\mods\MyStageMod\disk\bb\Packed\ghz200</code>
* Sonic Unleashed: <code>C:\Games\UnleashedRecomp\mods\MyStageMod\Packed\ActD_MykonosAct1</code>

Make sure to also turn on the following options under '''Materials''':

* Generate materials
* Copy and convert materials
* Force tags from Source 3D models' material names as submesh layer

In the end, you should have something similar to this:
[[File:Hedgehog Converter Example.png|center|thumb|625x625px]]
Next, click the '''Convert''' button and wait.
{{Notice|type=warn|content=You should normally disable the '''Merge existing files''' option when creating a brand-new stage. However, if you're appending more terrain to a stage you've already created, make sure to enable this option, otherwise, '''you may permanently lose any changes''' you've previously made to your level. '''This action is irreversible''', so proceed with caution!}}

== Part 3 (Getting Missing Files) ==
Once the conversion is complete, you may need to add files that are missing from your stage. These are stored in the <code>#</code> archive, located next to the <code>Packed</code> folder.

For example:

* For Green Hill Act 2, the archive will be named <code>#ghz200.ar.00</code>
* For Windmill Isle Act 1 (Day), the archive will be named <code>#ActD_MykonosAct1.ar.00</code>

The <code>#</code> archive contains important data such as set data, stage settings, collision information, and more. '''Your level will not function correctly without it.'''

=== Sonic Generations ===
When creating a brand-new stage in Sonic Generations, Hedgehog Converter '''does not''' generate the <code>#</code> archive. To get started quickly, you can copy this archive from the base game. For example, if you are replacing ''Green Hill Act 2'', you can copy the <code>#ghz200.ar.00</code> and <code>#ghz200.arl</code> files from the <code>disk/bb.cpk</code> file (extracted using [[PackCpk]]) to your mod directory.

=== Sonic Unleashed ===
When creating a brand-new stage in Sonic Unleashed, Hedgehog Converter '''will''' create the <code>#</code> archive. That's because unlike Sonic Generations, Sonic Unleashed expects terrain-related files to be stored here. However, you can't just copy the <code>#</code> archive files from the base game into your mod, doing that will override your custom level and break it. Instead, you'll need to merge the base game files into your mod's <code>#</code> archive. You can use [[HedgeArcPack]] to unpack/pack the .ar.00 files.

You need to copy the following file types from the base game's archive:

* .xml
* .hkx

You can '''NOT''' copy the following, or your custom level will break completely:

* .gil
* .gi-texture-group-info
* .light
* .light-list
* .terrain
* .terrain-group
* .tbst

== Part 4 (SonicGLvl Basic Setup) ==
Next up, we need to do some very basic setup of your level's set data in [[SonicGLvl]]. Open the app, and open your stage's <code>#</code> archive from there. Once the level has been imported into SonicGLvl, press Ctrl+A and then Delete. This will delete all the objects that are present in your level's set data, which are the original objects from the stage we are replacing. Now, find <code>"SonicSpawn"</code> in the objects menu on the left, and place it anywhere you want. This will be where Sonic will spawn in your level. Also, be sure to set the "Active" property to "true" in the settings of the <code>"SonicSpawn"</code> object.
[[File:SonicSpawn SonicGLvl.png|center|thumb]]
After that, go to '''File''' and press '''Save Stage Data'''.

== Part 5 (Creating Skybox - Optional but Recommended) ==
Skyboxes are just regular .model files. Though not mandatory for the game to boot, they are recommended so that your level at least has a sky for you to look at. You can take these from the original levels or create one yourself.

=== Making one yourself ===
Export your skybox model from Blender into an Assimp compatible file format. Then, using [[Model Converter]], drag and drop the model file onto the respective game's .bat file. This will generate the .model file, as well as material files. You will need to convert the textures of your skybox manually into the DDS format.

=== Grabbing one from a level ===

==== Sonic Generations ====
Go to the <code>Packed</code> folder in bb/bb2, and open the folder corresponding to the level you want the skybox from. Then, extract the <code>.ar</code> archive, and look for the sky's <code>.model</code> file. The name should have something to do with "sky". If you don't manage to find it, look at the stage's <code>Terrain.stg.xml</code> file, as it will mention the skybox's model name there. You will need the .model file, the textures (<code>.dds</code> files) and the materials of the sky model.

=== Using the Skybox files ===
After getting the necessary skybox model files, place them inside your stage's resources file:

* Sonic Generations: <code>Packed/stageID/stage.ar.00</code>
* Sonic Unleashed: <code>StageID.ar.00</code>

Then, open <code>#</code> file of your stage, and open the respective <code>.stg.xml</code> file:

* Sonic Generations: <code>Terrain.stg.xml</code>
* Sonic Unleashed: <code>Stage.stg.xml</code>

You'll need to create a <code>Sky</code> tag and write the name of the <code>.model</code> file of your skybox, without the extension. Below is an example of how you should write this. In this example, the skybox has a model file named <code>MySkybox.model</code>:<syntaxhighlight lang="xml">
<Sky>
<Model>MySkybox</Model>
<Sky>
</syntaxhighlight>If you boot your stage now, you'll notice that you will fall through the ground. This is because you only ported the terrain, and not the collision. To do this, follow the guide [[How To Import Custom Collision in Sonic Generations/Sonic Unleashed|here]].

How To Import Custom Collision in Sonic Generations/Sonic Unleashed

2025-05-02T13:51:09Z

NextinHKRY:

{{Notice|type=info|content=This guide uses the following tools:

* [[Havok Converter]]
* [https://www.blender.org Blender]
* [[HedgeArcPack]]
* [[SonicGLvl]]}}

== Part 1 (Creating Collision in Blender) ==
You'll need a separate model for the collision, while it is possible to use your stage's model files as collision, we still recommend that you create a separate project or model for it. You can specify tags for your collision in Blender, these tags change the properties of the collision mesh in the game. You'll need a special '''ini''' file for [[Havok Converter]] to change these tags, which you can download [https://gist.github.com/TheExentist151/8e4896b807d49cd86ff2b643d34c7aa2 here]. To apply these tags to your collision model, you have to rename the individual meshes and add a '''@''' followed by the tag name, below is an example of how you can do this in case you want a mesh to have the "Stone" collision tag.[[File:Collision tag example blender.png|center|thumb|385x385px|Example of a collision tag in Blender]]
You can find all the available tags by opening [[Havok Converter]] after placing the mentioned '''ini''' file in the same folder as the executable. If you want to use the tags for Sonic Unleashed, you'll have to rename the '''ini''' file to <code>HavokConverter_Unleashed.ini</code>.

== Part 2 (Converting Your Model Into a Collision File) ==
Open <code>HavokConverter.exe</code> (or <code>HavokConverter_Unleashed.exe</code> if you are converting for Sonic Unleashed), and fill in the following options:

* '''Source 3D model files''' - Your collision model files
* '''Output file''' - Directory which will contain the converted collision (add <code>.phy.hkx</code> in the end of the name)

[[File:Havok converter window.png|center|thumb|730x730px]]
Now you can click the '''Convert''' button and wait.

== Part 3 (Importing Your Collision into the Game) ==
When the conversion process finishes, extract your custom stage's <code>#</code> file, and place the generated <code>.phy.hkx</code> file there. Afterwards, open the respective <code>.stg.xml</code> file:

* Sonic Generations: <code>Terrain.stg.xml</code>

* Sonic Unleashed: <code>Stage.stg.xml</code>

You need to edit the collision file information. This is mentioned in the <code>RigidBodyContainer</code> tag. Change its value to your <code>.phy.hkx</code> filename, without the extension. Below is an example for a file name <code>MyCollision.phy.hkx</code>:<syntaxhighlight lang="xml"><Terrain>
<RigidBodyContainer>MyCollision</RigidBodyContainer>
<IsCollisionRender>false</IsCollisionRender>
</Terrain></syntaxhighlight>Now re-pack this file and replace the original. After booting into the game, you should now notice that your level has working collision. If this is not the case, you can open your level in [[SonicGLvl]] and enable the collision mesh through the '''View''' menu to see how it got converted'''.'''
{{Notice|type=warn|content=While repacking the <code>#</code> archive carries no risks in Sonic Generations, it's very easy to accidentally pack outdated terrain info files in Sonic Unleashed. This can happen if you convert your stage using [[Hedgehog Converter]] but forget to unpack the updated <code>#</code> archive back into your already-extracted folder. As a result, outdated files can overwrite Hedgehog Converter's output, potentially breaking your level.

To avoid this, it's highly recommended that you modify the <code>#</code> archive by opening the level in [[SonicGLvl]], editing the <code>data</code> folder inside SonicGLvl's cache, and saving your changes using '''Save Stage Data'''.}}

How To Import Custom Collision in Sonic Generations/Sonic Unleashed

2025-05-02T13:50:52Z

NextinHKRY:

{{Notice|type=info|content=This guide uses the following tools:

* [[Havok Converter]]
* [https://www.blender.org Blender]
* [[HedgeArcPack]]
* [[SonicGLvl]]}}

== Part 1 (Creating Collision in Blender) ==
You'll need a separate model for the collision, while it is possible to use your stage's model files as collision, we still recommend that you create a separate project or model for it. You can specify tags for your collision in Blender, these tags change the properties of the collision mesh in the game. You'll need a special '''ini''' file for [[Havok Converter]] to change these tags, which you can download [https://gist.github.com/TheExentist151/8e4896b807d49cd86ff2b643d34c7aa2 here]. To apply these tags to your collision model, you have to rename the individual meshes and add a '''@''' followed by the tag name. Below is an example of how you can do this, in case you want a mesh to have the "Stone" collision tag.[[File:Collision tag example blender.png|center|thumb|385x385px|Example of a collision tag in Blender]]
You can find all the available tags by opening [[Havok Converter]] after placing the mentioned '''ini''' file in the same folder as the executable. If you want to use the tags for Sonic Unleashed, you'll have to rename the '''ini''' file to <code>HavokConverter_Unleashed.ini</code>.

== Part 2 (Converting Your Model Into a Collision File) ==
Open <code>HavokConverter.exe</code> (or <code>HavokConverter_Unleashed.exe</code> if you are converting for Sonic Unleashed), and fill in the following options:

* '''Source 3D model files''' - Your collision model files
* '''Output file''' - Directory which will contain the converted collision (add <code>.phy.hkx</code> in the end of the name)

[[File:Havok converter window.png|center|thumb|730x730px]]
Now you can click the '''Convert''' button and wait.

== Part 3 (Importing Your Collision into the Game) ==
When the conversion process finishes, extract your custom stage's <code>#</code> file, and place the generated <code>.phy.hkx</code> file there. Afterwards, open the respective <code>.stg.xml</code> file:

* Sonic Generations: <code>Terrain.stg.xml</code>

* Sonic Unleashed: <code>Stage.stg.xml</code>

You need to edit the collision file information. This is mentioned in the <code>RigidBodyContainer</code> tag. Change its value to your <code>.phy.hkx</code> filename, without the extension. Below is an example for a file name <code>MyCollision.phy.hkx</code>:<syntaxhighlight lang="xml"><Terrain>
<RigidBodyContainer>MyCollision</RigidBodyContainer>
<IsCollisionRender>false</IsCollisionRender>
</Terrain></syntaxhighlight>Now re-pack this file and replace the original. After booting into the game, you should now notice that your level has working collision. If this is not the case, you can open your level in [[SonicGLvl]] and enable the collision mesh through the '''View''' menu to see how it got converted'''.'''
{{Notice|type=warn|content=While repacking the <code>#</code> archive carries no risks in Sonic Generations, it's very easy to accidentally pack outdated terrain info files in Sonic Unleashed. This can happen if you convert your stage using [[Hedgehog Converter]] but forget to unpack the updated <code>#</code> archive back into your already-extracted folder. As a result, outdated files can overwrite Hedgehog Converter's output, potentially breaking your level.

To avoid this, it's highly recommended that you modify the <code>#</code> archive by opening the level in [[SonicGLvl]], editing the <code>data</code> folder inside SonicGLvl's cache, and saving your changes using '''Save Stage Data'''.}}

How To Import Custom Collision in Sonic Generations/Sonic Unleashed

2025-05-02T13:49:24Z

NextinHKRY: Wording changes

{{Notice|type=info|content=This guide uses the following tools:

* [[Havok Converter]]
* [https://www.blender.org Blender]
* [[HedgeArcPack]]
* [[SonicGLvl]]}}

== Part 1 (Creating Collision in Blender) ==
You'll need a separate model for the collision, while it is possible to use your stage's model files as collision, we still recommend that you create a separate project or model for it. You can specify tags for your collision from Blender, these tags change the properties of the collision mesh in the game. You'll need a special '''ini''' file for [[Havok Converter]] to change these tags, which you can download [https://gist.github.com/TheExentist151/8e4896b807d49cd86ff2b643d34c7aa2 here]. To apply these tags to your collision model, you have to rename the individual meshes and add a '''@''' followed by the tag name. Below is an example of how you can do this, in case you want a mesh to have the "Stone" collision tag.[[File:Collision tag example blender.png|center|thumb|385x385px|Example of a collision tag in Blender]]
You can find all the available tags by opening [[Havok Converter]] after placing the mentioned '''ini''' file in the same folder as the executable. If you want to use the tags for Sonic Unleashed, you'll have to rename the '''ini''' file to <code>HavokConverter_Unleashed.ini</code>.

== Part 2 (Converting Your Model Into a Collision File) ==
Open <code>HavokConverter.exe</code> (or <code>HavokConverter_Unleashed.exe</code> if you are converting for Sonic Unleashed), and fill in the following options:

* '''Source 3D model files''' - Your collision model files
* '''Output file''' - Directory which will contain the converted collision (add <code>.phy.hkx</code> in the end of the name)

[[File:Havok converter window.png|center|thumb|730x730px]]
Now you can click the '''Convert''' button and wait.

== Part 3 (Importing Your Collision into the Game) ==
When the conversion process finishes, extract your custom stage's <code>#</code> file, and place the generated <code>.phy.hkx</code> file there. Afterwards, open the respective <code>.stg.xml</code> file:

* Sonic Generations: <code>Terrain.stg.xml</code>

* Sonic Unleashed: <code>Stage.stg.xml</code>

You need to edit the collision file information. This is mentioned in the <code>RigidBodyContainer</code> tag. Change its value to your <code>.phy.hkx</code> filename, without the extension. Below is an example for a file name <code>MyCollision.phy.hkx</code>:<syntaxhighlight lang="xml"><Terrain>
<RigidBodyContainer>MyCollision</RigidBodyContainer>
<IsCollisionRender>false</IsCollisionRender>
</Terrain></syntaxhighlight>Now re-pack this file and replace the original. After booting into the game, you should now notice that your level has working collision. If this is not the case, you can open your level in [[SonicGLvl]] and enable the collision mesh through the '''View''' menu to see how it got converted'''.'''
{{Notice|type=warn|content=While repacking the <code>#</code> archive carries no risks in Sonic Generations, it's very easy to accidentally pack outdated terrain info files in Sonic Unleashed. This can happen if you convert your stage using [[Hedgehog Converter]] but forget to unpack the updated <code>#</code> archive back into your already-extracted folder. As a result, outdated files can overwrite Hedgehog Converter's output, potentially breaking your level.

To avoid this, it's highly recommended that you modify the <code>#</code> archive by opening the level in [[SonicGLvl]], editing the <code>data</code> folder inside SonicGLvl's cache, and saving your changes using '''Save Stage Data'''.}}

How To Import Custom Terrain in Sonic Generations/Sonic Unleashed

2025-05-02T13:40:26Z

NextinHKRY: Slight formatting changes

{{Notice|type=info|content=This guide uses the following tools:
* [[SonicGLvl]]
* [[Hedgehog Converter]]
* [https://www.blender.org Blender]
* [[HedgeArcPack]]
* [[PackCpk]]
* [[Model Converter]]
You can use a different 3D software of your choice as long as you export to a format that Hedgehog Converter supports.}}

== Part 1 (Creating Terrain in Blender) ==
First of all, you need terrain for your level. You can do the terrain yourself, or take already created terrain. If your level contains transparent materials you need to add a proper layer tag to it. For transparency, you have two available layers, and you should pick the one that's best suited for your use case in order to avoid issues.
{| class="wikitable"
!Layers
!Usage
|-
|punch
|Used for materials which have binary transparency (one part is 100% opaque, another is 100% transparent). Useful for most kinds of textures, like leaves or grass
|-
|trans
|Used for translucent materials, as in, materials which are not 100% opaque but also not 100% transparent (ex. windows)
|}
In order to specify a layer for a material, use the <code>@LYR</code> prefix, with the layer name between parenthesis after it.
[[File:Transparent material example terrain import generations.png|center|thumb|357x357px|Example of a transparent material in Blender]]
You can then export your terrain from Blender into an Assimp compatible format (FBX, DAE, GLTF or OBJ work). When exporting FBX, make sure to set '''Apply Scalings''' to '''FBX Units Scale''', otherwise your level is going to appear 100x larger in-game.[[File:Blender FBX Units Scale.png|center|thumb|FBX Units Scale in FBX exporter window.]]

== Part 2 (Importing the Level to the Game) ==
Download [[Hedgehog Converter]] and run <code>bin/HedgehogConverter.exe</code>. Fill in the following fields:

* '''Game engine''' - The game you are converting for
* '''Source 3D model files''' - Your terrain model files
* '''Source textures directory''' - The directory containing the texture files for your terrain
* '''Terrain output directory''' - The directory that will contain the converted terrain
* '''Merge with existing files''' - Turn this off as we are creating a brand new stage

Make sure to create a folder inside the <code>Packed</code> directory, named according to your stage.

For example:

* For Green Hill Act 2, use the folder name <code>ghz200</code>
* For Windmill Isle Act 1 (Day), use the folder name <code>ActD_MykonosAct1</code>

You can refer to the [[Sonic Generations Stage IDs]] or [[Sonic Unleashed Stage IDs]] pages to find the ID of the stage you are going to replace.

It's recommended to first set up a mod and create these folders within it. If you've set up the folder structure correctly and browsed to it, the '''Terrain output directory''' should show something like the following examples:

* Sonic Generations: <code>D:\Steam\steamapps\common\Sonic Generations\mods\MyStageMod\disk\bb\Packed\ghz200</code>
* Sonic Unleashed: <code>C:\Games\UnleashedRecomp\mods\MyStageMod\Packed\ActD_MykonosAct1</code>

Make sure to also turn on the following options under '''Materials''':

* Generate materials
* Copy and convert materials
* Force tags from Source 3D models' material names as submesh layer

In the end, you should have something similar to this:
[[File:Hedgehog Converter Example.png|center|thumb|625x625px]]
Next, click the '''Convert''' button and wait.
{{Notice|type=warn|content=You should normally disable the '''Merge existing files''' option when creating a brand-new stage. However, if you're appending more terrain to a stage you've already created, make sure to enable this option, otherwise, '''you may permanently lose any changes''' you've previously made to your level. '''This action is irreversible''', so proceed with caution!}}

== Part 3 (Getting Missing Files) ==
Once the conversion is complete, you may need to add files that are missing from your stage. These are stored in the <code>#</code> archive, located next to the <code>Packed</code> folder.

For example:

* For Green Hill Act 2, the archive will be named <code>#ghz200.ar.00</code>
* For Windmill Isle Act 1 (Day), the archive will be named <code>#ActD_MykonosAct1.ar.00</code>

The <code>#</code> archive contains important data such as set data, stage settings, collision information, and more. '''Your level will not function correctly without it.'''

=== Sonic Generations ===
When creating a brand-new stage in Sonic Generations, Hedgehog Converter '''does not''' generate the <code>#</code> archive. To get started quickly, you can copy this archive from the base game. For example, if you are replacing ''Green Hill Act 2'', you can copy the <code>#ghz200.ar.00</code> and <code>#ghz200.arl</code> files from the <code>disk/bb.cpk</code> file (extracted using [[PackCpk]]) to your mod directory.

=== Sonic Unleashed ===
When creating a brand-new stage in Sonic Unleashed, Hedgehog Converter '''will''' create the <code>#</code> archive. That's because unlike Sonic Generations, Sonic Unleashed expects terrain-related files to be stored here. However, you can't just copy the <code>#</code> archive files from the base game into your mod, doing that will override your custom level and break it. Instead, you'll need to merge the base game files into your mod's <code>#</code> archive. You can use [[HedgeArcPack]] to unpack/pack the .ar.00 files.

You can copy these file types from the base game's archive:

* .xml
* .hkx

You can '''NOT''' copy the following, or your custom level will break completely:

* .gil
* .gi-texture-group-info
* .light
* .light-list
* .terrain
* .terrain-group
* .tbst

== Part 4 (SonicGLvl Basic Setup) ==
Next up, we need to do some very basic setup of your level's set data in [[SonicGLvl]]. Open the app, and open your stage's <code>#</code> archive from there. Once the level has been imported into SonicGLvl, press Ctrl+A and then Delete. This will delete all the objects that are present in your level's set data, which are the original objects from the stage we are replacing. Now, find <code>"SonicSpawn"</code> in the objects menu on the left, and place it anywhere you want. This will be where Sonic will spawn in your level. Also, be sure to set the "Active" property to "true" in the settings of the <code>"SonicSpawn"</code> object.
[[File:SonicSpawn SonicGLvl.png|center|thumb]]
After that, go to '''File''' and press '''Save Stage Data'''.

== Part 5 (Creating Skybox - Optional but Recommended) ==
Skyboxes are just regular .model files. Though not mandatory for the game to boot, they are recommended so that your level at least has a sky for you to look at. You can take these from the original levels or create one yourself.

=== Making one yourself ===
Export your skybox model from Blender into an Assimp compatible file format. Then, using [[Model Converter]], drag and drop the model file onto the respective game's .bat file. This will generate the .model file, as well as material files. You will need to convert the textures of your skybox manually into the DDS format.

=== Grabbing one from a level ===

==== Sonic Generations ====
Go to the <code>Packed</code> folder in bb/bb2, and open the folder corresponding to the level you want the skybox from. Then, extract the <code>.ar</code> archive, and look for the sky's <code>.model</code> file. The name should have something to do with "sky". If you don't manage to find it, look at the stage's <code>Terrain.stg.xml</code> file, as it will mention the skybox's model name there. You will need the .model file, the textures (<code>.dds</code> files) and the materials of the sky model.

=== Using the Skybox files ===
After getting the necessary skybox model files, place them inside your stage's resources file:

* Sonic Generations: <code>Packed/stageID/stage.ar.00</code>
* Sonic Unleashed: <code>StageID.ar.00</code>

Then, open <code>#</code> file of your stage, and open the respective <code>.stg.xml</code> file:

* Sonic Generations: <code>Terrain.stg.xml</code>
* Sonic Unleashed: <code>Stage.stg.xml</code>

You'll need to create a <code>Sky</code> tag and write the name of the <code>.model</code> file of your skybox, without the extension. Below is an example of how you should write this. In this example, the skybox has a model file named <code>MySkybox.model</code>:<syntaxhighlight lang="xml">
<Sky>
<Model>MySkybox</Model>
<Sky>
</syntaxhighlight>If you boot your stage now, you'll notice that you will fall through the ground. This is because you only ported the terrain, and not the collision. To do this, follow the guide [[How To Import Custom Collision in Sonic Generations/Sonic Unleashed|here]].

How To Use Sonic GLvl with Sonic Unleashed

2025-05-02T13:33:03Z

NextinHKRY: Formatting consistency changes

{{Notice|type=note|content=This guide covers how to setup Sonic Unleashed Xbox 360 levels in GLvl, but does not cover how to use this tool or how to set it up for PS3 levels. It's recommended that you also read the [[How To Use Sonic GLvl with Sonic Generations|Sonic Generations GLvl guide]].}}{{Notice|type=info|content=This guide uses the following tools:
* [[SonicGLvl|SonicGLvl]]}}

The latest [[SonicGLvl]] can now open Sonic Unleashed levels without needing to decompress any archive or move around files. Open a level through '''"File > Open Level"''' and select the # archive of a level of your choice. Refer to the [[Sonic Unleashed Stage IDs|Stage IDs]] page to find the level that you need.

== Setting Up Shaders ==
To display the level with game-accurate graphics, you need to copy the '''"shader.ar"''' file from your game installation to SonicGLvl's '''"database/shaders"''' folder. SonicGLvl will warn you about this if you have not done this step.

== Copying Files To Your Mod ==
If you open a level directly from the game files, you have the risk of corrupting your installation when you save your changes. It's recommended to first copy the files to a mod, and open the level from your mod directory. As an example, the files you need to copy for Windmill Isle Act 2 (Day) are as follows:

* <code>Packed/ActD_MykonosAct2/Stage.pfd</code>
* <code>#ActD_MykonosAct2.ar.00</code>
* <code>#ActD_MykonosAct2.arl</code>
* <code>ActD_MykonosAct2.ar.00</code>
* <code>ActD_MykonosAct2.arl</code>

The stage ID and the amount of AR files you need to copy will vary between levels.

== Missing Textures ==
Sonic Unleashed stores stage textures in different archives to share them between levels and save space. If you open a level from your game directory, SonicGLvl will automatically extract them to its '''"cache/country_name/slot_resources"''' folder.

However, if you open the level from a DLC or your mod files, and not copy over these archives, SonicGLvl won't be able to find the textures. To solve this, you can first open a level from the respective country region from the base game folder, then re-open the level from your DLC or mod directory.

As an example, for Apotos, the common texture archives are named as follows:

* <code>CmnActD_Terrain_Mykonos</code>
* <code>CmnActN_Terrain_Mykonos</code>
* <code>CmnMykonos</code>

== Missing Models ==
SonicGLvl does not come with the game assets, so objects are going to appear as cubes. To solve this, you need to extract the relevant AR files to SonicGLvl's "database/resources" folder. Most required assets are stored in <code>SonicActionCommon/EvilActionCommon</code> archives in the base game.

If you are unable to find the model for an object, you can open the corresponding object template from "database/objects" folder, and look for an Extra parameter with model as the type:<syntaxhighlight lang="xml"><Extra type="model" name="cmn_obj_sk2_hintring.model" /></syntaxhighlight>In this example, the HintRing object uses the <code>cmn_obj_sk2_hintring.model</code> file. You can then search for this file name in the [https://raw.githubusercontent.com/blueskythlikesclouds/SkythTools/refs/heads/master/Sonic%20Unleashed/File%20Index.txt Sonic Unleashed File Index] to find the archive it's stored in, and extract it.
{{Notice|type=warn|content=If you extract SonicActionCommon_Petra, a material file with invalid characters in its file name is going to crash SonicGLvl! Make sure to remove the faulty file to make it work: ptr_sk_dart01__NSP_CMN_ChaoTexSpecNrmTanVC____NPR_XB_��__.material}}{{Notice|type=warn|content=Some Sonic Unleashed object templates are currently incorrectly configured to load Sonic Generations model names. If you have the 2011 version of Sonic Generations installed, you can extract cmn100/cmn200 to the resources folder as a temporary workaround.}}

How To Use Sonic GLvl with Sonic Unleashed

2025-05-02T13:30:05Z

NextinHKRY: Slight wording changes

{{Notice|type=note|content=This guide covers how to setup Sonic Unleashed Xbox 360 levels in GLvl, but does not cover how to use this tool or how to set it up for PS3 levels. It's recommended that you also read the [[How To Use Sonic GLvl with Sonic Generations|Sonic Generations GLvl guide]].}}{{Notice|type=info|content=This guide uses the following tools:
* [[SonicGLvl|SonicGLvl]]}}

The latest [[SonicGLvl]] can now open Sonic Unleashed levels without needing to decompress any archive or move around files. Open a level through '''"File > Open Level"''' and select the # archive of a level of your choice. Refer to the [[Sonic Unleashed Stage IDs|Stage IDs]] page to find the level that you need.

== Setting Up Shaders ==
To display the level with game-accurate graphics, you need to copy the "shader.ar" file from your game installation to SonicGLvl's "database/shaders" folder. SonicGLvl will warn you about this if you have not done this step.

== Copying Files To Your Mod ==
If you open a level directly from the game files, you have the risk of corrupting your installation when you save your changes. It's recommended to first copy the files to a mod, and open the level from your mod directory. As an example, the files you need to copy for Windmill Isle Act 2 (Day) are as follows:

* Packed/ActD_MykonosAct2/Stage.pfd
* #ActD_MykonosAct2.ar.00
* #ActD_MykonosAct2.arl
* ActD_MykonosAct2.ar.00
* ActD_MykonosAct2.arl

The stage ID and the amount of AR files you need to copy will vary between levels.

== Missing Textures ==
Sonic Unleashed stores stage textures in different archives to share them between levels and save space. If you open a level from your game directory, SonicGLvl will automatically extract them to its "cache/country_name/slot_resources" folder.

However, if you open the level from a DLC or your mod files, and not copy over these archives, SonicGLvl won't be able to find the textures. To solve this, you can first open a level from the respective country region from the base game folder, then re-open the level from your DLC or mod directory.

As an example, for Apotos, the common texture archives are named as follows:

* CmnActD_Terrain_Mykonos
* CmnActN_Terrain_Mykonos
* CmnMykonos

== Missing Models ==
SonicGLvl does not come with the game assets, so objects are going to appear as cubes. To solve this, you need to extract the relevant AR files to SonicGLvl's "database/resources" folder. Most required assets are stored in SonicActionCommon/EvilActionCommon archives in the base game.

If you are unable to find the model for an object, you can open the corresponding object template from "database/objects" folder, and look for an Extra parameter with model as the type:<syntaxhighlight lang="xml"><Extra type="model" name="cmn_obj_sk2_hintring.model" /></syntaxhighlight>In this example, the HintRing object uses the <code>cmn_obj_sk2_hintring.model</code> file. You can then search for this file name in the [https://raw.githubusercontent.com/blueskythlikesclouds/SkythTools/refs/heads/master/Sonic%20Unleashed/File%20Index.txt Sonic Unleashed File Index] to find the archive it's stored in, and extract it.
{{Notice|type=warn|content=If you extract SonicActionCommon_Petra, a material file with invalid characters in its file name is going to crash SonicGLvl! Make sure to remove the faulty file to make it work: ptr_sk_dart01__NSP_CMN_ChaoTexSpecNrmTanVC____NPR_XB_��__.material}}{{Notice|type=warn|content=Some Sonic Unleashed object templates are currently incorrectly configured to load Sonic Generations model names. If you have the 2011 version of Sonic Generations installed, you can extract cmn100/cmn200 to the resources folder as a temporary workaround.}}

Ar0pack-ar0unpack

2025-04-30T14:39:39Z

NextinHKRY:

{{Notice|type=warn|content=This tool cannot extract Xbox compressed archives. For such archives, please use the latest version of [[HedgeArcPack]] instead.}}{{ToolInfobox|title=ar0pack|author=Skyth|website=https://github.com/blueskythlikesclouds/SkythTools|download=https://github.com/blueskythlikesclouds/SkythTools/blob/master/Sonic%20Generations/ar0pack.exe}}
{{ToolInfobox|title=ar0unpack|author=Skyth|website=https://github.com/blueskythlikesclouds/SkythTools|download=https://github.com/blueskythlikesclouds/SkythTools/blob/master/Sonic%20Generations/ar0unpack.exe}}
'''ar0pack''' and '''ar0unpack''' are SkythTools tools designed to pack and extract <code>.ar</code> files from Sonic Unleashed and Sonic Generations. To use them, drag a file ending with <code>.ar</code>, <code>.ar.00</code>, or <code>.pfd</code>. Please note however that ar0pack cannot repack .pfd files. For that, use [[pfdpack]] or [[pfdpackUnleashed]].

Sonic Unleashed Stage IDs

2025-04-16T19:47:41Z

NextinHKRY: Fixed mistake with geometry id in act 2-2 of holoska

This page contains a list of all the Stage IDs<ref>Credits to archxe and Hedgeturd for making a list of all the stage IDs!</ref> used in Sonic Unleashed. Stages don't follow a strict format, but they're generally like this:<syntaxhighlight lang="text">Act{Day/Night}_{country}</syntaxhighlight>
{{Notice|type=note|content=The tables are divided into 4 columns, the "Stage" is the name of the stage, the "ID" is the name of the #archive, and the "Geometry ID" is the archive the stage uses for the actual terrain, if it is blank then it means that the terrain archive it uses has the same name as the ID.}}
== Daytime ==

=== Apotos ===
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|Windmill Isle Act 1
|ActD_MykonosAct1
|
|
|-
|Windmill Isle Act 1-2
|ActD_SubMykonos_04
|X
|ActD_MykonosAct1
|-
|Windmill Isle Act 2
|ActD_MykonosAct2
|
|
|-
|Windmill Isle Act 2-2
|ActD_SubMykonos_05
|X
|ActD_MykonosAct2
|-
|Windmill Isle Act 3
|ActD_SubMykonos_01
|
|
|-
|Windmill Isle Act 4
|ActD_SubMykonos_02
|X
|
|-
|Town
|Town_Mykonos
|
|
|-
|Entrance Stage
|Town_MykonosETF
|
|
|}

=== Mazuri ===
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|Savannah Citadel Act 1
|ActD_Africa
|
|
|-
|Savannah Citadel Act 1-2
|ActD_SubAfrica_05
|X
|ActD_Africa
|-
|Savannah Citadel Act 2
|ActD_SubAfrica_01
|
|
|-
|Savannah Citadel Act 3
|ActD_SubAfrica_03
|
|
|-
|Savannah Citadel Act 3-2
|ActD_SubAfrica_06
|X
|ActD_SubAfrica_03
|-
|Savannah Citadel Act 4
|ActD_SubAfrica_02
|X
|
|-
|Savannah Citadel Act 5
|ActD_SubAfrica_04
|X
|BossEggBeetle
|-
|Egg Beetle
|BossEggBeetle
|
|
|-
|Town
|Town_Africa
|
|
|-
|Entrance Stage
|Town_AfricaETF
|
|
|}

=== Spagonia ===
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|Rooftop Run Act 1
|ActD_EU
|
|
|-
|Rooftop Run Act 1-2
|ActD_SubEU_05
|X
|ActD_EU
|-
|Rooftop Run Act 2
|ActD_SubEU_01
|
|
|-
|Rooftop Run Act 2-2
|ActD_SubEU_06
|X
|ActD_SubEU_01
|-
|Rooftop Run Act 3
|ActD_SubEU_02
|
|
|-
|Rooftop Run Act 4
|ActD_SubEU_03
|X
|
|-
|Rooftop Run Act 5
|ActD_SubEU_04
|X
|
|-
|Egg Devil Ray
|BossEggRayBird
|
|
|-
|Tornado Defence Act 1
|ExStageTails1
|
|
|-
|Town
|Town_EuropeanCity
|
|
|-
|Entrance Stage
|Town_EuropeanCityETF
|
|
|-
|Professor Pickle’s Lab
|Town_EULabo
|
|
|}

=== Chun-Nan ===
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|Dragon Road Act 1
|ActD_China
|
|
|-
|Dragon Road Act 1-2
|ActD_SubChina_05
|X
|ActD_China
|-
|Dragon Road Act 2
|ActD_SubChina_03
|
|
|-
|Dragon Road Act 2-2
|ActD_SubChina_06
|X
|ActD_SubChina_03
|-
|Dragon Road Act 3
|ActD_SubChina_04
|
|
|-
|Dragon Road Act 4
|ActD_SubChina_01
|X
|
|-
|Dragon Road Act 5
|ActD_SubChina_02
|X
|
|-
|Town
|Town_China
|
|
|-
|Entrance Stage
|Town_ChinaETF
|
|
|}

=== Holoska ===
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|Cool Edge Act 1
|ActD_Snow
|
|
|-
|Cool Edge Act 1-2
|ActD_SubSnow_04
|X
|ActD_Snow
|-
|Cool Edge Act 2
|ActD_SubSnow_01
|
|
|-
|Cool Edge Act 2-2
|ActD_SubSnow_05
|X
|ActD_SubSnow_01
|-
|Cool Edge Act 3
|ActD_SubSnow_02
|X
|
|-
|Cool Edge Act 4
|ActD_SubSnow_03
|X
|
|-
|Town
|Town_Snow
|
|
|-
|Entrance Stage
|Town_SnowETF
|
|
|}

=== Shamar ===
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|Arid Sands Act 1
|ActD_Petra
|
|
|-
|Arid Sands Act 1-2
|ActD_SubPetra_04
|X
|ActD_Petra
|-
|Arid Sands Act 2
|ActD_SubPetra_03
|
|
|-
|Arid Sands Act 3
|ActD_SubPetra_02
|X
|
|-
|Town
|Town_PetraCapital
|
|
|-
|Entrance Stage
|Town_PetraCapitalETF
|
|
|-
|Professor Pickle’s Lab
|Town_PetraLabo
|
|
|}

=== Empire City ===
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|Skyscraper Scamper Act 1
|ActD_NY
|
|
|-
|Skyscraper Scamper Act 1-2
|ActD_SubNY_03
|X
|ActD_NY
|-
|Skyscraper Scamper Act 2
|ActD_SubNY_01
|
|
|-
|Skyscraper Scamper Act 3
|ActD_SubNY_02
|X
|
|-
|Town
|Town_NYCity
|
|
|-
|Entrance Stage
|Town_NYCityETF
|
|
|}

=== Adabat ===
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|Jungle Joyride Act 1
|ActD_Beach
|
|
|-
|Jungle Joyride Act 1-2
|ActD_SubBeach_05
|X
|ActD_Beach
|-
|Jungle Joyride Act 2
|ActD_SubBeach_02
|
|
|-
|Jungle Joyride Act 3
|ActD_SubBeach_04
|
|
|-
|Jungle Joyride Act 4
|ActD_SubBeach_01
|X
|
|-
|Jungle Joyride Act 5
|ActD_SubBeach_03
|X
|
|-
|Egg Lancer
|BossEggLancer
|
|
|-
|Town
|Town_SouthEastAsia
|
|
|-
|Entrance Stage
|Town_SouthEastAsiaETF
|
|
|}

== Night ==

=== Apotos ===
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|Windmill Isle Act 1
|ActN_MykonosEvil
|
|
|-
|Windmill Isle Act 1-2
|ActN_SubMykonos_03
|X
|ActN_MykonosEvil
|-
|Windmill Isle Act 1-3
|ActN_SubMykonos_04
|X
|ActN_MykonosEvil
|-
|Windmill Isle Act 2
|ActN_SubMykonos_01
|
|
|-
|Town
|Town_Mykonos_Night
|
|
|-
|Entrance Stage
|Town_MykonosETF_Night
|
|
|}

=== Mazuri ===
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|Savannah Citadel Act 1
|ActN_AfricaEvil
|
|
|-
|Savannah Citadel Act 2
|ActN_SubAfrica_01
|
|
|-
|Savannah Citadel Act 3
|ActN_SubAfrica_02
|X
|
|-
|Savannah Citadel Act 4
|ActN_SubAfrica_03
|X
|
|-
|Town
|Town_Africa_Night
|
|
|-
|Entrance Stage
|Town_AfricaETF_Night
|
|
|}

=== Spagonia ===
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|Rooftop Run Act 1
|ActN_EUEvil
|
|
|-
|Rooftop Run Act 1-2
|ActN_SubEU_02
|X
|ActN_EUEvil
|-
|Rooftop Run Act 2
|ActN_SubEU_01
|X
|
|-
|Town
|Town_EuropeanCity_Night
|
|
|-
|Entrance Stage
|Town_EuropeanCityETF_Night
|
|
|-
|Professor Pickle’s Lab
|Town_EULabo_Night
|
|
|}

=== Chun-Nan ===
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|Dragon Road Act 1
|ActN_ChinaEvil
|
|
|-
|Dragon Road Act 1-2
|ActN_SubChina_03
|X
|ActN_ChinaEvil
|-
|Dragon Road Act 2
|ActN_SubChina_01
|
|
|-
|Dragon Road Act 3
|ActN_SubChina_02
|X
|
|-
|Dark Gaia Phoenix
|BossPhoenix
|
|
|-
|Town
|Town_China_Night
|
|
|-
|Entrance Stage
|Town_ChinaETF_Night
|
|
|}

=== Holoska ===
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|Cool Edge Act 1
|ActN_SnowEvil
|
|
|-
|Cool Edge Act 2
|ActN_SubSnow_01
|X
|
|-
|Cool Edge Act 3
|ActN_SubSnow_02
|X
|
|-
|Dark Gaia Moray
|BossDarkGaiaMoray
|
|
|-
|Town
|Town_Snow_Night
|
|
|-
|Entrance Stage
|Town_SnowETF_Night
|
|
|}

=== Shamar ===
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|Arid Sands Act 1
|ActN_PetraEvil
|
|
|-
|Arid Sands Act 2
|ActN_SubPetra_02
|X
|
|-
|Arid Sands Act 3
|ActN_SubPetra_03
|X
|ActN_PetraEvil
|-
|Dark Guardian
|BossPetra
|
|
|-
|Town
|Town_PetraCapital_Night
|
|
|-
|Entrance Stage
|Town_PetraCapitalETF_Night
|
|
|-
|Professor Pickle’s Lab
|Town_PetraLabo_Night
|
|
|}

=== Empire City ===
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|Skyscraper Scamper Act 1
|ActN_NYEvil
|
|
|-
|Skyscraper Scamper Act 2
|ActN_SubNY_02
|X
|ActN_NYEvil
|-
|Skyscraper Scamper Act 3
|ActN_SubNY_01
|X
|
|-
|Town
|Town_NYCity_Night
|
|
|-
|Entrance Stage
|Town_NYCityETF_Night
|
|
|}

=== Adabat ===
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|Jungle Joyride Act 1
|ActN_BeachEvil
|
|
|-
|Jungle Joyride Act 1-2
|ActN_SubBeach_03
|X
|ActN_BeachEvil
|-
|Jungle Joyride Act 2
|ActN_SubBeach_01
|
|
|-
|Jungle Joyride Act 3
|ActN_SubBeach_02
|X
|
|-
|Town
|Town_SouthEastAsia_Night
|
|
|-
|Entrance Stage
|Town_SouthEastAsiaETF_Night
|
|
|}

== Eggmanland ==
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|EggmanLand
|Act_EggmanLand
|
|
|-
|Egg Dragoon
|BossEggDragoon
|
|
|-
|Dark Gaia Colossus Sections
|BossDarkGaia1_1Air
|
|
|-
|Dark Gaia Sonic Section 1
|BossDarkGaia1_1Run
|
|
|-
|Dark Gaia Sonic Section 2
|BossDarkGaia1_2Run
|
|
|-
|Dark Gaia Sonic Section 3
|BossDarkGaia1_3Run
|
|
|-
|Perfect Dark Gaia
|BossFinalDarkGaia
|
|
|-
|Tornado Defence Act 2
|ExStageTails2
|
|
|-
|Town
|Town_EggManBase
|
|
|}
== Events ==
{| class="wikitable"
!Area
!ID
!Event ID
|-
|Spagonia Lab (Ransacked)
|Event_M2_01_professor_room_new
|M2_01
|-
|Eggman’s Base (Mazuri)
|Event_afr_hideout
|M2_02
|-
|Gaia Temple (Inside)
|Event_temple
|M3_03

M3_05

M6_02

M7_02

S1_05

S3_04

T0_01

T0_02
|-
|Eggman’s Base (Inside)
|Event_M4_01_egb_hideout
|M4_01

M5_02
|-
|Eggman’s Base (Outside)
|Event_egb_hidout_exterior
|M5_01

M8_13
|-
|Adabat Temple (Outside)
|Event_M6_01_temple
|M6_01
|-
|EggmanLand Ending Room
|Event_M8_02_egbHall
|M7_04

M8_02
|-
|Dummy Geometry Slot(?)
|Event_M8_03
|M8_03
|-
|Ending
|Event_M8_16_myk
|M8_16
|}

== Unused ==
These are IDs that are not used in the retail game. Some of these became pre-rendered, while some others come from the Sonic Unleashed Preview Builds.
{| class="wikitable"
!Stage/Area
!ID
!Type
!Notes
|-
|Savannah Citadel Act 1 (Day)
|ActD_Africa_20080621
|Stage
|Version from the leaked trailer and screenshots
|-
|Savannah Citadel Act 1 (Night)
|ActN_AfricaEvil_Dje_20080619
|Stage
|Version from leaked screenshots
|-
|Savannah Citadel Act 3 (Night)
|ActN_AfricaEvil_Bao_20080619
|Stage
|Version from leaked screenshots
|-
|Rooftop Run Act 1 (Night)
|ActN_EUEvil_20080604
|Stage
|Unknown early version
|-
|Dragon Road Act 1 (Night)
|ActN_ChinaEvil_20080609
|Stage
|Version from early trailer and leaked screenshots
|-
|Cool Edge Act 1 (Day)
|ActD_Snow_20080618
|Stage
|Unknown early version
|-
|Arid Sands Act 4 (Day)
|ActD_SubPetra_01
|Stage
|Scrapped stage, can be seen in a photo from the credits and an unused World Map thumbnail
|-
|Arid Sands Act 4 (Night)
|ActN_SubPetra_01
|Stage
|Scrapped stage, can be seen in an unused World Map thumbnail
|-
|Daytime Sonic Test Stage
|ActD_Test
|Testing
|Defined in arcinfo
|-
|Werehog Test Stage
|ActN_Test
|Testing
|Defined in arcinfo
|-
|
|TestEvilEnemy
|
|Defined in arcinfo
|-
|
|TestEvilLargeFloor
|
|Defined in arcinfo
|-
|
|TestEvilPathFinding_01
|
|Defined in arcinfo
|-
|
|ActN_Test_Dummy
|
|Defined in arcinfo
|-
|Windmill Isle Act 1 (Dawn)
|Event_M0_06_myk
|Event
|The start area of Windmill Isle Act 1 with the lighting from the first in-engine event baked into the stage, as opposed to being dynamically loaded by the event
|-
|Spagonia Lab (Ransacked)
|Event_M2_01_professor_room
|Event
|The ransacked Spagonia lab using the old terrain system
|-
|Eggman’s Base (Mazuri)
|Event_afr_hideout_main
|Event
|Eggman’s Mazuri base using the old terrain system
|-
|Chun-Nan Town - Cursed
|Event_M8_08_01chn
|Event
|The Chun-Nan scene from the “Dark World” event - the final game has this event pre-rendered.
|-
|Mazuri Town - Cursed
|Event_M8_08_02afr
|Event
|The Mazuri scene from the “Dark World” event - the final game has this event pre-rendered.
|-
|Spagonia Town - Cursed
|Event_M8_08_03EU
|Event
|The Spagonia scene from the “Dark World” event - the final game has this event pre-rendered.
|-
|Holoska Town - Cursed
|Event_M8_08_04snow
|Event
|The Holoska scene from the “Dark World” event - the final game has this event pre-rendered.
|-
|Chun-Nan Town - Cured
|Event_M8_12_01chn
|Event
|The Chun-Nan scene from the “Rekindled Light” event - the final game has this event pre-rendered.
|-
|Mazuri Town - Cured
|Event_M8_12_02afr
|Event
|The Mazuri scene from the “Rekindled Light” event - the final game has this event pre-rendered.
|-
|Spagonia Town - Cured
|Event_M8_12_03EU
|Event
|The Spagonia scene from the “Rekindled Light” event - the final game has this event pre-rendered.
|-
|Holoska Town - Cured
|Event_M8_12_04snow
|Event
|The Holoska scene from the “Rekindled Light” event - the final game has this event pre-rendered.
|}

YACpkTool

2025-04-03T11:26:44Z

NextinHKRY:

{{ToolInfobox|title=Yet Another CPK Tool|author=Brolijah|website=https://github.com/Brolijah/YACpkTool|download=https://github.com/Brolijah/YACpkTool/releases/tag/v1.1b}}
'''YACpkTool''' (Yet Another Cpk Tool) is a tool to extract and pack CRIWARE .cpk files. To use it, you can drag a folder into the program to pack it, or drag a .cpk file into it to extract it.

YACpkTool

2025-04-03T11:26:34Z

NextinHKRY: Created page with "{{ToolInfobox|title=Yet Another CPK Tool|author=Brolijah|website=https://github.com/Brolijah/YACpkTool|download=https://github.com/Brolijah/YACpkTool/releases/tag/v1.1b}} '''YACpkTool''' (Yet Another Cpk Tool) is a tool to extract and pack CRIWARE .cpk files. To use it, you can drag a folder into the program to pack it, or drag a .cpk file into it to extract it."

{{ToolInfobox|title=Yet Another CPK Tool|author=Brolijah|website=https://github.com/Brolijah/YACpkTool|download=https://github.com/Brolijah/YACpkTool/releases/tag/v1.1b}}

'''YACpkTool''' (Yet Another Cpk Tool) is a tool to extract and pack CRIWARE .cpk files. To use it, you can drag a folder into the program to pack it, or drag a .cpk file into it to extract it.

Sonic Unleashed Stage IDs

2025-04-03T11:18:07Z

NextinHKRY:

This page contains a list of all the Stage IDs<ref>Credits to archxe and Hedgeturd for making a list of all the stage IDs!</ref> used in Sonic Unleashed. Stages don't follow a strict format, but they're generally like this:<syntaxhighlight lang="text">Act{Day/Night}_{country}</syntaxhighlight>
{{Notice|type=note|content=The tables are divided into 4 columns, the "Stage" is the name of the stage, the "ID" is the name of the #archive, and the "Geometry ID" is the archive the stage uses for the actual terrain, if it is blank then it means that the terrain archive it uses has the same name as the ID.}}
== Daytime ==

=== Apotos ===
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|Windmill Isle Act 1
|ActD_MykonosAct1
|
|
|-
|Windmill Isle Act 1-2
|ActD_SubMykonos_04
|X
|ActD_MykonosAct1
|-
|Windmill Isle Act 2
|ActD_MykonosAct2
|
|
|-
|Windmill Isle Act 2-2
|ActD_SubMykonos_05
|X
|ActD_MykonosAct2
|-
|Windmill Isle Act 3
|ActD_SubMykonos_01
|
|
|-
|Windmill Isle Act 4
|ActD_SubMykonos_02
|X
|
|-
|Town
|Town_Mykonos
|
|
|-
|Entrance Stage
|Town_MykonosETF
|
|
|}

=== Mazuri ===
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|Savannah Citadel Act 1
|ActD_Africa
|
|
|-
|Savannah Citadel Act 1-2
|ActD_SubAfrica_05
|X
|ActD_Africa
|-
|Savannah Citadel Act 2
|ActD_SubAfrica_01
|
|
|-
|Savannah Citadel Act 3
|ActD_SubAfrica_03
|
|
|-
|Savannah Citadel Act 3-2
|ActD_SubAfrica_06
|X
|ActD_SubAfrica_03
|-
|Savannah Citadel Act 4
|ActD_SubAfrica_02
|X
|
|-
|Savannah Citadel Act 5
|ActD_SubAfrica_04
|X
|BossEggBeetle
|-
|Egg Beetle
|BossEggBeetle
|
|
|-
|Town
|Town_Africa
|
|
|-
|Entrance Stage
|Town_AfricaETF
|
|
|}

=== Spagonia ===
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|Rooftop Run Act 1
|ActD_EU
|
|
|-
|Rooftop Run Act 1-2
|ActD_SubEU_05
|X
|ActD_EU
|-
|Rooftop Run Act 2
|ActD_SubEU_01
|
|
|-
|Rooftop Run Act 2-2
|ActD_SubEU_06
|X
|ActD_SubEU_01
|-
|Rooftop Run Act 3
|ActD_SubEU_02
|
|
|-
|Rooftop Run Act 4
|ActD_SubEU_03
|X
|
|-
|Rooftop Run Act 5
|ActD_SubEU_04
|X
|
|-
|Egg Devil Ray
|BossEggRayBird
|
|
|-
|Tornado Defence Act 1
|ExStageTails1
|
|
|-
|Town
|Town_EuropeanCity
|
|
|-
|Entrance Stage
|Town_EuropeanCityETF
|
|
|-
|Professor Pickle’s Lab
|Town_EULabo
|
|
|}

=== Chun-Nan ===
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|Dragon Road Act 1
|ActD_China
|
|
|-
|Dragon Road Act 1-2
|ActD_SubChina_05
|X
|ActD_China
|-
|Dragon Road Act 2
|ActD_SubChina_03
|
|
|-
|Dragon Road Act 2-2
|ActD_SubChina_06
|X
|ActD_SubChina_03
|-
|Dragon Road Act 3
|ActD_SubChina_04
|
|
|-
|Dragon Road Act 4
|ActD_SubChina_01
|X
|
|-
|Dragon Road Act 5
|ActD_SubChina_02
|X
|
|-
|Town
|Town_China
|
|
|-
|Entrance Stage
|Town_ChinaETF
|
|
|}

=== Holoska ===
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|Cool Edge Act 1
|ActD_Snow
|
|
|-
|Cool Edge Act 1-2
|ActD_SubSnow_04
|X
|ActD_Snow
|-
|Cool Edge Act 2
|ActD_SubSnow_01
|
|
|-
|Cool Edge Act 2-2
|ActD_SubSnow_05
|X
|ActD_SubChina_03
|-
|Cool Edge Act 3
|ActD_SubSnow_02
|X
|
|-
|Cool Edge Act 4
|ActD_SubSnow_03
|X
|
|-
|Town
|Town_Snow
|
|
|-
|Entrance Stage
|Town_SnowETF
|
|
|}

=== Shamar ===
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|Arid Sands Act 1
|ActD_Petra
|
|
|-
|Arid Sands Act 1-2
|ActD_SubPetra_04
|X
|ActD_Petra
|-
|Arid Sands Act 2
|ActD_SubPetra_03
|
|
|-
|Arid Sands Act 3
|ActD_SubPetra_02
|X
|
|-
|Town
|Town_PetraCapital
|
|
|-
|Entrance Stage
|Town_PetraCapitalETF
|
|
|-
|Professor Pickle’s Lab
|Town_PetraLabo
|
|
|}

=== Empire City ===
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|Skyscraper Scamper Act 1
|ActD_NY
|
|
|-
|Skyscraper Scamper Act 1-2
|ActD_SubNY_03
|X
|ActD_NY
|-
|Skyscraper Scamper Act 2
|ActD_SubNY_01
|
|
|-
|Skyscraper Scamper Act 3
|ActD_SubNY_02
|X
|
|-
|Town
|Town_NYCity
|
|
|-
|Entrance Stage
|Town_NYCityETF
|
|
|}

=== Adabat ===
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|Jungle Joyride Act 1
|ActD_Beach
|
|
|-
|Jungle Joyride Act 1-2
|ActD_SubBeach_05
|X
|ActD_Beach
|-
|Jungle Joyride Act 2
|ActD_SubBeach_02
|
|
|-
|Jungle Joyride Act 3
|ActD_SubBeach_04
|
|
|-
|Jungle Joyride Act 4
|ActD_SubBeach_01
|X
|
|-
|Jungle Joyride Act 5
|ActD_SubBeach_03
|X
|
|-
|Egg Lancer
|BossEggLancer
|
|
|-
|Town
|Town_SouthEastAsia
|
|
|-
|Entrance Stage
|Town_SouthEastAsiaETF
|
|
|}

== Night ==

=== Apotos ===
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|Windmill Isle Act 1
|ActN_MykonosEvil
|
|
|-
|Windmill Isle Act 1-2
|ActN_SubMykonos_03
|X
|ActN_MykonosEvil
|-
|Windmill Isle Act 1-3
|ActN_SubMykonos_04
|X
|ActN_MykonosEvil
|-
|Windmill Isle Act 2
|ActN_SubMykonos_01
|
|
|-
|Town
|Town_Mykonos_Night
|
|
|-
|Entrance Stage
|Town_MykonosETF_Night
|
|
|}

=== Mazuri ===
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|Savannah Citadel Act 1
|ActN_AfricaEvil
|
|
|-
|Savannah Citadel Act 2
|ActN_SubAfrica_01
|
|
|-
|Savannah Citadel Act 3
|ActN_SubAfrica_02
|X
|
|-
|Savannah Citadel Act 4
|ActN_SubAfrica_03
|X
|
|-
|Town
|Town_Africa_Night
|
|
|-
|Entrance Stage
|Town_AfricaETF_Night
|
|
|}

=== Spagonia ===
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|Rooftop Run Act 1
|ActN_EUEvil
|
|
|-
|Rooftop Run Act 1-2
|ActN_SubEU_02
|X
|ActN_EUEvil
|-
|Rooftop Run Act 2
|ActN_SubEU_01
|X
|
|-
|Town
|Town_EuropeanCity_Night
|
|
|-
|Entrance Stage
|Town_EuropeanCityETF_Night
|
|
|-
|Professor Pickle’s Lab
|Town_EULabo_Night
|
|
|}

=== Chun-Nan ===
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|Dragon Road Act 1
|ActN_ChinaEvil
|
|
|-
|Dragon Road Act 1-2
|ActN_SubChina_03
|X
|ActN_ChinaEvil
|-
|Dragon Road Act 2
|ActN_SubChina_01
|
|
|-
|Dragon Road Act 3
|ActN_SubChina_02
|X
|
|-
|Dark Gaia Phoenix
|BossPhoenix
|
|
|-
|Town
|Town_China_Night
|
|
|-
|Entrance Stage
|Town_ChinaETF_Night
|
|
|}

=== Holoska ===
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|Cool Edge Act 1
|ActN_SnowEvil
|
|
|-
|Cool Edge Act 2
|ActN_SubSnow_01
|X
|
|-
|Cool Edge Act 3
|ActN_SubSnow_02
|X
|
|-
|Dark Gaia Moray
|BossDarkGaiaMoray
|
|
|-
|Town
|Town_Snow_Night
|
|
|-
|Entrance Stage
|Town_SnowETF_Night
|
|
|}

=== Shamar ===
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|Arid Sands Act 1
|ActN_PetraEvil
|
|
|-
|Arid Sands Act 2
|ActN_SubPetra_02
|X
|
|-
|Arid Sands Act 3
|ActN_SubPetra_03
|X
|ActN_PetraEvil
|-
|Dark Guardian
|BossPetra
|
|
|-
|Town
|Town_PetraCapital_Night
|
|
|-
|Entrance Stage
|Town_PetraCapitalETF_Night
|
|
|-
|Professor Pickle’s Lab
|Town_PetraLabo_Night
|
|
|}

=== Empire City ===
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|Skyscraper Scamper Act 1
|ActN_NYEvil
|
|
|-
|Skyscraper Scamper Act 2
|ActN_SubNY_02
|X
|ActN_NYEvil
|-
|Skyscraper Scamper Act 3
|ActN_SubNY_01
|X
|
|-
|Town
|Town_NYCity_Night
|
|
|-
|Entrance Stage
|Town_NYCityETF_Night
|
|
|}

=== Adabat ===
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|Jungle Joyride Act 1
|ActN_BeachEvil
|
|
|-
|Jungle Joyride Act 1-2
|ActN_SubBeach_03
|X
|ActN_BeachEvil
|-
|Jungle Joyride Act 2
|ActN_SubBeach_01
|
|
|-
|Jungle Joyride Act 3
|ActN_SubBeach_02
|X
|
|-
|Town
|Town_SouthEastAsia_Night
|
|
|-
|Entrance Stage
|Town_SouthEastAsiaETF_Night
|
|
|}

== Eggmanland ==
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|EggmanLand
|Act_EggmanLand
|
|
|-
|Egg Dragoon
|BossEggDragoon
|
|
|-
|Dark Gaia Colossus Sections
|BossDarkGaia1_1Air
|
|
|-
|Dark Gaia Sonic Section 1
|BossDarkGaia1_1Run
|
|
|-
|Dark Gaia Sonic Section 2
|BossDarkGaia1_2Run
|
|
|-
|Dark Gaia Sonic Section 3
|BossDarkGaia1_3Run
|
|
|-
|Perfect Dark Gaia
|BossFinalDarkGaia
|
|
|-
|Tornado Defence Act 2
|ExStageTails2
|
|
|-
|Town
|Town_EggManBase
|
|
|}
== Events ==
{| class="wikitable"
!Area
!ID
!Event ID
|-
|Spagonia Lab (Ransacked)
|Event_M2_01_professor_room_new
|M2_01
|-
|Eggman’s Base (Mazuri)
|Event_afr_hideout
|M2_02
|-
|Gaia Temple (Inside)
|Event_temple
|M3_03

M3_05

M6_02

M7_02

S1_05

S3_04

T0_01

T0_02
|-
|Eggman’s Base (Inside)
|Event_M4_01_egb_hideout
|M4_01

M5_02
|-
|Eggman’s Base (Outside)
|Event_egb_hidout_exterior
|M5_01

M8_13
|-
|Adabat Temple (Outside)
|Event_M6_01_temple
|M6_01
|-
|EggmanLand Ending Room
|Event_M8_02_egbHall
|M7_04

M8_02
|-
|Dummy Geometry Slot(?)
|Event_M8_03
|M8_03
|-
|Ending
|Event_M8_16_myk
|M8_16
|}

== Unused ==
These are IDs that are not used in the retail game. Some of these became pre-rendered, while some others come from the Sonic Unleashed Preview Builds.
{| class="wikitable"
!Stage/Area
!ID
!Type
!Notes
|-
|Savannah Citadel Act 1 (Day)
|ActD_Africa_20080621
|Stage
|Version from the leaked trailer and screenshots
|-
|Savannah Citadel Act 1 (Night)
|ActN_AfricaEvil_Dje_20080619
|Stage
|Version from leaked screenshots
|-
|Savannah Citadel Act 3 (Night)
|ActN_AfricaEvil_Bao_20080619
|Stage
|Version from leaked screenshots
|-
|Rooftop Run Act 1 (Night)
|ActN_EUEvil_20080604
|Stage
|Unknown early version
|-
|Dragon Road Act 1 (Night)
|ActN_ChinaEvil_20080609
|Stage
|Version from early trailer and leaked screenshots
|-
|Cool Edge Act 1 (Day)
|ActD_Snow_20080618
|Stage
|Unknown early version
|-
|Arid Sands Act 4 (Day)
|ActD_SubPetra_01
|Stage
|Scrapped stage, can be seen in a photo from the credits and an unused World Map thumbnail
|-
|Arid Sands Act 4 (Night)
|ActN_SubPetra_01
|Stage
|Scrapped stage, can be seen in an unused World Map thumbnail
|-
|Daytime Sonic Test Stage
|ActD_Test
|Testing
|Defined in arcinfo
|-
|Werehog Test Stage
|ActN_Test
|Testing
|Defined in arcinfo
|-
|
|TestEvilEnemy
|
|Defined in arcinfo
|-
|
|TestEvilLargeFloor
|
|Defined in arcinfo
|-
|
|TestEvilPathFinding_01
|
|Defined in arcinfo
|-
|
|ActN_Test_Dummy
|
|Defined in arcinfo
|-
|Windmill Isle Act 1 (Dawn)
|Event_M0_06_myk
|Event
|The start area of Windmill Isle Act 1 with the lighting from the first in-engine event baked into the stage, as opposed to being dynamically loaded by the event
|-
|Spagonia Lab (Ransacked)
|Event_M2_01_professor_room
|Event
|The ransacked Spagonia lab using the old terrain system
|-
|Eggman’s Base (Mazuri)
|Event_afr_hideout_main
|Event
|Eggman’s Mazuri base using the old terrain system
|-
|Chun-Nan Town - Cursed
|Event_M8_08_01chn
|Event
|The Chun-Nan scene from the “Dark World” event - the final game has this event pre-rendered.
|-
|Mazuri Town - Cursed
|Event_M8_08_02afr
|Event
|The Mazuri scene from the “Dark World” event - the final game has this event pre-rendered.
|-
|Spagonia Town - Cursed
|Event_M8_08_03EU
|Event
|The Spagonia scene from the “Dark World” event - the final game has this event pre-rendered.
|-
|Holoska Town - Cursed
|Event_M8_08_04snow
|Event
|The Holoska scene from the “Dark World” event - the final game has this event pre-rendered.
|-
|Chun-Nan Town - Cured
|Event_M8_12_01chn
|Event
|The Chun-Nan scene from the “Rekindled Light” event - the final game has this event pre-rendered.
|-
|Mazuri Town - Cured
|Event_M8_12_02afr
|Event
|The Mazuri scene from the “Rekindled Light” event - the final game has this event pre-rendered.
|-
|Spagonia Town - Cured
|Event_M8_12_03EU
|Event
|The Spagonia scene from the “Rekindled Light” event - the final game has this event pre-rendered.
|-
|Holoska Town - Cured
|Event_M8_12_04snow
|Event
|The Holoska scene from the “Rekindled Light” event - the final game has this event pre-rendered.
|}

Sonic Unleashed Stage IDs

2025-04-03T11:17:56Z

NextinHKRY:

This page contains a list of all the Stage IDs<ref>Credits to archxe and Hedgeturd for making a list of all the stage IDs!</ref> used in Sonic Unleashed. Stages don't follow a strict format, but they're generally like this:<syntaxhighlight lang="text">Act{Day/Night}_{country}</syntaxhighlight>
{{Notice|type=note|content=The tables are divided into 4 columns, the "Stage" is the name of the stage, the "ID" is the name of the #archive, and the "Geometry ID" is the archive the stage uses for the actual terrain, if it is blank then it means that the terrain archive it uses has the same name as the ID.}}

== Daytime ==

=== Apotos ===
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|Windmill Isle Act 1
|ActD_MykonosAct1
|
|
|-
|Windmill Isle Act 1-2
|ActD_SubMykonos_04
|X
|ActD_MykonosAct1
|-
|Windmill Isle Act 2
|ActD_MykonosAct2
|
|
|-
|Windmill Isle Act 2-2
|ActD_SubMykonos_05
|X
|ActD_MykonosAct2
|-
|Windmill Isle Act 3
|ActD_SubMykonos_01
|
|
|-
|Windmill Isle Act 4
|ActD_SubMykonos_02
|X
|
|-
|Town
|Town_Mykonos
|
|
|-
|Entrance Stage
|Town_MykonosETF
|
|
|}

=== Mazuri ===
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|Savannah Citadel Act 1
|ActD_Africa
|
|
|-
|Savannah Citadel Act 1-2
|ActD_SubAfrica_05
|X
|ActD_Africa
|-
|Savannah Citadel Act 2
|ActD_SubAfrica_01
|
|
|-
|Savannah Citadel Act 3
|ActD_SubAfrica_03
|
|
|-
|Savannah Citadel Act 3-2
|ActD_SubAfrica_06
|X
|ActD_SubAfrica_03
|-
|Savannah Citadel Act 4
|ActD_SubAfrica_02
|X
|
|-
|Savannah Citadel Act 5
|ActD_SubAfrica_04
|X
|BossEggBeetle
|-
|Egg Beetle
|BossEggBeetle
|
|
|-
|Town
|Town_Africa
|
|
|-
|Entrance Stage
|Town_AfricaETF
|
|
|}

=== Spagonia ===
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|Rooftop Run Act 1
|ActD_EU
|
|
|-
|Rooftop Run Act 1-2
|ActD_SubEU_05
|X
|ActD_EU
|-
|Rooftop Run Act 2
|ActD_SubEU_01
|
|
|-
|Rooftop Run Act 2-2
|ActD_SubEU_06
|X
|ActD_SubEU_01
|-
|Rooftop Run Act 3
|ActD_SubEU_02
|
|
|-
|Rooftop Run Act 4
|ActD_SubEU_03
|X
|
|-
|Rooftop Run Act 5
|ActD_SubEU_04
|X
|
|-
|Egg Devil Ray
|BossEggRayBird
|
|
|-
|Tornado Defence Act 1
|ExStageTails1
|
|
|-
|Town
|Town_EuropeanCity
|
|
|-
|Entrance Stage
|Town_EuropeanCityETF
|
|
|-
|Professor Pickle’s Lab
|Town_EULabo
|
|
|}

=== Chun-Nan ===
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|Dragon Road Act 1
|ActD_China
|
|
|-
|Dragon Road Act 1-2
|ActD_SubChina_05
|X
|ActD_China
|-
|Dragon Road Act 2
|ActD_SubChina_03
|
|
|-
|Dragon Road Act 2-2
|ActD_SubChina_06
|X
|ActD_SubChina_03
|-
|Dragon Road Act 3
|ActD_SubChina_04
|
|
|-
|Dragon Road Act 4
|ActD_SubChina_01
|X
|
|-
|Dragon Road Act 5
|ActD_SubChina_02
|X
|
|-
|Town
|Town_China
|
|
|-
|Entrance Stage
|Town_ChinaETF
|
|
|}

=== Holoska ===
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|Cool Edge Act 1
|ActD_Snow
|
|
|-
|Cool Edge Act 1-2
|ActD_SubSnow_04
|X
|ActD_Snow
|-
|Cool Edge Act 2
|ActD_SubSnow_01
|
|
|-
|Cool Edge Act 2-2
|ActD_SubSnow_05
|X
|ActD_SubChina_03
|-
|Cool Edge Act 3
|ActD_SubSnow_02
|X
|
|-
|Cool Edge Act 4
|ActD_SubSnow_03
|X
|
|-
|Town
|Town_Snow
|
|
|-
|Entrance Stage
|Town_SnowETF
|
|
|}

=== Shamar ===
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|Arid Sands Act 1
|ActD_Petra
|
|
|-
|Arid Sands Act 1-2
|ActD_SubPetra_04
|X
|ActD_Petra
|-
|Arid Sands Act 2
|ActD_SubPetra_03
|
|
|-
|Arid Sands Act 3
|ActD_SubPetra_02
|X
|
|-
|Town
|Town_PetraCapital
|
|
|-
|Entrance Stage
|Town_PetraCapitalETF
|
|
|-
|Professor Pickle’s Lab
|Town_PetraLabo
|
|
|}

=== Empire City ===
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|Skyscraper Scamper Act 1
|ActD_NY
|
|
|-
|Skyscraper Scamper Act 1-2
|ActD_SubNY_03
|X
|ActD_NY
|-
|Skyscraper Scamper Act 2
|ActD_SubNY_01
|
|
|-
|Skyscraper Scamper Act 3
|ActD_SubNY_02
|X
|
|-
|Town
|Town_NYCity
|
|
|-
|Entrance Stage
|Town_NYCityETF
|
|
|}

=== Adabat ===
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|Jungle Joyride Act 1
|ActD_Beach
|
|
|-
|Jungle Joyride Act 1-2
|ActD_SubBeach_05
|X
|ActD_Beach
|-
|Jungle Joyride Act 2
|ActD_SubBeach_02
|
|
|-
|Jungle Joyride Act 3
|ActD_SubBeach_04
|
|
|-
|Jungle Joyride Act 4
|ActD_SubBeach_01
|X
|
|-
|Jungle Joyride Act 5
|ActD_SubBeach_03
|X
|
|-
|Egg Lancer
|BossEggLancer
|
|
|-
|Town
|Town_SouthEastAsia
|
|
|-
|Entrance Stage
|Town_SouthEastAsiaETF
|
|
|}

== Night ==

=== Apotos ===
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|Windmill Isle Act 1
|ActN_MykonosEvil
|
|
|-
|Windmill Isle Act 1-2
|ActN_SubMykonos_03
|X
|ActN_MykonosEvil
|-
|Windmill Isle Act 1-3
|ActN_SubMykonos_04
|X
|ActN_MykonosEvil
|-
|Windmill Isle Act 2
|ActN_SubMykonos_01
|
|
|-
|Town
|Town_Mykonos_Night
|
|
|-
|Entrance Stage
|Town_MykonosETF_Night
|
|
|}

=== Mazuri ===
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|Savannah Citadel Act 1
|ActN_AfricaEvil
|
|
|-
|Savannah Citadel Act 2
|ActN_SubAfrica_01
|
|
|-
|Savannah Citadel Act 3
|ActN_SubAfrica_02
|X
|
|-
|Savannah Citadel Act 4
|ActN_SubAfrica_03
|X
|
|-
|Town
|Town_Africa_Night
|
|
|-
|Entrance Stage
|Town_AfricaETF_Night
|
|
|}

=== Spagonia ===
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|Rooftop Run Act 1
|ActN_EUEvil
|
|
|-
|Rooftop Run Act 1-2
|ActN_SubEU_02
|X
|ActN_EUEvil
|-
|Rooftop Run Act 2
|ActN_SubEU_01
|X
|
|-
|Town
|Town_EuropeanCity_Night
|
|
|-
|Entrance Stage
|Town_EuropeanCityETF_Night
|
|
|-
|Professor Pickle’s Lab
|Town_EULabo_Night
|
|
|}

=== Chun-Nan ===
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|Dragon Road Act 1
|ActN_ChinaEvil
|
|
|-
|Dragon Road Act 1-2
|ActN_SubChina_03
|X
|ActN_ChinaEvil
|-
|Dragon Road Act 2
|ActN_SubChina_01
|
|
|-
|Dragon Road Act 3
|ActN_SubChina_02
|X
|
|-
|Dark Gaia Phoenix
|BossPhoenix
|
|
|-
|Town
|Town_China_Night
|
|
|-
|Entrance Stage
|Town_ChinaETF_Night
|
|
|}

=== Holoska ===
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|Cool Edge Act 1
|ActN_SnowEvil
|
|
|-
|Cool Edge Act 2
|ActN_SubSnow_01
|X
|
|-
|Cool Edge Act 3
|ActN_SubSnow_02
|X
|
|-
|Dark Gaia Moray
|BossDarkGaiaMoray
|
|
|-
|Town
|Town_Snow_Night
|
|
|-
|Entrance Stage
|Town_SnowETF_Night
|
|
|}

=== Shamar ===
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|Arid Sands Act 1
|ActN_PetraEvil
|
|
|-
|Arid Sands Act 2
|ActN_SubPetra_02
|X
|
|-
|Arid Sands Act 3
|ActN_SubPetra_03
|X
|ActN_PetraEvil
|-
|Dark Guardian
|BossPetra
|
|
|-
|Town
|Town_PetraCapital_Night
|
|
|-
|Entrance Stage
|Town_PetraCapitalETF_Night
|
|
|-
|Professor Pickle’s Lab
|Town_PetraLabo_Night
|
|
|}

=== Empire City ===
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|Skyscraper Scamper Act 1
|ActN_NYEvil
|
|
|-
|Skyscraper Scamper Act 2
|ActN_SubNY_02
|X
|ActN_NYEvil
|-
|Skyscraper Scamper Act 3
|ActN_SubNY_01
|X
|
|-
|Town
|Town_NYCity_Night
|
|
|-
|Entrance Stage
|Town_NYCityETF_Night
|
|
|}

=== Adabat ===
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|Jungle Joyride Act 1
|ActN_BeachEvil
|
|
|-
|Jungle Joyride Act 1-2
|ActN_SubBeach_03
|X
|ActN_BeachEvil
|-
|Jungle Joyride Act 2
|ActN_SubBeach_01
|
|
|-
|Jungle Joyride Act 3
|ActN_SubBeach_02
|X
|
|-
|Town
|Town_SouthEastAsia_Night
|
|
|-
|Entrance Stage
|Town_SouthEastAsiaETF_Night
|
|
|}

== Eggmanland ==
{| class="wikitable sortable"
!Stage
!ID
!DLC
!Geometry ID
|-
|EggmanLand
|Act_EggmanLand
|
|
|-
|Egg Dragoon
|BossEggDragoon
|
|
|-
|Dark Gaia Colossus Sections
|BossDarkGaia1_1Air
|
|
|-
|Dark Gaia Sonic Section 1
|BossDarkGaia1_1Run
|
|
|-
|Dark Gaia Sonic Section 2
|BossDarkGaia1_2Run
|
|
|-
|Dark Gaia Sonic Section 3
|BossDarkGaia1_3Run
|
|
|-
|Perfect Dark Gaia
|BossFinalDarkGaia
|
|
|-
|Tornado Defence Act 2
|ExStageTails2
|
|
|-
|Town
|Town_EggManBase
|
|
|}
== Events ==
{| class="wikitable"
!Area
!ID
!Event ID
|-
|Spagonia Lab (Ransacked)
|Event_M2_01_professor_room_new
|M2_01
|-
|Eggman’s Base (Mazuri)
|Event_afr_hideout
|M2_02
|-
|Gaia Temple (Inside)
|Event_temple
|M3_03

M3_05

M6_02

M7_02

S1_05

S3_04

T0_01

T0_02
|-
|Eggman’s Base (Inside)
|Event_M4_01_egb_hideout
|M4_01

M5_02
|-
|Eggman’s Base (Outside)
|Event_egb_hidout_exterior
|M5_01

M8_13
|-
|Adabat Temple (Outside)
|Event_M6_01_temple
|M6_01
|-
|EggmanLand Ending Room
|Event_M8_02_egbHall
|M7_04

M8_02
|-
|Dummy Geometry Slot(?)
|Event_M8_03
|M8_03
|-
|Ending
|Event_M8_16_myk
|M8_16
|}

== Unused ==
These are IDs that are not used in the retail game. Some of these became pre-rendered, while some others come from the Sonic Unleashed Preview Builds.
{| class="wikitable"
!Stage/Area
!ID
!Type
!Notes
|-
|Savannah Citadel Act 1 (Day)
|ActD_Africa_20080621
|Stage
|Version from the leaked trailer and screenshots
|-
|Savannah Citadel Act 1 (Night)
|ActN_AfricaEvil_Dje_20080619
|Stage
|Version from leaked screenshots
|-
|Savannah Citadel Act 3 (Night)
|ActN_AfricaEvil_Bao_20080619
|Stage
|Version from leaked screenshots
|-
|Rooftop Run Act 1 (Night)
|ActN_EUEvil_20080604
|Stage
|Unknown early version
|-
|Dragon Road Act 1 (Night)
|ActN_ChinaEvil_20080609
|Stage
|Version from early trailer and leaked screenshots
|-
|Cool Edge Act 1 (Day)
|ActD_Snow_20080618
|Stage
|Unknown early version
|-
|Arid Sands Act 4 (Day)
|ActD_SubPetra_01
|Stage
|Scrapped stage, can be seen in a photo from the credits and an unused World Map thumbnail
|-
|Arid Sands Act 4 (Night)
|ActN_SubPetra_01
|Stage
|Scrapped stage, can be seen in an unused World Map thumbnail
|-
|Daytime Sonic Test Stage
|ActD_Test
|Testing
|Defined in arcinfo
|-
|Werehog Test Stage
|ActN_Test
|Testing
|Defined in arcinfo
|-
|
|TestEvilEnemy
|
|Defined in arcinfo
|-
|
|TestEvilLargeFloor
|
|Defined in arcinfo
|-
|
|TestEvilPathFinding_01
|
|Defined in arcinfo
|-
|
|ActN_Test_Dummy
|
|Defined in arcinfo
|-
|Windmill Isle Act 1 (Dawn)
|Event_M0_06_myk
|Event
|The start area of Windmill Isle Act 1 with the lighting from the first in-engine event baked into the stage, as opposed to being dynamically loaded by the event
|-
|Spagonia Lab (Ransacked)
|Event_M2_01_professor_room
|Event
|The ransacked Spagonia lab using the old terrain system
|-
|Eggman’s Base (Mazuri)
|Event_afr_hideout_main
|Event
|Eggman’s Mazuri base using the old terrain system
|-
|Chun-Nan Town - Cursed
|Event_M8_08_01chn
|Event
|The Chun-Nan scene from the “Dark World” event - the final game has this event pre-rendered.
|-
|Mazuri Town - Cursed
|Event_M8_08_02afr
|Event
|The Mazuri scene from the “Dark World” event - the final game has this event pre-rendered.
|-
|Spagonia Town - Cursed
|Event_M8_08_03EU
|Event
|The Spagonia scene from the “Dark World” event - the final game has this event pre-rendered.
|-
|Holoska Town - Cursed
|Event_M8_08_04snow
|Event
|The Holoska scene from the “Dark World” event - the final game has this event pre-rendered.
|-
|Chun-Nan Town - Cured
|Event_M8_12_01chn
|Event
|The Chun-Nan scene from the “Rekindled Light” event - the final game has this event pre-rendered.
|-
|Mazuri Town - Cured
|Event_M8_12_02afr
|Event
|The Mazuri scene from the “Rekindled Light” event - the final game has this event pre-rendered.
|-
|Spagonia Town - Cured
|Event_M8_12_03EU
|Event
|The Spagonia scene from the “Rekindled Light” event - the final game has this event pre-rendered.
|-
|Holoska Town - Cured
|Event_M8_12_04snow
|Event
|The Holoska scene from the “Rekindled Light” event - the final game has this event pre-rendered.
|}

Tools

2025-03-27T18:25:39Z

NextinHKRY:

This section contains tools that aren't specific to any Sonic game. Below you can see the tools divided by the engine they target and their purpose.

== Various Engines ==

=== Audio ===

* [[SonicAudioTools]]

=== Animations ===

* [[KwasTools (Hedgehog Engine)|io_kwastools]] (.cam-anim, .uv-anim)

== Hedgehog Engine ==

=== Archives ===

* [[PackCpk]] (.cpk)
* [[YACpkTool]] (.cpk)

* [[HedgeArchiveEditor]] (.ar, .pfd, .pac)
* [[HedgeArcPack]] (.ar, .pfd, .pac)
* [[ar0pack-ar0unpack]] (.ar, .pfd)

=== Collision ===
* [[Havok Converter]] (*.hkx)

=== Lighting ===
* [[HedgeGI]]
* [[SonicLightTools]]

=== Models ===

* [[terrain2fbx]] (.terrain-model)
* [[terrain2fbx-png]] (.terrain-model)

=== Text ===
* [[Converse]] (.fco / .fte)
=== UI ===
* [[Shuriken]] (.xncp / .yncp)
* [[Kunai]] (.xncp / .yncp / .gncp / .sncp)

Tools

2025-03-27T18:20:10Z

NextinHKRY:

This section contains tools that aren't specific to any Sonic game. Below you can see the tools divided by the engine they target and their purpose.

== Various Engines ==

=== Audio ===

* [[SonicAudioTools]]

=== Animations ===

* [[KwasTools (Hedgehog Engine)|io_kwastools]] (.cam-anim, .uv-anim)

== Hedgehog Engine ==

=== Common ===

* [[PackCpk]] (.cpk)
* [[terrain2fbx]] (.terrain-model)
* [[terrain2fbx-png]] (.terrain-model)

=== Archives (.ar, .pfd, .pac) ===
* [[HedgeArchiveEditor]]
* [[HedgeArcPack]]
* [[ar0pack-ar0unpack]]

=== Lighting ===
* [[HedgeGI]]
* [[SonicLightTools]]

=== UI ===
* [[Shuriken]] (.xncp / .yncp)
* [[Kunai]] (.xncp / .yncp / .gncp / .sncp)

=== Collision ===
* [[Havok Converter]] (*.hkx)

=== Text ===
* [[Converse]] (.fco / .fte)

KwasTools (Hedgehog Engine)

2025-03-27T18:19:52Z

NextinHKRY:

{{ToolInfobox|title=KwasTools|author=Kwasior|website=https://github.com/ThisKwasior/KwasTools}}
'''KwasTools''' is a set of utilities for several games, it contains tools to edit and examine CRIWARE formats and a [[wikipedia:Blender_(software)|Blender]] addon called '''[https://github.com/ThisKwasior/KwasTools/tree/master/addons/blender/io_kwastools io_kwastools]''' to edit <code>.cam-anim</code> and <code>.uv-anim</code> files from Hedgehog Engine 1 and 2.

KwasTools (Hedgehog Engine)

2025-03-27T18:19:39Z

NextinHKRY: Created page with "{{ToolInfobox|title=KwasTools|author=Kwasior|website=https://github.com/ThisKwasior/KwasTools}} '''KwasTools''' is a set of utilities for several games, it contains tools to edit and examine CRIWARE formats and a Blender addon called '''[https://github.com/ThisKwasior/KwasTools/tree/master/addons/blender/io_kwastools io_kwastools]''' to edit <code>.cam-anim</code> and <code>.uv-anim</code> files from Hedgehog Engine 1 and 2."

{{ToolInfobox|title=KwasTools|author=Kwasior|website=https://github.com/ThisKwasior/KwasTools}}

'''KwasTools''' is a set of utilities for several games, it contains tools to edit and examine CRIWARE formats and a [[wikipedia:Blender_(software)|Blender]] addon called '''[https://github.com/ThisKwasior/KwasTools/tree/master/addons/blender/io_kwastools io_kwastools]''' to edit <code>.cam-anim</code> and <code>.uv-anim</code> files from Hedgehog Engine 1 and 2.

Tools

2025-03-27T18:15:18Z

NextinHKRY:

This section contains tools that aren't specific to any Sonic game. Below you can see the tools divided by the engine they target and their purpose.

== Various Engines ==

=== Audio ===

* [[SonicAudioTools]]

=== Animations ===

* [[io_kwastools]] (.cam-anim, .uv-anim)

== Hedgehog Engine ==

=== Common ===

* [[PackCpk]] (.cpk)
* [[terrain2fbx]] (.terrain-model)
* [[terrain2fbx-png]] (.terrain-model)

=== Archives (.ar, .pfd, .pac) ===
* [[HedgeArchiveEditor]]
* [[HedgeArcPack]]
* [[ar0pack-ar0unpack]]

=== Lighting ===
* [[HedgeGI]]
* [[SonicLightTools]]

=== UI ===
* [[Shuriken]] (.xncp / .yncp)
* [[Kunai]] (.xncp / .yncp / .gncp / .sncp)

=== Collision ===
* [[Havok Converter]] (*.hkx)

=== Text ===
* [[Converse]] (.fco / .fte)

Tools

2025-03-27T18:14:55Z

NextinHKRY:

This section contains tools that aren't specific to any Sonic game. Below you can see the tools divided by the engine they target and their purpose.

== Various Engines ==

=== Audio ===

* [[SonicAudioTools]]

=== Animations ===

* [[KwasTools|io_kwastools]] (.cam-anim, .uv-anim)

== Hedgehog Engine ==

=== Common ===

* [[PackCpk]] (.cpk)
* [[terrain2fbx]] (.terrain-model)
* [[terrain2fbx-png]] (.terrain-model)

=== Archives (.ar, .pfd, .pac) ===
* [[HedgeArchiveEditor]]
* [[HedgeArcPack]]
* [[ar0pack-ar0unpack]]

=== Lighting ===
* [[HedgeGI]]
* [[SonicLightTools]]

=== UI ===
* [[Shuriken]] (.xncp / .yncp)
* [[Kunai]] (.xncp / .yncp / .gncp / .sncp)

=== Collision ===
* [[Havok Converter]] (*.hkx)

=== Text ===
* [[Converse]] (.fco / .fte)

Sonic Unleashed

2025-03-27T18:14:07Z

NextinHKRY:

== Tools ==

==== Lighting ====

* [[pfdpackUnleashed]] (*.pfd)

== Guides ==

=== Level Editing ===

* [[How To Use Sonic GLvl with Sonic Unleashed|Sonic GLvl]]

== Documentation ==

* [[Sonic Unleashed Stage IDs|Stage IDs]]
* [[Unleashed-Generations Havok Collision Attributes|Havok Collision Attributes]]

== Discoveries ==

=== PlayStation 3 ===

* [[Sonic Unleashed Install Screen|Install Screen]]