1
0
Fork 0
forked from fte/fteqw

Add more descriptions for CVARs (#201)

* Add more descriptions for CVARs

* Fixed a small typo

* Another small typo

* Added the suggestions from @Shpoike and @eukara along with a little more cleanup
This commit is contained in:
Xylemon 2023-07-29 17:04:47 -07:00 committed by GitHub
parent 5f389d7fbc
commit 25f1915fbf
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 28 additions and 28 deletions

View file

@ -1034,9 +1034,9 @@ void Renderer_Init(void)
// misc // misc
Cvar_Register(&con_ocranaleds, "Console controls"); Cvar_Register(&con_ocranaleds, "Console controls");
Cmd_AddCommand ("listfonts", R_ListFonts_f); Cmd_AddCommandD ("listfonts", R_ListFonts_f, "Displays a list of every installed font.");
Cmd_AddCommand ("listskins", R_ListSkins_f); Cmd_AddCommandD ("listskins", R_ListSkins_f, "Displays a list of every installed or downloaded QuakeWorld player skin.");
Cmd_AddCommand ("listconfigs", R_ListConfigs_f); Cmd_AddCommandD ("listconfigs", R_ListConfigs_f, "Displays a list of every installed config file.");
R_Sky_Register(); R_Sky_Register();

View file

@ -1346,8 +1346,8 @@ void R_Sky_Register(void)
Cvar_Register (&r_skybox_orientation, groupname); Cvar_Register (&r_skybox_orientation, groupname);
Cvar_Register (&gl_skyboxdist, groupname); Cvar_Register (&gl_skyboxdist, groupname);
Cmd_AddCommandAD("sky", R_ForceSky_f, R_ForceSky_c, "For compat with Quakespasm"); //QS compat Cmd_AddCommandAD("sky", R_ForceSky_f, R_ForceSky_c, "For compat with Quakespasm, please use r_skybox."); //QS compat
Cmd_AddCommandAD("loadsky", R_ForceSky_f, R_ForceSky_c, "For compat with DP"); Cmd_AddCommandAD("loadsky", R_ForceSky_f, R_ForceSky_c, "For compat with DarkPlaces, please use r_skybox.");
Cmd_AddCommand ("listskyboxes", R_ListSkyBoxes_f); Cmd_AddCommandD ("listskyboxes", R_ListSkyBoxes_f, "Displays a list of available custom skyboxes that can be set with r_skybox, type or click an entry.");
} }
#endif #endif

View file

