-
Notifications
You must be signed in to change notification settings - Fork 157
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
CVARS: Describe as much CVARS as possible. #188
Comments
23.10.2022 - EDIT: list edited to represent latest changes to some descriptions (ec-): f3c7c3e |
sv_gametype isn't a cvar anywhere in the code. You must be careful to avoid looking at the code variable names and look at the string name 🥲
|
Should avoid including the default values in the description strings as the default value is displayed with the current value when looking up the help text. |
Good point! Saved! I'll wait a bit, just in case you find more points, or ec will change ... |
Fixed all know issues at this moment |
Thank you so much @ec. I will leave the issue open for a while, if that is okay to you. Just in case other people want to complain/make suggestions etc. Though, feel free to close it, if this is better for you. |
LMAO, why are you keep referencing wrong person (ec but not ec-) ? |
@ec- OMG 🤦♂️ |
@KuehnhammerTobias You may wish to check through the following: There may also be some which were not included in this commit that I already wrote in, in surrounding code blocks too. |
@ensiform |
Complete almost all CVAR descriptions.
There is an opportunity to describe what each CVAR does (by typing the name of the CVAR into your console). Only a few CVARS are currently described. I made a pull request adding descriptions to as many CVARS as possible. By using the already existing function: Cvar_SetDescription.
The real problem is that there are roughly 3 'types' of undescribed CVARs:
For 'type 2' CVARS I choose the descriptions from here: https://www.quakearea.com/blog/q3-cvars&cmds.html (I think those are the most original descriptions) or if those are obviously outdated or wrong, I additionaly use the descriptions from here: https://www.excessiveplus.net/forums/thread/commandcvar-list-of-e-quake?page=1
Even using those sites, I had to search a lot to find some information for CVARS that were still not described at all.
Finally I took some describtions from @themuffinator and his Q3e fork https://github.com/themuffinator/dm-engine
Since his dm-engine is forked from Q3e, the CVAR descriptions are more accurate I think.
Well, there are still the 'type 3' CVARS, cvars I didn't find any description at all. Due to my lack of knowledge I don't understand what they are made for (when looking at the code). Some are dysfunctional as it seems.
The only thing I could do was list them separately. Of course not within the code. I have created a small list (see below) where it is marked which CVARS I have not added a description to.
Anyways, here is the pull request: https://github.com/ec-/Quake3e/pull/189
You really should check this PR twice before using it.
The reason why more people should check the descriptions is that:
Notes:
The CVAR list:
One possible workflow would be that we could tick it if anyone has a description for the missing CVARS, so I've included the list below. In addition, the descriptions are easier to read.
Description added:
No description found (TODO):
The text was updated successfully, but these errors were encountered: