ServerChecker v3.02

Index

  1. Index
  2. What is it and why would we need it?
  3. Features
  4. Future
  5. Game Support
  6. Source Code
  7. Please Donate
  8. Download the latest version
  9. How to use the program
  10. Windows Error Reporting and ErrorMode
  11. Bugs, features, etc
  12. FAQ
  13. Contact
  14. Updated Readme
  15. General Public License

Note: If you intend to use ServerChecker I strongly advise you to read the whole Readme (except for the GPLicense which was added for the sake of completeness).

What is it and why would we need it?

ServerChecker was created to keep our servers up and running. We run system-intensive mods on our servers and like all software they might not be free of bugs/crashes. ServerChecker has one big advantage over a batch file: It works from a user-perspective.
Scripts, FireDaemon and others would run the program in an infinite loop, counting on the server process to terminate when something happens. ServerChecker on the other hand communicates directly with the server the same way a player would, so if the server doesn't respond to user queries it will get restarted. On top of that, ServerChecker is completely free. No pro or pay-for-nothing versions...
Firstly, I created a basic console version of the program. The second version featured a Graphical User Interface and much more goodies. For this release I tweaked ServerChecker based on users feedback and own experiences with even more goodies.
We are using ServerChecker on all our Windows servers with success. Our servers now have an uptime we couldn't achieve before. Only maintenance will keep our servers down longer than half a minute.

Linux users that run a HL/HL2-based server also have the opportunity to run a perl-script made by [DumB]SGR with similar functionality. You can find it here.

Features

Basic features in v1.0

Changelog for v2.0

Changelog for v3.0

Changelog for v3.01

Start and stop times can now be in any order so a server may start in the evening and stop in the morning.

Changelog for v3.02

Removed the nasty Local Time <-> GMT bug. May have corrected a small bug causing the server to keep starting/stopping as well.

Game Support

In the next version a lot of new games will be supported. This is an extended list:

With thanks to [DumB]SGR for most of this list.

