some more comments and fixes in example config

[xonotic/xonotic.git] / server / server.cfg

// This is an example config, to actually use it, copy it to ~/.xonotic/data on linux
// or the equivalent directory on your OS (https://xonotic.org/faq/#config).

// Two slashes start a comment until the end of the line.
// Surround strings (text values) with double quotes (e.g. cvar_name "some value"), otherwise only the first word will be used.
// Cvar means console variable.
// Just "" means empty string.
// Semicolon separates commands (in console or in aliases).

// Search for settings and descriptions using the 'search' command in console
// or online: https://xonotic.org/tools/cacs/




/////////////////////////////////////////////////////////////////////
// Things you SHOULD change to make the server "yours" (remove the // and change the value):

//sv_public 1   // 0 or -1 (see description) if the server should not be on the public servers list
//hostname "Xonotic $g_xonoticversion Server"   // this name will appear on the server list (the $g_xonoticversion gets replaced with the current version)

// This is a good place for contact info (IRC, forum nick, etc.) so players can reach you when something is wrong with your server.
// Add line breaks using \n - e.g. "Line 1\nLine 2". Keep it as short as possible.
//sv_motd ""

// This sets the remote console password on the server, you also need to set the cvar to the same value on your client to use the 'rcon' command.
// Empty means rcon is disabled.
//rcon_password ""




/////////////////////////////////////////////////////////////////////
// Everything below has some sensible defaults so you don't really need to change anything.
// It's meant as inspiration for people who want to customize the server more.
// Some cvars have example or default values shown, some have an additional description/comment.
// For the rest, the description is available in console (type variable name and press TAB or use apropos/search).

//maxplayers // note: this is not the same as g_maxplayers

//net_address 0.0.0.0   // ONLY change this if you have problems with your server. Specifies the network interface used by the engine.  Set it to one of your internal IPs

//port 26000    // the port used by the server
// You are RECOMMENDED to change this value to a free port number on your server
// above 1024. The reason is that some bad ISPs might filter "gaming" ports, and
// changing the port your server runs on may make your server available to these
// people. Changing the port breaks nothing, the default simply matches Quake as
// we use a Quake-derived protocol and didn't do our own IANA port assignment yet
// (if anyone wants to go through that process, we'd be glad).

//log_file "server.log" // server console output will also be copied to this file. This: "${serverconfig}.log" uses variable substitution to make the logfile have the same name as your config file with .log appended which is useful if you run several servers
//timestamps

//g_start_delay

// List of maps to play on the server.  Set to "" to autodetect (which would enumerate ALL maps. Maps that don't support the current game mode will be skipped, so you don't need to remove them here.
//g_maplist "afterslime atelier boil catharsis courtfun dance drain erbium finalrage fuse geoplanetary glowplant implosion leave_em_behind nexballarena oilrig runningman runningmanctf silentsiege solarium space-elevator stormkeep techassault vorix warfare xoylent"
//g_maplist_shuffle 1   // 0 always selects the next map out of g_maplist (but then better set g_maplist_votable 0 below to prevent repetitive votes), 1 will select random maps each time
//g_maplist_mostrecent_count 3  // number of maps that have to be played before a map can be repeated

// LIMITS: how long a match will last before the next map starts (-1 means use the map default, 0 = unlimited, please note that the variables fraglimit/timelimit can NOT be globally used for this but only DURING the match being played)
//timelimit_override -1 // global timelimit for all maps and gametypes
//fraglimit_override -1 // global frag/point limit for all maps and gametypes
//capturelimit_override -1      // capture limit for CTF
//g_domination_point_limit -1
//g_keyhunt_point_limit -1
//g_lms_lives_override -1
//g_nexball_goallimit -1

//g_ctf_ignore_frags 0

// TEAMS for key hunt (change this to 2, 3, 4 to set a fixed keyhunt style)
//g_keyhunt_teams_override -1

// GAME MODE: what type of server do you want to host?
// possible values: dm (deathmatch), tdm (team deathmatch), ctf (capture the flag), ca (clan arena), ft (freeze tag), kh (keyhunt), as (assault), dom (domination), lms (last man standing), ka (keepaway), inv (invasion), ons (onslaught), rc (race), cts (complete the stage), nb (nexball)
//gametype dm   // default gamemode

// TIPS: uncomment this if you want help messages on your server - one per match 20 seconds after the map loads
//alias sv_hook_gamestart_all "defer 20 help_next"




/////////////////////////////////////////////////////////////////////
// Some settings you MIGHT want to change.  Again IF so remove the //
// from the line start and change them to your liking.

//skill 4       // the bots skill level
//minplayers 0  // add bots if less then that number of players playing
//minplayers_per_team 0 // add bots to each team if less than that number of players playing
//g_maxplayers 0 // above this player count, only allow spectators
//bot_prefix [BOT]      // prepend this to all botnames
//bot_suffix "" // append this to all botnames
//g_maplist_check_waypoints 0   // set this to 1 to skip maps without waypoints if there aren't enough players to play without bots

// Map voting screen
//g_maplist_votable
//g_maplist_votable_suggestions
//g_maplist_votable_abstain
//g_maplist_votable_nodetail

