Author        : $Author: jwalstra $
Revision      : $Revision: 1.11 $
Checkout Date : $Date: 2003/05/18 15:14:17 $
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

This mutator is a port of the UT Sniper Rifle. The mutator can be used in normal and arena play.

Arena style removes all the weapon pickups and replaces all ammo with the Sniper Rifle ammo. When you spawn, you are spawned with the Sniper Rifle. The Sniper Rifle can not be thrown. Normally in arena mode, the translocator is disabled, however the server is allowed to turn it on.

In non-arena style, the Sniper Rifle replaces the Lightning Gun. The Lightning Guns ammo is also replaced with Sniper Rifle ammo.

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.

Enjoy,
spoon (aka supun)

Thanks

Col Kassad - For the making the sniper rifle models work.
Fuzz[Frnz] - For the sniper ammo pickup and the Frnz logo.
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 the following files (along with images for the README)

  1. System/SA109.u
  2. System/SA109.int
  3. System/SA109.ini
  4. System/SA109.md5
  5. Help/SniperArena/SA109/SA109.ini.sample
  6. Help/SniperArena/SA109/LICENSE
  7. Help/SniperArena/SA109/SA_README.html ( and it's support files )

This archive should be unzipped into your UT2003 base directory in order for the files to be placed in the correct location. SA109 will not interfere with a currently installed Sniper Arena, since it does not replace or over-write older files. Since SA109's ini file is completely different from previous version, a default version is placed in your System directory. You will need to edit SA109.ini to use your previous setting, if you have been using an older version of Sniper Arena. See the Server section for information on how to set these values.

Server

Post Install

Once you have installed Sniper Arena 109, you will need to edit your server .ini file. Servers use UT2003.ini if not told differently.

You need to add ServerPackages=SA109 into the [Engine.GameEngine] section.

[Engine.GameEngine]
. ( other lines )
. 
ServerPackages=SA109

If you are using UTSecure, Sniper Arena 109 can run with bCheckSets set to True (tested against UTSecure 2.11). Sniper Arena 109 has the following MD5 information. This information can also be found in UT2003/System/SA109.md5.

Executing Class Engine.MasterMD5Commandlet
==================================================
 MD5 Database Management
==================================================

Performing full MD5 on SA109.u

 GUID = [84C4D3ADD7110C8CD000C6874E3993B7]
  MD5 = [11c56fd4e1c2ef3770a4c0afee0fd666]

Success - 0 error(s), 0 warning(s)

You will need to add, to the section of the version of UTSecure you are currently using, the following lines ...

[UTSecure###.UTChecker]
. ( other lines )
.
Checks=( FName="SA109.u", MD5="0322ca4b499fff6a506a3588b76382cc", ...
  MD5Type=2,GUID="100C0122D711F484D000C6874E3993B7", MaxGenerations=1)
bCheckSets=true

NOTE - Having extra spaces at the end of the line has been known to cause problems. I'm too lazy to test it, so for good measure don't put extra spaces at the end of the line. UT2003 urban legend #1. Oh yeah, the "..." just means continuation of the line.

At this point, normally I'd tell you to edit the SA109.ini to your liking, but Sniper Arena 109 offers better ways to configure the mutator over hand editing the .ini file. So I'll defer this topic till after you start a server. If you like hand editing .ini files, skip this section until you edit your .ini file.

Starting A Server

UT2003 has two says to start a server. One is via the Host Multiplayer Game menu in UT2003, the other is by using UCC.exe ( Windows ) or ucc-bin ( Linux ). For more information on UT2003 command line see The Admin Page. Here is an example ...

Windows

UCC.exe server <map>?game=<game class>mutator=SA109.MutSniperArena109ver ...
  ini=<ini file> log=<log file>

Linux

./ucc-bin server <map>?game=<game class>mutator=SA109.MutSniperArena109ver ...
  ini=<ini file> log=<log file>

With the server up, it's time to configure the server.

Configuration

There are three ways to configure Sniper Arena 109.

  1. Configure Mutator
  2. Web Admin Configuration
  3. Hand edit SA109.ini

Configure Mutator

UT2003 allows for configuration of some mutators via the Configure Mutator located under the Mutator tab in the Host Mutliplayer Game section. Just select "Frnz Sniper Arena 109" then click "Configure Mutator" to bring up the configuration GUI.

More information on this style can be found in the Client - Instant Action Section, since it's pretty much the same thing.

Web Admin Configuration

Web Admin is a feature of UT2003 that allows an admin to administrate the server via their web browser. It allow you to set the game rules from your web browser. You need to have your server configured to allow for web administration in order to configure Sniper Arena in this fashion.

To get to the Sniper Arena settings, click on Defaults, then SniperArena109. This will bring up the Sniper Arena settings. When done, click Accept to save the setting. Click on Restart Level to restart the server using the new settings.
RuleDescription
Arena ModeControls whether the game is arena style or normal.
Translocation in Arena ModeControls whether the translocator can be used in arena mode.
Default ScopeThe default scope for a new players and admin forced scope.
Force ScopeForce players to use the Default Scope.
Bot Rifle SoundSets the rifle sound for the bots.
Show Help MessageControls whether a help message is displayed.
Help TimerTime interval between when 'Help' messages are displayed.
Help MessageHelp message text.
Maximum AmmoMaximum sniper ammo a player can carry.
Initial AmountAmount of sniper ammo a player is spawned with.
Ammo DropAmount of ammo in dropped ammo pack.
Ammo PickupAmount of ammo in map pickups.
Fire RateSeconds between firing.
Crouched Fire RateSeconds between firing when crouched.
Headshot RadiusRadius around the head bone that will be considered a head shot.
Headshot DamageDamage caused by a head shot.
Normal DamageNormal body damage.
MomentumAmount of momentum to apply to hit player.
Adjust AttributesAllow adjustment of player attributes when killed or when scoring a kill.
Add Headshot HealthAmount of health added for a head shot.
Add Headshot FragsAmount of frags added, in addition to default frags, for a head shot.
HeadshotAddShieldAmount of shield points added for a head shot.
Add Headshot AdrenalineAmount of adrenaline added, in addition to default adrenaline, for a head shot.
Add Bodyshot HealthAmount of health added for a body shot.
Add Bodyshot FragsAmount of frags added, in addition to default frags, for a body shot.
Add Bodyshot ShieldAmount of shield points added for a body shot.
Add Bodyshot AdrenalineAmount of adrenaline added, in addition to default adrenaline, for a body shot.
Remove Headshot FragsAmount of frags to remove for being head shot.
Remove Headshot AdrenalineAmount of adrenaline to remove for being head shot.
Remove Bodyshot FragsAmount of frags to remove for being body shot.
Remove Bodyshot AdrenalineAmount of adrenaline to remove for being body shot.

Hand Edit SA109.ini

A sample of the SA109.ini file exist in the UT2003/Help/SniperArena/SA109 directory. This file should be copied to the UT2003/System directory, if it does not already exist there. Here is what SA109.ini looks like.

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

[SA109.ServerInfo]
bArenaStyle=True
bAllowTranslocator=False
DefaultZoomStyle=1
bForceZoomStyle=False
bShowHelp=True
BotRifleSound=0
HelpTimer=60
HelpMessage=For help with Frnz Sniper Arena, type 'mutate sahelp' in the console
MaxAmmo=50
InitialAmount=30
DropAmmoAmount=5
PickupAmount=10
FireRate=0.600000
CrouchFireRate=0.600000
HeadShotRadius=8.000000
HeadshotDamage=100
BodyDamage=45
Momentum=20000
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

Here is a description of the properties. All these properties are located in the [SA109.ServerInfo] section of SA109.ini

PropertyTypeDefaultDescription
bArenaStyleBooleantrueControls whether the game is arena style or normal.
bAllowTranslocatorBooleanfalseControls whether the translocator can be used in arena mode.
DefaultZoomStyleInteger1Sets the default scope.

0=UT2003
1=UT
2=None
3=UT2003 Clean

bForceZoomStyleBooleanfalseForce the DefaultZoomStyle on all players.
BotRifleSoundInteger0The sound a bot's rifle makes when fired.

0=Unreal
1=UT
2=Lightning Gun

bShowHelpBooleantrueControls whether a help message is displayed.
HelpTimerFloat60.00000Time interval between when 'Help' messages are displayed.
HelpMessageStringFor help with Frnz Sniper Arena, type 'mutate sahelp' in the console.Help message text.
FireRateFloat0.60000Seconds between firing.
CrouchFireRateFloat0.60000Seconds between firing when crouching.
MaxAmmoInteger50Maximum sniper ammo a player can carry.
InitialAmountInteger30Amount of sniper ammo a player is spawned with.
bDropAmmoBooleanFalseAllow ammo to be dropped when player is killed.
DropAmmoAmountInteger5Amount of ammo in dropped ammo pack.
HeadShotRadiusFloat8.00000Radius around the head bone that will be considered a head shot.
HeadshotDamageInteger100Damage caused by a head shot.
BodyDamageInteger45Normal body damage.
MomentumInteger20000Amount of force to apply to hit player.
bAdjustPlayerBooleanFalseAllow adjustment of player attributes when killed or when scoring a kill.
HeadshotAddHealthInteger10Amount of health added for a head shot.
HeadshotAddFragInteger1Amount of frags added, in addition to default frags, for a head shot.
HeadshotAddShieldInteger0Amount of shield points added for a head shot.
HeadshotAddAdrenalineInteger0Amount of adrenaline added, in addition to default adrenaline, for a head shot.
BodyshotAddHealthInteger0Amount of health added for a body shot.
BodyshotAddFragInteger0Amount of frags added, in addition to default frags, for a body shot.
BodyshotAddShieldInteger0Amount of shield points added for a body shot.
BodyshotAddAdrenalineInteger0Amount of adrenaline added, in addition to default adrenaline, for a body shot.
HeadshotRemoveFragInteger2Amount of frags to remove for being head shot.
HeadshotRemoveAdrenalineInteger0Amount of adrenaline to remove for being head shot.
BodyshotRemoveFragInteger1Amount of frags to remove for being body shot.
BodyshotRemoveAdrenalineInteger0Amount of adrenaline to remove for being body shot.
PickupAmountInteger10Amount of ammo in map pickups.

Client

Items

Sniper Arena has two map pickups. One is the Frnz Sniper Rifle. This pickup is only available when the server is set to non-arena mode. The seconds is the Frnz Sniper Ammo, which gives you sniper bullets.

Sniper Rifle
Sniper Rifle Pickup
Sniper Rifle
Sniper Ammo

Scopes

Sniper Arena offers four types of scopes.

UT2003 Zoom
UT2003 Zoom (default)
UT Zoom
UT Zoom
No Zoom
No Zoom
UT2003 Clean Zoom
UT2003 Clean Zoom

Instant Action

If you are planning on playing offline, you can change the settings of Sniper Arena via the Configure Mutator ability under the Mutator tab in the Instant Action section.

Just highlight Frnz Sniper Arena 109 in the Available Mutators list, click Add, and it should move over into the Active Mutators list.

If you highlight Frnz Sniper Arena 109 again, you'll notice that it will display a description and a button called Configure Mutator. If you click on the button, a configure menu system will appear that will allow you to change the setting in Sniper Arena. Currently, there is no way to automatically restore the default values. Default values can be found in the Server - Hand Edit SA109.ini

General

The General tab controls the basic functions of the mutator. You can choose from the following settings on this screen.

SettingDescriptionDefault
Arena ModeControls whether the game is arena style or normal.Checked
Allow TranslocationControls whether the translocator can be used in arena mode.Not Checked
Default ScopeThe default scope for a new players and admin forced scope.UT
Bot Rifle SoundSets the rifle sound for the bots.Unreal
Force Default Scope on PlayersForce players to use the Default Scope.Not Checked
Show Help MessageControls whether a help message is displayed.Checked
Help MessageHelp message text.NA
Help TimerTime interval between when 'Help' messages are displayed.60

Rifle

The Rifle tab controls the settings of the rifle. You can choose from the following settings on this screen.

SettingDescriptionDefault
Fire RateSeconds between firing..60
Crouched Fire RateSeconds between firing when crouched..60
Headshot RadiusRadius around the head bone that will be considered a head shot.8.0
Headshot DamageDamage caused by a head shot.100
Body DamageNormal body damage.45
MomentumAmount of momentum to apply to hit player.20000
Maximum AmmoMaximum sniper ammo a player can carry.50
Initial AmountAmount of sniper ammo a player is spawned with.30
Ammo DropAmount of ammo in dropped ammo pack.5
Ammo PickupAmount of ammo in map pickups.10

Attributes

The Attributes tab controls attributes that affect a player when killed or when they have killed.

SettingDescriptionDefault
Adjust Player AttributesAllow adjustment of player attributes when killed or when scoring a kill.Not Checked
Headshot + HealthAmount of health added for a head shot.10
Headshot + FragsAmount of frags added, in addition to default frags, for a head shot.1
Headshot + ShieldAmount of shield points added for a head shot.0
Headshot + Adren.Amount of adrenaline added, in addition to default adrenaline, for a head shot.0
Bodyshot + HealthAmount of health added for a body shot.0
Bodyshot + FragsAmount of frags added, in addition to default frags, for a body shot.0
Bodyshot + ShieldAmount of shield points added for a body shot.0
Bodyshot + Adren.Amount of adrenaline added, in addition to default adrenaline, for a body shot.0
Headshot - FragsAmount of frags to remove for being head shot.2
Headshot - Adren.Amount of adrenaline to remove for being head shot.0
Bodyshot - FragsAmount of frags to remove for being body shot.1
Bodyshot -Adren.Amount of adrenaline to remove for being body shot.0

Console Commands

The commands hudtype, zs_on, zs_off, and zs_toggle have been removed in favor of the mutate commands.

The new commands use the mutate command format. They can be called as a spectator, and when you are alive or dead in the game.

CommandDescription
mutate sahelpBrings up the help screen.
mutate sarifleBrings on the rifle configuration screen.
mutate saserverBrings on the server information screen.

The mutate commands can be bound to a key for quick access. The following is the UT2003 console command to bind a key. Replace <key> with the keyboard key your wish to press in order to bring up the desired screen.

set input <key> mutate sahelp
set input <key> mutate sarifle
set input <key> mutate saserver

Client Menu Screen

Help Tab

mutate sahelp brings up this menu screen.

The in-game help screen displays important information about playing Sniper Arena for the current server. The information changes based on the setting of the server, the setting for Sniper Arena on the current setting, and your current rifle settings.

Rifle Tab

mutate sarifle brings up this menu screen.

This screen allows you to select a sniper scope, turn on and off zoom sounds, and set the rifle shot sound you wish to be heard from your rifle. Any changes on this screen will be saved. If the server is running with Force Default Scope enabled, you will not be able to select a different scope. You will still be able to change the zoom and rifle sounds.

Sever Info Tab

mutate saserver brings up this menu screen.

This screen shows the server settings of the current server.

About Tab

The in-game thanks page.

SniperArena.ini

If the GUI is not your cup of tea, you can always hand edit the SniperArena.ini file to your liking. All properties are part of the [SA109.ClientInfo] section.

PropertyTypeDefaultDescription
ScopeInteger0Your sniper scope

0=UT2003
1=UT
2=None
3=UT2003 Clean

RifleSoundInteger0Your rifle shot sound

0=Unreal
1=UT
2=Lightning Gun

bZoomSoundBooleantrueControls whether sounds are played when you zoom.

Notes

Known "Problems"

TODO

Change Log

Release 109

Release 108

Release 107x

Release 106

Release 105

Release 104

Release 103

Release 102

Release 101

Release 100 (First Release)