https://github.com/tf2pickup-org/mumble-client
A simple mumble client for managing mumble servers
https://github.com/tf2pickup-org/mumble-client
bot mumble mumble-client mumble-server murmur nodejs
Last synced: about 1 month ago
JSON representation
A simple mumble client for managing mumble servers
- Host: GitHub
- URL: https://github.com/tf2pickup-org/mumble-client
- Owner: tf2pickup-org
- License: mit
- Created: 2022-05-09T22:43:52.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T12:04:24.000Z (6 months ago)
- Last Synced: 2024-10-29T14:34:46.162Z (6 months ago)
- Topics: bot, mumble, mumble-client, mumble-server, murmur, nodejs
- Language: TypeScript
- Homepage:
- Size: 11.7 MB
- Stars: 5
- Watchers: 2
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
mumble-client
A simple mumble client for managing mumble servers
### Installation
```bash
$ npm i @tf2pickup-org/mumble-client
```
### Examples
#### Connect to a mumble server
```typescript
import { Client } from '@tf2pickup-org/mumble-client';
const client = new Client({
host: 'mumble://example.com',
port: 64738,
username: 'me',
});
await client.connect();
if (client.isConnected) {
console.log(client.welcomeText);
console.log(`logged in as ${client.self.name}`);
}
```
#### List all channels
```typescript
import { type Channel } from '@tf2pickup-org/mumble-client';
function printChannel(channel: Channel, level = 0) {
if (channel.name) {
console.log(channel.name.padStart(channel.name.length + level));
}
for (const subChannel of channel.subChannels) {
printChannel(subChannel, level + 1);
}
}
printChannel(client.channels.root);
```