Forum Home Enhancements - Advanced Voicetool Viewer (Teamspeak 2, Teamspeak 3, Ventrilo viewer)

INFO

This is a more advanced version of my old tsxviewer plugin. It was written from scratch and offers a lot more features!
It displays a list of users connected to a voicetool like Teamspeak 2, Teamspeak 3 or Ventrilo and displays them on the Forumhome page inside the what's going on box, or anywhere else!

Templates allow you to fully customize the viewer, which can display unlimited amounts of viewers for your voicetool servers!

Keep track your server's uptime with the cron logger, which logs every time a server times out or comes back online!


*** Despite the product description saying mumble is supported, it is NOT. Sorry for any confusion ***

FEATURES

- Multiple Server Viewers on a single page
- Fully customizable Templates
- Query caching
- Server Uptime Logging
- No iFrames! Fits perfectly into vbulletn. Make search engines love you!

INSTALLATION

Extract the archive and upload the files according to their structure:

- forum root
	- admincp
		+ tsxview_admin.php
	- includes
		- cron
			+ tsxview_cron.php
		- xml
			+ cpnav_advancedvoicetoolviewer.xml
		+ tsxview_class.php
		+ ts2status.php
		+ ts3status.php
		+ ventstatus.php
	- images
		- cms
			+ delete_small.png
			+ edit_small.png
			+ permission-not-set_small.png
			+ permission-set_small.png
		- misc
			+ mumble.gif
			+ teamspeak2.gif
			+ teamspeak3.gif
			+ ventrilo.gif
			+ ts3_off.png (optional)
			+ ts3_on.png (optional)

Install the correct plugin xml file in your vBulletin ACP.
If you have any previous tsxviewer product installed prior to 1.3, uninstall it first! (Important!)

READ THE INCLUDED README FILE BEFORE INSTALLING THE PLUGIN! (srsly, spare you the headache!)

[Disasterpiece]

TROUBLESHOOTING

Please make sure, that
- you use the latest version
- followed the install instructions, uploaded each file to the correct location


TS3 Related Troubleshooting

My server is displayed as offline, but I can connect to the server!

Step 1: First, make sure you entered the correct port, queryport and serverID. it is crucial, that these informations are correct, otherwise the script won't get an answer or will pull the details from the wrong server.

Step 2: Firewall/NAT -
If your server is behind a firewall or a port filter tool, you need to allow datatransfer between the local server and the webserver. If you search for "Port forwarding", you should find enough material and tutorials to solve this issue

Step 3: query whitelist -
For the webserver being allowed to query information from the teamspeak server, you need to add the webserver's ip to the ip whitelist. The File is called "query_ip_whitelist.txt" and located in the ts3 server directory.
Add the webserver's ip in a separated line to the file and save the document. You may have to restart the ts3 server to apply these changes. (This step is not necessary if your teamspeak server runs on the same machine like the vB forum)

Step 4: For the query script to be allowed to pull specific information about the server, you need to grant special permissions to the guest and/or guest server query group.
First of all, you need to enable the advanced rights management inside of your ts3 client settings, so you can actually see what you're doing.
The specific setting is located in the settings window (ALT+P), under the "Anwendung / Application" Tab in the gorup "Verschiedenes / Misc" on the left hand side, named "Erweitertes Rechtemanagement / Advanced permissions system". Make sure the box is ticked.
Open the rights management from within the ts3 client while connected to your server, navigate to Server Groups. Then you need to grant these rights for the groups Guest and Guest Server Query:

• b_virtualserver_info_view
• b_virtualserver_channel_list
• b_virtualserver_client_list
• b_virtualserver_select

You'll find those rights via filter in the section Virtual Server > Information. (Make sure you have the selectbox set to "Display Names" on the bottom of the window)
If you are not able to solve this problem on your own or run in complications, please contact your ts3 server provider or the official teamspeak forums for assistance, since this problem is beyond the scope of this mod.

Also, you might want to check out this post on details how to enable these guest rights.

