Readme 1.6
BEST READ AT 1024*768 (for the table)


  		      ATROPHY PRESENTS

                        ============
                         GODFATHERS
                        ============


Version    : 1.6
Date       : April 9th 2001
Author     : Warren "Pigwhistler" Jacobs
Extra code : Jason "Rat Instinct" Lucas
Email      : Pigwhistler@atrophy.co.uk
WWW page   : www.atrophy.co.uk

****************************************************************************************************************************************************************
New to version 1.6 (yes 1.5 wasn't as final as I'd expected)

Changed armour for levels 5 & 6 - 50% and 75% respectively
Changed max health for level 5 - up to 200
Fixed rejoin server score when you left with a score < 5
Added anonymous text bind ban (thanks, rat)
Added taunt system (basic - only 4 taunts in)
Added cvar for Losepointswhenkilled
Added cvar to allow taunts or not...
Hookstop Hook start text suppression.
Added all taunts (50 male, 39 female)
Added random taunt function
Added flood protection for custom taunts
Fixed errors when promoted which resulted in losing health/armour
Reduce splash damage of grenades in general
Create a check for impact grenades
Added Impact Grenades and they work a treat :)
Plays a bell sound when you become a Level 5 now
Made Impact Grenades a cvar (ImpactGrenades)
Don't display your name when you're saying nowt
Redesigned display to fix text overlay on high resolutions & group information sensibly
Added quick load shotgun

New Server Commands:

Set TauntsAllowed 1   
whether taunts are allowed - 1 = on (default), 0 = off

Set LosePointsWhenKilled 1 
whether players lose points once they reach level 3 by being killed by lower level players - 1  = on (default), 0 = off
	
Set ImpactGrenades 1
Whether grenades explode on impact with a player or behave normally. Note that if the grenade does not hit a player it will behave as normal anyway. 1 = on (default), 0 = off


New Client Commands

Bind x taunt nn

Where x is the key to bind and nn is the specific taunt number (can be left blank).
e.g. bind kp_del taunt 21 - will play a specific sample depending on if you're a male or female character (see the table below for what taunts are assigned to each number)
also e.g. bind kp_del taunt - will play a random taunt selected from those below.


Valid Taunts

Taunt 		Character		What They Say					wav file name
Number


1.		Heilman		"I'm Hitting you"					fight1
2.		Heilman		"How You Like Zem Apples!"				fight2
3.		Heilman		"You are making me so Angry"				fight3
4. 		Heilman		"Take that you little schiese!"				fight4
5.		Heilman		"We have meat here in ze building"			funny1
6.		Heilman		I have ways of making you hurt				funny2
7		Heilman		I have five times your strength				funny4
8		Heilman		Stop fighting back its not fair!			funny6
9		Jesus		Lets go motherfucker					fight 1
10		Jesus		Are you ready to be fucked man				funny1
11		Jesus		You don't fuck with the jesus man			funny2
12		Jesus		I'll stick that thing up your arse and ....		funny6
13		Kingpin		I aint through with you by a damned sight		fight1
14		Kingpin		Your arse is going down					fight 2
15		Kingpin		I'm going to get mediaval on your arse.			fight4
16		Kingpin		Your days are just about numbered motherfucker		funny3
17		Kingpin		The cavalry will be coming directly			funny7
18		Lamont		Why you comen round look at...				babble1
19		Lamont		Motherfucker gonna be dead ...				babble2
20		Lamont		You got a fucking problem				fuckingprob
21		Lamont		Fuck you motherfuckers					fuckingyou
22		Lamont		Getsome of that out there				getsome
23		Lamont		What the fuck you looking at				lookingat1
24		Lamont		Get the fuck off my street man				offstreet1
25		Luke		Hey why are you fucking with us man?			hostile1
26		Luke		You should not do that					hostile2
27		Luke		Hey what's wrong with you?				hostile3
28		Mathew		People lose their teeth talking like that		curse1
29		Moe		Hey this is our turf arsehole - turn around		moe1
30		Moker		"evil laugh"						fight2
31		Moker		"You think you're tough					funny3
 32		Moker		lets go girlie man					funny4		
