more eol-style
[xonotic/netradiant.git] / docs / manual / quake3 / Compile_Manual / bspc.txt
1
2
3 Title:         BSP Converter
4 Version:       2.1h
5 Date:          2001-03-28
6 Author:        Mr. Elusive
7
8
9 Description
10 -----------
11
12 The BSPC tool is used to create AAS files from BSP files.
13 An AAS file is a file with areas used by the Quake III Arena bot in order
14 to navigate and understand a map. The Quake III Arena maps are stored in
15 BSP files.
16
17
18 Usage
19 -----
20
21 bspc [-<switch> [-<switch> ...]]
22
23 Example 1: bspc -bsp2aas d:\quake3\baseq3\maps\mymap?.bsp
24 Example 2: bspc -bsp2aas d:\quake3\baseq3\pak0.pk3\maps/q3dm*.bsp
25
26 Switches:
27    bsp2aas  <[pakfilter/]filter.bsp>    = convert BSP to AAS
28    reach    <filter.bsp>                = compute reachability & clusters
29    cluster  <filter.aas>                = compute clusters
30    aasopt   <filter.aas>                = optimize aas file
31    output   <output path>               = set output path
32    threads  <X>                         = set number of threads to X
33    cfg      <filename>                  = use this cfg file
34    optimize                             = enable optimization
35    noverbose                            = disable verbose output
36    breadthfirst                         = breadth first bsp building
37    nobrushmerge                         = don't merge brushes
38    freetree                             = free the bsp tree
39    nocsg                                = disables brush chopping
40    forcesidesvisible                    = force all sides to be visible
41    grapplereach                         = calculate grapple reachabilities
42
43
44 Several metacharacter may be used in the filter and pakfilter.
45
46 *          match any string of zero or more characters
47 ?          match any single character
48 [abc...]   match any of the enclosed characters; a hyphen can
49            be used to specify a range (e.g. a-z, A-Z, 0-9)
50
51 .pk3 files are accessed as if they are normal folders. For instance
52 use "d:\quake3\baseq3\pak0.pk3\maps/q3dm1.bsp" to access the
53 map q3dm1.bsp from the pak0.pk3 file. 
54
55 Multiple files may be listed after the switches bsp2map, bsp2aas, reach,
56 cluster and aasopt.
57
58 If a BSP file is being converted to an AAS file and no output path
59 is entered on the command-line then the AAS file will automatically
60 be stored in the same folder as the BSP file. However if the BSP file
61 was stored in a .pk3 file then the AAS file will be stored in a folder
62 with the name 'maps' outside the .pk3 file.
63
64
65 Updating entity lump
66 --------------------
67
68 If an AAS file is already available for a BSP file and you ONLY change
69 the entities inside this BSP file then you only have to recalculate the
70 reachabilities. This way you can move items, platforms etc. around
71 without the need to recalculate the whole AAS file which can save quite
72 some compile time. You can recalculate the reachabilities as follows:
73
74 bspc -reach mymap.bsp
75
76 Where mymap.bsp is the BSP file. The mymap.aas file has to be in the
77 same folder as mymap.bsp or should be in the output folder specified
78 with the -output option.
79
80 Keep in mind that as soon as ANY geometry in the map changes the whole
81 AAS file HAS to be recalculated in order to play with bots.
82
83 NOTE: -reach does not work on optimized .AAS files!
84 NOTE: don't use -reach when moving the position of doors.
85
86
87 Leaks
88 -----
89
90 Just like there can be vis leaks in a map there can also be clipping
91 leaks. Two things can be wrong when the BSPC tool outputs that a map
92 leaks.
93
94 1. There are no entities in the map at all, or all entities that are
95 actually in the map are placed in solid. In this case the BSPC tool
96 outputs "WARNING: no entities inside". (At least a player start entity
97 is needed to load a map.)
98
99 2. There is a spot in the map where players can go outside the map
100 into the void. This is bad, players should never be able to fall out
101 of a level. In this case the BSPC tool outputs "WARNING: entity
102 reached from outside". The BSPC tool also writes a mymap.lin file
103 that can be loaded in the Q3Radiant editor to show lines that go
104 through the actual leak.
105
106 Make sure the .lin file is stored in the same folder as where q3radiant
107 stores the .bsp file. Load the map in q3radiant and use the
108 menu -> File -> Pointfile... to load the .lin file. A thick red line
109 will be shown in the map. Follow this line to find the leak.
110
111
112 Map bounds
113 ----------
114
115 Currently a map should be within the bounds (-65536, -65536, -65536) -
116 (65536, 65536, 65536) for the bspc tool to compile. These are the same
117 limits the q3map tool has.
118
119
120 Physics
121 -------
122
123 The player bounding box is a 30 units by 30 units square with a height
124 of 56 units. If we assume 1.75 meters being the average height of a human
125 and a player in Quake III Arena being 56 units high we get 32 units = 1 meter.
126
127 Maximum step height of a player is 18 units (just keep steps 16 units or
128 lower).
129
130 The maximum water jump height for bots has been set to 18 units. (height
131 difference between water surface and the floor jumping onto). If the
132 waterjump height is made higher human players will have a hard time getting
133 out of the water.
134
135 With normal gravity and without the quad the maximum rocket jump height is
136 around 280 units (you can sometimes jump a few units higher but this is a
137 safe value for reference).
138
139 The maximum height for barriers the bots will jump on is 32 units.
140
141 Some math to calculate some other values of interest:
142
143 gravity = 800;
144 jump velocity = 270;
145 max vertical rocketjump velocity = 670;
146 max run velocity = 320;
147 max step height = 18;
148
149 max jump height = 0.5 * gravity * (jumpvelocity/gravity)*(jumpvelocity/gravity);
150 max jump height = 45 units;
151 NOTE: even though this is the mathematical maximum jump height always keep
152 the the 32 units maximum barrier height for bots in mind when building maps.
153
154 maximum horizontal jump distance over a gap from one spot to another both
155 at the same height:
156
157 t = sqrt((maxjumpheight + maxstep) / (0.5 * gravity));
158 t = 0.3986 seconds;
159 dist = maxrunvelocity * (t + jumpvelocity / gravity);
160 dist = 235 units;
161 Because players use a bounding box we can jump a full bounding box width
162 furter in the ideal case. (15 units at the jump start and 15 at the
163 landing place).
164 235 + 15 + 15 = 265 units.
165 Again this is the mathematical maximum which players can only reach under
166 ideal circumstances.
167
168
169 Optimizing a map for bspc
170 -------------------------
171
172 Hint brushes have no effect on the bspc tool. Only solid, clip, liquid,
173 cluster portal and do not enter brushes are used by the bspc tool.
174
175 The bspc tool outputs how many areas are created for a map. Less areas
176 is better. Often the number of areas can be reduced by adding additional
177 clip brushes. By adding these additional clip brushes the complexity
178 of the geometry used for collision can be reduced. Do not add clip
179 brushes in front of the complex geometry but get the complex shaped
180 geometry contained within these clip brushes. Things that should be
181 contained within clip brushes are small or complex shaped (often detail)
182 brushes and complex and twisted curves, but also more regular curves
183 can be placed within a clip brush. When containing a curve within a
184 clip brush it's preferred to place the whole curve within the clip
185 brush (not just part of the curve).
186 Note: you can make brushes or curves non-solid when they are contained
187 within *full* clip or *weap* clip brushes to speed up bspc calculations.
188
189 Always try to align your geometry to the grids. Always use the largest
190 grid possible for alignment of your geometry. Also try to align the
191 back sides of brushes which may not be visible. The more brush sides
192 are aligned the better. This will also speed up bspc calculations.
193
194 Align adjacent brushes as much as possible. Make sure no tiny faces are
195 created due to badly aligned brushes.
196
197 Quite often there are places in a map that are visible to players
198 but that players can never get to. Players would be able to walk around there
199 but since players can never reach such places they will never actually
200 move around there. If players are never able to get to such places
201 it's better to put a large clip brush which encloses that whole space.
202 This will also speed up bspc calculations and reduce the number of areas
203 created by the bspc tool.
204
205 Note: the number of areas relative to the map size tells something about
206 the navigation complexity for players in general (also human players).
207 Reducing the collision complexity for bots also makes the map easier to
208 navigate for human players
209
210
211 func_plat and func_bobbing
212 --------------------------
213
214 When func_plat or func_bobbing entities are placed in a map the bots will
215 use them if possible. The bots assume they can stand on top of the bounding
216 box of the model used for the func_plat or func_bobbing entity. As a result
217 creating complex shaped func_plat or func_bobbing models is mostly a bad
218 idea. You have to make sure the bots (and players) can actually stand
219 everywhere ontop of the bounding box of the model.
220
221
222 Cluster Portals
223 ---------------
224
225 A map is divided into areas. Several of these areas can be grouped together
226 to create a cluster. The clusters are seperated by cluster portals which are
227 areas themselves. One of the things the bot uses these clusters for is a
228 multi-level routing algorithm. When a map is efficiently divided up into
229 clusters bot calculations will be faster.
230
231 several things to take into account:
232
233 - The BSPC tool tries to create cluster portals automatically but additional
234   cluster portals can be created by placing "clusterportal" brushes.
235 - Cluster portals are manually created by placing "clusterportal" brushes
236   inside the map.
237 - Cluster portal brushes are a tool to optimize a map for CPU usage by the
238   bots. They are not needed for the bots to operate correctly.
239 - The "clusterportal" brushes should not be used outside the world hull.
240 - The cluster portals do not have any effect on vis.
241 - If a door is already sealed with an areaportal brush, a clusterportal is
242   not necessary there. (area portals are also used as cluster portals).
243 - Just like the area portals, the cluster portals must seal a space off
244   entirely from other areas.
245 - The cluster portal areas should seal off a cluster in a way that the only
246   path towards another cluster is through a cluster portal area.
247 - Only create cluster portals where people can walk or swim through.
248 - Don't create cluster portals in gaps in the floor. (people would fall through)
249 - If you have two sealed off clusters and you add a teleporter between them
250   then the two clusters will be merged again because of the teleporter.
251 - Cluster portals must seperate no more and no less than two (2) clusters.
252 - Try to create clusters with all the same number of 'reachability' areas.
253   for instance if the map has 5400 areas try to create 10 clusters with 540
254   areas each, or 12 clusters with 450 areas each, etc. The BSPC tool lists
255   the number of reachability areas in each cluster.
256   With Q3A version 1.25 and up you can use /set bot_testclusters 1 on the
257   console and the area number and cluster number you're in will be printed
258   on the screen. These cluster number correspond to the cluster numbers
259   the BSPC tool prints.
260 - Minimize the number of clusters with only a few (less than 10) areas.
261 - When adding "cluster portal" brushes try to place them in places with
262   minimal geometric complexity. For instance place them inside convex door
263   openings or small hallways (not infront of door openings). Ideally the shape
264   of the face through which a player walks or swims into the cluster portal
265   is the same as the shape of the face through which a player leaves the
266   cluster portal. Also ideally the open space inside the cluster portal
267   brush is convex.
268 - Make cluster portals about 16 or 32 units thick or align them with
269   adjacent geometry. Don't make them too thick though.
270 - Minimize the total number of cluster portal areas at all times. The more
271   cluster portal areas you have the more CPU the bots need.
272 - Items have no effect at all on the creation of areas or clusters.
273   The same goes for item_botroam.
274
275
276 Do Not Enter areas
277 ------------------
278
279 When bot navigation problems show up or you want to make sure a bot never tries
280 to go to a certain place "do not enter" brushes can be used.
281
282 several things to take into account:
283
284 - The "do not enter" brushes should not be used outside the world hull.
285 - The "do not enter" brush is Not a clip brush for the bot.
286 - The "do not enter" brush is a tool of last resort. Do not use it unless
287   there are serious navigation problems.
288 - The number of "do not enter" brushes should be minimized because these
289   brushes create additional areas for the bots.
290 - The "do not enter" brush will create a New area that the bot will try to
291   avoid. However if the bot somehow ends up in a "do not enter" area or there
292   is a valid goal inside the "do not enter" area then the bot is allowed to
293   go into and out of that area. So if the bot somehow gets in a "do not enter"
294   area the bot will be able to get out.
295
296
297 Bot roaming
298 -----------
299
300 The item_botroam entity can be used when a bot does not roam the whole level
301 or prefers to go to only specific areas. This (invisible) item can be placed
302 in a map just like regular items. Nobody can actually pick up the item it's
303 only used to attract bots to certain places of the map. The item_botroam has
304 a key "origin". The value is set by Q3Radiant automatically. The item_botroam
305 also has a key "weight". The value is the weight of the roam item and is
306 relative to the weight of other items in the map. The bot character specific
307 item weights are stored with the bot characters in the botfiles/bots/ sub-folder
308 in the .pk3 file. The value of the weight is a non-zero floating point value,
309 most often in the range 0 to 400. (Higher values are allowed but keep in mind
310 that the bot should also still go for normal items, so don't make the
311 item_botroam weight to high.)
312
313 When a bot should never go for a specific item the key "notbot" with value "1"
314 can be used for that item. This key with value can be used for every available
315 item in Quake III Arena.
316
317 The suspended flag can be used on all items (item_botroam included).
318 However keep in mind that when a suspended item is not anywhere near the
319 ground the bot will ONLY try to go for this suspended item using jump pads.
320
321
322 Team based entities
323 -------------------
324
325 You can use the "bot_notteam" entity key with value "1" or "2" on teleporters
326 (trigger_teleport or trigger_multiple pointing at a target_teleporter),
327 elevators (func_plat), cyclic movers (func_bobbing), jumppads (trigger_push)
328 and areas that hurt the player (trigger_hurt).
329 When "notteam" is set to "1" only bots using the travel flag TFL_NOTTEAM1 will
330 use the entity or move through the area. When "bot_notteam" is set to "2" only
331 bots using the travel flag TFL_NOTTEAM2 will use the entity or move through the
332 area. These travel flags can be used in the game source code. Using this entity
333 key also only has effect if the mod the map is being made for supports team based
334 navigation for bots.
335
336
337 Testing AAS files
338 -----------------
339
340 One of the easiest ways to test the AAS file is to load the map in
341 Quake3 in teamplay mode (type /set g_gametype 3 on the console before
342 loading the map). Enter a team and add a bot to your team. Use the
343 team order menu (by default bound to the key F3) to command the bot
344 to follow you. Walk around the map and see if the bot is able to
345 follow you everywhere.
346
347 Map bugs can sometimes cause certain places in the map to show up
348 'solid' in the AAS file. The bots cannot travel through these 'solid'
349 areas. To test for these 'solid' places set the cvar bot_testsolid
350 to 1 on the console. (type /set bot_testsolid 1) The map has to be
351 started with devmap instead of map before the cvar bot_testsolid can
352 be set. When the cvar is set to 1 then either "empty area" or
353 "SOLID area" will be printed on the screen while traveling through a map.
354 Several map bugs can cause these 'solid' places in the AAS file.
355 - Sometimes microscopic brushes are left over after a brush CSG. Search
356   for such brushes in the problem area and delete them.
357 - Tiny brush faces (not curves) can also cause problems. Due to vertex
358   snapping in the q3map tool those tiny brush faces can be snapped out
359   of existence. Such faces will not show up in Quake3 and you'll see
360   tiny peek holes or slits where you can view through the geometry.
361   Allign vertexes of and edges of adjacent brushes to remove and avoid
362   such tiny faces. Placing a clip brush in front of the face that is
363   snapped out of existence will also remove the 'solid' area but ofcourse
364   it's much better to remove the peek holes and slits.
365 - Another cause could be a brush with a collapsed side. Check how many
366   sides a brush has and how many sides actually have a surface. Rebuild
367   brushes with collapsed sides.
368 - All faces contained within liquid brushes using a shader without
369   "surfaceparm trans" set will be removed. Those contained surfaces will
370   not be visible and can cause the liquid to appear "solid" in the AAS file.
371
372 If you insist creating an AAS file for a map with bugs then the option
373 -forcesidesvisible can be used. This should fix all the problems with areas
374 showing up solid in the AAS file. However creating an AAS file with this
375 option takes a lot longer (often more than twice the normal compile time).
376
377 Clusters can be tested with the cvar bot_testclusters.
378 (type "/set bot_testclusters 1" on the console)
379
380 Jumppads can also be tested. Type the following on the Quake3 console
381 before loading your map:
382
383 /set bot_maxdebugpolys 1024
384 /set bot_visualizejumppads 1
385 /set bot_forcereachability 1
386
387 Now load the map. A counter will be shown and goes from 0% to 100%.
388 When the counter has reached 100% type /set bot_debug 1 and
389 /set r_debugSurface 2 on the console. For every jumppad the
390 default arch of travel (without using air control) will be visualized.
391 This only works if your .aas file is not optimized.
392
393
394 Error messages
395 --------------
396
397 Level designers should not worry too much about the following messages and/or warnings. The things reported are non fatal and won't cause any major problems. Some of the messages are just debug left overs.
398
399 "AAS_CheckArea: area %d face %d is flipped\n"
400 "AAS_CheckArea: area %d center is %f %f %f\n"
401 "AAS_CheckFaceWindingPlane: face %d winding plane unequal to face plane\r\n"
402 "AAS_CheckFaceWindingPlane: face %d winding reversed\r\n"
403 "area %d face %d flipped: front area %d, back area %d\n"
404 "area %d face %d is tiny\r\n"
405 "face %d and %d, same front and back area but flipped planes\r\n"
406 "AAS_SplitFace: tiny back face\r\n"
407 "AAS_SplitFace: tiny back face\r\n"
408 "AAS_SplitArea: front area without faces\n"
409 "AAS_SplitArea: back area without faces\n"
410 "gsubdiv: area %d has a tiny winding\r\n"
411 "AAS_TestSplitPlane: tried face plane as splitter\n"
412 "found %d epsilon faces trying to split area %d\r\n"
413 "AAS_SplitArea: front area without faces\n"
414 "AAS_GetFace: face %d had degenerate edge %d-%d\r\n"
415 "AAS_GetFace: face %d was tiny\r\n"
416 "WARNING: huge winding\n"
417 "bogus brush after clip"
418 "split removed brush"
419 "split not on both sides"
420 "two tiny brushes\r\n"
421 "possible portal: %d\r\n"
422 "portal %d: area %d\r\n"
423 "WARNING: CM_GridPlane unresolvable\n"
424 "WARNING: CM_AddFacetBevels... invalid bevel\n"
425 "WARNING: CM_SetBorderInward: mixed plane sides\n"
426 "WARNING: bevel plane already used\n"
427 "trigger_multiple model = \"%s\"\n"
428 "trigger_teleport model = \"%s\"\n"
429 "found a trigger_push with velocity %f %f %f\n"
430 "AAS_TraceBoundingBox: stack overflow\n"
431 "AAS_TraceAreas: stack overflow\n"
432 "AAS_LinkEntity: stack overflow\n"
433 "MergeWindings: degenerate edge on winding %f %f %f\n"
434 "Warning: MergeWindings: front to back found twice\n"
435 "FindPlaneSeperatingWindings: winding1 non-convex\r\n"
436 "FindPlaneSeperatingWindings: winding2 non-convex\r\n"
437
438
439 When one of the following messages, errors or warnings is found then there is often something to be fixed.
440
441 "WARNING! HashVec: point %f %f %f outside valid range\n"
442 "This should never happen!\n"
443         While storing the AAS file some vertex was found outside the valid map bounds. When this happens some part of the map is likely to have badly aligned brushes or weird shaped curves. Clipping off or rebuilding complex shapes often helps.
444 "trigger_push start solid\n"
445         The trigger_push start point is in solid. Try making the trigger_push brush a bit larger or move it around a bit.
446 "trigger_push without target entity %s\n"
447         Could not find the target entity of the trigger_push with the target field %s.
448 "trigger_push without time\n"
449         trigger_push entity found without "time" field.
450 "trigger_multiple not in any jump pad area\n"
451 "trigger_push not in any jump pad area\n"
452         A trigger_push entity was found not to be in any valid jumppad area. (the message states trigger_multiple but it should have been trigger_push) Try making the trigger_push brush a bit larger or move it around a bit.
453 "trigger_multiple at %1.0f %1.0f %1.0f without target\n"
454         A trigger multiple was found at the given coordinates without a "target" field.
455 "target_teleporter without target\n"
456         A target_teleporter entity was found without target field.
457 "trigger_teleport at %1.0f %1.0f %1.0f without target\n"
458         A trigger_teleport entity was found at the given coordinates without "target" field.
459 "teleporter without misc_teleporter_dest (%s)\n"
460         The destination of a teleporter with target field %s could not be found.
461 "teleporter destination (%s) without origin\n"
462         A teleporter destination with the target name %s was found without origin field.
463 "teleporter destination (%s) in solid\n"
464         A teleporter destination with the targetname %s was found to be in solid.
465 "teleported into slime or lava at dest %s\n"
466         A player would be pushed into slime or lave at the teleporter destination with the targetname %s.
467 "trigger_multiple not in any area\n"
468         A teleporter trigger was found not to be in any valid area. Try moving the trigger around a bit.
469 "func_plat without model\n"
470         A func_plat entity was found without model field.
471 "func_plat with invalid model number\n"
472         A func_plat entity was found with the model field set to some invalid number.
473 "func_bobbing without model\n"
474         A func_bobbing entity was found without model field.
475 "func_bobbing with invalid model number\n"
476         A func_bobbing entity was found with the model field set to some invalid number.
477 "%s in solid at (%1.1f %1.1f %1.1f)\n"
478         An item with classname %s was found to be in solid at the given coordinates.
479 "empty aas link heap\n"
480         Some part of the map has some rather complex clipping. Reduce the geometric complexity or use clip brushes to reduce the clipping complexity.
481 "too many entities in BSP file\n"
482         There are too many entities in the bsp file.
483 "error opening %s\n"
484         Could not create a new AAS file. Hard disk might be full.
485 "error writing lump %s\n"
486         Could not write an AAS lump to file. Hard disk might be full.
487
488
489
490 Version Changes
491 ---------------
492
493 2.1h (2001-03-28)
494
495 - fixed crash bug
496
497 2.1g (2001-02-18)
498
499 - added bot_notteam support on trigger_hurt entities
500
501
502 2.1f (2001-02-06)
503
504 - added some AAS statistics
505 - don't flood through faces when creating clusters
506
507
508 2.1e (2001-01-10)
509
510 - fix map size limitation
511
512
513 2.1d (2000-12-17)
514
515 - renamed "notteam" to "bot_notteam"
516
517
518 2.1c (2000-11-02)
519
520 - added fs_maxfallheight
521 - compiled with larger map size bounds
522
523
524 2.1b (2000-09-15)
525
526 - fixed cfg file loading
527
528
529 2.1 (2000-06-28)
530
531 - added model numbers for AREACONTENTS_MOVER
532 - added team based func_plat, func_bobbing, trigger_teleport and trigger_push reachabilities
533
534
535 2.0 (2000-06-21)
536
537 - fixed swim reachabilities
538 - fixed some reachabilities through cluster portals
539 - fixed jump reachabilities
540 - changed some start travel times
541 - added travel time settings to cfg
542
543
544 1.9 (2000-03-27)
545
546 - fixed func_bobbing entities with origin brush
547
548
549 1.8 (2000-01-14)
550
551 - fixed trigger_teleport bug.
552 - increased max map bounds to (-8192, -8192, -8192)-(8192, 8192, 8192)
553 - increased max points on winding
554 - made "HashVec: point x y z outside valid range" non-fatal
555 - fixed rocket jump reachabilities
556 - added force sides visible option
557 - increased simulated stack size for area traces
558
559
560 1.7 (1999-12-22)
561
562 - fixed ducked bounding box size
563 - fixed sv_maxsteepness being zero in aas configuration
564 - AAS files are now automatically stored in BSP file folder
565 - fixed crash bug caused by overflow of a simulated stack