Frnz Sniper Arena Mutator 108

Author        : $Author: jwalstra $
Revision      : $Revision: 1.10 $
Checkout Date : $Date: 2003/01/19 08:30:31 $
Source File   : $Source: /home/cvs/SniperArena/Info/SA_README.html,v $

GNU GENERAL PUBLIC LICENSE Version 2, June 1991
See LICENSE or http://www.fsf.org/license/gpl.txt

Coded using "vim". The only editor you'll ever need.

About

Arena style removes all the weapon pickups and replaces all ammo with the Sniper Rifle's ammo.

In the normal style of play, the Sniper Rifle replaces the Lightning Gun. The Lightning Guns ammo is also replaced with Sniper Rifle ammo, although it looks the same for now :)

This mutator offers the ability to change most of the default settings like fire rates, the amount of ammo in the pickups, bonus and penalties for killing or being killed, etc. Some of these features will allow you to emulate the popular "Zark" sniper mutator from UT. Check the Server Configuration section for more information.

Sniper Rifle Pickup ( non-arena style game )

Sniper Ammo

HUDType 0 - UT2003 Zoom (default)	HUDType 1 - UT Zoom
HUDType 2 - No Zoom	HUDType 3 - UT2003 Clean Zoom

Enjoy,
spoon (aka supun)

Thanks

Sniper Clan Frnz - For testing and being the best clan out there. :)

Ob1 - For being my Unrealscript Jedi master and being the first person I turn to when I'm clueless.

Epic - The rifle model came from UT. I'll call it even for the familiar looking health and ammo stations, re-charging translocator, and the shield gun :) Seriously, did you guys like WFUT?

Installation

The archived file should contain five files (along with images for the README)

1. System/SniperArena.u
2. System/SniperArena.int
3. Help/SniperArena/SniperArena.ini.sample
4. Help/SniperArena/LICENSE
5. Help/SniperArena/SA_README.html

This archive should be unzipped into your UT2003 base directory in order for the files to be placed in the correct location. A sample SniperArena.ini, called SniperArena.ini.sample, exists in Help/SniperArena. It's placed there so not to overwrite your current SniperArena.ini. You will need to copy this file to your System directory, renamed to SniperArena.ini, and edited to your taste. The default setting in this file are set to emulate UT's Sniper Arena. This is the contents of the sample SniperArena.ini file.

; See "Help/SniperArena/SA_README.html" for help

[SniperArena.MutSniperArena]
bArenaStyle=true
bAllowTranslocator=false
bShowHelp=true
HelpTimer=60.00000
HelpMessage="For help with Frnz Sniper Arena, type 'SAHelp' in the console"

[SniperArena.SASniperRifle]
FireRate=0.60000
CrouchFireRate=0.60000
MaxAmmo=50
InitialAmount=30
bDropAmmo=false
DropAmmoAmount=5

[SniperArena.SASniperFire]
HeadShotRadius=8.00000
HeadshotDamage=100
BodyDamage=45

[SniperArena.SAGameRules]
bAdjustPlayer=false
HeadshotAddHealth=10
HeadshotAddFrag=1
HeadshotAddShield=0
HeadshotAddAdrenaline=0
BodyshotAddHealth=0
BodyshotAddFrag=0
BodyshotAddShield=0
BodyshotAddAdrenaline=0
HeadshotRemoveFrag=2
HeadshotRemoveAdrenaline=0
BodyshotRemoveFrag=1
BodyshotRemoveAdrenaline=0

[SniperArena.SASniperAmmoPickup]
PickupAmount=10

You should edit your UT2003.ini file and add ServerPackages=SniperArena to the [Engine.GameEngine] section of your ini.

(remember not to leave a space after ServerPackages=SniperArena in your ini file)

  [Engine.GameEngine]
  ServerPackages=SniperArena

To use, select "Frnz Sniper Arena" from the mutator menu.

Server Configuration (SniperArena.ini)

