]> de.git.xonotic.org Git - xonotic/xonotic-data.pk3dir.git/blob - _hud_common.cfg
Improve description of a few cvars
[xonotic/xonotic-data.pk3dir.git] / _hud_common.cfg
1 // hud variables
2 set _hud_configure 0 "1 = configure the HUD"
3 seta hud_configure_teamcolorforced 0 "1 = force display of team colors in configure mode"
4 seta hud_configure_checkcollisions 0 "check for collisions against other panels when in hud configure mode"
5 seta hud_configure_bg_minalpha 0.25 "minimum panel background alpha when in hud configure mode"
6 seta hud_configure_grid_alpha 0.15 "alpha for visible grid when in configure mode"
7
8 seta hud_cursormode 1 "handle mouse input in cursor mode when CSQC displays a cursor"
9
10 seta hud_fontsize 11 "text fontsize for the hud"
11 seta hud_width 560 "2D virtual width for the hud"
12
13 seta hud_colorset_foreground_1 "2" "primary priority (important names, etc)"
14 seta hud_colorset_foreground_2 "3" "secondary priority (items, locations, numbers, etc)"
15 seta hud_colorset_foreground_3 "4" "tertiary priority or relatively inconsequential text"
16 seta hud_colorset_foreground_4 "1" "notice/attention grabbing texting"
17 seta hud_colorset_kill_1 "1" "'bad' or 'dangerous' text (death messages against you, kill notifications, etc)"
18 seta hud_colorset_kill_2 "3" "similar to above, but less important... OR, a highlight out of above message type"
19 seta hud_colorset_kill_3 "4" "'good' or 'beneficial' text (you fragging someone, etc)"
20 seta hud_colorset_background "7" "neutral/unimportant text"
21
22 // general hud panel cvars (i.e. shouldn't be adjusted by a skin config)
23 seta hud_panel_weapons          1 "enable this panel"
24 seta hud_panel_ammo             1 "enable this panel"
25 seta hud_panel_powerups         1 "enable this panel"
26 seta hud_panel_healtharmor      1 "enable this panel"
27 seta hud_panel_notify           1 "enable this panel"
28 seta hud_panel_timer            1 "enable this panel"
29 seta hud_panel_radar            1 "enable this panel, 2 = also enable in non-teambased gamemodes"
30 seta hud_panel_score            1 "enable this panel"
31 seta hud_panel_racetimer        1 "enable this panel"
32 seta hud_panel_vote             1 "enable this panel"
33 seta hud_panel_modicons         1 "enable this panel"
34 seta hud_panel_pressedkeys      1 "enable this panel, 1 = show only when spectating other players, 2 = show always"
35 seta hud_panel_chat             1 "enable this panel"
36 seta hud_panel_engineinfo       0 "enable this panel"
37 seta hud_panel_infomessages     1 "enable this panel"
38 seta hud_panel_physics          3 "enable this panel, 1 = show if not observing, 2 = show always, 3 = show only in race/cts if not observing"
39 seta hud_panel_centerprint      1 "enable this panel"
40 //seta hud_panel_minigameboard    1 "enable this panel"
41 //seta hud_panel_minigamestatus   1 "enable this panel"
42 //seta hud_panel_minigamehelp     1 "enable this panel"
43 //seta hud_panel_minigamemenu     0 "enable this panel"
44 //seta hud_panel_mapvote          1 "enable this panel"
45 seta hud_panel_itemstime        2 "enable this panel, 1 = show when spectating, 2 = even playing in warmup stage"
46 //seta hud_panel_quickmenu        1 "enable this panel"
47 //seta hud_panel_scoreboard       1 "enable this panel"
48 seta hud_panel_scoreboard_accuracy 1 "show weapon accuracy stats panel on scoreboard; colors can be configured with accuracy_color* cvars"
49 seta hud_panel_scoreboard_ctf_leaderboard 1 "show a capture time rankings leaderboard in the scoreboard if allowed by the server"
50 seta hud_panel_strafehud        3 "enable this panel, 1 = show if not observing, 2 = show always, 3 = show only in race/cts if not observing"
51
52 seta hud_panel_weapons_dynamichud          1 "apply the dynamic hud effects to this panel"
53 seta hud_panel_ammo_dynamichud             1 "apply the dynamic hud effects to this panel"
54 seta hud_panel_powerups_dynamichud         1 "apply the dynamic hud effects to this panel"
55 seta hud_panel_healtharmor_dynamichud      1 "apply the dynamic hud effects to this panel"
56 seta hud_panel_notify_dynamichud           1 "apply the dynamic hud effects to this panel"
57 seta hud_panel_timer_dynamichud            1 "apply the dynamic hud effects to this panel"
58 seta hud_panel_radar_dynamichud            1 "apply the dynamic hud effects to this panel"
59 seta hud_panel_score_dynamichud            1 "apply the dynamic hud effects to this panel"
60 seta hud_panel_racetimer_dynamichud        1 "apply the dynamic hud effects to this panel"
61 seta hud_panel_vote_dynamichud             1 "apply the dynamic hud effects to this panel"
62 seta hud_panel_modicons_dynamichud         1 "apply the dynamic hud effects to this panel"
63 seta hud_panel_pressedkeys_dynamichud      1 "apply the dynamic hud effects to this panel"
64 seta hud_panel_engineinfo_dynamichud       1 "apply the dynamic hud effects to this panel"
65 seta hud_panel_infomessages_dynamichud     0 "apply the dynamic hud effects to this panel"
66 seta hud_panel_physics_dynamichud          1 "apply the dynamic hud effects to this panel"
67 seta hud_panel_centerprint_dynamichud      1 "apply the dynamic hud effects to this panel"
68 seta hud_panel_itemstime_dynamichud        1 "apply the dynamic hud effects to this panel"
69 seta hud_panel_scoreboard_dynamichud       0 "apply the dynamic hud effects to this panel"
70 seta hud_panel_strafehud_dynamichud        1 "apply the dynamic hud effects to this panel"
71
72 seta hud_panel_weapons_ammo_full_shells 60 "show 100% of the status bar at this ammo count"
73 seta hud_panel_weapons_ammo_full_nails 320 "show 100% of the status bar at this ammo count"
74 seta hud_panel_weapons_ammo_full_cells 180 "show 100% of the status bar at this ammo count"
75 seta hud_panel_weapons_ammo_full_plasma 180 "show 100% of the status bar at this ammo count"
76 seta hud_panel_weapons_ammo_full_rockets 160 "show 100% of the status bar at this ammo count"
77 seta hud_panel_weapons_ammo_full_fuel 100 "show 100% of the status bar at this ammo count"
78 seta hud_panel_weapons_hide_ondeath 0 "hide this panel when dead"
79 seta hud_panel_weapons_orderbyimpulse "1" "List weapons in their impulse order instead of priority"
80
81 seta hud_panel_ammo_maxammo "40" "when you have this much ammo, the ammo status bar is full"
82 seta hud_panel_ammo_hide_ondeath 0 "hide this panel when dead"
83
84 seta hud_panel_powerups_hide_ondeath 0 "hide this panel when dead"
85
86 seta hud_panel_healtharmor_oxygenbar_startalpha "0.2" "start alpha of the oxygen bar"
87 seta hud_panel_healtharmor_maxhealth "200" "when you have this much health, the health status bar is full"
88 seta hud_panel_healtharmor_maxarmor "200" "when you have this much armor, the armor status bar is full"
89 seta hud_panel_healtharmor_progressbar_gfx_damage 5 "show damage effect when damaged at least by this amount; 0 disables the effect"
90 seta hud_panel_healtharmor_progressbar_gfx_lowhealth 40 "health progressbar blinks when health is lower than this amount"
91 seta hud_panel_healtharmor_hide_ondeath 0 "hide this panel when dead"
92
93 seta hud_panel_timer_increment "0" "show elapsed time instead of remaining time"
94
95 seta hud_panel_engineinfo_framecounter_exponentialmovingaverage 1 "use an averaging method for calculating fps instead of counting frametime like engine does"
96 seta hud_panel_engineinfo_framecounter_exponentialmovingaverage_new_weight 0.1 "weight of latest data point"
97 seta hud_panel_engineinfo_framecounter_exponentialmovingaverage_instantupdate_change_threshold 0.5 "threshold for fps change when to update instantly, to make big fps changes update faster"
98 seta hud_panel_engineinfo_framecounter_decimals "0" "amount of decimals to show"
99 seta hud_panel_engineinfo_framecounter_time "0.1" "time between framerate display updates"
100
101 seta hud_panel_physics_acceleration_movingaverage 1 "use an averaging method for calculating acceleration instead of the real value"
102 seta hud_panel_physics_update_interval 0.016 "how often (in seconds) numeric values get updated on screen"
103 seta hud_panel_physics_speed_unit "1" "speed unit (1 = qu/s, 2 = m/s, 3 = km/h, 4 = mph, 5 = knots)"
104
105 seta hud_panel_itemstime_progressbar_maxtime "30" "when left time is at least this amount, the status bar is full"
106 seta hud_panel_itemstime_hidespawned "1" "if 1 hide an item from the panel when all the occurrences of it are available again; if 2 hide it when at least one occurrence is available again"
107 seta hud_panel_itemstime_hidebig "0" "if 1 hide big armor and health from the panel"
108
109 seta hud_panel_quickmenu_file "" "load the quick menu from this file (empty or 0 to disable)"
110 seta hud_panel_quickmenu_translatecommands 0 "when the game is translated, translate strings inside commands too (useful for chat commands)"
111 seta hud_panel_quickmenu_time 5 "quickmenu expires after this number of seconds in the same page"
112
113 seta hud_panel_infomessages_group0 1 "show group 0 messages (showing keys for non-crucial actions you can do while spectating/observing)"
114 seta hud_panel_infomessages_group_time 6 "number of seconds a message of a group lasts before it gets changed"
115 seta hud_panel_infomessages_group_fadetime 0.4 "group message fade in/out time"
116
117 seta hud_panel_scoreboard_namesize 15 "size limit of player names and relative column (multiplied by fontsize)"
118 seta hud_panel_scoreboard_maxheight 0.6 "max height of the scoreboard; a few players that wouldn't fit into the scoreboard are listed in the last row"
119 seta hud_panel_scoreboard_others_showscore 1 "show scores of players listed in the last row when the scoreboard reaches the max height"
120 seta hud_panel_scoreboard_spectators_showping 1 "show ping of spectators"
121 seta hud_panel_scoreboard_spectators_aligned 0 "align spectators in columns"
122 seta hud_panel_scoreboard_minwidth 0.6 "minimum width of the scoreboard"
123
124 seta hud_panel_scoreboard_accuracy_showdelay 2 "how long to delay displaying accuracy below the scoreboard if it's too far down"
125 seta hud_panel_scoreboard_accuracy_showdelay_minpos 0.75 "delay displaying the accuracy panel only if its position is lower than this percentage of the screen height from the top"
126 seta hud_panel_scoreboard_team_size_position 0 "where to show the team size (0 = do not show, 1 = left of scoreboard, 2 = right of scoreboard), will move team scores to the other side if necessary"
127
128 seta _hud_panel_strafehud_demo "0" "strafehud changes angle during configure"
129 seta hud_panel_strafehud_mode "0" "strafehud mode which controls whether the strafehud is centered at \"0\" = view angle, \"1\" = velocity angle"
130 seta hud_panel_strafehud_range "0" "the angle range up to 360 degrees displayed on the strafehud, \"0\" = dynamic (chooses the minimum range required to still see the whole area needed for accelerating at once)"
131 seta hud_panel_strafehud_style "1" "\"0\" = no styling, \"1\" = progress bar style for the strafe bar, \"2\" = gradient for the strafe bar"
132 seta hud_panel_strafehud_unit "1" "speed unit (1 = qu/s, 2 = m/s, 3 = km/h, 4 = mph, 5 = knots), length unit (1 = qu, 2 = m, 3 = km, 4 = mi, 5 = nmi)"
133 seta hud_panel_strafehud_unit_show "1" "show units"
134 seta hud_panel_strafehud_bar_neutral_color "1 1 1" "color of the strafe meter neutral zone"
135 seta hud_panel_strafehud_bar_neutral_alpha "0.3" "opacity of the strafe meter neutral zone"
136 seta hud_panel_strafehud_bar_accel_color "0 1 0" "color of the strafe meter acceleration zone"
137 seta hud_panel_strafehud_bar_accel_alpha "0.3" "opacity of the strafe meter acceleration zone"
138 seta hud_panel_strafehud_bar_overturn_color "1 0 1" "color of the strafe meter overturn zone"
139 seta hud_panel_strafehud_bar_overturn_alpha "0.3" "opacity of the strafe meter overturn zone"
140 seta hud_panel_strafehud_angle_alpha "0.8" "opacity of the indicator showing the player's current angle"
141 seta hud_panel_strafehud_angle_height "1.5" "height of the indicator showing the player's current angle (relative to the panel height)"
142 seta hud_panel_strafehud_angle_width "0.005" "width of the indicator showing the player's current angle (relative to the panel width)"
143 seta hud_panel_strafehud_angle_neutral_color "1 1 0" "color of the indicator showing the player's current angle if the player's angle is within the neutral zone"
144 seta hud_panel_strafehud_angle_accel_color "0 1 1" "color of the indicator showing the player's current angle if the player's angle is within the acceleration zone"
145 seta hud_panel_strafehud_angle_overturn_color "1 0 1" "color of the indicator showing the player's current angle if the player's angle is within the overturn zone"
146 seta hud_panel_strafehud_switch_minspeed "-1" "minimum speed in qu/s at which switch indicators which are used to aid changing strafe direction will be shown (uses physics maxspeed + antiflicker speed if negative)"
147 seta hud_panel_strafehud_switch_active_color "0 1 0" "color of the switch indicator on the current side"
148 seta hud_panel_strafehud_switch_active_alpha "1" "opacity of the switch indicator on the current side"
149 seta hud_panel_strafehud_switch_inactive_color "1 1 0" "color of the switch indicator on the opposite side"
150 seta hud_panel_strafehud_switch_inactive_alpha "1" "opacity of the switch indicator on the opposite side"
151 seta hud_panel_strafehud_switch_width "0.0075" "width of the strafe angle indicators (relative to the strafe bar width)"
152 seta hud_panel_strafehud_direction_color "0 0.5 1" "color of the direction caps which indicate the direction the player is currently strafing towards"
153 seta hud_panel_strafehud_direction_alpha "1" "opacity of the direction caps which indicate the direction the player is currently strafing towards"
154 seta hud_panel_strafehud_direction_width "0.25" "stroke width of the direction caps which indicate the direction the player is currently strafing towards (relative to the panel height)"
155 seta hud_panel_strafehud_direction_length "0.02" "length of the horizontal component of the direction caps which indicate the direction the player is currently strafing towards (relative to the panel width)"
156 seta hud_panel_strafehud_slickdetector_range "0" "range of the slick detector in qu, \"0\" to disable"
157 seta hud_panel_strafehud_slickdetector_granularity "2" "value from 0 to 4 which defines how exact the search for slick should be, higher values may yield better results but require more computation"
158 seta hud_panel_strafehud_slickdetector_color "0 1 1" "color of the slick detector indicator"
159 seta hud_panel_strafehud_slickdetector_alpha "0.5" "opacity of the slick detector indicator"
160 seta hud_panel_strafehud_slickdetector_height "0.125" "height of the slick detector indicator (relative to the panel height)"
161 seta hud_panel_strafehud_startspeed_fade "0" "fade time (in seconds) of the start speed text or \"0\" to disable"
162 seta hud_panel_strafehud_startspeed_color "1 0.75 0" "color of the start speed text"
163 seta hud_panel_strafehud_startspeed_size "1.5" "size of the start speed text (relative to the panel height)"
164 seta hud_panel_strafehud_jumpheight_fade "0" "fade time (in seconds) of the jump height text or \"0\" to disable"
165 seta hud_panel_strafehud_jumpheight_min "50" "minimum jump height to display in the selected unit"
166 seta hud_panel_strafehud_jumpheight_color "0 1 0.75" "color of the jump height text"
167 seta hud_panel_strafehud_jumpheight_size "1.5" "size of the jump height text (relative to the panel height)"
168 seta hud_panel_strafehud_timeout_air "0.1" "time (in seconds) after take off before changing to air strafe physics when not jumping (visually more consistent hud while on slick downwards ramps)"
169 seta hud_panel_strafehud_timeout_ground "0.03333333" "time (in seconds) after landing before changing to non-air strafe physics (visually more consistent hud while strafe turning when touching the floor after every hop)"
170 seta hud_panel_strafehud_timeout_turn "0.1" "time (in seconds) after releasing the strafe keys before changing mode (visually more consistent hud while switching between left/right strafe turning)"
171 seta hud_panel_strafehud_timeout_direction "0.5" "time (in seconds) it takes until direction changes (forward or backward movement) are applied (set to zero if you intend to sideways strafe)"
172 seta hud_panel_strafehud_antiflicker_angle "0.01" "how many degrees from 0° to 180° the hud ignores if it could cause visual disturbances otherwise (and to counter rounding errors)"
173 seta hud_panel_strafehud_antiflicker_speed "0.0001" "how many qu/s the hud ignores if it could cause visual disturbances otherwise (and to counter rounding errors)"
174
175 // hud panel aliases
176 alias quickmenu "cl_cmd hud quickmenu ${* ?}"
177
178 alias hud_panel_radar_rotate "toggle hud_panel_radar_rotation 0 1 2 3 4"
179 alias +hud_panel_radar_maximized "cl_cmd hud radar 1"
180 alias -hud_panel_radar_maximized "cl_cmd hud radar 0"
181 alias hud_panel_radar_maximized "cl_cmd hud radar"
182
183 // other hud cvars
184 seta hud_panel_update_interval 2 "how often (in seconds) common panel cvars are reloaded"
185
186 seta hud_dynamic_follow 0 "HUD moves around following player's movement (effect shared with cl_followmodel, can be enabled independently from it though)"
187 seta hud_dynamic_follow_scale 0.01 "HUD following scale"
188 seta hud_dynamic_follow_scale_xyz "1 1 1" "HUD following scale for the x, y and z axis"
189
190 seta hud_dynamic_shake 1 "shake the HUD when hurt"
191 seta hud_dynamic_shake_damage_max 130 "damage value at which the HUD shake effect is maximum"
192 seta hud_dynamic_shake_damage_min 10 "damage value at which the HUD shake effect is minimum"
193 seta hud_dynamic_shake_scale 0.2 "HUD shake scale"
194
195 seta hud_showbinds 1    "what to show in the HUD to indicate certain keys to press: 0 display commands, 1 bound keys, 2 both"
196 seta hud_showbinds_limit 2      "maximum number of bound keys to show for a command. 0 for unlimited"
197 set _hud_showbinds_reload 0     "set it to 1 to reload binds if you changed any. It is reset to 0 automatically"
198
199 seta hud_colorflash_alpha 0.5 "starting alpha of the color flash"
200
201 seta hud_damage 0.55 "draw a blood image when hurt (improved version of gl_polyblend)"
202 seta hud_damage_blur 0 "Use postprocessing to blur the screen when you have taken damage. This can be paired with current hud damage or just used alone. Higher values = more blur"
203 seta hud_damage_blur_alpha 0.5 "Amount of alpha to use when merging the blurred layers back into the render. Turning this up higher will remove bloom, so it's best to find a balance"
204 seta hud_damage_gentle_alpha_multiplier 0.10 "how much to multiply alpha of flash when using the cl_gentle version, it's much more opaque than the non-gentle version"
205 seta hud_damage_gentle_color "1 0.7 1" "color of flash for cl_gentle version"
206 seta hud_damage_color "1 0 0" "color of flash"
207 seta hud_damage_factor 0.025 "(damage * factor) = how much to add to the alpha value"
208 seta hud_damage_fade_rate 0.75 "how much to subtract from the alpha value each second"
209 seta hud_damage_maxalpha 1.5 "how much to limit the alpha value to"
210 seta hud_damage_pain_threshold 0.1 "how much alpha to ignore (must be bigger than the hud_damage_factor so that e.g. rot is ignored)"
211 seta hud_damage_pain_threshold_lower 1.25 "how much we lower pain_threshold with when nearing 0 health (if pain_threshold gets negative then we always draw a flash at alpha = fabs(pain_threshold)"
212 seta hud_damage_pain_threshold_lower_health 50 "at which health we start lowering pain_threshold"
213 seta hud_damage_pain_threshold_pulsating_min 0.6 "minimum value when calculating the pulse: max(pulsating_min, fabs(sin(PI * time / period))"
214 seta hud_damage_pain_threshold_pulsating_period 0.8 "one pulse every X seconds"
215
216 seta hud_powerup 0 "power of the sharpen effect when owning the shield or strength powerups"
217
218 seta hud_postprocessing 1 "enables the ability for effects such as hud_damage_blur and hud_contents to apply a postprocessing method upon the screen - enabling this disables manual editing of the postprocess cvars"
219 seta hud_postprocessing_maxbluralpha 0 "maximum alpha which the blur postprocess can be"
220 seta hud_postprocessing_maxblurradius 8 "maximum radius which the blur postprocess can be"
221
222 seta hud_contents 1 "an improved version of gl_polyblend for liquids such as water/lava/slime, draw a filler when inside the liquid"
223 seta hud_contents_blur 10 "Use postprocessing to blur the screen when you are inside a liquid. Higher values = more blur"
224 seta hud_contents_blur_alpha 0.5 "Amount of alpha to use when merging the blurred layers back into the render. Turning this up higher will remove bloom, so it's best to find a balance"
225 seta hud_contents_factor 1 "factor at which to multiply the current faded value."
226 seta hud_contents_fadeintime 0.02 "factor of time it takes for the alpha level to reach normal value when entering the liquid"
227 seta hud_contents_fadeouttime 0.1 "factor of time it takes for the alpha level to reach normal value when leaving the liquid"
228 seta hud_contents_lava_alpha 0.7 "alpha of the lava"
229 seta hud_contents_lava_color "0.8 0.1 0" "color blend when inside lava"
230 seta hud_contents_slime_alpha 0.7 "alpha of the slime"
231 seta hud_contents_slime_color "0 0.4 0.1" "color blend when inside slime"
232 seta hud_contents_water_alpha 0.5 "alpha of the water"
233 seta hud_contents_water_color "0.4 0.3 0.3" "color blend when inside water"
234
235 seta hud_shownames 1 "draw names and health/armor of nearby players"
236 seta hud_shownames_enemies 1 "show tags for enemies as well"
237 seta hud_shownames_crosshairdistance 0 "if set, only draw tags which came within this distance of your crosshair (25 recommended)"
238 seta hud_shownames_crosshairdistance_time 5 "how many seconds the tag is still visible after pointing at them"
239 seta hud_shownames_crosshairdistance_antioverlap 0 "allow antioverlap to work as normal even with crosshairdistance on"
240 seta hud_shownames_self 0 "also include your own name to be shown when third person camera mode is on (chase_active/cl_eventchase)"
241 seta hud_shownames_status 1 "1 = draw health/armor status of teammates"
242 seta hud_shownames_statusbar_height 4 "height of status bar"
243 seta hud_shownames_statusbar_highlight 1 "Always highlight values of health and armor from 0 to half status bar"
244 seta hud_shownames_aspect 8 "aspect ratio of total drawing area per name"
245 seta hud_shownames_fontsize 12 "font size"
246 seta hud_shownames_decolorize 1 "1 = decolorize name in team games, 2 = decolorize always"
247 seta hud_shownames_alpha 0.7 "alpha"
248 seta hud_shownames_resize 1 "enable resizing of the names, then the size cvars will correspond to the maximum size"
249 seta hud_shownames_mindistance 1000 "start fading alpha/size at this distance"
250 seta hud_shownames_maxdistance 5000 "alpha/size is 0 at this distance"
251 seta hud_shownames_antioverlap 1 "if two tags get too close to each other, fade out the one further away from you"
252 seta hud_shownames_antioverlap_distance 50 "2d distance to other tag after which to fade out"
253 seta hud_shownames_offset 52 "offset (along z-axis) tag from player origin by this many units"