1SUMMARY
2
3QMass Deathmatch Mod
4
5This is a deathmatch modification for Quake2.  It aims to bring the
6functionality of several mods into one, and gives the players the ability
7to pick and choose features in realtime.
8
9INSTALL
10
11This mod ships with Quetoo, but it should run within any Quake2
12compatible engine.  Still, unless you feel like creating a Makefile for it,
13your best bet is to download and build Quetoo, and enable the mod at the
14configure stage:
15
16./configure --with-games='qmass' [--with-mysql[=path]]
17make install
18
19RUNNING
20
21There are several new cvars and cmds, as well as a couple small features
22that may be of interest to you:.
23
24log_mysql "0" Setting this to "1" will enable logging of frags and chat
25messages to a MySQL database.  To specify the host and database parameters,
26use mysql_host, mysql_user, mysql_db, and mysql_password.  See the Stats
27wiki page at http://jdolan.dyndns.org/trac/wiki/Stats.
28
29log_fraglog "0" Setting this to "1" will enable logging of frags to
30fraglog.log.  Likewise, setting log_chatlog to "1" will log chat messages
31to chatlog.log.
32
33sv_maplist "maps.list"  This is no longer a string of map names, but
34the name of a text file containing the levels you wish to rotate on your
35server.  The default "maps.lst" which ships with Quake2 is a good place
36to start.  Copy it to your qmass game directory and edit it to your
37liking.  File should be in Unix format (\n).  Map titles in quotes are
38perfectly acceptable, just as the default file contains.
39
40sv_rmap "0"  Setting this to "1" enables random selection of the maps
41listed in the sv_maplist file.
42
43gameplay "0"  The default value yields normal deathmatch play, ala baseq2.
44A value of "1" turns on "Instagib" (Railgun-only) play, and "2" enables
45"Arena" play.  All weapons, items, and powerups are stripped from the level
46in modes "1" and "2".  Self-damage is also disabled.
47
48teams "0"  Setting this to "1" enables teamplay.  Two teams exist.  Players
49must elect to join a team with the team command.  The teamname and teamskin
50commands allow players to modify their teams.  Team scores can be reset by
51voting for the "reset" command.
52
53hook "0"  Setting this to "1" enables the (in)famous Lithium II style
54offhand grappling hook.  Players should bind a key to "+hook".
55
56sv_allow_vote "1"  Allow things like map, gameplay, and teams to be
57voted upon by players.  Players should use the vote command.  A vote must
58reach a majority in order to pass.  Only maps present in sv_maplist can be
59voted for.
60
61sv_inter_sound "qmass.wav" This specifies sound file used for intermission
62music.  We find a snippet of Miami Sound Machine quite fitting :)
63
64You may also notice that players are asigned a random male skin on connect.
65We find that this has several nice effects: 1.  No annoying, skinny, hard-to-
66see ladies running around.  2.  People get to see some of the really well
67made but seldom used male skins.  3.  Everyone triggers pain sounds from the
68QMass Sound Pak, see http://jaydolan.com/quake.html.
69
70And lastly, there are some truly tasteless obituary messages.  Enjoy.
71
72NOTES
73
74This mod performs some file IO.  Quake2 provides no facilities for resolving
75the mod directory.  Therefore, the environment variable QUAKE2_HOME is
76expected to contain the Quake2 data installation path upon loading this mod.
77Quetoo exports QUAKE2_HOME as ~/.quake2 upon startup to simplify this.  If
78you are running this mod with a different engine (e.g. R1Q2), you must set
79this explicitly
80
81CREDITS
82
83Jay Dolan, http://jaydolan.com/quake.html
84The QuakeForge Project, http://quakeforge.net
85id Software, http://idsoftware.com
86
87LICENSE
88
89The QMass Deathmatch Mod is released under the GNU General Public License
90(GPL) v2.0.
91