    Author        : $Author: jwalstra $
    Revision      : $Revision: 1.2 $
    Checkout Date : $Date: 2004/05/11 03:42:46 $
    Source File   : $Source: /home/cvs/SA2K4/Help/README.html,v $

    // Copyright (C) 2003 John Walstra
    // spoon@spoonware.org
    // http://spoonware.org
    //
    // This library is free software; you can redistribute it and/or
    // modify it under the terms of the GNU Lesser General Public
    // License as published by the Free Software Foundation; either
    // version 2.1 of the License, or (at your option) any later version.
    //
    // This library is distributed in the hope that it will be useful,
    // but WITHOUT ANY WARRANTY; without even the implied warranty of
    // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    // Lesser General Public License for more details.
    //
    // You should have received a copy of the GNU Lesser General Public
    // License along with this library; if not, write to the Free Software
    // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
    //
    // See LICENSE.uc or LICENSE
# About This is the UT2004 version of my UT2003 Sniper Arena. For UT2003, Epic decided to remove the sniper rifle. This did not sit well with the sniper community of Unreal Tournament ( UT99 ) who were being left out in the cold. So for UT2003, I decided to create a simple mutator that would add back the sniper rifle. After 11 releases, the simple mutator evolved into more than just an arena mutator. Then it was announced that UT2004 would include the sniper rifle, I figured my work was done. However, while the UT2004 sniper rifle is very nice, it still does not cater to those that play arena style. So now, here we are. The UT2004 version of my sniper "arena". Enjoy, spoon (aka supun) http://spoonserver.org # Thanks Col Kassad - For the making the sniper rifle models work. # Installation This version uses the same SA2K4Media package as Sniper Arena 2K4 100. The archived file should contain the following files (along with images for the README) System/SA2K4_101.u System/SA2K4Media_100.u System/SA2K4_101.ucl System/SA2K4_101.md5 System/SA2K4Media_100.md5 Help/SA2K4_101/README.html ( this document ) Help/SA2K4_101/LICENSE Help/SA2K4_101/images/* ( related help images ) Web/SA2K4WebAdmin/* ( web admin pages ) Web/images/SA2K4/* ( web admin images ) This archive should be unzipped into your UT2004 base directory in order for the files to be placed in the correct location. # Server ## Post Install Once you have installed Sniper Arena 2K4, you will need to edit your server .ini file. Servers use UT2004.ini, if not told differently. You need to add a few entries to your server's ini file. The Engine.GameEngine is required in order for a connecting client to receive the mutator from the server via a download, if they do not have it already. The UWeb.WebServer section is required for configuring the mutator via a web browser. In the sample below, replace 2 with the next available number if 2 is already in use.
    [Engine.GameEngine]
    ServerPackages=SA2K4Media_100
    ServerPackages=SA2K4_101

    [UWeb.WebServer]
    Applications[2]=SA2K4_101.WebServerAdmin
    ApplicationPaths[2]=/SA2K4WebAdmin
If you use AntiTCC or UTSecure, here is the MD5 information. SA2K4_101 has the following MD5 information.
    Executing Class Engine.MasterMD5Commandlet
    ==================================================
     MD5 Database Management
    ==================================================

    Performing full MD5 on SA2K4_101.u

     GUID = [E047A930D8119AA7D000C6874E3993B7]
      MD5 = [e8dcf848cbaeb389a4f9735acaae6bdc]

    Success - 0 error(s), 0 warning(s)
SA2K4Media_100 has the following MD5 information.
    Executing Class Engine.MasterMD5Commandlet
    ==================================================
     MD5 Database Management
    ==================================================

    Performing full MD5 on SA2K4Media_100.u

     GUID = [F21A57C7D811FCA2D000C6874E3993B7]
      MD5 = [2b7abaf28438d2173ad018f89e74ba62]

    Success - 0 error(s), 0 warning(s)
