      ----------------------------
      * HexenWorld CTF beta 0.92 *
      ----------------------------

Contents
-----------------------------------

	Requirements 
	Installation 
	How to play HWCTF 
	HWCTF scores 
	New commands and impulses 
	Grapling hook
	Spectator Mode
	Server options 
	Credits 

Requirements 
----------------------------------------------------------------
                                                                                 
To run HWCTF you need: 

    - Hexen2 registered, patched to version 1.11 or 1.12 (1.12 is for mission pack) 
    - HexenWorld client version 0.15 
    - HexenWorld sever (only if you want to run a HWCTF server) version 0.15 

Hexen2 upgrade patch and HexenWorld client/server can be downloaded at http://www.hexenworld.com 
  

Installation 
----------------------------------------------------------------
                                                                                 
To install HWCTF run hwctf092.exe included in this package and follow the instructions. The installer will prompt
you for your Hexen2 directory and will create a /hwctf folder in it. It will also prompt you for your Hexen2 program
group in start menu to add shortcuts for HWCTF client, GL HWCTF client and HWCTF server and for this file. 
  

How to play HWCTF 
----------------------------------------------------------------
                                                                                 
HWCTF is a Capture The Flag mod for HexenWorld. CTF rules are quite simple: there are two teams, each having
a flag to protect. The goal is to capture enemy flag as many times as possible to get points while protecting your
flag from the enemy. The teams who scores the most points wins the game when timelimit or fraglimit is reached. 

When you connect to an HWCTF sevrer, there are two possible case: either you enter a map with a start room
(none of these included with HWCTF release as of now, but maps other maps poeple might do could have one) or a
map without start room. Siege/Rival Kingdoms/Dungeon Break players will be familar with the start room concept.
HWCTF start rooms works just like start rooms in these mods. For those who dont know how the starting room
works, its simple: you are in a room and two teleports, one for each team (there might be a third one for random
team). To join a team go in the appropriate teleport. If the map server is runnign doesnt have a start room, you are
in raven observer mode (you are a raven and can fly around the map. When in raven observer mode you cant
attack, pickup stuff or get killed. Press 1 to join gold team, 2 for silver and 3 for random team (random team is not
really random: it puts you in the team with less players, its random only if there is the same number of players in
each team).

Once in a team, your goal is to capture enemy flag and protect yours. To capture enemy flag, you first need to pick
it up (either from enemy base or from floor is it has been droped) and carry it to your own base. Once you are at
your own base, all you need to do to capture enemy flag (assuming that you carry it!) is to touch your own flag (your
flag need to be at its base, you cant capture if the enemy has your flag). If you kill an enemy carrying your flag, the
flag will drop to floor. You can return it to your base by touching it (no need to carry it back to your base). Flag will
also return if it stays dropped on the floor for more than a minute. 
  

HWCTF scores 
----------------------------------------------------------------
                                                                                 
Scores are awarded for different actions you do in HWCTF. There are two types fo score: team score and
personnal score. When a flag is captured, the player who captures it gets 15 points in his personnal score and all
toher players in his team get 10 points in their personnal score, and 10 points are added to Team score. 
Points are also awarded for killing an enemy, taking a flag from enemy base or returning a flag, and there is a
penality for killing self or a teammate. 
These awards/penalities are added/substracted to Team score and to the player's personnal score (only the player
who killed enemy or teammate, not all team). 
  
See the HTML version of this document for more information on scores.  


New commands and impulses 
----------------------------------------------------------------
                                                                                 
HWCTF has some new commands that are not in Hexen2/HexenWorld. There are three ways to use these new
commands: 

Impulses: you can call the commands by typing "impulse X" (no quotes) in the console where X is the impulse #
corresponding to the command. The new impulses are: 

     240: prints scores to screen (should be very much usefull since scores are displayed in bottom left corner) 
     242: resets grapling hook in case your hook stops working
     243: switch grapling hook type (see Grapling hook section) 
     251: drop your current weapon. 
     252: drop your team (go back in start room for maps with start room, or return to raven spectator mode). 
     253: drop the flag if you are carrying it. 
      

These impulses have been aliased in autoexec.cfg so you can also use their alias instead of the impulse. To use the
aliases, just type the name in the console: 

     scores 
     switch_hook 
     drop_weapon 
     drop_team 
     drop_flag

The third way is by binding an impulse or alias to a keyboard key. To do this, add this to the autoexec.cfg file
located in your hwctf folder for each command you want to bind to a key: 

          bind key "command_name"

Replace key with the key you want to bind and command_name with the name of the command or impulse you want
to bind to the key (ex  bind r "switch_hook"  or  bind tab "impulse 251"). 

There are also some other commands for the grapling hook, see the Grapling hook section for more information
about them. 
  

Grapling hook 
----------------------------------------------------------------                                                                                 

Two types of grapling hook are available to players in HWCTF: ThreeWave CTF style hook, and swing hook. 
Default hook is the ThreeWave one, but players can chose what hook they want to use with impulse 253 or the
switch_hook alias. 

     ThreeWave hook:  press shift to throw the hook (see below for reconfiguring) and hold shift down. When the
     hook attaches to a wall it will pull you in that direction. Release shift to drop. If you throw hook and
     immediately release shift it will pull you untill you press and release shift again. 

     Swing hook: swing hook is a little more complicated than the other. To throw it, press shift. If you hold shift
     down, it will pull you when it attaches to something. If you dont, it will just attach but not pull you. Hook will
     stay attached untill you press shift again. Once attached, if you are holding shift hook will pull you. If you are
     not holding shift down, you can move up/down the hook either by jumping/crouching or pressing y (up) or h
     (down). 
      

