https://github.com/connormcf/node-ts3
An abstracted Teamspeak 3 server query client
https://github.com/connormcf/node-ts3
teamspeak teamspeak3 ts ts3
Last synced: 4 months ago
JSON representation
An abstracted Teamspeak 3 server query client
- Host: GitHub
- URL: https://github.com/connormcf/node-ts3
- Owner: ConnorMcF
- License: mit
- Created: 2018-02-25T00:28:41.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-02-28T21:46:27.000Z (over 7 years ago)
- Last Synced: 2025-01-27T18:12:02.188Z (4 months ago)
- Topics: teamspeak, teamspeak3, ts, ts3
- Language: JavaScript
- Homepage: https://connormcf.com/node-ts3/
- Size: 48.8 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# node-ts3
> an abstracted teamspeak 3 server query client
[Documentation](http://connormcf.com/node-ts3/)
## Install
```bash
npm install ts3 -S
```
## Usage
```js
const TS3 = require('ts3')
const ts = new TS3()
ts.connect('127.0.0.1', 10011)
.then(async () => {
let auth = await ts.auth('serveradmin', 'supersecret', 1)
console.log('authed', auth)
ts.setName('node-ts3')
ts.subscribe('server')
ts.subscribe('channel', 1)
ts.subscribe('textprivate')
})
ts.on('clientJoin', (ev) => {
ev.client.message('Hello ' + ev.client.nick + '!')
})
```
See additional examples in the [examples directory](https://github.com/ConnorMcF/node-ts3/tree/master/example).
## Documentation
Generated documentation is available from [connormcf.com/node-ts3](http://connormcf.com/node-ts3/).