Update Basic server configuration
[xonotic/xonotic.wiki.git] / Basic-server-configuration.md
1 During the start of the server, it searches for the `data/server.cfg` file and executes it. You need to create it inside [your user directory](http://www.xonotic.org/faq/#config).
2
3 # Quick start
4 Xonotic comes with an example configuration in `/server/server.cfg`. You can copy it into your user directory and simply edit it.
5
6 # Hello world
7 A minimal configuration would be this:
8
9 ```
10 sv_public 1
11 hostname "My Test server"
12 ```
13
14 It creates a server named "My Test server" that can handle 16 players and is visible on the master server. It will run deathmatch with default settings.
15
16 # Basic settings
17 ```
18 sv_motd "Hi, this is my epic server"
19 ```
20 Specifies the "message of the day" which will be displayed to players when they connect or press the info button.
21
22 ```
23 maxplayers 32
24 ```
25 Specifies the maximum number of players on the server.
26
27 ```
28 timelimit_override 20
29 ```
30 Overrides the time limit for each map in minutes. 0 to play without limit, -1 to use the time limit specified by the map.
31
32 ```
33 port 26000
34 ```
35 Specifies the port which is used by the server. This can be very useful if you want to run more than 1 server on the same machine. In that case, ports for each server must be unique.
36
37 ```
38 log_file "server.log"
39 ```
40 If set, the server will log game events to a file. Beware that this file may become very large with time.
41
42 ```
43 rcon_password "Correct horse battery staple"
44 ```
45 Specifies a RCON (remote console) password that can be used to control your server remotely such as from the connected client. This can be very useful when you are playing on your server and want to quickly change some settings.
46
47 # Gametype and maps
48 ```
49 gametype dm
50 ```
51 Specifies default gametype that will be played.
52
53 ```
54 sv_vote_gametype 0
55 ```
56 If set to 1, players will be able to vote for different gametypes.
57
58 ```
59 sv_vote_gametype_options "dm tdm lms ctf ca ft ka kh dom ons as"
60 ```
61 Specifies the list of gametypes that the player are allowed to vote for.
62
63 ```
64 g_maplist_votable 6
65 ```
66 Specifies the number of maps that will be offered for voting. Higher values will allow more choices.
67
68 ```
69 g_maplist_votable_nodetail 1
70 ```
71 If set to 0, the players will be able to see the number of votes for each map (or gametype if `sv_vote_gametype` is 1).
72
73 # Bots
74 ```
75 minplayers 0
76 ```
77 If set to more than 0, the server will try to make sure that the number of all active players matches the value set. For example, if `minplayers` is 4 and there is 1 person playing, the server will have 3 bots. Bots will leave or join when the number of players changes. When nobody is connected to the server, no bots will be playing.
78
79 ```
80 skill 5
81 ```
82 Sets the skill level of bots. Higher values mean harder bots. Possible values are 0 through 10.
83
84 # Warmup
85 ```
86 g_warmup 0
87 ```
88 If set to 1, the map will start in the warmup mode which is designed to let everyone join before the game begins. All players will need to become ready (by pressing `F4` by default) or vote `allready` in order for the game to begin.
89
90 ```
91 g_warmup_limit 0
92 ```
93 If set to more than 0, specifies the maximum time of the warmup state. Can be used to force the game to begin without player consensus or when players forgot about warmup being active.
94
95 # More advanced configuration
96 You can find other useful variables using the [Command And Cvar search tool on xonotic.org](https://xonotic.org/tools/cacs).