From 76a11bd74a10450bca03db90a5b4eb17bc445ce3 Mon Sep 17 00:00:00 2001 From: Bill Currie Date: Sun, 31 Dec 2000 04:46:04 +0000 Subject: [PATCH] cvar doc patches from Misty --- source/cl_cam.c | 8 ++-- source/cl_input.c | 3 +- source/cl_main.c | 13 ++---- source/cl_pred.c | 5 ++- source/cl_sys_sdl.c | 2 +- source/cl_sys_unix.c | 2 +- source/cl_sys_win.c | 2 +- source/com.c | 2 +- source/console.c | 2 +- source/cvar.c | 2 +- source/d_init.c | 6 +-- source/draw.c | 2 +- source/gl_draw.c | 14 +++--- source/gl_rmisc.c | 40 +++++++++-------- source/gl_screen.c | 26 +++++------ source/in_sdl.c | 4 +- source/in_svgalib.c | 2 +- source/in_win.c | 2 +- source/in_x11.c | 6 +-- source/joy_linux.c | 2 +- source/joy_win.c | 74 ++++++++++++++++--------------- source/model.c | 2 +- source/net_chan.c | 7 +-- source/r_main.c | 47 ++++++++++---------- source/r_view.c | 38 ++++++++-------- source/screen.c | 24 +++++----- source/snd_dma.c | 21 ++++----- source/snd_null.c | 6 +-- source/sv_ccmds.c | 2 +- source/sv_main.c | 101 ++++++++++++++++++++++++++----------------- source/sv_sys_unix.c | 5 ++- source/sv_sys_win.c | 5 ++- source/sv_user.c | 9 ++-- source/teamplay.c | 2 +- source/vid_ggi.c | 4 +- source/vid_mgl.c | 24 +++++----- source/vid_sgl.c | 2 +- source/vid_svgalib.c | 6 +-- source/vid_wgl.c | 2 +- 39 files changed, 275 insertions(+), 251 deletions(-) diff --git a/source/cl_cam.c b/source/cl_cam.c index 82781c5..830cb82 100644 --- a/source/cl_cam.c +++ b/source/cl_cam.c @@ -603,9 +603,9 @@ Cam_Reset (void) void CL_Cam_Init_Cvars (void) { - cl_hightrack = Cvar_Get ("cl_hightrack", "0", CVAR_NONE, "None"); - cl_chasecam = Cvar_Get ("cl_chasecam", "0", CVAR_NONE, "None"); + cl_hightrack = Cvar_Get ("cl_hightrack", "0", CVAR_NONE, "view the player with the highest frags while in spectator mode."); + cl_chasecam = Cvar_Get ("cl_chasecam", "0", CVAR_NONE, "get first person view of the person you are tracking in spectator mode"); cl_camera_maxpitch = - Cvar_Get ("cl_camera_maxpitch", "10", CVAR_NONE, "None"); - cl_camera_maxyaw = Cvar_Get ("cl_camera_maxyaw", "30", CVAR_NONE, "None"); + Cvar_Get ("cl_camera_maxpitch", "10", CVAR_NONE, "highest camera pitch in spectator mode"); + cl_camera_maxyaw = Cvar_Get ("cl_camera_maxyaw", "30", CVAR_NONE, "highest camera yaw in spectator mode"); } diff --git a/source/cl_input.c b/source/cl_input.c index d685ebc..775c300 100644 --- a/source/cl_input.c +++ b/source/cl_input.c @@ -741,7 +741,8 @@ CL_Input_Init (void) void CL_Input_Init_Cvars (void) { - cl_nodelta = Cvar_Get ("cl_nodelta", "0", CVAR_NONE, "None"); + cl_nodelta = Cvar_Get ("cl_nodelta", "0", CVAR_NONE, "disable player delta compression. + set to 1 if you have a poor ISP and get a lot of U_REMOVE warnings."); } diff --git a/source/cl_main.c b/source/cl_main.c index 366410c..226ec57 100644 --- a/source/cl_main.c +++ b/source/cl_main.c @@ -1297,7 +1297,6 @@ CL_Init_Cvars (void) // LordHavoc: some people like it asking on quit, others don't... confirm_quit = Cvar_Get ("confirm_quit", "1", CVAR_ARCHIVE, "confirm quit command"); - show_fps = Cvar_Get ("show_fps", "0", CVAR_NONE, "display realtime frames per second"); // Misty: I like to be able to see the time when I play @@ -1307,7 +1306,6 @@ CL_Init_Cvars (void) "display host processing times"); developer = Cvar_Get ("developer", "0", CVAR_NONE, "show info interesting to developers"); - // Misty: Turn on or off screen filling colors for powerups among other things. cl_cshift_bonus = Cvar_Get ("cl_cshift_bonus", "1", CVAR_ARCHIVE, "Show bonus flash on item pickup"); @@ -1317,7 +1315,6 @@ CL_Init_Cvars (void) "Shift view colors on damage"); cl_cshift_powerup = Cvar_Get ("cl_cshift_powerup", "1", CVAR_ARCHIVE, "Shift view colors for powerups"); - cl_autoexec = Cvar_Get ("cl_autoexec", "0", CVAR_ROM, "exec autoexec.cfg on gamedir change"); cl_warncmd = Cvar_Get ("cl_warncmd", "0", CVAR_NONE, @@ -1358,7 +1355,7 @@ CL_Init_Cvars (void) m_pitch = Cvar_Get ("m_pitch", "0.022", CVAR_ARCHIVE, "mouse pitch (up/down) multipier"); m_yaw = Cvar_Get ("m_yaw", "0.022", CVAR_NONE, - "mouse yaw (left/right) multipiler"); + "mouse yaw (left/right) multiplier"); m_forward = Cvar_Get ("m_forward", "1", CVAR_NONE, "mouse forward/back speed"); m_side = Cvar_Get ("m_side", "0.8", CVAR_NONE, "mouse strafe speed"); @@ -1400,13 +1397,9 @@ CL_Init_Cvars (void) "Players color on top"); bottomcolor = Cvar_Get ("bottomcolor", "0", CVAR_ARCHIVE | CVAR_USERINFO, "Players color on bottom"); - /* Misty: FIXME: Nobody seems to know exactly what this rate *IS* - - bytes/packets/what?? */ rate = Cvar_Get ("rate", "2500", CVAR_ARCHIVE | CVAR_USERINFO, - "download rate"); - /* Misty: FIXME: We need to find out exactly *what* it does - suppress/allow */ - msg = Cvar_Get ("msg", "1", CVAR_ARCHIVE | CVAR_USERINFO, "Message level"); + "Amount of bytes per second server will send/download to you"); + msg = Cvar_Get ("msg", "1", CVAR_ARCHIVE | CVAR_USERINFO, "Determines the type of messages reported 0 is maximum, 4 is none"); noaim = Cvar_Get ("noaim", "0", CVAR_ARCHIVE | CVAR_USERINFO, "Auto aim off switch. Set to 1 to turn off."); } diff --git a/source/cl_pred.c b/source/cl_pred.c index 6cec2da..e946016 100644 --- a/source/cl_pred.c +++ b/source/cl_pred.c @@ -250,6 +250,7 @@ CL_Prediction_Init_Cvars void CL_Prediction_Init_Cvars (void) { - cl_pushlatency = Cvar_Get ("pushlatency", "-999", CVAR_NONE, "None"); - cl_nopred = Cvar_Get ("cl_nopred", "0", CVAR_NONE, "None"); +/* I'm not totally sure what cl_pushlatency is for. Or if it is SUPPOSED TO BE SETTABLE. */ + cl_pushlatency = Cvar_Get ("pushlatency", "-999", CVAR_NONE, "How much prediction should the client make"); + cl_nopred = Cvar_Get ("cl_nopred", "0", CVAR_NONE, "Set to turn off client prediction"); } diff --git a/source/cl_sys_sdl.c b/source/cl_sys_sdl.c index 2d56004..37248ce 100644 --- a/source/cl_sys_sdl.c +++ b/source/cl_sys_sdl.c @@ -252,7 +252,7 @@ Sys_Sleep (void) void Sys_Init_Cvars (void) { - sys_nostdout = Cvar_Get ("sys_nostdout", "0", CVAR_NONE, "None"); + sys_nostdout = Cvar_Get ("sys_nostdout", "0", CVAR_NONE, "Set to disable std out"); if (COM_CheckParm ("-nostdout")) Cvar_Set (sys_nostdout, "1"); } diff --git a/source/cl_sys_unix.c b/source/cl_sys_unix.c index b4fab92..e201d49 100644 --- a/source/cl_sys_unix.c +++ b/source/cl_sys_unix.c @@ -123,7 +123,7 @@ Sys_Quit (void) void Sys_Init_Cvars (void) { - sys_nostdout = Cvar_Get ("sys_nostdout", "0", CVAR_NONE, "None"); + sys_nostdout = Cvar_Get ("sys_nostdout", "0", CVAR_NONE, "set to disable std out"); if (COM_CheckParm ("-nostdout")) Cvar_Set (sys_nostdout, "1"); } diff --git a/source/cl_sys_win.c b/source/cl_sys_win.c index 9f414fe..1583e61 100644 --- a/source/cl_sys_win.c +++ b/source/cl_sys_win.c @@ -173,7 +173,7 @@ Sys_Init void Sys_Init_Cvars (void) { - sys_nostdout = Cvar_Get ("sys_nostdout", "1", CVAR_NONE, "None"); + sys_nostdout = Cvar_Get ("sys_nostdout", "1", CVAR_NONE, "unset to enable std out - windows does NOT support this"); } void diff --git a/source/com.c b/source/com.c index 06e9839..611f8a2 100644 --- a/source/com.c +++ b/source/com.c @@ -117,5 +117,5 @@ COM_Init (void) void COM_Init_Cvars (void) { - registered = Cvar_Get ("registered", "0", CVAR_NONE, "None"); + registered = Cvar_Get ("registered", "0", CVAR_NONE, "Is the game the registered version. 1 yes 0 no"); } diff --git a/source/console.c b/source/console.c index dd2a635..ce809ef 100644 --- a/source/console.c +++ b/source/console.c @@ -293,7 +293,7 @@ Con_Init (void) void Con_Init_Cvars (void) { - con_notifytime = Cvar_Get ("con_notifytime", "3", CVAR_NONE, "None"); + con_notifytime = Cvar_Get ("con_notifytime", "3", CVAR_NONE, "How long in seconds messages are displayed on screen"); } diff --git a/source/cvar.c b/source/cvar.c index 0abad8d..53340ef 100644 --- a/source/cvar.c +++ b/source/cvar.c @@ -425,7 +425,7 @@ Cvar_CvarList_f (void) void Cvar_Init (void) { - developer = Cvar_Get ("developer", "0", 0, "None"); + developer = Cvar_Get ("developer", "0", 0, "set to enable extra debugging information"); Cmd_AddCommand ("set", Cvar_Set_f); Cmd_AddCommand ("setrom", Cvar_Setrom_f); diff --git a/source/d_init.c b/source/d_init.c index 8c8160d..4e6ffc4 100644 --- a/source/d_init.c +++ b/source/d_init.c @@ -71,9 +71,9 @@ D_Init (void) void D_Init_Cvars (void) { - d_subdiv16 = Cvar_Get ("d_subdiv16", "1", CVAR_NONE, "None"); - d_mipcap = Cvar_Get ("d_mipcap", "0", CVAR_NONE, "None"); - d_mipscale = Cvar_Get ("d_mipscale", "1", CVAR_NONE, "None"); + d_subdiv16 = Cvar_Get ("d_subdiv16", "1", CVAR_NONE, "Set to enable extreme perspective correction"); + d_mipcap = Cvar_Get ("d_mipcap", "0", CVAR_NONE, "Detail level. 0 is highest, 3 is lowest."); + d_mipscale = Cvar_Get ("d_mipscale", "1", CVAR_NONE, "Detail level of objects. 0 is highest, 3 is lowest."); } /* diff --git a/source/draw.c b/source/draw.c index 9d2016e..3ad0d80 100644 --- a/source/draw.c +++ b/source/draw.c @@ -203,7 +203,7 @@ Draw_Init (void) r_rectdesc.rowbytes = draw_backtile->width; cl_verstring = - Cvar_Get ("cl_verstring", PROGRAM " " VERSION, CVAR_NONE, "None"); + Cvar_Get ("cl_verstring", PROGRAM " " VERSION, CVAR_NONE, "Client version string"); } void diff --git a/source/gl_draw.c b/source/gl_draw.c index 049fea5..eecbce2 100644 --- a/source/gl_draw.c +++ b/source/gl_draw.c @@ -505,14 +505,10 @@ Draw_Init_Cvars (void) // LordHavoc: lighting mode gl_lightmode = Cvar_Get ("gl_lightmode", "1", CVAR_ARCHIVE, "Lighting mode (0 = GLQuake style, 1 = new style)"); - gl_max_size = Cvar_Get ("gl_max_size", "1024", CVAR_NONE, "None"); // CVAR_FIXME - // - - // set - // a - // description - gl_picmip = Cvar_Get ("gl_picmip", "0", CVAR_NONE, "None"); // CVAR_FIXME - // - set a - // description + gl_max_size = Cvar_Get ("gl_max_size", "1024", CVAR_NONE, "Texture dimension"); + + gl_picmip = Cvar_Get ("gl_picmip", "0", CVAR_NONE, "Dimensions of displayed textures. 0 is normal, 1 is half, 2 is 1/4"); + gl_colorlights = Cvar_Get ("gl_colorlights", "1", CVAR_ROM, "Whether to use RGB lightmaps or not"); @@ -525,7 +521,7 @@ Draw_Init_Cvars (void) "speed at which the console spins"); cl_verstring = Cvar_Get ("cl_verstring", PROGRAM " " VERSION, CVAR_NONE, - "client version string"); + "Client version string"); } diff --git a/source/gl_rmisc.c b/source/gl_rmisc.c index 2eae1e6..d64e09b 100644 --- a/source/gl_rmisc.c +++ b/source/gl_rmisc.c @@ -210,30 +210,32 @@ R_Init (void) void R_Init_Cvars (void) { - r_norefresh = Cvar_Get ("r_norefresh", "0", CVAR_NONE, "None"); - r_drawentities = Cvar_Get ("r_drawentities", "1", CVAR_NONE, "None"); - r_drawviewmodel = Cvar_Get ("r_drawviewmodel", "1", CVAR_ARCHIVE, "None"); - r_shadows = Cvar_Get ("r_shadows", "0", CVAR_NONE, "None"); - r_wateralpha = Cvar_Get ("r_wateralpha", "1", CVAR_NONE, "None"); - r_waterripple = Cvar_Get ("r_waterripple", "0", CVAR_NONE, "None"); - r_dynamic = Cvar_Get ("r_dynamic", "1", CVAR_NONE, "None"); - r_novis = Cvar_Get ("r_novis", "0", CVAR_NONE, "None"); - r_speeds = Cvar_Get ("r_speeds", "0", CVAR_NONE, "None"); + r_norefresh = Cvar_Get ("r_norefresh", "0", CVAR_NONE, "Set to 1 to disable display refresh"); + r_drawentities = Cvar_Get ("r_drawentities", "1", CVAR_NONE, "Set to 0 to disable drawing entities"); + r_drawviewmodel = Cvar_Get ("r_drawviewmodel", "1", CVAR_ARCHIVE, "Set to 0 to disable drawing your weapon"); + r_shadows = Cvar_Get ("r_shadows", "0", CVAR_NONE, "Set to 1 to enable shadows for entities"); + r_wateralpha = Cvar_Get ("r_wateralpha", "1", CVAR_NONE, "Determine opacity of liquids. 1 is solid, + .75, .50, and .25 are partially transparent, and 0 is transparent."); + /* FIXME what does r_waterripple use for units? */ + r_waterripple = Cvar_Get ("r_waterripple", "0", CVAR_NONE, "Set to make liquids ripple, a good setting is 5"); + r_dynamic = Cvar_Get ("r_dynamic", "1", CVAR_NONE, "Set to 0 to disable all dynamic lighting - unless gl_flashblend is set to 1"); + r_novis = Cvar_Get ("r_novis", "0", CVAR_NONE, "Set to 1 to enable transparency of liquids on unvised maps"); + r_speeds = Cvar_Get ("r_speeds", "0", CVAR_NONE, "Display drawing time and statistics of what is being viewed"); r_netgraph = Cvar_Get ("r_netgraph", "0", CVAR_ARCHIVE, "Graph network stats"); r_netgraph_alpha = Cvar_Get ("r_netgraph_alpha", "0.5", CVAR_ARCHIVE, "Net graph translucency"); r_netgraph_box = Cvar_Get ("r_netgraph_box", "1", CVAR_ARCHIVE, "Draw box around net graph?"); - gl_clear = Cvar_Get ("gl_clear", "0", CVAR_NONE, "None"); - gl_texsort = Cvar_Get ("gl_texsort", "1", CVAR_NONE, "None"); + gl_clear = Cvar_Get ("gl_clear", "0", CVAR_NONE, "Set to 1 to make background black. Useful for removing HOM effect"); + gl_texsort = Cvar_Get ("gl_texsort", "1", CVAR_NONE, "Set to 0 to enable multitexture"); - gl_cull = Cvar_Get ("gl_cull", "1", CVAR_NONE, "None"); - gl_smooth = Cvar_Get ("gl_smooth", "1", CVAR_NONE, "None"); - gl_smoothdlights = Cvar_Get ("gl_smoothdlights", "1", CVAR_NONE, "None"); - gl_affinemodels = Cvar_Get ("gl_affinemodels", "0", CVAR_NONE, "None"); - gl_flashblend = Cvar_Get ("gl_flashblend", "0", CVAR_NONE, "None"); - gl_playermip = Cvar_Get ("gl_playermip", "0", CVAR_NONE, "None"); - gl_nocolors = Cvar_Get ("gl_nocolors", "0", CVAR_NONE, "None"); + gl_cull = Cvar_Get ("gl_cull", "1", CVAR_NONE, "If set to 1, does not render things that do not need to be"); + gl_smooth = Cvar_Get ("gl_smooth", "1", CVAR_NONE, "Set to 0 to NOT smooth lighted models"); + gl_smoothdlights = Cvar_Get ("gl_smoothdlights", "1", CVAR_NONE, "Set to 0 to NOT smooth lights"); + gl_affinemodels = Cvar_Get ("gl_affinemodels", "0", CVAR_NONE, "Makes texture rendering quality better if set to 1"); + gl_flashblend = Cvar_Get ("gl_flashblend", "0", CVAR_NONE, "Set to 1 to use a type of lighting faster on GL"); + gl_playermip = Cvar_Get ("gl_playermip", "0", CVAR_NONE, "Detail of player skins. 0 best, 2 worst."); + gl_nocolors = Cvar_Get ("gl_nocolors", "0", CVAR_NONE, "Set to 1, turns off all player skins"); gl_fires = Cvar_Get ("gl_fires", "0", CVAR_ARCHIVE, "Toggles lavaball and rocket fireballs"); @@ -247,7 +249,7 @@ R_Init_Cvars (void) gl_fb_bmodels = Cvar_Get ("gl_fb_bmodels", "1", CVAR_ARCHIVE, "Toggles fullbright color support for bmodels"); - gl_keeptjunctions = Cvar_Get ("gl_keeptjunctions", "1", CVAR_NONE, "None"); + gl_keeptjunctions = Cvar_Get ("gl_keeptjunctions", "1", CVAR_NONE, "Set to 1 to turn off colinear vertexes upon level load"); gl_lerp_anim = Cvar_Get ("gl_lerp_anim", "1", CVAR_ARCHIVE, "Toggles model animation interpolation"); diff --git a/source/gl_screen.c b/source/gl_screen.c index 80a273e..336c0d8 100644 --- a/source/gl_screen.c +++ b/source/gl_screen.c @@ -387,20 +387,20 @@ SCR_SizeDown_f (void) void SCR_Init_Cvars (void) { - scr_fov = Cvar_Get ("fov", "90", CVAR_NONE, "None"); - scr_viewsize = Cvar_Get ("viewsize", "100", CVAR_ARCHIVE, "None"); - scr_conspeed = Cvar_Get ("scr_conspeed", "300", CVAR_NONE, "None"); - scr_showram = Cvar_Get ("showram", "1", CVAR_NONE, "None"); - scr_showturtle = Cvar_Get ("showturtle", "0", CVAR_NONE, "None"); - scr_showpause = Cvar_Get ("showpause", "1", CVAR_NONE, "None"); - scr_centertime = Cvar_Get ("scr_centertime", "2", CVAR_NONE, "None"); - scr_printspeed = Cvar_Get ("scr_printspeed", "8", CVAR_NONE, "None"); - gl_triplebuffer = Cvar_Get ("gl_triplebuffer", "1", CVAR_ARCHIVE, "None"); + scr_fov = Cvar_Get ("fov", "90", CVAR_NONE, "Your point of view in degrees. Smaller than 90 zooms in."); + scr_viewsize = Cvar_Get ("viewsize", "100", CVAR_ARCHIVE, "Set the screen size 30 minimum, 120 maximum"); + scr_conspeed = Cvar_Get ("scr_conspeed", "300", CVAR_NONE, "How quickly console scrolls up or down"); + scr_showram = Cvar_Get ("showram", "1", CVAR_NONE, "Show RAM icon if game is running low on memory"); + scr_showturtle = Cvar_Get ("showturtle", "0", CVAR_NONE, "Show a turtle icon if your fps is slower than 10"); + scr_showpause = Cvar_Get ("showpause", "1", CVAR_NONE, "Toggles display of pause graphic"); + scr_centertime = Cvar_Get ("scr_centertime", "2", CVAR_NONE, "How long in seconds screen hints are displayed"); + scr_printspeed = Cvar_Get ("scr_printspeed", "8", CVAR_NONE, "How fast the text is displayed at the end of the single player episodes"); + gl_triplebuffer = Cvar_Get ("gl_triplebuffer", "1", CVAR_ARCHIVE, "Set to 1 by default. Fixes status bar flicker on some hardware"); - crosshaircolor = Cvar_Get ("crosshaircolor", "79", CVAR_ARCHIVE, "None"); - crosshair = Cvar_Get ("crosshair", "0", CVAR_ARCHIVE, "None"); - cl_crossx = Cvar_Get ("cl_crossx", "0", CVAR_ARCHIVE, "None"); - cl_crossy = Cvar_Get ("cl_crossy", "0", CVAR_ARCHIVE, "None"); + crosshaircolor = Cvar_Get ("crosshaircolor", "79", CVAR_ARCHIVE, "Color of the new crosshair"); + crosshair = Cvar_Get ("crosshair", "0", CVAR_ARCHIVE, "Crosshair type. 0 off, 1 old without color, 2 new with colors"); + cl_crossx = Cvar_Get ("cl_crossx", "0", CVAR_ARCHIVE, "Sets the position of the crosshair on the X-axis."); + cl_crossy = Cvar_Get ("cl_crossy", "0", CVAR_ARCHIVE, "Sets the position of the crosshair on the Y-axis."); } void diff --git a/source/in_sdl.c b/source/in_sdl.c index 90f0e9b..7d0808b 100644 --- a/source/in_sdl.c +++ b/source/in_sdl.c @@ -364,8 +364,8 @@ IN_Init_Cvars (void) { JOY_Init_Cvars (); - _windowed_mouse = Cvar_Get ("_windowed_mouse", "0", CVAR_ARCHIVE, "None"); - // m_filter = Cvar_Get ("m_filter", "0", CVAR_ARCHIVE, "None"); + _windowed_mouse = Cvar_Get ("_windowed_mouse", "0", CVAR_ARCHIVE, "If set to 1, quake will grab the mouse in X"); + // m_filter = Cvar_Get ("m_filter", "0", CVAR_ARCHIVE, "Toggle mouse input filtering"); } void diff --git a/source/in_svgalib.c b/source/in_svgalib.c index 6acd37c..32235f8 100644 --- a/source/in_svgalib.c +++ b/source/in_svgalib.c @@ -134,7 +134,7 @@ void IN_Init_Cvars (void) { JOY_Init_Cvars (); - m_filter = Cvar_Get ("m_filter", "0", 0, "None"); + m_filter = Cvar_Get ("m_filter", "0", 0, "Toggle mouse input filtering."); } static void diff --git a/source/in_win.c b/source/in_win.c index 5cd3102..6c0dc8c 100644 --- a/source/in_win.c +++ b/source/in_win.c @@ -447,7 +447,7 @@ void IN_Init_Cvars (void) { // mouse variables - m_filter = Cvar_Get ("m_filter", "0", CVAR_NONE, "None"); + m_filter = Cvar_Get ("m_filter", "0", CVAR_NONE, "Toggle mouse input filtering."); JOY_Init_Cvars(); } diff --git a/source/in_x11.c b/source/in_x11.c index d8e3f7c..4857732 100644 --- a/source/in_x11.c +++ b/source/in_x11.c @@ -537,9 +537,9 @@ void IN_Init_Cvars (void) { JOY_Init_Cvars (); - _windowed_mouse = Cvar_Get ("_windowed_mouse", "0", CVAR_ARCHIVE, "None"); - m_filter = Cvar_Get ("m_filter", "0", CVAR_ARCHIVE, "None"); + _windowed_mouse = Cvar_Get ("_windowed_mouse", "0", CVAR_ARCHIVE, "With this set to 1, quake will grab the mouse from X"); + m_filter = Cvar_Get ("m_filter", "0", CVAR_ARCHIVE, "Toggle mouse input filtering."); in_dga = Cvar_Get ("in_dga", "1", CVAR_ARCHIVE, "DGA Input support"); in_dga_mouseaccel = Cvar_Get ("in_dga_mouseaccel", "1", CVAR_ARCHIVE, - "None"); + "DGA Mouse accelleration multiplier"); } diff --git a/source/joy_linux.c b/source/joy_linux.c index 7326840..1741d24 100644 --- a/source/joy_linux.c +++ b/source/joy_linux.c @@ -210,7 +210,7 @@ JOY_Init_Cvars (void) for (i = 0; i < JOY_MAX_AXES; i++) { joy_axes[i].axis = Cvar_Get (joy_axes[i].var.name, joy_axes[i].var.string, - CVAR_ARCHIVE, "None"); + CVAR_ARCHIVE, "Set joystick axes"); } } diff --git a/source/joy_win.c b/source/joy_win.c index 46c7577..ec30efb 100644 --- a/source/joy_win.c +++ b/source/joy_win.c @@ -575,43 +575,45 @@ JOY_Init_Cvars(void) "Joystick sensitivity"); // joystick variables - in_joystick = - Cvar_Get ("joystick", "0", CVAR_ARCHIVE, "None"); - joy_name = - Cvar_Get ("joyname", "joystick", CVAR_NONE, "None"); - joy_advanced = - Cvar_Get ("joyadvanced", "0", CVAR_NONE, "None"); - joy_advaxisx = - Cvar_Get ("joyadvaxisx", "0", CVAR_NONE, "None"); - joy_advaxisy = - Cvar_Get ("joyadvaxisy", "0", CVAR_NONE, "None"); - joy_advaxisz = - Cvar_Get ("joyadvaxisz", "0", CVAR_NONE, "None"); - joy_advaxisr = - Cvar_Get ("joyadvaxisr", "0", CVAR_NONE, "None"); - joy_advaxisu = - Cvar_Get ("joyadvaxisu", "0", CVAR_NONE, "None"); - joy_advaxisv = - Cvar_Get ("joyadvaxisv", "0", CVAR_NONE, "None"); - joy_forwardthreshold = - Cvar_Get ("joyforwardthreshold", "0.15", CVAR_NONE, "None"); - joy_sidethreshold = - Cvar_Get ("joysidethreshold", "0.15", CVAR_NONE, "None"); - joy_pitchthreshold = - Cvar_Get ("joypitchthreshold", "0.15", CVAR_NONE, "None"); - joy_yawthreshold = Cvar_Get ("joyyawthreshold", "0.15", CVAR_NONE, "None"); - joy_forwardsensitivity = - Cvar_Get ("joyforwardsensitivity", "-1.0", CVAR_NONE, "None"); - joy_sidesensitivity = - Cvar_Get ("joysidesensitivity", "-1.0", CVAR_NONE, "None"); - joy_pitchsensitivity = - Cvar_Get ("joypitchsensitivity", "1.0", CVAR_NONE, "None"); - joy_yawsensitivity = - Cvar_Get ("joyyawsensitivity", "-1.0", CVAR_NONE, "None"); - joy_wwhack1 = Cvar_Get ("joywwhack1", "0.0", CVAR_NONE, "None"); - joy_wwhack2 = Cvar_Get ("joywwhack2", "0.0", CVAR_NONE, "None"); + /* FIXME: Someone who has windows please document these cvars.*/ - joy_debug = Cvar_Get ("joy_debug", "0.0", CVAR_NONE, "None"); + in_joystick = + Cvar_Get ("joystick", "0", CVAR_ARCHIVE, "FIXME: Please document"); + joy_name = + Cvar_Get ("joyname", "joystick", CVAR_NONE, "FIXME: Please document"); + joy_advanced = + Cvar_Get ("joyadvanced", "0", CVAR_NONE, "FIXME: Please document"); + joy_advaxisx = + Cvar_Get ("joyadvaxisx", "0", CVAR_NONE, "FIXME: Please document"); + joy_advaxisy = + Cvar_Get ("joyadvaxisy", "0", CVAR_NONE, "FIXME: Please document"); + joy_advaxisz = + Cvar_Get ("joyadvaxisz", "0", CVAR_NONE, "FIXME: Please document"); + joy_advaxisr = + Cvar_Get ("joyadvaxisr", "0", CVAR_NONE, "FIXME: Please document"); + joy_advaxisu = + Cvar_Get ("joyadvaxisu", "0", CVAR_NONE, "FIXME: Please document"); + joy_advaxisv = + Cvar_Get ("joyadvaxisv", "0", CVAR_NONE, "FIXME: Please document"); + joy_forwardthreshold = + Cvar_Get ("joyforwardthreshold", "0.15", CVAR_NONE, "FIXME: Please document"); + joy_sidethreshold = + Cvar_Get ("joysidethreshold", "0.15", CVAR_NONE, "FIXME: Please document"); + joy_pitchthreshold = + Cvar_Get ("joypitchthreshold", "0.15", CVAR_NONE, "FIXME: Please document"); + joy_yawthreshold = Cvar_Get ("joyyawthreshold", "0.15", CVAR_NONE, "FIXME: Please document"); + joy_forwardsensitivity = + Cvar_Get ("joyforwardsensitivity", "-1.0", CVAR_NONE, "FIXME: Please document"); + joy_sidesensitivity = + Cvar_Get ("joysidesensitivity", "-1.0", CVAR_NONE, "FIXME: Please document"); + joy_pitchsensitivity = + Cvar_Get ("joypitchsensitivity", "1.0", CVAR_NONE, "FIXME: Please document"); + joy_yawsensitivity = + Cvar_Get ("joyyawsensitivity", "-1.0", CVAR_NONE, "FIXME: Please document"); + joy_wwhack1 = Cvar_Get ("joywwhack1", "0.0", CVAR_NONE, "FIXME: Please document"); + joy_wwhack2 = Cvar_Get ("joywwhack2", "0.0", CVAR_NONE, "FIXME: Please document"); + + joy_debug = Cvar_Get ("joy_debug", "0.0", CVAR_NONE, "FIXME: Please document"); return; } diff --git a/source/model.c b/source/model.c index bca4526..c1c51fb 100644 --- a/source/model.c +++ b/source/model.c @@ -78,7 +78,7 @@ void Mod_Init_Cvars (void) { gl_subdivide_size = - Cvar_Get ("gl_subdivide_size", "128", CVAR_ARCHIVE, "None"); + Cvar_Get ("gl_subdivide_size", "128", CVAR_ARCHIVE, "Sets the division value for the sky brushes."); } /* diff --git a/source/net_chan.c b/source/net_chan.c index f6927ad..f2e0eca 100644 --- a/source/net_chan.c +++ b/source/net_chan.c @@ -132,9 +132,10 @@ Netchan_Init (void) void Netchan_Init_Cvars (void) { - showpackets = Cvar_Get ("showpackets", "0", CVAR_NONE, "None"); - showdrop = Cvar_Get ("showdrop", "0", CVAR_NONE, "None"); - qport = Cvar_Get ("qport", "0", CVAR_NONE, "None"); + showpackets = Cvar_Get ("showpackets", "0", CVAR_NONE, "Show all network packets"); + showdrop = Cvar_Get ("showdrop", "0", CVAR_NONE, "Toggle the display of how many packets you are dropping"); + qport = Cvar_Get ("qport", "0", CVAR_NONE, "The internal port number for the game networking code. + Useful for clients who use multiple connections through one IP address (NAT/IP-MASQ) because default port is random."); } /* diff --git a/source/r_main.c b/source/r_main.c index ac1c6bb..5192462 100644 --- a/source/r_main.c +++ b/source/r_main.c @@ -266,29 +266,30 @@ R_Init_Cvars (void) { D_Init_Cvars (); - r_draworder = Cvar_Get ("r_draworder", "0", CVAR_NONE, "None"); - r_speeds = Cvar_Get ("r_speeds", "0", CVAR_NONE, "None"); - r_timegraph = Cvar_Get ("r_timegraph", "0", CVAR_NONE, "None"); - r_netgraph = Cvar_Get ("r_netgraph", "0", CVAR_NONE, "None"); - r_zgraph = Cvar_Get ("r_zgraph", "0", CVAR_NONE, "None"); - r_graphheight = Cvar_Get ("r_graphheight", "15", CVAR_NONE, "None"); - r_drawflat = Cvar_Get ("r_drawflat", "0", CVAR_NONE, "None"); - r_ambient = Cvar_Get ("r_ambient", "0", CVAR_NONE, "None"); - r_clearcolor = Cvar_Get ("r_clearcolor", "2", CVAR_NONE, "None"); - r_waterwarp = Cvar_Get ("r_waterwarp", "1", CVAR_NONE, "None"); - r_drawentities = Cvar_Get ("r_drawentities", "1", CVAR_NONE, "None"); - r_drawviewmodel = Cvar_Get ("r_drawviewmodel", "1", CVAR_ARCHIVE, "None"); - r_aliasstats = Cvar_Get ("r_polymodelstats", "0", CVAR_NONE, "None"); - r_dspeeds = Cvar_Get ("r_dspeeds", "0", CVAR_NONE, "None"); - r_reportsurfout = Cvar_Get ("r_reportsurfout", "0", CVAR_NONE, "None"); - r_maxsurfs = Cvar_Get ("r_maxsurfs", "0", CVAR_NONE, "None"); - r_numsurfs = Cvar_Get ("r_numsurfs", "0", CVAR_NONE, "None"); - r_reportedgeout = Cvar_Get ("r_reportedgeout", "0", CVAR_NONE, "None"); - r_maxedges = Cvar_Get ("r_maxedges", "0", CVAR_NONE, "None"); - r_numedges = Cvar_Get ("r_numedges", "0", CVAR_NONE, "None"); - r_aliastransbase = Cvar_Get ("r_aliastransbase", "200", CVAR_NONE, "None"); - r_aliastransadj = Cvar_Get ("r_aliastransadj", "100", CVAR_NONE, "None"); - gl_flashblend = Cvar_Get ("gl_flashblend", "0", CVAR_NONE, "None"); + r_draworder = Cvar_Get ("r_draworder", "0", CVAR_NONE, "Toggles drawing order"); + r_speeds = Cvar_Get ("r_speeds", "0", CVAR_NONE, "Toggles the displaying of drawing time and + statistics of what is currently being viewed"); + r_timegraph = Cvar_Get ("r_timegraph", "0", CVAR_NONE, "Toggle the display of a performance graph"); + r_netgraph = Cvar_Get ("r_netgraph", "0", CVAR_NONE, "Toggle the display of a graph showing network performance"); + r_zgraph = Cvar_Get ("r_zgraph", "0", CVAR_NONE, "Toggle the graph that reports the changes of z-axis position"); + r_graphheight = Cvar_Get ("r_graphheight", "15", CVAR_NONE, "Set the number of lines displayed in the various graphs"); + r_drawflat = Cvar_Get ("r_drawflat", "0", CVAR_NONE, "Toggles the drawing of textures"); + r_ambient = Cvar_Get ("r_ambient", "0", CVAR_NONE, "Determines the ambient lighting for a level"); + r_clearcolor = Cvar_Get ("r_clearcolor", "2", CVAR_NONE, "This sets the color for areas outside of the current map"); + r_waterwarp = Cvar_Get ("r_waterwarp", "1", CVAR_NONE, "Toggles whether surfaces are warped in a liquid."); + r_drawentities = Cvar_Get ("r_drawentities", "1", CVAR_NONE, "Toggles the drawing of entities."); + r_drawviewmodel = Cvar_Get ("r_drawviewmodel", "1", CVAR_ARCHIVE, "Toggles the drawing of your weapon"); + r_aliasstats = Cvar_Get ("r_polymodelstats", "0", CVAR_NONE, "Toggles the displays of number of polygon models current being viewed"); + r_dspeeds = Cvar_Get ("r_dspeeds", "0", CVAR_NONE, "Toggles the display of drawing speed information"); + r_reportsurfout = Cvar_Get ("r_reportsurfout", "0", CVAR_NONE, "Toggle the display of how many surfaces where not displayed"); + r_maxsurfs = Cvar_Get ("r_maxsurfs", "0", CVAR_NONE, "Sets the maximum number of surfaces"); + r_numsurfs = Cvar_Get ("r_numsurfs", "0", CVAR_NONE, "Toggles the displaying of number of surfaces currently being viewed"); + r_reportedgeout = Cvar_Get ("r_reportedgeout", "0", CVAR_NONE, "Toggle the display of how many edges where not displayed"); + r_maxedges = Cvar_Get ("r_maxedges", "0", CVAR_NONE, "Sets the maximum number of surfaces"); + r_numedges = Cvar_Get ("r_numedges", "0", CVAR_NONE, "Toggles the displaying of number of edges currently being viewed"); + r_aliastransbase = Cvar_Get ("r_aliastransbase", "200", CVAR_NONE, "Determines how much of an alias model is clipped away and how much is viewable"); + r_aliastransadj = Cvar_Get ("r_aliastransadj", "100", CVAR_NONE, "Determines how much of an alias model is clipped away and how much is viewable."); + gl_flashblend = Cvar_Get ("gl_flashblend", "0", CVAR_NONE, "Toggles the type of lighting for objects"); gl_sky_divide = Cvar_Get ("gl_sky_divide", "1", CVAR_ARCHIVE, "subdivide sky polys"); } diff --git a/source/r_view.c b/source/r_view.c index 52e385e..273bb6b 100644 --- a/source/r_view.c +++ b/source/r_view.c @@ -820,29 +820,29 @@ V_Init (void) void V_Init_Cvars (void) { - v_centermove = Cvar_Get ("v_centermove", "0.15", CVAR_NONE, "None"); - v_centerspeed = Cvar_Get ("v_centerspeed", "500", CVAR_NONE, "None"); + v_centermove = Cvar_Get ("v_centermove", "0.15", CVAR_NONE, "How far the player must move forward before the view re-centers"); + v_centerspeed = Cvar_Get ("v_centerspeed", "500", CVAR_NONE, "How quickly you return to a center view after a lookup or lookdown"); - v_iyaw_cycle = Cvar_Get ("v_iyaw_cycle", "2", CVAR_NONE, "None"); - v_iroll_cycle = Cvar_Get ("v_iroll_cycle", "0.5", CVAR_NONE, "None"); - v_ipitch_cycle = Cvar_Get ("v_ipitch_cycle", "1", CVAR_NONE, "None"); - v_iyaw_level = Cvar_Get ("v_iyaw_level", "0.3", CVAR_NONE, "None"); - v_iroll_level = Cvar_Get ("v_iroll_level", "0.1", CVAR_NONE, "None"); - v_ipitch_level = Cvar_Get ("v_ipitch_level", "0.3", CVAR_NONE, "None"); + v_iyaw_cycle = Cvar_Get ("v_iyaw_cycle", "2", CVAR_NONE, "How far you tilt right and left when v_idlescale is enabled"); + v_iroll_cycle = Cvar_Get ("v_iroll_cycle", "0.5", CVAR_NONE, "How quickly you tilt right and left when v_idlescale is enabled"); + v_ipitch_cycle = Cvar_Get ("v_ipitch_cycle", "1", CVAR_NONE, "How quickly you lean forwards and backwards when v_idlescale is enabled"); + v_iyaw_level = Cvar_Get ("v_iyaw_level", "0.3", CVAR_NONE, "How far you tilt right and left when v_idlescale is enabled"); + v_iroll_level = Cvar_Get ("v_iroll_level", "0.1", CVAR_NONE, "How far you tilt right and left when v_idlescale is enabled"); + v_ipitch_level = Cvar_Get ("v_ipitch_level", "0.3", CVAR_NONE, "How far you lean forwards and backwards when v_idlescale is enabled"); - v_idlescale = Cvar_Get ("v_idlescale", "0", CVAR_NONE, "None"); + v_idlescale = Cvar_Get ("v_idlescale", "0", CVAR_NONE, "Toggles whether the view remains idle"); - cl_rollspeed = Cvar_Get ("cl_rollspeed", "200", CVAR_NONE, "None"); - cl_rollangle = Cvar_Get ("cl_rollangle", "2.0", CVAR_NONE, "None"); + cl_rollspeed = Cvar_Get ("cl_rollspeed", "200", CVAR_NONE, "How quickly you straighten out after strafing"); + cl_rollangle = Cvar_Get ("cl_rollangle", "2.0", CVAR_NONE, "How much your screen tilts when strafing"); - cl_bob = Cvar_Get ("cl_bob", "0.02", CVAR_NONE, "None"); - cl_bobcycle = Cvar_Get ("cl_bobcycle", "0.6", CVAR_NONE, "None"); - cl_bobup = Cvar_Get ("cl_bobup", "0.5", CVAR_NONE, "None"); + cl_bob = Cvar_Get ("cl_bob", "0.02", CVAR_NONE, "How much your weapon moves up and down when walking"); + cl_bobcycle = Cvar_Get ("cl_bobcycle", "0.6", CVAR_NONE, "How quickly your weapon moves up and down when walking"); + cl_bobup = Cvar_Get ("cl_bobup", "0.5", CVAR_NONE, "How long your weapon stays up before cycling when walking"); - v_kicktime = Cvar_Get ("v_kicktime", "0.5", CVAR_NONE, "None"); - v_kickroll = Cvar_Get ("v_kickroll", "0.6", CVAR_NONE, "None"); - v_kickpitch = Cvar_Get ("v_kickpitch", "0.6", CVAR_NONE, "None"); + v_kicktime = Cvar_Get ("v_kicktime", "0.5", CVAR_NONE, "How long the kick from an attack lasts"); + v_kickroll = Cvar_Get ("v_kickroll", "0.6", CVAR_NONE, "How much you lean when hit"); + v_kickpitch = Cvar_Get ("v_kickpitch", "0.6", CVAR_NONE, "How much you look up when hit"); - brightness = Cvar_Get ("brightness", "1", CVAR_ARCHIVE, "None"); - contrast = Cvar_Get ("contrast", "1", CVAR_ARCHIVE, "None"); + brightness = Cvar_Get ("brightness", "1", CVAR_ARCHIVE, "Brightness level"); + contrast = Cvar_Get ("contrast", "1", CVAR_ARCHIVE, "Contrast level"); } diff --git a/source/screen.c b/source/screen.c index ce1fcad..6d2ee67 100644 --- a/source/screen.c +++ b/source/screen.c @@ -405,19 +405,19 @@ SCR_SizeDown_f (void) void SCR_Init_Cvars (void) { - scr_fov = Cvar_Get ("fov", "90", CVAR_NONE, "None"); - scr_viewsize = Cvar_Get ("viewsize", "100", CVAR_ARCHIVE, "None"); - scr_conspeed = Cvar_Get ("scr_conspeed", "300", CVAR_NONE, "None"); - scr_showram = Cvar_Get ("showram", "1", CVAR_NONE, "None"); - scr_showturtle = Cvar_Get ("showturtle", "0", CVAR_NONE, "None"); - scr_showpause = Cvar_Get ("showpause", "1", CVAR_NONE, "None"); - scr_centertime = Cvar_Get ("scr_centertime", "2", CVAR_NONE, "None"); - scr_printspeed = Cvar_Get ("scr_printspeed", "8", CVAR_NONE, "None"); + scr_fov = Cvar_Get ("fov", "90", CVAR_NONE, "field of view. 90 is normal, smaller numbers zoom"); + scr_viewsize = Cvar_Get ("viewsize", "100", CVAR_ARCHIVE, "Set the screen size 30 minimum, 120 maximum"); + scr_conspeed = Cvar_Get ("scr_conspeed", "300", CVAR_NONE, "How quickly in the console screen scrolls up and down"); + scr_showram = Cvar_Get ("showram", "1", CVAR_NONE, "Show ram icon when low on ram in game"); + scr_showturtle = Cvar_Get ("showturtle", "0", CVAR_NONE, "Show turtle icon when fps is lower than 10"); + scr_showpause = Cvar_Get ("showpause", "1", CVAR_NONE, "Show paused graphic when paused"); + scr_centertime = Cvar_Get ("scr_centertime", "2", CVAR_NONE, "How long in seconds the screen hints are displayed on the screen"); + scr_printspeed = Cvar_Get ("scr_printspeed", "8", CVAR_NONE, "How fast the text is displayed at the end of the single player episodes"); - crosshaircolor = Cvar_Get ("crosshaircolor", "79", CVAR_ARCHIVE, "None"); - crosshair = Cvar_Get ("crosshair", "0", CVAR_ARCHIVE, "None"); - cl_crossx = Cvar_Get ("cl_crossx", "0", CVAR_ARCHIVE, "None"); - cl_crossy = Cvar_Get ("cl_crossy", "0", CVAR_ARCHIVE, "None"); + crosshaircolor = Cvar_Get ("crosshaircolor", "79", CVAR_ARCHIVE, "Crosshair 2's color"); + crosshair = Cvar_Get ("crosshair", "0", CVAR_ARCHIVE, "Crosshair type. 0 off, 1 old, 2 new with color"); + cl_crossx = Cvar_Get ("cl_crossx", "0", CVAR_ARCHIVE, "Sets the position of the crosshair on the X-axis"); + cl_crossy = Cvar_Get ("cl_crossy", "0", CVAR_ARCHIVE, "Sets the position of the crosshair on the Y-axis"); } void diff --git a/source/snd_dma.c b/source/snd_dma.c index 7124adf..0c93beb 100644 --- a/source/snd_dma.c +++ b/source/snd_dma.c @@ -265,21 +265,22 @@ S_Init (void) void S_Init_Cvars (void) { - nosound = Cvar_Get ("nosound", "0", CVAR_NONE, "None"); - volume = Cvar_Get ("volume", "0.7", CVAR_ARCHIVE, "None"); - precache = Cvar_Get ("precache", "1", CVAR_NONE, "None"); - loadas8bit = Cvar_Get ("loadas8bit", "0", CVAR_NONE, "None"); - bgmvolume = Cvar_Get ("bgmvolume", "1", CVAR_ARCHIVE, "None"); - ambient_level = Cvar_Get ("ambient_level", "0.3", CVAR_NONE, "None"); - ambient_fade = Cvar_Get ("ambient_fade", "100", CVAR_NONE, "None"); - snd_noextraupdate = Cvar_Get ("snd_noextraupdate", "0", CVAR_NONE, "None"); - snd_show = Cvar_Get ("snd_show", "0", CVAR_NONE, "None"); + nosound = Cvar_Get ("nosound", "0", CVAR_NONE, "Set to turn sound off"); + volume = Cvar_Get ("volume", "0.7", CVAR_ARCHIVE, "Set the volume for sound playback"); + precache = Cvar_Get ("precache", "1", CVAR_NONE, "Toggle the use of a precache"); + loadas8bit = Cvar_Get ("loadas8bit", "0", CVAR_NONE, "Toggles if sounds are loaded as 8-bit samples"); + bgmvolume = Cvar_Get ("bgmvolume", "1", CVAR_ARCHIVE, "Volume of CD music"); + ambient_level = Cvar_Get ("ambient_level", "0.3", CVAR_NONE, "Ambient sounds' volume"); + ambient_fade = Cvar_Get ("ambient_fade", "100", CVAR_NONE, "How quickly ambient sounds fade in or out"); + snd_noextraupdate = Cvar_Get ("snd_noextraupdate", "0", CVAR_NONE, + "Toggles the correct value display in host_speeds. Usually messes up sound playback when in effect"); + snd_show = Cvar_Get ("snd_show", "0", CVAR_NONE, "Toggles the display of sounds currently being played"); snd_interp = Cvar_Get ("snd_interp", "1", CVAR_ARCHIVE, "control sample interpolation"); snd_phasesep = Cvar_Get ("snd_phasesep", "0.0", CVAR_ARCHIVE, "max stereo phase separation in ms. 0.6 is for 20cm head"); snd_volumesep = Cvar_Get("snd_volumesep", "1.0", CVAR_ARCHIVE, "max stereo volume separation in ms. 1.0 is max"); - _snd_mixahead = Cvar_Get ("_snd_mixahead", "0.1", CVAR_ARCHIVE, "None"); + _snd_mixahead = Cvar_Get ("_snd_mixahead", "0.1", CVAR_ARCHIVE, "Delay time for sounds"); } diff --git a/source/snd_null.c b/source/snd_null.c index 2b03087..79d1998 100644 --- a/source/snd_null.c +++ b/source/snd_null.c @@ -56,9 +56,9 @@ S_Init (void) void S_Init_Cvars (void) { - volume = Cvar_Get ("volume", "0.7", CVAR_ARCHIVE, "None"); - loadas8bit = Cvar_Get ("loadas8bit", "0", CVAR_NONE, "None"); - bgmvolume = Cvar_Get ("bgmvolume", "1", CVAR_ARCHIVE, "None"); + volume = Cvar_Get ("volume", "0.7", CVAR_ARCHIVE, "Volume level of sounds"); + loadas8bit = Cvar_Get ("loadas8bit", "0", CVAR_NONE, "Load samples as 8-bit"); + bgmvolume = Cvar_Get ("bgmvolume", "1", CVAR_ARCHIVE, "CD music volume"); } void diff --git a/source/sv_ccmds.c b/source/sv_ccmds.c index a265882..b972aea 100644 --- a/source/sv_ccmds.c +++ b/source/sv_ccmds.c @@ -875,7 +875,7 @@ SV_InitOperatorCommands (void) Cmd_AddCommand ("maplist", COM_Maplist_f); cl_warncmd = - Cvar_Get ("cl_warncmd", "1", CVAR_NONE, "dunno. equiv to sh -x?"); // FIXME + Cvar_Get ("cl_warncmd", "1", CVAR_NONE, "Toggles the display of error messages for unknown commands"); // poor // description } diff --git a/source/sv_main.c b/source/sv_main.c index 4babc04..3fdc2e4 100644 --- a/source/sv_main.c +++ b/source/sv_main.c @@ -1484,43 +1484,63 @@ SV_InitLocal (void) SV_UserInit (); - rcon_password = Cvar_Get ("rcon_password", "", CVAR_NONE, "None"); - password = Cvar_Get ("password", "", CVAR_NONE, "None"); - spectator_password = Cvar_Get ("spectator_password", "", CVAR_NONE, "None"); + rcon_password = Cvar_Get ("rcon_password", "", CVAR_NONE, "Set the password for rcon commands"); + password = Cvar_Get ("password", "", CVAR_NONE, "Set the server password for players"); + spectator_password = Cvar_Get ("spectator_password", "", CVAR_NONE, "Set the spectator password"); - sv_mintic = Cvar_Get ("sv_mintic", "0.03", CVAR_NONE, "None"); - sv_maxtic = Cvar_Get ("sv_maxtic", "0.1", CVAR_NONE, "None"); + sv_mintic = Cvar_Get ("sv_mintic", "0.03", CVAR_NONE, + "The minimum amount of time the server will wait before sending packets to a client. Set to .5 to make modem users happy"); + sv_maxtic = Cvar_Get ("sv_maxtic", "0.1", CVAR_NONE, + "The maximum amount of time in seconds before a client a receives an update from the server"); + fraglimit = Cvar_Get ("fraglimit", "0", CVAR_SERVERINFO, "Amount of frags a player must attain in order to exit the level"); + timelimit = Cvar_Get ("timelimit", "0", CVAR_SERVERINFO, + "Sets the amount of time in minutes that is needed before advancing to the next level"); + teamplay = Cvar_Get ("teamplay", "0", CVAR_SERVERINFO, + "Determines teamplay rules. 0 off, 1 You cannot hurt yourself nor your teammates, + 2 You can hurt yourself, your teammates, and you will lose one frag for killing a teammate + 3 You can hurt yourself but you cannot hurt your teammates"); + samelevel = Cvar_Get ("samelevel", "0", CVAR_SERVERINFO, + "Determines the rules for level changing and exiting. 0 Allows advancing to the next level, + 1 The same level will be played until someone exits, + 2 The same level will be played and the exit will kill anybody that tries to exit, + 3 The same level will be played and the exit will kill anybody that tries to exit, except on the Start map."); + maxclients = Cvar_Get ("maxclients", "8", CVAR_SERVERINFO, + "Sets how many clients can connect to your server, this includes spectators and players"); + maxspectators = Cvar_Get ("maxspectators", "8", CVAR_SERVERINFO, + "Sets how many spectators can connect to your server. The maxclients value takes precidence over this value so this + value should always be equal-to or less-then the maxclients value"); + hostname = Cvar_Get ("hostname", "unnamed", CVAR_SERVERINFO, "Report or sets the server name"); + deathmatch = Cvar_Get ("deathmatch", "1", CVAR_SERVERINFO, + "Sets the rules for weapon and item respawning. + 1 Does not leave weapons on the map. You can pickup weapons and items and they will respawn, + 2 Leaves weapons on the map. You can only pick up a weapon once. Picked up items will not respawn, + 3 Leaves weapons on the map. You can only pick up a weapon once. Picked up items will respawn."); + spawn = Cvar_Get ("spawn", "0", CVAR_SERVERINFO, "Spawn the player entity"); + watervis = Cvar_Get ("watervis", "0", CVAR_SERVERINFO, "Toggle the use of r_watervis by OpenGL clients"); - fraglimit = Cvar_Get ("fraglimit", "0", CVAR_SERVERINFO, "None"); - timelimit = Cvar_Get ("timelimit", "0", CVAR_SERVERINFO, "None"); - teamplay = Cvar_Get ("teamplay", "0", CVAR_SERVERINFO, "None"); - samelevel = Cvar_Get ("samelevel", "0", CVAR_SERVERINFO, "None"); - maxclients = Cvar_Get ("maxclients", "8", CVAR_SERVERINFO, "None"); - maxspectators = Cvar_Get ("maxspectators", "8", CVAR_SERVERINFO, "None"); - hostname = Cvar_Get ("hostname", "unnamed", CVAR_SERVERINFO, "None"); - deathmatch = Cvar_Get ("deathmatch", "1", CVAR_SERVERINFO, "None"); - spawn = Cvar_Get ("spawn", "0", CVAR_SERVERINFO, "None"); - watervis = Cvar_Get ("watervis", "0", CVAR_SERVERINFO, "None"); + developer = Cvar_Get ("developer", "0", CVAR_NONE, + "Toggle verbose output of server information. Useful for diagnosing problems and learning more about the server"); - developer = Cvar_Get ("developer", "0", CVAR_NONE, "None"); + timeout = Cvar_Get ("timeout", "65", CVAR_NONE, + "Sets the amount of time in seconds before a client is considered disconnected if the server does not receive a packet"); + zombietime = Cvar_Get ("zombietime", "2", CVAR_NONE, + "The number of minutes that the server will keep the character of a player on the map who seems to have disconnected"); - timeout = Cvar_Get ("timeout", "65", CVAR_NONE, "None"); - zombietime = Cvar_Get ("zombietime", "2", CVAR_NONE, "None"); - - sv_maxvelocity = Cvar_Get ("sv_maxvelocity", "2000", CVAR_NONE, "None"); - sv_gravity = Cvar_Get ("sv_gravity", "800", CVAR_NONE, "None"); - sv_stopspeed = Cvar_Get ("sv_stopspeed", "100", CVAR_NONE, "None"); - sv_maxspeed = Cvar_Get ("sv_maxspeed", "320", CVAR_NONE, "None"); + sv_maxvelocity = Cvar_Get ("sv_maxvelocity", "2000", CVAR_NONE, "Sets the maximum velocity an object can travel"); + sv_gravity = Cvar_Get ("sv_gravity", "800", CVAR_NONE, "Sets the global value for the amount of gravity"); + sv_stopspeed = Cvar_Get ("sv_stopspeed", "100", CVAR_NONE, + "Sets the value that determines how fast the player should come to a complete stop"); + sv_maxspeed = Cvar_Get ("sv_maxspeed", "320", CVAR_NONE, "Sets the maximum speed a player can move"); sv_spectatormaxspeed = - Cvar_Get ("sv_spectatormaxspeed", "500", CVAR_NONE, "None"); - sv_accelerate = Cvar_Get ("sv_accelerate", "10", CVAR_NONE, "None"); - sv_airaccelerate = Cvar_Get ("sv_airaccelerate", "0.7", CVAR_NONE, "None"); + Cvar_Get ("sv_spectatormaxspeed", "500", CVAR_NONE, "Sets the maximum speed a spectator can move"); + sv_accelerate = Cvar_Get ("sv_accelerate", "10", CVAR_NONE, "Sets the acceleration value for the players"); + sv_airaccelerate = Cvar_Get ("sv_airaccelerate", "0.7", CVAR_NONE, "Sets how quickly the players accelerate in air"); sv_wateraccelerate = - Cvar_Get ("sv_wateraccelerate", "10", CVAR_NONE, "None"); - sv_friction = Cvar_Get ("sv_friction", "4", CVAR_NONE, "None"); - sv_waterfriction = Cvar_Get ("sv_waterfriction", "4", CVAR_NONE, "None"); + Cvar_Get ("sv_wateraccelerate", "10", CVAR_NONE, "Sets the water acceleration value"); + sv_friction = Cvar_Get ("sv_friction", "4", CVAR_NONE, "Sets the friction value for the players"); + sv_waterfriction = Cvar_Get ("sv_waterfriction", "4", CVAR_NONE, "Sets the water friction value"); - sv_aim = Cvar_Get ("sv_aim", "2", CVAR_NONE, "None"); + sv_aim = Cvar_Get ("sv_aim", "2", CVAR_NONE, "Sets the value for auto-aiming leniency"); sv_timekick = Cvar_Get ("sv_timekick", "3", CVAR_SERVERINFO, "Time cheat protection"); @@ -1557,23 +1577,26 @@ SV_InitLocal (void) Cvar_Get ("sv_timefmt", "[%b %e %X] ", CVAR_NONE, "Time/date format to use"); - filterban = Cvar_Get ("filterban", "1", CVAR_NONE, "None"); + filterban = Cvar_Get ("filterban", "1", CVAR_NONE, + "Determines the rules for the IP list + 0 Only IP addresses on the Ban list will be allowed onto the server, + 1 Only IP addresses NOT on the Ban list will be allowed onto the server"); - allow_download = Cvar_Get ("allow_download", "1", CVAR_NONE, "None"); + allow_download = Cvar_Get ("allow_download", "1", CVAR_NONE, "Toggle if clients can download game data from the server"); allow_download_skins = - Cvar_Get ("allow_download_skins", "1", CVAR_NONE, "None"); + Cvar_Get ("allow_download_skins", "1", CVAR_NONE, "Toggle if clients can download skins from the server"); allow_download_models = - Cvar_Get ("allow_download_models", "1", CVAR_NONE, "None"); + Cvar_Get ("allow_download_models", "1", CVAR_NONE, "Toggle if clients can download models from the server"); allow_download_sounds = - Cvar_Get ("allow_download_sounds", "1", CVAR_NONE, "None"); + Cvar_Get ("allow_download_sounds", "1", CVAR_NONE, "Toggle if clients can download sounds from the server"); allow_download_maps = - Cvar_Get ("allow_download_maps", "1", CVAR_NONE, "None"); + Cvar_Get ("allow_download_maps", "1", CVAR_NONE, "Toggle if clients can download maps from the server"); - sv_highchars = Cvar_Get ("sv_highchars", "1", CVAR_NONE, "None"); + sv_highchars = Cvar_Get ("sv_highchars", "1", CVAR_NONE, "Toggle the use of high character color names for players"); - sv_phs = Cvar_Get ("sv_phs", "1", CVAR_NONE, "None"); + sv_phs = Cvar_Get ("sv_phs", "1", CVAR_NONE, "FIXME: Please document"); /* FIXME: Needs documentation */ - pausable = Cvar_Get ("pausable", "1", CVAR_NONE, "None"); + pausable = Cvar_Get ("pausable", "1", CVAR_NONE, "Toggle if server can be paused 1 is on, 0 is off"); // DoS protection Cmd_AddCommand ("netdosexpire", SV_netDoSexpire_f); diff --git a/source/sv_sys_unix.c b/source/sv_sys_unix.c index 13c0671..60ac3ce 100644 --- a/source/sv_sys_unix.c +++ b/source/sv_sys_unix.c @@ -149,8 +149,9 @@ is marked void Sys_Init_Cvars (void) { - sys_nostdout = Cvar_Get ("sys_nostdout", "0", CVAR_NONE, "None"); - sys_extrasleep = Cvar_Get ("sys_extrasleep", "0", CVAR_NONE, "None"); + sys_nostdout = Cvar_Get ("sys_nostdout", "0", CVAR_NONE, "Toggles console screen output"); + sys_extrasleep = Cvar_Get ("sys_extrasleep", "0", CVAR_NONE, + "Set to cause whatever amount delay in microseconds you want. Mostly useful to generate simulated bad connections."); sys_dead_sleep = Cvar_Get ("sys_dead_sleep", "1", CVAR_NONE, "When set, the server gets NO cpu if no clients are connected" "and there's no other activity. *MIGHT* cause problems with" diff --git a/source/sv_sys_win.c b/source/sv_sys_win.c index 2d99d30..8d999d2 100644 --- a/source/sv_sys_win.c +++ b/source/sv_sys_win.c @@ -156,8 +156,9 @@ is marked void Sys_Init_Cvars (void) { - sys_nostdout = Cvar_Get ("sys_nostdout", "0", CVAR_NONE, "None"); - sys_sleep = Cvar_Get ("sys_sleep", "8", CVAR_NONE, "None"); + sys_nostdout = Cvar_Get ("sys_nostdout", "0", CVAR_NONE, "Toggle console output"); + sys_sleep = Cvar_Get ("sys_sleep", "8", CVAR_NONE, + "Sleep how long in seconds between checking for connections. minimum is 0, maximum is 13"); } void diff --git a/source/sv_user.c b/source/sv_user.c index 4d92024..0d7ba7f 100644 --- a/source/sv_user.c +++ b/source/sv_user.c @@ -1810,8 +1810,9 @@ SV_UserInit void SV_UserInit (void) { - cl_rollspeed = Cvar_Get ("cl_rollspeed", "200", CVAR_NONE, "None"); - cl_rollangle = Cvar_Get ("cl_rollangle", "2", CVAR_NONE, "None"); - sv_spectalk = Cvar_Get ("sv_spectalk", "1", CVAR_NONE, "None"); - sv_mapcheck = Cvar_Get ("sv_mapcheck", "1", CVAR_NONE, "None"); + cl_rollspeed = Cvar_Get ("cl_rollspeed", "200", CVAR_NONE, "How quickly a player straightens out after strafing"); + cl_rollangle = Cvar_Get ("cl_rollangle", "2", CVAR_NONE, "How much a player's screen tilts when strafing"); + sv_spectalk = Cvar_Get ("sv_spectalk", "1", CVAR_NONE, "Toggles the ability of spectators to talk to players"); + sv_mapcheck = Cvar_Get ("sv_mapcheck", "1", CVAR_NONE, + "Toggle the use of map checksumming to check for players who edit maps to cheat"); } diff --git a/source/teamplay.c b/source/teamplay.c index ba0682a..2ebfe2c 100644 --- a/source/teamplay.c +++ b/source/teamplay.c @@ -337,7 +337,7 @@ Team_Init_Cvars (void) Cvar_Get ("cl_deadbodyfilter", "0", CVAR_NONE, "Hide dead player models"); cl_gibfilter = Cvar_Get ("cl_gibfilter", "0", CVAR_NONE, "Hide gibs"); - cl_parsesay = Cvar_Get ("cl_parsesay", "0", CVAR_NONE, "None"); + cl_parsesay = Cvar_Get ("cl_parsesay", "0", CVAR_NONE, "Use .loc files to find your present location when you put %l in messages"); cl_nofake = Cvar_Get ("cl_nofake", "0", CVAR_NONE, "Unhide fake messages"); } diff --git a/source/vid_ggi.c b/source/vid_ggi.c index 1d2fe8b..7e66de6 100644 --- a/source/vid_ggi.c +++ b/source/vid_ggi.c @@ -1069,8 +1069,8 @@ IN_Init_Cvars (void) { JOY_Init_Cvars (); - _windowed_mouse = Cvar_Get ("_windowed_mouse", "0", CVAR_ARCHIVE, "None"); - m_filter = Cvar_Get ("m_filter", "0", CVAR_ARCHIVE, "None"); + _windowed_mouse = Cvar_Get ("_windowed_mouse", "0", CVAR_ARCHIVE, "Have Quake grab the mouse from X when you play"); + m_filter = Cvar_Get ("m_filter", "0", CVAR_ARCHIVE, "Mouse input filtering"); } diff --git a/source/vid_mgl.c b/source/vid_mgl.c index 75b2911..34a7ec5 100644 --- a/source/vid_mgl.c +++ b/source/vid_mgl.c @@ -2113,21 +2113,21 @@ VID_Init (unsigned char *palette) void VID_Init_Cvars () { - vid_mode = Cvar_Get ("vid_mode", "0", CVAR_NONE, "None"); - vid_nopageflip = Cvar_Get ("vid_nopageflip", "0", CVAR_ARCHIVE, "None"); + vid_mode = Cvar_Get ("vid_mode", "0", CVAR_NONE, "Set the video mode"); + vid_nopageflip = Cvar_Get ("vid_nopageflip", "0", CVAR_ARCHIVE, "Toggles the use of page flipping"); _vid_default_mode_win = - Cvar_Get ("_vid_default_mode_win", "3", CVAR_ARCHIVE, "None"); - vid_config_x = Cvar_Get ("vid_config_x", "800", CVAR_ARCHIVE, "None"); - vid_config_y = Cvar_Get ("vid_config_y", "600", CVAR_ARCHIVE, "None"); - vid_stretch_by_2 = Cvar_Get ("vid_stretch_by_2", "1", CVAR_ARCHIVE, "None"); - _windowed_mouse = Cvar_Get ("_windowed_mouse", "0", CVAR_ARCHIVE, "None"); + Cvar_Get ("_vid_default_mode_win", "3", CVAR_ARCHIVE, "Default windowed video mode"); + vid_config_x = Cvar_Get ("vid_config_x", "800", CVAR_ARCHIVE, "Maximum x-axis screen size"); + vid_config_y = Cvar_Get ("vid_config_y", "600", CVAR_ARCHIVE, "Maximum y-axis screen size"); + vid_stretch_by_2 = Cvar_Get ("vid_stretch_by_2", "1", CVAR_ARCHIVE, "Stretch the pixles by a two fold to acheive proper view"); + _windowed_mouse = Cvar_Get ("_windowed_mouse", "0", CVAR_ARCHIVE, "Have quake grab the mouse from X when you play"); vid_fullscreen_mode = - Cvar_Get ("vid_fullscreen_mode", "3", CVAR_ARCHIVE, "None"); + Cvar_Get ("vid_fullscreen_mode", "3", CVAR_ARCHIVE, "Set the full screen video mode."); vid_windowed_mode = - Cvar_Get ("vid_windowed_mode", "0", CVAR_ARCHIVE, "None"); - block_switch = Cvar_Get ("block_switch", "0", CVAR_ARCHIVE, "None"); - vid_window_x = Cvar_Get ("vid_window_x", "0", CVAR_ARCHIVE, "None"); - vid_window_y = Cvar_Get ("vid_window_y", "0", CVAR_ARCHIVE, "None"); + Cvar_Get ("vid_windowed_mode", "0", CVAR_ARCHIVE, "Set the windowed video mode"); + block_switch = Cvar_Get ("block_switch", "0", CVAR_ARCHIVE, "If set, won't allow you to task switch while playing"); + vid_window_x = Cvar_Get ("vid_window_x", "0", CVAR_ARCHIVE, "The x-axis location of the window, if windowed"); + vid_window_y = Cvar_Get ("vid_window_y", "0", CVAR_ARCHIVE, "The y-axis location of the window, if windowed"); } diff --git a/source/vid_sgl.c b/source/vid_sgl.c index 1cb6be8..cd636b5 100644 --- a/source/vid_sgl.c +++ b/source/vid_sgl.c @@ -224,7 +224,7 @@ VID_Init (unsigned char *palette) void VID_Init_Cvars () { - vid_fullscreen = Cvar_Get ("vid_fullscreen", "0", 0, "None"); + vid_fullscreen = Cvar_Get ("vid_fullscreen", "0", CVAR_ROM, "Toggles fullscreen mode"); } void diff --git a/source/vid_svgalib.c b/source/vid_svgalib.c index e82f3f9..886a394 100644 --- a/source/vid_svgalib.c +++ b/source/vid_svgalib.c @@ -609,10 +609,10 @@ VID_Init (unsigned char *palette) void VID_Init_Cvars () { - vid_mode = Cvar_Get ("vid_mode", "5", 0, "None"); - vid_redrawfull = Cvar_Get ("vid_redrawfull", "0", 0, "None"); + vid_mode = Cvar_Get ("vid_mode", "5", CVAR_NONE, "Sets the video mode"); + vid_redrawfull = Cvar_Get ("vid_redrawfull", "0", CVAR_NONE, "Redraw entire screen each frame instead of just dirty areas"); vid_waitforrefresh = Cvar_Get ("vid_waitforrefresh", "0", - CVAR_ARCHIVE, "None"); + CVAR_ARCHIVE, "Wait for vertical retrace before drawing next frame"); } diff --git a/source/vid_wgl.c b/source/vid_wgl.c index 167f7ef..4cb1cf1 100644 --- a/source/vid_wgl.c +++ b/source/vid_wgl.c @@ -1764,7 +1764,7 @@ VID_Init (unsigned char *palette) void VID_Init_Cvars () { - _windowed_mouse = Cvar_Get ("_windowed_mouse", "0", CVAR_ARCHIVE, "None"); + _windowed_mouse = Cvar_Get ("_windowed_mouse", "0", CVAR_ARCHIVE, "Grab the mouse from X while playing quake"); }