crypt.lz4compress

Compresses plaintext into the LZ4 Block format and returns the compressed bytes as a string.

crypt.lz4compress(plaintext: string): string

There is no header, no checksum, and no trailing size marker, so you have to remember (or store separately) the original byte length to decompress later.

Most commonly used to shrink a large JSON dump or serialized table before writing it to disk with writefile or sending it over request + base64encode.

Parameters

Parameter	Type	Description
plaintext	string	The data to compress.

Note: any byte value is allowed, including embedded zeros.

Returns

string - the compressed payload.

Aliases

• lz4compress

Example

In a chat-event-based Roblox game, stream Bad Apple as ASCII video over a remote at 30fps.
Reason: storing >1800 frames and parsing them would be a lot more easier if you compress the data beforehand.

Example 1

<<<<<<< HEAD
local lz4compress = crypt.lz4compress("Hello, world!")
=======
-- crypt.lz4compress(plaintext: string): string
>>>>>>> 50e30f53759b0538759af25c9b271514aa2c9290

Useful when saving large configs or sending massive data payloads.