/***********************************************************************************/ /* */ /* Server Browser version 1.42 */ /* Written by C. Grote (cmgrote@thethird.net) */ /* http://www.thethird.net */ /* */ /***********************************************************************************/ Description: Server Browser is a module written to allow people to see the status of their favorite gaming servers - including how many people, and who, is logged on and playing, what map the server is currently running, and so on. /***********************************************************************************/ /* */ /* Installation Instructions */ /* */ /***********************************************************************************/ NEW INSTALLATIONS ----------------- 1. Upload all the serverbrowser folder to the modules sub-directory of your PostNuke web site. Remember to use ASCII mode to upload all the files with FTP except images (use Binary mode for images). 2. Setup the module. All you need to do is, as the administrator on your PostNuke web site, go to the administration menu and enter the "Modules" administration feature. a. Scroll down to the listing for "serverbrowser" and click on "initialise" in the column on the far right. You should see a "Module initialised" message at the top-left of the screen after doing so. b. Scroll down to the listing for "serverbrowser" once again, and this time click on "activate" in the column on the far right. You should see a "Module activated" message at the top-left of the screen after doing so. 3. Go to the administration page, and then to the serverbrowser administration interface. Under "Modify server browser configuration" you will find an option for: "Path to QSTAT binary". You'll need to enter the FULL path to the qstat binary; so for instance, if qstat is installed in /home/joe/bin/qstat, you'll need to enter: "/home/joe/bin/qstat" (without the quotes of course) in the textbox. (see (4) under the Special Considerations towards the bottom for details on your other options here.) 4. If you plan to use the block, go to the block section of your administration menu and add it to your block layout. The type is: "Serverbrowser/Server Listing" 5. You may add new servers to be browsed through the administration interface, accessible via the "serverbrowser" link on the main administration page. 6. You are finished. Enjoy your new module! UPGRADE FROM 1.42 ----------------- 0. This version (1.42) makes no changes to the database from v1.4, so you should be able to simply upload and overwrite the old files from v1.4. 1. You then need to go to the administration menu (admin.php), click on "Modules", then on "Regenerate", and scroll down to the "serverbrowser" entry and click on the "Upgrade" link to the far right (and then the "Activate" link after that). 2. If you had any MOH:AA servers in your server list previously, you will need to remove them and re-add them. 3. Everything should work now! Enjoy =) UPGRADE FROM 1.25 ----------------- 0. This version (1.4) makes no changes to the database from v1.25, so you should be able to simply upload and overwrite the old files from v1.25. 1. You then need to go to the administration menu (admin.php), click on "Modules", then on "Regenerate", and scroll down to the "serverbrowser" entry and click on the "Upgrade" link to the far right. 2. If you were using the qstat.pl CGI wrapper, you will need to replace it with the newer one this version of the serverbrowser module comes with. 3. Scroll down to the "serverbrowser" entry again, and click on "Activate" to the far right. 4. Your block (if you had one), should now re-appear, and everything should be in order and ready to use. 5. As a final touch, though, you can go to the administration menu, then to "serverbrowser", then to "Modify serverbrowser configuration", and choose a sorting method for the servers that are queried. 6. That's it! Enjoy =) UPGRADE FROM 1.2 ---------------- 0. As of this writing, the module upgrade system only works in versions _AFTER_ PostNuke 0.714 (as of this writing this means CVS). Because this version (1.25) modifies the database table structure, your only option to do an upgrade is to "Deactivate" and "Remove" the serverbrowser module (under the "Modules" section of the administration menu), and then follow the NEW INSTALLATION instructions above. Unfortunately, you will need to re-add your servers after doing this, and users' personal favorites will also be lost. (To avoid losing your servers and your users' favorites, you can dump the data of your $prefix_game_servers table and then re-insert it after doing a new installation of the module.) 0. In the future (when the upgrade bug is fixed), all you will need to do is: 1. Upload all the serverbrowser folder to the modules sub-directory of your PostNuke web site. Remember to use ASCII mode to upload all the files with FTP except images (use Binary mode for images). Overwrite any files (if prompted). 2. Go to the administration menu (admin.php), click on "Modules", then on "Regenerate". 3. Scroll down to the "serverbrowser" entry, and click on the "Upgrade" link to the far right. 4. Scroll down to the "serverbrowser" entry again, and click on the "Activate" link to the far right. 5. That's it - you're all set! UPGRADE FROM 1.1 ---------------- 0. As of this writing, the module upgrade system is currently broken in PostNuke (bug 561802). Because this version (1.2) modifies the database table structure, your only option to do an upgrade is to "Deactivate" and "Remove" the serverbrowser module (under the "Modules" section of the administration menu), and then follow the NEW INSTALLATION instructions above. Unfortunately, you will need to re-add your servers after doing this. 0. In the future (when the upgrade bug is fixed), all you will need to do is: 1. Upload all the serverbrowser folder to the modules sub-directory of your PostNuke web site. Remember to use ASCII mode to upload all the files with FTP except images (use Binary mode for images). Overwrite any files (if prompted). 2. Go to the administration menu (admin.php), click on "Modules", then on "Regenerate". 3. Scroll down to the "serverbrowser" entry, and click on the "Upgrade" link to the far right. 4. Scroll down to the "serverbrowser" entry again, and click on the "Activate" link to the far right. 5. That's it - you're all set! UPGRADE FROM 1.01 ----------------- (These instructions assume you are applying the smaller upgrade download - if you re-downloaded the whole package, however, these instructions should still work.) 0. Do not deactivate or otherwise remove the current module (1.01) if you still want to keep all the servers you have added to the database. If you do remove the module, then you will need to refer to the installation instructions above (as a NEW INSTALLATION). 1. Upload all the serverbrowser folder to the modules sub-directory of your PostNuke web site. Remember to use ASCII mode to upload all the files with FTP except images (use Binary mode for images). Overwrite any files (if prompted). 2. Go to the administration page, and then to the serverbrowser administration interface. Under "Modify server browser configuration" you will find an option for: "Path to QSTAT binary". You'll need to enter the FULL path to the qstat binary; so for instance, if qstat is installed in /home/joe/bin/qstat, you'll need to enter: "/home/joe/bin/qstat" (without the quotes of course) in the textbox. (see (4) below for special considerations with this option and the "Use CGI wrapper" option.) 3. You are finished. Enjoy your new module! /***********************************************************************************/ /* */ /* IMPORTANT: Special Considerations */ /* */ /***********************************************************************************/ 1. Renaming the "serverbrowser" directory under the modules directory will result in the module not working without heavily modifying all the files in the module. This is a current limitation in PostNuke - just leave it named as is. 2. This module makes extensive use of many of the PostNuke API features, and thus may not work with versions of PostNuke prior to v0.713. 3. The images referenced to display maps in the detailed view of a server are all under the /pnimages/levelshots subdirectory of the serverbrowser directory. Currently these include images for Quake3: Arena (including Threewave, ReactionQuake3, and Freakball Arena mods), Half-Life: Counterstrike, and Threewave's CTF for Quake2. Feel free to add level shots of your favorite game to this directory, but keep in mind that they will be resized to 128x128 (so you may want to crop / trim them if they are not in square proportions). Also note that the images need to be in a sub-directory dependent on their game-type according to 'qstat'; for instance, 'q3s' is the qstat type for Quake3 servers, so all Quake3 shots (including those for all Quake3 mods) must be under /pnimages/levelshots/q3s. 4. THE QSTAT BINARY There are two options here. 1. You can have qstat installed on your system and in a path whose full traversal allows executable access to world (so if it's in '/home/joe/bin/qstat', then all of /home, /home/joe, /home/joe/bin, and /home/joe/bin/qstat need to have 'x' permission for world / other). If this is the case, then you want to have the administrative option to "Use CGI wrapper" unchecked, and the path you need to enter in the "Path to QSTAT binary" option is the hard-drive path, for instance: /home/joe/bin/qstat 2. You can have qstat installed on your system in your cgi-bin (or equivalent) directory along with the included file "qstat.pl". This is going to be somewhat slower than the first option, but for some webhosting firms (HostNuke, for instance) it appears to be the only option. If this is what you decide to use, then you want to check the administrative option to "Use CGI wrapper" and enter the URL where the 'qstat.pl' file can be executed from a web-browser, for instance: http://www.mysite.com/cgi-bin/qstat.pl NOTE: If you are using the CGI wrapper, then you MAY need to modify the file qstat.pl for several reasons: First, if you have perl installed somewhere other than "/usr/bin/perl", you will need to change the path in the first line of the file to point to the correct path for PERL. Second, if you are using Windows, you will need to follow the instructions included at the tope of the file 'qstat.pl' and probably will require some knowledge of getting PERL scripts to work under Windows as I have never even tried it (I don't own or operate Windows at all - period.) Finally, you may download qstat for free from: http://www.qstat.org /***********************************************************************************/ /* */ /* Testing */ /* */ /***********************************************************************************/ This module was originally written for PostNuke v0.71x, and has been tested on PostNuke Rogue v0.713/4. You may view it in action, or download the latest release, at http://www.thethird.net. All reasonable questions for support will be answered to the best of my ability -- feel free to e-mail cmgrote@thethird.net with questions/comments, or check / post an FAQ question at my site (http://www.thethird.net). Responses will come as soon as time allows -- bear in mind this is distributed as a FREE package. Enjoy!