Difference between revisions of "How to run a server"

From OdaWiki
(added rcon_password)
Line 27: Line 27:
  
 
You may wish to set up a map or wad rotation using the [[addmap]] command.
 
You may wish to set up a map or wad rotation using the [[addmap]] command.
 +
 +
 +
== Master server ==
 +
See information about the [[Master|master server]].
 +
 +
== Useful commands ==
 +
==== rquit ====
 +
You can use [[rquit]] instead of [[quit]] when quickly restarting a server, such as within a script. This will tell clients to reconnect immediately, and would provide a smooth transition. You should start a new server on the same port as soon as possible (otherwise players might get bored of waiting and leave).
 +
 +
==== usemasters ====
 +
[[usemasters]] is used to set your server as either private or public.
 +
 +
==== if ====
 +
The [[if]] command allows to run another command depending on the comparison of a [[cvar]] and a static expression. Allows you to script your server.
 +
 +
== Useful variables ==
 +
[[startmapscript]] and [[endmapscript]] contain the scripts that are to be run during map reloads. This can be used to override cvars, but the scripts cannot issue commands. A more flexible alternative to the classic mapcycling.
 +
 +
== Optional Services ==
 +
We provide a range of extended services for running servers to improve experience of both players and server administrators.
 +
 +
=== Software updates ===
 +
The server can check and notify you of software updates. In some cases, it can even run the software update automatically. This will keep your server up-to-date.
 +
 +
=== Global blacklist ===
 +
Some computers and/or persons tend to do nothing but cause trouble. Computers can be afflicted by malicious software and there can be particular individuals with ill intent. We track computer addresses that cause trouble on our network and maintain a blacklist. You can use this on your server to block the access of computers that pose a threat.
 +
 +
== Getting help ==
 +
 +
You can easily [[IRC|talk to us]] if you have a specific problem or wish to make a request.

Revision as of 14:38, 5 May 2008

If you would like to run a server, then simply run the "odasrv" application from the installation directory. You should then automatically have a server up and running with default configuration.

Basics of Configuring a Server

The server can be started with, or without command line parameters. The default behaviour is to bind to local UDP port 10666 (or the next available port; the server console will display the port). The server then finds and loads the WAD files (default: odamex.wad and doom2.wad), loads a map, and begins accepting connections. Unless you have made any changes to settings, the server will run with a default configuration. You should test the server with a client.

Public/private server

First of all, decide if you want your server to be displayed on the Odamex public server list. Set usemasters appropriately.

If you are running a public server, it is a good idea to give it a name. You can name it whatever you choose, but if you want to provide insight reflecting what kind of WAD and game type is being run on it, then do so. To name a public server you must type hostname "x" into the server console, where "x" is the name of the server (with quotes included). Check that the server appears listed on a master server.

Useful settings

Then you can customize server settings with variables and commands. Here are a few examples to get you going:

  • wad x.wad -- Loads the given PWAD, whose name is to be typed in place of the "x".
  • map MAPxx or ExMx -- Goes to the indicated map, where the "x"'s represent digits such as "01" for MAP01. "ExMx" is used when the Ultimate Doom or Shareware Doom is being run, where the "x"'s also represent digits, such as "1" and "1" for E1M1
  • deathmatch x -- Sets the indicated deathmatch mode, where "x" represents the value of the desired deathmatch mode. 1 would be regular deathmatch, while 2 would be altdeath deathmatch. 0 disables deathmatch and enables co-operative mode.
  • rcon_password x -- Sets a remote password for the server. This allows access to server control from within a client console. "x" is the password used within the server and client to set a password and login respectively.

Further configuration

Map and WAD cycles

You may wish to set up a map or wad rotation using the addmap command.


Master server

See information about the master server.

Useful commands

rquit

You can use rquit instead of quit when quickly restarting a server, such as within a script. This will tell clients to reconnect immediately, and would provide a smooth transition. You should start a new server on the same port as soon as possible (otherwise players might get bored of waiting and leave).

usemasters

usemasters is used to set your server as either private or public.

if

The if command allows to run another command depending on the comparison of a cvar and a static expression. Allows you to script your server.

Useful variables

startmapscript and endmapscript contain the scripts that are to be run during map reloads. This can be used to override cvars, but the scripts cannot issue commands. A more flexible alternative to the classic mapcycling.

Optional Services

We provide a range of extended services for running servers to improve experience of both players and server administrators.

Software updates

The server can check and notify you of software updates. In some cases, it can even run the software update automatically. This will keep your server up-to-date.

Global blacklist

Some computers and/or persons tend to do nothing but cause trouble. Computers can be afflicted by malicious software and there can be particular individuals with ill intent. We track computer addresses that cause trouble on our network and maintain a blacklist. You can use this on your server to block the access of computers that pose a threat.

Getting help

You can easily talk to us if you have a specific problem or wish to make a request.