Skip to content

Commit 3171a07

Browse files
authored
Clarify Gameplay vs [Game Name] Settings section distinction
docs/config-standards.md: - Gameplay section: clarified it covers ALL standard engine cvars (mp_*, sv_*, network rates) shared across multiple games - [Game Name] Settings: clarified it is ONLY for game-specific cvars with game-unique prefixes (sbox_*, jb_*, zm_*, sf_*, etc.) Standard engine cvars must never appear here aoc/server.cfg: - Replaced 'Age Of Chivalry Settings' with standard 'Gameplay' section (mp_friendlyfire, mp_timelimit are standard engine cvars) - Fixed section ordering: Gameplay -> Fast Download -> Ban List dys/server.cfg: - Removed 'Dystopia Settings' (contained no game-specific cvars) - Added Security section: sv_pure, sv_cheats - Added Communication section: sv_alltalk - Added Gameplay section: all mp_* cvars, sv_gravity, voting, network rate cvars (sv_minrate/maxrate, sv_mincmdrate/maxcmdrate, sv_minupdaterate/maxupdaterate) zmr/server.cfg: - Moved mp_timelimit, sv_alltalk, mp_forcecamera out of ZMR Settings - Added Communication section: sv_alltalk - Added Gameplay section: mp_timelimit, mp_forcecamera - ZMR Settings retains only zm_* game-specific cvars - Fixed section ordering: Communication -> Gameplay -> Fast Download -> Ban List
1 parent 6d80bf6 commit 3171a07

4 files changed

Lines changed: 89 additions & 164 deletions

File tree

aoc/server.cfg

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -38,19 +38,13 @@ sv_logfile 1
3838
// sv_log_onefile - Log server information to only one file.
3939
sv_log_onefile 0
4040

41-
// ................................ Ban List ................................ //
42-
43-
// exec banned_user.cfg - Load the banned user ID list.
44-
exec banned_user.cfg
41+
// ................................ Gameplay ................................ //
4542

46-
// exec banned_ip.cfg - Load the banned IP address list.
47-
exec banned_ip.cfg
48-
49-
// writeid - Writes a list of permanently-banned user IDs to banned_user.cfg.
50-
writeid
43+
// mp_friendlyfire - Allows team members to injure other members of their team.
44+
mp_friendlyfire 0
5145

52-
// writeip - Save the ban list to banned_ip.cfg.
53-
writeip
46+
// mp_timelimit - game time per map in minutes.
47+
mp_timelimit 20
5448

5549
// ............................. Fast Download .............................. //
5650
// info: Allows custom maps to be downloaded to the client.
@@ -61,10 +55,16 @@ sv_allowdownload 1
6155
// sv_downloadurl - Location from which clients can download missing files.
6256
sv_downloadurl ""
6357

64-
// ........................ Age Of Chivalry Settings ........................ //
58+
// ................................ Ban List ................................ //
6559

66-
// mp_friendlyfire - Allows team members to injure other members of their team.
67-
mp_friendlyfire 0
60+
// exec banned_user.cfg - Load the banned user ID list.
61+
exec banned_user.cfg
6862

69-
// mp_timelimit - game time per map in minutes.
70-
mp_timelimit 20
63+
// exec banned_ip.cfg - Load the banned IP address list.
64+
exec banned_ip.cfg
65+
66+
// writeid - Writes a list of permanently-banned user IDs to banned_user.cfg.
67+
writeid
68+
69+
// writeip - Save the ban list to banned_ip.cfg.
70+
writeip

docs/config-standards.md

Lines changed: 25 additions & 108 deletions
Original file line numberDiff line numberDiff line change
@@ -149,10 +149,17 @@ Server security and integrity settings.
149149

150150
### 5. Gameplay *(required)*
151151

152-
Game rules, physics, and mechanics. Includes:
152+
Standard engine cvars controlling game rules, physics, and mechanics. Use this
153+
section for cvars that exist across multiple Source/GoldSrc games — not for
154+
cvars unique to one specific game (those go in **[Game Name] Settings**).
155+
156+
Includes:
153157

154158
- `mp_*` cvars (timelimit, friendlyfire, teamplay, roundtime, etc.)
155159
- `sv_maxspeed`, `sv_gravity`, `sv_friction`, `sv_airaccelerate`
160+
- `sv_minrate`, `sv_maxrate`, `sv_mincmdrate`, `sv_maxcmdrate`,
161+
`sv_minupdaterate`, `sv_maxupdaterate` (network bandwidth)
162+
- `sv_idlekick`, `sv_pure`, `sv_cheats` if not already in Security
156163
- GoldSrc: `deathmatch`, `decalfrequency`, `sys_ticrate`, `hpk_maxsize`
157164
- `sv_aim` (GoldSrc autoaim)
158165

@@ -208,14 +215,24 @@ custom plugin commands.
208215

209216
### 10. [Game Name] Settings *(optional)*
210217

