Pattern Language

The Pattern Language is a C++ and Rust inspired DSL that was developed for the
ImHex Hex Editor to easily define and decode binary structures found in files or memory.

Getting Started

Before diving into the documentation, let's start with a simple example.

We have a file that follows this specification:

We start with a minimal definition and refine it step by step.

First, the basic structure. The file starts at 0x0, and the first 4 bytes are the number of animations in the file (count).

struct AnimationBank {
    u32 count;
};
 
AnimationBank animationBank @ 0x0;

Now that we know how many animations the file contains, we can define an array to store them.

struct Animation {
};
 
struct AnimationBank {
    u32 count;
    Animation animations[count];
};
 
AnimationBank animationBank @ 0x0;

Each Animation struct contains an offset, which defines the position of the AnimationEntry:

struct Animation {
    u32 offset;
};
 
struct AnimationBank {
    u32 count;
    Animation animations[count];
};
 
AnimationBank animationBank @ 0x0;

Through this offsets, we can read each AnimationEntry:

struct AnimationEntry {
};
 
struct Animation {
    u32 offset;
    AnimationEntry entry @ offset;
};
 
struct AnimationBank {
    u32 count;
    Animation animations[count];
};
 
AnimationBank animationBank @ 0x0;

With the offsets and entry in place, we can now define the actual contents of an AnimationEntry:

struct AnimationEntry {
    u8 index;
    u8 delay;
    u8 flags;
    u8 paletteIndex; 
};
 
struct Animation {
    u32 offset;
    AnimationEntry entries[parent.count] @ offset;
};
 
struct AnimationBank {
    u32 count;
    Animation animations[count];
};
 
AnimationBank animationBank @ 0x0;

Contributing

If you want to contribute towards improving this documentation, the source documents are available at https://github.com/WerWolv/Documentation under pattern_language.