If you've gone through these 4 steps and still can't get the viewer to work, contact me via PM with this information:

• TS3 Server IP:
• TS3 Port:
• TS3 Queryport:
• TS3 Server IP:
• TS3 Server version:
• vBulletin Version:
• Product version:
• Problem description: Error messages, logs, observations, etc.

General F.A.Q.

I'm getting a blank site with PHP errors of classes that could not be found

You forgot to upload the query libaries or you put it in the wrong place.
Make sure you uploaded the necessary php files into the ./forum/includes directory and set
the correct permissions so the webserver can access it.
Also check if you're using the correct version.
If you update the plugin file, always update the libary file(s) too!

The viewer output doesn't print at all, how can I display it?

Check first, if you enabled the ts viewer in your vBulletin Settings -> "Advanced Voicetool Viewer".
Also, check in your ServerOverview panel, if there are any servers which are active.
If you chose to hide offline servers, check if at least one server is online.
When using a custom template, you may have different hook names than the default vbulletin style.
Check the template code for the right hook names where you want the viewer to appear or consult
your designer for help.
If all this didn't help, check the template files IF you modified them or ask in the mod thread for help.

The Viewer doesn't update immediately, sometimes I have to refresh the page multiple times for it to update the viewer!

This happens when you didn't set up a proper cron job for vbulletin.
Check the section "Cron jobs" in the readme file for more information.



CHANGELOG

CHANGELOG
=========

06/05/11
- Fixed a bug in the userlist for ventrilo servers
- Fixed a MYSQL Statement bug when editing a server
Upgrade notes: When updating from v1.3, just download the zip archive and upload the file inclues/tsxview_class.php

02/05/11
- Minor Bug fixes in back- and frontend
- Added option to specify the server ordering
- Improved template system to allow more customization
- Fixed wrong behaviour of ts2 query libary on certain occasions
- Fixed some image urls not being defined correctly
- Changed version to v1.3

04/04/11
- Internal Beta release of v1.2
- Introduced Support for Multiple Voicetools (TS2, TS3, Ventrilo)
- Introduced Query caching
- Introduced Multiple server viewers at once
- Improvements to server queries and error handling
- Bug fixes and improvements in the backend
- Added phrases for translations

12/01/09
- First non-beta Release starting at v1.1
- Fixed a formatting error in ts3status.php libary file
- Fixed tabs and whitespaces in xml files causing plugin installation to fail in rare cases.

04/01/09
- General code-cleanup
- Some additions for the settings descriptions
- Added setting for password-protected servers
- Added joinlink support for passworded servers
- Minor changes in ts3status.php

01/01/09
- Initial release

[Mastar]

Its saying our vent is offline when its not! Any suggestions?

[Mastar]

Its saying our vent is offline when its not! Any suggestions?

[tlwwolfseye]

I tried that Mod ony my 4.10 vB and I get this MySQL error.

MySQL Error : Column count doesn't match value count at row 1
Error Number : 1136

There were no previous Versions of TSX installed. Whats wrong ?

[kardac.stenfot]

Nice app. Installed.

[Disasterpiece]

Originally Posted by Mastar

Its saying our vent is offline when its not! Any suggestions?

Did you use the correct ip and port?
Please PM me the connection details to your vent server, I'll take a look.

Originally Posted by tlwwolfseye

I tried that Mod ony my 4.10 vB and I get this MySQL error.

There were no previous Versions of TSX installed. Whats wrong ?

Huh, never heard of that one before. 4.1.0 you say? I'll check back and see what's the problem. Didn't encounter something like this myself yet.

[Kapeket]

Installed and working.

I am new to CMS so how do I go about creating a forum block for this or widget?

Thriled with the idea of not using an outside source for this information.

I did get the cronjob setup correctly so that is a start. =)

[watfro]

Originally Posted by tlwwolfseye

I tried that Mod ony my 4.10 vB and I get this MySQL error.



There were no previous Versions of TSX installed. Whats wrong ?

I have the same problem on 4.1.3 when adding an TS3 server...

[Doc90]

mee too