Created
May 19, 2017 20:18
-
-
Save mGm-Lizard/6d6a209a28f47da474efe80172d5999f to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
TeamSpeak 3 Package Installer | |
----------------------------- | |
The TeamSpeak Package Installer allows users to install plugins, soundpacks, | |
skins etc. by opening a package file in Windows explorer. | |
Requires TeamSpeak 3 Client rc-2 or later. | |
Package files are ZIP archives with another file suffix. Only zlib compression | |
is supported. Do not use Umlauts in your filenames inside the ZIP archive, they | |
are not supported. | |
Package files are identified by their file suffix: | |
.ts3_plugin | |
.ts3_style | |
.ts3_soundpack | |
.ts3_iconpack | |
.ts3_translation | |
.ts3_addon | |
The suffix is a hint for the user about the package content. The install | |
structure is not defined by the suffix but by the content of the package. | |
Packages which contain multiple types (like stylesheet and an iconpack) | |
could use the suffix of the primary content (e.g. .ts3_style) or the | |
more generic .ts3_addon. | |
The root directory of the archive is required to contain a special package | |
information file named "package.ini". | |
[Example package.ini] | |
Name = Test Plugin | |
Type = Plugin | |
Author = TeamSpeak Systems GmbH | |
Version = 1.0 | |
Platforms = win32, win64, mac | |
Description = "This is a test plugin." | |
The Type field should match the file suffix or, in the case of a multiple | |
content package, be a combination (e.g. "Style, Iconpack"). | |
The Platforms field can be empty (allowed for all platforms) or a list of | |
supported platforms of this add-on. | |
Valid platform names are: win32, win64, linux_x86, linux_amd64, mac | |
The package installer will validate the current platform it is running on | |
against the list of supported platforms in the package.ini file. If the | |
current platform is included in the list, installing will be allowed. | |
If the platform list is empty or the field is not given, installing will | |
be allowed. | |
The hierarchy of a package archive is required to reflect the structure of | |
the installed files relative to the TeamSpeak 3 installation directory. | |
[my_plugin.ts3_plugin] | |
package.ini | |
plugins | |
my_plugin_win32.dll | |
my_plugin_win64.dll | |
my_plugin_data | |
data1.dat | |
data2.dat | |
The root level of this package will be extracted into the TeamSpeak 3 Client | |
root folder, excluding package.ini. | |
Note that content needs to be at the root level of the package and *not* | |
within a subfolder. The following would be *wrong*: | |
[my_invalid_plugin.ts3_plugin] | |
my_plugin | |
package.ini | |
plugins | |
my_plugin_win32.dll | |
my_plugin_win64.dll | |
my_plugin_data | |
data1.dat | |
data2.dat | |
A soundpack might be look like this: | |
[my_soundpack.ts3_soundpack] | |
package.ini | |
sounds | |
my_soundpack (directory) | |
sounds.ini | |
sound_1.wav | |
sound_2.wav | |
Example for a combine iconpack and style package: | |
[my_soundpack.ts3_style] | |
package.ini | |
styles | |
my_style.qss | |
my_style | |
my_style_icon_1.png | |
my_style_icon_2.png | |
gfx | |
my_gfx_pack | |
my_icon_1.png | |
my_icon_2.png |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
where do i put these to install?