HedgeDocs - User contributions [en]

HedgeBake

2025-09-14T08:00:27Z

Skyth:

{{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 data for Hedgehog Engine 1 games using the Cycles engine.

Troubleshooting Custom Level Issues in Sonic Generations/Sonic Unleashed

2025-05-11T22:07:12Z

Skyth:

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 Terrain Models ====
<code>StageGuidePath.path.xml</code> leftover from another level can cause wonky terrain streaming or not render some of your terrain models, as it wouldn't follow the path of your stage. To disable stage guide path, you can simply remove the <code>StageGuidePath.path.xml</code> file or set <code>g_UseGuidePath</code> in <code>Terrain.prm.xml</code> to <code>false</code>.

==== 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>

How To Import Custom Terrain in Sonic Generations/Sonic Unleashed

2025-05-07T14:07:32Z

Skyth:

{{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>
{{Notice|type=warn|content=When converting for Sonic Unleashed, Hedgehog Converter saves <code>.ar</code> files by navigating two levels up from the '''Terrain output directory'''. For example, if you pick <code>C:\folder1\folder2\ActD_MykonosAct1</code>, the <code>.ar</code> files will be saved to <code>folder1</code>.

To avoid confusion or misplaced files, it’s strongly recommended to follow the original <code>Packed</code> folder structure used by the game in your mod directory.}}

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 '''will 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.

The materials of your skybox need to be assigned to sky shaders such as <code>Sky_d</code>, otherwise they will not appear in-game correctly. You can assign the shaders by loading the model in SonicGLvl's material editor under '''Materials'''. After changing the shaders, you can save the materials by saving the model from the material editor.

=== 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/stageID.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]]. For any potential issues you may run into after creating your level, please take a look at the [[Troubleshooting Custom Level Issues in Sonic Generations/Sonic Unleashed|Troubleshooting]] page.

Troubleshooting Custom Level Issues in Sonic Generations/Sonic Unleashed

2025-05-03T11:27:35Z

Skyth:

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 Terrain Models ====
<code>StageGuidePath.path.xml</code> leftover from another level can cause wonky terrain streaming or not render some of your terrain models, as it wouldn't follow the path of your stage. To disable stage guide path, you can simply remove the <code>.path.xml</code> file or set <code>g_UseGuidePath</code> in <code>Terrain.prm.xml</code> to <code>false</code>.

==== 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-03T11:26:40Z

Skyth:

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 Terrain Models ====
<code>StageGuidePath.path.xml</code> leftover from another level can cause wonky terrain streaming and not render some of your terrain models, as it wouldn't follow the path of your stage. To disable stage guide path, you can simply remove the <code>.path.xml</code> file or set <code>g_UseGuidePath</code> in <code>Terrain.prm.xml</code> to <code>false</code>.

==== 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-02T18:03:13Z

Skyth:

{{Notice|type=info|content=This page covers both Sonic Generations and Sonic Unleashed. Game-specific explanations will be indicated by the game name in parentheses. If no game is specified, the explanation applies to both games.}}

== Common Issues ==

=== 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.

=== Rainbow Flashing Textures (Sonic Generations) ===
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'''.

=== 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. Use <code>BC3</code>/<code>DXT5</code> instead.

=== Missing Terrain Models ===
<code>Terrain.prm.xml</code> likely requires memory sizes to be higher.

==== Sonic Generations ====
Under <code>DynamicLoad</code> and <code>Terrain-Model</code>, increase the <code>g_TerrainModelLimitSizeDefault</code> and <code>g_TerrainModelLimitSizeWin32</code> parameters to values like 100 or 250. The unit of the value is MB. Make sure to use sensible values as absurd values like 999999999 are not going to work correctly.

==== Sonic Unleashed ====
Under <code>DynamicLoad</code> and <code>Terrain-Model</code>, increase the <code>g_LimitSize</code> to values like 100000000 or 250000000. The unit of the value is byte. 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 (Sonic Unleashed) ===
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.

=== Red Materials (Sonic Generations) ===
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.

=== Invisible Materials (Sonic Unleashed) ===
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.

==== Sonic Generations ====
Under <code>DynamicLoad</code> and <code>GI-Texture</code>, increase the <code>g_GITextureLimitSizeDefault</code> and <code>g_GITextureLimitSizeWin32</code> parameters to values like 100 or 250. The unit of the value is MB. Make sure to use sensible values as absurd values like 999999999 are not going to work correctly.

==== Sonic Unleashed ====
Under <code>DynamicLoad</code> and <code>GI-Texture</code>, increase the <code>g_LimitSize</code> to values like 100000000 or 250000000. The unit of the value is byte. Make sure to use sensible values as absurd values like 999999999999 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.

=== 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.

== Common Crash or Infinite Loading Reasons ==

=== 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.

=== Incorrect Material Format (Sonic Unleashed) ===
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.

=== 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.

=== Unloaded Sonic Animations (Sonic Generations) ===
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>

=== 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

2025-05-02T17:59:56Z

Skyth:

== 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]]
* [[Troubleshooting Custom Level Issues in Sonic Generations/Sonic Unleashed|Troubleshooting]]

== 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]]

