KwasTools (Hedgehog Engine): Difference between revisions

Latest revision as of 19:25, 10 May 2025

KwasTools

Author(s)	Kwasior
Website

KwasTools is a set of utilities for several games. Notably it contains tools to view and edit Hedgehog Engine *-anim family of formats and CRIWARE formats. A Blender addon called io_kwastools also exists for real-time preview and editing .cam-anim and .uv-anim files.

Entire suite of tools supports Windows and GNU/Linux operating systems.

Software

he_anim_tool

he_anim_tool is a tool for modifying animation files native to the Hedgehog Engine 1 and 2.

Any given *-anim will be converted to its XML representation. Same goes for XML files - tool will know the output format thanks to root element's name (XML identifier).

Supported formats
Format	Description	XML identifier
`.uv-anim`	Translation (v2), rotation and scaling (v3) of a texture in the material	`UVAnimation`
`.cam-anim`	Full control of in-game camera during events	`CAMAnimation`
`.vis-anim`	Visibility of the mesh	`VISAnimation`
`.morph-anim`	Animation of shape keys (Sonic's mouth in Unleashed/Generations uses this to speak)	`MORPHAnimation`
`.pt-anim`	Texture swapping (Tokyo DLC in Shadow Generations uses this for the billboard)	`PTAnimation`
`.mat-anim`	Transformation of a material (like swapping Sonic's mouth left-to-right)	`MATAnimation`
`.lit-anim`	Companion to `.light` files. Can animate its fields.	`LITAnimation`

cri_awb_tool

Unpacker and packer for AWB audio archives. Does not support decrypting data (will extract contents as-is).

Extracts an AWB to a folder and writes an XML file with its metadata.

Creates an AWB from a folder of files (with default values) or from an XML descriptor.

cri_utf_tool

Multi-purpose tool for editing CRIWARE @UTF tables. Created for modification of .acb files, but will work fine with tables from other formats, such as .acf, .cpk, .aax, .usm or .csb.

In addition to @UTF, program will also parse ACB commands (used for example for looping of Sonic Frontiers' Titan songs) and embedded AWB files (which allows for modding music and sounds without shipping entire corresponding AWB file).

@@ Line 1: / Line 1: @@
 {{ToolInfobox|title=KwasTools|author=Kwasior|website=https://github.com/ThisKwasior/KwasTools}}
-'''KwasTools''' is a set of utilities for several games, it contains tools to edit and examine CRIWARE formats and a [[wikipedia:Blender_(software)|Blender]] addon called '''[https://github.com/ThisKwasior/KwasTools/tree/master/addons/blender/io_kwastools io_kwastools]''' to edit <code>.cam-anim</code> and <code>.uv-anim</code> files from Hedgehog Engine 1 and 2.
+'''KwasTools''' is a set of utilities for several games. Notably it contains tools to view and edit Hedgehog Engine <code>*-anim</code> family of formats and CRIWARE formats. A [[wikipedia:Blender_(software)|Blender]] addon called '''[https://github.com/ThisKwasior/KwasTools/tree/master/addons/blender/io_kwastools io_kwastools]''' also exists for real-time preview and editing <code>.cam-anim</code> and <code>.uv-anim</code> files.
+Entire suite of tools supports Windows and GNU/Linux operating systems.
+== Software ==
+=== he_anim_tool ===
+[[File:KwasTools he anim tool usage.png|alt=he_anim_tool running without any arguments given to the program. By default, it prints supported file formats and how to use the software.|thumb|366x366px|Usage of <code>he_anim_tool</code>]] <code>he_anim_tool</code> is a tool for modifying animation files native to the Hedgehog Engine 1 and 2.
+Any given <code>*-anim</code> will be converted to its XML representation. Same goes for XML files - tool will know the output format thanks to root element's name (XML identifier).
+{| class="wikitable"
+|+
+Supported formats
+!Format
+!Description
+!XML identifier
+|-
+|<code>.uv-anim</code>
+|Translation (v2), rotation and scaling (v3) of a texture in the material
+|<code>UVAnimation</code>
+|-
+|<code>.cam-anim</code>
+|Full control of in-game camera during events
+|<code>CAMAnimation</code>
+|-
+|<code>.vis-anim</code>
+|Visibility of the mesh
+|<code>VISAnimation</code>
+|-
+|<code>.morph-anim</code>
+|Animation of shape keys (Sonic's mouth in Unleashed/Generations uses this to speak)
+|<code>MORPHAnimation</code>
+|-
+|<code>.pt-anim</code>
+|Texture swapping (Tokyo DLC in Shadow Generations uses this for the billboard)
+|<code>PTAnimation</code>
+|-
+|<code>.mat-anim</code>
+|Transformation of a material (like swapping Sonic's mouth left-to-right)
+|<code>MATAnimation</code>
+|-
+|<code>.lit-anim</code>
+|Companion to <code>.light</code> files. Can animate its fields.
+|<code>LITAnimation</code>
+|}
+=== cri_awb_tool ===
+Unpacker and packer for AWB audio archives. Does not support decrypting data (will extract contents as-is).
+Extracts an AWB to a folder and writes an XML file with its metadata.
+Creates an AWB from a folder of files (with default values) or from an XML descriptor.
+=== cri_utf_tool ===
+[[File:Example XML created by cri utf tool.png|alt=Converted bgm_miller.acb displayed in Notepad++ as an XML|left|thumb|385x385px|<code>bgm_miller.acb</code> converted to XML]]
+Multi-purpose tool for editing CRIWARE <code>@UTF</code> tables. Created for modification of <code>.acb</code> files, but will work fine with tables from other formats, such as <code>.acf</code>, <code>.cpk</code>, <code>.aax</code>, <code>.usm</code> or <code>.csb</code>.
+In addition to <code>@UTF</code>, program will also parse '''ACB commands''' (used for example for looping of '''Sonic Frontiers'''<nowiki/>' Titan songs) and embedded '''AWB files''' (which allows for modding music and sounds without shipping entire corresponding AWB file).