                        -=+ King of the Hill v1.2 +=-
                            a Quake2 Modification
                       by  Orange Smoothie Productions

                            Release Date: 5/11/98

Not so Original Concept:
        Craig "BotanikA" Sparks
        Scott "Spudman" Woodward
Executive Producers:
        Craig "BotanikA" Sparks
        Scott "Spudman" Woodward
The Programmer:      
        Brandon "GreenMarine" Reinhart
v1.0-1.2 Release Level Design:
        Craig "BotanikA" Sparks
v1.0-1.2 Readme Documentation:
        Brandon "GreenMarine" Reinhart


WHAT YOU NEED TO PLAY

The latest KOTH distribution available at 
http://www.planetquake.com/osp/

With version 1.2 this includes VWEP support so download this from 
our download page as well. Make sure that this .pak file is
installed into your baseq2 directory.
For more info on VWEP visit http://www.telefragged.com/vwep/


LOW ATTENTION SPAN INSTALLATION: 

KOTH is a server side mod. The server code and maps are both
included in this release. Just unzip the above file into your Quake2
directory maintaining the archive's directory structure.

This includes Win95/NT and Linux versions.

As a client just run regular Quake2 in DEATHMATCH mode, no
commands, no configs, just join a KOTH server and have fun! 

To run a server run quake2 with the "+set game koth" parameter.
Also all games must be timed, if you use the default timelimit of 0
the levels will never end and no one will win! 

It is highly recommended to use the following settings for your
server. In addition, the gameplay works really well when you set
weapons to stay using the dmflags. We usually run with weapons
stay, spawn furthest,turn off instant powerups, and drop quad. This 
results in a value of 16900.

An example command line for a dedicated server is shown below.

"<path>/quake2.exe +set deathmatch 1 +set
dedicated 1 +set dmflags 16900 +set game koth +set
timelimit 10 +set fraglimit 0 +set maxclients 8 +map
koth1"

The "+map koth1" can be any of the sequence of maps koth1-6 as
they cycle in order.

In version 1.2 we have added the ability to read the map order in from 
a file.  This file, maps.txt, is in the <quake2path>\koth\ directory 
and is a simple list of KOTH maps.  The first map is set by the 
server.cfg file which is also inlcuded.  To start the server use the 
following command line:

<quake2path>\quake2.exe +set game koth +exec server.cfg

Example server.cfg and maps.txt files are included in the 1.2 release.

v1.0 maps files names are:
koth1.bsp - Plasma
koth2.bsp - The Dirt Pile
koth3.bsp - Veranda
koth4.bsp - It's Raining Men!
koth5.bsp - Vertigo
koth6.bsp - Yo ho ho

Version 1.2 adds
koth8.bsp - Bishop to King Seven


Coming in Version 1.3
---------------------
Teamplay
3 New OSP maps
Map contest winners (contest ends May 15 23:59:59 hours)


To play a particular map use the map command.
As an example, to play koth6 - Yo ho ho, you would press the ~ key
to bring down the console and type the following:

map koth6

That's it. Have fun and thanks for playing,

The Orange Smoothie Team


=======================================================================

ATTENTION: If you are a map maker, amateur or professional, be sure to
check out our Map Design Contest at

http://www.planetquake.com/osp/koth/contest.html.

Each winning entry gets an Orange Smoothie T-Shirt!!!

========================================================================
LEGAL:

  King of the Hill for Quake2 is Copyright (C) 1998 Orange Smoothie
  Productions.  Quake, Quake2 and stylized Q are registered
  trademarks of id Software corporation.

  King of the Hill may NOT be distributed on any CD-ROM or included
  on any Quake or Quake2 modification package without the
  express permission of Orange Smoothie Productions and Craig
  Sparks.

  King of the Hill may NOT be used as a basis for future
  modifications until such time as the source code is released.

  The King of the Hill source code may NOT be distributed by
  any means until such time as it is released.

  King of the Hill may NOT be used in any way for commercial purposes or
  distributed via a commercial product wihtout express permission of
  Orange Smoothie Productions and Craig Sparks.

  Excepting the above requirements, King of the Hill is a freeware
  product and may be freely distributed via any electronic means.
