]> git.xonotic.org Git - xonotic/netradiant.git/blobdiff - tools/quake3/q3map2/help.c
Merge branch 'master' into master-merge
[xonotic/netradiant.git] / tools / quake3 / q3map2 / help.c
index 5f5664d79e57f45196fbeb2ca751aa8c998970c4..a1fb1eaf45d517f67d58e6ba654948caa5ddac7f 100644 (file)
 /* dependencies */
 #include "q3map2.h"
 
+#if GDEF_OS_POSIX
+#include <sys/ioctl.h>
+#endif // GDEF_OS_POSIX
 
+static unsigned terminalColumns = 80;
 
 struct HelpOption
 {
@@ -39,6 +43,7 @@ struct HelpOption
        const char* description;
 };
 
+// FIXME: low column width cause an endless loop
 void HelpOptions(const char* group_name, int indentation, int width, struct HelpOption* options, int count)
 {
        indentation *= 2;
@@ -145,7 +150,7 @@ void HelpBsp()
                {"-verboseentities", "Enable `-v` only for map entities, not for the world"},
        };
 
-       HelpOptions("BSP Stage", 0, 80, bsp, sizeof(bsp)/sizeof(struct HelpOption));
+       HelpOptions("BSP Stage", 0, terminalColumns, bsp, sizeof(bsp)/sizeof(struct HelpOption));
 }
 
 void HelpVis()
@@ -166,7 +171,7 @@ void HelpVis()
                {"-v -v", "Extra verbose mode for cluster debug"}, // q3map2 common takes first -v
        };
 
-       HelpOptions("VIS Stage", 0, 80, vis, sizeof(vis)/sizeof(struct HelpOption));
+       HelpOptions("VIS Stage", 0, terminalColumns, vis, sizeof(vis)/sizeof(struct HelpOption));
 }
 
 void HelpLight()
@@ -210,18 +215,20 @@ void HelpLight()
                {"-export", "Export lightmaps when compile finished (like `-export` mode)"},
                {"-exposure <F>", "Lightmap exposure to better support overbright spots"},
                {"-external", "Force external lightmaps even if at size of internal lightmaps"},
+               {"-externalnames", "Write lightstyle shader using external lightmap names"},
                {"-extradist <F>", "Extra distance for lights in map units"},
                {"-extravisnudge", "Broken feature to nudge the luxel origin to a better vis cluster"},
                {"-extrawide", "Deprecated alias for `-super 2 -filter`"},
                {"-extra", "Deprecated alias for `-super 2`"},
                {"-fastallocate",  "Trade lightmap size against packing time (useful with hi res lightmaps on large maps: reduce allocation time from days to minutes for only some extra bytes)"},
+               {"-slowallocate", "Use old (a bit more careful, but much slower) lightmaps packing algorithm (default)"},
                {"-fastbounce", "Use `-fast` style lighting for radiosity"},
                {"-faster", "Use a faster falloff curve for lighting; also implies `-fast`"},
                {"-fastgrid", "Use `-fast` style lighting for the light grid"},
                {"-fastlightmapsearch", "Deprecated alias for `-fastallocate`"},
                {"-fast", "Ignore tiny light contributions"},
                {"-fill", "Fill lightmap colors from surrounding pixels to improve JPEG compression"},
-               {"-filter", "Lightmap filtering"},
+               {"-filter", "Lightmap filtering, doesn't play nice with some other effects, don't use it, use `-samples` instead"},
                {"-floodlight", "Enable floodlight (zero-effort somewhat decent lighting)"},
                {"-gamma <F>", "Lightmap gamma"},
                {"-gridambientdirectionality <F>", "Ambient directional lighting received (default: 0.0)"},
@@ -277,14 +284,14 @@ void HelpLight()
                {"-sRGBtex", "Treat textures as sRGB colorspace"},
                {"-style, -styles", "Enable support for light styles"},
                {"-sunonly", "Only compute sun light"},
-               {"-super <N, `-supersample` N>", "Ordered grid supersampling quality"},
+               {"-super <N, `-supersample` N>", "Ordered grid supersampling quality, much slower than `-samples`"},
                {"-thresh <F>", "Triangle subdivision threshold"},
                {"-trianglecheck", "Broken check that should ensure luxels apply to the right triangle"},
                {"-trisoup", "Convert brush faces to triangle soup"},
                {"-wolf", "Use linear falloff curve by default (like W:ET)"},
        };
 
