Difference between revisions of "Basic Server Settings"

Latest revision as of 07:43, 26 July 2012

For more information on getting started running a server, visit how to run a server.

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.

Network Settings

Universal Plug and Play

Universal Plug and Play, or UPnP for short, is a set of networking protocols used mainly by residential networks that allow ease of use in connecting computers, routers, printers, and other similar devices to find and communicate with each other seamlessly. This is particularly useful for Odamex in that it allows easy setup of Odamex servers without the need to modify router port forwarding manually.

Enabling UPnP

Usage sv_upnp (0-1)

Enables Universal Plug and Play to autoconfigure on compliant routers.

UPnP Discover Timeout

Usage sv_upnp_discovertimeout (#)

Length of time that Odamex will seek for UPnP compliant routers at server start up.

UPnP Description

Usage sv_upnp_description "Odamex Server"

PLEASE DOCUMENT.

UPnP Internal IP

Usage sv_upnp_internalip

This cvar stores the internal IP address of the router. It cannot be changed.

UPnP External IP

Usage sv_upnp_externalip

This cvar stores the external IP address of the router. It cannot be changed.

maxrate

Usage: sv_maxrate (500-200000)

The maxrate cvar puts a soft cap on the amount of bytes per second to send to each client. Certain kinds of important information will still be sent when this cap is reached, but most will not be.

natport

Usage: sv_natport (Port #)

Sometimes NAT software (if running) will skewer a server's port number in the ip/udp header. This cvar can be used to bypass this. If a server is not being reported to the master, try setting this to the specified port number.

networkcompression

Usage: sv_networkcompression (0-1)

The network compression cvar compresses network packets to make them smaller, lowering bandwidth usage. However, this cvar is currently experimental, so server administrators should use at their own risk.

Advertising Settings

email

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.

motd

Usage: sv_motd "Welcome to Odamex!"

The motd (which stands for message of the day) is displayed to players on connect. In the example above, players would be greeted with the message "Welcome to Odamex!". This field may be left blank.

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.

join 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.

rcon password

Usage: rcon_password "example"

The rcon (or remote console) password is used for controlling a server from clients or other utilities. Using the above example, a client could connect to and control a server through their console by using the command rcon_password example. They could then execute commands or change cvars on the server through their client by using rcon [command].

Client Connections

For information on protecting your server from malicious users, visit Abuse Prevention.

maxclients

This is a latched variable, and only takes effect after a map change.

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

This is a latched variable, and only takes effect after a map change.

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.

maxplayersperteam

This is a latched variable, and only takes effect after a map change.

Usage: sv_maxplayersperteam (0-255)

This cvar determines maximum amount of players allowed on a team. 0 disables this feature.

Ticbuffer

Usage: sv_ticbuffer (0-1)

Enables Odamex's tic buffer feature. Buffers player's controller input to help provide smoother movement when lag spikes occur.

Unlagged

Usage: sv_unlag (0-1)

Enables Odamex's unlagged feature.

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.

Useful Commands

cmdlist

Usage: cmdlist

Outputs a list of all available console commands to the console. This command works on both servers and clients.

cvarlist

Usage: cvarlist

Outputs a list of all available variables to the console. This command works on both servers and clients.

Map List

For full information on modifying and maintaining a map list, refer to Map List.

Voting

For full information on modifying and maintaining client vote privileges, refer to Voting.

@@ Line 1: / Line 1: @@
 ''For more information on getting started running a server, visit [[how to run a server]].''
-=== Master Server Communication Settings ===
+== Master Server Communication Settings ==
-====addmaster====
+===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====
+===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====
+===masters===
 Usage: '''masters'''
 Lists master servers which the server will advertise to if '''usemasters''' is enabled.
-====usemasters====
+===usemasters===
-Usage: '''usemasters (0-1)'''
+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 ===
+== Network Settings ==
-====email====
+===Universal Plug and Play===
-Usage: '''email "email@domain.com"'''
+Universal Plug and Play, or UPnP for short, is a set of networking protocols used mainly by residential networks that allow ease of use in connecting computers, routers, printers, and other similar devices to find and communicate with each other seamlessly. This is particularly useful for Odamex in that it allows easy setup of Odamex servers without the need to modify router port forwarding manually.
+====Enabling UPnP====
+Usage '''sv_upnp (0-1)'''
+Enables Universal Plug and Play to autoconfigure on compliant routers.
+====UPnP Discover Timeout====
+Usage '''sv_upnp_discovertimeout (#)'''
+Length of time that Odamex will seek for UPnP compliant routers at server start up.
+====UPnP Description====
+Usage '''sv_upnp_description "Odamex Server"'''
+PLEASE DOCUMENT.
+====UPnP Internal IP====
+Usage '''sv_upnp_internalip'''
+This cvar stores the internal IP address of the router. It cannot be changed.
+====UPnP External IP====
+Usage '''sv_upnp_externalip'''
+This cvar stores the external IP address of the router. It cannot be changed.
+===maxrate===
+Usage: '''sv_maxrate (500-200000)'''
+The maxrate cvar puts a soft cap on the amount of bytes per second to send to each client. Certain kinds of important information will still be sent when this cap is reached, but most will not be.
+===natport===
+Usage: '''sv_natport (Port #)'''
+Sometimes NAT software (if running) will skewer a server's port number in the ip/udp header. This cvar can be used to bypass this. If a server is not being reported to the master, try setting this to the specified port number.
+===networkcompression===
+Usage: '''sv_networkcompression (0-1)'''
+The network compression cvar compresses network packets to make them smaller, lowering bandwidth usage. However, this cvar is currently experimental, so server administrators should use at their own risk.
+== Advertising Settings ==
+===email===
+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====
+===hostname===
-Usage: '''hostname "Example Server Name"'''
+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====
+===motd===
-Usage: '''website "http://odamex.net/"'''
+Usage: '''sv_motd "Welcome to Odamex!"'''
+The motd (which stands for message of the day) is displayed to players on connect. In the example above, players would be greeted with the message "Welcome to Odamex!". This field may be left blank.
+===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 ===
+== Privacy Settings ==
-====Bans & Exceptions====
+===Bans & Exceptions===
 Read [[ban and exception lists]] for more information.
-====password====
+===join password===
-Usage: '''password "example"'''
+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 ''password'' followed by your actual password. To have no password on your server, leave the password blank.
+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 ===
+===rcon password===
+Usage: '''rcon_password "example"'''
-====maxclients====
+The rcon (or remote console) password is used for controlling a server from clients or other utilities. Using the above example, a client could connect to and control a server through their console by using the command '''rcon_password example'''. They could then execute commands or change cvars on the server through their client by using '''rcon [command]'''.
+== Client Connections ==
+''For information on protecting your server from malicious users, visit [[Abuse Prevention]].''
+===maxclients===
 {{latched}}
-Usage: '''maxclients (1-255)'''
+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====
+===maxplayers===
 {{latched}}
-Usage: '''maxplayers (1-255)'''
+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====
+===maxplayersperteam===
-Usage: '''waddownload (0-1)'''
+{{latched}}
+Usage: '''sv_maxplayersperteam (0-255)'''
+This cvar determines maximum amount of players allowed on a team. 0 disables this feature.
+===Ticbuffer===
+Usage: '''sv_ticbuffer (0-1)'''
+Enables Odamex's tic buffer feature. Buffers player's controller input to help provide smoother movement when lag spikes occur.
+===Unlagged===
+Usage: '''sv_unlag (0-1)'''
+Enables Odamex's [[unlagged]] feature.
+===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.
+== Useful Commands ==
+===cmdlist===
+Usage: '''cmdlist'''
+Outputs a list of all available console commands to the console. This command works on both servers and clients.
+===cvarlist===
+Usage: '''cvarlist'''
+Outputs a list of all available variables to the console. This command works on both servers and clients.
+===Map List===
+''For full information on modifying and maintaining a map list, refer to [[Map List]].''
+===Voting===
+''For full information on modifying and maintaining client vote privileges, refer to [[Voting]].''

OdaWiki

Difference between revisions of "Basic Server Settings"

Latest revision as of 07:43, 26 July 2012

Contents

Master Server Communication Settings

addmaster

delmaster

masters

usemasters

Network Settings

Universal Plug and Play

Enabling UPnP

UPnP Discover Timeout

UPnP Description

UPnP Internal IP

UPnP External IP

maxrate

natport

networkcompression

Advertising Settings

email

hostname

motd

website

Privacy Settings

Bans & Exceptions

join password

rcon password

Client Connections

maxclients

maxplayers

maxplayersperteam

Ticbuffer

Unlagged

waddownload

Useful Commands

cmdlist

cvarlist

Map List

Voting