Warning — GameBreaker is still under heavy, active development. Expect things to shift around often.

GameBreaker

GameMaker reverse-engineering tooling, done right.

---

GameBreaker is a GameMaker reverse-engineering and modding toolchain written in C# for .NET 6.

Taking into consideration previous projects' (subjective) successes and failures, GameBreaker intends to create a powerful, efficient, fast toolchain that makes reverse-engineering and modding GameMaker games significantly easier. GameBreaker considers programmatic capabilities to be a first-class priority. GameBreaker is designed and optimized around being used as a library, not as a UI application background. No officially-supported UI is currently planned.

Currently planned is a reliable deserialization and serialization system. If all goes well, decompilation- and compilation-related projects will undergo experimentation. A free (as in free speech and free beer) desktop runner exists in an idealistic future as well.

Examples

For a more detailed list of examples, see various usages in ./src/GameBreaker.Tests/ and ./GameBreaker.Examples/.

Simple deserialization of a GameMaker IFF file.

// The IChunkFileMetadata object helps to control differences in versions, so a specific class is not used as an example here.
var file = new GameMakerFile(new ChunkFileMetadata());
var stream = ...; // Any stream containing the bytes of the IFF file to deserialize will do.
var deserializer = new GmDataDeserializer(new GmReader(stream)); // Create a new deserializer encapsulating a reader that reads the IFF stream.

// Deserialize the IFF file. This encapsulates the deserialized data from the deserializer in the GameMakerFile (IChunkedFile instance).
file.Deserialize(deserializer);

Building

git clone https://github.com/steviegt6/gamebreaker
cd ./gamebreaker/src/
dotnet build Tomat.GameBreaker.sln -c Release

Licensing

GameBreaker utilizes research and code by myself and others, see COPYING.md for peoples' hard work and relevant software licenses.

Progress

• IFF/chunk library.
  • IFF/chunk abstractions.
    • Funamental layout.
    • Plan out extensibility structure to abstract away GameMaker-specific behavior.
  • Extensibility structure to abstract away GameMaker-specific behavior.
• Core (de)serialization library.
  • Core (de)serialization abstractions.
    • IGMSerializable + basic layout for handling deserializable data.
    • Plan out extensibility structure to abstract away version-dependent behavior.
  • Extensibility structure to abstract away version-dependent behavior.
• GMS modification library.
  • Chunk (de)serialization.
    • Proper version detection.
    • Account for conditional chunk padding.
    • GEN8 chunk.
      • Serialization.
      • Deserialization.
    • LANG chunk.
      • Serialization.
      • Deserialization.
    • EXTN chunk.
      • Serialization.
      • Deserialization.
    • STRG chunk.
      • Serialization.
      • Deserialization.
    • TPAG chunk.
      • Serialization.
      • Deserialization.
    • TXTR chunk.
      • Serialization.
      • Deserialization.
    • AGRP chunk.
      • Serialization.
      • Deserialization.
    • AUDO chunk.
      • Serialization.
      • Deserialization.
    • SONG chunk.
      • Serialization.
      • Deserialization.
    • BGND chunk.
      • Serialization.
      • Deserialization.
    • PATH chunk.
      • Serialization.
      • Deserialization.
    • EMBI chunk.
      • Serialization.
      • Deserialization.
    • DAFL chunk.
      • Serialization.
      • Deserialization.
    • TGIN chunk.
      • Serialization.
      • Deserialization.
    • FONT chunk.
      • Serialization.
      • Deserialization.
    • SPRT chunk.
      • Serialization.
      • Deserialization.
    • ACRV chunk.
      • Serialization.
      • Deserialization.
    • FUNC chunk.
      • Serialization.
      • Deserialization.
    • VARI chunk.
      • Serialization.
      • Deserialization.
    • SCPT chunk.
      • Serialization.
      • Deserialization.
    • TAGS chunk.
      • Serialization.
      • Deserialization.
    • ROOM chunk.
      • Serialization.
      • Deserialization.
    • OBJT chunk.
      • Serialization.
      • Deserialization.
    • TMLN chunk.
      • Serialization.
      • Deserialization.
    • GLOB chunk.
      • Serialization.
      • Deserialization.
    • GMEN chunk.
      • Serialization.
      • Deserialization.
    • SHDR chunk.
      • Serialization.
      • Deserialization.
    • CODE chunk.
      • Serialization.
      • Deserialization.
    • SEQN chunk.
      • Serialization.
      • Deserialization.
    • FEDS chunk.
      • Serialization.
      • Deserialization.
    • FEAT chunk.
      • Serialization.
      • Deserialization.