// Gametype voting screen (also includes an example of creating a custom gamemode)
sv_vote_gametype 1 // uncommented because it's a suggested default
//sv_vote_gametype_options "dm tdm ca ctf 1v1ctf"
// sv_vote_gametype_*_type Must be set to the name of the gametype the option is based on
// sv_vote_gametype_*_name Contains a human-readable name of the gametype
// sv_vote_gametype_*_description Contains a longer description
//set sv_vote_gametype_1v1ctf_type ctf
//set sv_vote_gametype_1v1ctf_name "Capture the Flag Duel"
//set sv_vote_gametype_1v1ctf_description "One vs One match in CTF"
//alias sv_vote_gametype_hook_all "g_maxplayers 0"
//alias sv_vote_gametype_hook_1v1ctf "g_maxplayers 2"

// Votes available by 'vcall'
//sv_vote_call
//sv_vote_commands
//sv_vote_majority_factor
//sv_vote_majority_factor_of_voted
// note: to JUST support simple majorities, set these two factors equal

// Masters can be voted in by players or chosen by the admin and given a password.
//sv_vote_master
//sv_vote_master_callable
//sv_vote_master_password
//sv_vote_master_commands // You may want to put 'kickban' here and allow masters to change 'sv_status_privacy', so they can keep out punks, but in that case don't make master votable or it will get abused.

// Similar functionality to vote masters
//rcon_restricted_commands
//rcon_restricted_password

// Autokick idle players (conditionally only if there are enough free slots)
//sv_maxidle

//sv_taunt
//sv_autotaunt




/////////////////////////////////////////////////////////////////////
// Settings you MIGHT want to change for PRIVACY reasons.

//sv_status_privacy 1   // 1 hides IP addresses from "status" replies shown to clients, 0 shows them. Enables players to identify wellknown punks on your server OR is a threat to anonymity.. depending on your point of view :)

// This line sends the following data to our servers:
// - Date and time
// - Your server IP address
// - Your server ID hash, which is a fingerprint of the public key of your
//   server and does not impact security of your private key (use "crypto_keys"
//   on the console to show it)
// - Your server name ("hostname")
// - Current game type
// - Current map
// - Balance settings you have modified from defaults (only those that make
//   your server "impure")
// - For each weapon pairing (A, B), separately for player-player, player-bot,
//   bot-player, bot-bot pairings:
//   - Number of hits of players/bots holding A against players/bots holding B
//   - Number of frags of players/bots holding A against players/bots holding B
//   - Total damage of players/bots holding A against players/bots holding B
//
// We use this data to:
// - Optimize the game balance for future releases
// - Identify problems in the bot AI and improving it
// - Find settings that make servers "impure" that should not, so we can
//   whitelist them in future releases
//
// We will or might publish:
// - Global weapon pairing statistics for players vs players, or bots vs bots,
//   or any vs any, on a selection of servers
// - Per-gametype and per-map weapon pairing statistics players vs players, or
//   bots vs bots, or any vs any, on a selection of servers
// - Lists of commonly changed cvars, together with counts on how often they
//   are modified
//
// No information about the players on the server is sent, so as a server admin
// you need no permission of your players for this.
//
// No information about your server will be published - all published data sets
// will include data from multiple servers.
//
sv_weaponstats_file "http://www.xonotic.org/weaponbalance/"




/////////////////////////////////////////////////////////////////////
// Some more advanced settings.  You probably are not interested in changing them at all.

// Allow restarting the current match using the "ready" button
//sv_ready_restart
//sv_ready_restart_after_countdown
//sv_ready_restart_repeatable
//sv_autoscreenshot 0   // Useful for competitions or the ladder.

// Different hit detection options
//g_antilag

//sv_maxrate 1000000    // limits client connections to this rate in bytes/seconds

// see Docs/mapdownload.txt for more info
//sv_curl_defaulturl

// Force player models for everyone
//sv_defaultcharacter
//sv_defaultplayermodel
//sv_defaultplayerskin
//sv_defaultplayercolors
//g_fullbrightplayers
//g_fullbrightitems

// Gives players the freedom to make better teams than automatic but makes abuse easier
//g_balance_teams
//g_balance_teams_prevent_imbalance

//g_ban_sync_uri "http://46.38.241.138/~xonotic/bans/" // this ban list provider is currently offline
//g_ban_sync_trusted_servers

//g_spawnshieldtime




/////////////////////////////////////////////////////////////////////
// "Obvious" mutators that are allowed on a "pure" server
// Note that they often have more config options, use 'apropos'

//g_instagib
//g_weapon_stay
//g_powerups
//g_jetpack
//g_grappling_hook
//g_nix




/////////////////////////////////////////////////////////////////////
// Overkill ruleset

// To enable Overkill, put 'exec ruleset-overkill.cfg' at the top of this file (above any other cvar changes), don't use 'g_overkill 1' directly.




/////////////////////////////////////////////////////////////////////
// WARNING: anything below this line makes your server "impure"!
// Some more mutators (and other cvars) you might find interesting

//g_cloaked
//g_midair
//g_vampire
//sv_gravity