Reconfiguring hook: 

     Both hook are using the same set of impulses and aliases to work, you cant configure them separatly. 
     To reconfigure hook, open autoexec.cfg in notepad and locate this part: 
       
          // here is where you set your keys 
          // only change 'SHIFT', 'w', or 'r' to whatever key you desire 

          bind SHIFT +hook  // hook on/off toggle 
          bind h +grow   // for sliding down the chain 
          bind y +shrink   // for climbing up the chain 
           
     Just change SHIFT, h and y to whatever keys you want.


Spectator Mode
----------------------------------------------------------------

Before you join a team, you are in spectator mode. In this mode, you cant attack or be hurt, and you are invisible.
There are 2 spectator modes: free and follow modes. In free mode you fly around like with a ring of flight, in follow mode
you will follow another player. To activate follow mode, just press the throw hook key (default is SHIFT).
Press that key again to rotate through all players and free mode.

When in follow mode, press and hold attack to adjust the following distance. Everytime press attack it will
alternate between lowering distnace and increasing it (ie, first time you adjust distance, it will
decrase, second time it will increase, third time decrease and so on)


Server options 
----------------------------------------------------------------
                                                                                 
HWCTF also has some new server options that are set with the teamplay server variable. 
These options are bitfields, if you want more than one of these enabled just set teamplay to the sum of all the
options you want: 
  
  
1	TEAM_HEALTH_PROTECT		No health damage if hurting teammate.
2	TEAM_ARMOR_PROTECT		No armor damage if hurting teammate.
4	TEAM_ATTACKER_DAMAGE		Attacker takes damage from hitting teammates.
8	TEAM_FRAG_PENALTY		One extra frag penalty in personnal score for killing teammate.
16	TEAM_DEATH_PENALTY		Die when you kill a teammate.
32	TEAM_NO_HOMING			Homing weapons dont home at teammates.
64	TEAM_MONSTERS			Summoned monsters (imps) dont attack teammates.
128	TEAM_STATIC_TEAMS		Don't allow players to switch teams (disable impulse 252)
256	TEAM_AUTOTEAM			When players join a team, its always auto-team whatever team they chose
512	STRAIGHT_DM			Disable CTF, only straight deathmatch
1024	TEAM_DM				Enable Team Deathmatch mode (same as CTF but without the flags)

There are also these new 0.92 options:

    patternrunner
      - set the minimum number of player needed to allow uneven teams.
      - add 128 to that number to enable real patterrunner command

    tomemode 3 => tomes used ONLY for unsheep.

    easyfourth:
      1 - normal easyfourth (need only 1 piece of 4th weapon to get complete 4th weapon)
      2 - players always respawn with weapon2
      4 - players always respawn with weapon3
      8 - players always respawn with weapon4
      16 - remove all weapon2
      32 - remove all weapon3
      64 - remove all weapon4

    See artifacts2.cfg for number of artifacts players can carry options


Credits 
----------------------------------------------------------------
                                                                                 
A special thanks to all those who worked making HWCTF a reality! 
  
  - Raven Software for making Hexen2 and HexenWorld 
  - Id Software for the Quake engine used in Hexen2 
  - Activision for publishing Hexen2 
     HWCTF files are unsupported by Raven Sofwtare, Id software or Activision 
  
  - Spencer (Phayyde) Jones - the "grandfather" of HexenWorld CTF, as well as the Hexen II modding scene. 
  - William (Phoebus) Mull - HexenWorld CTF Project Administrator, some of HWCTF sounds 
  - Marc (Kor Skarn) Allaire - HWCTF code based on Phayyde's H2ctf 2.0, some graphics, maps, this file. 
  - Steve (Ancient 1) Hoier - Start room, pictures used for console background and web site. 
  - Max (MadMax) Rebo - maps. 
  - Tobias (Tobey) Persson - maps. 
  - Headrot - maps 
  - Steve (Wedge) Bond - ThreeWave style Grapling hook 
  - Perecli (Bort) Manole - Swing hook 
  - Patrick (Millennium) - skins 
  - Curry and Carl (Melkior) Kidwell - skins 
  - Someone at Activision (dont know who) - new sounds 

  MAPS: 
  
  assylumctf.bsp - Headrot 
  ctf1.bsp - Headrot 
  ctf2.bsp - Headrot 
  ctf_fin3.bsp - MadMax 
  tob_ctf.bsp - Tobey 
  hwctf_osiris.bsp - Kor Skarn 
  hwctf_tomb.bsp - Kor Skarn 
  hwctf_temple.bsp - Kor Skarn 
  
 And all the others not listed here who helped in the making and testing of HWCTF. 
----------------------------------------------------------------------------------------                                                                                 

The installer for this product was created using Installer VISE from 
MindVision Software. For more information on Installer VISE, contact: 

MindVision Software 
7201 North 7th Street 
Lincoln, NE 68521-8913 
Voice: 402-477-3269 
Fax: 402-477-1395 
Internet: mindvision@mindvision.com 
http://www.mindvision.com 
  