Merge remote-tracking branch 'origin/master'

CounterStrikeGlobalOffensive/server.cfg

@@ -1,4 +1,13 @@
-// Hostname for server.
+// ************************************************************************** //
+//                                                                            //
+//     Counter-Strike: Global Offensive - server.cfg                          //
+//     Version 240917                                                         //
+//                                                                            //
+// ************************************************************************** //
+
+// .................................. Basic ................................. //
+
+// Hostname - Name of the server.
 hostname "SERVERNAME"
 
 // RCON - remote console password.
@@ -7,25 +16,62 @@ rcon_password "ADMINPASSWORD"
 // Server password - for private servers.
 sv_password ""
 
-// Server Logging
+// Email - Server admin email.
+// Example: sv_contact "[email protected]"
+sv_contact ""
+
+// LAN mode - If set the server will not show on the internet.
+// Default: sv_lan 0
+sv_lan 0
+
+// ............................. Server Logging ............................. //
+
+// Enable log - Enables logging to file, console, and udp < on | off >.
+// Recommended: log on
 log on
+
+// Log bans - Log server bans in the server logs.
+// Default: sv_logbans 1
+// Recommended: sv_logbans 1
 sv_logbans 1
+
+// Log echo - Display log information to the server console.
+// Default: sv_logecho 1
+// Recommended: sv_logecho 1
 sv_logecho 1
+
+// Log file - Log server information in the log file.
+// Default: sv_logfile 1
+// Recommended: sv_logfile 1
 sv_logfile 1
+
+// One file log - Log server information to only one file.
+// Default: sv_log_onefile 0
+// Recommended: sv_log_onefile 0
 sv_log_onefile 0
 
 // Server Hibernation
 sv_hibernate_when_empty 1
 sv_hibernate_ms 5
 
-// Server Query
+// ............................. Server Query ............................. //
 // More info at: https://www.gametracker.com/games/csgo/forum.php?thread=91691
 host_name_store 1
 host_info_show 1
 host_players_show 2
 
+// ................................ Ban List ................................ //
 
+// User ban - Server banlist based on user steam ID.
+// Recommended: exec banned_user.cfg
 exec banned_user.cfg
+
+// IP ban - Server banlist based on user IP.
+// Recommended: exec banned_ip.cfg
 exec banned_ip.cfg
+
+// Write ID - Writes a list of permanently-banned user IDs to banned_user.cfg.
 writeid
+
+// Write IP - Save the ban list to banned_ip.cfg.
 writeip

README.md

@@ -19,4 +19,8 @@ The aim of this repository is to put together config files for game servers and
 
 **What Do You Mean by Vanilla/Generic?**
 
-A vanilla/generic server is unchanged from what the game developer intended. It excludes mods or major tweaks to the server settings that are found in a custom server.
+A vanilla/generic server is unchanged from what the game developer intended. It excludes mods or major tweaks to the server settings that are found in a custom server. The exception to this would be any widly accepted settings that improve the permormance or are commonly used.
+
+**How to contribute**
+
+There are many different game servers many of which are different. If you run a game server and wish to improve a config please fork this repo and do a PR or if you are not used to Git raise an issue with your changes so it can be added.

template/server.cfg.template

@@ -5,11 +5,30 @@
 //                                                                            //
 // ************************************************************************** //
 
-// .................................. Basic ................................. //
-// .................................. Game .................................. //
-// ................................ Map Cycle ............................... //
-// .............................. Communication ............................. //
-// .............................. Fast Download ............................. //
-// ................................ Ban List ................................ //
-// ............................. Server Logging ............................. //
+// Section Header ........................................................... //
 
+// Setting Name - Setting description.
+// 0 = option 1.
+// 0 = option 2.
+// Default: variable 0
+variable 0
+
+// Setting Name - Setting description.
+// Default: variable 45
+variable 45
+
+// Setting Name - Setting description.
+// Default: variable 1
+// Recommended: variable 2
+variable 2
+
+// Setting Name - Setting description.
+// Example:
+//    server location: maps/custommap.bsp
+//    web server location: http://example.com/custom/maps/custommap.bsp
+//    sv_downloadurl "http://example.com/custom"
+// Default: variable ""
+variable ""
+
+// Section Header ........................................................... //
+// Section description (optional)