(Created page with "This guide takes you through the steps required to create a dedicated SCP:SL server on '''Windows'''. =Minimum Server Specifications= *4 GB RAM *2 core CPU *~600 MB storage s...") |
(Linux) |
||
| Line 1: | Line 1: | ||
This guide takes you through the steps required to create a dedicated SCP:SL server on '''Windows'''. | __TOC__ | ||
This guide takes you through the steps required to create a dedicated SCP:SL server on '''Windows''' and '''Linux'''. | |||
=Minimum Server Specifications= | =Minimum Server Specifications= | ||
| Line 6: | Line 7: | ||
*~600 MB storage space | *~600 MB storage space | ||
=Prerequisites= | =Windows Instructions= | ||
===Prerequisites=== | |||
*Mono (64-bit) - Framework used by Unity for a lot of things, needed to fix certain voice chat issues | *Mono (64-bit) - Framework used by Unity for a lot of things, needed to fix certain voice chat issues | ||
*[https://developer.valvesoftware.com/wiki/SteamCMD#Downloading_SteamCMD SteamCMD] - Used to install and update the server | *[https://developer.valvesoftware.com/wiki/SteamCMD#Downloading_SteamCMD SteamCMD] - Used to install and update the server | ||
=Installing the server | ===Installing the SCP:SL dedicated server with SteamCMD=== | ||
SteamCMD is used to install the SCP:SL server in a specified location, this will also make it easier to update it once there is an update. | SteamCMD is used to install the SCP:SL server in a specified location, this will also make it easier to update it once there is an update. | ||
| Line 19: | Line 21: | ||
<code>login anonymous</code> | <code>login anonymous</code> | ||
'''Setting install directory'''<br> | '''Setting install directory'''<br> | ||
| Line 25: | Line 26: | ||
<code>force_install_dir <directory></code> - (eg. C:/SL_Server) | <code>force_install_dir <directory></code> - (eg. C:/SL_Server) | ||
'''Installing it'''<br> | '''Installing it'''<br> | ||
| Line 31: | Line 31: | ||
<code>app_update 996560</code> | <code>app_update 996560</code> | ||
'''Validating'''<br> | '''Validating'''<br> | ||
| Line 38: | Line 37: | ||
<code>app_update 996560 validate</code> | <code>app_update 996560 validate</code> | ||
===(Optional) Creating | ===(Optional) Creating an update script=== | ||
A batch file can be created to have the server automatically updated when needed. | A batch file can be created to have the server automatically updated when needed. | ||
| Line 51: | Line 50: | ||
+quit | +quit | ||
</code> | </code> | ||
=Linux Instructions= | |||
===Prerequisites=== | |||
*An already set-up server with SSH and FTP configured | |||
===Installing components=== | |||
<code>sudo apt install '''mono-complete'''</code> - Framework used by Unity for a lot of things, needed to fix certain voice chat issues<br> | |||
<code>sudo apt-get install '''tmux'''</code> - Allows running multiple windows in a single session, in our case it used to keep the server running without having to be logged into it<br> | |||
<code>sudo apt-get install '''steamcmd'''</code> - Used to install and update the server | |||
===Creating new user=== | |||
A new user will be created to be specifically used for the SL server, as using the root user is insecure. | |||
<code>sudo adduser scpserver</code> - Creates a new user with the name "scpserver"<br> | |||
<code>su - scpserver</code> - Changes active user to "scpserver" | |||
===Installing the SCP:SL dedicated server with SteamCMD=== | |||
SteamCMD is used to install the SCP:SL server in a specified location, this will also make it easier to update it once there is an update. | |||
<code>steamcmd</code> - Used to run steamcmd and be able to input the required commands | |||
'''Logging in'''<br> | |||
To be able to download the server it must be logged into into steam. | |||
Logging in as anonymous works, but it can also be logged in into a steam account. | |||
<code>login anonymous</code> | |||
'''Setting install directory'''<br> | |||
To set the desired server directory/install location. | |||
<code>force_install_dir <directory></code> - (eg. /home/SL_Server) | |||
'''Installing it'''<br> | |||
To install the dedicated server the appid '''996560''' is used, it is the headless build of SCP:SL and will run faster than if the game itself was used to host. | |||
<code>app_update 996560</code> | |||
'''Validating'''<br> | |||
To make sure that no required files are missing or corrupted. | |||
<code>app_update 996560 validate</code> | |||
===Starting up the server=== | |||
On linux starting the server is a bit different than on windows. | |||
<code>screen -a</code> - Uses screen with all capabilities when starting server<br> | |||
<code>cd <directory></code> - Select server directory<br> | |||
<code>mono LocalAdmin.exe</code> - Starts up the server with LocalAdmin | |||
=Server Configuration= | =Server Configuration= | ||
| Line 56: | Line 105: | ||
After installing the server can be configured, and settings such as the server name, info tab, player count and similar can be set. | After installing the server can be configured, and settings such as the server name, info tab, player count and similar can be set. | ||
All of these settings can be changed in the '''config_gameplay.txt''' file. | All of these settings can be changed in the '''config_gameplay.txt/config.txt''' file. | ||
*On Windows: '''%AppData%\Roaming\SCP Secret Laboratory\config_gameplay.txt''' | |||
*On Linux: '''\home\{username}\.config\SCP Secret Laboratory\config.txt''' | |||
===Basic Fields=== | ===Basic Fields=== | ||
<code>server_name:</code> - Used to set the server name<br> | <code>server_name:</code> - Used to set the server name<br> | ||
<code>server_ip: <IP/auto></code> - Used to set the IP address used by the server, it must be a IPv4 address. If it is set to auto it will automatically choose the machine's address (used for dynamic IPs).<br> | <code>server_ip: <IP/auto></code> - Used to set the IP address used by the server, it must be a IPv4 address. If it is set to auto it will automatically choose the machine's address (used for dynamic IPs).<br> | ||
<code>max_players:</code> - Used to set max amount of players that can be connected to the server at once<br> | <code>max_players:</code> - Used to set max amount of players that can be connected to the server at once.<br> | ||
<code>serverinfo_pastebin_id: <pastebin ID></code> - Used to set the content in the server's info tab. Pastebin ID replaced with the [Pastebin.com pastebin id] on which the desired info is written. - Default: 7wV681fT<br> | <code>serverinfo_pastebin_id: <pastebin ID></code> - Used to set the content in the server's info tab. Pastebin ID replaced with the [Pastebin.com pastebin id] on which the desired info is written. - Default: 7wV681fT<br> | ||
<code>contact_email: <email></code> - Used to set the contact email for verification. - This field must be manually added into the config.<br> | <code>contact_email: <email></code> - Used to set the contact email for verification. - This field must be manually added into the config.<br> | ||
| Line 68: | Line 119: | ||
The server must be verified to be visible in the [[Server Info#Server Browser|Server Browser]]. | The server must be verified to be visible in the [[Server Info#Server Browser|Server Browser]]. | ||
Before requesting verification make sure your server follows the [https://scpslgame.com/Verified_server_rules.pdf Verified Server Rules]. | |||
===Requesting Verification=== | ===Requesting Verification=== | ||
Revision as of 22:28, 11 April 2019
This guide takes you through the steps required to create a dedicated SCP:SL server on Windows and Linux.
Minimum Server Specifications
- 4 GB RAM
- 2 core CPU
- ~600 MB storage space
Windows Instructions
Prerequisites
- Mono (64-bit) - Framework used by Unity for a lot of things, needed to fix certain voice chat issues
- SteamCMD - Used to install and update the server
Installing the SCP:SL dedicated server with SteamCMD
SteamCMD is used to install the SCP:SL server in a specified location, this will also make it easier to update it once there is an update.
Logging in
To be able to download the server it must be logged into into steam.
Logging in as anonymous works, but it can also be logged in into a steam account.
login anonymous
Setting install directory
To set the desired server directory/install location.
force_install_dir <directory> - (eg. C:/SL_Server)
Installing it
To install the dedicated server the appid 996560 is used, it is the headless build of SCP:SL and will run faster than if the game itself was used to host.
app_update 996560
Validating
To make sure that no required files are missing or corrupted.
app_update 996560 validate
(Optional) Creating an update script
A batch file can be created to have the server automatically updated when needed.
Paste the following code into a batch file and run it once the server needs an update.
steamcmd
+login anonymous
+force_install_dir <directory>
+app_update 996560
+app_update 996560 validate
+quit
Linux Instructions
Prerequisites
- An already set-up server with SSH and FTP configured
Installing components
sudo apt install mono-complete - Framework used by Unity for a lot of things, needed to fix certain voice chat issues
sudo apt-get install tmux - Allows running multiple windows in a single session, in our case it used to keep the server running without having to be logged into it
sudo apt-get install steamcmd - Used to install and update the server
Creating new user
A new user will be created to be specifically used for the SL server, as using the root user is insecure.
sudo adduser scpserver - Creates a new user with the name "scpserver"
su - scpserver - Changes active user to "scpserver"
Installing the SCP:SL dedicated server with SteamCMD
SteamCMD is used to install the SCP:SL server in a specified location, this will also make it easier to update it once there is an update.
steamcmd - Used to run steamcmd and be able to input the required commands
Logging in
To be able to download the server it must be logged into into steam.
Logging in as anonymous works, but it can also be logged in into a steam account.
login anonymous
Setting install directory
To set the desired server directory/install location.
force_install_dir <directory> - (eg. /home/SL_Server)
Installing it
To install the dedicated server the appid 996560 is used, it is the headless build of SCP:SL and will run faster than if the game itself was used to host.
app_update 996560
Validating
To make sure that no required files are missing or corrupted.
app_update 996560 validate
Starting up the server
On linux starting the server is a bit different than on windows.
screen -a - Uses screen with all capabilities when starting server
cd <directory> - Select server directory
mono LocalAdmin.exe - Starts up the server with LocalAdmin
Server Configuration
Related article: Docs:Server Config
After installing the server can be configured, and settings such as the server name, info tab, player count and similar can be set.
All of these settings can be changed in the config_gameplay.txt/config.txt file.
- On Windows: %AppData%\Roaming\SCP Secret Laboratory\config_gameplay.txt
- On Linux: \home\{username}\.config\SCP Secret Laboratory\config.txt
Basic Fields
server_name: - Used to set the server name
server_ip: <IP/auto> - Used to set the IP address used by the server, it must be a IPv4 address. If it is set to auto it will automatically choose the machine's address (used for dynamic IPs).
max_players: - Used to set max amount of players that can be connected to the server at once.
serverinfo_pastebin_id: <pastebin ID> - Used to set the content in the server's info tab. Pastebin ID replaced with the [Pastebin.com pastebin id] on which the desired info is written. - Default: 7wV681fT
contact_email: <email> - Used to set the contact email for verification. - This field must be manually added into the config.
Verification
The server must be verified to be visible in the Server Browser.
Before requesting verification make sure your server follows the Verified Server Rules.
Requesting Verification
Once ready send an email to [email protected] with the following info:
- The server's external IPv4 address
- The port used by the server
- If the server IP is static or dynamic
Once sent make sure to keep your server running until it is verified, the verification process is usually done within 48 hours.
