]> git.xonotic.org Git - xonotic/xonotic.git/blobdiff - server/server.cfg
explain line breaks in MOTD as suggested by Calinou
[xonotic/xonotic.git] / server / server.cfg
index 3e945588e455d8116b605c86dd0895b5f654d270..faa62d83be53bf2cade04118d495626aba6cf763 100644 (file)
@@ -1,48 +1,83 @@
-// A setting needs to be surrounded with " if it contains special
-// characters like space, semicolon (seperates commands) or starts
-// with // (begins a comment for the rest of the line or next
-// semicolon).  While just "" means 'no/empty setting'.
+// 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/
+
+
+
 
 /////////////////////////////////////////////////////////////////////
-// Everything has some sensible defaults so you do NOT really need to
-// change anything.  But here are some settings you SHOULD change to
-// make it 'YOUR' server.  IF so remove the // from the line start and
-// change them to your liking.
+// Things you SHOULD change to make the server "yours" (remove the // and change the value):
 
-//sv_public 1  // 0 if the server should not be on the public servers list
-//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 thread to anonymity.. depending on your point of view :)
+//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)
-//sv_motd ""   // this message (unless "") is displayed to players on connect
-//maxplayers 8 // number of players allowed on the server
+
+// 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
-//g_start_delay 15     // delay before the game starts to let players join the server first
+//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 dance g-23 glowplant leave_em_behind newtonian-nightmare nexballarena red-planet runningman space-elevator stormkeep techassault xoylent"
+// 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 a match is being played)
+// 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
-//g_ctf_capture_limit -1       // frag/capture limit for CTF
 //capturelimit_override -1     // capture limit for CTF
-//g_domination_point_limit -1  // frag/point limit for DOM
-//g_runematch_point_limit -1   // frag/point limit for RUNE
-//g_keyhunt_point_limit -1     // frag/point limit for KH
-//g_lms_lives_override -1      // lives for LMS
-//g_nexball_goallimit -1       // goals for NEXBALL
+//g_domination_point_limit -1
+//g_keyhunt_point_limit -1
+//g_lms_lives_override -1
+//g_nexball_goallimit -1
 
-//g_ctf_win_mode 0     // CTF win mode: 0 = caps only, 1 = caps + points as tie breaker, 2 = points only
-//g_ctf_ignore_frags 1 // set to 1 to ignore kills except for FC kills
+//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  // teams for KH
+//g_keyhunt_teams_override -1
 
 // GAME MODE: what type of server do you want to host?
-// possible values: dm (deathmatch), tdm (team deathmatch), dom (domination), ctf (ctf), rune (runematch), lms (last man standing), arena (arena), kh (keyhunt), as (assault), ons (onslaught), race (race), nexball (nexball)
-//gametype dm
+// 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.
 
-//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 you one of you internal IPs
-
-//rcon_password ""     // you can use rcon if this password is set.  you need to set the same password in your client if you want to issue rcon commands
-//rcon_restricted_password ""  // put here the password for a "restricted" rcon user (see below)
-
-//bot_number 0 // number of bots to add
 //skill 4      // the bots skill level
-//minplayers 0 // add bots if less then that number of players playing. MAKE SURE ITS LESS THEN maxplayers or people will get blocked by bots!
+//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
 
-//g_maplist_votable 6  // number of maps to vote between.  set to 0 to disable the map voting screen (please enable g_maplist_shuffle above when this is enabled, or votes will be repetitive)
-//g_maplist_votable_suggestions 2      // number of suggestions to accept using the suggestmap command
-//g_maplist_votable_abstain 0  // when 1, people get a "don't care" selection in the vote screen
-//g_maplist_votable_nodetail 1 // when 1, people can't see how many voted for what (to thwart abusive "influential" first votes)
+//g_maplist_votable
+//g_maplist_votable_suggestions
+//g_maplist_votable_abstain
+//g_maplist_votable_nodetail
+
+sv_vote_gametype 1 // uncommented because it's a suggested default
+
+// this also includes an example of creating a custom gamemode
+//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"
+
+//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
 
-//sv_vote_commands "restart fraglimit chmap gotomap nextmap endmatch reducematchtime extendmatchtime allready kick cointoss movetoauto"        // players can vote for those commands or use them if they are masters. You canm also add 'g_grappling_hook' for hook voting, and 'sv_fbskin_green sv_fbskin_red sv_fbskin_orange sv_fbskin_off' for fbskin voting.
-//sv_vote_master_commands "movetored movetoblue movetoyellow movetopink"       // add commands masters can use if logged in or elected. You may want to put 'kickban' here, so masters can keep out punks. It may be good to also put "sv_status_privacy 0" then...
-//rcon_restricted_commands "restart fraglimit chmap gotomap endmatch reducematchtime extendmatchtime allready kick kickban \"sv_cmd bans\" \"sv_cmd unban\" status \"sv_cmd teamstatus\" movetoauto movetored movetoblue movetoyellow movetopink"      // commands for the (stronger) rcon restricted
+// 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.
 
-//sv_vote_call 1       // 0 will disable the normal voting
-//sv_vote_master 1     // 0 will disable voting to become master, good if you prefer to use the master password instead
-//sv_vote_master_password ""   // when set, vlogin PWD will allow people to become master to run master commands directly using vdo
-//sv_vote_majority_factor 0.5  // What percentage of the PLAYERS constitute a majority to win a vote? must be at least 0.5
-//sv_vote_majority_factor_of_voted 0   // What percentage of the VOTERS who already voted constitute a majority to win a vote? must be at least 0.5
-// note: to JUST support simple majorities, set these two factors equal
+// Similar functionality to vote masters
+//rcon_restricted_commands
+//rcon_restricted_password
+
+//sv_maxidle
+
+//sv_taunt
+//sv_autotaunt
 
