-
Notifications
You must be signed in to change notification settings - Fork 0
Home
Aloha, now that you are reading this, i think you'd like to know more about the ts3observer.
This tool's target is to observe your TeamSpeak3 server and manage clients, groups and channels the way you wish. To make this task(s) nice and easy, the ts3observer will work with plugins. Every plugin should cover one specific topic.
The tool is currently tested on linux (Debian 7 and Ubuntu 14.04 or higher). Windows has not been tested yet.
The Installation is really simple, all you do is pull the project, install some dependencies, configure the config skeleton and run the ts3observer.py file with python or directly from bash.
git clone https://github.com/HWDexperte/ts3observer.git
cd ts3observer
cp conf/ts3observer.yml.skel conf/ts3observer.yml
vi conf/ts3observer.yml # Edit this file to your needs
python ts3observer.py run
# or
./ts3observer.py runTo update ts3observer, just pull again. All your local configuration files will be ignored by git. But make sure that new config entries will be updated ;)
git pull origin masterYou configure this tool using yaml! Yay
All configuration files are in the conf/ folder. The global config for the behavior of the ts3observer itself is called conf/ts3observer.yml.
You MUST completely configure this file to ensure that the ts3observer works like you want to. Every part of the config should be self explaining. If you have questions, read the comments above every entrie first.
It's recommended to run ts3observer locally (on the server where the teamspeak-server is running). Otherwise you should add the hostaddress of this tool to teamspeaks
query_ip_whitelist.txt
After you have run the ts3observer once, it will stop and tell you that he have found new Plugins. Now you can go to conf/ts3observer.yaml ans en-/disable Plugins.
If you want to cinfigure a plugin itself, simply go to the plugin named configuration file in the conf/ folder.
You can find a complete list of shipped plugins and their configuration right here.
The usage of the tool is explained quickly. Simply type ./ts3observer.py -h and you'll get an up-to-date help of all command line arguments like this:
me@localhost:~/ts3observer$ ./ts3observer.py -h
usage: ts3observer.py [-h] [-v] [-q] [-g] [-d] {utils,run,version} ...
positional arguments:
{utils,run,version}
utils Need some help?
run Run the ts3observer
version Shows the ts3observer version
optional arguments:
-h, --help show this help message and exit
-v, --verbose Increase verbosity for debugging purpose
-q, --quiet Only show messaged if there is an critical Exception
-g, --graphical Run the ts3observer as Gui
-d, --dev Run in developer modusThe ts3observer comes with a hand full of tools to speed up the configuration step. For example, you'll need to configure some channel-id's or servergroup-id's. But won't find these id's in your teamspeak client. That's why the ts3observer utils exists.
You can get a full list of all your servergroups or channels with the utils.
me@localhost:~/ts3observer$ ./ts3observer.py utils -h
usage: ts3observer.py utils [-h] {servergrouplist,channellist,clientlist} ...
positional arguments:
{servergrouplist,channellist,clientlist}
servergrouplist List all servergroups
channellist List all channels
clientlist List all connected clients
me@localhost:~/ts3observer$ ./ts3observer.py utils servergrouplist
Connecting ...
----------------------------------------------------
sgid name type sortid
----------------------------------------------------
1 Guest Server Query Query Group 0
2 Admin Server Query Query Group 0
3 Server Admin Template 0
4 Normal Template 0
5 Guest Template 0
6 Server Admin Real Group 1
7 Member Real Group 90
8 Guest Real Group 99
9 Stamm Real Group 80
10 VIP Real Group 70
11 Police Real Group 20
----------------------------------------------------