Name of Mod        : Head Soccer
File Name          : hedsoc9b.zip
Version            : 0.9b
Date               : December 20, 1998
E-mail             : thefatal@telefragged.com
Web Site           : http://www.telefragged.com/thefatal/head.shtml

Additional Credits : Q2God12 and Brian McClelland for level designing
                     work (see their seperate map text files in the
                     \maps folder, which are named appropriately to
                     their respective maps) and everyone who helped in
                     any way with the mod or gave us words of
                     encouragement (and of course those lovely
                     TeleFragged folks who so kindly host me for free).
                     Special thanks to Alan Kivlin (Strider) for
                     providing the QW rankings/skin/etc. code.

AUTHOR INFO
-----------
I wrote the Famkebot and did many other things.

TYPE OF MOD 
-----------
This is a partial conversion for QuakeWorld, there are no plans
for a "Normal Quake" port as of now.

QuakeC   : Yep.
Sound    : Yep (head sounds, taunt sounds).
MDL      : Nope (not yet, anyway).
Maps     : Yep.
Graphics : Yep (skins).

INSTALLATION
------------
Extract the zip file to your Quake directory (e.g. c:\quake) and make
sure you use a -d to unzip with directory structure if you're using
pkunzip.exe (if you don't know how to do that with the extractor you're
using, see its documentation). Then start your QuakeWorld server by
adding "+gamedir headsocr" (without quotation marks) to the command line.
Make sure you edit the server.cfg (you may use any text editor, such as
Windows Notepad or DOS EDIT) to your liking before starting the server.
For help, just read the commented (//) lines in the server.cfg which
explain what things do. If you need additional help (though I don't know
why you would), then you may e-mail me. Also, if you're running a server
on a fast connection that's up more than it's down, e-mail me and you'll
be mentioned on the Head Soccer web page. If you're playing by yourself
(against bots), first start a server (qwsv) as described above, then
start QuakeWorld (qwcl or glqwcl) and type "connect localhost" in the
console. You can then use impulse 50 (or type addbot in the console) to
add bots (which will be set to teams automatically depending on which
team needs more players). If you're interested in making your own Head
Soccer level, see the "mapspecs.txt" file that's in the same directory
as this file.


SETTINGS AND COMMANDS
---------------------
*deathmatch cvar*
The deathmatch cvar can be set to 1 or 3. Setting it to 3 will disable
bots, 1 will have everything at default. Add .1 to either value (e.g.
3.1 or 1.1) to disable voting on your server.

*teamplay cvar*
The teamplay cvar can be set to 0, 1 or 2 and can also be set through
voting by players on the server. 0 is the default in which no one can
hurt eachother, 1 makes it so you can only kill players on the team
opposite of you, and 2 makes it so you can kill everyone (with a 1 frag
penalty for killing players on your team). Add .1 to any of the values
to force players to have team skins, add .2 to force all players to base
skins (handy for clan matches). You can also set teamplay to 1.5 if you
want teamplay 0's rules with the teamplay scoreboard (which I recommend).
Note that bots will also obey skin rules.

*samelevel cvar*
Set to 50 to use the \custmaps CFG files for map rotation, or set to
whatever you please (see quakeworld.net for how to use original cvars
such as samelevel).

*allowteamvote variable*
Set this to 0 in your server.cfg if you don't want clients to be able
to vote on changing the teamplay cvar.

*getfrags variable*
Setting this to 0 will make it so players don't get frags by killing
eachother if teamplay is set to let them do so. Set it to 1 will give
them frags for killing eachother.

*losefrags variable*
Setting this to 0 will make it so players don't get frags subtracted
for killing themselves or teammates if teamplay is set to let them do so.
They'll still lose frags for things like falling in lava. Setting it to 1
will subtract frags if players kill themselves or teammates.

*joininprogress variable*
Setting this to 1 allows players to join in the game at any time even
if a game is already in progress. Setting to 0 will only allow players
to join in between rounds.

*allowteamchange variable*
This sets if players should be able to switch teams at any time rather
than having to reconnect. Players can switch teams by typing "team red"
or "team blue" (depending on which team they're already on) at the
console.

*allowtaunt variable*
Setting to 1 enables players to use the taunt sounds which they can
replace with whatever they like. Setting to 0 makes the taunt commands
do nothing.

*use_rl variable*
Set to 1 to enable the RL, set to 0 to disable. Players can also vote on
changing this.

*axedamage variable*
This allows you to set how much damage the axe does when it hits an
entity that can take damage. The default is 50. Also note that the ball
will fly farther the more damage the axe does (so making the axe do 1000
in damage could make it so the axe could bash the ball all the way across
a field about the size of soccer13's).

*kickslowdown variable*
Setting to 1 will bounce the players up and push them back slightly like
they're actually kicking the ball. This also makes it easier to catch up
to a player who is kicking the ball down the field.

*addbot command* (clients only)
This simply adds a bot into the game if bots are enabled on the server.
It can be used from observer mode and while playing.

*levelvote command* (clients only)
This will bring up a list of levels to choose from. Once you choose,
your request will be seen by all players and they'll type "yes" or "no"
to vote on if they want to go to the level you selected.

*teamplayvote command* (clients only)
This allows you to set the teamplay cvar on the server by voting. See
the explanation for "teamplay cvar".

*taunt_# commands* (clients only)
# should be a number between 1 and 10. This will play the appropriate
taunt sound if the server has allowtaunt set to 1. You can replace the
sounds (they're located in headsocr\sound\taunt\) with whatever you want.
The originals were taken from various places and were all available for
public use.

BUGS, ETC.
----------
If you find a game/server-crashing bug, please e-mail me and notify
me of what you were doing when it happened. I'm already aware of any
other bugs that currently exist, so please don't bother e-mailing me
about them just yet. The bots, of course, aren't the smartest and
don't work too well on some levels. It's best to play on a level like
soccer13 if you're using bots. The most annoying bugs that currently
exist are ones involving lag. Sometimes a player will be left in the
space he's currently in after the round ends or his score won't be
updated if he experiences severe lag (e.g. 100% packet loss type lag).
This will be fixed in future updates, as it isn't that much of a problem,
especially not for LAN games or other environments which have very little
or no lag.

OTHER NOTES
-----------
Of course, I highly recommend playing with real players over bots... no
matter how good the AI, bots just aren't the same. :) The 2 levels
included with this version of HS that bots are most likely to score in
and perform well in are all.bsp and soccer13.bsp. If you get a message
saying "Note: This level is not supported by bots, they won't act
correctly", it doesn't mean you can't use bots on the level. It simply
means the level author didn't put bot-specific entities in the level, so
the bots don't know where the goals are and will just kick the ball at
a randomly set origin. Remember, if running a server, MAKE SURE you setup
your server.cfg first. If you're running a server for public use, you'll
most likely want to disable bots and enable things like voting. The main
reason it's an option to use the CFG files in \custmaps for map rotation
is because you can add things to each map config file, which allows for
you to actually change the server settings depending on the level.
However, if you want to use the traditional map rotation method and want
settings the same for each map, then just set samelevel appropriately
(you'd probably want to set it at 0). If you need help with other server
settings or don't know what they mean, please go visit
http://www.quakeworld.net/.

COPYRIGHT/PERMISSIONS
---------------------
Contact me if you want to put this on a game magazine CD or something
like that, I'll talk to the level authors about it and we'll get back to
you (I'm sure they'd be delighted to have their work with a magazine). If
you want to put it on any other type of media that costs money, then NO,
you cannot use it (unless you're willing to pay both me and the level
editors for it). You may not use any part of this mod as a base for
anything else (except levels, and even then you must agree to the
author's terms and have his/her permission). You MAY NOT UNDER ANY
CONDITION decompile the qwprogs.dat (it's been protected, but I know
there are hacks to get around that).


