q3apd (jan 30 2005)
-------------------

this is my attempt to package up a version of q3apd that actually works for
most people out-of-the-box.

first, some requirements. to run this you need, at the very least,

- a full and working installation of quake3 for linux

unpack this zipfile (q3apd-20050130.zip) in (or move it's contents to) either
your $HOME/.q3a directory (recommended) or in your /usr/local/games/quake3/
directory. you will probably need root access to install it in the latter
location, but it will be available to all users on your system.

after installation, when running quake normally (typing quake3 or quake3-smp,
with no command line parameters), a q3apd entry should appear in the MODS menu.
once the q3apd mod is loaded, quake3 will run as normal, except that it will
attempt to stream out lots of data about player status/locations over the
pd/max netsend/receive (FUDI) protocol to localhost on port 6661. if you aren't
running something to listen to the messages (pd, max, pdreceive) this will
probably just result in lots of connection refused messages in the terminal
where you executed quake3.

you can also tell quake3 to load the q3apd mod on the command-line:
$ quake3 +set fs_game q3apd

if you run the provided q3apd.pd patch in pd at the same time, you should get
lots of flickering numbers which signify success ;) if you start quake3 with
the commandline given above, by default it should disable sound, so that pd
will be able to start at the same time. you can re-enable it by setting the
quake3 snddevice variable to something sensible (eg, /dev/dsp).

q3apd provides a few quake3 variables you can use to change it's behaviour:

fudi_hostname:	the hostname to which q3apd will broadcast data.
fudi_post:	the port number to send to.
fudi_rate:	q3apd will wait this many milliseconds between sending messages
		this is useful as it normally generates a lot of data, but also
		results in dropped messages.
fudi_open:	set this to 1 to transmit data, set it to 0 to stop transmission.

you can change these variables by either:
- setting them on the quake3 commandline, eg: 
	$ quake3 +set fs_game q3apd +set fudi_hostname 192.168.0.5
- setting them in the quake3 console, which you can normally access with the tilde (~) key.
	] /set fudi_hostname 192.168.0.5
- or by editing the appropriate lines in .q3a/q3apd/q3config.cfg, eg:
	seta fudi_hostname "192.168.0.5"

there are a few extra variables which q3apd provides, which don't have much to
do with it's intended purpose:

g_plasma_time:		the maximum lifetime of a plasma gun bullet
g_plasma_speed:		the velocity of plasma gun bullets (try 0 to make 3d graffiti)
g_plasma_explode:	to be honest, i'm not sure.

pix.
