				CTF Version 2
				(AKA CTF/Lua)
			    script by W'rkncacnter
			    this document by Irons


	This document accompanies the Capture the Flag lua script released by
W'rkncacnter. The script came into existence because almost everyone in the
Marathon community can't stand the Capture the Flag mode that is now built into
the Aleph One engine. Why?

* The "flag" is really the Ball from KTMWTB, which poses a few problems:
	-It forces you to walk when carrying the flag
	-You can't use any other weapons while carrying
* You can't easily see who is carrying the flag
* The beloved mapmaking program, Forge, does not support making maps of this
	game type. The mapmakers that _do_ support it are either buggy or still
	under development.
* Apart from the programs themselves, creating a CTF map is very complicated.
* Other reasons?

	As you can see, CTF is a pain to play and create in Marathon. The script
is here in order to simplify the process for everyone. Who needs to know about
this? Gamers, hosts, and mappers.

------------------------------------
To The Gamers (How to play the game)

	You should probably know how to play capture the flag already. If you
don't, I'll outline the basics. There are two teams, red and blue, and each of
has a home base and a flag in that base. The object of the game is to infiltrate
the enemy team's base, steal the flag, and bring it to your own base, hence the
name "capture the flag." Each flag turned into the base results in a point for
you, and therefore, for your team.

	You will of course want to leave someone to defend your base, and so on,
but in the event that an enemy captures your flag, you can kill him and touch
your flag (which should now be on the ground) to return it to base instantly.

	When someone has a flag, you will be notified with a Lua message printed
in the upper right-hand corner of the screen. The player will have a white shirt
(personal color) and his pants (team color) will remain the same. In addition,
the compass that overlays the motion detector will point to an enemy if he is
carrying the flag.


The game will print the winning team of the match before the match ends. The
postgame carnage report screen is interpreted differently: each death recorded
there represents a capture (point).

---------------------------------------------
To The Hosts (What to do for hosting CTF/Lua)

	Hosting is easy, and with this Lua version of CTF, it does _not_ require
you to select the "Capture The Flag" game mode in the gathering screen. Instead,
The script is designed for play on the EMFH (Every Man For Himself) style game,
but with teams enabled. Ideally, you will divide into two teams, red or blue. If
you start a game with more or less than two teams, the script will divide you
into red or blue. Alternatively, if you want a random team assignment, you can
divide teams by yellow and purple, and you will become red and blue randomly.

	You will still need a special map. It won't be a map specially designed
for Aleph One's CTF mode; instead, mappers will have to make new maps to go with
this script. Make sure the map you want to host is designed for Lua CTF, or else
you will have a bad game or, more likely, a crash.

	Selecting a time limit will affect the game by limiting how long it can
last. The script will end the game automatically if the _point limit_ is reached
(more on that in a bit). With a time limit, the game will end either when the
game reaches the time limit, or when a team has score the point limit. Be warn-
ed that the end game screen is _not_ directly indicative of a team's or a play-
er's score, so if you reach the time limit, it won't be very clear who "won."
This is in part due to a problem with the SDL version of Aleph One, which crash-
es when it tries to graph a negative suicide on the end-game screen. Amyway, if
you refrain from adding a time limit to your game, when a player scores the last
point, the game will stop and the winner and scores will be printed to the
screen.

	How does one change the point limit? You'll have to edit the Lua script
itself, for now. To do this, open the script with a text editor like Notepad,
TextEdit, emacs, or whatever, and look for the line CAPTURES = <some number>.
Replace the number after the equals sign with the point limit you'd like to have
for the game, and save the script. Easy.

	The last step of hosting a CTF game with this script is, of course,
selecting the script in the game gather screen. At the top of this screen, there
should be a tab that says something like "Other Stuff." Selecting this tab will
bring up options like "Use Lua Script," "Allow Crosshair," etc. Check the "Use
Lua Script" option and then find the path to the Lua script, click on it, and
confirm your selection.

	Once all of this is set up, you're ready to play.

----------------------------------------------------------
To The Mappers (What you need to do to make a CTF/Lua map)

	Making a map that will work in CTF/Lua is far, far easier than making
one for Aleph One's own CTF mode. You can use any map editor that will make
valid Marathon 2 or Marathon Infinity netmaps.

	You only need to remember five items:

	*Base polygons
	To designate a polygon as a "Base" polygon (that is, one where a revived
	player can spawn to):
		-Team 1's base polygons are "Dual Monster Trigger" polygons
		-Team 2's base polygons are "Must Be Explored" polygons

	*Flag polygons
	Each team's flag should have one area where it will appear. Ideally, the
	area will be one polygon.
		-Team 1's flag will appear on polygons of the type "Visible Mon-
		ster Trigger"
		-Team 2's flag will appear on polygons of the type "Invisible
		Monster Trigger"

	*Spawning
	In order to make sure that players will spawn in their proper bases, you
should make a polygon isolated from the rest of the map that will serve as the
spawn point for all players. That is to say, put all eight player spawn points
somewhere not connected to the main map. The script will teleport players to the
right place after they spawn in such an area.


	And that's it! Of course, it would be best to make a _good_ CTF map, but
this is far easier and far more attractive thanks to the CTF/Lua script. You can
use your favorite editor, and you only have to remember the five items listed
above. Make some good maps, and maybe we will at last have fun playing CTF--our
way!
