explain cvar prefixes, rename name_maxlength
[xonotic/xonotic-data.pk3dir.git] / xonotic-common.cfg
1 // most common prefixes (currently not used consistently - especially g_ and sv_):
2 // cl_ client
3 // g_ gameplay
4 // r_ renderer
5 // sv_ server administration, should not affect gameplay
6 // _ temporary, private or internal cvar - should not be changed manually, sometimes used in scripts
7
8 // Xonotic version (formatted for machines)
9 // used to determine if a client version is compatible
10 // this doesn't have to be bumped with every release
11 // bump when clients become incompatible or any other perfectly good reason
12 // (e.g. game data incompatibility, engine version incompatibility, etc
13 // note: this automatically filters the server browser, clients of the new
14 // version won't see old servers, and clients of the old version won't see new
15 // servers either
16 //
17 // e.g. Xonotic 1.5.1 RC1 will be 15101
18 set g_xonoticversion git "Xonotic version (formatted for humans)"
19
20 gameversion 802 // 0.8.2
21 gameversion_min 0 // git builds see all versions
22 gameversion_max 65535 // git builds see all versions
23
24 // compatibility guideline:
25 //   version a.b.c   = a0b0c
26 //   gameversion_min = a0(b-1)00 // show servers of the previous "line"
27 //   gameversion_max = a0(b+1)99 // show servers of the next "line"
28 // so, for a given gameversion, _min and _max calculate as follows:
29 //   gameversion_min = (gameversion / 100) * 100 - 100
30 //   gameversion_max = (gameversion / 100) * 100 + 199
31
32 seta g_configversion 0  "Configuration file version (used to upgrade settings) 0: first run, or previous start was <2.4.1  Later, it's overridden by config.cfg, version ranges are defined in config_update.cfg"
33
34 exec xonotic-client.cfg
35 exec xonotic-server.cfg
36
37 set ekg 0       "Throw huge amounts of gibs"
38
39 _cl_playermodel "models/player/erebus.iqm"
40
41 locs_enable 0
42 pausable 0
43 set samelevel 0 "when 1, always play the same level over and over again"
44
45 fs_empty_files_in_pack_mark_deletions 1 // makes patches able to delete files
46
47 // singleplayer campaign
48 set g_campaign 0
49 set g_campaign_forceteam 0 "Forces the player to a given team in campaign mode, 1 = red, 2 = blue, 3 = yellow, 4 = pink"
50 seta g_campaign_name "xonoticbeta"
51 seta g_campaign_skill -1 // -2 easy -1 medium 0 hard
52
53 alias singleplayer_start "g_campaign_index 0; set scmenu_campaign_goto 0"
54 alias singleplayer_continue "set scmenu_campaign_goto -1"
55 alias singleplayer_levellist "set scmenu_campaign_dump 1; togglemenu; wait; togglemenu"
56
57 // campaign internal, set when loading a campaign map1G
58 set _campaign_index ""
59 set _campaign_name ""
60 set _campaign_testrun 0 "To verify the campaign file, set this to 1, then start the first campaign level from the menu. If you end up in the menu again, it's good, if you get a QC crash, it's bad."
61
62 // used by both server and menu to maintain the available list of maps
63 seta g_maplist "" "the list of maps to be cycled among (is autogenerated if empty)"
64
65 // we must change its default from 1.0 to 1 to be consistent with menuqc
66 set slowmo 1
67
68 // ticrate
69 //sys_ticrate 0.0166667 // 60fps. This would be ideal, but kills home routers.
70 sys_ticrate 0.0333333 // Use 30fps instead.
71
72 // Audio track names (for old-style "cd loop NUMBER" usage)
73 set _cdtrack_first "1"
74 alias _cdtrack_0 "g_cdtracks_remaplist \"$g_cdtracks_remaplist $1\""
75 alias _cdtrack_1 "g_cdtracks_remaplist \"$1\"; set _cdtrack_first 0"
76 alias _cdtrack "_cdtrack_$_cdtrack_first $2"
77 set g_cdtracks_remaplist ""
78 exec cdtracks.cfg
79 unset _cdtrack_first
80 unalias _cdtrack_0
81 unalias _cdtrack_1
82 unalias _cdtrack
83
84 cd remap $g_cdtracks_remaplist
85 set sv_intermission_cdtrack ""
86
87 set g_cdtracks_dontusebydefault "rising-of-the-phoenix"
88 seta menu_cdtrack "rising-of-the-phoenix"
89
90 // these entities are not referenced by anything directly, they just represent
91 // teams and are found by find() when needed
92 prvm_leaktest_ignore_classnames "ctf_team dom_team tdm_team"
93 prvm_backtraceforwarnings 1
94
95 set _urllib_nextslot 0 "temp variable"
96
97 set g_debug_defaultsounds 0 "always use default sounds"
98
99 // define some engine cvars that we need even on dedicated server
100 set r_showbboxes 0
101
102 // support Q1BSP maps
103 mod_q1bsp_polygoncollisions 1
104
105 // match q3map2
106 mod_obj_orientation 0
107
108 // UTF-8
109 utf8_enable 1
110
111 // this is mainly for _decal entities (their shaders should use "polygonoffset" shader parameter) - this is "good enough" as it seems, but smaller than the decals one so these don't zfight decals
112 mod_q3shader_default_polygonoffset -14
113 mod_q3shader_default_polygonfactor 0
114
115 // random charge stuff :P
116 set g_weapon_charge_colormod_hdrmultiplier 4 "how much to multiply the colors by in the colormod vector"
117 set g_weapon_charge_colormod_red_half 0
118 set g_weapon_charge_colormod_green_half 0.5
119 set g_weapon_charge_colormod_blue_half 1
120 set g_weapon_charge_colormod_red_full 1
121 set g_weapon_charge_colormod_green_full -0.5
122 set g_weapon_charge_colormod_blue_full -1
123
124 // session locking
125 locksession 1
126
127 // create this cvar in case the engine did not
128 set snd_soundradius 1200
129 set snd_softclip 1
130 set snd_maxchannelvolume 0
131 set snd_streaming_length 2
132 seta menu_snd_sliderscale 2 "0: decibels; 1: linear percent; 2: 0..10 scale; 3: slider size percent"
133 seta menu_snd_attenuation_method 1 "Use exponential instead of linear falloff for sound attenuation"
134 alias snd_attenuation_method_0 "set menu_snd_attenuation_method 0; set snd_soundradius 1200; set snd_attenuation_exponent 1; set snd_attenuation_decibel 0" // Quake default
135 alias snd_attenuation_method_1 "set menu_snd_attenuation_method 1; set snd_soundradius 2400; set snd_attenuation_exponent 4; set snd_attenuation_decibel 0" // nice approximation for method 2
136 alias snd_attenuation_method_2 "set menu_snd_attenuation_method 2; set snd_soundradius 1200; set snd_attenuation_exponent 0; set snd_attenuation_decibel 10" // warning: plays sounds within up to 6000qu
137 snd_attenuation_method_1
138
139 // declare the channels we use
140 seta snd_channel8volume 1 "QuakeC controlled background music volume"
141 seta snd_channel9volume 1 "QuakeC controlled ambient sound volume"
142
143 // sound randomization
144 snd_identicalsoundrandomization_time -0.1
145 snd_identicalsoundrandomization_tics    1
146
147 // load console command aliases and settings
148 exec commands.cfg
149
150 // ... and now that everything is configured/aliased, we can do some things:
151
152 // Change g_start_delay based upon if the server is local or not.
153 if_client set g_start_delay 0   "delay before the game starts, so everyone can join; recommended to set this to like 15 on a public server"
154 if_dedicated set g_start_delay 15       "delay before the game starts, so everyone can join; recommended to set this to like 15 on a public server"
155
156 // this should be execed only once even on ruleset-votable servers, otherwise the tips would always start from 0
157 if_dedicated exec help.cfg