-//sv_maxidle 0 // idle time in seconds after which players will get kicked
 
-//sv_taunt 1   // 0 to disallow taunts
-//sv_autotaunt 1       // 0 to disallow autotaunts
 
 
 /////////////////////////////////////////////////////////////////////
 // Settings you MIGHT want to change for PRIVACY reasons.
-//
-// The settings here may impact your or your players' privacy and serve to
-// optimize the game for further releases.
-//
-// Change them, or comment them out to turn them off.
+
+//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
 //
 // 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/
+//
+sv_weaponstats_file "http://www.xonotic.org/weaponbalance/"
 
 
 
@@ -139,41 +186,50 @@ sv_weaponstats_file http://www.xonotic.org/weaponbalance/
 /////////////////////////////////////////////////////////////////////
 // Some more advanced settings.  You probably are not interested in changing them at all.
 
-//sys_ticrate 0.0333333        // change to 0.0166667 if your server can take the abuse, can make the game a bit more fluent
+//sv_ready_restart
+//sv_ready_restart_after_countdown
+//sv_ready_restart_repeatable
+//sv_autoscreenshot 0  // Useful for competitions or the ladder.
 
-//sv_ready_restart 0   // 1 to allow players to restart the map when all of them press the ready button
-//sv_ready_restart_after_countdown 0   // if set to 1 the players and map items are reset after the countdown ended, otherwise they're reset already at the beginning of the countdown
-//sv_ready_restart_repeatable 0        "allows the players to restart the game as often as needed
-//sv_autoscreenshot 0  // 1 will force a screenshot for all clients when the map ends.  Useful for competitions or the ladder.
-
-//g_antilag 2  // 0 to disable the antilag feature, 1 and 2 use different methods
+//g_antilag
 
 //sv_maxrate 1000000   // limits client connections to this rate in bytes/seconds
 
 // see Docs/mapdownload.txt for more info
-//sv_curl_defaulturl http://www.xonotic.com/contentdownload/getmap.php?file=   //fallback download URL
+//sv_curl_defaulturl
+
+//sv_defaultcharacter
+//sv_defaultplayermodel
+//sv_defaultplayerskin
+//sv_defaultplayercolors
+//g_fullbrightplayers
+//g_fullbrightitems
 
-//sv_defaultcharacter 0        // 1 will force a specific model for all players
-//sv_defaultplayermodel models/player/nexus.zym        // this model will be used
-//sv_defaultplayerskin 0       // this skin number will be forced for all players
-//sv_defaultplayercolors ""    // you can even force player colors here (16*shirt+pants)
-//g_fullbrightplayers 0        // 1 to make players fullbright
-//g_fullbrightitems 0  // 1 to make items fullbright
+//g_balance_teams
+//g_balance_teams_prevent_imbalance
 
-//g_balance_teams 1    // 0 will show players the team selection menu after joining instead of automaticly putting them on the smaller team
-//g_balance_teams_force 0      // 1 to automaticly balance teams even during a game
+//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
 
-//g_ban_sync_uri "http://94.23.21.40/~xonotic/bans/" // sync bans using this ban list provider (disabled by default, uncomment this line to enable)
-//g_ban_sync_trusted_servers "" // accept bans that were initially set on the server IPs listed here (if not set, your bans are just sent to the sync URIs, but no bans are retrieved from there)
 
-//g_spawnshieldtime 1  // time for which players are protected after spawn
 
 
 /////////////////////////////////////////////////////////////////////
 // "Obvious" mutators that are allowed on a "pure" server
-//g_minstagib 0        // set to 1 for MinstaGib
-//g_weapon_stay 0 // set to 1, 2 or 3 for different weapon-stay modes (1 = traditional, 2 = no ammo but allow throwing, 3 = ghost weapon stay)
-//g_powerups -1 // set to 0 to turn off strength/quad and shield/invincible, and set to 1 to turn them on even in game modes that normally have them turned off
+
+//g_instagib
+//g_weapon_stay
+//g_powerups
+
+
+
+
+/////////////////////////////////////////////////////////////////////
+// Overkill mod settings
+
+// 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.
 
 
 
@@ -181,15 +237,16 @@ sv_weaponstats_file http://www.xonotic.org/weaponbalance/
 /////////////////////////////////////////////////////////////////////
 // WARNING: anything below this line makes your server "impure"!
 
-// enable some mutators you'd like
-//g_cloaked 0  // set to 1 for transparent hard to see players
-//g_grappling_hook 0   // set to 1 to enable the hook (allowed on "pure" server in MinstaGib)
-//g_jetpack 0  // set to 1 to enable the jetpack (allowed on "pure" server in MinstaGib)
-//g_laserguided_missile 0      // set to 1 for laser guided missiles in the RL
-//g_midair 0   // set to 1 to make only midair damage count
-//g_vampire 0  // set to 1 to give players the damage they cause as health
-//sv_gravity 800       // for low gravity, set this somewhere between 50 and 400
-
-// select AT MOST one of these arena mutators (if you didn't select g_minstagib)
-//g_nixnex 0   // set to 1 for No Items Xonotic
-//g_nixnex_with_laser 0        // set to 1 to always give players the laser in NixNex
+// some mutators (and other cvars) you might find interesting
+
+//g_cloaked
+//g_grappling_hook
+//g_jetpack
+//g_midair
+//g_vampire
+//sv_gravity
+
+//g_nix
+//g_nix_with_healtharmor
+//g_nix_with_blaster
+//g_nix_with_powerups