Property	Type	Default	Description
SniperArena.MutSniperArena
bArenaStyle	Boolean	true	Controls whether the game is arena style or normal.
bAllowTranslocator	Boolean	false	Controls whether the translocator can be used in arena mode.
bShowHelp	Boolean	true	Controls whether a help message is displayed
HelpTimer	Float	60.00000	Time interval between when 'Help' messages are displayed.
HelpMessage	String	For help with Frnz Sniper Arena, type 'SAHelp' in the console	Help message text
SniperArena.SASniperRifle
FireRate	Float	0.60000	Seconds between firing.
CrouchFireRate	Float	0.60000	Seconds between firing when crouching.
MaxAmmo	Integer	50	Maximum sniper ammo a player can carry.
InitialAmount	Integer	30	Amount of sniper ammo a player is spawned with.
bDropAmmo	Boolean	False	Allow ammo to be dropped when player is killed.
DropAmmoAmount	Integer	5	Amount of ammo in dropped ammo pack.
SniperArena.SASniperFire
HeadShotRadius	Float	8.00000	Radius around the head bone that will be considered a head shot.
HeadshotDamage	Integer	100	Damage caused by a head shot
BodyDamage	Integer	45	Normal body damage
SniperArena.SAGameRules
bAdjustPlayer	Boolean	False	Allow adjustment of player attributes when killed or when scoring a kill
HeadshotAddHealth	Integer	10	Amount of health added for a head shot
HeadshotAddFrag	Integer	1	Amount of frags added, in addition to default frags, for a head shot.
HeadshotAddShield	Integer	0	Amount of shield points added for a head shot
HeadshotAddAdrenaline	Integer	0	Amount of adrenaline added, in addition to default adrenaline, for a head shot.
BodyshotAddHealth	Integer	0	Amount of health added for a body shot
BodyshotAddFrag	Integer	0	Amount of frags added, in addition to default frags, for a body shot.
BodyshotAddShield	Integer	0	Amount of shield points added for a body shot
BodyshotAddAdrenaline	Integer	0	Amount of adrenaline added, in addition to default adrenaline, for a body shot.
HeadshotRemoveFrag	Integer	2	Amount of frags to remove for being head shot.
HeadshotRemoveAdrenaline	Integer	0	Amount of adrenaline to remove for being head shot.
BodyshotRemoveFrag	Integer	1	Amount of frags to remove for being body shot.
BodyshotRemoveAdrenaline	Integer	0	Amount of adrenaline to remove for being body shot.
SniperArena.SASniperAmmoPickup
PickupAmount	Integer	10	Amount of ammo in map pickups

Client Configuration ( SniperArena.ini )

Some of these value can be set in the game. If you change the values in the game, the values in SniperArena.ini will also change.

Property	Type	Default	Description
SniperArena.SASniperRifle
MyHUDValue	Integer	0	Your zoom HUD style (HUDType command )
bMyZoomSound	Boolean	true	Controls whether sounds are played when you zoom. (ZS_* commands)
*ExchangeFireModes	Integer	0	Reverses fire modes (inherited from super class)
*Priority	Integer	10	Priority of weapon (inherited from super class)

* Not part of Frnz Sniper Arena.

Client Commands

Due to being converted to a spectator when you are killed, these commands can only be used when you are alive.

Command	Description
HUDType <value>	Selects the type of zoom HUD to use. 0 (default) = UT2003 zoom HUD 1 = UT zoom HUD 2 = No zoom HUD 3 = UT2003 Clean zoom HUD
ZS_on	Turns zoom sounds on
ZS_off	Turns zoom sounds off
ZS_toggle	Toggle the zoom sounds on/off
SAHelp	Show the console commands and current settings

Notes

• In arena play, the Sniper Rifle is not dropped when a player is killed. In non-arena play, the sniper rifle is dropped, like all weapons, when the player is killed.
• In non-arena play, it's wise to disable dropping ammo when killed since the rifle is dropped instead. Do this by setting bDropAmmo to false in your SniperArena.ini. This also avoids a little trick you can play to get unlimited sniper ammo.
• To enable a Zark style play, set bAdjustPlayer to true and set the other properties in [SniperArena.SAGameRules].
• To allow the translocator in arena play, set bAllowTranslocator to true in [SniperArena.SAGameRules].

