Difference between revisions of "Replay server configuration"

From Team Fortress Wiki
Jump to: navigation, search
(→‎Finishing Touches)
(Cleaned up this page's info, remove references to "orangebox" since SteamPipe removed that)
Line 2: Line 2:
  
 
==Prerequisites==
 
==Prerequisites==
−
* FTP information for remotely handling replay files.
+
To enable a server to record replays, one of the following is required:
−
* A installed web server on the local server for handling replay files locally.
+
* A remote FTP server to host the replay files (the "ftp" method)
−
:* Location you wish to store replay files.
+
* A web server at the same location as the game server, with a dedicated location for storing replay files (the "local http" method)
−
* For both instances the folder directory needs to be accessible by the public and files downloaded.
+
In both cases, the directory in which replays are stored needs to be accessible to the public.
  
 
==Setup==
 
==Setup==
 
===File Names and Locations===
 
===File Names and Locations===
−
<pre>/orangebox/tf/cfg/replay.cfg
+
<pre>/tf/cfg/replay.cfg
−
/orangebox/tf/cfg/replay_local_http.cfg
+
/tf/cfg/replay_local_http.cfg
−
/orangebox/tf/cfg/replay_ftp.cfg</pre>
+
/tf/cfg/replay_ftp.cfg</pre>
  
 
==Enabling Replay==
 
==Enabling Replay==
−
<pre>/orangebox/tf/cfg/replay.cfg</pre>
+
<pre>/tf/cfg/replay.cfg</pre>
  
 
'''replay_enable 0'''
 
'''replay_enable 0'''
Line 23: Line 23:
 
----
 
----
 
'''Note:''' Only choose one of the below methods! Comment out the method you do not wish to use.
 
'''Note:''' Only choose one of the below methods! Comment out the method you do not wish to use.
−
For example if you would like to use the local http method you will do:
+
For example if you would like to use the local http method, add <code>//</code> before the line pertaining to <code>replay_ftp.cfg</code>:
 
<pre>exec replay_local_http
 
<pre>exec replay_local_http
 
//exec replay_ftp.cfg</pre>
 
//exec replay_ftp.cfg</pre>
Line 36: Line 36:
 
* Your Team Fortress 2 Server needs to have a web server installed and properly configured for allowing public downloads from the specified replay directory.
 
* Your Team Fortress 2 Server needs to have a web server installed and properly configured for allowing public downloads from the specified replay directory.
  
−
<pre>/orangebox/tf/cfg/replay_local_http.cfg</pre>
+
<pre>/tf/cfg/replay_local_http.cfg</pre>
  
 
'''replay_local_fileserver_path "location/of/replay/folder"'''
 
'''replay_local_fileserver_path "location/of/replay/folder"'''
−
: This is the folder where you will be storing your replay data, this folder '''must''' be accessible via the public.
+
: This is the folder (relative to the game/web server) in which the game server will be storing replay data; this folder '''must''' be accessible to the public.
  
 
----
 
----
  
 
'''replay_fileserver_host "my.domain.tld"'''
 
'''replay_fileserver_host "my.domain.tld"'''
−
: This is the domain that you wish to use for serving your files. If you do not have a domain, you can just use the IP that is assigned to the web server.
+
: This is the URL that clients will download replays from. Either the domain of the web server or the web server's IP may go here.
−
'''replay_fileserver_port "80"'''
+
'''replay_fileserver_port "80"'''
−
: This is the port your web server is running on, unless you had to change it to another port leave this at 80.
+
: This is the port the web server is running on (the default port for web servers is typically 80).
 
'''replay_fileserver_path "/replays"'''
 
'''replay_fileserver_path "/replays"'''
−
: This is the public folder on the webserver where the files are. (my.domain.tld'''/replays''')
+
: This is the public path (relative to the host/domain) on the webserver where the replay files are stored. (my.domain.tld'''/replays''')
  
 
==Remote FTP==
 
==Remote FTP==
Line 54: Line 54:
 
* You must have the FTP login details for the remote location you wish to use.
 
* You must have the FTP login details for the remote location you wish to use.
  
−
<pre>/orangebox/tf/cfg/replay_ftp.cfg</pre>
+
<pre>/tf/cfg/replay_ftp.cfg</pre>
  
 
'''replay_fileserver_host "my.domain.tld"'''
 
'''replay_fileserver_host "my.domain.tld"'''
−
: This is the domain that you wish to use for serving your files. If you do not have a domain, you can just use the IP that is assigned to the web server.
+
: This is the URL that clients will download replays from. Either the domain of the FTP server or the FTP server's IP may go here.
 
'''replay_fileserver_port  "80"'''
 
'''replay_fileserver_port  "80"'''
−
: This is the port your web server is running on, unless you had to change it to another port leave this at 80.
+
: This is the port the FTP server is serving files on (the default port for web servers is typically 80).
 
'''replay_fileserver_path "/replays"'''
 
'''replay_fileserver_path "/replays"'''
−
: This is the public folder on the webserver where the files are. (my.domain.tld'''/replays''')
+
: This is the public path (relative to the host/domain) on the FTP server where the replay files are stored. (my.domain.tld'''/replays''')
  
 
----
 
----
Line 68: Line 68:
 
: Currently FTP is only supported so leave this as is.
 
: Currently FTP is only supported so leave this as is.
 
'''replay_fileserver_offload_hostname "IP/my.domain.tld"'''
 
'''replay_fileserver_offload_hostname "IP/my.domain.tld"'''
−
: This is the IP or domain you use to connect to the FTP server.
+
: This is the IP or domain used to connect to the FTP server to upload files.
 
'''replay_fileserver_offload_port "21"'''
 
'''replay_fileserver_offload_port "21"'''
−
: Unless you have change the port FTP is running on, you should not need to change this.
+
: This is the port on which files are uploaded to the FTP server (the default is usually 21).
 
'''replay_fileserver_offload_remotepath "location/of/replay/folder"'''
 
'''replay_fileserver_offload_remotepath "location/of/replay/folder"'''
−
: This is the folder where you will be storing your replay data, this folder '''must''' be accessible via the public.
+
: This is the folder on the FTP server to which the game server will upload replay data; this folder '''must''' be accessible to the public.
 
'''replay_fileserver_offload_login "login ID"'''
 
'''replay_fileserver_offload_login "login ID"'''
−
: The login id or username used to login to the FTP server.
+
: The login ID or username used to log on to the FTP server.
 
'''replay_fileserver_offload_password "password"'''
 
'''replay_fileserver_offload_password "password"'''
−
: This is the password used in combination of your login id to login to the FTP server.
+
: This is the password used in conjunction with the login ID to log on to the FTP server.
 
'''replay_fileserver_offload_maxuploads "16"'''
 
'''replay_fileserver_offload_maxuploads "16"'''
−
: The max amount concurrent uploads allowed.
+
: This limits the maximum amount of uploads the game server can perform at once to the FTP server.
  
 
==Finishing Touches==
 
==Finishing Touches==
Line 85: Line 85:
  
 
For example for linux you may have:
 
For example for linux you may have:
−
<pre>./orangebox/srcds_run -game tf -replay...</pre>
+
<pre>./srcds_run -game tf -replay...</pre>
  
 
For Windows you may have:
 
For Windows you may have:
−
<pre>\orangebox\srcds.exe -console -game tf -replay...</pre>
+
<pre>\srcds.exe -console -game tf -replay...</pre>
  
 
If you are running multiple servers on one machine you may specify a different directory for each server using "-replayserverdir <foldername>" in the server command line.
 
If you are running multiple servers on one machine you may specify a different directory for each server using "-replayserverdir <foldername>" in the server command line.
  
 
For linux you may have:
 
For linux you may have:
−
<pre>./orangebox/srcds_run -game tf -replay -replayserverdir server1...</pre>
+
<pre>./srcds_run -game tf -replay -replayserverdir server1...</pre>
  
 
For Windows you may have:
 
For Windows you may have:
−
<pre>\orangebox\srcds.exe -console -game tf -replay -replayserverdir server1...</pre>
+
<pre>\srcds.exe -console -game tf -replay -replayserverdir server1...</pre>
  
 
Where '''server1''' is the name you choose for the folder for that server. This is '''not''' a folder path, just the name.
 
Where '''server1''' is the name you choose for the folder for that server. This is '''not''' a folder path, just the name.

Revision as of 09:41, 2 February 2014

Replay is a video recording feature for Team Fortress 2 servers allowing clients to download and edit video footage of their previous life after they die. For more information about the replay system seek the Replay wiki page.

Prerequisites

To enable a server to record replays, one of the following is required:

  • A remote FTP server to host the replay files (the "ftp" method)
  • A web server at the same location as the game server, with a dedicated location for storing replay files (the "local http" method)

In both cases, the directory in which replays are stored needs to be accessible to the public.

Setup

File Names and Locations

/tf/cfg/replay.cfg
/tf/cfg/replay_local_http.cfg
/tf/cfg/replay_ftp.cfg

Enabling Replay

/tf/cfg/replay.cfg

replay_enable 0

Disables the replay system.

replay_enable 1

Enables the replay system.

Note: Only choose one of the below methods! Comment out the method you do not wish to use. For example if you would like to use the local http method, add // before the line pertaining to replay_ftp.cfg: 

exec replay_local_http
//exec replay_ftp.cfg

exec replay_local_http

Handles replay files via a locally installed and configured web server.

exec replay_ftp.cfg

Handles replay files via a remote webserver using FTP.

Local HTTP

Requirements

  • Your Team Fortress 2 Server needs to have a web server installed and properly configured for allowing public downloads from the specified replay directory.
/tf/cfg/replay_local_http.cfg

replay_local_fileserver_path "location/of/replay/folder"

This is the folder (relative to the game/web server) in which the game server will be storing replay data; this folder must be accessible to the public.

replay_fileserver_host "my.domain.tld"

This is the URL that clients will download replays from. Either the domain of the web server or the web server's IP may go here.

replay_fileserver_port "80"

This is the port the web server is running on (the default port for web servers is typically 80).

replay_fileserver_path "/replays"

This is the public path (relative to the host/domain) on the webserver where the replay files are stored. (my.domain.tld/replays)

Remote FTP

Requirements

  • You must have the FTP login details for the remote location you wish to use.
/tf/cfg/replay_ftp.cfg

replay_fileserver_host "my.domain.tld"

This is the URL that clients will download replays from. Either the domain of the FTP server or the FTP server's IP may go here.

replay_fileserver_port "80"

This is the port the FTP server is serving files on (the default port for web servers is typically 80).

replay_fileserver_path "/replays"

This is the public path (relative to the host/domain) on the FTP server where the replay files are stored. (my.domain.tld/replays)

replay_fileserver_offload_protocol "ftp"

Currently FTP is only supported so leave this as is.

replay_fileserver_offload_hostname "IP/my.domain.tld"

This is the IP or domain used to connect to the FTP server to upload files.

replay_fileserver_offload_port "21"

This is the port on which files are uploaded to the FTP server (the default is usually 21).

replay_fileserver_offload_remotepath "location/of/replay/folder"

This is the folder on the FTP server to which the game server will upload replay data; this folder must be accessible to the public.

replay_fileserver_offload_login "login ID"

The login ID or username used to log on to the FTP server.

replay_fileserver_offload_password "password"

This is the password used in conjunction with the login ID to log on to the FTP server.

replay_fileserver_offload_maxuploads "16"

This limits the maximum amount of uploads the game server can perform at once to the FTP server.

Finishing Touches

Now that you have fully configured Replay for your server you will need to start your server adding "-replay" to the server command line.

For example for linux you may have: 

./srcds_run -game tf -replay...

For Windows you may have: 

\srcds.exe -console -game tf -replay...

If you are running multiple servers on one machine you may specify a different directory for each server using "-replayserverdir <foldername>" in the server command line.

For linux you may have: 

./srcds_run -game tf -replay -replayserverdir server1...

For Windows you may have: 

\srcds.exe -console -game tf -replay -replayserverdir server1...

Where server1 is the name you choose for the folder for that server. This is not a folder path, just the name.

See also

Team Fortress 2 Replay Server Overview on Steam Support

Retrieved from "https://wiki.teamfortress.com/w/index.php?title=Replay_server_configuration&oldid=1612849"