HedgeLib

(Thanks to Gotta Play Fast for the wonderful project logo!)

IMPORTANT: All code committed to this repository, preferably, should follow these style guidelines.

HedgeLib is a C# library under the MIT license that aims to make modding games in the Sonic the Hedgehog franchise easier, similar to Dario’s excellent “LibGens”.

Right now it supports the following:

Havok

• Reading/Writing XML Havok data.

Hedgehog Engine

• Reading/Writing Lights.
• Reading/Writing Models.
• Reading/Writing Materials.

Sonic Forces

• Reading/Writing Gismos.
• Reading Archives.
• Reading/Writing Set Data.

Sonic Colors/Sonic Lost World

• Reading/Writing GISM files.
• Reading/Writing Set Data.
• Reading/Writing SNDL (SouND List) files.

Sonic Unleashed/Sonic Generations

• Reading/Writing Uncompressed Archives.
• Reading Set Data.
• Reading/Writing Terrain Groups.
• Reading/Writing Light Lists.
• Reading/Writing PFI Files.

Sonic '06

• Reading Archives.
• Reading/Writing Set Data.

Sonic Heroes/Shadow the Hedgehog

• Reading/Writing Uncompressed Archives.

Other

• Reading DDS Texures.
• Reading/Writing BINA headers/footers.

HedgeEdit

A level editor built with OpenTK/Winforms designed to carry much of the same functionality as “SonicGlvl”, but with support for a large number of games in the series, rather than just Generations.

Right now it’s a major WIP, though feel free to try it out!

HedgeTools

A collection of miscellaneous tools that utilize HedgeLib to allow editing a wide array of formats.

Right now this includes the following:

• Hedge Archive Packer

  • A Command Line tool that allows quick and powerful editing of archiving formats from all games HedgeLib supports.

• Hedge Archive Editor

  • A GUI tool that allows easy editing of archiving formats from all games HedgeLib supports.

• Hedge PFD

  • A Command Line tool that allows for quick packing of Generations/Unleashed PFD files and generation of their accompanying PFI files.

• Forces GISM Editor

  • A GUI tool that allows editing of the Forces GISM format (basically a “Gismo” used by a stage).

• Hedge GISM Editor

  • A GUI tool that allows editing of the Lost World GISM format (basically a list of “Gismos” used by a stage).

• Hedge Cnvrs Editor

  • A GUI tool that allows editing of the Forces CNVRS-TEXT format (basically a list of text used in different areas in the game e.g.: Loading Screen).

• Hedge SCFNT Converter

  • A Command Line tool that allows for conversion of OTF or TTF files into a SCFNT format.

Building

This repository uses AppVeyor to automatically build every commit! As such, you don’t have to manually build any of the tools/libraries in this repository if you simply want to try out the latest versions.

• Stable (release) builds
• Latest (development) builds

Manually building

If you do wish to manually build, however, all that’s required is the following:

• Visual Studio 2017 (or later).
• .NET Framework 4.6/4.7 (can be downloaded from Visual Studio).
• OpenTK, OpenTK.GLControl, and MoonSharp (these are all automatically downloaded as NuGet packages when HedgeEdit is first opened in Visual Studio).