@mcbe-mods/compress

Deflate compression for Minecraft Bedrock Edition Script API.

Uses fflate/browser under the hood — pure JS, compatible with QuickJS (no TextEncoder/TextDecoder at runtime).

Install

npm install @mcbe-mods/compress

Usage

import { Compressor } from '@mcbe-mods/compress'

const c = new Compressor()

const original = `Hello, World!${'x'.repeat(500)}`
const compressed = c.compress(original)
// compressed is Base64-encoded deflated data, shorter than original

const decompressed = c.decompress(compressed)
// decompressed === original

With IPC

Compressor structurally matches the DataCompressor interface from @mcbe-mods/ipc — pass it directly as a compression plugin:

import { Compressor } from '@mcbe-mods/compress'
import { IPC } from '@mcbe-mods/ipc'

const ipc = new IPC({
  compress: new Compressor(),
  compressThreshold: 500,
})

API

| Method | Signature | Description | |--------|-----------|-------------| | compress | (data: string) => string | Deflate + Base64 encode | | decompress | (data: string) => string | Base64 decode + Inflate |

Implementation notes

• Uses deflateSync / inflateSync from fflate/browser (avoids Node's createRequire)
• Results are Base64-encoded via @mcbe-mods/utils for safe transport
• No compression threshold — the class always compresses. Threshold checking is delegated to the consumer (e.g. IPC's compressThreshold option)
• Unicode-safe via shared utf8Encode/utf8Decode from @mcbe-mods/utils

License

MIT