Skip to content
Display client list of a Teamspeak3 server on MagicMirror.
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore
LICENSE Initial commit Oct 23, 2016
MMM-teamspeak3.js Fix textAlign Oct 31, 2016
README.md Update README.md Apr 12, 2017
node_helper.js Fix textAlign Oct 31, 2016
package.json

README.md

Module: MMM-teamspeak3

This MagicMirror module, display client list of a Teamspeak3 server.

TeamSpeak3 visualisation

Dependencies

Installation

Navigate into your MagicMirror's modules folder:

cd ~/MagicMirror/modules

Clone this repository:

git clone https://github.com/Thlb/MMM-teamspeak3

Navigate to the new MMM-teamspeak3 folder and install the node dependencies.

npm install

Configure the module in your config.js file.

Create a TeamSpeak ServerQuery login

  • Open TeamSpeak3
  • At the top of the TeamSpeak 3 program, click the "Tools" menu then click the "ServerQuery Login" option.
  • Type in the server query username you wish to create. Copy and paste the information that is generated for you to login with.

TeamSpeak support tutorial

Using the module

To use this module, add it to the modules array in the config/config.js file.

Note : If you rent the TeamSpeak server, you probably need to specify the serverPort or sid

modules: [
  {
    module: 'MMM-teamspeak3',
    position: 'top_right',
    header: 'My TeamSpeak3 server',
    config: {
      host: 'my.teamspeakhost.com',
      serverPort: '9987', // Default server port (not required if default port (9987) is used)
      sid: '', // Server ID 
      serverQueryPort: '10011', // Default server query port (not required if default port (10011) is used)
      login: 'queryuser',
      passwd: 'password',
      refreshInterval: 10 // in seconds
    }
  },
]

Configuration options

The following properties can be configured:

Option Description
host Hostname/IP of the Teamspeak Server.

Required
Possible values: localhost, url or a IP
Default value: null
serverPort Port of the Teamspeak Server.


Default value: 9987 (Default TeamSpeak3 voice port)
sid ID of the Teamspeak Server.


Default value: ''
serverQueryPort Port of the Teamspeak Server.


Default value: 10011 (Default TeamSpeak3 query port)
login Teamspeak ServerQuery login.

Required
Default value: null
passwd Teamspeak ServerQuery password.

Required
Default value: null
refreshInterval The refresh interval of queries (in seconds).

Default value: 10
displayIcon Display FontAwesome user icon

Possible values: true or false
Default value: true
textAlign Text alignment

Possible values: align-left or align-right
Default value: Depending on module position: if bottom-right or top_right : align-right, else : align-left
iconSize Size of FontAwesome user icon

Possible values: xsmall, small, medium, large, xlarge
Default value: small
textSize Size of nicknames

Possible values: xsmall, small, medium, large, xlarge
Default value: xsmall
icon Fontawesome user icon

Possible values: Any FontAwesome icon : fa-user, fa-circle-o ...
Default value: fa-circle-o
msgEmptyServer Display message when server is empty

Possible values: Any string you want!
Default value: Nobody's online !
You can’t perform that action at this time.