Some important notes:

  1. This list may NOT be complete. Contact me if a game using one of the protocols is not listed.
  2. I got parts of this list from www.int64.org. I did not have time or resources (I don't own all the games) to test each and every game. I did test the protocols on a random gameserver using it. If you find any errors in this list then contact me so I can correct it (e.g. Medal of Honour is listed twice).
  3. Expansion packs should work if the base game is listed and the game engine was unchanged.
  4. Sometimes the game port differs from the query port. Go to this webpage to see if you need to use another port. For Battlefield 2 you should use 29900 as base port the same way 23000 is the base port for BF1942.
  5. If you want support for a game, go here.

Source Code

I've decided to publish the source code of this program under GPL license. You can find a description of the GPL license here.
If you alter any part of the source code and you think the change might be useful, then please let me know about the change and I will include the changes and your credits in a next release.

This program is free, including the source code. I've written this to support our community, and the gaming community as a whole. Money doesn't grow on our back though, and to keep our servers up every month, we heavily depend on donations from players who love to play on our servers. If you like my work, we'd appreciate it very much if you'd donate to our community.
Here's how:
Paypal: hutch@tarnok.org
NoChex: hutch@tarnok.org
International bank transfer and mail are also possible. For details, visit our donations forum
Donating also provides you with rewards like reserved slot, nick protection, etc. If you've donated, make sure you post a reply in the donations thread of the month, saying how generous you are, so we can verify it and load your steamid with goodies. Don't forget to mention you're a ServerChecker user...

Download the latest version

The latest version can be obtained through our forum here.

How to use the program

Main window

Server Overview (upper part of the window)

This part provides a list of all servers monitored, and has buttons to add, remove, start and stop servers.
The server list contains info to identify the server and lists the current status of the server.
Possible Values:
UPStatusDescription
UPOKAll is fine.
UnknownStarting Up...ServerChecker is waiting for the server to start up.
UnknownNo Reply...The server did not reply to ServerChecker queries.
This may occur when: the server is changing maps, the specified startup time is not high enough or the server has crashed
UnknownStopping Server...ServerChecker is currently stopping this server
DOWNNo Reply...ServerChecker has detected that the server was unreachable.
DOWNStoppedThe server was stopped successfully.
New in this release are the "Name" and "PID" columns. PID is the program identifier used by windows. I added this so I can quickly find the right server in the Task Manager or even with netstat (using the -ao option).

Server Details View (lower part of the window)

Here you can edit the settings used to monitor the selected server in the Server Overview. All settings/changes, except Priority and Time control, can only be updated when the server is stopped.

Menu

The "View" menu has a shortcut to watch the logfile.
The "Pingbooster" menu controls the Windows Multimedia Timer.
- Clicking "Change Value..." brings up a window where you can change the precision.
- The "Run" item starts or stops the adjustment.

General

Since v3.0 ServerChecker automatically starts with window. This requires Windows to automatically login. If your server doesn't login automatically use Microsoft's TweakUI for XP/2K3 or TweakUI for 2K.
To disable this behaviour open your start menu, go to programs > Startup. Then right-click ServerChecker and choose delete.

Pingbooster Window

This window controls the precision of the Windows Multimedia timer. It can only be changed when ServerChecker is not adjusting it. By default this value is 1, which is already tweaked!
Note: adjusting the precision of the timer is to be done with care. Mostly, this is done on HL/HL2 based servers. Doing this on other types of servers may or may not cause erratic behaviour and is untested by me.
To read more about Pingboosting click here.

New Server Window

This window contains the basic settings needed to add a new server. They are similar to the ones mentioned in the Server Details View.
All fields are obligatory except if you wish to monitor a "Normal Program", then Server IP and port shouldn't be entered.
For server IP, do NOT enter "127.0.0.1" or "localhost" because they use the MS TCP Loopback Interface and thus do not represent availability of the server to players.

Some important tips for HL/HL2 users

  1. Use hldsupdate to install your server. BoD reported on our forums that using the dedicated server using Steam is possible when using the command:
    c:\...\steam\steam.exe -applaunch 5
    Use this at OWN risk!
  2. Use the -console commandline switch for hlds and srcds servers.

Windows Error Reporting and ErrorMode

Windows Error Reporting is designed to give Microsoft feedback about malfunctioning programs. The bad side of it is that it may require user input. I don't think you'll be logged into your server at all times to wait for it popping up. This program can disable Windows Error Reporting by changing some values in the Windows Registry.
To enable/disable the Error Reporting functions:

  1. Go to your "System Properties" (right-click "This Computer", then select "properties")
  2. Find the Advanced tab and push the "Error Reporting" button.
  3. Choose the setting you want. By default "Error Reporting" is enabled and both checkboxes ("Windows Operating system" and "Programs") are enabled.
  4. This program requires Windows Error Reporting to be disabled and notifications to be turned off.

This site explains this nicely with some screenshots.
If you want to go sniffing around in the registry for the keys then this link might be useful to find HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\PCHealth\ErrorReporting and the meaning of the keys.

ErrorMode is another Registry value that controls what errors show a pop-up. This value will also be checked and changed in the next update. It can be found at HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Windows and can only be changed with the registry editor. For more information about the values click through to the Microsoft MSDN library.

Bugs, features, etc.

The first version of ServerChecker was pretty straightforward to program. This version however has increased complexity. Therefore it comes with no guarantee (as the GPL license specifies). Bugs are known to be in most programs and my program MAY not be an exception. If you'd like to see certain features added to the program (especially game support!), I'm willing to look into it. If you find a bug, please contact me and provide me with info on how te reproduce it. I'll try to fix it then, and include credits to you.

FAQ

  1. Q: ServerChecker keeps restarting my server.
    A: If server IP and port are correct then your startup time is most likely not high enough. Measure the time needed for you server to start up (the time needed for the console to display "Round_Start" for HL/HL2 based servers) multiply that by approximately 1.5 and use that time as "Startup" value. This is because ServerChecker will wait 2/3 of that time, and it will monitor the server for console input the remainder(1/3) of the time, indicating it is ready.
  2. Q: Didn't you say there wouldn't be a v3.0?
    A: Yes, I did. But since there are so many changes, including game support and the file-incompatibility with v2.0, it was decided to skip major version numbers and immediately go to v3.0. Don't expect a v4.0 though :) As stated before: I will try to support ServerChecker as long as possible, especially for game support.
  3. Q: Can you add support for <enter game here>?
    A: If it supports the technique used in ServerChecker (communicating through simple question-reply) and the query format is publicly available then I can most probably add support. Contact me so I can add support for your game.
  4. Note: Don't hesitate to contact me if you want support for a game. Once I have the query string it takes me 5 minutes at most to add support for it... If you have a server of the type running, then I'd be happy if you could supply me with an IP and port so I can quicktest it.
  5. Q: I'm very happy with your program, how can I thank you?
    A: ServerChecker is free of charge. Any donations however, made to our community will be accepted gratefully. Remember that donating to our community also rewards you: you get nickname protection, DumB-Donator tag, reserved slot on all our servers and more when you donate. And who knows: the future might bring more nice rewards...
  6. Q: I have another question, a bug report or a feature request.
    A: Contact me so I can answer your question, fix any bugs or look into the feature (not future :D ).

Contact

We have set up a bugtracking system where you can supply us with most feedback.
You can also contact me through our forum or on IRC(this link requires you to have a program like mIRC installed).
If you'd rather contact me personally you can send me a mail.

Updated Readme

I will try to keep this readme updated. An updated version will appear here when available.

General Public License


0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you". Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does.
1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License.
c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program. In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License.
3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.) The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.
5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License.
7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation.
10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS

End of Readme

ServerChecker v3.02