This is a simple example plugin for TeamSpeak. It is meant to be used as a starting point for developing your own plugins. Using CMake, it can be compiled for all supported platforms.
This project is licensed under the MIT License - see the LICENSE file for details.
An outdated documentation for the TeamSpeak Client SDK can be found in the latest release of the plugin SDK.
This plugin uses the Qt framework. The Qt documentation can be found here.
To compile this plugin (on Windows), you need the following software installed:
To create a new plugin based on this example, you can use the button Use this template on GitHub. This will create a new repository for you, which you can clone and modify.
First, you need to rename the plugin. To do this, you need to change the following files:
.github/workflows/deploy.ymldeploy/package.inisrc/config.cppsrc/definitions.hpp
When you want to compile locally you need to point CMake to the correct Qt installation. To do this, you need to change the following line in CMakeLists.txt:
-# list(APPEND CMAKE_PREFIX_PATH "H:/Qt/5.15.2/msvc2019_64")
+list(APPEND CMAKE_PREFIX_PATH "H:/Qt/5.15.2/msvc2019_64")Furthermore, you need to set plugin_name to allow for CMake to work properly:
-project("<plugin_name>")
+project("example")Even the version numbering is handeled by the build script. The version number is defined by the tag pushed to GitHub. So there is nothing special you need to do 🎉.
This plugin is not supported by TeamSpeak Systems GmbH. It is provided as-is and without any warranty. You are free to use it as a starting point for your own plugins, but you are responsible for any issues that may arise from using it.
If you want to contribute to this project, feel free to open a pull request. I will try to review it as soon as possible.