]> git.xonotic.org Git - xonotic/xonotic.git/commitdiff
cleanup example config
authorMartin Taibr <taibr.martin@gmail.com>
Tue, 17 Sep 2019 08:51:59 +0000 (10:51 +0200)
committerMartin Taibr <taibr.martin@gmail.com>
Tue, 17 Sep 2019 08:51:59 +0000 (10:51 +0200)
server/server.cfg

index b7185fe549caacde38344a39389ce5350fb94d36..780763a62bef5005ed40cc7e7fe2f8fbe3996409 100644 (file)
@@ -2,7 +2,7 @@
 // or the equivalent directory on your OS (https://xonotic.org/faq/#config).
 
 // Two slashes start a comment until the end of the line.
-// Surround settings with double quotes (e.g. cvar_name "some value") unless they're a single number or word.
+// 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).
 
 //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 ""   // displayed on connect - good place for contact info (IRC, forum nick, etc.) so players can reach you when something is wrong with your 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.
+// 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 examples for people who want to customize the server more.
-// The values shown are either defaults or examples (for up to date defaults, see 'search' (or 'apropos') in console.
+// 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 8 // number of player slots on the server (including spectators)
+//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
 
 // (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
 
-// 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_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 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
 //capturelimit_override -1     // capture limit for CTF
-//g_domination_point_limit -1  // frag/point limit for DOM
-//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_ignore_frags 0 // 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), 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)
@@ -73,6 +81,7 @@
 
 
 
+
 /////////////////////////////////////////////////////////////////////
 // Some settings you MIGHT want to change.  Again IF so remove the //
 // from the line start and change them to your liking.
 //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)
-
-sv_vote_gametype 1     // set to 1 to enable voting for gametypes after every match
-//sv_vote_gametype_options "dm kh dom tdm mycustom"    // the gametypes to vote for, custom gametypes are supported (max 9 chars for the gametype identifier because sv_vote_gametype_hook_* can have max 31 chars)
-//set sv_vote_gametype_mycustom_name "My Custom Mode"  // Name displayed for the custom gametype "mycustom" (replace "mycustom" with the name you set in sv_vote_gametype_options)
-//set sv_vote_gametype_mycustom_type "ft"      // the basetype that the custom gametype is derived from
-//set sv_vote_gametype_mycustom_description "This is my custom gametype"       // the description for the custom gametype
-// Custom icons for custom gametypes are supported and have to be located in a server pk3 as gfx/menu/default/gametype_mycustom
-
-//sv_vote_commands "restart fraglimit chmap gotomap nextmap endmatch reducematchtime extendmatchtime allready kick cointoss movetoauto shuffleteams"   // 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
-//rcon_restricted_password ""  // put here the password for a "restricted" rcon user (see below)
-
-//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
+//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_maxidle 0 // idle time in seconds after which players will get kicked
+// 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, so masters can keep out punks. It may be good to also put "sv_status_privacy 0" then...
 
-//sv_taunt 1   // 0 to disallow taunts
-//sv_autotaunt 1       // 0 to disallow autotaunts
+// Similar functionality to vote masters
+//rcon_restricted_commands
+//rcon_restricted_password
+
+//sv_maxidle
+
+//sv_taunt
+//sv_autotaunt
 
 
 
@@ -167,41 +186,42 @@ sv_weaponstats_file "http://www.xonotic.org/weaponbalance/"
 /////////////////////////////////////////////////////////////////////
 // Some more advanced settings.  You probably are not interested in changing them at all.
 
-//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.
+//sv_ready_restart
+//sv_ready_restart_after_countdown
+//sv_ready_restart_repeatable
+//sv_autoscreenshot 0  // 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.org/contentdownload/getmap.php?file=   //fallback download URL
+//sv_curl_defaulturl
 
-//sv_defaultcharacter 0        // 1 will force a specific model for all players
-//sv_defaultplayermodel models/player/erebus.iqm       // 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
+//sv_defaultcharacter
+//sv_defaultplayermodel
+//sv_defaultplayerskin
+//sv_defaultplayercolors
+//g_fullbrightplayers
+//g_fullbrightitems
 
-//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_prevent_imbalance 1  // 0 to prevent switchint to a bigger/begger team
+//g_balance_teams
+//g_balance_teams_prevent_imbalance
 
-//g_ban_sync_uri "http://46.38.241.138/~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_ban_sync_uri "http://46.38.241.138/~xonotic/bans/" // this ban list provider is currently offline
+//g_ban_sync_trusted_servers
 
-//g_spawnshieldtime 1  // time for which players are protected after spawn
+//g_spawnshieldtime
 
 
 
 
 /////////////////////////////////////////////////////////////////////
 // "Obvious" mutators that are allowed on a "pure" server
-//g_instagib 0 // set to 1 for InstaGib
-//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
 
 
 
@@ -217,16 +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 InstaGib)
-//g_jetpack 0  // set to 1 to enable the jetpack (allowed on "pure" server in InstaGib)
-//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_instagib)
-//g_nix is "0" ["0"] No Items Xonotic - instead of pickup items, everyone plays with the same weapon. After some time, a countdown will start, after which everyone will switch to another weapon, and so on
-//g_nix_with_healtharmor is "0" ["0"] when 1, health and armor still show up in NIX
-//g_nix_with_blaster is "0" ["0"] always carry the blaster as an additional weapon in NIX
-//g_nix_with_powerups is "0" ["0"] when 1, powerups still show up in NIX
+// 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