AVP2Serv FE

README File/Instructions for AVP2SERV FE

File Descriptions:
	
AVP2ServFE.rtf  	- Your Reading it right now.

AVP2Serv_History.txt
			- No Longer releasing it to the public.  


AVP2ServFE.exe	- The Custom AVP2Serv App.  Can be used with ANY mod and any client
                    side changes.	
                          
AVP2_MOTD.DAT  	- This file stores the MOTD Settings.  This will appear when you
			  configure your server MOTD and Time Setting.  There will be a 
			  different .DAT if you use the custom config feature.

AVP2SRVCHAT.LOG   - This file will appear if you use the Server Chat Log feature.  These 
			  two .LOG files will be different if you use the custom config feature.

AVP2SRVREAD.LOG   - This will appear if you click READ LOG.  I copy it to let an
                    admin read it, and prevent you from causing File I/O errors
                    if an entry is trying to be added while you read.  Both .LOG
                    files are stored in the MAIN AVP2 Game Folder.  DELETE LOG 
                    button deletes both of these files.  Changing the location of where
			  the LOG files are stored is not an option, nor do I see why it 
 			  should be.

Incomming.wav	- See WAV NOTE.  This wav you can set to any sound you want, but I 
			  recommend no more than 1 second of audio.  This is what you 
			  hear when a player joins if you activate the Sound Alert feature 
			  and set the Sound Source to DISKFILE.

Leaving.wav		- See WAV NOTE.  This wav you can set to any sound you want, but I 
			  recommend no more than 1 second of audio. This is what you hear 
			  when a player joins if you activate the Sound Alert feature and 
	              set the Sound Source to DISKFILE.

AVP2ServFEConfig.EXE
			- If you rent servers, this file will allow you to configure this
			  server app remotely.  Run the program, set the options.  Click
			  "Make AVP2_MOTD.DAT" and then upload this file to the folder that
			  contains the AVP2 Executables.

WAV NOTE 1: I do not include any .WAV files, you will need to acquire these on your own.
		DO NOT RECORD MORE THAN 1 SECOND OF AUDIO, OR YOU MAY ADD 
		SERVER LAG!!!!!!!!

PLEASE NOTE!
As of version v1.5.7.2 BETA or later, you must wipe out 
your .DAT file and restart over.  If you do not do this
you will have some strange problems occur possibly.  I 
recommend you wipe the .DAT file after every server app 
upgrade.


DESCRIPTION OF MOD:

1.  	This Mod Provides a couple of usefull features for Server Admins. The MOTD 
    	(Message of the Day) can be up to 5 lines long and be configured for displaying
    	to player anywhere from 1 to 20 minutes, I recommend between 8 to 15 minutes.  Any
	more or any less could be either annoying, or not getting displayed to enough players.
	I also recommend that it be 1-3 lines long, MANY players set their message history
	window size quite small.  So 4-5 lines can be too much, but I allow it none the less.
	THis MOTD feature used to be a seperate Application I had created in WIN32/C++, which
	I based off of Agent X04 of Midwest Mayhem's Visual Basic implementation.  I do wish
	to thank Agent X04 for giving me the idea!  

2.  	For Admins who are busy doing lots of other things, I have a feature in this program
	called  Join/Leave Sounds.  This allows you to activate the sounds such that when a
 	player joins or leaves your server, you will hear a sound.  This is a Console Admin
	only feature.  

3. 	Chat Logging, usefull for monitoring Server chat while you are away, so that you can
	determine what actually happened somewhat.  This implementation ONLY logs general
 	player broadcast, it DOES NOT log Admin Console Chat, nor does it log chat said only
	to a players Species, I call it SPECIES_SAY. I also have each entry TIME STAMPED, so 
	that you know when and which day/year/month it took place. I recommend that you DO NOT
 	allow the file to become excessively LARGE.  This will slow the logging down and
 	adversely affect server performance.  I have let the log accumulate for quite a long 
	time,  but I run a Athlon XP 2200+ CPU in my server, so I haven't noticed a problem.
  	I DO NOT know what happens with slower servers, so be ADVISED!  You have been warned.  
	The 2 buttons READ LOG and DELETE LOG are self explanatory.

4. 	J/L Snd Alert Delay, this feature with the help of testing by Agent X04, prevents 
	Join/Leave sounds to be played while a level in changing.  I used a 70 second timer to 
	delay the sounds.  Some Servers don't seem to be able to handle the load that playing 
	alot of join/leave sounds at once can cause. So if you notice HEAVY server load on a 
	level change, enable this feature.

5. 	Min. Left to Display the MOTD, simply put, is a count down timer that indicates how 
	soon the next MOTD message will be displayed.  If the MOTD Timer is NOT on, you will 
	see N/A in that box colored RED.  This quickly lets you know you didn't turn on the 
	MOTD Timer, and is also handy if you are typing to players and notice you have 60 
	seconds to display, that your text may not get seen, as the MOTD message would push 
	your text out of the way...so just wait till the MOTD shows, then type.

