Registry / communication / mumble-client-websocket

mumble-client-websocket

library1.0.0jsnpmunverified

WebSocket transport protocol for the Mumble voice chat client library. Version 1.0.0 provides a callback/Promise-based interface to connect to Mumble servers via WebSockets. Works in Node.js and browsers. Key differentiator: browser support via WebSocket transport (mumble-client also supports TCP). Low maintenance: last release 2015; no versioned changelog.

communication

npm install mumble-client-websocket

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · MUMBLE-CLIENT-WEBS

mumble-client-websocket

communicationjavascriptv1.0.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

default

✓ import connect from 'mumble-client-websocket'

✗ const { connect } = require('mumble-client-websocket')

Default export is a function. ES import syntax requires default import.

connect

✓ const connect = require('mumble-client-websocket')

✗ const mumble = require('mumble-client-websocket').default

CommonJS default export is directly assigned to module.exports, not an object with .default.

Promise usage

✓ connect('wss://host:port', options).then(client => {}).catch(err => {})

✗ connect('ws://host:port', options, callback)

Protocol must be 'wss://' (secure WebSocket) in browser environments; insecure 'ws://' may be blocked. The function returns a Promise if no callback is provided.

Connects to a Mumble server via WebSocket using async/await. Uses environment variables for credentials (fallback placeholders). Shows welcome message and username on success.

import connect from 'mumble-client-websocket' // Replace with your Mumble server WebSocket URL and credentials const url = process.env.MUMBLE_URL ?? 'wss://voice.example.com:64737' const options = { username: process.env.MUMBLE_USER ?? 'Bot', password: process.env.MUMBLE_PASS ?? '' } try { const client = await connect(url, options) console.log('Connected! Welcome message:', client.welcomeMessage) console.log('Assigned username:', client.self?.username) } catch (err) { console.error('Connection failed:', err) }

Debug

Known issues

gotchaThe module only supports WebSocket transport (not TCP). Ensure your Mumble server exposes a WebSocket endpoint (typically port 64738).

fix

Use mumble-client's TCP transport for traditional Mumble connections, or configure your server (e.g., Murmur) to enable WebSocket.

affects: all

breakingNo TypeScript type definitions are provided. All types come from mumble-client.

fix

Install @types/mumble-client if available, or declare module augmentation.

affects: all

deprecatedLast release in 2015; unmaintained. No security updates or compatibility with modern Mumble protocol versions.

fix

Consider migrating to a maintained alternative or forking. Check mumble-client status.

affects: >=1.0.0

gotchaThe connect function expects a callback with two arguments (err, client) but returns a Promise only if the callback is omitted. Mixing patterns causes silent failures.

fix

Always provide a callback OR use .then()/.catch() – never both.

affects: all

Errors

Common errors & fixes

Error: No 'mumble-client' peer dependency installed.

Missing required peer package mumble-client.

fix

npm install mumble-client mumble-client-websocket

TypeError: connect is not a function

Incorrect import in CommonJS (e.g., using destructuring on a default export).

fix

const connect = require('mumble-client-websocket'); // no destructuring

SecurityError: The operation is insecure.

Using 'ws://' in a browser context; modern browsers block insecure WebSocket on secure pages.

fix

Use 'wss://' URL for the Mumble WebSocket endpoint.

Upgrade

Version history

1.0.0latest on npm

Audit

Dependencies

mumble-clientrequiredPeer dependency: provides the core Mumble protocol implementation, authentication, and audio codecs. This module only provides the WebSocket transport layer.

Agent activity

17 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/johni0702/mumble-client-websocket ↗

packagemumble-client-websocket ↗

homepagehttps://github.com/johni0702/mumble-client-websocket#readme ↗