33		Nikki		Cmon Cmon						fight3
34		Nikki		Nobody fucks with our operation				funny4
35		Nikki		Come here punk I wanna chastise you			funny5
36		Profanity	you punk motherfucking piece of shit			cuss3-1
37		Profanity	I will fucking end you					cuss2-11
38		Profanity	What did you say motherfucker?				cuss2-14
39		Profanity	You fucking talking to me?				cuss2-2
40		Profanity	You gonna fuckingstand there all day?			cuss2-4
41		Profanity	Kiss my ass						cuss1-10
42		Specific	Fucking pussy ass					spec2
43		Specific	Hey drop your fucking weapon				weapon1
44		Specific	I'm sorry did I break your concentration?		funny1
45		Specific	Do I look like a bitch motherfucker?			funny3
46		Specific	I am a mushroom cloud laying motherfucker	   	funny5
47		Specific	I will lay my vengeance down upon you!			funny6
48		Specific	Lets go,cmon						fight1
49		Specific	Bring it motherfucker					fight2
50		Specific	Be cool bitch						fight3


Female

1		Bambi		Fuck off you prick					curse1.wav
2		Bambi		Piss off I don't have time for your shit		curse3.wav
3		Beth_specific	woo - backoff motherfucker				backoff.wav
4		Beth_specific	Don't be pulling that shit on me			pullshit.wav
5		Blunt		Lets dance motherfucker					fight2
6		Blunt		I'm going to unload in your fucking face		fight3
7		Blunt		You like to watch, well watch this			fight4
8		Blunt		Give it to me baby					Fight5
9		Blunt		I'll execute you motherfucker				funny1
10		Blunt		You're getting me all worked up				funny4
11		Blunt		I never thanked you for dinner				funny6
12		Blunt		Ooo I got to go pee					pain1
13		Brittany	Up yours you foul mothed little creep			curse3
14		Fighting	Back the fuck off arsehole				fbackoff		
15		Fighting	Die you son of a bitch					fdie1
16		Fighting	Die you motherfucker					fdie2
17		Fighting	I'll fuck you up you son of a bitch			fdie3
18		Fighting	Take that you motherfucker				ftakethat
19		Fighting	In your face motherfucker				infacemf
20		Lola		hey motherfucker					curse1
21		Lola		Yoooo!							Curse2
22		Lola		Be Cool Bitch						curse3
23		mona		I will bust a cap in you ass you do understand		angry2
24		mona		Now that's it motherfucker				angry3
25		mona		Yeah fuck you too					angry5
26		profanity	Yo fuck you man 					f cuss3-1
27		profanity	Back the fuck up bitch					f cuss 3-2
28		profanity	Fuck you motherfucker					f cuss3-3
29		profanity	I'll bust your face					fcuss 2-4
30		profanity	Piss the fuck off					fcuss 1-1
31		profanity	Oh I will bust a cap in you ass				fcuss1-4		
32		profanity	Your mama made that?					fcuss 1-5
33		Yolanda		You're gonna need a bigger gun baby			biggergun
34		Yolanda		fucking die						die
35		Yolanda		Hey drop it						dropit
36		Yolanda		Hey fuck you motherfucker				fuckyou
37		Yolanda		Holy Shit						holyshit
38		Yolanda		That's it motherfucker					mf
39		Yolanda		Piss off						pissoff		
					
40-50 are repeated 1 - 11 due to the fact that there are less female sample sounds than male sample sounds. - i.e. sample 41 is the same as sample 2 (this enables you to bind a key to "taunt 42" and get a valid taunt for both male and female characters.
					
e.g  "bind k taunt 9" will play the taunt "Let's go motherfucker" if you are using the thug or runt model and "I'll execute you motherfucker" if you're using the bitch model.	

"bind k taunt" would select a random taunt - e.g 14 and again play the specific sample for your gender. Next time you pressed "k" it would play a different sample.

Flooding control is in place - so it won't get too silly.					

Not documented previously is the following:

bind x showtable - which displays how the scoring system works.

bind x showstats - provides information such as longest killstreak, time alive etc - loads of interesting extras.

Both these features have been in since 1.3 but don't seem to be documented before. - Both functions coded by Rat Instinct.



The default values for some of the variables introduced in Godfathers 1.5 have been changed - i.e. AllowTeleports is now disabled by default.


****************************************************************************************************************************************************************
New to version 1.5 Final

Fixed bugs in 1.4b (doh!)
Added optional player glow per level - easily identify the level of your opponents.
Added optional teleports for players - definable on/off, how many and which levels get them.

NEW SERVER COMMANDS: (defaults shown)

set PlayerGlow "1"   (Whether the player glow per level option is on or off)
set AllowTeleports "1" (Whether the teleport option is on or off)
set NoOfTeleports "3"  (How Many Teleports you get by default)
set MaxLevelTeleport "2" (The highest rank that is allowed to teleport - in this case its Thug - Mobsters and above would not be able to teleport.

NEW CLIENT BINDS:

teleport

e.g. Bind k teleport
Allows you to use the teleports if allowed by server.



1) THE GAME
   --------

1.1) Scenario:
"Hey kid, I think i've got a job for you."
You look into the eyes of the man stood before you, the godfather - you know he's testing you.
"Go for it" You say.
The Godfather smiles. "I want you to whack someone for me, do a good job, and I'll reward you. Screw it up, and you're not going to be around to be my problem anymore."
"When do I start?" You ask.
The Godfather hands you a pistol. "You already have."
 