6. 	Player Join Alert feature allows you to let players in game get notified the moment 
	someone starts the Server join Process, and as you all know, LAG occurs while this is happening.  
	I have only seen it NOT happen on TRUE T3 Servers, yes, it happens on T1 Servers as well!  This lag
	can even occur on Fractal T3 lines.

7.  	Custom Config Files/Logs for Multiple Instances of AVP2ServFE on the same Server.  This is done 
	by adding a command line parameter to the "Target" of a windows shortcut.  

	EXAMPLE:

	"C:\Program Files\Fox\Aliens versus Predator 2\AVP2ServFE.exe" -fkcfg filename

	In the above example, this instance of the server app would use a config file called filename.DAT
	I append the .DAT onto the name you choose. strcpy() is quite usefull...  :)
	Now, once you run this shortcut, you will be prompted a number of times by message boxes.  Follow
	the Message Box instructions.  You will also be taken DIRECTLY into the MOTD Setup Modal Dialog Box,
	where you must at least set a LOGNAME.  You may use up to 19 characters, don't ask why I chose 19,
	it just happened.  DO NOT ADD A FILE EXTENSION like .LOG or .TXT, etc as I will automatically add
	.LOG to the filename you type in.  And if you try to click Apply Settings without entering a log
	name, you will notice you cannot exit that screen until you do.  This feature will allow you to 
	run a number of AVP2ServFE instances with their own MOTD Settings/Chat Log.  If you DO NOT specify
	the -fkcfg option, then this app uses the default .DAT config filename and default Chat Log Names.
	
	Please NOTE:  I assume you have basic knowledge of how to Operate Windows, and how to make/edit 
	shortcuts.  PLEASE DO NOT EMAIL ME ASKING ME HOW TO DO THIS, I DO NOT HAVE TIME!!!

8.	THe Player Join Alert string is now configurable.  Currently, I only have the program monitor the first
	character array position "[0]" to determine if it is a NULL string or configured.  If the first character
	is NULL, I disable this feature.
	I recommend something like:  A Player is joining!
	
	NOTE: I append "{AUTO MSG}" to the beginning of the string!

9.	Added support for using custom log folders.  Use the following command line option:

	-logdir <path>

	Here is an example:
	
	-logdir C:\AVP2LOGS

	This would store the chat logs in the folder AVP2LOGS in the C: drive.

10. 	The server app logs every startup.  This is usefull to determine how often a server crashes or is
	restarted.


SETTING UP THE MOTD PROCEDURE:
When you first run the app, you will be put into the MOTD config screen, just edit 
each item, click Apply Settings, then click OK.  

OR once you have done initial configuration:
	
1. 	While the app is running of course, click SETTINGS.
2.	Now, Enter the text you want on each of the 5 lines.  You may opt to use only 1 or all 5, or whatever you need. 
	HOWVEVER, at the minimum to use the MOTD Feature, Line 1 must be configured.
3. 	Enter a Time in the Time Setting Edit Box, between 1 and 20 Minutes.
4.    Press SAVE LINE 1, SAVE LINE 2, SAVE LINE 3, SAVE LINE 4, SAVE LINE 5 buttons.
5.  	Press the SET TIME button.
6.	Set any checkboxes that you wish to activate everytime you load the Server App.
6.  	Click Apply Settings.  The OK button now appears.
7. 	Click OK.
	
To edit only a specific item, then just click SETTINGS and edit the line you want, click the 
SAVE LINE button for the line you just edited, and then click Apply Settings, then Click ok.

NOTE: All the togglable button states are now saved to file.  Click SETTINGS to go to the 
config dialog screen.  Set the checkboxes you wish to be enabled when you load the server
app.  Click Apply Settings, then click OK.  When the server app loads next time, those option
will automatically be activated.
	

LEGALESE CRAP:
	
This mod is not for SALE or for PROFIT in any way.  I distribute this mod soley AS-IS, without 
warranty or implied warranty of any kind.  Use at your own risk.  I can, however, assure you 
that I have done ALOT of testing, and have gotten rid of all known bugs.  I am NOT distributing 
the SOURCE CODE, so DO NOT ask for it.  As per Monolith EULA, I cannot distribute the source in 
an fashion, just the completed mod for Non-Profit to legit AVp2 Owners.

This mod is NOT supported by Monolith or Sierra in any manner.  Monolith, Sierra and Fox Interactive 
are the copyright owners.

AND A WORD FROM THE AUTHOR:

If you have any comments, Flames or Good, and suggestions, you may email me at [email protected]  
Of course, if it is flames, don't expect me to respond, and I will just assume you can do a better job.

I am [DMH]Keu'r-cte (A.K.A. FuzzyKilla), as my name can be seen on GameSpy Arcade and I can be seen on MSN Messenger by [email protected]

Due to the way they implemented the &quot;Server/Client&quot; architecture, I may or may not be able to implement 
some features.  This is a LIMITED Server system, and the client handles many &quot;server&quot; functions.  
I am also working on some Client Features, such as a Spawn Kill Protection Mod, and several other things.

Thank You, and I hope you enjoy this Mod to the AVP2 Server Console.

[DMH]Keu'r-cte (A.K.A. FuzzyKilla)

Read More