Pancakes

High-performance binary serialization for Roblox Luau.

Pancakes serializes supported Luau values and Roblox datatypes into compact native buffer values. It provides automatic serialization, explicit schemas, SmartSchemas, custom converters, buffer utilities, runtime configuration, and malformed-buffer protection.

Installation

Wally

Add Pancakes to your wally.toml:

[dependencies]
Pancakes = "darkgamer/pancakes@1.0.0"

Then run:

wally install

pesde

pesde add darkgamer/pancakes

Ember

embr add darkgamer/pancakes

Basic usage

--!strict
local ReplicatedStorage = game:GetService("ReplicatedStorage")
local Pancakes = require(ReplicatedStorage.Packages.Pancakes)

local encoded: buffer = Pancakes.SerializeAuto({
    coins = 1250,
    name = "Pancake",
    equipped = true,
})

local decoded = Pancakes.DeserializeAuto(encoded)
print(decoded.coins)

Package layout

src/init.luau is the main module and src/Settings.luau is its child module. The included default.project.json maps the src directory as one Roblox ModuleScript package, so require(script.Settings) works after syncing.

Documentation

The complete static documentation site is in docs/. GitHub Actions deploys that directory directly to GitHub Pages on pushes to main.

Development

Run the repository consistency check before releasing:

python scripts/check_release.py

The check verifies that Wally, pesde, Ember, and the source BUILD_ID all use the same version.

License

MIT.