protocol

@mcbe-mods/protocol

bedrock:// transport layer for Minecraft Bedrock Edition Script API.

Wraps system.sendScriptEvent and scriptEventReceive into a simple Pub/Sub API.

Install

npm install @mcbe-mods/protocol

Usage

Plain text

import { Protocol } from '@mcbe-mods/protocol'

const protocol = new Protocol()

// Subscribe to incoming messages
const unsubscribe = protocol.on((event) => {
  event.url // BedrockURL
  event.message // string payload
  event.sourceType // 'Server' | 'Client' | 'Other'
})

// Send a message
protocol.post('bedrock://my-addon/info', 'hello')
protocol.get('bedrock://my-addon/ping')

// Cleanup
unsubscribe()
protocol.dispose()

Encrypted

import { Protocol } from '@mcbe-mods/protocol'

// Pass any encrypt/decrypt function pair (pure JS required — no atob/btoa in QuickJS)
const protocol = new Protocol({
  cipher: {
    encrypt(s: string) {
      return [...s].map(c => (c.charCodeAt(0) ^ 0x55).toString(16).padStart(2, '0')).join('')
    },
    decrypt(s: string) {
      return String.fromCharCode(...s.match(/.{2}/g)!.map(b => Number.parseInt(b, 16) ^ 0x55))
    },
  },
})

protocol.post('bedrock://secret/cmd', 'hello') // automatically encrypted
protocol.on((event) => {
  event.message // automatically decrypted
})

The cipher interface is protocol-agnostic — you can use any pure-JS encryption library (such as @noble/ciphers, tweetnacl, or your own implementation).

Messages that fail decryption are silently dropped, preventing untrusted scripts in the same world from injecting forged payloads.

License

MIT