Add documentation for undocumented cvars (game.cfg / README) - #1187
Open
Nord1cWarr1or wants to merge 1 commit into
Open
Add documentation for undocumented cvars (game.cfg / README)#1187Nord1cWarr1or wants to merge 1 commit into
Nord1cWarr1or wants to merge 1 commit into
Conversation
- mp_chat_loc_fallback: own entry next to mp_location_area_info (previously mentioned only as a NOTE inside its description) - mp_logkills: present in README but was missing from game.cfg - bot_mimic / bot_mimic_yaw_offset: REGAMEDLL_ADD debug cvars, never documented anywhere - hostage_debug / hostage_stop: improved CZ hostage AI debug cvars, never documented anywhere (require hostage_ai_enable 1)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Systematic comparison of all cvar definitions in the codebase (
dlls/game.cpp,bot/cs_bot_init.cpp,hostage/hostage.cpp,tutor.cpp,voice_gamemgr.cpp) againstREADME.md,dist/game.cfganddist/game_init.cfgrevealed several cvars missing from the documentation:mp_chat_loc_fallback— had no own entry anywhere; was only mentioned inside the NOTE ofmp_location_area_info. Added a standalone block next to it in game.cfg and a table row in README.mp_logkills— documented in README but missing fromdist/game.cfg.bot_mimic/bot_mimic_yaw_offset— REGAMEDLL_ADD debug cvars (registered inBot_RegisterCVars()under#ifdef REGAMEDLL_ADD), never documented anywhere.hostage_debug/hostage_stop— debug cvars for improved CZ hostage AI, never documented anywhere. Noted that they requirehostage_ai_enable 1.Not included:
game_version(informational cvar, intentionally left undocumented).Both files updated in the existing documentation style. No code changes.