Browse Source

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
source-config-standards-trial
Daniel Gibbs 1 month ago
committed by GitHub
parent
commit
3171a07804
No known key found for this signature in database GPG Key ID: B5690EEEBB952194
  1. 32
      aoc/server.cfg
  2. 133
      docs/config-standards.md
  3. 48
      dys/server.cfg
  4. 40
      zmr/server.cfg

32
aoc/server.cfg

@ -38,19 +38,13 @@ sv_logfile 1
// sv_log_onefile - Log server information to only one file.
sv_log_onefile 0
// ................................ Ban List ................................ //
// exec banned_user.cfg - Load the banned user ID list.
exec banned_user.cfg
// ................................ Gameplay ................................ //
// exec banned_ip.cfg - Load the banned IP address list.
exec banned_ip.cfg
// writeid - Writes a list of permanently-banned user IDs to banned_user.cfg.
writeid
// mp_friendlyfire - Allows team members to injure other members of their team.
mp_friendlyfire 0
// writeip - Save the ban list to banned_ip.cfg.
writeip
// mp_timelimit - game time per map in minutes.
mp_timelimit 20
// ............................. Fast Download .............................. //
// info: Allows custom maps to be downloaded to the client.
@ -61,10 +55,16 @@ sv_allowdownload 1
// sv_downloadurl - Location from which clients can download missing files.
sv_downloadurl ""
// ........................ Age Of Chivalry Settings ........................ //
// ................................ Ban List ................................ //
// mp_friendlyfire - Allows team members to injure other members of their team.
mp_friendlyfire 0
// exec banned_user.cfg - Load the banned user ID list.
exec banned_user.cfg
// mp_timelimit - game time per map in minutes.
mp_timelimit 20
// exec banned_ip.cfg - Load the banned IP address list.
exec banned_ip.cfg
// writeid - Writes a list of permanently-banned user IDs to banned_user.cfg.
writeid
// writeip - Save the ban list to banned_ip.cfg.
writeip

133
docs/config-standards.md

