ec- / Quake3e

Improved Quake III Arena engine
GNU General Public License v2.0
1.22k stars 153 forks source link

CVARS: Describe as much CVARS as possible. #188

Open ghost opened 2 years ago

ghost commented 2 years ago

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:

  1. CVARS that are easy to describe and check.
  2. CVARS whose description is incorrect or unclear.
  3. CVARS for which I have not found any description at all.

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:

Description added:

No description found (TODO):

ghost commented 2 years ago

23.10.2022 - EDIT: list edited to represent latest changes to some descriptions (ec-): https://github.com/ec-/Quake3e/commit/f3c7c3e4a8c3ac34e50f2af27f013ac7315d07b9 24.10.2022 - EDIT: list edited to represent latest changes to some descriptions (default case - ensiform): https://github.com/ec-/Quake3e/commit/10c975a8ad7ebae340f1a878f447302866c140f0 30.10.2022 - EDIT: list edited to represent latest changes to some descriptions (cl_nodelta - ensiform): https://github.com/ec-/Quake3e/commit/6fe4ff1808a071acfa88acac2362fb1932b3da17 02.11.2022 - EDIT: list edited to represent latest changes to some descriptions (ensiform - ztm - ec-): https://github.com/ec-/Quake3e/commit/fb9f72713ed3a22b677ad221f017ef6be818e19d https://github.com/ec-/Quake3e/commit/726c1eb3aceeffeb381bd0f26fe36fc8c8452fc1 28.04.2022 - EDIT: list edited to represent latest changes to some descriptions. 01.08.2023 - EDIT: list edited to represent recent changes (Calinou): https://github.com/ec-/Quake3e/commit/8bfb53fc565795eb1afa9b90f3ebc9426f5d1764

ghost commented 2 years ago

@ec No description for sv_gametype? Please talk to @ensiform

ensiform commented 2 years ago

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 🥲

cvar_t *blah = Cvar_Get("g_gametype"....) is still just g_gametype

ensiform commented 2 years ago

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.

ghost commented 2 years ago

Good point! Saved! I'll wait a bit, just in case you find more points, or ec will change ...

ec- commented 2 years ago

Fixed all know issues at this moment

ghost commented 2 years ago

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.

ec- commented 2 years ago

LMAO, why are you keep referencing wrong person (ec but not ec-) ?

ghost commented 2 years ago

@ec- OMG :man_facepalming:

ensiform commented 2 years ago

@KuehnhammerTobias

You may wish to check through the following: https://github.com/etfdevs/ETe/commit/ddbbf49ad3ce0002877e4d28b350548ddfd32e8c and, https://github.com/etfdevs/ETe/commit/3ee5cc942b8a22363d5efbc2a87e26ddbf715ad2

There may also be some which were not included in this commit that I already wrote in, in surrounding code blocks too.

ghost commented 2 years ago

@ensiform Thanks for the tip and thanks for fixing the cl_nodelta description! I'm currently doing a new PR with descriptions that you pointed out (ETe).