TeamSpeak 3 Banner

Fully customisable and responsive TeamSpeak 3 🔊 banner with server & client informations.

View Demo · Report Bug · Request Feature

Table of Contents

1. Introduction
   • Program Explanation
2. Getting Started
• Prerequisites
• Installation
• Add Banner
3. Demo
4. License
5. Contact

Introduction

There are some great TeamSpeak 3 Banner Generators on GitHub, however I didn't find one with much information about the client & server side and the ability to customize the banner with an extern config file.

My goal was to create a TeamSpeak 3 Banner with some important features:

• Full Customization
• Great Design
• Translation
• Client sided information
  
  

  Upload (last min.)

  Download (last min.)

  Nickname

  Online time

  Total connections

  Flag of the country

• Server sided information
  
  

  Name

  Logo

  Version

  Custom text

  Time

  Date

  Active Clients

  Total Clients

  Channels

  Uptime

  Group Icons

Program Explanation

The whole project was made with PHP & TS3 PHP Framework. The program connects to the TeamSpeak 3 server, authenticate and spawn an object for the virtual server to get Client- & Server sided information. This is saved in variables, gets rendered on a image that is generated by PHP and outputs a png file.

Getting Started

Prerequisites

• PHP 7.x
• TeamSpeak 3 Server v3.4.0 (build >= 1536564584) or higher
• TeamSpeak 3 PHP Framework
• HTTP server for example: Apache, nginx

Installation

1. Create a new folder ts3-banner inside the root folder of your web server and clone the repo inside of it. Default path: var/www/html.

   git clone https://github.com/dennisabrams/teamspeak3-banner.git ts3-banner

2. Add the path of your TeamSpeak 3 PHP Framework to the config.php.

   $ts3_libary = "PATH";

3. Modify your serverquery inside the config.php.

   $serverquery_username = "serveradmin";
   $serverquery_password = "PASSWORD";
   $server_ip = "127.0.0.1";
   $serverquery_port = "10011";
   $server_port = "9987";

Note: Serverquery username & password will be automatically encoded to RFC 3986, so this issue will be not appear in the future. 🔒

Add Banner

1. Open TeamSpeak 3 Client and connect to your Server.

2. Right click your server name.

3. Choose "Edit Virtual Server".

4. Add the URL of the Banner.

   Banner Gfx URL: http://.../ts3-banner/ts3-banner.php
   

5. Change the Gfx Interval to 60 so the Banner will reload every minute.

   Gfx Interval: 60
   

Warning: The minimum Gfx Interval of TeamSpeak 3 is 60 seconds. Sadly it's not 100% accurate so the time on the banner will be not perfectly synced with the minutes. ⏳

Configuration

The TeamSpeak 3 Banner will look similar to this if there are no changes inside the config.php file.

• Logo Image & Custom text can be added.
• If you don't have any logo, the name of your server will be shown instead.
• Changing the font style, size, rotation & color of the text is possible.
• Positioning of the text is customizable.
• Background can be switched.
• Displaying the server version or group icons can be enabled / disabled.
• Choose a maximum amount of rendered server group icons.
• Locale information for the time and date can be modified.
• Text is editable for translations.

Note: An 3:1 aspect ratio is recommended for the background image but not necessary. 🖼️

Demo

You can join the TeamSpeak Sever of my german gaming community Projekt-Eleven to see the TeamSpeak 3 Banner in action.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Dennis Abrams - [email protected]

Project Link: https://github.com/dennisabrams/teamspeak3-banner

back to top ⬆