1.2 About

Starting as a new recruit, you need to work your way up the ranks of the family to ultimately become the Godfather. There are others that stand in your way though, and these must be ruthlessly executed, for they will stop at nothing to remove you from the race to become the Godfather. Have you got what it takes?
You join each map as a new recruit, and get promoted by gaining kills. Promotion has its benefits (extra health, better starting weapons, some armour) and also its drawbacks (lower level kills give you less experience points). The levels and bonuses are as follows:

(The following table looks poo in this readme unless read full screen at 1024*768! check out the real thing (and the most current settings at http://www.pigwhistler.co.uk/godfathers.html)


---------------------------------------------------------------------------------------------------------------------
- key for table:												    -
- St       - 	Starting											    -
- EPNFL    - 	Experience Points Needed For Level - how many points you need to start with these bonuses           -	
- EPGFK    - 	Experience Points Gained For Kill - how many points you get when you kill someone at this level	    -
- 50-HJL   - 	50 armour points for Helmet, Jacket & Leg Armour       						    -
- CC       - 	Cooling Clip											    -
- LI       -    Level Indicator											    -
---------------------------------------------------------------------------------------------------------------------
LEVEL  	     LI	  St.Health  	Max.Health  	St.Bonus  	St.Ammo  	St.Armour  	EPNFL    	EPGFK
---------------------------------------------------------------------------------------------------------------------
Recruit       0	     75  	    75  	  pistol	   50		  None  	   0  		  5  
---------------------------------------------------------------------------------------------------------------------
Lookout       1	     75 	   100  	Magnum Mod  	   50	  	  None  	  30  		 10  
---------------------------------------------------------------------------------------------------------------------
Thug  	      2	    100		   125  	 Shotgun  	   24		  None  	 100  		 15  
---------------------------------------------------------------------------------------------------------------------
Mobster       3	    125		   150  	Tommy Gun  	  100		  None  	 200  		 25  
---------------------------------------------------------------------------------------------------------------------
Hitman        4	    125		   175  	Tommy Gun  	  200		25-HJL  	 400  		 40  
---------------------------------------------------------------------------------------------------------------------
Leuitenant    5	    150		   175  	    HMG  	   30	        25-HJL 		 700  		 50  
---------------------------------------------------------------------------------------------------------------------
Crime-Lord    6     175		   200  	 HMG + CC  	   30	 	25-HJL		1000  		 75  
---------------------------------------------------------------------------------------------------------------------

Each game's experience point limit is 1500 frags(though this is definable by the server admin), which, when hit, will result in a Crime-Lord becoming "The Godfather" and winning the game. The game ends as per normal, and you are all dropped back into the next map as Recruits again. A time limit can be set and the winner in this scenario will be the player with the most experience points (frags).
Of course, if you are an exceptional player, and you hit Crime-Lord level before anyone has even made mobster, you'll only be getting a maximum of 15 experience points per kill (look at the chart above), meaning you'd need to kill 24 thugs to become Godfather. If the game is more balanced however, and you find yourself in the company of other Crime-Lords, you would only need to kill five of them to become the Godfather.
Suicides are also more painful the higher up the ranks you go. You may be trapped in a room and think to take out an opponent in a suicidal grenade attack. However, if you are a Crime-Lord and they're a recruit, you're going to lose 70 experience points for your pains (gain 5 for the kill - then lose 75 for a suicide = 70), which might drop you back down to Leuitenant ranking, so the higher up the levels you go, the more you have to lose. Of course, the situation may be reversed and a suicide attack as a recruit on a Crime-Lord will gain you 70 experience points! Enough to take you up to the higher ranks of the thugs, but then the Crime-Lords get more points when they frag you. 
Also, once you reach level 4 (Hitman) - When you are killed by a player who is a lower level than you, you now lose frags equivalent to the difference in your levels. e.g. a level 6 player (exp modifier 75) is killed by a Level 4 player (exp modifier 40), the level 4 player would gain 75 points for killing you, and the level 6 player would lose 35 experience for being killed by a level 4 player (75-40).
e.g. (again) a level 5 player (exp modifier 50) is killed by a Level 3 player (exp modifier 25), the level 3 player would gain 50 points for the kill, and the level 5 player would lose 25 experience points for being killed by a level 3 player (50-25).
Remember - just like share prices - levels can go down as well as up. 

1.2) The rules.

Kill everyone, but the higher the level of the people you kill, the quicker you'll get to battle for the title of "Godfather".

1.3) So whats in it for me?