Known "Problems"

• Thowing weapon and ammo trick. The guide to unlimited ammo.
• Can only set Sniper Arena commands while alive. Not much I can do.
• Crosshair comes back. The UT style HUD removes the crosshair, but now and then does not return the crosshair after a zoom. The hack is just to turn on the crosshair no matter what after a zoom.

TODO

• Change sniper ammo pickup mesh.
• Create a sniper rifle icon for the status bar.
• UWindows thingy for configurating.
• Better SAHELP showing server settings.

Change Log

Release 108

• Fixed problem with ammo being dropped even when disabled in SniperArena.ini
• Fixed problem with MaxAmmo and InitialAmount being initialized to 0 if entries didn't exist in SniperArena.ini.
• Fixed this document to show MaxAmmo and InitialAmount info.
• Added ability to play this mutator in non-arena mode.
• Added StaticMesh for sniper rifle pickup.
• Added ability to disable help message.
• Added control to allow translocator to be used in arena mode.
• Moved the ammo drop functions, so the the config locations changed.

Release 107x

• Added new zoom HUD style - UT Clean (3)
• Allow server admins to control ....
  • Ammo pickups
  • Spawn ammo amount and max ammo amount
  • Normal fire rate
  • Crouch fire rate (Zark style)
  • Bonus/Penalities (Zark style)
    • Health (bonus only)
    • Frags
    • Sheild (bonus only)
    • Adrenaline
  • Headshot damage
  • Headshot damage radius
  • Bodyshot damage
  • Help message and display timing

Release 106

• Fixed problem with cross hairs being turned off if zoom HUD is type UT2003 or None.
• Fixed console commands so they save defaults in client's .ini instead of server's.
• Added SAHelp and Help reminder message.
• Hacked it so if player changes to or from UT zoom HUD, while zoomed, the cross hair is either shown or hidden.

Release 105

• Fixed problem with cross hair disappearing when zooming or unzooming. I can not replicate the problem, so this is untested.

Release 104

• Removed "Zark" code. Couldn't get replication work right, add it back later.
• Made it so the cross-hair for UT zoom HUD is removed when zoomed.
• Improved reliability of hit effect showing up.

Release 103

• Added one my HUDType ( 3 = No Zoom HUD )
• Fixed model ( Col Kassad )
• Added muzzle flashes (1st and 3rd views)
• Make it so server can control default ammo amount, rifle damage, fire rate
• Added "Zark" style firing and player attribute adjustment (HP,SP,frag, Adren)
• Fixed problem with shell ejection and new model.

Release 102

• Added sniper rifle model.
• Fixed problem with HUDtype and zoom sound console command.
• Changed HUDType to use value. (0,default = UT2003; 1 = UT )
• Replaced ZoomSound with ZS_on,ZS_off,ZS_toggle.
• Fixed problem with impact effect not working on mutliplayer.
• Ported UT impacts sounds.
• Ported UT pickup sound.
• Added Sniper Rifle model.
• Ported UT body impact sound.
• Removed HitFlame effect from head shots
• Removed electric effect from body when killed

Release 101

• Replaced 3rd person Lightning gun mesh with shock rifle.
• Added wall impact effect (visual/sound)
• Added back the UT2003 zoom HUD
• Added ability to switch between UT and UT2003 zoom HUD
• Added ability to turn zoom sound on and off.
• Allowed health and armor pickups to not be replaced.
• Changed the death messages
• Add Frnz clan name to UT2003 HUD :)

Release 100 (First Release)

• Create mutator code to remove all pickup items in map.
• Create SA Sniper Rifle using Lightning gun code.
• Removed the UT2003 zoom HUD.
• Inserted the UT zoom HUD.
• Change damage code to UT style.
• Replaced 1st person Lightning gun mesh with shock rifle.
• Replaced gun fire sound with UT sniper rifle fire.