211-
Game-specific cvars that do not fit into any standard section above. The
212-
section name must match the full display name of the game or mod followed by
213-
` Settings`:
218+
Game-specific cvars that are **unique to that game or mod** and do not exist in
219+
any other Source/GoldSrc game. If a cvar begins with a game-specific prefix
220+
(e.g. `sbox_`, `jb_`, `zm_`, `sf_`, `ins_`) or is otherwise not shared with
221+
other games, it belongs here.
222+
223+
**Standard engine cvars (`mp_*`, `sv_*`, etc.) must never go in this section**
224+
— they always belong in the appropriate standard section above (Security,
225+
Communication, Gameplay, etc.).
226+
227+
The section name must match the full display name of the game or mod followed
228+
by ` Settings`:
214229

215-
- `Garry's Mod Settings`
216-
- `Insurgency Settings`
217-
- `Fistful of Frags Settings`
218-
- `Dystopia Settings`
230+
- `Garry's Mod Settings``sbox_*` sandbox cvars
231+
- `Insurgency Settings``sv_vote_*`, `mp_coop_*` vote and coop system
232+
- `Fistful of Frags Settings``fof_*` game-specific cvars
233+
- `Zombie Master: Reborn Settings``zm_*` game-specific cvars
234+
235+
If a game has no game-specific cvars, omit this section entirely.
219236

220237
---
221238