========================================================================

1. What's King of the Hill?

  Fight to the top in King of the Hill. The only mod where everyone is trying
to get where you're standing. The idea is simple: find the "hill" and rack
up time defending it. Whoever has accumulated the most time by the end of
the level is crowned the King of the Hill.

2. Okay, great, now how do I play?

  KOTH is a server side mod. The server code and maps are both
included in this release. Just unzip the above file into your
Quake2 directory maintaining the archive's directory structure. 
As a client just run regular Quake2 Deathmatch, no commands, 
no configs, just join a KOTH server and have fun!  You can find
more KOTH maps (descriptions, screenshots, and files) at
http://www.planetquake.com/osp/

  If you want to run a server, you will need to use the King of the Hill
gamex86.dll file.  Setting up a KOTH server is simple.  First, unzip the 
KOTH release package and the KOTH map pack into your Quake2 directory.
Second, run your Quake2 server with the parameter: +set game koth

For example, you might type:
        quake2 +set dedicated 1 +set game koth

  To run a basic dedicated King of the Hill server.

3. What are the rules?

  The rules are simple: find the "Hill" and spend as much time
on top of it as possible.  As you stand on the hill you will
accumulate time by the second.  Time is calculated into three
score catagories:

  - TTP, Total Time in Possession
    This is a measure of the total time you've been on the hill
    so far in a game.  In the current release of KOTH, this
    score is what counts.  Future releases of KOTH will allow
    the server to rank scores by LUP also.
  - TTP%, Total Time in Possession Percentage
    This is the percentage of game time you've spent on the hill.
  - LUP, Longest Unbroken Possession
    If you're a real badass, you might be able to take the hill
    for an extended period of time.  This score shows your longest
    unbroken period of time on the hill, so you can compare
    your badassedness with your friends.

  It is possible to leave the hill, grab a nearby item and go back on
the hill without breaking up a period of possession, if you are gone
no longer than a second.  What you will find as you play KOTH levels
is that getting a big weapon requires an equally big time
sacrifice.  It is your job to balance weapon use (to prevent others
from taking the hill) versus time you spend on the hill.
  One other clarification: multiple people can be on the hill
gaining time simultaneously.  If you see someone on the hill,
they are gaining time! Kill them! Quick!  The King of the Hill
is whoever has logged the most time on top of the hill.

4. How many people can play?

  There is no *technical* limit, but some levels are aimed for
different numbers than others...it really is an issue of level
design.  For example, the Plasma level is good for about
6-10 players...it doesn't fit any more very well.  The Dirt Pile
level is good for about 8-12 players, but any more cause some
nasty slowdown (because you can see so far across the level).
Other levels, like Yo Ho Ho and It's Raining Men, are great
for larger numbers of players.  For the best playing experience,
we suggest 8-12 players with Pentium II processors and
hardware 3D acceleration.

5. That's not a hill...that's a boat!

  We never said a Hill had to be a Hill in the literal sense!!!
Part of the fun of King of the Hill is the wierd ways in which
a hill can be implemented.  If you want, we could always
rename it to "King of the Place-That-Gains-You-Time"...or not.
If you are totally lost, try the following suggestions:

  - Go where everyone else is going.  Unless they are all really
  stupid, they're probably going to the hill.
  - Go until you see the message "You're on the Hill!"  Anytime
  you start a new period of possession, this message will
  pop up.
  - Watch your time indicator, it'll start to increment when you
  are standing on the hill.  If it's incrementing already then
  you're already on the hill, silly!

6. What? Time indicator?

  Check out the HUD.  You'll see that your frag count has moved