-       HelpOptions("Light Stage", 0, 80, light, sizeof(light)/sizeof(struct HelpOption));
+       HelpOptions("Light Stage", 0, terminalColumns, light, sizeof(light)/sizeof(struct HelpOption));
 }
 
 void HelpAnalyze()
@@ -294,7 +301,7 @@ void HelpAnalyze()
                {"-lumpswap", "Swap byte order in the lumps"},
        };
 
-       HelpOptions("Analyzing BSP-like file structure", 0, 80, analyze, sizeof(analyze)/sizeof(struct HelpOption));
+       HelpOptions("Analyzing BSP-like file structure", 0, terminalColumns, analyze, sizeof(analyze)/sizeof(struct HelpOption));
 }
 
 void HelpScale()
@@ -306,7 +313,7 @@ void HelpScale()
                {"-spawn_ref <F>", "Vertical offset for info_player_* entities (adds spawn_ref, scales, subtracts spawn_ref)"},
        };
 
-       HelpOptions("Scaling", 0, 80, scale, sizeof(scale)/sizeof(struct HelpOption));
+       HelpOptions("Scaling", 0, terminalColumns, scale, sizeof(scale)/sizeof(struct HelpOption));
 }
 
 void HelpConvert()
@@ -325,16 +332,16 @@ void HelpConvert()
                {"-shadersasbitmap", "Save shader names as bitmap names in the model so it works as a prefab (only when writing ase and obj)"},
        };
 
-       HelpOptions("Converting & Decompiling", 0, 80, convert, sizeof(convert)/sizeof(struct HelpOption));
+       HelpOptions("Converting & Decompiling", 0, terminalColumns, convert, sizeof(convert)/sizeof(struct HelpOption));
 }
 
 void HelpExport()
 {
        struct HelpOption exportl[] = {
-               {"-export <filename.bsp>", "Copies lightmaps from the BSP to `filename/lightmap_0000.tga` ff"}
+               {"-export <filename.bsp>", "Copies lightmaps from the BSP to `filename/lightmap_0000.tga`"}
        };
 
-       HelpOptions("Exporting lightmaps", 0, 80, exportl, sizeof(exportl)/sizeof(struct HelpOption));
+       HelpOptions("Exporting lightmaps", 0, terminalColumns, exportl, sizeof(exportl)/sizeof(struct HelpOption));
 }
 
 void HelpExportEnts()
@@ -342,7 +349,7 @@ void HelpExportEnts()
        struct HelpOption exportents[] = {
                {"-exportents <filename.bsp>", "Exports the entities to a text file (.ent)"},
        };
-       HelpOptions("ExportEnts Stage", 0, 80, exportents, sizeof(exportents)/sizeof(struct HelpOption));
+       HelpOptions("ExportEnts Stage", 0, terminalColumns, exportents, sizeof(exportents)/sizeof(struct HelpOption));
 }
 
 void HelpFixaas()
@@ -351,7 +358,7 @@ void HelpFixaas()
                {"-fixaas <filename.bsp>", "Switch that enters this mode"},
        };
 
-       HelpOptions("Fixing AAS checksum", 0, 80, fixaas, sizeof(fixaas)/sizeof(struct HelpOption));
+       HelpOptions("Fixing AAS checksum", 0, terminalColumns, fixaas, sizeof(fixaas)/sizeof(struct HelpOption));
 }
 
 void HelpInfo()
@@ -360,7 +367,7 @@ void HelpInfo()
                {"-info <filename.bsp>", "Switch that enters this mode"},
        };
 
-       HelpOptions("Get info about BSP file", 0, 80, info, sizeof(info)/sizeof(struct HelpOption));
+       HelpOptions("Get info about BSP file", 0, terminalColumns, info, sizeof(info)/sizeof(struct HelpOption));
 }
 
 void HelpImport()
@@ -369,7 +376,7 @@ void HelpImport()
                {"-import <filename.bsp>", "Copies lightmaps from `filename/lightmap_0000.tga` ff into the BSP"},
        };
 
