Difference between revisions of "Basic Server Settings"
m (formatting) |
(Changes to sv_*) |
||
| Line 20: | Line 20: | ||
====usemasters==== | ====usemasters==== | ||
| − | Usage: ''' | + | Usage: '''sv_usemasters (0-1)''' |
If this [[cvar]] is enabled, your server will use all of the defined master servers. See [[masters]] for more info on managing contacted master servers. If disabled, your server will be a "private" server and will not show up on launchers. | If this [[cvar]] is enabled, your server will use all of the defined master servers. See [[masters]] for more info on managing contacted master servers. If disabled, your server will be a "private" server and will not show up on launchers. | ||
| Line 29: | Line 29: | ||
====email==== | ====email==== | ||
| − | Usage: ''' | + | Usage: '''sv_email "email@domain.com"''' |
The email cvar is an optional cvar used to display the contact information of a server administrator. It may be left blank. | The email cvar is an optional cvar used to display the contact information of a server administrator. It may be left blank. | ||
====hostname==== | ====hostname==== | ||
| − | Usage: ''' | + | Usage: '''sv_hostname "Example Server Name"''' |
Your hostname is what your server will appear named as in launchers. It is essentially your server's identity to the outside world. | Your hostname is what your server will appear named as in launchers. It is essentially your server's identity to the outside world. | ||
====website==== | ====website==== | ||
| − | Usage: ''' | + | Usage: '''sv_website "http://odamex.net/"''' |
The website can be used to display your server's official website or perhaps the location of the wads that you run on your server. This field may be left blank. | The website can be used to display your server's official website or perhaps the location of the wads that you run on your server. This field may be left blank. | ||
| Line 51: | Line 51: | ||
====password==== | ====password==== | ||
| − | Usage: ''' | + | Usage: '''join_password "example"''' |
| − | If you wish to make your server open to only those you know, you can create a password that is required to join your server. To set a password on your server, simply type '' | + | If you wish to make your server open to only those you know, you can create a password that is required to join your server. To set a password on your server, simply type ''join_password'' followed by your actual password. To have no password on your server, leave the password blank. |
| Line 62: | Line 62: | ||
====maxclients==== | ====maxclients==== | ||
{{latched}} | {{latched}} | ||
| − | Usage: ''' | + | Usage: '''sv_maxclients (1-255)''' |
The maxclients cvar determines how many total clients may connect to a server (and spectate). Though there is theoretical support for up to 255 players in Odamex the true limit depends on the machine running the server and will vary. | The maxclients cvar determines how many total clients may connect to a server (and spectate). Though there is theoretical support for up to 255 players in Odamex the true limit depends on the machine running the server and will vary. | ||
| Line 68: | Line 68: | ||
====maxplayers==== | ====maxplayers==== | ||
{{latched}} | {{latched}} | ||
| − | Usage: ''' | + | Usage: '''sv_maxplayers (1-255)''' |
The maxplayers cvar determines how many total clients may actually join in the game and play. The number of players allowed in a server must be equal or less than '''maxclients'''. | The maxplayers cvar determines how many total clients may actually join in the game and play. The number of players allowed in a server must be equal or less than '''maxclients'''. | ||
====waddownload==== | ====waddownload==== | ||
| − | Usage: ''' | + | Usage: '''sv_waddownload (0-1)''' |
The wad downloading feature takes it cue from more modern gaming engines. Much like games such as Quake and Half-Life, Odamex allows players that connect to download the map files required to play (if they do not already have them). | The wad downloading feature takes it cue from more modern gaming engines. Much like games such as Quake and Half-Life, Odamex allows players that connect to download the map files required to play (if they do not already have them). | ||
If enabled, any client connecting that does not have the needed wad will download it directly from the server. | If enabled, any client connecting that does not have the needed wad will download it directly from the server. | ||
Revision as of 03:31, 6 August 2010
For more information on getting started running a server, visit how to run a server.
Contents
Master Server Communication Settings
addmaster
Usage: addmaster (ip/domain:port)
Adds a master server which the server will advertise to if usemasters is enabled. Server can be added by domain name or ip address followed by port.
delmaster
Usage: delmaster (ip/domain:port)
Deletes a master server which the server will advertise to if usemasters is enabled. Server is deleted by typing delmaster and then any information before the brackets.
masters
Usage: masters
Lists master servers which the server will advertise to if usemasters is enabled.
usemasters
Usage: sv_usemasters (0-1)
If this cvar is enabled, your server will use all of the defined master servers. See masters for more info on managing contacted master servers. If disabled, your server will be a "private" server and will not show up on launchers.
Advertising Settings
Usage: sv_email "email@domain.com"
The email cvar is an optional cvar used to display the contact information of a server administrator. It may be left blank.
hostname
Usage: sv_hostname "Example Server Name"
Your hostname is what your server will appear named as in launchers. It is essentially your server's identity to the outside world.
website
Usage: sv_website "http://odamex.net/"
The website can be used to display your server's official website or perhaps the location of the wads that you run on your server. This field may be left blank.
Privacy Settings
Bans & Exceptions
Read ban and exception lists for more information.
password
Usage: join_password "example"
If you wish to make your server open to only those you know, you can create a password that is required to join your server. To set a password on your server, simply type join_password followed by your actual password. To have no password on your server, leave the password blank.
Client Connections
For information on protecting your server from malicious users, visit Abuse Prevention.
maxclients
Usage: sv_maxclients (1-255)
The maxclients cvar determines how many total clients may connect to a server (and spectate). Though there is theoretical support for up to 255 players in Odamex the true limit depends on the machine running the server and will vary.
maxplayers
Usage: sv_maxplayers (1-255)
The maxplayers cvar determines how many total clients may actually join in the game and play. The number of players allowed in a server must be equal or less than maxclients.
waddownload
Usage: sv_waddownload (0-1)
The wad downloading feature takes it cue from more modern gaming engines. Much like games such as Quake and Half-Life, Odamex allows players that connect to download the map files required to play (if they do not already have them).
If enabled, any client connecting that does not have the needed wad will download it directly from the server.