@ -3392,19 +3392,19 @@ void SV_InitOperatorCommands (void)
if (isDedicated) if (isDedicated)
#endif #endif
{ {
Cmd_AddCommand ("quit", SV_Quit_f); Cmd_AddCommandD ("quit", SV_Quit_f, "Exits the engine back to desktop.");
Cmd_AddCommand ("say", SV_ConSay_f); Cmd_AddCommandD ("say", SV_ConSay_f, "Send a chat message to everyone on the server.");
Cmd_AddCommand ("sayone", SV_ConSayOne_f); Cmd_AddCommand ("sayone", SV_ConSayOne_f);
Cmd_AddCommand ("tell", SV_ConSayOne_f); Cmd_AddCommand ("tell", SV_ConSayOne_f);
Cmd_AddCommand ("serverinfo", SV_Serverinfo_f); //commands that conflict with client commands. Cmd_AddCommand ("serverinfo", SV_Serverinfo_f); //commands that conflict with client commands.
Cmd_AddCommand ("serverinfoblob", SV_Serverinfo_f); //commands that conflict with client commands. Cmd_AddCommand ("serverinfoblob", SV_Serverinfo_f); //commands that conflict with client commands.
Cmd_AddCommand ("user", SV_User_f); Cmd_AddCommand ("user", SV_User_f);
Cmd_AddCommand ("god", SV_God_f); Cmd_AddCommandD ("god", SV_God_f, "Makes you immune to damage.");
#ifdef QUAKESTATS #ifdef QUAKESTATS
Cmd_AddCommand ("give", SV_Give_f); Cmd_AddCommand ("give", SV_Give_f);
#endif #endif
Cmd_AddCommand ("noclip", SV_Noclip_f); Cmd_AddCommandD ("noclip", SV_Noclip_f, "Disables clipping, allowing you to fly through the level.");
Cmd_AddCommand ("download", SV_Download_f); Cmd_AddCommand ("download", SV_Download_f);
} }
@ -3425,27 +3425,27 @@ void SV_InitOperatorCommands (void)
Cmd_AddCommand ("snapall", SV_SnapAll_f); Cmd_AddCommand ("snapall", SV_SnapAll_f);
//various punishments //various punishments
Cmd_AddCommand ("kick", SV_Kick_f); Cmd_AddCommandD ("kick", SV_Kick_f, "Removes a player from the server, provide the name or IP of the desired player.");
Cmd_AddCommand ("clientkick", SV_KickSlot_f); Cmd_AddCommand ("clientkick", SV_KickSlot_f);
Cmd_AddCommand ("renameclient", SV_ForceName_f); Cmd_AddCommand ("renameclient", SV_ForceName_f);
Cmd_AddCommandD ("mute", SV_Mute_f, "Mutes the player, shaming them."); Cmd_AddCommandD ("mute", SV_Mute_f, "Mutes the player (no voice or chat), shaming them.");
Cmd_AddCommandD ("stealthmute", SV_StealthMute_f, "Mutes the player, without telling them, while pretending that their messages are still being broadcast. For use against people that would escalate on expiry or externally."); Cmd_AddCommandD ("stealthmute", SV_StealthMute_f, "Mutes the player, without telling them, while pretending that their messages are still being broadcast. For use against people that would escalate on expiry or externally.");
Cmd_AddCommandD ("cuff", SV_Cuff_f, "Slap handcuffs on the player, preventing them from being able to attack."); Cmd_AddCommandD ("cuff", SV_Cuff_f, "Slap handcuffs on the player, preventing them from being able to attack.");
Cmd_AddCommandD ("cripple", SV_CripplePlayer_f, "Block the player's ability to move."); Cmd_AddCommandD ("cripple", SV_CripplePlayer_f, "Block the player's ability to move.");
Cmd_AddCommandD ("ban", SV_BanClientIP_f, "Block the player's IP, preventing them from connecting. Also kicks them."); Cmd_AddCommandD ("ban", SV_BanClientIP_f, "Block the player's IP, preventing them from connecting. Also kicks them.");
Cmd_AddCommand ("banname", SV_BanClientIP_f); //legacy dupe-name crap Cmd_AddCommandD ("banname", SV_BanClientIP_f, "Legacy compat, please use ban."); //legacy dupe-name cruft
Cmd_AddCommand ("banlist", SV_BanList_f); //shows only bans, not other penalties Cmd_AddCommandD ("banlist", SV_BanList_f, "Displays a list of every banned player on the server."); //shows only bans, not other penalties
Cmd_AddCommand ("unban", SV_Unfilter_f); //merely renamed. Cmd_AddCommandD ("unban", SV_Unfilter_f, "Unbans or removes an IP Address from the penality list, alias to removeip."); //merely renamed.
Cmd_AddCommand ("addip", SV_FilterIP_f); Cmd_AddCommand ("addip", SV_FilterIP_f);
Cmd_AddCommand ("removeip", SV_Unfilter_f); Cmd_AddCommandD ("removeip", SV_Unfilter_f, "Removes an IP Address from the penality list.");
Cmd_AddCommand ("listip", SV_FilterList_f); //shows all penalties Cmd_AddCommandD ("listip", SV_FilterList_f, "Displays a list of ever player the server has penalties for."); //shows all penalties
Cmd_AddCommand ("writeip", SV_WriteIP_f); Cmd_AddCommand ("writeip", SV_WriteIP_f);
Cmd_AddCommand ("floodprot", SV_Floodprot_f); Cmd_AddCommand ("floodprot", SV_Floodprot_f);
Cmd_AddCommand ("status", SV_Status_f); Cmd_AddCommandD ("status", SV_Status_f, "Prints info about the current server.");
Cmd_AddCommand ("sv", SV_SendGameCommand_f); Cmd_AddCommand ("sv", SV_SendGameCommand_f);
Cmd_AddCommand ("mod", SV_SendGameCommand_f); Cmd_AddCommand ("mod", SV_SendGameCommand_f);
@ -3457,19 +3457,19 @@ void SV_InitOperatorCommands (void)
#endif #endif
Cmd_AddCommand ("killserver", SV_KillServer_f); Cmd_AddCommand ("killserver", SV_KillServer_f);
Cmd_AddCommandD ("precaches", SV_PrecacheList_f, "Displays a list of current server precaches."); Cmd_AddCommandD ("precaches", SV_PrecacheList_f, "Displays a list of current server precaches.");
Cmd_AddCommandAD ("map", SV_Map_f, SV_Map_c, "Changes map. If a second argument is specified then that is normally the name of the initial start spot."); Cmd_AddCommandAD ("map", SV_Map_f, SV_Map_c, "Begins a new game on the specified map.");
Cmd_AddCommandAD ("mapedit", SV_Map_f, SV_Map_c, "Loads the named map without any gamecode active."); Cmd_AddCommandAD ("mapedit", SV_Map_f, SV_Map_c, "Loads the named map without any gamecode active.");
#ifdef Q3SERVER #ifdef Q3SERVER
Cmd_AddCommandAD ("spmap", SV_Map_f, SV_Map_c, NULL); Cmd_AddCommandAD ("spmap", SV_Map_f, SV_Map_c, "Loads a map in single-player mode, for Quake III compat.");
Cmd_AddCommandAD ("spdevmap", SV_Map_f, SV_Map_c, NULL); Cmd_AddCommandAD ("spdevmap", SV_Map_f, SV_Map_c, "Loads a map in single-player developer mode (sv_cheats 1), for Quake III compat.");
Cmd_AddCommandAD ("devmap", SV_Map_f, SV_Map_c, NULL); Cmd_AddCommandAD ("devmap", SV_Map_f, SV_Map_c, "Loads a map in developer mode (sv_cheats 1), for Quake III compat.");
#endif #endif
Cmd_AddCommandAD ("gamemap", SV_Map_f, SV_Map_c, NULL); Cmd_AddCommandAD ("gamemap", SV_Map_f, SV_Map_c, NULL);
Cmd_AddCommandAD ("changelevel", SV_Map_f, SV_Map_c, NULL); Cmd_AddCommandAD ("changelevel", SV_Map_f, SV_Map_c, "Continues the game on a different map. The current map can be reentered later when a starting position for the new map is specified as a second argument.");
Cmd_AddCommandD ("map_restart", SV_Map_f, NULL); //from q3. Cmd_AddCommandD ("map_restart", SV_Map_f, "Restarts the server and reloads the map while flushing level cache, for general use and Quake III compat."); //from q3.
Cmd_AddCommand ("listmaps", SV_MapList_f); Cmd_AddCommandD ("listmaps", SV_MapList_f, "Displays a list of installed maps.");
Cmd_AddCommand ("maplist", SV_MapList_f); Cmd_AddCommandD ("maplist", SV_MapList_f, "Displays a list of installed maps.");
Cmd_AddCommand ("maps", SV_MapList_f); Cmd_AddCommandD ("maps", SV_MapList_f, "Displays a list of installed maps.");
#if defined(HAVE_LEGACY) && defined(HAVE_SERVER) #if defined(HAVE_LEGACY) && defined(HAVE_SERVER)
Cmd_AddCommandD ("check_maps", SV_redundantcommand_f, "Obsolete, specific to ktpro. Modern mods should use search_begin instead."); Cmd_AddCommandD ("check_maps", SV_redundantcommand_f, "Obsolete, specific to ktpro. Modern mods should use search_begin instead.");
Cmd_AddCommandD ("sys_select_timeout", SV_redundantcommand_f, "Redundant - server will throttle according to tick rates instead."); Cmd_AddCommandD ("sys_select_timeout", SV_redundantcommand_f, "Redundant - server will throttle according to tick rates instead.");
@ -3481,7 +3481,7 @@ void SV_InitOperatorCommands (void)
Cmd_AddCommandD ("sv_progtype", SV_redundantcommand_f, "Use sv_progs instead. Using to block .dll loading is insufficient with buggy clients around."); Cmd_AddCommandD ("sv_progtype", SV_redundantcommand_f, "Use sv_progs instead. Using to block .dll loading is insufficient with buggy clients around.");
#endif #endif
Cmd_AddCommand ("heartbeat", SV_Heartbeat_f); Cmd_AddCommandD ("heartbeat", SV_Heartbeat_f, "Sends an update or ping to the master server so the current server can remain listed.");
Cmd_AddCommand ("localinfo", SV_Localinfo_f); Cmd_AddCommand ("localinfo", SV_Localinfo_f);
Cmd_AddCommandAD ("gamedir", SV_Gamedir_f, SV_Gamedir_c, "Change the current gamedir."); Cmd_AddCommandAD ("gamedir", SV_Gamedir_f, SV_Gamedir_c, "Change the current gamedir.");