@@ -266,103 +283,3 @@ The shortname matches the directory name in this repository (e.g. `css` for
266283

267284
For cvars not present in the cvarlist (mod-specific cvars), write a concise
268285
description in sentence case ending with a period.
269-
270-
---
271-
272-
## Complete Example
273-
274-
```
275-
// ****************************************************************************
276-
// Counter-Strike: Source
277-
// Config - server.cfg
278-
// Date - 01/01/2025
279-
// ****************************************************************************
280-
281-
// .................................. Basic ................................. //
282-
283-
// hostname - Name of the server.
284-
hostname "SERVERNAME"
285-
286-
// rcon_password - Remote console password.
287-
rcon_password "ADMINPASSWORD"
288-
289-
// sv_password - Server password for private servers.
290-
sv_password ""
291-
292-
// sv_contact - Contact email for server admin.
293-
sv_contact ""
294-
295-
// ................................. Security ................................ //
296-
297-
// sv_lan - LAN server mode, disables Steam authentication.
298-
sv_lan 0
299-
300-
// sv_cheats - Allow cheat commands on the server.
301-
sv_cheats 0
302-
303-
// sv_pure - Enforce pure server file verification.
304-
sv_pure 1
305-
306-
// ............................. Server Logging ............................. //
307-
308-
// log - Enable server log output.
309-
log on
310-
311-
// sv_logbans - Log bans in the server logs.
312-
sv_logbans 1
313-
314-
// sv_logecho - Echo log information to the console.
315-
sv_logecho 1
316-
317-
// sv_logfile - Log server information to file.
318-
sv_logfile 1
319-
320-
// sv_log_onefile - Log server information to only one file.
321-
sv_log_onefile 0
322-
323-
// .............................. Communication ............................. //
324-
325-
// sv_voiceenable - Enable voice communications.
326-
sv_voiceenable 1
327-
328-
// sv_alltalk - Allow all players to hear each other regardless of team.
329-
sv_alltalk 0
330-
331-
// ................................ Gameplay ................................ //
332-
333-
// mp_friendlyfire - Allow players to injure teammates.
334-
mp_friendlyfire 0
335-
336-
// mp_timelimit - Game time per map in minutes.
337-
mp_timelimit 30
338-
339-
// .............................. Map Rotation .............................. //
340-
341-
// mapcyclefile - Name of the map cycle file.
342-
mapcyclefile mapcycle.txt
343-
344-
// ............................. Fast Download .............................. //
345-
346-
// sv_allowdownload - Allow clients to download files from the server.
347-
sv_allowdownload 1
348-
349-
// sv_allowupload - Allow clients to upload customisation files.
350-
sv_allowupload 1
351-
352-
// sv_downloadurl - URL of the fast download server.
353-
sv_downloadurl ""
354-
355-
// ................................ Ban List ................................ //
356-
357-
// exec banned_user.cfg - Load the banned user ID list.
358-
exec banned_user.cfg
359-
360-
// exec banned_ip.cfg - Load the banned IP address list.
361-
exec banned_ip.cfg
362-
363-
// writeid - Write banned user IDs to banned_user.cfg.
364-
writeid
365-
366-
// writeip - Write banned IPs to banned_ip.cfg.
367-
writeip
368-
```

dys/server.cfg

Lines changed: 26 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,14 @@ sv_contact ""
2121
// sv_lan - Server is a lan server ( no heartbeat, no authentication, no non-class C addresses ).
2222
sv_lan 0
2323

24+
// ................................. Security ................................ //
25+
26+
// sv_pure - Show user data.
27+
sv_pure 2
28+
29+
// sv_cheats - Allow cheats on server.
30+
sv_cheats 0
31+
2432
// ............................. Server Logging ............................. //
2533

2634
// log - Enables logging to file, console, and udp < on | off >.
@@ -38,31 +46,16 @@ sv_logfile 1
3846
// sv_log_onefile - Log server information to only one file.
3947
sv_log_onefile 0
4048

41-
// ................................ Ban List ................................ //
42-
43-
// exec banned_user.cfg - Load the banned user ID list.
44-
exec banned_user.cfg
45-
46-
// exec banned_ip.cfg - Load the banned IP address list.
47-
exec banned_ip.cfg
48-
49-
// writeid - Writes a list of permanently-banned user IDs to banned_user.cfg.
50-
writeid
49+
// ............................. Communication .............................. //
5150

52-
// writeip - Save the ban list to banned_ip.cfg.
53-
writeip
51+
// sv_alltalk - Players can hear all other players, no team restrictions.
52+
sv_alltalk 0
5453

55-
// ........................... Dystopia Settings ............................ //
54+
// ................................ Gameplay ................................ //
5655

5756
// mp_rounds - number of rounds.
5857
mp_rounds 2
5958

60-
// sv_pure - Show user data.
61-
sv_pure 2
62-
63-
// sv_cheats - Allow cheats on server.
64-
sv_cheats 0
65-
6659
// mp_stopwatch - stop watch mode.
6760
mp_stopwatch 0
6861

@@ -87,9 +80,6 @@ mp_scalespawntime 0
8780
// sv_gravity - World gravity.
8881
sv_gravity 600
8982

90-
// sv_alltalk - Players can hear all other players, no team restrictions.
91-
sv_alltalk 0
92-
9383
// mp_allowvoting - allow use of callvote.
9484
mp_allowvoting 1
9585

@@ -140,3 +130,17 @@ sv_maxupdaterate 66
140130

141131
// sv_minupdaterate - Minimum updates per second that the server will allow.
142132
sv_minupdaterate 30
133+
134+
// ................................ Ban List ................................ //
135+
136+
// exec banned_user.cfg - Load the banned user ID list.
137+
exec banned_user.cfg
138+
139+
// exec banned_ip.cfg - Load the banned IP address list.
140+
exec banned_ip.cfg
141+
142+
// writeid - Writes a list of permanently-banned user IDs to banned_user.cfg.
143+
writeid
144+
145+
// writeip - Save the ban list to banned_ip.cfg.
146+
writeip

zmr/server.cfg

Lines changed: 22 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -38,19 +38,18 @@ sv_logfile 1
3838
// sv_log_onefile - Log server information to only one file.
3939
sv_log_onefile 0
4040

41-
// ................................ Ban List ................................ //
41+
// ............................. Communication .............................. //
4242

43-
// exec banned_user.cfg - Load the banned user ID list.
44-
exec banned_user.cfg
43+
// sv_alltalk - Players can hear all other players, no team restrictions.
44+
sv_alltalk 1
4545

46-
// exec banned_ip.cfg - Load the banned IP address list.
47-
exec banned_ip.cfg
46+
// ................................ Gameplay ................................ //
4847

49-
// writeid - Writes a list of permanently-banned user IDs to banned_user.cfg.
50-
writeid
48+
// mp_timelimit - game time per map in minutes.
49+
mp_timelimit 0
5150

52-
// writeip - Save the ban list to banned_ip.cfg.
53-
writeip
51+
// mp_forcecamera - Restricts spectator modes for dead players.
52+
mp_forcecamera 0
5453

5554
// ............................. Fast Download .............................. //
5655
// info: Allows custom maps to be downloaded to the client.
@@ -61,6 +60,20 @@ sv_allowdownload 1
6160
// sv_downloadurl - Location from which clients can download missing files.
6261
sv_downloadurl ""
6362

63+
// ................................ Ban List ................................ //
64+
65+
// exec banned_user.cfg - Load the banned user ID list.
66+
exec banned_user.cfg
67+
68+
// exec banned_ip.cfg - Load the banned IP address list.
69+
exec banned_ip.cfg
70+
71+
// writeid - Writes a list of permanently-banned user IDs to banned_user.cfg.
72+
writeid
73+
74+
// writeip - Save the ban list to banned_ip.cfg.
75+
writeip
76+
6477
// ..................... Zombie Master: Reborn Settings ..................... //
6578

6679
// zm_sv_joingrace - Seconds after round start that players can still join as survivor.
@@ -69,14 +82,5 @@ zm_sv_joingrace 60
6982
// zm_mp_roundlimit - How many rounds do we play before going into intermission. 0 = Disable.
7083
zm_mp_roundlimit 0
7184

72-
// mp_timelimit - game time per map in minutes.
73-
mp_timelimit 0
74-
75-
// sv_alltalk - Players can hear all other players, no team restrictions.
76-
sv_alltalk 1
77-
78-
// mp_forcecamera - Restricts spectator modes for dead players.
79-
mp_forcecamera 0
80-
8185
// zm_sv_happyzombies_usedate - Special dates bring happy zombies :).
8286
zm_sv_happyzombies_usedate 1

0 commit comments

Comments
 (0)