LAPLACE Event Bridge

A WebSocket bridge connecting LAPLACE Chat to clients

Monorepo Structure

This repository contains two packages:

• Server (packages/server): WebSocket server that routes events between LAPLACE Chat and clients
• SDK (packages/sdk): TypeScript/JavaScript client for connecting to the bridge
• Examples (examples/): Examples of how to use the SDK

Features

• Role-based connection system (server/client)
• Server-to-clients message broadcasting
• Token-based authentication
• Reconnection support

Requirements

• Bun v1.2.0 or higher

Installation

# Clone the repository
git clone https://github.com/laplace-live/event-bridge
cd event-bridge

# Install dependencies for all packages
bun install

Server Package

Configuration

There are multiple ways to configure the server:

Authentication

You can set authentication in order of precedence:

1. Environment variable: LEB_AUTH="your-secure-token"
2. Command line: --auth "your-secure-token"

Network Interface

Control which network interface the server listens on:

1. Environment variable: HOST="127.0.0.1"
2. Command line: --host 127.0.0.1

By default, the server listens on localhost.

Debug Mode

Enable detailed debug logging using:

1. Environment variable: DEBUG=1 or DEBUG=true
2. Command line: --debug

Usage

# Start the server in development mode
bun run dev:server

# Start the server in production mode
bun run start:server

# Start with CLI options
bun run start:server --debug --auth "your-secure-token" --host 0.0.0.0

The server runs on http://localhost:9696 by default.

SDK Package

The SDK provides a client for connecting to the event bridge.

Installation

# Install from npm
bun add @laplace.live/event-bridge-sdk

Usage

import { LaplaceEventClient } from '@laplace.live/event-bridge-sdk'

const client = new LaplaceEventClient({
  url: 'ws://localhost:9696',
  token: 'your-auth-token', // If auth is enabled
})

// Connect to the bridge
await client.connect()

// Listen for specific events
client.on('message', event => {
  console.log('Received message:', event)
})

// Listen for all events
client.onAny(event => {
  console.log('Received event:', event.type)
})

LaplaceEvent

LaplaceEvent is the core type of the event bridge system, representing events exchanged between LAPLACE Chat and connected clients. Each event contains standardized data for various chat streams from Biliibli Live.

All events share a common type field that identifies the event category and additional fields specific to each event type.

You can read more about the event types in the Event Types documentation.

Use Cases

• Integrate with Discord, OBS, VTube Studio
• Create custom chat layouts in your preferred frontend
• Connect to 3rd party services like streamer.bot or SAMMI
• ...any other use case you can think of

License

AGPL and MIT