Home - Schrotty/TeamSpeak-Viewer GitHub Wiki

TeamSpeak-Viewer

  1. Was ist der TeamSpeak Viewer?
  2. Features
  3. Geplante Features
  4. Einrichtung
  5. Einstellungen
  6. Hintergrundgalerie
  7. Bilder
  8. Lizenz

Was ist der TeamSpeak Viewer?

Eine Weboberfläche für einen TeamSpeak 3, um sich alle verbundenden Clients anzeigen zu lassen.

Features

  • Responsive dank Bootstrap
  • Auflistung aller verbundenden Clients mitsamt des aktuellen Channels.
  • Hintergrundgalerie
  • Automatische Aktualisierung.
    • Die Aktualisierungsrate ist frei wählbar. (Siehe Einstellungen)

Geplante Features

  • Desktopbenachrichtigungen.
  • Sounds
  • Ein Adminpanel.

Wie genau die einzelnen Features umgesetzt werden sollen steht noch nicht genau fest.

Einrichtung

  1. Das Repo. klonen oder als .zip herunterladen und auf einen Webserverr hochladen. Der Name des Ordners ist dabei nicht wichtig. Ein Beispiel könnte sein: http://www.ihre-domain.de/tsview/
  2. Als Admin einen neuen ServerQuery anlegen.
  3. Dazu als Admin im TS Client anmelden und unter Extras den Punkt ServerQuery Login anwählen.
  4. Im folgenden wird ein Name für das Query festgelegt.
  5. Im nächsten Schritt wird der Name und das Passwort für das Query ausgegeben. Beides in die config/Config.php eintragen und die bestehenden Einträge überschreiben.
  6. Wenn der Viewer auf einem anderen Server laufen soll als der TeamSpeak Server muss noch die Server IP angepasst werden. Die Ports können unverändert übernommen werden, wenn die Ports des Server nicht angepasst wurden.
  7. Sollte der Viewer auf einem anderen Server laufen muss dessen IP noch in die query_ip_whitelist.txt des TeamSpeak Server eingetragen werden, da es sonst zu einem Floodban des Viewers kommt.

Einstellungen

Die meisten Einstellungen liegen in der config/Config.php. Dort wird neben den Query & Server Einstellungen auch die Sprache des Viewers eingestellt.

Die Sprachdateien befinden sich unter lang/[sprachkürzel]/.

Die Aktualisierungsrate des Viewers wird in js/viewer.js/ eingestellt und zwar mit der Variable refreshRateinSeconds.

Die Hintergrundbilder liegen im Ordner img/baackgrounds/. Empfohlen sind Bilder mit einer Auflösung von 1920x1080 Pixeln, wobei auch alle anderen Auflösungen akzeptiert werden.

    /* ### Query Settings ### */
    public static $sQueryName = "dev_view"; //Query Name
    public static $sQueryPasswd = "a1g7ZGQF"; //Query Passwort
    public static $sQueryPort = "10011"; //TeamSpeak Query Port
    
    /* ### Server Settings ### */
    public static $sServerIP = "127.0.0.1"; //TeamSpeak Server IP
    public static $sServerPort = "9987"; //TeamSpeak Server Port
    
    /* ### Translation Settings ### */
    public static $sLanguage = "de";  //Sprache des Viewers

Hintergrundgalerie

In der Hintergrundgalerie kann jeder Benutzer einen eigenen Hintergrund für sich festlegen. Aufgerufen wird die Galerie über die Einstellungen, welche mit dem Icon links oben erreichbar sind.

Bilder

Default Image Default background

Custom Image Custom background

Background gallery Background gallery

Lizenz

Dieses Projekt steht unter MIT Lizenz. Siehe LICENSE.md