Troubleshooting Custom Level Issues in Sonic Generations

2025-05-02T17:59:39Z

Skyth: Skyth moved page Troubleshooting Custom Level Issues in Sonic Generations to Troubleshooting Custom Level Issues in Sonic Generations/Sonic Unleashed: Guide now mentions both Sonic Unleashed and Sonic Generations.

#REDIRECT [[Troubleshooting Custom Level Issues in Sonic Generations/Sonic Unleashed]]

Troubleshooting Custom Level Issues in Sonic Generations/Sonic Unleashed

2025-05-02T17:59:38Z

{{Notice|type=info|content=This page covers both Sonic Generations and Sonic Unleashed. Game-specific explanations will be indicated by the game name in parentheses. If no game is specified, the explanation applies to both games.}}

== Common Issues ==

=== 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.

=== Rainbow Flashing Textures (Sonic Generations) ===
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'''.

=== 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. Use <code>BC3</code>/<code>DXT5</code> instead.

=== Missing Terrain Models ===
<code>Terrain.prm.xml</code> likely requires memory sizes to be higher.

==== Sonic Generations ====
Under <code>DynamicLoad</code> and <code>Terrain-Model</code>, increase the <code>g_TerrainModelLimitSizeDefault</code> and <code>g_TerrainModelLimitSizeWin32</code> parameters to values like 100 or 250. The unit of the value is MB. Make sure to use sensible values as absurd values like 999999999 are not going to work correctly.

==== Sonic Unleashed ====
Under <code>DynamicLoad</code> and <code>Terrain-Model</code>, increase the <code>g_LimitSize</code> to values like 100000000 or 250000000. The unit of the value is byte. 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 (Sonic Unleashed) ===
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.

=== Red Materials (Sonic Generations) ===
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.

=== Invisible Materials (Sonic Unleashed) ===
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.

==== Sonic Generations ====
Under <code>DynamicLoad</code> and <code>GI-Texture</code>, increase the <code>g_GITextureLimitSizeDefault</code> and <code>g_GITextureLimitSizeWin32</code> parameters to values like 100 or 250. The unit of the value is MB. Make sure to use sensible values as absurd values like 999999999 are not going to work correctly.

==== Sonic Unleashed ====
Under <code>DynamicLoad</code> and <code>GI-Texture</code>, increase the <code>g_LimitSize</code> to values like 100000000 or 250000000. The unit of the value is byte. Make sure to use sensible values as absurd values like 999999999999 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.

=== 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.

== Common Crash or Infinite Loading Reasons ==

=== 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.

=== Incorrect Material Format (Sonic Unleashed) ===
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.

=== 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.

=== Unloaded Sonic Animations (Sonic Generations) ===
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>

=== 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.

Troubleshooting Custom Level Issues in Sonic Generations/Sonic Unleashed

2025-05-02T17:59:24Z

Skyth:

{{Notice|type=info|content=This page covers both Sonic Generations and Sonic Unleashed. Game-specific explanations will be indicated by the game name in parentheses. If no game is specified, the explanation applies to both games.}}

== Common Issues ==

=== 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.

=== Rainbow Flashing Textures (Sonic Generations) ===
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'''.

=== 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. Use <code>BC3</code>/<code>DXT5</code> instead.

=== Missing Terrain Models ===
<code>Terrain.prm.xml</code> likely requires memory sizes to be higher.

