|
| |
| Installation |
Run the ServerSpySetup.exe file to install! When it's finished run ServerSpy.exe either from the Start Menu or Desktop shortcut. Or from the actual EXE (of course).
Please note that because of a recent bout of incredibly inane tech support questions I will expect anyone that contacts me to have fully read this documentation and the FAQ. Thank you for your support. |
|
| |
| Running The Server Spy For The First Time |
 |
|
| |
| File->Settings |
Spy IP Address: The IP that you want the HL server to sends it's logs to. This will usually be the actual IP of the box but in the case of some users behind a firewall will be the IP of the firewall box.
Error Log Type: You can select the amount of information you want displayed in the error log.
IRC Server: The IP or domain name of the IRC server to which you may post server happenings.
IRC Port: The port of the IRC server.
Log all traffic: This will write all incoming IRC connect and disconnect information to IRC.log.
IRC Server Password: The password necessary for connecting to the IRC server.
Nickname: The nickname of the IRC bot. This will automatically be adjusted when reconnecting.
Email: The email you used to register the software.
Key: The registration key you will recieve once you've registered.
You must click "Save" before any changes you have made will be saved. |
|
| |
| File->Stats |
If you don't have a web server installed on this machine or a networked drive you can't use this feature.
The Server Spy will create server statistics at certain intervals (that you set) into the web site folder (that you point it to). To do this it uses the .html files in the Templates folder. Open these files up in Notepad (or your preferred text editor) and you'll notice some commented out code towards the bottom (<!--REPEAT--> for example). These are used by The Server Spy to determine where to drop in the data. The only fields available for each of the files is already listed in an html comment. You can rearrange anything within the REPEAT...ENDREPEAT tags and can change the layout of the entire page if you'd like. Just please make sure that you include both the <!--REPEAT--> and <!--ENDREPEAT--> tags. If you miss one or the other or misspell them the output will not be correct.
By default it produces web pages that look strikingly similar to my clan's website. =) Please send me a link if you do anything really cool with this. I'd love to see it.
To setup the templates:
a) Move "index.html", "toc.html" and "stats.css" from the Templates folder into your web site folder.
b) If it doesn't already exist, create a folder called "img" below your main site folder.
c) Find the "img" folder that was installed with The Server Spy.
d) Copy all the files and directories in this folder into the "img" folder you created in step c.
Web Folder: The web site folder on your hard drive where you'd like The Server Wench to write your web pages. Typically "C:\Inetpub\wwwroot" or "C:\Program Files\Apache\htdocs".
Generate stats...: How frequently you would like the Spy to generate the stats pages. This takes some CPU cycles and can start to burden the processor after the Spy has been monitoring for a while. Set it to run every 30-60 minutes.
Display stats...: How many days you would like to include in your stats.
Show top...: How many players you would like to rank in each category. |
|
| |
| File->Telnet |
Run the form to allow users Telnet access to your Spy sessions. Shut down the form to disallow access. This does not give anyone any access to your Windows session. It is simply a TCP connection to a Windows Socket. The Spy Telnet session runs on port 2000. |
|
| |
| File->Player Search: |
Player Name Contains: Select the type of query at the bottom. Then enter the substring of the players name, their WonID/SteamID or simply click "Query" if searching by immunity..
|
|
| |
| File->Messages: |
If the Spy is being used to monitor a LAN party this form will display the names of a player and the server they're on if they type "!admin" in messagemode1 or messagemode2. |
|
| |
| File->Send to All: |
RCON Command: You can use this form to send a Remote Console command to every server being monitored. You can either hit "send" or just the enter key to initiate your RCON command once it is typed. |
|
| |
|
| |
| Console |
RCON Command: This is the window for your Remote Console commands. You can either hit "send" or just the enter key to initiate your RCON command once it is typed. Note that the window scrolls down (not up like the HL console).
Scroll lock: Locks the Spy from displaying console information.
|
|
| |
| Main Tab |
Enter the logging port, server IP, server port, rcon password and MOD then click "connect". The Spy should connect immediately. Soon you should see the form caption change to show you information about the server. You are now fully connected to the server.
Remember that the logging port is the port on which you would like the HL server to send out it's logs. This is not the same port to which your players connect (27015, 27016, etc.). I usually start at port 2001 and add one for each server being monitored. Each time you add a new Spy you will need to increment this port number. An error will be generated if you fail to increment or chose a port that is in use by another application. This document is not a discussion of standard internet ports. The 2001-2025 range should be safe to use for purposes of the Spy.
Logging Port: Start with 2001. Remember each "New Spy" session will need a different port.
MOD: You must tell the Spy which MOD it will be monitoring.
Server IP: Enter the IP address of your HL server that the Server Spy will be monitoring.
Server Port: Enter the port number of your game server - usually 27015.
RCON Password: This is also something you have already setup in your AUTOEXEC.CFG file in your Counter-Strike directory. Make sure you use the same one or RCON commands will not work.
Team Kill Enforce: You can enforce penalties for team killing directly from Server Spy. See also under "File->Settings" menu later in the documentation for setting up TK warning message.
Team Damage Enforce: You can enforce penalties for wounding teammates directly from Server Spy.
Language Filter: Server Spy enables you to warn a player with a message, kick and then temporarily ban them for using profanity. It even picks up the profanity in their names! This "Filtered Language" list is configurable through the "File->Settings" menu mentioned later in the documentation.
Enforce Min & Max Pings: You can restrict players to within a specific ping range..
Post to IRC: Server Spy allows you to post the activity going on in a game to an Internet Relay Chat channel that you specify. Clan members can then use an IRC client to "watch" the match without being logged in and playing the game themselves. See "Using IRC".
Map CFGs: When this is checked the Server Spy will issue "rcon exec <mapname>.cfg" when the server rotates the map. This file should be named like the map (cs_assault.cfg, de_dust.cfg, etc.) and must be in your cstrike folder. This is useful for changing the timelimit for each map in your rotation (or any other setting you see fit).
Log to File: Check to have Server Spy keep a separate log of it’s own. This is usually named 2001.log, 2002.log, 2003.log etc. You will notice this is the same as the "Logging Port" for each "New Spy" session. This file is just for your own benefit. It is not used to monitor the game nor to generate the stats. Consider it a "backup" of what went on in the game while Server Spy was monitoring. This file is deleted each time you restart the Spy.
LAN Settings: This enables Server Spy to track players on a Local Area Network server. LAN players do not authenticate with WON and are all issued the same WONID from the HL server. This check box tells the spy to generate it's own unique WONID from the players IP address (which has to be unique on the LAN. Do not use this setting on an internet HL server.
Auto Reconnect: This keeps the Spy connected to the server in the event of a server crash or long-term network problem. There may be cases where you'd rather not have the Spy reconnect (if using a logaddress forwarder for example). Uncheck this in those cases. Setting up logaddress through your autoexec.cfg will be necessary.
Request status...: This will increase or decrease the time between status requests.
Allow players to...: Allow connected players to say !skill to receive their current ranking.
|
|
| |
| Punishment Settings Tab |
Ban for...: How long a player will be temporarily banned for team killing.
Permanently ban...: How many times a player can get temporarily banned before they are permanently banned. This will take into account how much time a player has played on your server. I will forgive one temporary ban for every 3 hours played on your server.
Allow immune...: Keeps those granted permanent ban immunity from being temp banned by other players.
Forgive...: On a FF server team kills happen. How many are you going to allow within how many minutes.
Permanently ban for TK...: How many seconds after the beginning of a round (in CS) will a TK cause the player to be permanently banned.
Allow TKed to temp ban their killers with "!punishtk": Checking this will allow your users to temp ban anyone that TKs them by typing "!punishtk" in messagemode1 or messagemode2.
Allow TKed to slap their killer with "!slaptk": Checking this will allow your users to slap anyone that TKs them by typing "!slaptk" in messagemode1 or messagemode2. This requires Admin Mod to be installed on your HL server.
Allow TKed to slay their killer with "!slaytk": Checking this will allow your users to slay anyone that TKs them by typing "!slaytk" in messagemode1 or messagemode2. This requires Admin Mod to be installed on your HL server.
Allow X retributions per round: Limit the number of !punishtk, !slaytk, etc allowed each map rotation.
Forgive...: How many language violations are you going to allow before the player is kicked.
Admin Mod function...: Type in the name of an Admin Mod function to use instead of simply banning a violator.
Kick for...: How many points of damage to a teammate within the first X seconds of the round will get them kicked (or eventually temp banned) from the server.
Mirror Damage: If you have Admin Mod installed and the plugin_serverspy installed (and Valve starts logging team damage) you can use this to setup mirrored damage for team wounders.
Allow players...: What is the allowable ping range for this server.
|
|
| |
| Word Filters Tab |
Filtered Language: A comma-separated string of all the language you wish to restrict on your server. Don't forget to include the h@x0r variations. You do not have to include plural (or longer versions of the same swear) in the list. It performs a substring match and the shorter version will set it off. Be careful to not filter words so short that a legitimate player may use them.
Filtered Nicknames: Same instructions as the language filter except these are used to check player nicknames. This could be useful for banning an entire clan.
|
|
| |
| Spy Messages Tab |
Welcome Message: The message that will display when a player connects (in their console window).
Spy Warning: The general warning displayed to tell your players that the Spy is running.
TK Warning: The message that will display to warn someone who has team killed.
Language Warning: The message that will display to warn someone who has violated your language restrictions.
Permanent Ban: The message that will display when a players is being permanently banned. Example: "PERMANENT ban: karmann (gs)".
Temporary Ban: The message that will display when a players is being temporarily banned. Example: "Temporary ban: karmann (gs)".
Language Kick: The message that will display when a players is being kicked for violating the language filter. Example: "Kicking for Language Violation: karmann (gs)".
Nickname Kick: The message that will display when a players is being kicked for violating the nickname filter. Example: "Kicking for Nickname Violation: karmann (gs)".
Team Damage Kick: The message that will display when a players is being kicked for inflicting too much team damage. Example: "Kicking for Team Damage: karmann (gs)".
Weapons Kick: The message that will display when a players is being kicked for a violating a weapons restriction. Example: "Kicking for Weapons Violation: karmann (gs)".
Ping Kick: The message that will display when a players is being kicked for a violating a ping restriction. Example: "Kicking for Ping Violation: karmann (gs)".
Weapons Info: The message that will display the current weapons restrictions. Example: "Weapons Restrictions: None".
Forgive Info: The message that will display when a players is forgiven. Example: "Forgiven: karmann (gs)".
War Warning: The message that will display when both clans start the clan war: "This is live! Good luck!".
Screenshots Warning: The message that will display when both clans release for screenshots. Example: "Screenshots round. THIS IS NOT LIVE!".
Skill Message: The message that will display when a player requests their skill ranking. |
|
| |
| IRC Settings Tab |
IRC Channel: The channel in which this server should broadcast.
IRC Password: The password to the channel (if required).
Messagemode1 Talk: Check to broadcast public talk.
Messagemode2 Talk: Check to broadcast team talk.
Server Says: Check to broadcast server console talk.
Events: Check to broadcast events (planted the bomb...).
Scores: Check to broadcast scores.
Kills: Check to broadcast kills.
Name Changes: Check to broadcast name changes.
Connects and Disconnects: Check to broadcast connections and disconnections.
Team and Role Changes: Check to broadcast team and role changes.
Round Starts, Ends and Restarts: Check to broadcast the beginning and end of a round and any match restarts.
WONIDs: Check to include a player's WONID with the IRC messages.
Damage Inflicted/Taken: Check to include the total damage dealt and taken (requires "mp_logdetail 3").
IRC Topic: Fill in the topic you would like to display in the IRC channel.
|
|
| |
|
| |
| Current Players Tab |
A listing of all the players currently connected to the server. You can right click on a players name to bring up a menu of options.
|
|
| |
| Custom Commands |
The Server Spy has added a few client and RCON commands of which you and your players should be aware:
"rcon forgive <wonid>": Will issue a removeid and writeid for the specified WONID.
"rcon tempban <wonid> <message>" and "rcon permban <wonid> <message>": Will kick and ban the specified user if they're currently connected to the server and issue a writeid. This will also send a console message to the specified user with the <message> you include. Example: "rcon tempban 9999999 because you're a jerk".
"rcon banweapon" and "rcon onlyweapon": Either from the Spy or the HL client you can issue an "rcon banweapon awp" or "rcon onlyweapon deagle" to ban a weapon or restrict everyone to just one weapon. Unfortunately you have to know the abbreviation of the weapons name to be able to ban it. Also, this will not keep someone from buying a weapon. It will only kick them if they use it. The restrictions will remain between map rotations and HL server restarts. Be sure to remove the restrictions when you're done with them. They cannot restrict the use of the knife. To remove the restriction you can issue an "rcon banweapon reset" or "rcon onlyweapon reset".
"rcon spyon" and "rcon spyoff": Turns all enforcement measure on or off (respectively). This is useful for clan matches. The Spy never enforces anything when your HL server has a password set.
"rcon spystatus": Checks the current enforcement status of the Spy.
"!admin": Used by a player in messagemode1 or 2. If LAN settings are enabled it will beep the Spy server and display a message of the server and player that is trying to get the admin's attention.
"!punishtk": Ever wanted to punish that jerk that just TKed you? Type !punishtk in messagemode1 or messagemode2 and they'll be temporarily banned and removed from the server.
"!slaptk": If you have Admin Mod installed you can allow your users to slap their killer. Type !slaptk in messagemode1 or messagemode2.
"!slaytk": If you have Admin Mod installed you can allow your users to kill their killer. Type !slaytk in messagemode1 or messagemode2.
"!forgivetk", !forgivetd" and "rcon forgive": A player that is TKed or wounded by a teammate can forgive by typing "!forgivetk" (or "!forgivetd") in messagemode1 or messagemode2. Otherwise an rcon users can use "rcon forgive <WONID>". This simply removes their latest TK from our records. It does not shut off mp_tkpunish! Both methods will remove a ban if it exists. Note that none of the team damage settings will work until Valve allows logging of team wounding.
"!skill": Used by a player in messagemode1 or 2. The Spy will respond with their current skill ranking.
"rcon warmap", "rcon warconfig", "rcon warmode", "!captain", "!screenshots" and "!war": These commands are used to make holding a clan match on a monitored server much easier. First someone with rcon needs to issue three commands:
"rcon warmap <mapname>" - Tells the spy what map is being played in the match
"rcon warconfig <config name>" - Tells the spy what server side CFG is used for this match
"rcon warmode" - Tells the spy to go to warmode. This sets sv_maxspeed to 0 so neither team can move.
Then one person from each team types "!captain" which tells the Spy that they are their teams captain. The captains can then type "!screenshots" and finally "!war" to begin the match. All of these commands can be in messagemode1 or messagemode2. |
|
