isledecomp/isle
1
0
Fork 0
mirror of https://github.com/isledecomp/isle.git synced 2026-02-02 13:11:15 +00:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity
d892f9beda
isle/docs/README.md
Christian Semmler d892f9beda
Some checks are pending
Analyze / ${{ matrix.who }} annotations (CONFIG) (push) Waiting to run
Details
Analyze / ${{ matrix.who }} annotations (ISLE) (push) Waiting to run
Details
Analyze / ${{ matrix.who }} annotations (LEGO1) (push) Waiting to run
Details
Build / Download original binaries (push) Waiting to run
Details
Build / Current ${{ matrix.toolchain.name }} (map[clang-tidy:true msys-env:mingw-w64-i686 msystem:mingw32 name:msys2 mingw32 shell:msys2 {0} werror:true]) (push) Waiting to run
Details
Build / Current ${{ matrix.toolchain.name }} (map[name:MSVC setup-cmake:true setup-msvc:true setup-ninja:true shell:sh]) (push) Waiting to run
Details
Build / MSVC 4.20 (push) Waiting to run
Details
Build / MSVC 4.20 (BETA10) (push) Waiting to run
Details
Build / Verify decomp (push) Blocked by required conditions
Details
Build / Upload artifacts (push) Blocked by required conditions
Details
Format / C++ (push) Waiting to run
Details
Naming / C++ (push) Waiting to run
Details
Add Kaitai Struct definition for animation files (.ani) (#1734) 
Add animation.ksy documenting the binary format for LEGO Island's
animation files, including keyframe data, actor references, and
optional camera animation. Includes sample file pns065rd.ani.
2026-01-30 18:05:48 -08:00

2.6 KiB
Raw Blame History

LEGO Island File Format Documentation

This folder contains documentation for LEGO Island's custom binary file formats using Kaitai Struct, a declarative language for describing binary data structures.

What is Kaitai Struct?

Kaitai Struct allows you to define binary formats in a YAML-based .ksy file, which can then be:

image

Documented Formats

File Extension Description
savegame.ksy .GS Main game save data (game state, progress, customizations)
players.ksy .gsi Player profile save data (usernames)
history.ksy .gsi Score history and high scores
animation.ksy .ani Animation data (keyframes, actor references, camera animation)

Using the Tools

Installation

See the Kaitai Struct Visualizer installation instructions for setup details.

Kaitai Struct Visualizer (ksv)

The Kaitai Struct Visualizer (ksv) provides an interactive terminal UI for exploring binary files.

# View a save game file
ksv samples/G0.GS savegame.ksy

# View a Players.gsi file
ksv samples/Players.gsi players.ksy

# View a History.gsi file
ksv samples/History.gsi history.ksy

# View an animation file
ksv samples/pns065rd.ani animation.ksy

Kaitai Struct Dump (ksdump)

ksdump outputs the parsed structure as JSON or YAML for scripting and inspection.

# Dump a save game to JSON
ksdump --format json samples/G0.GS savegame.ksy

# Dump Players.gsi to JSON
ksdump --format json samples/Players.gsi players.ksy

# Dump History.gsi to YAML
ksdump --format yaml samples/History.gsi history.ksy

# Dump an animation file to JSON
ksdump --format json samples/pns065rd.ani animation.ksy

Sample Files

The samples/ directory contains example files for testing:

  • G0.GS, G1.GS, G2.GS - Sample main game save files (slots 0, 1, 2)
  • Players.gsi - Sample player profile data
  • History.gsi - Sample score history data
  • pns065rd.ani - Sample animation file