CTS line
[divverent/nexuiz.git] / Docs / mapping.txt
1 ==============\r
2 =Mapping Help=\r
3 ==============\r
4 \r
5 While I can't help you make a map, I can help you get it listed in the menu and\r
6 working in the maplist. :p  The central object is the .mapinfo file, but\r
7 there's much more available.\r
8 \r
9 Table of Contents\r
10 -----------------\r
11 I        Map Lists & Scripts\r
12          (get your map listed and working)\r
13   i.     mapinfo\r
14   ii.    mapname.cfg\r
15 \r
16 II       Map Image\r
17 \r
18 III      Domination\r
19 \r
20 IV       CTF\r
21 \r
22 V        Rune Match\r
23 \r
24 VI       Race/CTS\r
25 \r
26 VII      Nexball\r
27 \r
28 Appendix A - Advanced mapinfo\r
29 \r
30 Appendix B - Helpful extras\r
31   i.     Team Colors\r
32   ii.    Text Colors\r
33 \r
34 Appendix C - Advanced Darkplaces shaders\r
35 \r
36 ========================\r
37 =I. Map Lists & Scripts=\r
38 ========================\r
39 \r
40 There now is just a single script/cfg file available to you, containing all map\r
41 specific settings:\r
42 \r
43 mapname.mapinfo\r
44 \r
45 The mapinfo is actually required - however, the game is so nice that it\r
46 automatically generates a draft of it for you.\r
47 \r
48 ------------------\r
49 -The mapinfo file-\r
50 ------------------\r
51 \r
52 *cue even more scary music*\r
53 \r
54 The mapinfo file is basically what gets your map listed in the menu, and sets\r
55 up the options needed to change to it. If no mapinfo file exists, the menu\r
56 will automatically generate a rough draft for you on game startup. It will get\r
57 stored into data/data/mapname.mapinfo.\r
58 \r
59 As an example, let's say I make a map called "wazat1.bsp". As long as I'm\r
60 fantasizing, I might as well say this map is so well done I'm actually willing\r
61 to release it for friends, neighbors, fellow forum visitors and other people\r
62 who like me to judge me by. Let's also assume that I want domination,\r
63 deathmatch/team deathmatch and runematch to all be playable on my map.\r
64 \r
65 This is very easy. First, I start the game and exit it again so the game writes\r
66 data/data/wazat1.mapinfo for me. The file may look like:\r
67 \r
68     title Wazat's Great Map\r
69     description Bleh.\r
70     author Unknown\r
71     _diameter 1966.839355\r
72     _spawnpoints 5\r
73     has weapons\r
74         cdtrack 5\r
75     type dm 30 20\r
76     type dom 200 20\r
77     type rune 200 20\r
78     type lms 9 20\r
79     type arena 10 20\r
80 \r
81 As I see, the menu autodetected that my map may be suitable for deathmatch,\r
82 domination, runematch, last man standing and arena. But I want the map to be\r
83 played in domination, deathmatch, team deathmatch, runematch only, and I also\r
84 want different timelimits/fraglimits, so I will change the "type" lines to:\r
85 \r
86     type dom 100 15\r
87     type rune 1000 25\r
88     type dm 40 15\r
89     type tdm 50 0 2\r
90 \r
91 Also, while I am at it, I should fix the placeholders in the map description lines:\r
92 \r
93     title Wibble\r
94     description A large multi level arena map\r
95     author Wazat\r
96 \r
97 Although not entirely necessary, I will now move the .mapinfo file from\r
98 data/data/maps/wazat1.mapinfo to data/maps/wazat1.mapinfo, so it is at the same\r
99 place as my map. Next time I start the game, my map will be shown supporting\r
100 the right game modes and with the right description in the menu.\r
101 \r
102 Also, note the "has weapons" line. If this line is not there (which happens if\r
103 the map contains no weapon entities other than the Nex), the map will run in\r
104 MinstaGib only and not be shown in the menu normally. So if you look for your\r
105 map and don't find it, add "has weapons" to the mapinfo file, and make sure you\r
106 have weapon entities placed.\r
107 \r
108 There's much more power in a mapinfo file. See Appendix A for more details.\r
109 \r
110 Gametype        | Syntax                                                                              | Notes\r
111 ----------------+-------------------------------------------------------------------------------------+-------------------------------------------------------\r
112 Deathmatch      | type dm    <fraglimit>  <timelimit>                                                 |\r
113 Team Deathmatch | type tdm   <fraglimit>  <timelimit> <teams>                                         | 2, 3, or 4 teams\r
114 Domination      | type dom   <pointlimit> <timelimit>                                                 | teams are set by the map's entities\r
115 CTF             | type ctf   <pointlimit> <timelimit> <caplimit>                                      | pointlimit if g_ctf_win_mode is 2, otherwise caplimit\r
116 Runematch       | type rune  <pointlimit> <timelimit>                                                 |\r
117 LMS             | type lms   <lives>      <timelimit>                                                 |\r
118 Arena           | type arena <fraglimit>  <timelimit>                                                 |\r
119 Key Hunt        | type kh    <pointlimit> <timelimit> <teams>                                         | 2, 3, or 4 teams\r
120 Assault         | type as                 <timelimit>                                                 | never uses points\r
121 Onslaught       | type ons                <timelimit>                                                 | never uses points\r
122 Race            | type race               <timelimit> <qualifyingtimelimit> <laplimit> <teamlaplimit> | g_race_teams: teamlaplimit is used instead of laplimit\r
123 CTS             | type cts                <timelimit> <skill>                                         | never uses points\r
124 \r
125 \r
126 ===============\r
127 =II. Map Image=\r
128 ===============\r
129 \r
130 So, you've got your map listed in the menu and it plays properly, but the menu\r
131 isn't showing your picture! Or the picture is scaled badly! What manner of man\r
132 would create such an accursed abomination?!\r
133 \r
134 Well... That sounds like something I'd do. :D\r
135 \r
136 And it is really easy: just make a screenshot of the map in action (preferably\r
137 with crosshair and HUD switched off), and place it next to the map as\r
138 mapname.jpg. For best rendering and file size, make the image in 4:3 aspect\r
139 ratio, but scale it to the resolution 256x256 or possibly 512x512. It will look\r
140 skewed in your image editing app, but the menu will show it right, and your\r
141 graphics card LOVES images of such dimension.\r
142 \r
143 \r
144 =================\r
145 =III. Domination=\r
146 =================\r
147 \r
148 In order to get Domination working well in your map, you need to place dom_team\r
149 and dom_controlpoint entites. You *must* have at least 3 dom_team entities - 2\r
150 minimum teams and one blank one (empty netname and no team). You can have up\r
151 to 4 teams (5 dom_team entities).\r
152 \r
153 Dom Team\r
154 --------\r
155 classname  dom_team\r
156 netname    name of team (Red Team). Set to "" or don't define for the required\r
157            blank team.\r
158 cnt        color of the team. See the "Helpful Extras" section for info.\r
159 model      When this team captures control points, the points turn to this\r
160            model. If this is the neutral team, points start out as this model.\r
161 noise      Sound to be played on the control point when it's captured. Only\r
162            players nearby will hear it.\r
163 noise1     Sound to be played to all players when the control point is\r
164            captured. Also good for an annoncer voice ("Red Team has captured a\r
165            control point")\r
166 \r
167 Control Points\r
168 --------------\r
169 classname  dom_controlpoint\r
170 message    message to be displayed to all players when this point is captured,\r
171            preceded by the team's name. This defaults to " has captured a control point".\r
172            You can specify different names for each point, for example " has captured the\r
173            Lava Room".\r
174 origin     where in the map this point is\r
175 wait       How often this point gives its controlling team frags.\r
176 frags      How many frags this point gives each wait cycle.\r
177 \r
178 Here is an example entry in a .ent file that includes colored text and 3 teams:\r
179 \r
180 {\r
181 "classname" "dom_team"\r
182 "netname" ""\r
183 "model" "models/domination/dom_unclaimed.md3"\r
184 }\r
185 {\r
186 "classname" "dom_team"\r
187 "netname" "^4Blue Team"\r
188 "cnt" "13"\r
189 "noise" ""\r
190 "noise1" "domination/claim.wav"\r
191 "model" "models/domination/dom_blue.md3"\r
192 }\r
193 {\r
194 "classname" "dom_team"\r
195 "netname" "^1Red Team"\r
196 "cnt" "4"\r
197 "noise" ""\r
198 "noise1" "domination/claim.wav"\r
199 "model" "models/domination/dom_red.md3"\r
200 }\r
201 {\r
202 "classname" "dom_team"\r
203 "netname" "^6Pink Team"\r
204 "cnt" "9"\r
205 "noise" ""\r
206 "noise1" "domination/claim.wav"\r
207 "model" "models/domination/dom_pink.md3"\r
208 }\r
209 {\r
210 "classname" "dom_team"\r
211 "netname" "^3Yellow Team"\r
212 "cnt" "12"\r
213 "noise" ""\r
214 "noise1" "domination/claim.wav"\r
215 "model" "models/domination/dom_yellow.md3"\r
216 }\r
217 {\r
218 "classname" "dom_controlpoint"\r
219 "message" " ^3has captured the ^1Hallways"\r
220 "origin" "-206.0 -488.8 -150.0"\r
221 "frags" "3"\r
222 "wait" "5"\r
223 "scale" "1.3"\r
224 }\r
225 {\r
226 "classname" "dom_controlpoint"\r
227 "message" " ^3has captured the ^1Lavaroom"\r
228 "origin" "1457.1  19.9 -110.0"\r
229 "frags" "1"\r
230 "wait" "5"\r
231 }\r
232 {\r
233 "classname" "dom_controlpoint"\r
234 "message" " ^3controls the ^1Nex & Strength"\r
235 "origin" "-259.8 299.3  5"\r
236 "frags" "1"\r
237 "wait" "5"\r
238 }\r
239 {\r
240 "classname" "dom_controlpoint"\r
241 "message" " ^3has captured the ^1Upper Platform"\r
242 "origin" "539.7 1206.0 182.0"\r
243 "frags" "1"\r
244 "wait" "5"\r
245 }\r
246 {\r
247 "classname" "dom_controlpoint"\r
248 "message" " ^3has captured the ^1Teleport Room"\r
249 "origin" "-1000.0 636.2 -16.0"\r
250 "frags" "1"\r
251 "wait" "5"\r
252 }\r
253 \r
254 \r
255 As you can see in the example, there are 5 dom_team ents: one blank, Red, Blue,\r
256 Pink and Yellow. Each control point has a different message (giving it a\r
257 special name), and the one in the hallways gives 3 frags every 5 seconds\r
258 instead of just one, making it more valuable.\r
259 \r
260 If your map contains the required entities for Domination, the menu will\r
261 automatically detect it for supporting Domination. To force the map to get\r
262 re-detected after you add such entities, delete the data/data/mapname.mapinfo\r
263 file - or simply edit it to add the "type dom" line.\r
264 \r
265 \r
266 =========\r
267 =IV. CTF=\r
268 =========\r
269 \r
270 Capture the flag needs at least 1 CTF flag per team, and can also make use of\r
271 team spawnpoints.\r
272 \r
273 CTF Flags\r
274 ---------\r
275 classname  item_flag_team1 or item_flag_team2\r
276 angle      direction the flag will point\r
277 model      model of the flag (default: models/ctf/flag_red.md3 or\r
278            models/ctf/flag_blue.md3)\r
279 noise      sound played when flag is stolen (default: "ctf/take.wav")\r
280 noise1     sound played when flag is returned by a teammate (default:\r
281            "ctf/return.wav")\r
282 noise2     sound played when flag is captured (default: "ctf/capture.wav")\r
283 noise3     sound played when flag returns itself (default: "ctf/respawn.wav")\r
284 \r
285 Team Spawnpoints\r
286 ----------------\r
287 classname  info_player_team1 or info_player_team2\r
288 *note: These function just like info_player_deathmatch, but for one team only.\r
289 If you don't make team spawnpoints, info_player_deathmatch is used instead.\r
290 \r
291 If your map contains the required entities for CTF, the menu will automatically\r
292 detect it for supporting CTF. To force the map to get re-detected after you add\r
293 such entities, delete the data/data/mapname.mapinfo file - or simply edit it to\r
294 add the "type ctf" line.\r
295 \r
296 ==============\r
297 =V. Runematch=\r
298 ==============\r
299 \r
300 Runematch needs only one type of entity to work: rune spawn points. You will\r
301 need at least one for each rune (5 minimum at the time of this writing), though\r
302 you should probably have more than that in the map. Just give the points a\r
303 classname and origin.\r
304 \r
305 Rune Spawnpoints\r
306 ----------------\r
307 classname  runematch_spawn_point\r
308 \r
309 If your map contains the required entities for Runematch, the menu will automatically\r
310 detect it for supporting Runematch. To force the map to get re-detected after you add\r
311 such entities, delete the data/data/mapname.mapinfo file - or simply edit it to\r
312 add the "type rune" line.\r
313 \r
314 ==============\r
315 =VI. Race/CTS=\r
316 ==============\r
317 \r
318 Making a race map is not hard: you need some special spawnpoints, and some checkpoints.\r
319 \r
320 Spawnpoints\r
321 -----------\r
322 classname  info_player_race\r
323 target     targetname of the checkpoint\r
324 race_place for finish line checkpoints, the place of the point, or -1 to make it qualifying/CTS-only, or unset to let all the other players spawn\r
325 \r
326 Checkpoints\r
327 -----------\r
328 classname  trigger_race_checkpoint\r
329 targetname some name to target the checkpoint with\r
330 cnt        number of the checkpoint (or 0 for finish line)\r
331 \r
332 Note that checkpoints are brush entities, and they should be somewhat thick and\r
333 cover the full volume the player could use to get past them.\r
334 \r
335 Example of entity placement:\r
336 \r
337                          ###\r
338     ---------------------###---\r
339    /    >>>>  7  5  3  1 ###   \\r
340   /     >>>> 8  6  4  2  ###    \\r
341  |     ------------------###     |\r
342 %%%%%%%%                 ###|    |\r
343 %%%%%%%%                 $$$|    |\r
344  | ^ ^ ------------------$$$     |\r
345  \                       $$$ <  /\r
346   \                      $$$ < /\r
347    ----------------------$$$---\r
348                          $$$\r
349 \r
350 ###:  classname = trigger_race_checkpoint, cnt = 0, targetname = finish\r
351 $$$:  classname = trigger_race_checkpoint, cnt = 1, targetname = cp1\r
352 %%%:  classname = trigger_race_checkpoint, cnt = 2, targetname = cp2\r
353 >:    classname = info_player_race,                 target = finish, angle = 0\r
354 1:    classname = info_player_race,                 target = finish, angle = 0, race_place = 1\r
355 2:    classname = info_player_race,                 target = finish, angle = 0, race_place = 2\r
356 ....\r
357 8:    classname = info_player_race,                 target = finish, angle = 0, race_place = 8\r
358 <:    classname = info_player_race,                 target = cp1,    angle = 180\r
359 ^:    classname = info_player_race,                 target = cp2,    angle = 90\r
360 \r
361 If your map contains the required entities for Race, the menu will automatically\r
362 detect it for supporting Race. To force the map to get re-detected after you add\r
363 such entities, delete the data/data/mapname.mapinfo file - or simply edit it to\r
364 add the "type rc" line.\r
365 \r
366 CTS maps do not use checkpoints with race_place set, so you can leave them out\r
367 for CTS maps.\r
368 \r
369 The skill parameter in the mapinfo entry for CTS shall be in the range from 0 (easy) to 10 (impossible).\r
370 \r
371 =============\r
372 =VI. Nexball=\r
373 =============\r
374 \r
375 There are three required entities: nexball_redgoal, nexball_bluegoal, and one of nexball_basketball\r
376 or nexball_football. There are also optional nexball_yellowgoal and nexball_pinkgoal entities (don't\r
377 add a pink goal when there is no yellow goal on the map, it will crash)\r
378 \r
379 Goals are made just like any other regular triggers. You can use multiple brushes for one trigger,\r
380 but avoid this if possible.\r
381 \r
382 There are also two other goal-like entities, nexball_fault and nexball_bound, the first taking a point\r
383 from the team that hits the trigger with the ball, the second simply returning it. You can spawn the\r
384 ball inside a goal-like trigger, this can be useful for basketball maps with separate teams and a\r
385 common ball spawn.\r
386 The different keys for the entities are documented in entities.def.\r
387 \r
388 The ball is affected by trigger_impulse, but not by trigger_push or teleporters.\r
389 \r
390 You should better avoid patches on the field, as collisions can sometimes get buggy on these.\r
391 \r
392 \r
393 ===============================\r
394 =Appendix A - Advanced mapinfo=\r
395 ===============================\r
396 \r
397 You now know how to make a basic, bare-bones mapinfo to set up a couple options\r
398 and load your map. However, there's much more you can do!  Consider these\r
399 senarios:\r
400 \r
401 1. The laser has too high of a force for laser jumps and ruins CTF\r
402 2. I don't want players to start out with the shotgun, but with the machinegun\r
403    instead\r
404 3. The map takes so much server CPU performance that the anti-wallhack can't be\r
405    made active\r
406 \r
407 Each of these situations can be resolved with ease with a little work in the\r
408 mapinfo file.\r
409 \r
410 To do this, I can add the following lines to my mapinfo file:\r
411 \r
412     settemp_for_type ctf g_balance_laser_primary_force 200\r
413     settemp_for_type all g_start_weapon_shotgun 0\r
414     settemp_for_type all g_start_weapon_uzi 1\r
415     settemp_for_type all sv_cullentities_trace 0\r
416 \r
417 These "settemp" settings are automatically removed when the map is left and\r
418 another is loaded. As you can see, it is possible to make per-mode temporary\r
419 settings, and global ones.\r
420 \r
421 Similar settings are also possible for the client:\r
422 \r
423     clientsettemp_for_type all r_shadow_glossexponent 96\r
424 \r
425 Another possibility is to specify fog settings in the mapinfo, for convenience\r
426 in case you set sv_foginterval by it too (to force the fog on the clients):\r
427 \r
428     fog 0.2 0.25 0.3 0.3 1 1500\r
429     settemp_for_type all sv_foginterval 5\r
430 \r
431 \r
432 =============================\r
433 =Appendix B - Helpful Extras=\r
434 =============================\r
435 \r
436 ----------------\r
437 -i. Team Colors-\r
438 ----------------\r
439 When you need to set an entity's color or team, use these values:\r
440 \r
441 Red\r
442 ---\r
443 Team:      5\r
444 Color:     4\r
445 \r
446 Blue\r
447 ----\r
448 Team:      14\r
449 Color:     13\r
450 \r
451 Yellow\r
452 ------\r
453 Team:      13\r
454 Color:     12\r
455 \r
456 Pink\r
457 -----\r
458 Team:      10\r
459 Color:     9\r
460 \r
461 \r
462 ----------------\r
463 -i. Text Colors-\r
464 ----------------\r
465 Occasionally you may want to print text in color, such as team names. Here are your options:\r
466 \r
467 1  Red\r
468 2  Green\r
469 3  Yellow\r
470 4  Blue\r
471 5  Cyan\r
472 6  Magenta\r
473 7  White\r
474 8  Grey (transparent)\r
475 9  Grey (solid)\r
476 0  Black\r
477 \r
478 ==========================================\r
479 =Appendix C - Advanced Darkplaces shaders=\r
480 ==========================================\r
481 \r
482 Shader parameters for DP's own features:\r
483 - dp_reflect <distort> <r> <g> <b> <a>\r
484   Makes surfaces of this shader reflective with r_water. The reflection is\r
485   alpha blended on the texture with the given alpha, and modulated by the given\r
486   color. distort is used in conjunction with the normalmap to simulate a\r
487   nonplanar water surface.\r
488 - dp_refract <distort> <r> <g> <b>\r
489   Makes surfaces of this shader refractive with r_water. The refraction\r
490   replaces the transparency of the texture. distort is used in conjunction with\r
491   the normalmap to simulate a nonplanar water surface.\r
492 - dp_water <reflectmin> <reflectmax> <refractdistort> <reflectdistort> <refractr> <refractg> <refractb> <reflectr> <reflectg> <reflectb> <alpha>\r
493   This combines the effects of dp_reflect and dp_refract to simulate a water\r
494   surface. However, the refraction and the reflection are mixed using a Fresnel\r
495   equation that makes the amount of reflection slide from reflectmin when\r
496   looking parallel to the water to reflectmax when looking directly into the\r
497   water. The result of this reflection/refraction mix is then layered BELOW the\r
498   texture of the shader, so basically, it "fills up" the alpha values of the\r
499   water. The alpha value is a multiplicator for the alpha value on the texture\r
500   - set this to a small value like 0.1 to emphasize the reflection and make\r
501   the water transparent; but if r_water is 0, alpha isn't used, so the water can\r
502   be very visible then too.\r
503 \r