Skip to content
This repository has been archived by the owner on Jul 22, 2022. It is now read-only.

Latest commit

 

History

History
50 lines (38 loc) · 2.05 KB

README.md

File metadata and controls

50 lines (38 loc) · 2.05 KB
Raw

TS3Viewer

Simple dashboard which displays TS3 server info and partially controls an instance of TS3AudioBot.

NOTICE

This project is no longer in development. A newer version written in React and .NET 6 can be found in this repo.

Dependencies

TeamSpeak3 PHP Framework and Symfony YAML dependencies are managed by Composer.

Installation

git clone https://github.com/Loupeznik/ts3viewer-php.git .
sudo apt install php-curl composer
composer install
cp .env.example.yml .env.yml

Fill your server information and other options in .env.yml and set correct permissions to move.sh (the process is explained within the script).

WARNING: The bot's API key or the TeamSpeak3 user who requested it need to have permissions to control the bot (mainly its playback functions). If these permissions are missing, refer to the bot's documentation for setting up these permissions.

If Server Status images are not working, you can fix it by copying the images from TS3 PHP Framework into the root directory. This is a problem due to the library having paths for the server viewer object messed up somehow.

cp -r vendor/planetteamspeak/ts3-php-framework/images .

Functions

  • Complete server status with periodical refresh as well as minified server status on the main page
  • TS3AudioBot playback controls
  • Music upload
  • List of music available to the bot locally with the option to have this music played through the bot
  • Showcase of basic TS3AudioBot commands

Feature roadmap

  • Server admin section
  • Better AudioBot API interaction
  • Improved server viewer
  • Parametrized / Database-stored audiobot command list