cactus
helper library for the TeamSpeak 3 ServerQuery
example
const Cactus = let bot = 'hunter1' bot
usage
getting started
new Cactus(password || options)
Returns a new instance of Cactus
and will try to connect to a server, provided that opts.connect
isn't set to false
.
options
opts.password
- password used for identification; if you don't know what it is - click here (required)opts.login
(defaultserveradmin
)opts.ip
(defaultlocalhost
) - ip to which the client will try to connect toopts.port
(default10011
) - same as aboveopts.server_number
(default 1) - sets the server index for theuse x
command, leave as default if you don't know what that isopts.connect
(defaulttrue
) - determines whether the bot should attempt connecting immediatelyopts.display_name
(defaultCactus
) - the name that the bot will appear as
events
Cactus extends your old and loved EventEmitter, and will emit the following events
.on('ready', [callback])
-> cb()
Probably the only one you'll ever need, gets emitted when all the boring stuff is finished and the bot is ready to accept commands.
.on('motd', [callback])
-> cb(msg)
Emitted when the server sends out its welcome message,
methods
.connect([ip, [port]])
Use this if you have opts.connect
set to false
. Attempts to connect to a server at the given address.
.send(command, [[[parameters, [[options, [callback])
-> cb(res)
{ err: id: '0' msg: 'ok' body: version: '3.0.0-alpha4' build: '9155' platform: 'Linux' }
Prepares a nicely escaped command
with optionals parameters
and options
, passes res
in the given format above to the callback. Refer to the tests.
command
#String of lowercase letters only, refer to the pdf (required)parameters
#Object containing your keys and valuesoptions
#Array with different switches for your command --without-- the dash (e.g.uid
,away
)
See the tests for examples of usage.
.raw(string, [callback])
-> cb(res)
Queries a raw string of the command to the server, has to be escaped (page 5 in the pdf). Passes res
to the callback.
.register(type, [id], [callback])
-> cb(res)
Registers callbacks to special events emitted by the server, provided that you ask it nicely. type
depends on the type of events you want to register, so type
is:
- messages
private-message
- listen to all private messages sent to the bot, this also includes your own messages that you send to others, so be sure to put a check in place for that.channel-message
- requiresid
- get messages in the channel referred to by theid
server-message
- all messages in the global server channel
client-moved
- requiresid
- fires whenether a user switches to, or gets moved into a channel.client-joined
- listen to clients joining the server, or more specifically your bot's view, if you have weird permissions for the SQ on your server.client-left
- same as above, but with leaving.
install
npm install --save cactus-ts
license
MIT