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