-       HelpOptions("Importing lightmaps", 0, 80, import, sizeof(import)/sizeof(struct HelpOption));
+       HelpOptions("Importing lightmaps", 0, terminalColumns, import, sizeof(import)/sizeof(struct HelpOption));
 }
 
 void HelpMinimap()
@@ -395,7 +402,7 @@ void HelpMinimap()
                {"-white", "Write the minimap as a white-on-transparency RGBA32 image"},
        };
 
-       HelpOptions("MiniMap", 0, 80, minimap, sizeof(minimap)/sizeof(struct HelpOption));
+       HelpOptions("MiniMap", 0, terminalColumns, minimap, sizeof(minimap)/sizeof(struct HelpOption));
 }
 
 void HelpCommon()
@@ -414,13 +421,13 @@ void HelpCommon()
                {"-fs_nohomepath", "Do not load home path in VFS"},
                {"-fs_pakpath <path>", "Specify a package directory (can be used more than once to look in multiple paths)"},
                {"-game <gamename>", "Load settings for the given game (default: quake3)"},
-               {"-subdivisions <F>", "multiplier for patch subdivisions quality"},
-               {"-threads <N>", "number of threads to use"},
+               {"-subdivisions <F>", "Multiplier for patch subdivisions quality"},
+               {"-threads <N>", "Number of threads to use"},
                {"-v", "Verbose mode"},
                {"-werror", "Make all warnings into errors"}
        };
 
-       HelpOptions("Common Options", 0, 80, common, sizeof(common)/sizeof(struct HelpOption));
+       HelpOptions("Common Options", 0, terminalColumns, common, sizeof(common)/sizeof(struct HelpOption));
 }
 
 void HelpGames()
@@ -432,7 +439,7 @@ void HelpGames()
        for ( unsigned i = 0, length = 0; games[ i ].arg != NULL; i++ )
        {
                // 3 for two whitespaces at the beginning and one (optional) comma a the end
-               if ( length + 3 + strlen( games[ i ].arg ) > 80 )
+               if ( length + 3 + strlen( games[ i ].arg ) > terminalColumns )
                {
                        printf(",\n");
                        length = 0;
@@ -458,7 +465,16 @@ void HelpGames()
 void HelpMain(const char* arg)
 {
        printf("Usage: q3map2 [stage] [common options...] [stage options...] [stage source file]\n");
-       printf("       q3map2 -help [stage]\n\n");
+       printf("       q3map2 -help [stage]\n");
+       printf("       q3map2 -help all\n\n");
+
+#if GDEF_OS_POSIX
+       struct winsize ws;
+       ioctl(STDOUT_FILENO, TIOCGWINSZ, &ws);
+       if (ws.ws_col > 60) {
+               terminalColumns = ws.ws_col;
+       }
+#endif // GDEF_OS_POSIX
 
        HelpCommon();
 
@@ -497,16 +513,30 @@ void HelpMain(const char* arg)
        if ( arg && strlen(arg) > 0 )
        {
                if ( arg[0] == '-' )
+               {
                        arg++;
+               }
 
-               unsigned i;
-               for ( i = 0; i < sizeof(stages)/sizeof(struct HelpOption); i++ )
+               if ( strcmp(arg, "all") == 0 )
+               {
+                       HelpOptions("Stages", 0, terminalColumns, stages, sizeof(stages)/sizeof(struct HelpOption));
+
+                       for ( unsigned i = 0; i < sizeof(stages)/sizeof(struct HelpOption); i++ )
+                       {
+                               help_funcs[i]();
+                       }
+                       return;
+               }
+
+               for ( unsigned i = 0; i < sizeof(stages)/sizeof(struct HelpOption); i++ )
+               {
                        if ( strcmp(arg, stages[i].name+1) == 0 )
                        {
                                help_funcs[i]();
                                return;
                        }
        }
+       }
 
-       HelpOptions("Stages", 0, 80, stages, sizeof(stages)/sizeof(struct HelpOption));
+       HelpOptions("Stages", 0, terminalColumns, stages, sizeof(stages)/sizeof(struct HelpOption));
 }