Skip to content

Commit

Permalink
HELP: updates from JSON generator and assorted cleanups
Browse files Browse the repository at this point in the history
- Refreshed alphabetical sorting of sections and keys for easier merging over time, keeping maintainers happy.
- The JSON generator is apparently case sensitive -> made HUD262 command descriptions lowercase so it doesn't introduce duplicates.
- Updated defaults in JSON from code:
cl_chunksperframe 5 -> 30
cl_demoplay_flash gets its 0.33 back
joy* stuff defaults were missing
r_fx_fog_density 0.002 -> 0.125
scr_cursor_iconoffset_x 10 -> 0
scr_teaminfo_show_countdown 0 -> 1
vid_grab_keyboard 1->0
vid_win_borderless did not mention its default value
- System-generated placeholders for dateiso, fs_savegame_home, vid_reload, vid_reload_auto (to be described)
- Updated some default cvar values according to actual behaviour: v_dlightcolor, v_dlightcshift, cl_bonusflash are actually used as bool/ints (no need to suggest a float value).
- Cleaned up *palette* spelling
- Fixed some grammar here and there
- Removed references to default values that aren't adding meaning to descriptions; ezq repeats defaults anyway.
- Same with some "on/off" descriptions adding nothing
- Simplified s_khz/s_linearresample. The latter is what actually gives perfect quality over s_khz, so made that clearer.
- s_linearresample_stream actually used in speex (VOIP) decoding, giving it a little description.
- rl_bloodcolor : r_explosiontype, not cl_
- r_skyname: help text does not use a "comments" field -> fixed to "remarks"
- Moved s_mixahead to legacy group.

- Moved some "descriptions" from "on/off" values to main desc (that's what it's for if that's all you'll write)
cl_filterdrawviewmodel
cl_model_bobbing
cl_smartjump
log_readable
s_swapstereo
scr_centermenu
scr_centerbar
scr_spectatorMessage
tp_forcetriggers
tp_loadlocs
tp_msgtriggers
- Reworded
log_readable
scr_centerbar
- Removed old descriptions for LegacyCommands (help automatically redirects to the description for the new cvar)
gl_smoothfont -> r_smoothtext
scr_printspeed -> scr_centerspeed
  • Loading branch information
