twitchtsbot

This bot was developed in order to give users on a TeamSpeak Server a server group when they are live on twitch. It aims to solve the problem of users joining the channel without even knowing a channel member is streaming.

Download

The latest binary can be found and downloaded at the releases page of this repository.

Usage

Configuration file

As soon as the application starts for the very first time, a default configuration file is generated automatically. The user then has to fill in his own values in order for the bot to work properly. The following sections describes each configuration value and how they have to be set:

accounts

Sets the account pairs to check for. Format has to match the following syntax: <TeamSpeak-UID/TeamSpeak-Database-ID>/<Twitch-Login-Name>

Example

accounts:
- ts: 'auniqueteamspeakid'
  twitch: 'testuserontwitch'
- ts: '42'
  twitch: 'anothertestuserontwitch'

interval

Sets the Twitch API retrieve interval. Has to be a duration such as 1s or 10m.

Example

interval: '1s'

servergroupid

Sets the Server Group ID which should be set as soon as a user is streaming. Can be retrieved by hovering above the Server Group in the Server Group dialogue of the TeamSpeak client.

Example

servergroupid: 42

teamspeak

Sets the required information to connect to the TeamSpeak Query. This includes the HTTP API key, the server id to use (per standard equal to 1) and the url to connect to.

Example

teamspeak:
  apikey: 'dmVyeXNlY3VyZXRva2Vu'
  serverid: 1
  url: 'http://localhost:10080'

twitch

Sets the required information to communicate with the Twitch Helix API. An App Access Token as well as a client id is required! Both of them can be retrieved here: https://dev.twitch.tv/docs/authentication

Example

twitch:
  appaccesstoken: 'eWV0YW5vdGhlcnR3aXRjaGhlbGl4dG9rZW4K'
  clientid: 'dGhpc2NsaWVudGlkaXN2ZXJ5c2VjdXJl'

Running the application

You can run the application simply by placing the binary as well as the config.yml in the same directory. You can then run the application like this:

./twitchtsbot

There are various parameters which can be retrieved by running ./twitchtsbot -help