put my new nick instead of the old in a comment and a docs file
[divverent/nexuiz.git] / Docs / gamemodes.txt
1 ========================\r
2 =   Game Mode Patch    =\r
3 =By Dan Hale, aka Wazat=\r
4 ========================\r
5 \r
6 PLEASE NOTE THAT SINCE THE INTEGRATION OF 'GAME MODE PATCH' THE MAP AND MENU SYSTEM WAS REWRITTEN AND THUS THE INFO REGARDING BOTH IS OUTDATED!\r
7 \r
8 This patch enables game modes like Capture the Flag and Domination, and adds more controls for all game modes.\r
9 \r
10 See Cvars.txt and mapping.txt in /data/ for more info.\r
11 \r
12 \r
13 ================\r
14 =Starting a map=\r
15 ================\r
16 \r
17 You can select a map from the menu and even build a maplist with it as normal.  To get the menu to list more maps, see the Adding Maps section.\r
18 \r
19 To change maps from the console or a dedicated server, you usually won't use "map" or "changelevel" anymore.  Instead use "exec maps/<filename>.mapcfg".  For example, to play domination on nexdm10, type "exec maps/dom_nexdm10.mapcfg".  This is the preferred method, though you can use "map" and "changelevel" if you need to.\r
20 \r
21 Note for dedicated servers:\r
22 Please look over cvars.txt and find out how to enable team balancing and other helpful features, as they won't take effect automatically in a dedicated server.  Your maplist should also list the mapcfg files (dm_nexdm03 rune_nexdm08 etc) instead of the .bsp files (nexdm03).\r
23 Also remember that you can edit the .mapcfg files in the pk3 to change fraglimits, timelimits, and other features.  If players begin complaining that maps don't last long enough you should probably do this (or set the frag overrides like g_domination_point_limit).  You can find out more about those in mapping.txt\r
24 \r
25 \r
26 ============\r
27 =Game Modes=\r
28 ============\r
29 \r
30 Classic Deathmatch\r
31 Team Deathmatch (TDM)\r
32 Domination\r
33 Capture the Flag\r
34 Runematch\r
35 \r
36 \r
37 Classic Deathmatch\r
38 ------------------\r
39 \r
40 Nothing's changed here.  It's the standard frag fest we all know and love.\r
41 \r
42 \r
43 Team Deathmatch (TDM)\r
44 ---------------------\r
45 \r
46 TDM places players on different teams, making them win or lose together.  There are some new options for this mode including balancing teams.\r
47 \r
48 \r
49 Domination\r
50 ----------\r
51 \r
52 Frags are not the focus.  Instead players must capture control points placed throughout the level.  You capture a control point by touching it, and it will change to your team's insignia.  The longer you control points and the more you have, the more your team will score.  On some levels there may be some control points that award more points than others, so be sure to prioritize!\r
53 \r
54 \r
55 Capture The Flag\r
56 ----------------\r
57 \r
58 In CTF the main goal is to steal the enemy flag and take it back to your base to capture it.  You must have your flag back at base to capture, and you must touch it while carrying the enemy flag.  That said, you must also guard your flag from being stolen by the enemy team, or you will not be able to capture their flag, and they might capture yours.\r
59 \r
60 \r
61 Rune Match\r
62 ----------\r
63 \r
64 Players must find runes scattered throughout the level.  The longer you hold a rune, the more points you'll get.  Runes also imbue their holder with special powers, such as increased defense or speed.  However, every rune also has a curse attached to it, which has the opposite effect of a rune.  So you may have increased attack but lowered defense!\r
65 Runes pair up with curses randomly, and recombine into new pairs when their holder dies and drops them.\r
66 \r
67 There are 5 runes and just as many curses.  Each rune has its own color, and its opposing curse is the same color but a different shape.  Below I've listed each of the runes and their opposing curses.\r
68 \r
69 Rune: Strength (RED)\r
70 Increases attack power\r
71 Curse: Weakness\r
72 Decreases attack power\r
73 \r
74 Rune: Defense (BLUE)\r
75 Increases defense\r
76 Curse: Vulnerability\r
77 Decreases defense\r
78 \r
79 Rune: Vitality (GREEN)\r
80 Increases maximum HP and health regeneration rate\r
81 Curse: Venom\r
82 Decreases maximum HP and increases health degeneration rate\r
83 \r
84 Rune: Speed (YELLOW)\r
85 Increases movement and attack speed\r
86 Curse: Slow\r
87 Decreases movement and attack speed\r
88 \r
89 Rune: Vampire (PURPLE)\r
90 Gain health when you attack other players\r
91 Curse: Empathy\r
92 Lose health when you attack other players\r
93 \r
94 \r
95 Rune Match is usually played as a free for all, so you generally won't have a team to help you.\r
96 \r
97 \r
98 ===========\r
99 Adding Maps\r
100 ===========\r
101 \r
102 This mod changes how maps are handled by the menu, so in order for a new map to be listed you need to add a .mapcfg file for it at the bare minimum (or hope the map's author has made one for you).  You can view existing mapcfgs in the maps folder, but here's a simple example of "dm_nexdm01.mapcfg":\r
103 \r
104 set fraglimit 20\r
105 set timelimit 15\r
106 changelevel nexdm01\r
107 \r
108 \r
109 In truth, the *only* thing a mapcfg needs is the changelevel command, but usually you'll also want to set the game mode and default fraglimit and timelimit.\r
110 \r
111 Mapcfgs are discussed in greater detail in mapping.txt\r
112 \r
113 \r
114 ==============\r
115 Grappling Hook\r
116 ==============\r
117 \r
118 Servers can now enable the grappling hook with "g_grapppling_hook" set to 1.  Bind a key to "+hook" to use it.  For example:\r
119 bind f "+hook"\r
120 \r
121 \r
122 ============\r
123 Menu Options\r
124 ============\r
125 \r
126 There are also new options available for these game modes:\r
127 \r
128 ------------\r
129 Common & TDM\r
130 ------------\r
131 \r
132 Join Message Display Time\r
133 How long to display the join message to tell players what game mode is being played and what team they are on.\r
134 \r
135 Auto-Balance Teams\r
136 When players join, automatically assign them to the smallest team to keep things balanced (they can still change teams, however)\r
137 \r
138 Force Balanced Teams\r
139 Players cannot switch to larger teams, and the game moves players around to make sure each team is more or less even in player numbers.  Players can switch to smaller or equally-sized teams, however.\r
140 \r
141 Prevent Team Imbalance\r
142 If a player tries to change teams, he must join a team of lesser size or else he will be forced back to his old team, unless there are bots in that team he can trade with.\r
143 \r
144 Changing team not allowed\r
145 Players cannot switch teams by themselves at all.  It is recommended you combine this with Force Balanced Teams, so that the game will move players around automatically if players leave and unbalance the teams.\r
146 \r
147 Team Deathmatch # of teams\r
148 The number of teams in Team Deathmatch (2 - 4).\r
149 \r
150 Score Transfer % on Change Team\r
151 When players choose to change teams, this is the percent of their score they get to keep (0 - 100).\r
152 \r
153 Friendly Fire\r
154 If a team game is being played, this controls whether allies can hurt themselves or each other\r
155 \r
156 Force Teamplay\r
157 Play a team game even if only normal deathmatch is selected\r
158 \r
159 \r
160 ----------\r
161 Domination\r
162 ----------\r
163 \r
164 Point Limit\r
165 (Overrides map settings) How many points a team needs to win the game\r
166 \r
167 No Scores From Kills\r
168 Players don't get points from kills, only from controlling domination points.  They do however still lose points if they kill themselves or a teammate.\r
169 \r
170 Domination Score Amount\r
171 (Overrides map settings) How many points a domination point gives to the team that owns it each time it pings.\r
172 \r
173 Score Frequency\r
174 (Overrides map settings) How often each domination point pings out points for its teammates.\r
175 \r
176 DomPoint Capture Delay\r
177 How long after being touched it takes for a Domination Point to be captured.\r
178 \r
179 Default # of teams\r
180 If playing on a normal DM map or non-Domination map, this is how many teams will be available to join.\r
181 \r
182 ----------------\r
183 Capture the Flag\r
184 ----------------\r
185 \r
186 Point Limit\r
187 (Overrides map settings) How many points a team must score to win\r
188 \r
189 Return Time\r
190 How long flag takes to return when dropped\r
191 \r
192 Capture Points (player)\r
193 How many points to give to the player who captured the flag in addition to what the whole team gets\r
194 \r
195 Capture Points (team)\r
196 How many points the whole team gets when they capture the flag\r
197 \r
198 Pickup Points\r
199 You get this many points simply for picking up the enemy flag\r
200 \r
201 Return Points\r
202 Points you recieve when you return your flag to base\r
203 \r
204 Rogue Team Return Points\r
205 Points a rogue team gets when returning the flag\r
206 \r
207 \r
208 ----------\r
209 Rune Match\r
210 ----------\r
211 \r
212 Point Limit\r
213 How many points a player needs to win a match\r
214 \r
215 Point Rate\r
216 How often each player carrying runes will score points\r
217 \r
218 Point Amount\r
219 How many points player gets per rune he's carrying\r
220 \r
221 Shuffle Time\r
222 How often runes change position when not picked up\r
223 \r
224 Respawn Time\r
225 How quickly runes respawn after being dropped\r
226 \r
227 Rune Settings\r
228 There are settings for each rune to modify its effects on the player when carries.\r
229 Most of these are ratios, meaning 0.5 is 50% and 1.2 is 120%.\r
230 \r
231 \r
232 =========\r
233 =Credits=\r
234 =========\r
235 \r
236 My name's Dan Hale, aka Wazat.  I'm responsible for writing the code and making the changes to the menu.  I also added lots of features like team balancing, which weren't there before.\r
237 \r
238 Black helped me with lots of menu stuff, and fixed it when I made a mess of things.  He got the map filter working, too.  Thanks, Black!\r
239 \r
240 Thanks to Kaz for pushing me to do this and giving feedback & suggestions.  It turned out great because of him.\r
241 \r
242 "Lardarse" Gregory R. Payne came up with the initial idea of Rune Match and helped me define it further from there.  In fact, probably most or all of the idea is his, and I take credit for coding it.\r
243 \r
244 Uber special thanks to Black for his awesome idea on how to do maplists and game mode selection by map.\r
245 \r
246 Special thanks to Randy, who provided the awesome team symbols for Domination & CTF.\r
247 \r
248 Thanks to people who beta tested, found bugs, and/or made suggestions:\r
249 Kaz, Lardarse, esteel (who helped me weed out the dedicated server bugs)\r
250 Probably others I've forgotten  :(\r
251 \r
252 \r
253 \r
254 \r
255 \r
256 =======\r
257 Changes\r
258 =======\r
259 \r
260 Version 1.1\r
261 -----------\r
262 \r
263 Dom points and CTF flags are now properly animated.\r
264 Fixed the grappling hook so it can be refired right after being released\r
265 Fixed the obnoxious "landing on floor" sound when using the hook\r
266 You should no longer take damage from using the grappling hook\r
267 Grappling hook flight and pull speed can now be set in the menu or by cvars\r
268 Fixed the management menu crashing when trying to save the Game settings (actually Black fixed it).\r
269 Black fixed the Map Filter too, so that it should properly change the currently selected map, and work in the maplist menu.\r
270 \r