@ -149,10 +149,17 @@ Server security and integrity settings.
### 5. Gameplay *(required)*
Game rules, physics, and mechanics. Includes:
Standard engine cvars controlling game rules, physics, and mechanics. Use this
section for cvars that exist across multiple Source/GoldSrc games — not for
cvars unique to one specific game (those go in **[Game Name] Settings**).
Includes:
- `mp_*` cvars (timelimit, friendlyfire, teamplay, roundtime, etc.)
- `sv_maxspeed`, `sv_gravity`, `sv_friction`, `sv_airaccelerate`
- `sv_minrate`, `sv_maxrate`, `sv_mincmdrate`, `sv_maxcmdrate`,
`sv_minupdaterate`, `sv_maxupdaterate` (network bandwidth)
- `sv_idlekick`, `sv_pure`, `sv_cheats` if not already in Security
- GoldSrc: `deathmatch`, `decalfrequency`, `sys_ticrate`, `hpk_maxsize`
- `sv_aim` (GoldSrc autoaim)
@ -208,14 +215,24 @@ custom plugin commands.
### 10. [Game Name] Settings *(optional)*
Game-specific cvars that do not fit into any standard section above. The
section name must match the full display name of the game or mod followed by
` Settings`:
Game-specific cvars that are **unique to that game or mod** and do not exist in
any other Source/GoldSrc game. If a cvar begins with a game-specific prefix
(e.g. `sbox_`, `jb_`, `zm_`, `sf_`, `ins_`) or is otherwise not shared with
other games, it belongs here.
**Standard engine cvars (`mp_*`, `sv_*`, etc.) must never go in this section**
— they always belong in the appropriate standard section above (Security,
Communication, Gameplay, etc.).
The section name must match the full display name of the game or mod followed
by ` Settings`:
- `Garry's Mod Settings`
- `Insurgency Settings`
- `Fistful of Frags Settings`
- `Dystopia Settings`
- `Garry's Mod Settings``sbox_*` sandbox cvars
- `Insurgency Settings``sv_vote_*`, `mp_coop_*` vote and coop system
- `Fistful of Frags Settings``fof_*` game-specific cvars
- `Zombie Master: Reborn Settings``zm_*` game-specific cvars
If a game has no game-specific cvars, omit this section entirely.
---
@ -266,103 +283,3 @@ The shortname matches the directory name in this repository (e.g. `css` for
For cvars not present in the cvarlist (mod-specific cvars), write a concise
description in sentence case ending with a period.
---
## Complete Example
```
// ****************************************************************************
// Counter-Strike: Source
// Config - server.cfg
// Date - 01/01/2025
// ****************************************************************************
// .................................. Basic ................................. //
// hostname - Name of the server.
hostname "SERVERNAME"
// rcon_password - Remote console password.
rcon_password "ADMINPASSWORD"
// sv_password - Server password for private servers.
sv_password ""
// sv_contact - Contact email for server admin.
sv_contact ""
// ................................. Security ................................ //
// sv_lan - LAN server mode, disables Steam authentication.
sv_lan 0
// sv_cheats - Allow cheat commands on the server.
sv_cheats 0
// sv_pure - Enforce pure server file verification.
sv_pure 1
// ............................. Server Logging ............................. //
// log - Enable server log output.
log on
// sv_logbans - Log bans in the server logs.
sv_logbans 1
// sv_logecho - Echo log information to the console.
sv_logecho 1
// sv_logfile - Log server information to file.
sv_logfile 1
// sv_log_onefile - Log server information to only one file.
sv_log_onefile 0
// .............................. Communication ............................. //
// sv_voiceenable - Enable voice communications.
sv_voiceenable 1
// sv_alltalk - Allow all players to hear each other regardless of team.
sv_alltalk 0
// ................................ Gameplay ................................ //
// mp_friendlyfire - Allow players to injure teammates.
mp_friendlyfire 0
// mp_timelimit - Game time per map in minutes.
mp_timelimit 30
// .............................. Map Rotation .............................. //
// mapcyclefile - Name of the map cycle file.
mapcyclefile mapcycle.txt
// ............................. Fast Download .............................. //
// sv_allowdownload - Allow clients to download files from the server.
sv_allowdownload 1
// sv_allowupload - Allow clients to upload customisation files.
sv_allowupload 1
// sv_downloadurl - URL of the fast download server.
sv_downloadurl ""
// ................................ Ban List ................................ //
// exec banned_user.cfg - Load the banned user ID list.
exec banned_user.cfg
// exec banned_ip.cfg - Load the banned IP address list.
exec banned_ip.cfg
// writeid - Write banned user IDs to banned_user.cfg.
writeid
// writeip - Write banned IPs to banned_ip.cfg.
writeip
```

48
dys/server.cfg

@ -21,6 +21,14 @@ sv_contact ""
// sv_lan - Server is a lan server ( no heartbeat, no authentication, no non-class C addresses ).
sv_lan 0
// ................................. Security ................................ //
// sv_pure - Show user data.
sv_pure 2
// sv_cheats - Allow cheats on server.
sv_cheats 0
// ............................. Server Logging ............................. //
// log - Enables logging to file, console, and udp < on | off >.
@ -38,31 +46,16 @@ sv_logfile 1
// sv_log_onefile - Log server information to only one file.
sv_log_onefile 0
// ................................ Ban List ................................ //
// exec banned_user.cfg - Load the banned user ID list.
exec banned_user.cfg
// exec banned_ip.cfg - Load the banned IP address list.
exec banned_ip.cfg
// writeid - Writes a list of permanently-banned user IDs to banned_user.cfg.
writeid
// ............................. Communication .............................. //
// writeip - Save the ban list to banned_ip.cfg.
writeip
// sv_alltalk - Players can hear all other players, no team restrictions.
sv_alltalk 0
// ........................... Dystopia Settings ............................ //
// ................................ Gameplay ................................ //
// mp_rounds - number of rounds.
mp_rounds 2
// sv_pure - Show user data.
sv_pure 2
// sv_cheats - Allow cheats on server.
sv_cheats 0
// mp_stopwatch - stop watch mode.
mp_stopwatch 0
@ -87,9 +80,6 @@ mp_scalespawntime 0
// sv_gravity - World gravity.
sv_gravity 600
// sv_alltalk - Players can hear all other players, no team restrictions.
sv_alltalk 0
// mp_allowvoting - allow use of callvote.
mp_allowvoting 1
@ -140,3 +130,17 @@ sv_maxupdaterate 66
// sv_minupdaterate - Minimum updates per second that the server will allow.
sv_minupdaterate 30
// ................................ Ban List ................................ //
// exec banned_user.cfg - Load the banned user ID list.
exec banned_user.cfg
// exec banned_ip.cfg - Load the banned IP address list.
exec banned_ip.cfg
// writeid - Writes a list of permanently-banned user IDs to banned_user.cfg.
writeid
// writeip - Save the ban list to banned_ip.cfg.
writeip

40
zmr/server.cfg

@ -38,19 +38,18 @@ sv_logfile 1
// sv_log_onefile - Log server information to only one file.
sv_log_onefile 0
// ................................ Ban List ................................ //
// ............................. Communication .............................. //
// exec banned_user.cfg - Load the banned user ID list.
exec banned_user.cfg
// sv_alltalk - Players can hear all other players, no team restrictions.
sv_alltalk 1
// exec banned_ip.cfg - Load the banned IP address list.
exec banned_ip.cfg
// ................................ Gameplay ................................ //
// writeid - Writes a list of permanently-banned user IDs to banned_user.cfg.
writeid
// mp_timelimit - game time per map in minutes.
mp_timelimit 0
// writeip - Save the ban list to banned_ip.cfg.
writeip
// mp_forcecamera - Restricts spectator modes for dead players.
mp_forcecamera 0
// ............................. Fast Download .............................. //
// info: Allows custom maps to be downloaded to the client.
@ -61,6 +60,20 @@ sv_allowdownload 1
// sv_downloadurl - Location from which clients can download missing files.
sv_downloadurl ""
// ................................ Ban List ................................ //
// exec banned_user.cfg - Load the banned user ID list.
exec banned_user.cfg
// exec banned_ip.cfg - Load the banned IP address list.
exec banned_ip.cfg
// writeid - Writes a list of permanently-banned user IDs to banned_user.cfg.
writeid
// writeip - Save the ban list to banned_ip.cfg.
writeip
// ..................... Zombie Master: Reborn Settings ..................... //
// zm_sv_joingrace - Seconds after round start that players can still join as survivor.
@ -69,14 +82,5 @@ zm_sv_joingrace 60
// zm_mp_roundlimit - How many rounds do we play before going into intermission. 0 = Disable.
zm_mp_roundlimit 0
// mp_timelimit - game time per map in minutes.
mp_timelimit 0
// sv_alltalk - Players can hear all other players, no team restrictions.
sv_alltalk 1
// mp_forcecamera - Restricts spectator modes for dead players.
mp_forcecamera 0
// zm_sv_happyzombies_usedate - Special dates bring happy zombies :).
zm_sv_happyzombies_usedate 1

Loading…
Cancel
Save