Document and clean up platform/platform_default.cfg

platform/platform_default.cfg

@@ -1,99 +1,153 @@
+// This file is not meant to be edited.
+// It sets defaults to wrangle the engine into
+// acting more useful towards our goals and agenda
+// You can find Nuclide specific cvars in `cvars.cfg`
+
+// default console font size is 12 pixels, negative values specifies explicit size
 seta con_textsize -12
+// console background should be opaque so we can read it properly
 seta scr_conalpha 1
+// idlefps 0 means we will match cl_maxfps
 seta cl_idlefps 0
+// forces CSQC to take the pvs of an entity into account on its end
 seta r_ignoreentpvs 0
-seta allow_download_packages 0
+// required for spray logos
 seta _pext_infoblobs 1
+// required for speedy patch/curve collision
 seta _q3bsp_bihtraces 1
+// required for some custom prop entities
 seta sv_gameplayfix_setmodelsize_qw 1
+// required so that Quake does not round to the nearest hull or whatever
 seta sv_gameplayfix_setmodelrealbox 1
+// load console font in HL format
 seta gl_font 0
 seta gl_font CONCHARS?fmt=h
-
+// sensible texture filtering default
 seta gl_texturemode GL_LINEAR_MIPMAP_LINEAR
+// sensible mipcap default
 seta d_mipcap 0 1000
-
-// no limitations
+// sensible texture max size
 seta gl_max_size 8192
-
-// make sure those gl vars are set to a minimal setting
+// no affine texture projection on models by default
 seta gl_affinemodels 0
+// don't blend sprites by default
 seta gl_blendsprites 0
+// no flashblend by default
 seta gl_flashblend 0
+// we assume overbright 2 for best dynamic range
 seta gl_overbright 2
+// we assume highest texture quality
 seta gl_picmip 0
+// allow overlays like cshifts
 seta gl_polyblend 1
-seta gl_specular 0
-seta gl_texture_anisotropic_filtering 0
+// allow specular...
+seta gl_specular 1
+// but the engine forces a fallback, which is applied on everything, kill that
+seta gl_specular_fallback 0
+// set kernel dithering for defaultwall/defaultskin to 0
 seta gl_kdither 0
+// cull models out of the view to avoid e.g. shotgun shell clipping in HL
 seta gl_mindist 4
-
-// interpolation
+// allow interpolation of entities
 seta cl_nolerp 0
+// allow interpolation between framegroups
 seta r_noframegrouplerp 0
+// allow interpolation between frames
 seta r_nolerp 0
-
-// lighting
+// not what you think this means, turning this to 1 disables diffusemap rendering
 seta r_lightmap 0
+// we want hdr quality lightmaps by default
 seta r_lightmap_format e5bgr9
+// we want vanilla lightmap saturation by default
 seta r_lightmap_saturation 1
+// allow models to respect light direction
 seta r_nolightdir 0
+// respect colored lighting files
 seta r_loadlit 1
-
-// FBO settings
+// FBO setting, render 1:1 framebuffer to our window
 seta r_renderscale 1
-
-// glsl trickery
+// disable offset/parallax mapping
 seta r_glsl_offsetmapping 0
+// disable softwarebanding
 seta r_softwarebanding 0
+// disable any possible overlay we might have
 seta r_postprocshader ""
+// disable low dynamic range light clamping
 seta gl_ldr 0
-
-// colormap related
+// allow fullbright colors on brush models
 seta r_fb_bmodels 1
+// allow fullbright colors on models
 seta r_fb_models 1
-
 // shadows
 seta r_shadows 1
 seta r_shadow_realtime_dlight 1
 seta r_shadow_realtime_dlight_shadows 1
 seta r_shadow_realtime_world 1
-
-// rest of the video gang
+// disable bloom
 seta r_bloom 0
+// disable engine coronas
 seta r_coronas 0
+// enable deluxe mapping on maps that support it
 seta r_deluxemapping 1
+// allow static entities like flames
 seta r_drawflame 1
+// don't render the world flat shaded
 seta r_drawflat 0
+// allow dlights, colored ones at that (2 forces all to be monochrome like Q1)
 seta r_dynamic 1
+// full quality sky setting
 seta r_fastsky 0
+// classic liquid style rendering
 seta r_lavastyle 1
-seta r_stains 0
 seta r_waterstyle 1
+seta r_slimestyle 1
+seta r_telestyle 1
+// disable stain mapping
+seta r_stains 0
+// enable the waterwarp shader
 seta r_waterwarp 1
-seta "r_particledesc" "default"
+// allow scripted particles
+seta r_particledesc "default"
+// control gamma via glsl when in windowed mode
 seta vid_hardwaregamma 1
-seta "cl_cursor_scale" "1"
-seta "cl_bob" "0"
-seta "maxpitch" "89"
-seta "minpitch" "-89"
-seta "r_meshpitch" "1"
-seta "v_bob" "0.01"
-seta "v_bobcycle" "0.8"
-seta "v_bobup" "0.5"
-seta "v_contentblend" "0"
-
-// Misc defaults
-seta "cfg_save_auto" "1"
-seta "cl_idlefps" "60"
-seta "cl_maxfps" "250"
-seta "com_nogamedirnativecode" "0"
-seta "con_logcenterprint" "0"
-seta "con_notifylines" "0"
-seta "lang" "en_us"
-seta "r_imageextensions" "tga bmp pcx png jpg"
-seta "scr_sshot_type" "tga"
-seta "media_repeat "0"
+// because the defaul cursor scale is not 1 apparently
+seta cl_cursor_scale "1"
+// disable any extra bob the engine may have.
+seta cl_bob "0"
+// allow people to look up almost all the way
+seta maxpitch "89"
+// ditto, but for downwards viewing
+seta minpitch "-89"
+// this fixes model pitches, otherwise all of our angle math would need *= -1 on x
+seta r_meshpitch "1"
+// default bob values for Nuclide
+seta v_bob "0.01"
+seta v_bobcycle "0.8"
+seta v_bobup "0.5"
+// disable engine side content blends, let the client-game handle it
+seta v_contentblend "0"
+// people hate having to manually save configs
+seta cfg_save_auto "1"
+// menu doesn't need to operate at more than 60 fps
+seta cl_idlefps "60"
+// game shouldn't need to run at more than 250 fps right now
+seta cl_maxfps "250"
+// allow native code if it's there I guess
+seta com_nogamedirnativecode "0"
+// don't log centerprints
+seta con_logcenterprint "0"
+// don't display regular prints in the top corner
+seta con_notifylines "0"
+// set a default locale, because the engine won't
+seta lang "en_us"
+// external texture formats that we recognize
+seta r_imageextensions "tga bmp pcx png jpg"
+// store screenshots in TrueVision Targa by default
+seta scr_sshot_type "tga"
+// don't force music loops
+seta media_repeat "0"
 
+// set master servers
 exec masters.lst
+// load in Nuclide specific cvars
 exec cvars.cfg