Forum Home Enhancements - TSxView: simple live viewer for Teamspeak 2 & 3

++++ ATTENTION! ++++++++++++++++++++++

This mod is outdated and has been replaced with an advanced version, covering more features: https://vborg.vbsupport.ru/showthread.php?t=264573

Because the mod has been completely rewritten, this isn't considered a simple "update".
Please install the new mod as I won't offer any more support for this one.

+++++++++++++++++++++++++++++++++++




[Old version:]

Welcome everyone!

You can find here a simple Teamspeak online-viewer for your forum.
You don't have to edit core files, just a small plugin file with a php libary and everything should work fine.

If you want to have an overview about how it's looking in the end, check out the screenshots included with this post.

The vBulletin 3.8.x Version of this mod is located here.



INFO
====

Current Version: (please report bugs, issues and any other feedback)
Author: Andreas Rudolph <radon@ggmj.de> (aka Radon)

This is a vB 3 / 4 Plugin with a simple who-is-in-teamspeak box.
Tested with:
- TS2
- TS3 Beta 9
- vBulletin 4.0.0
- vBulletin 3.8.2


ADDITIONAL FILES
================

There are two libaries included with this script which are necessary for php-sided teamspeak query.
You don't need both files, if you're using one teamspeak version only.

ts2status.php by Guido van Biemen (aka MrGuide@NL)
ts3status.php by Sebastien Gerard <sebeuu@gmail.com>


INSTALLATION
============

Extract the archive and upload the libary files into "/forum/includes/" directory.
Install the correct plugin xml file in your vBulletin ACP.
If you are updating, make sure to allow overriding of previous plugin versions.


UPGRADING
=========

To upgrade the plugin, proceed as you'd install a new product by navigating to the
"Plugins & Products -> Manage Products" group and klick "[Add/Import Product]"
Choose the pluginfile for your vBulletin version and make sure to check "Allow Overwrite" before
you import the updated plugin.

If you have problems after upgrading the plugin, write down your plugin's settings, un-install the
addon and install it again.

If you made any changes to the templates, the template records will not be deleted!
After the installation you'll have to re-enter your configurations, because these won't be saved!


CONFIGURATION
=============

By default the plugin is disabled in its options to prevent error warnings.
You can access the configuration by "Settings -> Teamspeakx Viewer".
After you entered the correct information, you can enable the viewer with the first option.

The most important settings:

- Enable / Disable TSxViewer:
This should be enabled for the actual plugin to work. Make sure to enable it *after* you
configured your plugin.

- Teamspeak Version:
If you want to query a TS2 server, switch this to "NO", otherwise leave it to "YES".

- Server IP:
Simply enter the IP, you're using to connect to your teamspeak server.

- Teamspeak 2 Port:
If you're using Teamspeak 2, you have to specify the connection port. This is important,
because if more virtual servers are running on the same machine, this port is used to
identify the correct server and it's used to display a Join link so user can connect through
your forum.
This is the port number you use in your Teamspeak 2 application behind the IP.
If you're using this ip in your TS2 Connection window: "123.123.123.123:8767", your TS2 port
is "8767".
If you're using Teamspeak 3, this setting is obsolete, because the port is transfered
through the query anyway.

- Queryport:
The teamspeak server uses a certain port where it listens for incoming queries.
For TS2 servers, you find this port in the server.ini file, which is located in the same
directory as the server binary is.
In the server.ini, look for a like called "TCPQueryPort". The port number is the value
after the "=".
For TS3 servers, you find this port in the ts3server.ini file, which is located in the same
directory as the server binary is.
In the ts3server.ini, look for a like called "query_port". The port number is the value
after the "=".

If you don't have access to these ini files, ask your server administrator or server
provider for these informations.

- VServer ID:
Teamspeak 3 servers aren't identified by their port number anymore.
Each virtual server gets an unique ID to differ it from the others.
In order to query the correct Teamspeak server, you have to specify its id. This is
important, if the machine TS3 is running on, provides more virtual servers than one.
In this case, you may ask your server provider for the correct ID of your server or ask your
server admin.
You usually find this ID in the server's log files too.


TROUBLESHOOTING / F.A.Q
=======================

- I get the error message "Socket error" or "Connection refused"
-> This is mostly the case, if you entered the wrong IP or port information.
Regardless if the port and ip is correct, the script sends a query to ask if the server
is "there" and answers. If no answer comes back, the script gives back these error messages.
Also check if you use the correct connection method. If your server is Teamspeak 2, it makes
no sense to query it with Teamspeak 3 methods and vice-versa.

- The who-is-online list prints out players who aren't on my server
-> You probably entered the wrong server port (for TS2) or the wrong vServerID (for TS3) and
the script is querying the wrong server.
Make sure you're using your server's data.

- 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!


CUSTOMIZATION
=============

To customize the template, you'll find it in the forumhome Templategroup as "forumhome_tsviewer"
If you want advanced customization of the output code, you have to edit the plugin code.

To display the viewer in a different position, you can edit the output template hook.
In the plugin's code, find
"$hookpos = 'forumhome_wgo_pos'.$vbulletin->options['tsx_displayposition'];"
And change the 'forumhome_wgo_pos' to any other hook you want the output to appear.
Since the forumhome template has 5 positions (forumhome_wgo_pos1, forumhome_wgo_pos2, ...,
forumhome_wgo_pos5), you have to remove
"$vbulletin->options['tsx_displayposition'];"
if your preferred hook has no number at its end.
If there is no output at all, you probably used an invalid hookname.

