deep-delta

[image: DeepDeltaLogo_1024x484]

A Luau library that serializes nested table diffs into buffers. Similar to DeltaCompress, but supporting nested tables. Future updates to improve compression size are likely.

Available on Wally

API

DeepDelta.clone(tab: T): T

Deep clones a table, usually used to save a snapshot of old data before diffing or applying.

-- Server
local oldData = DeepDelta.clone(data)
mutateData(data)
local diff = DeepDelta.diff(data, oldData)

-- Client
local oldData = DeepDelta.clone(data)
local deltas = DeepDelta.apply(data, diff, deltas)
DataChanged:Fire(data, oldData, deltas)

---

DeepDelta.diff(new: T, old: table): (buffer, T)

Serializes the deep delta between two tables into a buffer for applying to a table later and returns a new table representing the delta between them. Useful for validating if a change has occurred down-the-chain.

local oldData = DeepDelta.clone(data)

data.money -= 10

local row = math.random(1, #data.loot)
table.insert(data.loot[row], {
	rarity = "rare",
	duration = 300, -- seconds
})

local diff, deltas = DeepDelta.diff(data, oldData)
DataUpdated:Fire(diff)

---

DeepDelta.apply(target: table, diff: buffer)

Applies a previously serialized deep delta diff to a table.

local oldData = DeepDelta.clone(data)
local deltas = DeepDelta.apply(data, diff)
DataChanged:Fire(data, oldData, deltas)