## Starting A Server UT2004 has two ways to start a server. One is via the Host Game menu in UT2004, the other is by using UCC.exe ( Windows ) or ucc-bin ( Linux ). Windows
    UCC.exe server <map>?game=<game class>mutator=SA2K4_101.MutSniperArena
    ini=<ini file> log=<log file>
Linux
    ./ucc-bin server <map>?game=<game class>mutator=SA2K4_101.MutSniperArena \
      ini=<ini file> log=<log file>
With the server up, it's time to configure the server. ## Configuration There are two ways to configure Sniper Arena 2K4. Configure Mutator Web Admin Configuration It is not recommended that you configure the mutator by hand. ### Configure Mutator UT2004 allows for configuration of some mutators via the Configure Mutators located under the Mutators tab in the Host Game section. Just select "Sniper Arena 2K4 101", click add, then click Configure Mutators, at the bottom of the screen, to bring up the configuration GUI. This will open a page and display items that can be configured for your selected mutators. Sniper Arena 2K4 will have an Open button. Click this to open the configuration screen for Sniper Arena 2K4. #### Help The Help Message screen is used to set the help message that appears in the console.
Help Message
Show help Message | Check box to enable/disable the help message
Help Message | Help message text
Help Timer (seconds) | Delay between messages in seconds.
#### Configurations The Configurations screen is used map the game type to a configuration. First click on a game type in the Game Types box. The corisponding configuration will be highlighted in the Configurations box. If you click on a different configuration in the Configuration box, that configuration will be used for that game type. The same configuration can be used with multiple games types. The Edit Configuration section on this screen allows you configure the configurations. Just select the configuration you wish to edit in the drop down box and click on Edit. #### General The General tab contain general game options and the name of the configurations.
General
Arena Mode | Check for arena mode, unchecked for lightening gun/stock sniper rifle replacement
Allow translocator | If checked, the translocator will not be removed in arena mode.
Spawn with sniper rifle | If checked, players spawn with the sniper rifle in non-arena mode/replacement mode.
Arena safe link gun | If checked, players will be allowed to pick up a link gun that does not do damage.
Allow special weapons | If checked, weapons that are built into the map are not removed.
Allow health pickups | If checked, health items will remain in the map.
Allow shield pickups | If checked, shield items will remain in the map.
Allow damage amplifier | If checked, the damage amplifier pickup will remain in the map.
Allow super weapons | If checked, super weapons will remain in the map for arena mode.
#### Scope The Scope tab contain scope related configurations.
Scope
Force Default Scope | If checked, player will be forced to play with the scope below.
Available Scopes | Scope player would be forced to play with, if forced.
Maximum Zoom Multiplier | Control the distance you can zoom.
#### Rifle The Rifle tab contain the rifle related configurations.
Rifle
Normal Fire Rate | Seconds between firing.
Crouched Fire Rate | Seconds between firing when crouched.
Headshot Radius | Radius around the head that will be considered a head shot
Headshot Damage | Damage caused by a head shot
Body Damage | Damage cause by a normal body shot
Vehicle Damage | Damage to a vehicle
Hit Momentum | Amount of momentum to apply to hit player.
Team Momentum Adj | Increase or decrease the amount of boost applied to teammates
Fire Range | Distance the rifle can fire
Bot Sniper Rifle Sound | The sound of the rifle used by the bot.
Sniper Rifle Model | The rifle model to be used
Show Tracer Bullet | If checked, a tracer fire effect will be displayed
Show Smoke Cloud | If checked, a smoke cloud will be emitted by the snipe rifle.
#### Ammo The Ammo tab contain the ammo related configurations.
Ammo
Maximum Ammo Amount | Maximum sniper ammo a player can carry.
Initial Amount | Amount of sniper ammo a player is spawned with.
Drop Ammo Amount | Amount of ammo in dropped ammo pack.
Pickup Ammo Amount | Amount of ammo in map pickups.
#### Attributes The Attributes tab contain the bonuses and penalties for killing or being killed
Attributes
Adjust Player Attributes | Allow adjustment of player attributes when killed or when scoring a kill.
Headshot + Health | Amount of health added for a head shot.
Headshot + Frags | Amount of frags added, in addition to default frags, for a head shot.
Headshot + Shield | Amount of shield points added for a head shot.
Headshot + Adren. | Amount of adrenaline added, in addition to default adrenaline, for a head shot.
Headshot + Ammo. | Amount of ammo added for a head shot.
Bodyshot + Health | Amount of health added for a body shot.
Bodyshot + Frags | Amount of frags added, in addition to default frags, for a body shot.
Bodyshot + Shield | Amount of shield points added for a body shot.
Bodyshot + Adren. | Amount of adrenaline added, in addition to default adrenaline, for a body shot.
Bodyshot + Ammo. | Amount of ammo added for a body shot.
Headshot - Frags | Amount of frags to remove for being head shot.
Headshot - Adren. | Amount of adrenaline to remove for being head shot.
Bodyshot - Frags | Amount of frags to remove for being body shot.
Bodyshot - Adren. | Amount of adrenaline to remove for being body shot.
### Web Admin Configuration Web Admin is a feature of UT2004 that allows you to administrate the server via a web browser. It allows 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. Sniper Arena 2K4 however does not use the normal web admin pages. It uses it's own pages. To access these pages, you need to go to http://yourserver:port/SA2K4WebAdmin in your web browser. #### Main Page The Main Page shows the current configuration setup. What is shown is a list of game types and which configuration it will use. A configuration can be use by multiple games types. #### Help Message The Help Message page is used to set the help message that appears in the console.
Help Message
Show help Message | Check box to enable/disable the help message
Seconds between messages | Delay between messages in seconds.
Help Message | Help message text
#### Configuration The Configuration page is used map the game type to a configuration. First click on a game type in the Game Types box. The corisponding configuration will be highlighted in the Configurations box. If you click on a different configuration in the Configuration box, that configuration will be used for that game type. The same configuration can be used with multiple games types. Click Update to save the configuration map. The Edit Configuration section of this page allows you configure the configurations. Just select the configuration you wish to edit in the drop down box and click on Edit. #### Configuration - Edit Page
General
Arena Mode? | Check for arena mode, unchecked for lightening gun/stock sniper rifle replacement
Allow translocator in arena model? | If checked, the translocator will not be removed in arena mode.
Spawn with sniper rifle in normal mode? | If checked, players spawn with the sniper rifle in non-arena mode/replacement mode.
Allow safe link gun in arena mode? | If checked, players will be allowed to pick up a link gun that does not do damage.
Keep special weapons? | If checked, weapons that are built into the map are not removed.
Allow health pickups? | If checked, health items will remain in the map.
Allow shield pickups? | If checked, shield items will remain in the map.
Allow damage amplifier pickups? | If checked, the damage amplifier pickup will remain in the map.
Allow super weapons? | If checked, super weapons will remain in the map for arena mode.
Scope
Force default scope? | If checked, player will be forced to play with the scope below.
Default Scope | Scope player would be forced to play with.
Scope Multiplier | Control the distance you can zoom.
Rifle
Normal Fire Rate | Seconds between firing.
Crouched Fire Rate | Seconds between firing when crouched.
Headshot Radius | Radius around the head that will be considered a head shot
Headshot Damage | Damage caused by a head shot
Normal Damage | Damage cause by a normal body shot
Vehicle Damage | Damage to a vehicle
Hit Momentum | Amount of momentum to apply to hit player.
Teamboost Adjustment % | Increase or decrease the amount of boost applied to teammates
Range of Fire | Distance the rifle can fire
Show Tracer Round? | If checked, a tracer fire effect will be displayed
Show Smoke Cloud? | If checked, a smoke cloud will be emitted by the snipe rifle.
Rifle Model | The rifle model to be used
Bot Rifle Sound | The sound of the rifle used by the bot.
Ammo
Maximum Ammo | Maximum sniper ammo a player can carry.
Initial Amount | Amount of sniper ammo a player is spawned with.
Ammo Drop | Amount of ammo in dropped ammo pack.
Ammo Pickup | Amount of ammo in map pickups.
Attributes
Adjust Attributes | Allow adjustment of player attributes when killed or when scoring a kill.
Headshot - Add Health | Amount of health added for a head shot.
Headshot - Additional Frags | Amount of frags added, in addition to default frags, for a head shot.
Headshot - Add Shield | Amount of shield points added for a head shot.
Headshot - Additional Adrenaline | Amount of adrenaline added, in addition to default adrenaline, for a head shot.
Headshot - Add Ammo | Amount of ammo added for a head shot.
Bodyshot - Add Health | Amount of health added for a body shot.
Bodyshot - Additional Frags | Amount of frags added, in addition to default frags, for a body shot.
Bodyshot - Add Shield | Amount of shield points added for a body shot.
Bodyshot - Additional Adrenaline | Amount of adrenaline added, in addition to default adrenaline, for a body shot.
Bodyshot - Add Ammo | Amount of ammo added for a body shot.
Headshot - Remove Frags | Amount of frags to remove for being head shot.
Headshot- Remove Adrenaline | Amount of adrenaline to remove for being head shot.
Bodyshot - Remove Frags | Amount of frags to remove for being body shot.
Bodyshot - Remove Adrenaline | Amount of adrenaline to remove for being body shot.
## Map Vote You can enable Sniper Arena 2K4 via the map vote. It can be added via the UT2004 Web Admin or by adding the GameConfig lines to UT2004.ini.
    GameConfig=(GameClass="XGame.xDeathMatch",Prefix=,Acronym=,GameName="DM SA2K4",
                Mutators="SA2K4_101.MutSniperArena",Options=)
