Installation

The Teamspeak Query Plugin Framework was designed to run on nearly every platform. Additionally, we tried to make it as easy as possible for everyone to use it.

Installing the Framework

This page will provide you with everything you need to get started as quickly as possible. Just follow all the steps we've compiled for you below:

  1. Ensure you have a running Teamspeak server with query access. We also recommend to run the framework on the same machine as the Teamspeak server in order to minimize latency and traffic.

  2. Download the latest release of the TSQPF. You can do so by going over to its GitHub page and switching to the "Releases" section.

  3. Extract the downloaded tsqpf-{version}-{release-title}.jar to the directory you want the frameworks structure to be generated in.

  4. Now create a startup script. Here are some examples for Windows and Linux:

    @echo off
    TITLE Teamspeak Query Plugin Framework
    java -jar tsqpf-{version}-{release-title}.jar -debug
    PAUSE
    java -jar tsqpf-{version}-{release-title}.jar -debug
    Linux users should additionally install the program screen. On Debian or Ubuntu, use apt-get install screen to install.

  5. (Skip this step if you are using Windows or MacOS) On Linux, set the required execute permissions by using chmod 755 LAUNCHSCRIPTFILE.

  6. Now with the launch script ready, we're ready to run the framework the first time. But be aware that on Linux we recommend you to run the launch script inside a screen session. You can create a new one by using screen -S SESSIONNAME.

  7. This should have created some new folders, including configs and logs, followed by a txt file called eula. Please carefully read it and then accept it in the main.properties config, located in the configs directory.

  8. Adjust the main.properties to match your servers information. The most imporant values being serverAddress, queryPort, queryUser and queryPassword. After you've done all of that, go ahead and run the framework again.

  9. If everything runs nicely and you get to the login prompt, you've completed the setup!

  10. You are now able to install plugins. You can find a list of official ones in the plugin section. You should also be able to sign into the terminal. More information about the terminal and its features are available in the terminal section.

Start Parameters →