Something unique in Kingpin - Levels. There are great mods coming out that deal with "Classes" and that is different. Here you have to fight tooth and claw to get to the higher levels. The weapons given to the higher levels on startup can still be gained by the lower levels to even the balance, but its the armour and health bonuses that make all the difference - and where else can you battle on a map to gain 1500 frags in 30 minutes!


1.4) Whats new on the display?

Well you'll notice that frags aren't just a non-descript number in the top corner anymore. No Siree, you now have "Experience Points". You'll notice a big difference when you start fragging too. The largest single increase that can occur is when you kill a Crime-Lord. That way you'll gain 75 experience points whatever level you are.
Just below this is an indicator showing your current level - a number 0 to 6. 
Whenever anyone gains a level, you'll be notified at the top of your screen (where the death-messages come up). You'll also be notified when anyone drops a level too.
New to version 1.0 is the leaderboard display, just above your ammo. This shows you your ranking out of the players in the level, so you can easily see at a glance how close you are to the leaders. Also you'll notice your screen flash a couple of times when you join (using the default server.cfg file). While your screen is flashing you are invulnerable. This should stop respawn campers :-). However, it is up to the server admins if they want to set this. By setting the variable to 0, the respawn protection is ignored. You can tell if a player is invul by a red glow around their weapon. The maximum time allowed for protection is 5 seconds (a lot) - i recommend 2 seconds to allow you to get out of those tricky situations. Respawn protection only works for levels 0 - 2 (recruit, look-out, thug) - once you reach mobster you should be able to survive a rocket blast and you can fire back with your machine gun.
New to version 1.1-1.2 is the points to next level on screen so that you have a better idea of whats happening. Also everyone's level has been added to the score table so youe can see how well each player is doing.
New to version 1.5 is the PlayerGlow. If this is turned on, players weapons glow to denote their level. The colour code is:

Level 0: No Glow    	(Recruit)
Level 1: Red		(Look-Out)
Level 2: Green		(Thug)
Level 3: Dark Blue	(Mobster)
Level 4: Yellow		(Hitman)
Level 5: Purple		(Lieutenant)
Level 6: Cyan		(Crime-Lord)

1.5) Installing and running.

If you are just a client wanting to connect to a game you don't need to do anything except understand what's going on. You're obviously a good-mannered gamer in that you've read this far already - so you don't seem like the type to join the server and say things like "Why do I start with 75 health?" or "why did i just gain 15 frags for a kill". Good for you.
If you're a server admin, I won't patronise you by explaining in kiddy talk what you already know. If you want to run this at home though, on a LAN, create a directory under your Kingpin folder called "Godfather". Unzip all the files into this new directory. Once unzipped you should find a sbatch file called Godserver.bat - simply run this and get your friends to connect to your server. It is set to cycle through the standard KPDM1-5, but is playable on any map.
New in version 0.95, MOTD support. Server admins can now change the MOTD that comes up when you join a server. A sample one is included in the zip. Just change the text to say what you'd like, but try to keep it short as it can cause problems with client overflows on map changes.

1.6) New commands.

New to version 1.2 are the following commands "showtable" and "showstats". Showtable has been added so that people can see quickly what the extra items for for each level, saves going to the website :) Also we now have a showstats command which gives you a breakdown of how well your doing, this also displays the leaders stats (incase your not winning) so you can see how much better he is that you :)

1.7) GSlog support.

For people who love stats (BC) we've now added the Quake2 GSlogging to Godfathers. This can be turned on/off by changing the stdlogfile variable in the server.cfg. 0=off, 1=on.

=================================================================================================

2) RELEASE HISTORY

10/04/01   v1.6 - Added impact grenades, amended armour/health for higher levels, added taunt system, definable losepointswhenkilled on or off, lots more - see the update at the top of the page.

14/10/00   v1.5 - Added Optional Player Glow to denote player levels. Also added definable teleport option - can be on or off , can define the number of teleports and the maximum level at which you can teleport

1/10/00 -  v1.4 - Added speed-cheat and spawn-cheat fixes

14/05/00 - v1.3 - Added the resume feature from comp mod. Cheers lads.