==== Sonic Generations ====
Under <code>DynamicLoad</code> and <code>Terrain-Model</code>, increase the <code>g_TerrainModelLimitSizeDefault</code> and <code>g_TerrainModelLimitSizeWin32</code> parameters to values like 100 or 250. The unit of the value is MB. Make sure to use sensible values as absurd values like 999999999 are not going to work correctly.

==== Sonic Unleashed ====
Under <code>DynamicLoad</code> and <code>Terrain-Model</code>, increase the <code>g_LimitSize</code> to values like 100000000 or 250000000. The unit of the value is byte. 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 (Sonic Unleashed) ===
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.

=== Red Materials (Sonic Generations) ===
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.

=== Invisible Materials (Sonic Unleashed) ===
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.

==== Sonic Generations ====
Under <code>DynamicLoad</code> and <code>GI-Texture</code>, increase the <code>g_GITextureLimitSizeDefault</code> and <code>g_GITextureLimitSizeWin32</code> parameters to values like 100 or 250. The unit of the value is MB. Make sure to use sensible values as absurd values like 999999999 are not going to work correctly.

==== Sonic Unleashed ====
Under <code>DynamicLoad</code> and <code>GI-Texture</code>, increase the <code>g_LimitSize</code> to values like 100000000 or 250000000. The unit of the value is byte. Make sure to use sensible values as absurd values like 999999999999 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.

=== 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.

== Common Crash or Infinite Loading Reasons ==

=== 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.

=== Incorrect Material Format (Sonic Unleashed) ===
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.

=== 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.

=== Unloaded Sonic Animations (Sonic Generations) ===
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>

=== 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.

How To Import Custom Terrain in Sonic Generations/Sonic Unleashed

2025-05-02T16:15:13Z

Skyth:

How To Import Custom Terrain in Sonic Generations/Sonic Unleashed

2025-05-02T16:12:17Z

Skyth:

{{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>
{{Notice|type=warn|content=When converting for Sonic Unleashed, Hedgehog Converter saves <code>.ar</code> files by navigating two levels up from the '''Terrain output directory'''. For example, if you pick <code>C:\folder1\folder2\ActD_MykonosAct1</code>, the <code>.ar</code> files will be saved to <code>folder1</code>.

To avoid confusion or misplaced files, it’s strongly recommended to follow the original <code>Packed</code> folder structure used by the game in your mod directory.}}

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.

The materials of your skybox need to be assigned to sky shaders such as <code>Sky_d</code>, otherwise they will not appear in-game correctly. You can assign the shaders by loading the model in SonicGLvl's material editor under '''Materials'''. After changing the shaders, you can save the materials by saving the model from the material editor.

=== 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/stageID.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 Terrain in Sonic Generations/Sonic Unleashed

2025-05-02T16:04:26Z

Skyth:

{{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>
{{Notice|type=warn|content=When converting for Sonic Unleashed, Hedgehog Converter saves <code>.ar</code> files by navigating two levels up from the '''Terrain output directory'''. For example, if you pick <code>C:\folder1\folder2\ActD_MykonosAct1</code>, the <code>.ar</code> files will be saved to <code>folder1</code>.

To avoid confusion or misplaced files, it’s strongly recommended to follow the original <code>Packed</code> folder structure used by the game in your mod directory.}}

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/stageID.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-02T15:55:44Z

Skyth:

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

== 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 Terrain in Sonic Generations/Sonic Unleashed

2025-05-02T15:50:27Z

Skyth:

{{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>
{{Notice|type=warn|content=When converting for Sonic Unleashed, Hedgehog Converter saves <code>.ar</code> files by navigating two levels up from the '''Terrain output directory'''. For example, if you pick <code>C:\folder1\folder2\ActD_MykonosAct1</code>, the <code>.ar</code> files will be saved to <code>folder1</code>.

To avoid confusion or misplaced files, it’s strongly recommended to follow the original <code>Packed</code> folder structure used by the game in your mod directory.}}

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 Use Sonic GLvl with Sonic Unleashed

2025-05-02T15:36:31Z

Skyth:

{{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]]
* [[HedgeArcPack]]}}

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.

Note that if you simply want to view the levels in SonicGLvl without making any changes, opening them from the base game files is fine. This advice is for when you want to make modifications to the level.

== 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. [[HedgeArcPack]] can be used to directly extract the archives to the resources folder.

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:50:17Z

Skyth:

{{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]]
* [[HedgeArcPack]]}}

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. [[HedgeArcPack]] can be used to directly extract the archives to the resources folder.

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 Import Custom Terrain in Sonic Generations/Sonic Unleashed

2025-05-02T13:46:01Z

Skyth:

{{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 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 Terrain in Sonic Generations/Sonic Unleashed

2025-05-02T13:35:07Z

Skyth:

{{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>This concludes this guide. 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]].

Sonic Unleashed

2025-05-02T13:29:23Z

Skyth:

== 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]]
* [[Unleashed-Generations Havok Collision Attributes|Havok Collision Attributes]]

== Discoveries ==

=== PlayStation 3 ===

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

How To Import Custom Collision in Sonic Generations

2025-05-02T13:28:57Z

Skyth: Skyth moved page How To Import Custom Collision in Sonic Generations to How To Import Custom Collision in Sonic Generations/Sonic Unleashed: Guide now mentions both Sonic Unleashed and Sonic Generations.

#REDIRECT [[How To Import Custom Collision in Sonic Generations/Sonic Unleashed]]

How To Import Custom Collision in Sonic Generations/Sonic Unleashed

2025-05-02T13:28:57Z

{{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 a collision, we still recommend that you create a separate project/model for it, even if it's a copy of it.

It is possible to specify tags for your collision, which control the type of collision it has. For this, you'll need a special INI file for Havok Converter with tags. You can download it [https://gist.github.com/TheExentist151/8e4896b807d49cd86ff2b643d34c7aa2 here]. To apply these tags to your collision model, you can simply rename the meshes and add the tag as a prefix to its 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 its 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:28:45Z

Skyth:

Sonic Unleashed

2025-05-02T13:01:49Z

Skyth:

How To Import Custom Terrain in Sonic Generations

2025-05-02T13:00:41Z

Skyth: Skyth moved page How To Import Custom Terrain in Sonic Generations to How To Import Custom Terrain in Sonic Generations/Sonic Unleashed: Guide now mentions both Sonic Unleashed and Sonic Generations.

#REDIRECT [[How To Import Custom Terrain in Sonic Generations/Sonic Unleashed]]

How To Import Custom Terrain in Sonic Generations/Sonic Unleashed

2025-05-02T13:00:41Z

{{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>This concludes this guide. 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 here.

How To Import Custom Terrain in Sonic Generations/Sonic Unleashed

2025-05-02T12:59:45Z

Skyth: Updating with guides for Sonic Unleashed.

{{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>This concludes this guide. 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 here.

File:Hedgehog Converter Example.png

2025-05-02T12:12:52Z

Skyth:

Hedgehog Converter Example

File:Blender FBX Units Scale.png

2025-05-02T11:01:57Z

Skyth:

Image showing the FBX Units Scale setting for Blender FBX Export window.

Ar0pack-ar0unpack

2025-04-28T13:33:17Z

Skyth:

{{Notice|type=warn|content=This page is unfinished.}}{{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]].

{{Notice|type=warn|content=This tool cannot extract Xbox compressed archives. For such archives, please use the latest version of [[HedgeArcPack]] instead.}}

Ar0pack-ar0unpack

2025-04-28T13:32:51Z

Skyth:

How To Use Sonic GLvl with Sonic Unleashed

2025-04-27T12:34:16Z

Skyth:

{{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]]}}

Latest [[SonicGLvl]] now can 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 [[Sonic Unleashed Stage IDs|stage IDs]] to find the level 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.}}

How To Use Sonic GLvl with Sonic Unleashed

2025-04-27T12:30:54Z

Skyth:

{{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]]}}

Latest [[SonicGLvl]] now can 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 [[Sonic Unleashed Stage IDs|stage IDs]] to find the level 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}}

How To Use Sonic GLvl with Sonic Unleashed

2025-04-27T12:30:23Z

Skyth:

{{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]]}}

Latest [[SonicGLvl]] now can 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 [[Sonic Unleashed Stage IDs|stage IDs]] to find the level 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", 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}}

Tools

2025-04-27T11:45:07Z

Skyth:

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]]

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

=== 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]]

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

Model Converter

2025-04-27T11:44:28Z

Skyth: Created page with "{{ToolInfobox|title=Model Converter|author=Skyth|website=https://github.com/blueskythlikesclouds/ModelConverter|download=https://github.com/blueskythlikesclouds/ModelConverter/releases}} Model Converter is a tool that converts 3D model formats like FBX to Hedgehog Engine .model files."

{{ToolInfobox|title=Model Converter|author=Skyth|website=https://github.com/blueskythlikesclouds/ModelConverter|download=https://github.com/blueskythlikesclouds/ModelConverter/releases}}

Model Converter is a tool that converts 3D model formats like FBX to Hedgehog Engine .model files.

Havok Animation Exporter

2025-04-27T11:43:03Z

Skyth: Created page with "{{ToolInfobox|title=Havok Animation Exporter|author=Skyth|website=https://github.com/blueskythlikesclouds/HavokAnimationExporter|download=https://github.com/blueskythlikesclouds/HavokAnimationExporter/releases}} Havok Animation Exporter is a tool that allows you to generate skeleton and animation data for Sonic games that use Havok."

{{ToolInfobox|title=Havok Animation Exporter|author=Skyth|website=https://github.com/blueskythlikesclouds/HavokAnimationExporter|download=https://github.com/blueskythlikesclouds/HavokAnimationExporter/releases}}

Havok Animation Exporter is a tool that allows you to generate skeleton and animation data for Sonic games that use Havok.

Tools

2025-04-27T11:42:14Z

Skyth:

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]]

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

=== 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]]

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

Hedgehog Engine Blender I/O

2025-04-27T11:40:11Z

Skyth: Created page with "{{ToolInfobox|title=Hedgehog Engine Blender I/O|author=Justin113D|website=https://hedge-dev.github.io/HedgehogEngineBlenderIO/index.html}} The Hedgehog Engine Blender I/O Addon, short “'''HEIO'''”, is an addon for Blender, adding the ability to import and export 3D related file formats used by Hedgehog Engine and Hedgehog Engine 2 games."

{{ToolInfobox|title=Hedgehog Engine Blender I/O|author=Justin113D|website=https://hedge-dev.github.io/HedgehogEngineBlenderIO/index.html}}

The Hedgehog Engine Blender I/O Addon, short “'''HEIO'''”, is an addon for Blender, adding the ability to import and export 3D related file formats used by Hedgehog Engine and Hedgehog Engine 2 games.

Tools

2025-04-27T11:38:33Z

Skyth:

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)
* [[HavokAnimationExporter]] (.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]]

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

=== 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]]

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

Tools

2025-04-27T11:38:11Z

Skyth:

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)
* [[HavokAnimationExporter]] (.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]]

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

=== Models ===

* [[Hedgehog Engine I/O|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]]

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

Tools

2025-04-27T11:35:05Z

Skyth:

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)
* [[HavokAnimationExporter]] (.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]]

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

=== Models ===

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

=== Terrain ===

* [[Hedgehog Converter]]

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

Troubleshooting Custom Level Issues in Sonic Generations/Sonic Unleashed

2025-04-27T11:24:57Z

Skyth:

== Common Issues ==

=== Black Textures ===
Textures must have power of two resolutions. For example, 512x512, 1024x1024, 2048x4096, etc. An arbitrary resolution like 600x600 is not supported by the game when using compressed textures.

=== Rainbow Flashing Textures ===
The game shows a rainbow flashing texture if the texture assigned to a material is missing. Ensure you included the texture in the AR and didn't make a typo in the material.

=== Randomly Switching Textures ===
The material might not have any textures assigned at all. You need to at least assign one diffuse texture, otherwise the game is going to use the texture of whatever was rendered last.

=== Missing Transparency On Textures ===

* You might need <code>@LYR(trans)</code> or <code>@LYR(punch)</code> tags on your material names. See terrain importing guide for more information.
* Your texture might be compressed using <code>BC1</code>/<code>DXT1</code> format. This format does not support alpha channels. For transparent textures, use the <code>BC3</code>/<code>DXT5</code> compression format instead.

=== Missing Terrain Models ===

* <code>Terrain.prm.xml</code> file might require higher memory sizes. Look for the <code>g_TerrainModelLimitSizeDefault</code> and <code>g_TerrainModelLimitSizeWin32</code> parameters, and increase them. If your stage requires more memory than what is defined in this file, some of your models might not render.
** Do not increase these values too much! The values are represented in MB, and inputting insane values like 99999999 won't allow the game to parse the value correctly. Start small like 100 or 250 MB.
* There is a limit of 8192 instances in the game. If you are trying to render more instances, the game is going to hit this limit and stop rendering.
* Material files might be missing. There is a chance it might not crash and display nothing instead.
* You might have a <code>visibility-tree.vt</code> file leftover from another level in your files. This file controls occlusion culling, and it needs to be created specifically for the level it's used in. Remove this file to solve potential pop-in problems.
** Similarly, if you are porting a level from Sonic Unleashed to Sonic Generations or vice versa, you might experience issues if your set object cameras don't exactly match with the original game. If they do, you can safely keep this file.

=== Red Materials ===
The game fallbacks to displaying a red emissive material if the shader assigned to a material does not exist. If you want to see every available shader in the game, unpack <code>shader_r_add.ar.00</code> located inside <code>bb3.cpk</code>, and look for files with <code>.shader-list</code> extension.

=== Low Quality or Missing GI Textures ===
<code>Terrain.prm.xml</code> file might require higher memory sizes. Look for the <code>g_GITextureLimitSizeDefault</code> and <code>g_GITextureLimitSizeWin32</code> parameters, and increase them.

Do not increase these values too much! The values are represented in MB, and inputting insane values like 99999999 won't allow the game to parse the value correctly. Start small like 100 or 250 MB.

=== Missing Direct Light ===
If you add a new direct light with a different name, you need to edit <code>Terrain.stg.xml</code> to make the stage use it. For example:<syntaxhighlight lang="xml">
<Light>
<DataName>MyDirectLight</DataName>
</Light>
</syntaxhighlight>

=== Missing Sky Model ===
If you add a new sky model with a different name, you need to edit <code>Terrain.stg.xml</code> to make the stage use it. For example:<syntaxhighlight lang="xml">
<Sky>
<Model>MySkyModel</Model>
</Sky>
</syntaxhighlight>Ensure that the materials of the sky model also use sky shaders such as <code>Sky_d</code>.

=== Enemies From Other Stages Not Appearing ===
Certain enemies are loaded manually in stages to save memory. If an enemy does not appear in your stage, you can fix it 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>, which allows 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>

== Common Crash Reasons ==

=== Missing Material Files ===
Unlike later games, missing materials can cause a crash in Sonic Generations and Sonic Unleashed.

=== Periods in File Names ===
Having periods in your file names can confuse the game and cause crashes. For example, having a material named <code>Material.000.material</code> would make the game think the file has a <code>.000.material</code> extension, and not recognize it as a material file.

=== 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.

=== 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>

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

Sonic Unleashed Stage IDs

2025-04-24T12:05:07Z

Skyth:

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.}}

== Country ==
{| class="wikitable"
|+
!Country
!ID
|-
|Apotos
|Mykonos
|-
|Mazuri
|Africa
|-
|Spagonia
|EU / EuropeanCity
|-
|Chun-Nan
|China
|-
|Holoska
|Snow
|-
|Shamar
|Petra
|-
|Empire City
|NY / NYCity
|-
|Adabat
|Beach / SouthEastAsia
|}

== 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_03
|X
|ActN_PetraEvil
|-
|Arid Sands Act 3
|ActN_SubPetra_02
|X
|
|-
|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.
|}

How To Use Sonic GLvl with Sonic Unleashed

2025-04-24T11:55:57Z

Skyth:

How To Use Sonic GLvl with Sonic Unleashed

2025-04-24T11:52:04Z

Skyth:

Sonic Generations

2025-04-24T11:29:00Z

Skyth: The tool is called SonicGLvl, not Sonic GLvl.

== Tools ==

=== Animation ===
* [[evsxml]] (.evs)

=== Lighting ===
* [[cropGIA]]
* [[SeparateGIA]]

=== Collision ===
* [[Collision2fbx (Sonic Generations)|collision2fbx]] (.phy.hkx)

=== Models ===
* [[Unleashed2Generations]] (*.model / *.terrain-model / *.material)
* [[slwModel2Gens]] (*.model)
* [[TuringFixer]]

=== Stages ===
* [[TransformGensStage]]
* [[SonicGLvl]]

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

=== Other ===
* [[BscPack]]

== Guides ==

=== Level Editing ===

* [[How To Use Sonic GLvl with Sonic Generations|SonicGLvl]]
* [[How To Import Custom Terrain in Sonic Generations|Importing Terrain]]
* [[How To Import Custom Collision in Sonic Generations|Importing Collision]]
* [[How To Specify Custom Rank Times for Sonic Generations|Custom Rank Times]]
* [[Troubleshooting Custom Level Issues in Sonic Generations|Troubleshooting]]

== Documentation ==

* [[Sonic Generations Stage IDs|Stage IDs]]
* [[Sonic Generations Event List|Set Object Event List]]
* [[Sonic Generations Camera Types|Camera Types]]
* [[Unleashed-Generations Havok Collision Attributes|Havok Collision Attributes]]
* [[Sound File Locations]]

== Discoveries ==

=== Common (2011/2024) ===

==== HUD ====

* [[Unused Time Eater Gauge]]

==== Code ====

* [[Leftover code from Unleashed in Generations|Unleashed Leftovers]]

=== 2024 ===

==== Stages ====

* [[TestCourse]]

Sonic Generations

2025-04-24T11:28:35Z

Skyth: This tool has been obsolete for a decade.

== Tools ==

=== Animation ===
* [[evsxml]] (.evs)

=== Lighting ===
* [[cropGIA]]
* [[SeparateGIA]]

=== Collision ===
* [[Collision2fbx (Sonic Generations)|collision2fbx]] (.phy.hkx)

=== Models ===
* [[Unleashed2Generations]] (*.model / *.terrain-model / *.material)
* [[slwModel2Gens]] (*.model)
* [[TuringFixer]]

=== Stages ===
* [[TransformGensStage]]
* [[SonicGLvl]]

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

=== Other ===
* [[BscPack]]

== Guides ==

=== Level Editing ===

* [[How To Use Sonic GLvl with Sonic Generations|Sonic GLvl]]
* [[How To Import Custom Terrain in Sonic Generations|Importing Terrain]]
* [[How To Import Custom Collision in Sonic Generations|Importing Collision]]
* [[How To Specify Custom Rank Times for Sonic Generations|Custom Rank Times]]
* [[Troubleshooting Custom Level Issues in Sonic Generations|Troubleshooting]]

== Documentation ==

* [[Sonic Generations Stage IDs|Stage IDs]]
* [[Sonic Generations Event List|Set Object Event List]]
* [[Sonic Generations Camera Types|Camera Types]]
* [[Unleashed-Generations Havok Collision Attributes|Havok Collision Attributes]]
* [[Sound File Locations]]

== Discoveries ==

=== Common (2011/2024) ===

==== HUD ====

* [[Unused Time Eater Gauge]]

==== Code ====

* [[Leftover code from Unleashed in Generations|Unleashed Leftovers]]

=== 2024 ===

==== Stages ====

* [[TestCourse]]

Sonic Generations

2025-04-24T11:08:35Z

Skyth:

== Tools ==

=== Animation ===
* [[evsxml]] (.evs)

=== Lighting ===
* [[cropGIA]]
* [[SeparateGIA]]
* [[FxPipelineResolutionChanger]]

=== Collision ===
* [[Collision2fbx (Sonic Generations)|collision2fbx]] (.phy.hkx)

=== Models ===
* [[Unleashed2Generations]] (*.model / *.terrain-model / *.material)
* [[slwModel2Gens]] (*.model)
* [[TuringFixer]]

=== Stages ===
* [[TransformGensStage]]
* [[SonicGLvl]]

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

=== Other ===
* [[BscPack]]

== Guides ==

=== Level Editing ===

* [[How To Use Sonic GLvl with Sonic Generations|Sonic GLvl]]
* [[How To Import Custom Terrain in Sonic Generations|Importing Terrain]]
* [[How To Import Custom Collision in Sonic Generations|Importing Collision]]
* [[How To Specify Custom Rank Times for Sonic Generations|Custom Rank Times]]
* [[Troubleshooting Custom Level Issues in Sonic Generations|Troubleshooting]]

== Documentation ==

* [[Sonic Generations Stage IDs|Stage IDs]]
* [[Sonic Generations Event List|Set Object Event List]]
* [[Sonic Generations Camera Types|Camera Types]]
* [[Unleashed-Generations Havok Collision Attributes|Havok Collision Attributes]]
* [[Sound File Locations]]

== Discoveries ==

=== Common (2011/2024) ===

==== HUD ====

* [[Unused Time Eater Gauge]]

==== Code ====

* [[Leftover code from Unleashed in Generations|Unleashed Leftovers]]

=== 2024 ===

==== Stages ====

* [[TestCourse]]

How To Use Sonic GLvl with Sonic '06

2025-04-24T11:08:30Z

Skyth:

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

* [[SonicGLvl]]
* [[Sonic '06 Stage Editing Archive]]
* Sonic '06 GLvl Converter (included with Sonic '06 Stage Editing Archive)}}{{Notice|type=note|content=Due to a lack of an actual, dedicated level editor for Sonic '06, we (at the time of writing) use a hacked together solution that allows us to use Sonic GLvl as a stand in. This guide will explain how to set up GLvl for this purpose, with the assumption that the user understands basic usage of the program itself.}}

== Setting Up ==
Download your preferred version of Sonic GLvl 0.9 and extract the repository to any location. Then, open the database folder and delete the <code>objects</code> folder. Next, download the [[Sonic '06 Stage Editing Archive]] and extract the <code>SonicGLvl/database</code> folder to your SonicGLvl location, choosing to merge/replace existing files.

== Converting Stage Terrain ==
Pre converted copies of the actual Sonic '06 stages are present on the Stage Editing Archive repository (under the <code>SonicGLvl/import</code> directory). When converting your own terrain (such as for a stage mod) the process is almost identical to the conversion process for Sonic Generations (it's recommended to use the two <code>#base</code> files as a template). The crucial step is to remember to set the stage scale in HedgehogConverter to 1% on all three axis, as the scale does not match between both games.

== Usage ==
The process of placing and editing objects at this point follows the workflow of using Sonic GLvl for a Generations stage mod, so will not be covered here.

== Groups ==
Objects in '06 make frequent usage of grouping, allowing objects to influence each other in some way (such as an Egg Chaser commanding a squad of Egg Liners or defeating an enemy unlocking a cage). To set these up, create an XML in your stage's cache directory called <code>groupdata_[x].group.xml</code> (where [x] is a name, such as <code>base</code>). Then lay them out as shown below.
[[File:Sonic 2006 Object Groups.png|center|thumb|913x913px]]
Each <Group> key is... Well... A Group that will be compiled into the converted SET.

The <Name> key seems to just be for identification, so here (for Ocean Palace) I called it <code>CageGroup01</code> as it was the first group I made that unlocked a cage.

The <Type> key is the name of the lua event that this group will activate, this key can be left empty if the group doesn't need to activate anything. In this example, it's called Cage01, so it will fire the event called Cage01 in the stage's lua file; which, as you can probably guess, signalled a cage to open.

The <ObjectCount> key simply lists how many objects this group has (and honestly shouldn't have even been a thing, but I wrote this thing incredibly badly).

The subkeys within the <ObjectIDs> key simply give the ID of an object that should be in this group. These IDs are shown in the conversion log, and are also patched into the Generations SET if the <code>Patch Generations SET</code> option is used in the Converter (see below).

== '06 SET Conversion ==
[[File:Sonic 2006 GLvl Converter.png|center|thumb|668x668px]]
For converting between Generations and '06, we use the GLvl Converter. In the Source SET, select your Generations <code>.set.xml</code> file from your stage's cache directory in your GLvl location (will be named <code>setdata_base.set.xml</code> by default). If you've created any groups for your object layout (which need to be made manually, see above), then select the approriate <code>groupdata_[x].group.xml</code> file for the Groups XML option, otherwise, leave it blank.

For the GLvl Templates, select the <code>database\objects</code> folder.

Target SET is simply where you want to save the converted object placement to.

Filtered Object Names will prevent the <code>Replace Object Names</code> option from overwriting objects that have any of the inputted values as part of their names. This object is useful for group events where you're activating an object by its name.

This converter can also convert from '06 to Generations by simply putting an '06 <code>.set</code> file as the source and a Generations <code>.set.xml</code> as the target. This can also convert '06 groups into an XML if a Groups XML path is specified.

Due to how Sonic GLvl handles object IDs, they will often not match with the IDs that '06 uses. To correct this, choose the <code>Patch Generations SET</code> option, which will update the Generations <code>.set.xml</code> to show the correct IDs.