For usage with teamspeak2, you can also put an icon file "teamspeak.gif" into the misc dir of your
image folder. This icon will be displayed on the left side of the output row.
If you want to use an other icon file or rebuild the output row, you have to edit the forumhome_tsview
template to fit your needs.


CHANGELOG
=========

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

[Wood 20th*]

Thank you!! I'll check in tomorrow.

[S3Ponline]

I couldn’t get this to work. Was having a connection error 111

[Disasterpiece]

Originally Posted by Wood 20th*

Thank you!! I'll check in tomorrow.

Sorry for the delayed reply;
I tested it with the latest vB 4.0.6 PL1 Installation of vBulletin, but everything works fine to me.
You can test the following:
- Open the xml install file
- Change in Line 1:

<?xml version="1.1" encoding="ISO-8859-1"?>

to:

<?xml version="1.1" encoding="UTF-8"?>

- Try to re-import the plugin file

Originally Posted by S3Ponline

I couldn?t get this to work. Was having a connection error 111

Hi

Are you sure, that you got the correct query port and that the teamspeak server's communication ports aren't blocked by a firewall?

If the problem persists, you can PM me the following information:
- Teamspeak version (2/3)
- Teamspeak server IP
- For TS3: serverID
- For TS2: query Port
- Where and how your teamspeak server is hosted. On your own root server/home server/rented by a provider

[S3Ponline]

I think it might be an issue with my router, but I’m not 100% sure.

I read your entire thread and saw a similar issue. I’m hosting the TS server from home, and the website is hosted by a company.

I used a port checker and it said that my 10011 is open but it couldn’t ping the router. That might be the issue?

[Scan Cape Cod]

I'm having a somewhat bizarre problem that I'm trying to nail down. First, the basics:

Using TS3 Server latest build installed on a Windows XP Pro PC in my house. All appropriate ports are forwarded, everything is fine in that regard.

Using latest TS3 clients on various different PC's as well as other people experiencing the same problem, which is:

When we click on the Join Link from the website, we are seeing the following pop-up message prior to the TS3 Client running:

"Your icon path: 'default' does not exist... Please consider to reinstall Teamspeak 3 or choose another icon pack." with an OK button below it. When OK is clicked we are able to log into the server but as indicated all icons are gone.

This ONLY occurs when the join link is used to start the TS3 client and enter the server. If the TS3 client is already running the problem does not occur. Starting the TS3 client manually, the problem does not occur. It's ONLY when using the join link to start TS3 and enter the server.

This has been tested in both Firefox and IE8 with the same results, from multiple computers in multiple locations, with the same error message.

I'm at a loss. Does anyone have any idea? Other than this little bugaboo I'm having this mod works quite nicely.

Thanks in advance!

[Devil_Dog]

This looks like a great mod and would love to use it. One problem.We use Ventrilo.

Is there a Ventrilo version for theis mod? Or can can it modified for Ventrilo?

Thanks and tagged.

[Disasterpiece]

Originally Posted by Scan Cape Cod

I'm having a somewhat bizarre problem that I'm trying to nail down. First, the basics:
...

Hmm, never heard of anything related to this issue.

There has been an TS3 update lately, so I suspect some weird TS-related bug there.
Fact is, this seems 99% to be a ts3-related problem, so this might not be the correct place to ask for help. The only thing I included, was a ts3 connection link, as provided by the ts3 dev documentation. So nothing much to do here I guess.
Try to post this issue here: http://forum.teamspeak.com/forumdisplay.php?f=120

Originally Posted by Devil_Dog

This looks like a great mod and would love to use it. One problem.We use Ventrilo.

Is there a Ventrilo version for theis mod? Or can can it modified for Ventrilo?


Thanks and tagged.

"It's done when It's done" :P
Working on it somehow, but I won't be finished in the next weeks or so.

[Scan Cape Cod]

Originally Posted by Disasterpiece

Hmm, never heard of anything related to this issue.

There has been an TS3 update lately, so I suspect some weird TS-related bug there.
Fact is, this seems 99% to be a ts3-related problem, so this might not be the correct place to ask for help. The only thing I included, was a ts3 connection link, as provided by the ts3 dev documentation. So nothing much to do here I guess.
Try to post this issue here: http://forum.teamspeak.com/forumdisplay.php?f=120

You're right of course. Had I been thinking last night I would have tried to duplicate this error by creating a shortcut on the Windows desktop. I did so this morning and got the same results so it is most certainly NOT this mod. Sorry for the waste of bandwidth!

[Devil_Dog]

Originally Posted by Disasterpiece

"It's done when It's done" :P
Working on it somehow, but I won't be finished in the next weeks or so.

Thanks!!!!

[Scan Cape Cod]

Hello,

I have looked at your customization section and also done quite a bit of searching here to no avail.

What I'm trying to accomplish is a way to use the link for joining the Teamspeak server in another area of the website, so if a person clicks on it he or she is logged into Teamspeak 3 with their registered vBulletin username.

My beginner status with code has got the better of me. Can you make any suggestions?

Thanks in advance!