1 /* -------------------------------------------------------------------------------
3 Copyright (C) 1999-2007 id Software, Inc. and contributors.
4 For a list of contributors, see the accompanying CONTRIBUTORS file.
6 This file is part of GtkRadiant.
8 GtkRadiant is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 GtkRadiant is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GtkRadiant; if not, write to the Free Software
20 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 -------------------------------------------------------------------------------
24 This code has been altered significantly from its original form, to support
25 several games based on the Quake III Arena engine, in the form of "Q3Map2."
27 ------------------------------------------------------------------------------- */
39 const char* description;
42 void HelpOptions(const char* group_name, int indentation, int width, struct HelpOption* options, int count)
45 char* indent = malloc(indentation+1);
46 memset(indent, ' ', indentation);
47 indent[indentation] = 0;
48 printf("%s%s:\n", indent, group_name);
50 indent = realloc(indent, indentation+1);
51 memset(indent, ' ', indentation);
52 indent[indentation] = 0;
55 for ( i = 0; i < count; i++ )
57 int printed = printf("%s%-24s ", indent, options[i].name);
58 int descsz = strlen(options[i].description);
60 while ( j < descsz && descsz-j > width - printed )
63 printf("%s%26c",indent,' ');
64 int fragment = width - printed;
65 while ( fragment > 0 && options[i].description[j+fragment-1] != ' ')
67 j += fwrite(options[i].description+j, sizeof(char), fragment, stdout);
69 printed = indentation+26;
73 printf("%s\n",options[i].description+j);
75 else if ( j < descsz )
77 printf("%s%26c%s\n",indent,' ',options[i].description+j);
88 struct HelpOption bsp[] = {
89 {"-bsp <filename.map>", "Switch that enters this stage"},
90 {"-altsplit", "Alternate BSP tree splitting weights (should give more fps)"},
91 {"-bspfile <filename.bsp>", "BSP file to write"},
92 {"-celshader <shadername>", "Sets a global cel shader name"},
93 {"-custinfoparms", "Read scripts/custinfoparms.txt"},
94 {"-debuginset", "Push all triangle vertexes towards the triangle center"},
95 {"-debugportals", "Make BSP portals visible in the map"},
96 {"-debugsurfaces", "Color the vertexes according to the index of the surface"},
97 {"-deep", "Use detail brushes in the BSP tree, but at lowest priority (should give more fps)"},
98 {"-de <F>", "Distance epsilon for plane snapping etc."},
99 {"-fakemap", "Write fakemap.map containing all world brushes"},
100 {"-flares", "Turn on support for flares (TEST?)"},
101 {"-flat", "Enable flat shading (good for combining with -celshader)"},
102 {"-fulldetail", "Treat detail brushes as structural ones"},
103 {"-leaktest", "Abort if a leak was found"},
104 {"-linfile <filename.lin>", "Line file to write"},
105 {"-meta", "Combine adjacent triangles of the same texture to surfaces (ALWAYS USE THIS)"},
106 {"-minsamplesize <N>", "Sets minimum lightmap resolution in luxels/qu"},
107 {"-mi <N>", "Sets the maximum number of indexes per surface"},
108 {"-mv <N>", "Sets the maximum number of vertices of a lightmapped surface"},
109 {"-ne <F>", "Normal epsilon for plane snapping etc."},
110 {"-nocurves", "Turn off support for patches"},
111 {"-nodetail", "Leave out detail brushes"},
112 {"-noflares", "Turn off support for flares"},
113 {"-nofog", "Turn off support for fog volumes"},
114 {"-nohint", "Turn off support for hint brushes"},
115 {"-nosubdivide", "Turn off support for `q3map_tessSize` (breaks water vertex deforms)"},
116 {"-notjunc", "Do not fix T-junctions (causes cracks between triangles, do not use)"},
117 {"-nowater", "Turn off support for water, slime or lava (Stef, this is for you)"},
118 {"-np <A>", "Force all surfaces to be nonplanar with a given shade angle"},
119 {"-onlyents", "Only update entities in the BSP"},
120 {"-patchmeta", "Turn patches into triangle meshes for display"},
121 {"-prtfile <filename.prt>", "Portal file to write"},
122 {"-rename", "Append suffix to miscmodel shaders (needed for SoF2)"},
123 {"-samplesize <N>", "Sets default lightmap resolution in luxels/qu"},
124 {"-skyfix", "Turn sky box into six surfaces to work around ATI problems"},
125 {"-snap <N>", "Snap brush bevel planes to the given number of units"},
126 {"-srffile <filename.srf>", "Surface file to write"},
127 {"-tempname <filename.map>", "Read the MAP file from the given file name"},
128 {"-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"},
129 {"-tmpout", "Write the BSP file to /tmp"},
130 {"-verboseentities", "Enable `-v` only for map entities, not for the world"},
132 HelpOptions("BSP Stage", 0, 80, bsp, sizeof(bsp)/sizeof(struct HelpOption));
137 struct HelpOption vis[] = {
138 {"-vis <filename.map>", "Switch that enters this stage"},
139 {"-fast", "Very fast and crude vis calculation"},
140 {"-hint", "Merge all but hint portals"},
141 {"-mergeportals", "The less crude half of `-merge`, makes vis sometimes much faster but doesn't hurt fps usually"},
142 {"-merge", "Faster but still okay vis calculation"},
143 {"-nopassage", "Just use PortalFlow vis (usually less fps)"},
144 {"-nosort", "Do not sort the portals before calculating vis (usually slower)"},
145 {"-passageOnly", "Just use PassageFlow vis (usually less fps)"},
146 {"-prtfile <filename.prt>", "Portal file to read"},
147 {"-saveprt", "Keep the Portal file after running vis (so you can run vis again)"},
148 {"-tmpin", "Use /tmp folder for input"},
149 {"-tmpout", "Use /tmp folder for output"},
151 HelpOptions("VIS Stage", 0, 80, vis, sizeof(vis)/sizeof(struct HelpOption));
156 struct HelpOption light[] = {
157 {"-light <filename.map>", "Switch that enters this stage"},
158 {"-vlight <filename.map>", "Deprecated alias for `-light -fast` ... filename.map"},
159 {"-approx <N>", "Vertex light approximation tolerance (never use in conjunction with deluxemapping)"},
160 {"-areascale <F, `-area` F>", "Scaling factor for area lights (surfacelight)"},
161 {"-border", "Add a red border to lightmaps for debugging"},
162 {"-bouncegrid", "Also compute radiosity on the light grid"},
163 {"-bounceonly", "Only compute radiosity"},
164 {"-bouncescale <F>", "Scaling factor for radiosity"},
165 {"-bounce <N>", "Number of bounces for radiosity"},
166 {"-bspfile <filename.bsp>", "BSP file to write"},
167 {"-cheapgrid", "Use `-cheap` style lighting for radiosity"},
168 {"-cheap", "Abort vertex light calculations when white is reached"},
169 {"-compensate <F>", "Lightmap compensate (darkening factor applied after everything else)"},
170 {"-cpma", "CPMA vertex lighting mode"},
171 {"-custinfoparms", "Read scripts/custinfoparms.txt"},
172 {"-dark", "Darken lightmap seams"},
173 {"-debugaxis", "Color the lightmaps according to the lightmap axis"},
174 {"-debugcluster", "Color the lightmaps according to the index of the cluster"},
175 {"-debugdeluxe", "Show deluxemaps on the lightmap"},
176 {"-debugnormals", "Color the lightmaps according to the direction of the surface normal"},
177 {"-debugorigin", "Color the lightmaps according to the origin of the luxels"},
178 {"-debugsurfaces, -debugsurface", "Color the lightmaps according to the index of the surface"},
179 {"-debugunused", "This option does nothing"},
180 {"-debug", "Mark the lightmaps according to the cluster: unmapped clusters get yellow, occluded ones get pink, flooded ones get blue overlay color, otherwise red"},
181 {"-deluxemode 0", "Use modelspace deluxemaps (DarkPlaces)"},
182 {"-deluxemode 1", "Use tangentspace deluxemaps"},
183 {"-deluxe, -deluxemap", "Enable deluxemapping (light direction maps)"},
184 {"-dirtdebug, -debugdirt", "Store the dirtmaps as lightmaps for debugging"},
185 {"-dirtdepth", "Dirtmapping depth"},
186 {"-dirtgain", "Dirtmapping exponent"},
187 {"-dirtmode 0", "Ordered direction dirtmapping"},
188 {"-dirtmode 1", "Randomized direction dirtmapping"},
189 {"-dirtscale", "Dirtmapping scaling factor"},
190 {"-dirty", "Enable dirtmapping"},
191 {"-dump", "Dump radiosity from `-bounce` into numbered MAP file prefabs"},
192 {"-export", "Export lightmaps when compile finished (like `-export` mode)"},
193 {"-exposure <F>", "Lightmap exposure to better support overbright spots"},
194 {"-external", "Force external lightmaps even if at size of internal lightmaps"},
195 {"-extravisnudge", "Broken feature to nudge the luxel origin to a better vis cluster"},
196 {"-extrawide", "Deprecated alias for `-super 2 -filter`"},
197 {"-extra", "Deprecated alias for `-super 2`"},
198 {"-fastallocate", "Use `-fastallocate` to trade lightmap size against allocation time (useful with hi res lightmaps on large maps: reduce allocation time from days to minutes for only some extra bytes)"},
199 {"-fastbounce", "Use `-fast` style lighting for radiosity"},
200 {"-faster", "Use a faster falloff curve for lighting; also implies `-fast`"},
201 {"-fastgrid", "Use `-fast` style lighting for the light grid"},
202 {"-fast", "Ignore tiny light contributions"},
203 {"-filter", "Lightmap filtering"},
204 {"-floodlight", "Enable floodlight (zero-effort somewhat decent lighting)"},
205 {"-gamma <F>", "Lightmap gamma"},
206 {"-gridambientscale <F>", "Scaling factor for the light grid ambient components only"},
207 {"-gridscale <F>", "Scaling factor for the light grid only"},
208 {"-keeplights", "Keep light entities in the BSP file after compile"},
209 {"-lightmapdir <directory>", "Directory to store external lightmaps (default: same as map name without extension)"},
210 {"-lightmapsearchblocksize <N>", "Restrict lightmap search to block size <N>"},
211 {"-lightmapsearchpower <N>", "Optimize for lightmap merge power <N>"},
212 {"-lightmapsize <N>", "Size of lightmaps to generate (must be a power of two)"},
213 {"-lightsubdiv <N>", "Size of light emitting shader subdivision"},
214 {"-lomem", "Low memory but slower lighting mode"},
215 {"-lowquality", "Low quality floodlight (appears to currently break floodlight)"},
216 {"-minsamplesize <N>", "Sets minimum lightmap resolution in luxels/qu"},
217 {"-nocollapse", "Do not collapse identical lightmaps"},
218 {"-nodeluxe, -nodeluxemap", "Disable deluxemapping"},
219 {"-nogrid", "Disable grid light calculation (makes all entities fullbright)"},
220 {"-nolightmapsearch", "Do not optimize lightmap packing for GPU memory usage (as doing so costs fps)"},
221 {"-normalmap", "Color the lightmaps according to the direction of the surface normal (TODO is this identical to `-debugnormals`?)"},
222 {"-nostyle, -nostyles", "Disable support for light styles"},
223 {"-nosurf", "Disable tracing against surfaces (only uses BSP nodes then)"},
224 {"-notrace", "Disable shadow occlusion"},
225 {"-novertex", "Disable vertex lighting"},
226 {"-patchshadows", "Cast shadows from patches"},
227 {"-pointscale <F, `-point` F>", "Scaling factor for point lights (light entities)"},
228 {"-q3", "Use nonlinear falloff curve by default (like Q3A)"},
229 {"-samplescale <F>", "Scales all lightmap resolutions"},
230 {"-samplesize <N>", "Sets default lightmap resolution in luxels/qu"},
231 {"-samples <N>", "Adaptive supersampling quality"},
232 {"-scale <F>", "Scaling factor for all light types"},
233 {"-shadeangle <A>", "Angle for phong shading"},
234 {"-shade", "Enable phong shading at default shade angle"},
235 {"-skyscale <F, `-sky` F>", "Scaling factor for sky and sun light"},
236 {"-smooth", "Deprecated alias for `-samples 2`"},
237 {"-srffile <filename.srf>", "Surface file to read"},
238 {"-style, -styles", "Enable support for light styles"},
239 {"-sunonly", "Only compute sun light"},
240 {"-super <N, `-supersample` N>", "Ordered grid supersampling quality"},
241 {"-thresh <F>", "Triangle subdivision threshold"},
242 {"-trianglecheck", "Broken check that should ensure luxels apply to the right triangle"},
243 {"-trisoup", "Convert brush faces to triangle soup"},
244 {"-wolf", "Use linear falloff curve by default (like W:ET)"},
247 HelpOptions("Light Stage", 0, 80, light, sizeof(light)/sizeof(struct HelpOption));
252 struct HelpOption analyze[] = {
253 {"-analyze <filename.bsp>", "Switch that enters this mode"},
254 {"-lumpswap", "Swap byte order in the lumps"},
257 HelpOptions("Analyzing BSP-like file structure", 0, 80, analyze, sizeof(analyze)/sizeof(struct HelpOption));
262 struct HelpOption scale[] = {
263 {"-scale <S filename.bsp>", "Scale uniformly"},
264 {"-scale <SX SY SZ filename.bsp>", "Scale non-uniformly"},
265 {"-scale -tex <S filename.bsp>", "Scale uniformly without texture lock"},
266 {"-scale -tex <SX SY SZ filename.bsp>", "Scale non-uniformly without texture lock"},
268 HelpOptions("Scaling", 0, 80, scale, sizeof(scale)/sizeof(struct HelpOption));
273 struct HelpOption convert[] = {
274 {"-convert <filename.bsp>", "Switch that enters this mode"},
275 {"-de <number>", "Distance epsilon for the conversion"},
276 {"-format <converter>", "Select the converter (available: map, ase, or game names)"},
277 {"-ne <F>", "Normal epsilon for the conversion"},
278 {"-shadersasbitmap", "(only for ase) use the shader names as \\*BITMAP key so they work as prefabs"},
281 HelpOptions("Converting & Decompiling", 0, 80, convert, sizeof(convert)/sizeof(struct HelpOption));
286 struct HelpOption exportl[] = {
287 {"-export <filename.bsp>", "Copies lightmaps from the BSP to `filename/lightmap_0000.tga` ff"}
290 HelpOptions("Exporting lightmaps", 0, 80, exportl, sizeof(exportl)/sizeof(struct HelpOption));
293 void HelpExportEnts()
295 struct HelpOption exportents[] = {
296 {"-exportents <filename.bsp>", "Exports the entities to a text file (.ent)"},
298 HelpOptions("ExportEnts Stage", 0, 80, exportents, sizeof(exportents)/sizeof(struct HelpOption));
303 struct HelpOption fixaas[] = {
304 {"-fixaas <filename.bsp>", "Switch that enters this mode"},
307 HelpOptions("Fixing AAS checksum", 0, 80, fixaas, sizeof(fixaas)/sizeof(struct HelpOption));
312 struct HelpOption info[] = {
313 {"-info <filename.bsp>", "Switch that enters this mode"},
316 HelpOptions("Get info about BSP file", 0, 80, info, sizeof(info)/sizeof(struct HelpOption));
321 struct HelpOption import[] = {
322 {"-import <filename.bsp>", "Copies lightmaps from `filename/lightmap_0000.tga` ff into the BSP"},
325 HelpOptions("Importing lightmaps", 0, 80, import, sizeof(import)/sizeof(struct HelpOption));
330 struct HelpOption minimap[] = {
331 {"-minimap <filename.bsp>", "Creates a minimap of the BSP, by default writes to `../gfx/filename_mini.tga`"},
332 {"-black", "Write the minimap as a black-on-transparency RGBA32 image"},
333 {"-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"},
334 {"-border <F>", "Sets the amount of border pixels relative to the total image size"},
335 {"-gray", "Write the minimap as a white-on-black GRAY8 image"},
336 {"-keepaspect", "Ensure the aspect ratio is kept (the minimap is then letterboxed to keep aspect)"},
337 {"-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)"},
338 {"-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)"},
339 {"-o <filename.tga>", "Sets the output file name"},
340 {"-random <N>", "Sets the randomized supersampling count (cannot be combined with `-samples`)"},
341 {"-samples <N>", "Sets the ordered supersampling count (cannot be combined with `-random`)"},
342 {"-sharpen <F>", "Sets the sharpening coefficient"},
343 {"-size <N>", "Sets the width and height of the output image"},
344 {"-white", "Write the minimap as a white-on-transparency RGBA32 image"},
347 HelpOptions("MiniMap", 0, 80, minimap, sizeof(minimap)/sizeof(struct HelpOption));
352 struct HelpOption common[] = {
353 {"-connect <address>", "Talk to a NetRadiant instance using a specific XML based protocol"},
354 {"-force", "Allow reading some broken/unsupported BSP files e.g. when decompiling, may also crash"},
355 {"-fs_basepath <path>", "Sets the given path as main directory of the game (can be used more than once to look in multiple paths)"},
356 {"-fs_game <gamename>", "Sets a different game directory name (default for Q3A: baseq3, can be used more than once)"},
357 {"-fs_homebase <dir>", "Specifies where the user home directory name is on Linux (default for Q3A: .q3a)"},
358 {"-fs_homepath <path>", "Sets the given path as home directory name"},
359 {"-fs_nobasepath", "Do not load base paths in VFS, imply -fs_nomagicpath"},
360 {"-fs_nomagicpath", "Do not try to guess base path magically"},
361 {"-fs_nohomepath", "Do not load home path in VFS"},
362 {"-fs_pakpath <path>", "Specify a package directory (can be used more than once to look in multiple paths)"},
363 {"-game <gamename>", "Load settings for the given game (default: quake3)"},
364 {"-subdivisions <F>", "multiplier for patch subdivisions quality"},
365 {"-threads <N>", "number of threads to use"},
366 {"-v", "Verbose mode"},
367 {"-werror", "Make all warnings into errors"}
370 HelpOptions("Common Options", 0, 80, common, sizeof(common)/sizeof(struct HelpOption));
374 void HelpMain(const char* arg)
376 printf("Usage: q3map2 [stage] [common options...] [stage options...] [stage source file]\n");
377 printf(" q3map2 -help [stage]\n\n");
381 struct HelpOption stages[] = {
382 {"-bsp", "BSP Stage"},
383 {"-vis", "VIS Stage"},
384 {"-light", "Light Stage"},
385 {"-analyze", "Analyzing BSP-like file structure"},
386 {"-scale", "Scaling"},
387 {"-convert", "Converting & Decompiling"},
388 {"-export", "Exporting lightmaps"},
389 {"-exportents", "Exporting entities"},
390 {"-fixaas", "Fixing AAS checksum"},
391 {"-info", "Get info about BSP file"},
392 {"-import", "Importing lightmaps"},
393 {"-minimap", "MiniMap"},
395 void(*help_funcs[])() = {
410 if ( arg && strlen(arg) > 0 )
416 for ( i = 0; i < sizeof(stages)/sizeof(struct HelpOption); i++ )
417 if ( strcmp(arg, stages[i].name+1) == 0 )
424 HelpOptions("Stages", 0, 80, stages, sizeof(stages)/sizeof(struct HelpOption));