down and two new read outs are present.  The top most counter
is your time indicator.  It reflects your TTP so you don't have
to keep hitting F1 to see the scoreboard.  The second counter
is your current ranking.  The left number is your rank and the
right number is the current number of players in the game.

7. The Scoreboard.

  The scoreboard can be accessed like the regular Quake2
scoreboard by hitting F1.  It displays the picture and name
of the current King of the Hill, as well as score information
for the top five players.  Why only the top five?
Ask John Carmack.  There is currently a scoreboard message limit
of 1400 bytes, so only a little bit of information can be
sent.  In normal Quake2, 10 or so names can be displayed.
KOTH sends more score information, though, so only 5 can
currently be displayed.  Hopefully this limit will be changed
in the future, although technical issues might prevent that
from happening.
  If you are standing there saying "But Brandon, this scoreboard
looks like crap!" you're probably running in a low resolution.
The default scoreboard is pretty space intensive, so it only looks
right at higher resolutions.  To fix this, hit the tilde key (~)
to open the console.  Enter, koth_long_scoreboard 0, to turn off
the long scoreboard.  Now hit F1 to reopen the scoreboard...it
should fit now.

8. Known Issues

  - Servers will often print "rejected unreliable" messages.
    This will be addressed in a future release.  It has no
    noticable effect on gameplay.

9. Coming Soon

  - HTML and Text format logging
  - Alternative methods of score sorting
  - Teamplay!!!

10. Where is the source code?

  It's coming.  I want to finish the above elements first and
clean up the internal documentation.  Also, I'll probably
have to revamp most of the mod after the point release,
so just hold your rail gun!  

11. Conclusion.

  I think that's everything.  If you've read this far, you're
one of those rare few who actually read game documentation!
Wow, send me and email, I've never met one of you before.

Just kidding :p

  Make sure you periodically check out the Orange Smoothie
Productions web page for information regarding our other
mod projects.  New maps will also be appearing for KOTH
as our Map Design contest gets underway.

Thanks for playing,

The Orange Smoothie Team


Orange Smoothie Productions
http://www.planetquake.com/osp/


Release Notes
^^^^^^^^^^^^^

What's New in 1.2
-----------------

Tie Breaking -
  KOTH will now break ties based on "Longest Unbroken Possession."
If LUP is also tied, then KOTH will break the tie based on frag count.
If frag count is tied then its more or less luck of the draw.

VWep Support -
  VWep seems stable enough to include in KOTH now.  I was hestiant
before because it seemed like Hentai was releasing new versions
quite often.  I think VWep is very, very cool and I'd like to thank
Hentai for writing it.  If you don't have VWep, or want more information
check Hentai's webpage at http://www.telefragged.com/vwep/.

Dynamic Map Ordering -
  You can now customize the map order for KOTH servers, instead of
playing the normal rotation.  Just create a file in your KOTH directory
called maps.txt.  On each line put the name of a map, maps will then
be played in that order.  Put the first map on the last line and start
the server with that map.
  In other words, if you wanted to play koth1, koth2, and koth3 in a
rotation your maps.txt file would look like this:

  koth2
  koth3
  koth1

  And you would start the server on koth1.  In theory, you should be able
to edit the maps.txt file while the server is running, but I haven't
tested the results.  Heh.  We've supplied a sample maps.txt file that
plays the full KOTH rotation.

What's Next -
  There will probably be one, final release of KOTH (1.3) coming out
fairly soon.  I plan to add teamplay and some enhance scoreboard features.
After that, OSP will be directing its energy towards the Violator mod.


What's New in 1.1?
------------------
Not a whole lot.  This is just an update to 3.14 compatibility and will
probably be the final version of KOTH.  KOTH is now compatible with normal
Quake2 teamply, but I haven't added any new features.

The KOTH source code will be available by the end of the week!
OSP is currently involved with a very interesting teamplay project for
the PC Gamer teamplay mod project.  It looks to be very cool (but we
can't release any details yet).


Relase 1.0
----------
The first release of King of the Hill