Complete_list_of_command_line_parameters.textile

   1 h1. Complete list of command line parameters
   2
   3 h2. Common options
   4
   5 * *@-connect@ address:* Talk to a NetRadiant instance using a specific XML based protocol
   6 * *@-force@:* Allow reading some broken/unsupported BSP files e.g. when decompiling, may also crash
   7 * *@-fs_basepath@ path:* Sets the given path as main directory of the game (can be used more than once to look in multiple paths)
   8 * *@-fs_game@ gamename:* Sets a different game directory name (default for Q3A: baseq3)
   9 * *@-fs_homebase@ dir:* Specifies where the user home directory name is on Linux (default for Q3A: .q3a)
  10 * *@-game@ gamename:* Load settings for the given game (default: quake3)
  11 * *@-subdivisions@ F:* multiplier for patch subdivisions quality
  12 * *@-threads@ N:* number of threads to use
  13 * *@-v@:* Verbose mode
  14
  15 h2. BSP stage
  16
  17 * *@-bsp@ ... filename.map:* Switch that enters this stage
  18 * *@-altsplit@:* Alternate BSP tree splitting weights (should give more fps)
  19 * *@-celshader@ shadername:* Sets a global cel shader name
  20 * *@-custinfoparms@:* Read scripts/custinfoparms.txt
  21 * *@-debuginset@:* Push all triangle vertexes towards the triangle center
  22 * *@-debugportals@:* Make BSP portals visible in the map
  23 * *@-debugsurfaces@:* Color the vertexes according to the index of the surface
  24 * *@-deep@:* Use detail brushes in the BSP tree, but at lowest priority (should give more fps)
  25 * *@-de@ F:* Distance epsilon for plane snapping etc.
  26 * *@-fakemap@:* Write fakemap.map containing all world brushes
  27 * *@-flares@:* Turn on support for flares (TEST?)
  28 * *@-flat@:* Enable flat shading (good for combining with -celshader)
  29 * *@-fulldetail@:* Treat detail brushes as structural ones
  30 * *@-leaktest@:* Abort if a leak was found
  31 * *@-meta@:* Combine adjacent triangles of the same texture to surfaces (ALWAYS USE THIS)
  32 * *@-minsamplesize@ N:* Sets minimum lightmap resolution in luxels/qu
  33 * *@-mi@ N:* Sets the maximum number of indexes per surface
  34 * *@-mv@ N:* Sets the maximum number of vertices of a lightmapped surface
  35 * *@-ne@ F:* Normal epsilon for plane snapping etc.
  36 * *@-nocurves@:* Turn off support for patches
  37 * *@-nodetail@:* Leave out detail brushes
  38 * *@-noflares@:* Turn off support for flares
  39 * *@-nofog@:* Turn off support for fog volumes
  40 * *@-nohint@:* Turn off support for hint brushes
  41 * *@-nosubdivide@:* Turn off support for @q3map_tessSize@ (breaks water vertex deforms)
  42 * *@-notjunc@:* Do not fix T-junctions (causes cracks between triangles, do not use)
  43 * *@-nowater@:* Turn off support for water, slime or lava (Stef, this is for you)
  44 * *@-np@ A:* Force all surfaces to be nonplanar with a given shade angle
  45 * *@-onlyents@:* Only update entities in the BSP
  46 * *@-patchmeta@:* Turn patches into triangle meshes for display
  47 * *@-rename@:* Append "\_bsp" suffix to misc\_model shaders (needed for SoF2)
  48 * *@-samplesize@ N:* Sets default lightmap resolution in luxels/qu
  49 * *@-skyfix@:* Turn sky box into six surfaces to work around ATI problems
  50 * *@-snap@ N:* Snap brush bevel planes to the given number of units
  51 * *@-tempname@ filename.map:* Read the MAP file from the given file name
  52 * *@-texrange@ N:* Limit per-surface texture range to the given number of units, and subdivide surfaces like with @q3map_tessSize@ if this is not met
  53 * *@-tmpout@:* Write the BSP file to /tmp
  54 * *@-verboseentities@:* Enable @-v@ only for map entities, not for the world
  55
  56 h2. VIS stage
  57
  58 * *@-vis@ ... filename.map:* Switch that enters this stage
  59 * *@-fast@:* Very fast and crude vis calculation
  60 * *@-mergeportals@:* The less crude half of @-merge@, makes vis sometimes much faster but doesn't hurt fps usually
  61 * *@-merge@:* Faster but still okay vis calculation
  62 * *@-nopassage@:* Just use PortalFlow vis (usually less fps)
  63 * *@-nosort@:* Do not sort the portals before calculating vis (usually slower)
  64 * *@-passageOnly@:* Just use PassageFlow vis (usually less fps)
  65 * *@-saveprt@:* Keep the PRT file after running vis (so you can run vis again)
  66 * *@-tmpin@:* Use /tmp folder for input
  67 * *@-tmpout@:* Use /tmp folder for output
  68
  69 h2. LIGHT stage
  70
  71 * *@-light@ ... filename.map:* Switch that enters this stage
  72 * *@-vlight@ ... filename.map:* Deprecated alias for @-light -fast@ ... filename.map
  73 * *@-approx@ N:* Vertex light approximation tolerance (never use in conjunction with deluxemapping)
  74 * *@-areascale@ F, @-area@ F:* Scaling factor for area lights (surfacelight)
  75 * *@-border@:* Add a red border to lightmaps for debugging
  76 * *@-bouncegrid@:* Also compute radiosity on the light grid
  77 * *@-bounceonly@:* Only compute radiosity
  78 * *@-bouncescale@ F:* Scaling factor for radiosity
  79 * *@-bounce@ N:* Number of bounces for radiosity
  80 * *@-cheapgrid@:* Use @-cheap@ style lighting for radiosity
  81 * *@-cheap@:* Abort vertex light calculations when white is reached
  82 * *@-compensate@ F:* Lightmap compensate (darkening factor applied after everything else)
  83 * *@-cpma@:* CPMA vertex lighting mode
  84 * *@-custinfoparms@:* Read scripts/custinfoparms.txt
  85 * *@-dark@:* Darken lightmap seams
  86 * *@-debugaxis@:* Color the lightmaps according to the lightmap axis
  87 * *@-debugcluster@:* Color the lightmaps according to the index of the cluster
  88 * *@-debugdeluxe@:* Show deluxemaps on the lightmap
  89 * *@-debugnormals@:* Color the lightmaps according to the direction of the surface normal
  90 * *@-debugorigin@:* Color the lightmaps according to the origin of the luxels
  91 * *@-debugsurfaces@, @-debugsurface@:* Color the lightmaps according to the index of the surface
  92 * *@-debugunused@:* This option does nothing
  93 * *@-debug@:* Mark the lightmaps according to the cluster: unmapped clusters get yellow, occluded ones get pink, flooded ones get blue overlay color, otherwise red
  94 * *@-deluxemode 0@:* Use modelspace deluxemaps (DarkPlaces)
  95 * *@-deluxemode 1@:* Use tangentspace deluxemaps
  96 * *@-deluxe@, @-deluxemap@:* Enable deluxemapping (light direction maps)
  97 * *@-dirtdebug@, @-debugdirt@:* Store the dirtmaps as lightmaps for debugging
  98 * *@-dirtdepth@:* Dirtmapping depth
  99 * *@-dirtgain@:* Dirtmapping exponent
 100 * *@-dirtmode 0@:* Ordered direction dirtmapping
 101 * *@-dirtmode 1@:* Randomized direction dirtmapping
 102 * *@-dirtscale@:* Dirtmapping scaling factor
 103 * *@-dirty@:* Enable dirtmapping
 104 * *@-dump@:* Dump radiosity from @-bounce@ into numbered MAP file prefabs
 105 * *@-export@:* Export lightmaps when compile finished (like @-export@ mode)
 106 * *@-exposure@ F:* Lightmap exposure to better support overbright spots
 107 * *@-external@:* Force external lightmaps even if at size of internal lightmaps
 108 * *@-extravisnudge@:* Broken feature to nudge the luxel origin to a better vis cluster
 109 * *@-extrawide@:* Deprecated alias for @-super 2 -filter@
 110 * *@-extra@:* Deprecated alias for @-super 2@
 111 * *@-fastbounce@:* Use @-fast@ style lighting for radiosity
 112 * *@-faster@:* Use a faster falloff curve for lighting; also implies @-fast@
 113 * *@-fastgrid@:* Use @-fast@ style lighting for the light grid
 114 * *@-fast@:* Ignore tiny light contributions
 115 * *@-filter@:* Lightmap filtering
 116 * *@-floodlight@:* Enable floodlight (zero-effort somewhat decent lighting)
 117 * *@-gamma@ F:* Lightmap gamma
 118 * *@-gridambientscale@ F:* Scaling factor for the light grid ambient components only
 119 * *@-gridscale@ F:* Scaling factor for the light grid only
 120 * *@-keeplights@:* Keep light entities in the BSP file after compile
 121 * *@-lightmapdir@ directory:* Directory to store external lightmaps (default: same as map name without extension)
 122 * *@-lightmapsize@ N:* Size of lightmaps to generate (must be a power of two)
 123 * *@-lomem@:* Low memory but slower lighting mode
 124 * *@-lowquality@:* Low quality floodlight (appears to currently break floodlight)
 125 * *@-minsamplesize@ N:* Sets minimum lightmap resolution in luxels/qu
 126 * *@-nocollapse@:* Do not collapse identical lightmaps
 127 * *@-nodeluxe@, @-nodeluxemap@:* Disable deluxemapping
 128 * *@-nogrid@:* Disable grid light calculation (makes all entities fullbright)
 129 * *@-nolightmapsearch@:* Do not optimize lightmap packing for GPU memory usage (as doing so costs fps)
 130 * *@-normalmap@:* Color the lightmaps according to the direction of the surface normal (TODO is this identical to @-debugnormals@?)
 131 * *@-nostyle@, @-nostyles@:* Disable support for light styles
 132 * *@-nosurf@:* Disable tracing against surfaces (only uses BSP nodes then)
 133 * *@-notrace@:* Disable shadow occlusion
 134 * *@-novertex@:* Disable vertex lighting
 135 * *@-patchshadows@:* Cast shadows from patches
 136 * *@-pointscale@ F, @-point@ F:* Scaling factor for point lights (light entities)
 137 * *@-q3@:* Use nonlinear falloff curve by default (like Q3A)
 138 * *@-samplescale@ F:* Scales all lightmap resolutions
 139 * *@-samplesize@ N:* Sets default lightmap resolution in luxels/qu
 140 * *@-samples@ N:* Adaptive supersampling quality
 141 * *@-scale@ F:* Scaling factor for all light types
 142 * *@-shadeangle@ A:* Angle for phong shading
 143 * *@-shade@:* Enable phong shading at default shade angle
 144 * *@-skyscale@ F, @-sky@ F:* Scaling factor for sky and sun light
 145 * *@-smooth@:* Deprecated alias for @-samples 2@
 146 * *@-style@, @-styles@:* Enable support for light styles
 147 * *@-sunonly@:* Only compute sun light
 148 * *@-super@ N, @-supersample@ N:* Ordered grid supersampling quality
 149 * *@-thresh@ F:* Triangle subdivision threshold
 150 * *@-trianglecheck@:* Broken check that should ensure luxels apply to the right triangle
 151 * *@-trisoup@:* Convert brush faces to triangle soup
 152 * *@-wolf@:* Use linear falloff curve by default (like W:ET)
 153
 154 h2. Analyzing BSP-like file structure
 155
 156 * *@-analyze@ ... filename.bsp:* Switch that enters this mode
 157 * *@-lumpswap@:* Swap byte order in the lumps
 158
 159 h2. Converting & Decompiling
 160
 161 * *@-convert@ ... filename.bsp:* Switch that enters this mode
 162 * *@-de@ number:* Distance epsilon for the conversion
 163 * *@-format@ converter:* Select the converter (available: map, ase, or game names)
 164 * *@-ne@ F:* Normal epsilon for the conversion
 165 * *@-shadersasbitmap@:* (only for ase) use the shader names as *BITMAP key so they work as prefabs
 166
 167 h2. Exporting lightmaps
 168
 169 * *@-export@ filename.bsp:* Copies lightmaps from the BSP to filename/lightmap_0000.tga ff
 170
 171 h2. Fixing AAS checksum
 172
 173 * *@-fixaas@ filename.bsp:* Switch that enters this mode
 174
 175 h2. Get info about BSP file
 176
 177 * *@-info@ filename.bsp:* Switch that enters this mode
 178
 179 h2. Importing lightmaps
 180
 181 * *@-import@ filename.bsp:* Copies lightmaps from filename/lightmap_0000.tga ff into the BSP
 182
 183 h2. MiniMap
 184
 185 * *@-minimap@ ... filename.bsp:* Creates a minimap of the BSP, by default writes to @../gfx/filename_mini.tga@
 186 * *@-black@:* Write the minimap as a black-on-transparency RGBA32 image
 187 * *@-boost@ F:* Sets the contrast boost value (higher values make a brighter image); contrast boost is somewhat similar to gamma, but continuous even at zero
 188 * *@-border@ F:* Sets the amount of border pixels relative to the total image size
 189 * *@-gray@:* Write the minimap as a white-on-black GRAY8 image
 190 * *@-keepaspect@:* Ensure the aspect ratio is kept (the minimap is then letterboxed to keep aspect)
 191 * *@-minmax@ xmin ymin zmin xmax ymax zmax:* Forces specific map dimensions (note: the minimap actually uses these dimensions, scaled to the target size while keeping aspect with centering, and 1/64 of border appended to all sides)
 192 * *@-nokeepaspect@:* Do not ensure the aspect ratio is kept (makes it easier to use the image in your code, but looks bad together with sharpening)
 193 * *@-o@ filename.tga:* Sets the output file name
 194 * *@-random@ N:* Sets the randomized supersampling count (cannot be combined with @-samples@)
 195 * *@-samples@ N:* Sets the ordered supersampling count (cannot be combined with @-random@)
 196 * *@-sharpen@ F:* Sets the sharpening coefficient
 197 * *@-size@ N:* Sets the width and height of the output image
 198 * *@-white@:* Write the minimap as a white-on-transparency RGBA32 image
 199
 200 h2. Scaling
 201
 202 * *@-scale@ S filename.bsp:* Scale uniformly
 203 * *@-scale@ SX SY SZ filename.bsp:* Scale non-uniformly
 204 * *@-scale -tex@ S filename.bsp:* Scale uniformly without texture lock
 205 * *@-scale -tex@ SX SY SZ filename.bsp:* Scale non-uniformly without texture lock