02/04/00 - v1.1/1.2 - Added points to next level to the HUD. Each players level has been added to the scoretable. Showstats and showtable commands added. GSlog support added.

09/01/00 - V1.00 - Full Release. Considered fully working and tested on a LAN. Feel free to make extra requests for future versions, but please remember that this is a server-side mod and will remain so - any requests would have to fit this one criteria at least. You can contact me at pigwhistler@atrophy.co.uk. Compiled to be compatible with the V1.21 WinX86 Release of Kingpin.

28/12/99 - V0.95 PT#2 - Play-Test Version. Considered fully working and tested on a LAN. The release version (PT#2) refers to the fact that the health and weapon bonuses may change to balance out the gameplay (as they have from version PT#1). This of course all depends on me getting some feedback on the testing phase. Preferably, leave your comments in the relevant forum at http://www.pigwhistler.co.uk. Alternatively you can e-mail me feedback to       pigwhistler@pigwhistler.co.uk - feel free to make extra requests but please remember that this is a server-side mod and will remain so - any requests would have to fit this one criteria at least. Compiled to be compatible with the V1.21 WinX86 Release of Kingpin.

05/12/99 - V0.9 PT#1 - Play-Test Version. Considered fully working and tested on a LAN. The release version (PT#1) refers to the fact that the health and weapon bonuses may change to balance out the gameplay. This of course all depends on me getting some feedback on the testing phase. Preferably, leave your comments in the relevant forum at http://www.pigwhistler.co.uk. Alternatively you can e-mail me feedback to       pigwhistler@pigwhistler.co.uk - feel free to make extra requests but please remember that this is a server-side mod and will remain so - any requests would have to fit this one criteria at least. Compiled to be compatible with the V1.21 WinX86 Release of Kingpin.



4)  DISTRIBUTION NOTES
    ------------------

4.1) Disclaimer, copyright and permissions
     -------------------------------------

Kingpin: Life of Crime (c)1999 Xatrix Entertainment, Inc. (Cheers lads)
Godfathers is Copyright where applicable by Warren "Pigwhistler" Jacobs.


This modification and its attendant files must not, under any circumstance be distributed for monetary gains unless express and specific permission is authorised by myself (Warren Jacobs). No written permission is needed for distributing this software package on any media known or unknown to me, as long as this text file is included unchanged from its present form in this distribution and there is no charge associated with its distribution. I would appreciate being notified of distributions on cover discs, just for the buzz though - you understand :-).

4) ACKNOWLEDGEMENTS & THANKS
   -------------------------

Thanks to  Poisonville for mentioning this mod in their news and continuing to give us Kingpinners a reason to surf the net. I'd also like to say a BIG thank you to Tony at Modcity for getting the mod scene rolling along with wireplay's server bods - especially Drilla. Big thanks to Mr. Damage, Truzenzuzex and Orgseey for keeping Kingpin going and fully informed via the only real Kingpin news resource left - Planetkingpin should fuck off and die now - you're an embarrassment to the kingpin community - hand the site over to someone who actually cares.
Everyone who's given me feedback too, good or bad (only 1 bad one though!), thanks for taking the time to let me know what you think - it is appreciated.
Thanks to the authors of the Quake 2 programming tutorials at http://www.planetquake.com/qdevels - an invaluable resource in getting me started on mod-making. Code from some of these tutorials were modified to provide some of the code in Godfathers.
I'd also like to thank Rat Instinct for his programming help - for pointing out the obvious so many times (but the numbers are dropping), for testing (eventually) when i could get him off my bloody ISDN connection. And to all those who've played our mods and enjoyed them (and i suppose those of you who didn't - at least you made the effort).
Thanks also to the wonderful people in clan [TCC]. It's been a fantastic 18 months in the clan - lets see if we can make it 18 more - Congrats also to the clan for winning Wireplay DM6v6 division 3 with a 100% win record - the only clean sheet in all 3 leagues.
If I've missed you from this mention please let me know ASAP.
What's next? Well 1.7 will have a few nice additions but it'll mostly be eye-candy - the games nearly as perfect as it'll ever be - I don't think there's much to do about the gameplay elements. 
Real-mode Godfathers will be developed separately and will provide much the same but obviously with different weapons/health/etc powerups - shouldn't be too long b4 that is out.
Teamplay Godfathers might still make an appearance. The basic premise at the moment is that its a team score - so once the team hits level 1, all the players on that team become level 1. Could make for some interesting clan games.

pigwhistler signing off, this time not for good :)   9/4/01


Cheers.


Pigwhistler

pigwhistler@atrophy.co.uk
http://www.atrophy.co.uk