Sniper Arena 2K4, by default, will match the configuration to the game type, however this can be over-riden. The option is SAConfig and it must be passed in via the Options parameter. For example, if you have two death-match games, and wish them to uses different configurations, you would specify different SACOnfig values for each games.
    GameConfig=(GameClass="XGame.xDeathMatch",Prefix=,Acronym=,GameName="Test 1",
                Mutators="SA2K4_101.MutSniperArena",Options="SAConfig=0")
    GameConfig=(GameClass="XGame.xDeathMatch",Prefix=,Acronym=,GameName="Test 2",
                Mutators="SA2K4_101.MutSniperArena",Options="SAConfig=1")
Valid values are 0 through 9. You can find the correct SAConfig number by looking at the main page on the web admin page, the web admin configuration edit page, or by looking on the mutator configuration, general tab by the configuration name. # Client ## Items Sniper Arena 2K4 has two sniper models, the stock UT2004 and the UT99 sniper rifle. UT2004 Sniper Rifle Pickup UT99 Sniper Rifle Pickup ## Scopes Sniper Arena offers five types of scopes.
UT99 Scope | UT2004 Scope
UT2003 Scope | UT99/2004 Hybrid
and no scope ( not shown ). ## Console Commands Most of the Sniper Arena 2K4 commands use the mutate command format. They can be called as a spectator, and when you are alive or dead in the game.
Commands
mutate sahelp | Brings up the help screen.
mutate sarifle | Brings on the rifle configuration screen.
mutate saserver | Brings on the server information screen.
zoomin | While zoomed, will increase the zoom.
zoomout | While zoomed, will decrease the zoom.
The mutate commands can be bound to a key for quick access. The following is the UT2004 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
    set input <key> zoomin
    set input <key> zoomout
## 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. # Known "Problems" Weapons lockers have UT2004 sniper model in them, even if you are using UT99 sniper model. # Releases ## Release 101 Fixed the web admin so it would work with IE. Fixed the problem with the UT99 skin being used on the UT2004 sniper rifle. ## Release 100 (First Release) Ported UT2003 Sniper Arena to UT2004