hemostx committed Nov 7, 2023
1 parent 6a9d96e commit 2aa4f84
Show file tree
Hide file tree
Showing 4 changed files with 406 additions and 523 deletions.
43 changes: 23 additions & 20 deletions help_commands.json
Original file line number Diff line number Diff line change
Expand Up @@ -253,13 +253,13 @@
"bind": {
"description": "This command binds one or several commands to a key.\nTo bind multiple commands to a key, enclose the commands in double-quotes (\") and separate them with semicolons (;)."
},
"bindlist": {
"description": "Prints all binds."
},
"bindedit": {
"description": "Allows you to edit your bind in the console.",
"syntax": "<key>"
},
"bindlist": {
"description": "Prints all binds."
},
"calc_fov": {
"arguments": [
{
Expand Down Expand Up @@ -338,6 +338,9 @@
"clearlocs": {
"description": "Clear all currently loaded locs."
},
"clipboard": {
"description": "Copies all the following arguments to the system clipboard"
},
"cmd": {
"description": "Sends a command directly to the server."
},
Expand Down Expand Up @@ -673,7 +676,7 @@
"hide": {
"system-generated": true
},
"HUD262_add": {
"hud262_add": {
"arguments": [
{
"description": "Can be cvar or str",
Expand All @@ -687,7 +690,7 @@
"description": "Creates or changes a HUD element with hud_name.\nThe following types of HUD elements are available:\ncvar - a value of a variable is displayed; in this case param must be a name of this variable.\nstr - a string defined by param is displayed\nCvar and %macros expansion is performed every time element is shown.",
"syntax": "<hud_name> <type> <param>"
},
"HUD262_alpha": {
"hud262_alpha": {
"arguments": [
{
"description": "HUD element's name",
Expand All @@ -701,7 +704,7 @@
"description": "Sets a transparency for strings-HUD element.",
"syntax": "<name> <value>"
},
"HUD262_bg": {
"hud262_bg": {
"arguments": [
{
"description": "HUD element's name",
Expand All @@ -715,7 +718,7 @@
"description": "Defines a color of the HUD element background.\n0 - transparent (default).",
"syntax": "<hud_name> <bg_color>"
},
"HUD262_blink": {
"hud262_blink": {
"arguments": [
{
"description": "HUD element's name",
Expand All @@ -733,7 +736,7 @@
"description": "Allows to make blinking strings-HUD elements.",
"syntax": "<name> <period> <mask>"
},
"HUD262_bringtofront": {
"hud262_bringtofront": {
"arguments": [
{
"description": "HUD element's name",
Expand All @@ -743,7 +746,7 @@
"description": "Transfers all HUD elements created after hud_name element (including) to the end of drawing list, that in short means that they will be displayed above all other elements which could be present on that place already.",
"syntax": "<name>"
},
"HUD262_disable": {
"hud262_disable": {
"arguments": [
{
"description": "HUD element's name",
Expand All @@ -753,7 +756,7 @@
"description": "Prohibits to display one or more HUD elements.",
"syntax": "<hud_name> [hud_name2...]"
},
"HUD262_enable": {
"hud262_enable": {
"arguments": [
{
"description": "HUD element's name",
Expand All @@ -763,7 +766,7 @@
"description": "Allows to display one or more HUD elements.",
"syntax": "<hud_name> [hud_name2...]"
},
"HUD262_list": {
"hud262_list": {
"arguments": [
{
"description": "Print only [regexp] matching HUDs",
Expand All @@ -773,7 +776,7 @@
"description": "Prints a list of strings-HUD elements.",
"syntax": "[regexp]"
},
"HUD262_move": {
"hud262_move": {
"arguments": [
{
"description": "HUD element's name",
Expand All @@ -791,7 +794,7 @@
"description": "Moves a HUD element.\ndx and dy deviations are measured in symbols.",
"syntax": "<hud_name> <dx> <dy>"
},
"HUD262_position": {
"hud262_position": {
"arguments": [
{
"description": "Name of your HUD element",
Expand All @@ -813,7 +816,7 @@
"description": "Indicates position of a HUD element on the screen.",
"syntax": "<hud_name> <pos> <x> <y>"
},
"HUD262_remove": {
"hud262_remove": {
"arguments": [
{
"description": "HUD element's name",
Expand All @@ -823,7 +826,7 @@
"description": "Kills a HUD element.",
"syntax": "<hud_name>"
},
"HUD262_width": {
"hud262_width": {
"arguments": [
{
"description": "HUD element's name",
Expand Down Expand Up @@ -1829,7 +1832,7 @@
"toggleconsole": {
"description": "Brings the console up and down."
},
"toggleHUD": {
"togglehud": {
"system-generated": true
},
"togglemenu": {
Expand Down Expand Up @@ -2049,6 +2052,9 @@
"vid_modelist": {
"description": "Prints all supported video modes."
},
"vid_reload": {
"system-generated": true
},
"vid_restart": {
"description": "Will restart your video renderer. Needed for some changes to take affect."
},
Expand Down Expand Up @@ -2086,10 +2092,7 @@
"writeip": {
"description": "Records all IP addresses on the server IP list. The file name is listip.cfg."
},
"clipboard": {
"description": "Copies all the following arguments to the system clipboard"
},
"z_ext_list": {
"system-generated": true
}
}
}
6 changes: 5 additions & 1 deletion help_macros.json
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,10 @@
"teamplay-restricted": true,
"type": "string"
},
"dateiso": {
"system-generated": true,
"teamplay-restricted": true
},
"deathloc": {
"flags": [
"incomplete"
Expand Down Expand Up @@ -423,4 +427,4 @@
],
"teamplay-restricted": false
}
}
}
Loading

0 comments on commit 2aa4f84

Please sign in to comment.