AtomicTorchWiki - User contributions [en]

Main Page

2025-10-21T16:18:32Z

Ai enabled:

[[File:AtomicTorchStudioLogoTransparent.png]] Welcome to '''AtomicTorch Studio''' wiki!

'''Links:'''
* [https://atomictorch.com AtomicTorch Studio portal] ('''website''' and developer's '''blog''')
* [https://forums.atomictorch.com Forums] (official forums)
* [https://store.steampowered.com/publisher/AtomicTorch Steam Store] (official page in Steam)

'''Note:''' This wiki is work in progress and is in no way complete. We are only starting adding content here, for now mostly for our own reference. But if you would like to help - feel free to create an account. Any help with adding additional materials or organizing what's already here is appreciated!

= CryoFall Wiki =
{| class="wikitable" style="width:100%"
|-
! style="width:40%" | Get the game
! style="width:60%" | Articles
|-
| 
[[File:CryoFallBanner.png|300px|center]]

You can find additional information about CryoFall on the official website.
* [http://CryoFall.com CryoFall website]
* [https://store.steampowered.com/app/829590/CryoFall/ CryoFall Steam Page]
| 
Please note that the official CryoFall wiki is hosed at [https://cryofall.gamepedia.com/CryoFall_Wiki https://cryofall.gamepedia.com].

Additional articles:
* [[CryoFall/Server/Setup|Server Setup]]
|}

= [[VoidExpanse]] Wiki =
{| class="wikitable" style="width:100%"
|-
! style="width:40%" | Get the game
! style="width:20%" | The game
! style="width:20%" | Modding
! style="width:20%" | Tutorials
|-
| 
[[File:VoidExpanseBanner.png|300px|center]]

You can find additional information about [[VoidExpanse]] on the official website.
* [http://voidexpanse.com VoidExpanse website]
| 
* [[VoidExpanse/Ships|Ships]]
* [[VoidExpanse/Weapons|Weapons]]
* [[VoidExpanse/Equipment|Equipment]]
* [[VoidExpanse/Topics|NPCs and topics]]
* [[VoidExpanse/Holodeck|Holodeck]]
* [[VoidExpanse/Ore|Ore]]
* [[VoidExpanse/Goods|Goods]]
* [[VoidExpanse/Objects|Alien Relics & Body Parts]]
| 
* [[VoidExpanse/installing_mods|How to install mods?]]
* [[VoidExpanse/mod_uploader|Steam Mod Uploader]]
* [[VoidExpanse/modding|Modding]]
* [[VoidExpanse/scripting_api|Scripting]]
* [[VoidExpanse/localization|Localization and Translation]]
| 
* [[VoidExpanse/updating_the_game|How to update the game?]]
* [[VoidExpanse/Server_setup|Server setup]]
* [[VoidExpanse/SteamCMD|SteamCMD Linux setup]]
* [[VoidExpanse/Server_commands|Server commands]]
* [[VoidExpanse/Troubleshooting|Troubleshooting]]
* [[VoidExpanse/Linux_Compatibility|Running on Linux]]
|}

= [[Dinocide]] Wiki =
{| class="wikitable" style="width:100%"
|-
! style="width:40%" | Get the game
! style="width:30%" | The game
! style="width:30%" | Game content
|-
| 
[[File:DinocideBanner.png|300px|center]]

[[Dinocide]] is currently in development. You can find all information about the game on the website.
* [http://dinocide.com Dinocide website]
* [http://dinocide.com/Pages/Dinocide-Download-Demo-Version Download Dinocide Demo]
| 
* [[Dinocide/Tactics|Tactics]]
* [[Dinocide/World map|World map]]
* [[Dinocide/Bosses|Bosses]]
| 
* [[Dinocide/Dinosaurs|Dinosaurs]]
* [[Dinocide/Weapons|Weapons]]
* [[Dinocide/Items|Items]]
|}

= AtomicTorch Studio technology wiki =
{| class="wikitable" style="width:100%"
|-
! style="width:50%" | Information
! style="width:50%" | Projects
|-
|
Aside from the game projects AtomicTorch Studio also develops certain software projects to aid its game development needs. These projects are mostly intended for internal use, however our latest work ([[RENKEI_Engine|RENKEI Engine]]) is quite a powerful tool by itself which might interest other developers as well. Hence we decided to make the information available publicly.
| 
* [[RENKEI_Engine|RENKEI Engine]]
|}

== Editing wiki ==
* [[:Category:Templates|List of templates]]

CryoFall/Server/Setup

2023-06-14T15:12:08Z

Ai enabled: /* Game server rent service */

= Local server / Singleplayer =
Starting with R31 "Singleplayer Update" the local server is seamlessly integrated into the game client. Other players can also connect to you over LAN (new tab in Multiplayer menu) and even over the internet with virtual LAN (with software such as Hamachi).

= Using game server hosting providers =

==== Game server rent service ====
''If you don't want to hassle with the game server setup, you can rent your own CryoFall server from any third party game server hosting company in just a few minutes. They provide data center locations in almost every country around the world!''
* [https://pingperfect.com/gameservers/cryofall-game-server-hosting-rental.php?aff=586 PingPerfect] (largest worldwide coverage and reliable 24/7 support)
* [https://agonhosting.com/en/category/game-server/cryofall Agon Hosting] (cheapest, no slot limit, straightforward control panel, hosted in Germany with DDoS protection by OVH)
* [https://www.4netplayers.com/en/server-hosting/cryofall-server-rental/ 4PLAYERS] (not recommended for modded servers as the server customization is complicated (Data files are not accessible for editing); some datacenters are restricting access from certain countries, in that case you can reach the support to relocate your server to another datacenter)

''Please note that AtomicTorch Studio is not affiliated with any of these companies and not responsible for their service quality so in case of any issues please reach them directly. So far we've heard only positive feedback about their services.''

= Self-hosting =

== Requirements ==
====Hardware requirements====
(for up to about 30 players online) 1-core CPU 1.6-2 GHz, 1.5 GB RAM, 2-3 Mbit/s bandwidth (each way)
 (for up to about 100 players online) 2-core CPU 1.6-2 GHz, 2 GB RAM, 3-6 Mbit/s bandwidth
 (for up to about 200 players online) 2-core CPU 2.4-3 GHz, 2 GB RAM, 6-12 Mbit/s bandwidth
 (for up to about 300 players online) 2-core CPU 3+ GHz, 2.5 GB RAM, 12-20 Mbit/s bandwidth
 Usually, VPS (virtual machines) hosting such as [https://www.vultr.com/?ref=7238385 Vultr.com] (this is our referral link as we're using this company services to host our own servers) is sufficient for hosting a game server. Using 1-core machines is not recommended as the game requires a secondary CPU to ensure smooth performance without hiccups during intensive background operations (such as world snapshot saving). Using more than a 2-core machine for a single game server hosting is redundant as the game cannot utilize more than two cores due to the sequential execution of the game simulation (except networking).

====Software (system) requirements====
The server could run on Windows, Linux, and Mac.
To achieve this the game server is using .NET Runtime 6.0.
For hosting the official game servers we prefer using CentOS 7 with Docker or CentOS 8 with podman (OSS alternative to Docker).

== Server installation with Docker (best way for Linux) ==
We recommend this for Linux only. Please follow this guide [https://hub.docker.com/r/atomictorch/cryofall-server CryoFall Dedicated Server Docker Image] then return back here to '''"Server installation"''' section and follow the list after number 7. Ignore instructions on how to start the server with "dotnet" as you should use "docker run ..." instead as explained in the Docker guide above.

== Server installation / direct download (Windows, Linux, Mac) ==

==== How to setup your own server (on any OS): ====
# Download and '''install''' .NET Runtime 6.0 x64ΓÇöplease visit [https://dotnet.microsoft.com/download/dotnet/6.0/runtime Download .NET page] and follow the installation guide for your OS (for Windows you need to download x64 version from the "Run console apps" section).
# Download the game server package. There are several ways to do this:
## You can download it directly from our website:
### '''[https://atomictorch.com/Files/CryoFall_Server_v1.33.1.15.zip SERVER DOWNLOAD LINK (any OS)]'''
### Extract the downloaded package (it's a regular ZIP archive).
## Alternatively, you can download it from '''Steam Client''': ''(preferable, as this way you can easily download updates)''
### Launch Steam Client
### Select LIBRARY tab
### Click on "ALL" and toggle "Tools"
### Search for "CryoFall Dedicated Server" and install it
## Alternatively, you can download it with '''SteamCMD''' (if you're familiar with it):
### launch SteamCMD
### enter:
###: <code>
###: login anonymous
###: app_update 1061710
###: </code>
### navigate to the installation folder (usually in steamapps/Common/CryoFall Dedicated Server)
# The server executable is located in the subfolder: "Binaries/Server". Open the command line/terminal/SSH (or PowerShell in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable first time with <code>loadOrNew</code> flag. The server will start and create the game world.
#:<code>dotnet CryoFall_Server.dll loadOrNew</code>
# Usually it takes about 1-2 minutes to create a new world (or load a savegame). After that the server will keep writing performance statistics information every 20 seconds among other information such as the spawn scripts reporting and network events.
# Stop the server. To do so enter the command below and press Enter key.
#:<code>stop 0</code>
#The server will save and quit. Now you have the "SettingsServer.xml" and "ModsConfig.xml" files.
# Now you need to navigate to the subfolder "Data" (in the root of the server folder, '''not''' in the "Binaries/Server") and modify "SettingsServer.xml" to set the unique server '''name''' and set other settings, etc (there are XML comments explaining every setting so it should be straightforward). ''Please note that you can (and should) edit '''Description''' and '''Welcome message''' from the '''CURRENT GAME''' menu right from the game after connecting to your server.''
# If you are interested in making your server visible in the community servers list make sure to edit <is_public_server> and change the value from 0 to 1. Also, please make sure your router is configured correctly (port forwarding) to enable other people to connect to your machine from outside. But ideally, you should use dedicated server hardware (VPS or VDS) to host public servers.
# While you're still editing "SettingsServer.xml" file, please find the value '''<server_operators_list>''' and change it to include '''your nickname'''! Otherwise, you will be unable to access your server console from the game and also you will be unable to edit the server's Description and Welcome message.
# If you want to have a custom server icon, please replace the ServerIcon.png file in the "Data" subfolder. The icon image file requirements: '''PNG24 format, 256x256 size, up to 100 KB'''.

'''Important (for Windows only):''' you need to allow the dotnet process in the Windows Firewall settingsΓÇöif the Firewall access request was not shown automatically by Windows you can add the <code>C:\Program Files\dotnet\dotnet.exe</code> file into Firewall whitelist. To do this, open Windows Start menu and search for "Allow an app through Windows Firewall" -> button "Allow another app".

==== Starting the server ====
# Launch the command line (we recommending '''PowerShell''' in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable with <code>load</code> flag.
#:<code>dotnet CryoFall_Server.dll load</code>
# Stop your server by typing command below and pressing Enter key (it will save the world before stopping).
#:<code>stop 60 The shutdown message text goes here</code>
(Where <code>60</code> is the shutdown delay (in seconds) so the connected players will have some time to find a safe location)

'''''Please note that typing this message is really hard as the console is updating regularly! The best way is to simply copy-paste from the text editor the whole command text into the game console window (hint: you can paste in PowerShell by simply pressing the right mouse button) and pressing Enter key.'''''

You can always wipe the world by launching the game with <code>new</code> flag:
:<code>dotnet CryoFall_Server.dll new</code>

Currently, we don't support the savegame migration between the major game versions (if there are changes to the game data serialization scheme). We plan to implement the proper data migration feature ASAP.

==== Connecting to the server ====
If you want to connect to your local game server, simply add SERVERS->Custom list as <code>localhost</code>

To connect to the public server you need to navigate to SERVERS->Community servers list (please note that this might not work if you host this server on the same PC as the client, read below).

If you're attempting to host your server on a home computer and other players cannot connect to it, you need to manually forward the port '''UDP 6000''' on your home router to '''your local IP address''' (the game has the auto port forwarding feature but it often fails due to the difference in UPnP implementation on many routers). E.g. if your PC's IP address in local network is 192.168.1.100 (you can check it with ipconfig tool or in Windows network adapter's settings) you will need to setup a port forward rule on your router to forward traffic from port 6000 UDP to port 6000 UDP on IP address 192.168.1.100.

'''If you're running a game server on the same PC as the game client:'''
 Please note that you might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its address as <code>localhost:6000</code> and connect to it directly.

'''If you're running a game server in the same local network as the game client (for example you want to play over LAN with your friends and family):'''
 You might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its local IP address (IPv4) and connect to it directly. To get your local IP address please use ipconfig command-line tool or check the network adapter properties in the network center. You need to get the local network IP address of the PC that is hosting the game server. Then add it in the custom servers list on your PC. You can lookup the IP address in the Windows network settings or by using CMD tool called ipconfig in Windows. For example, here we've run the ipconfig tool here and see the IPv4 address as 192.168.1.200 ([https://cdn.discordapp.com/attachments/421250395298332672/739147674367950908/Screenshot_at_19-48-06.png screenshot]). We can use it on any other PC in the local network to connect to that PC hosting the game server.

Connecting to the private servers requires adding it via the Custom servers menu.

6000 is the default port but you can change it in the Data/SettingsServer.xml file.

== Server update/upgrade to new version ==
When we're releasing a new version of the game server, you need to follow these steps to update it:
# (If you have not done this) Install ".NET Runtime" (version 6.0) https://dotnet.microsoft.com/download/dotnet/6.0/runtime
# Ensure you've made a '''backup''' of the "'''Data'''" folder inside the game server installation folder.
# If you're updating from A28 or earlier versions (ONLY), delete "Data/Saves" folder as the savegame is not compatible (breaking changes). Update from A29 to R30/R31/R32 (or to any patch versions) '''doesn't require this step''' (savegame is compatible).
# Download the new version of the server and overwrite your current installation with it (you can find the actual download link above in the "Installation" section).
# Stop the game server (if it's running).
# Important: please '''overwrite''' both Binaries and Core folders!
# Start the server as usual.

== Server commands ==
# Ensure you're the server operator (you've edited the ServerSettings.xml file and added yourself into the server_operators_list).
# Connect to your game server.
# The game console can be toggled by pressing <code>~</code> (the key on the left from <code>1</code> key) like in old-school games (you can change the key binding for console in the controls options).
# Please add <code>/</code> (slash) prefix to the server commands you want to execute.
# You can use '''Tab''' key to fill autocomplete, and you can use '''arrow Up/Down keys''' to navigate the suggestions list. Press '''Tab''' or '''Enter''' to accept the suggestion.

Here is the page with the server commands list: [[CryoFall/Server/Commands|Server Commands List]]

== Moderation (whitelist, blacklist, kicking, muting) ==
Server operator can access special moderation commands. To invoke these commands, please ensure you're the server operator, connect to your game server, open the console (~ key) and then you can use these commands: (replace username with the actual player nickname)

Whitelist management:

<code>/mod.whiteList.add username</code>

<code>/mod.whiteList.remove username</code>

<code>/mod.whiteList.print</code>

To enable whitelist:

<code>/mod.whiteList.enabled 1</code>

Blacklist management:

<code>/mod.blackList.add username</code>

<code>/mod.blackList.remove username</code>

<code>/mod.blackList.print</code>

Kicking players (temporary removing from server and blocking from connecting):

<code>/mod.kickList.add username durationInMinutes</code>

<code>/mod.kickList.remove username</code>

<code>/mod.kickList.print</code>

Muting players (temporary removing their ability to send messages to chat):

<code>/mod.muteList.add username durationInMinutes</code>

<code>/mod.muteList.remove username</code>

<code>/mod.muteList.print</code>

== Server rates adjusting / Enabling PvP mode ==
Server rates (and PvP mode setting) are exposed in a separate "rates" config file. You can quickly change things like LP gain rate, increase item drops, reduce the player to player damage to zero, or even increase the damage from creatures and make it really tough for the players!

'''Important:''' Now you can edit the server rates right from the game if you have server operator access rights (if you don't, please see the guide above how to gain server operator rights by editing SettingsServer.xml file).
If you're a server operator, please log in to your server, press ESC key and you will see a menu containing a button to browse the server ratesΓÇöthere is also a '''"Edit"''' button right next to it (if you don't see it, please ensure that you have server operator access rights).

The guide below will explain how to edit the server rates config manually:
To adjust the server rates, stop the server and check the file <game server>/Data/ServerRates.config
Please read carefullyΓÇöall the rates are disabled and in order to apply them '''you need to remove the # char at the start of the line'''!
If you want to '''enable PvP''', search PvP in the file. By default, this setting's value is 0 and you need to change it to 1 and remove the # char at the start of the line.

== Server raiding hours (for PvP) ==
'''(Please note: with A27 this feature is not recommend anymore as there is a better feature now ΓÇö S.H.I.E.L.D. protection that is enabled by default for PvP servers)'''

On PvP server, you could set up specific hours during which the raiding is possible.
 By default, offline raiding protection is not enabled so players could raid other players' bases at any time.
 To enable offline raiding protection, please use this in-game console command:
 <code>/admin.setRaidingWindow 4 14 1.5</code>
 In this code we're using (first number) +4 GMT/UTC timezone, (second number) hour of day when raiding is possible (value from 0 to 24), and (third number) is the duration of the raiding window (value from 0 to 24).
 So the code in the example will allow raiding from 14:00 (or 2PM) for 1.5 hours.
 After changing the value you could open Politics/Diplomacy menu ([P] key) and verify whether you set the correct numbers.
 Please note that Politics/Diplomacy menu displaying your local time (in your PC timezone)!

== How to prohibit client modifications ==
If you wish to restrict usage of any client modifications on your server, please find "<no_client_mods>" setting in the SettingsServer.xml file. Change the value from 0 to 1 to enable this feature. It's recommended for PvP servers to set it to 1. You can read more details about this feature in [https://atomictorch.com/Post/Id2218/A28-Justice-Update-Release A28 Update announcement].

CryoFall/Server/Setup

2023-02-09T14:53:09Z

Ai enabled: /* Game server rent service */

= Local server / Singleplayer =
Starting with R31 "Singleplayer Update" the local server is seamlessly integrated into the game client. Other players can also connect to you over LAN (new tab in Multiplayer menu) and even over the internet with virtual LAN (with software such as Hamachi).

= Using game server hosting providers =

==== Game server rent service ====
''If you don't want to hassle with the game server setup, you can rent your own CryoFall server from any third party game server hosting company in just a few minutes. They provide data center locations in almost every country around the world!''
* [https://pingperfect.com/gameservers/cryofall-game-server-hosting-rental.php?aff=586 PingPerfect] (largest worldwide coverage and reliable 24/7 support)
* [https://agonhosting.com/en/category/game-server/cryofall Agon Hosting] (cheapest, no slot limit, straightforward control panel, but has limited number of locations and no DDoS protection)
* [https://www.4netplayers.com/en/server-hosting/cryofall-server-rental/ 4PLAYERS] (not recommended for modded servers as the server customization is complicated (Data files are not accessible for editing); some datacenters are restricting access from certain countries, in that case you can reach the support to relocate your server to another datacenter)

''Please note that AtomicTorch Studio is not affiliated with any of these companies and not responsible for their service quality so in case of any issues please reach them directly. So far we've heard only positive feedback about their services.''

= Self-hosting =

== Requirements ==
====Hardware requirements====
(for up to about 30 players online) 1-core CPU 1.6-2 GHz, 1.5 GB RAM, 2-3 Mbit/s bandwidth (each way)
 (for up to about 100 players online) 2-core CPU 1.6-2 GHz, 2 GB RAM, 3-6 Mbit/s bandwidth
 (for up to about 200 players online) 2-core CPU 2.4-3 GHz, 2 GB RAM, 6-12 Mbit/s bandwidth
 (for up to about 300 players online) 2-core CPU 3+ GHz, 2.5 GB RAM, 12-20 Mbit/s bandwidth
 Usually, VPS (virtual machines) hosting such as [https://www.vultr.com/?ref=7238385 Vultr.com] (this is our referral link as we're using this company services to host our own servers) is sufficient for hosting a game server. Using 1-core machines is not recommended as the game requires a secondary CPU to ensure smooth performance without hiccups during intensive background operations (such as world snapshot saving). Using more than a 2-core machine for a single game server hosting is redundant as the game cannot utilize more than two cores due to the sequential execution of the game simulation (except networking).

====Software (system) requirements====
The server could run on Windows, Linux, and Mac.
To achieve this the game server is using .NET Runtime 6.0.
For hosting the official game servers we prefer using CentOS 7 with Docker or CentOS 8 with podman (OSS alternative to Docker).

== Server installation with Docker (best way for Linux) ==
We recommend this for Linux only. Please follow this guide [https://hub.docker.com/r/atomictorch/cryofall-server CryoFall Dedicated Server Docker Image] then return back here to '''"Server installation"''' section and follow the list after number 7. Ignore instructions on how to start the server with "dotnet" as you should use "docker run ..." instead as explained in the Docker guide above.

== Server installation / direct download (Windows, Linux, Mac) ==

==== How to setup your own server (on any OS): ====
# Download and '''install''' .NET Runtime 6.0 x64ΓÇöplease visit [https://dotnet.microsoft.com/download/dotnet/6.0/runtime Download .NET page] and follow the installation guide for your OS (for Windows you need to download x64 version from the "Run console apps" section).
# Download the game server package. There are several ways to do this:
## You can download it directly from our website:
### '''[https://atomictorch.com/Files/CryoFall_Server_v1.33.1.15.zip SERVER DOWNLOAD LINK (any OS)]'''
### Extract the downloaded package (it's a regular ZIP archive).
## Alternatively, you can download it from '''Steam Client''': ''(preferable, as this way you can easily download updates)''
### Launch Steam Client
### Select LIBRARY tab
### Click on "ALL" and toggle "Tools"
### Search for "CryoFall Dedicated Server" and install it
## Alternatively, you can download it with '''SteamCMD''' (if you're familiar with it):
### launch SteamCMD
### enter:
###: <code>
###: login anonymous
###: app_update 1061710
###: </code>
### navigate to the installation folder (usually in steamapps/Common/CryoFall Dedicated Server)
# The server executable is located in the subfolder: "Binaries/Server". Open the command line/terminal/SSH (or PowerShell in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable first time with <code>loadOrNew</code> flag. The server will start and create the game world.
#:<code>dotnet CryoFall_Server.dll loadOrNew</code>
# Usually it takes about 1-2 minutes to create a new world (or load a savegame). After that the server will keep writing performance statistics information every 20 seconds among other information such as the spawn scripts reporting and network events.
# Stop the server. To do so enter the command below and press Enter key.
#:<code>stop 0</code>
#The server will save and quit. Now you have the "SettingsServer.xml" and "ModsConfig.xml" files.
# Now you need to navigate to the subfolder "Data" (in the root of the server folder, '''not''' in the "Binaries/Server") and modify "SettingsServer.xml" to set the unique server '''name''' and set other settings, etc (there are XML comments explaining every setting so it should be straightforward). ''Please note that you can (and should) edit '''Description''' and '''Welcome message''' from the '''CURRENT GAME''' menu right from the game after connecting to your server.''
# If you are interested in making your server visible in the community servers list make sure to edit <is_public_server> and change the value from 0 to 1. Also, please make sure your router is configured correctly (port forwarding) to enable other people to connect to your machine from outside. But ideally, you should use dedicated server hardware (VPS or VDS) to host public servers.
# While you're still editing "SettingsServer.xml" file, please find the value '''<server_operators_list>''' and change it to include '''your nickname'''! Otherwise, you will be unable to access your server console from the game and also you will be unable to edit the server's Description and Welcome message.
# If you want to have a custom server icon, please replace the ServerIcon.png file in the "Data" subfolder. The icon image file requirements: '''PNG24 format, 256x256 size, up to 100 KB'''.

'''Important (for Windows only):''' you need to allow the dotnet process in the Windows Firewall settingsΓÇöif the Firewall access request was not shown automatically by Windows you can add the <code>C:\Program Files\dotnet\dotnet.exe</code> file into Firewall whitelist. To do this, open Windows Start menu and search for "Allow an app through Windows Firewall" -> button "Allow another app".

==== Starting the server ====
# Launch the command line (we recommending '''PowerShell''' in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable with <code>load</code> flag.
#:<code>dotnet CryoFall_Server.dll load</code>
# Stop your server by typing command below and pressing Enter key (it will save the world before stopping).
#:<code>stop 60 The shutdown message text goes here</code>
(Where <code>60</code> is the shutdown delay (in seconds) so the connected players will have some time to find a safe location)

'''''Please note that typing this message is really hard as the console is updating regularly! The best way is to simply copy-paste from the text editor the whole command text into the game console window (hint: you can paste in PowerShell by simply pressing the right mouse button) and pressing Enter key.'''''

You can always wipe the world by launching the game with <code>new</code> flag:
:<code>dotnet CryoFall_Server.dll new</code>

Currently, we don't support the savegame migration between the major game versions (if there are changes to the game data serialization scheme). We plan to implement the proper data migration feature ASAP.

==== Connecting to the server ====
If you want to connect to your local game server, simply add SERVERS->Custom list as <code>localhost</code>

To connect to the public server you need to navigate to SERVERS->Community servers list (please note that this might not work if you host this server on the same PC as the client, read below).

If you're attempting to host your server on a home computer and other players cannot connect to it, you need to manually forward the port '''UDP 6000''' on your home router to '''your local IP address''' (the game has the auto port forwarding feature but it often fails due to the difference in UPnP implementation on many routers). E.g. if your PC's IP address in local network is 192.168.1.100 (you can check it with ipconfig tool or in Windows network adapter's settings) you will need to setup a port forward rule on your router to forward traffic from port 6000 UDP to port 6000 UDP on IP address 192.168.1.100.

'''If you're running a game server on the same PC as the game client:'''
 Please note that you might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its address as <code>localhost:6000</code> and connect to it directly.

'''If you're running a game server in the same local network as the game client (for example you want to play over LAN with your friends and family):'''
 You might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its local IP address (IPv4) and connect to it directly. To get your local IP address please use ipconfig command-line tool or check the network adapter properties in the network center. You need to get the local network IP address of the PC that is hosting the game server. Then add it in the custom servers list on your PC. You can lookup the IP address in the Windows network settings or by using CMD tool called ipconfig in Windows. For example, here we've run the ipconfig tool here and see the IPv4 address as 192.168.1.200 ([https://cdn.discordapp.com/attachments/421250395298332672/739147674367950908/Screenshot_at_19-48-06.png screenshot]). We can use it on any other PC in the local network to connect to that PC hosting the game server.

Connecting to the private servers requires adding it via the Custom servers menu.

6000 is the default port but you can change it in the Data/SettingsServer.xml file.

== Server update/upgrade to new version ==
When we're releasing a new version of the game server, you need to follow these steps to update it:
# (If you have not done this) Install ".NET Runtime" (version 6.0) https://dotnet.microsoft.com/download/dotnet/6.0/runtime
# Ensure you've made a '''backup''' of the "'''Data'''" folder inside the game server installation folder.
# If you're updating from A28 or earlier versions (ONLY), delete "Data/Saves" folder as the savegame is not compatible (breaking changes). Update from A29 to R30/R31/R32 (or to any patch versions) '''doesn't require this step''' (savegame is compatible).
# Download the new version of the server and overwrite your current installation with it (you can find the actual download link above in the "Installation" section).
# Stop the game server (if it's running).
# Important: please '''overwrite''' both Binaries and Core folders!
# Start the server as usual.

== Server commands ==
# Ensure you're the server operator (you've edited the ServerSettings.xml file and added yourself into the server_operators_list).
# Connect to your game server.
# The game console can be toggled by pressing <code>~</code> (the key on the left from <code>1</code> key) like in old-school games (you can change the key binding for console in the controls options).
# Please add <code>/</code> (slash) prefix to the server commands you want to execute.
# You can use '''Tab''' key to fill autocomplete, and you can use '''arrow Up/Down keys''' to navigate the suggestions list. Press '''Tab''' or '''Enter''' to accept the suggestion.

Here is the page with the server commands list: [[CryoFall/Server/Commands|Server Commands List]]

== Moderation (whitelist, blacklist, kicking, muting) ==
Server operator can access special moderation commands. To invoke these commands, please ensure you're the server operator, connect to your game server, open the console (~ key) and then you can use these commands: (replace username with the actual player nickname)

Whitelist management:

<code>/mod.whiteList.add username</code>

<code>/mod.whiteList.remove username</code>

<code>/mod.whiteList.print</code>

To enable whitelist:

<code>/mod.whiteList.enabled 1</code>

Blacklist management:

<code>/mod.blackList.add username</code>

<code>/mod.blackList.remove username</code>

<code>/mod.blackList.print</code>

Kicking players (temporary removing from server and blocking from connecting):

<code>/mod.kickList.add username durationInMinutes</code>

<code>/mod.kickList.remove username</code>

<code>/mod.kickList.print</code>

Muting players (temporary removing their ability to send messages to chat):

<code>/mod.muteList.add username durationInMinutes</code>

<code>/mod.muteList.remove username</code>

<code>/mod.muteList.print</code>

== Server rates adjusting / Enabling PvP mode ==
Server rates (and PvP mode setting) are exposed in a separate "rates" config file. You can quickly change things like LP gain rate, increase item drops, reduce the player to player damage to zero, or even increase the damage from creatures and make it really tough for the players!

'''Important:''' Now you can edit the server rates right from the game if you have server operator access rights (if you don't, please see the guide above how to gain server operator rights by editing SettingsServer.xml file).
If you're a server operator, please log in to your server, press ESC key and you will see a menu containing a button to browse the server ratesΓÇöthere is also a '''"Edit"''' button right next to it (if you don't see it, please ensure that you have server operator access rights).

The guide below will explain how to edit the server rates config manually:
To adjust the server rates, stop the server and check the file <game server>/Data/ServerRates.config
Please read carefullyΓÇöall the rates are disabled and in order to apply them '''you need to remove the # char at the start of the line'''!
If you want to '''enable PvP''', search PvP in the file. By default, this setting's value is 0 and you need to change it to 1 and remove the # char at the start of the line.

== Server raiding hours (for PvP) ==
'''(Please note: with A27 this feature is not recommend anymore as there is a better feature now ΓÇö S.H.I.E.L.D. protection that is enabled by default for PvP servers)'''

On PvP server, you could set up specific hours during which the raiding is possible.
 By default, offline raiding protection is not enabled so players could raid other players' bases at any time.
 To enable offline raiding protection, please use this in-game console command:
 <code>/admin.setRaidingWindow 4 14 1.5</code>
 In this code we're using (first number) +4 GMT/UTC timezone, (second number) hour of day when raiding is possible (value from 0 to 24), and (third number) is the duration of the raiding window (value from 0 to 24).
 So the code in the example will allow raiding from 14:00 (or 2PM) for 1.5 hours.
 After changing the value you could open Politics/Diplomacy menu ([P] key) and verify whether you set the correct numbers.
 Please note that Politics/Diplomacy menu displaying your local time (in your PC timezone)!

== How to prohibit client modifications ==
If you wish to restrict usage of any client modifications on your server, please find "<no_client_mods>" setting in the SettingsServer.xml file. Change the value from 0 to 1 to enable this feature. It's recommended for PvP servers to set it to 1. You can read more details about this feature in [https://atomictorch.com/Post/Id2218/A28-Justice-Update-Release A28 Update announcement].

CryoFall/Server/Setup

2023-01-30T16:10:43Z

Ai enabled: /* Game server rent service */

= Local server / Singleplayer =
Starting with R31 "Singleplayer Update" the local server is seamlessly integrated into the game client. Other players can also connect to you over LAN (new tab in Multiplayer menu) and even over the internet with virtual LAN (with software such as Hamachi).

= Using game server hosting providers =

==== Game server rent service ====
''If you don't want to hassle with the game server setup, you can rent your own CryoFall server from any third party game server hosting company in just a few minutes. They provide data center locations in almost every country around the world!''
* [https://pingperfect.com/gameservers/cryofall-game-server-hosting-rental.php?aff=586 PingPerfect]
* [https://www.4netplayers.com/en/server-hosting/cryofall-server-rental/ 4PLAYERS]
* [https://agonhosting.com/en/category/game-server/cryofall Agon Hosting]

''Please note that AtomicTorch Studio is not affiliated with any of these companies and not responsible for their service quality so in case of any issues please reach them directly. So far we've heard only positive feedback about their services.''

= Self-hosting =

== Requirements ==
====Hardware requirements====
(for up to about 30 players online) 1-core CPU 1.6-2 GHz, 1.5 GB RAM, 2-3 Mbit/s bandwidth (each way)
 (for up to about 100 players online) 2-core CPU 1.6-2 GHz, 2 GB RAM, 3-6 Mbit/s bandwidth
 (for up to about 200 players online) 2-core CPU 2.4-3 GHz, 2 GB RAM, 6-12 Mbit/s bandwidth
 (for up to about 300 players online) 2-core CPU 3+ GHz, 2.5 GB RAM, 12-20 Mbit/s bandwidth
 Usually, VPS (virtual machines) hosting such as [https://www.vultr.com/?ref=7238385 Vultr.com] (this is our referral link as we're using this company services to host our own servers) is sufficient for hosting a game server. Using 1-core machines is not recommended as the game requires a secondary CPU to ensure smooth performance without hiccups during intensive background operations (such as world snapshot saving). Using more than a 2-core machine for a single game server hosting is redundant as the game cannot utilize more than two cores due to the sequential execution of the game simulation (except networking).

====Software (system) requirements====
The server could run on Windows, Linux, and Mac.
To achieve this the game server is using .NET Runtime 6.0.
For hosting the official game servers we prefer using CentOS 7 with Docker or CentOS 8 with podman (OSS alternative to Docker).

== Server installation with Docker (best way for Linux) ==
We recommend this for Linux only. Please follow this guide [https://hub.docker.com/r/atomictorch/cryofall-server CryoFall Dedicated Server Docker Image] then return back here to '''"Server installation"''' section and follow the list after number 7. Ignore instructions on how to start the server with "dotnet" as you should use "docker run ..." instead as explained in the Docker guide above.

== Server installation / direct download (Windows, Linux, Mac) ==

==== How to setup your own server (on any OS): ====
# Download and '''install''' .NET Runtime 6.0 x64ΓÇöplease visit [https://dotnet.microsoft.com/download/dotnet/6.0/runtime Download .NET page] and follow the installation guide for your OS (for Windows you need to download x64 version from the "Run console apps" section).
# Download the game server package. There are several ways to do this:
## You can download it directly from our website:
### '''[https://atomictorch.com/Files/CryoFall_Server_v1.33.1.15.zip SERVER DOWNLOAD LINK (any OS)]'''
### Extract the downloaded package (it's a regular ZIP archive).
## Alternatively, you can download it from '''Steam Client''': ''(preferable, as this way you can easily download updates)''
### Launch Steam Client
### Select LIBRARY tab
### Click on "ALL" and toggle "Tools"
### Search for "CryoFall Dedicated Server" and install it
## Alternatively, you can download it with '''SteamCMD''' (if you're familiar with it):
### launch SteamCMD
### enter:
###: <code>
###: login anonymous
###: app_update 1061710
###: </code>
### navigate to the installation folder (usually in steamapps/Common/CryoFall Dedicated Server)
# The server executable is located in the subfolder: "Binaries/Server". Open the command line/terminal/SSH (or PowerShell in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable first time with <code>loadOrNew</code> flag. The server will start and create the game world.
#:<code>dotnet CryoFall_Server.dll loadOrNew</code>
# Usually it takes about 1-2 minutes to create a new world (or load a savegame). After that the server will keep writing performance statistics information every 20 seconds among other information such as the spawn scripts reporting and network events.
# Stop the server. To do so enter the command below and press Enter key.
#:<code>stop 0</code>
#The server will save and quit. Now you have the "SettingsServer.xml" and "ModsConfig.xml" files.
# Now you need to navigate to the subfolder "Data" (in the root of the server folder, '''not''' in the "Binaries/Server") and modify "SettingsServer.xml" to set the unique server '''name''' and set other settings, etc (there are XML comments explaining every setting so it should be straightforward). ''Please note that you can (and should) edit '''Description''' and '''Welcome message''' from the '''CURRENT GAME''' menu right from the game after connecting to your server.''
# If you are interested in making your server visible in the community servers list make sure to edit <is_public_server> and change the value from 0 to 1. Also, please make sure your router is configured correctly (port forwarding) to enable other people to connect to your machine from outside. But ideally, you should use dedicated server hardware (VPS or VDS) to host public servers.
# While you're still editing "SettingsServer.xml" file, please find the value '''<server_operators_list>''' and change it to include '''your nickname'''! Otherwise, you will be unable to access your server console from the game and also you will be unable to edit the server's Description and Welcome message.
# If you want to have a custom server icon, please replace the ServerIcon.png file in the "Data" subfolder. The icon image file requirements: '''PNG24 format, 256x256 size, up to 100 KB'''.

'''Important (for Windows only):''' you need to allow the dotnet process in the Windows Firewall settingsΓÇöif the Firewall access request was not shown automatically by Windows you can add the <code>C:\Program Files\dotnet\dotnet.exe</code> file into Firewall whitelist. To do this, open Windows Start menu and search for "Allow an app through Windows Firewall" -> button "Allow another app".

==== Starting the server ====
# Launch the command line (we recommending '''PowerShell''' in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable with <code>load</code> flag.
#:<code>dotnet CryoFall_Server.dll load</code>
# Stop your server by typing command below and pressing Enter key (it will save the world before stopping).
#:<code>stop 60 The shutdown message text goes here</code>
(Where <code>60</code> is the shutdown delay (in seconds) so the connected players will have some time to find a safe location)

'''''Please note that typing this message is really hard as the console is updating regularly! The best way is to simply copy-paste from the text editor the whole command text into the game console window (hint: you can paste in PowerShell by simply pressing the right mouse button) and pressing Enter key.'''''

You can always wipe the world by launching the game with <code>new</code> flag:
:<code>dotnet CryoFall_Server.dll new</code>

Currently, we don't support the savegame migration between the major game versions (if there are changes to the game data serialization scheme). We plan to implement the proper data migration feature ASAP.

==== Connecting to the server ====
If you want to connect to your local game server, simply add SERVERS->Custom list as <code>localhost</code>

To connect to the public server you need to navigate to SERVERS->Community servers list (please note that this might not work if you host this server on the same PC as the client, read below).

If you're attempting to host your server on a home computer and other players cannot connect to it, you need to manually forward the port '''UDP 6000''' on your home router to '''your local IP address''' (the game has the auto port forwarding feature but it often fails due to the difference in UPnP implementation on many routers). E.g. if your PC's IP address in local network is 192.168.1.100 (you can check it with ipconfig tool or in Windows network adapter's settings) you will need to setup a port forward rule on your router to forward traffic from port 6000 UDP to port 6000 UDP on IP address 192.168.1.100.

'''If you're running a game server on the same PC as the game client:'''
 Please note that you might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its address as <code>localhost:6000</code> and connect to it directly.

'''If you're running a game server in the same local network as the game client (for example you want to play over LAN with your friends and family):'''
 You might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its local IP address (IPv4) and connect to it directly. To get your local IP address please use ipconfig command-line tool or check the network adapter properties in the network center. You need to get the local network IP address of the PC that is hosting the game server. Then add it in the custom servers list on your PC. You can lookup the IP address in the Windows network settings or by using CMD tool called ipconfig in Windows. For example, here we've run the ipconfig tool here and see the IPv4 address as 192.168.1.200 ([https://cdn.discordapp.com/attachments/421250395298332672/739147674367950908/Screenshot_at_19-48-06.png screenshot]). We can use it on any other PC in the local network to connect to that PC hosting the game server.

Connecting to the private servers requires adding it via the Custom servers menu.

6000 is the default port but you can change it in the Data/SettingsServer.xml file.

== Server update/upgrade to new version ==
When we're releasing a new version of the game server, you need to follow these steps to update it:
# (If you have not done this) Install ".NET Runtime" (version 6.0) https://dotnet.microsoft.com/download/dotnet/6.0/runtime
# Ensure you've made a '''backup''' of the "'''Data'''" folder inside the game server installation folder.
# If you're updating from A28 or earlier versions (ONLY), delete "Data/Saves" folder as the savegame is not compatible (breaking changes). Update from A29 to R30/R31/R32 (or to any patch versions) '''doesn't require this step''' (savegame is compatible).
# Download the new version of the server and overwrite your current installation with it (you can find the actual download link above in the "Installation" section).
# Stop the game server (if it's running).
# Important: please '''overwrite''' both Binaries and Core folders!
# Start the server as usual.

== Server commands ==
# Ensure you're the server operator (you've edited the ServerSettings.xml file and added yourself into the server_operators_list).
# Connect to your game server.
# The game console can be toggled by pressing <code>~</code> (the key on the left from <code>1</code> key) like in old-school games (you can change the key binding for console in the controls options).
# Please add <code>/</code> (slash) prefix to the server commands you want to execute.
# You can use '''Tab''' key to fill autocomplete, and you can use '''arrow Up/Down keys''' to navigate the suggestions list. Press '''Tab''' or '''Enter''' to accept the suggestion.

Here is the page with the server commands list: [[CryoFall/Server/Commands|Server Commands List]]

== Moderation (whitelist, blacklist, kicking, muting) ==
Server operator can access special moderation commands. To invoke these commands, please ensure you're the server operator, connect to your game server, open the console (~ key) and then you can use these commands: (replace username with the actual player nickname)

Whitelist management:

<code>/mod.whiteList.add username</code>

<code>/mod.whiteList.remove username</code>

<code>/mod.whiteList.print</code>

To enable whitelist:

<code>/mod.whiteList.enabled 1</code>

Blacklist management:

<code>/mod.blackList.add username</code>

<code>/mod.blackList.remove username</code>

<code>/mod.blackList.print</code>

Kicking players (temporary removing from server and blocking from connecting):

<code>/mod.kickList.add username durationInMinutes</code>

<code>/mod.kickList.remove username</code>

<code>/mod.kickList.print</code>

Muting players (temporary removing their ability to send messages to chat):

<code>/mod.muteList.add username durationInMinutes</code>

<code>/mod.muteList.remove username</code>

<code>/mod.muteList.print</code>

== Server rates adjusting / Enabling PvP mode ==
Server rates (and PvP mode setting) are exposed in a separate "rates" config file. You can quickly change things like LP gain rate, increase item drops, reduce the player to player damage to zero, or even increase the damage from creatures and make it really tough for the players!

'''Important:''' Now you can edit the server rates right from the game if you have server operator access rights (if you don't, please see the guide above how to gain server operator rights by editing SettingsServer.xml file).
If you're a server operator, please log in to your server, press ESC key and you will see a menu containing a button to browse the server ratesΓÇöthere is also a '''"Edit"''' button right next to it (if you don't see it, please ensure that you have server operator access rights).

The guide below will explain how to edit the server rates config manually:
To adjust the server rates, stop the server and check the file <game server>/Data/ServerRates.config
Please read carefullyΓÇöall the rates are disabled and in order to apply them '''you need to remove the # char at the start of the line'''!
If you want to '''enable PvP''', search PvP in the file. By default, this setting's value is 0 and you need to change it to 1 and remove the # char at the start of the line.

== Server raiding hours (for PvP) ==
'''(Please note: with A27 this feature is not recommend anymore as there is a better feature now ΓÇö S.H.I.E.L.D. protection that is enabled by default for PvP servers)'''

On PvP server, you could set up specific hours during which the raiding is possible.
 By default, offline raiding protection is not enabled so players could raid other players' bases at any time.
 To enable offline raiding protection, please use this in-game console command:
 <code>/admin.setRaidingWindow 4 14 1.5</code>
 In this code we're using (first number) +4 GMT/UTC timezone, (second number) hour of day when raiding is possible (value from 0 to 24), and (third number) is the duration of the raiding window (value from 0 to 24).
 So the code in the example will allow raiding from 14:00 (or 2PM) for 1.5 hours.
 After changing the value you could open Politics/Diplomacy menu ([P] key) and verify whether you set the correct numbers.
 Please note that Politics/Diplomacy menu displaying your local time (in your PC timezone)!

== How to prohibit client modifications ==
If you wish to restrict usage of any client modifications on your server, please find "<no_client_mods>" setting in the SettingsServer.xml file. Change the value from 0 to 1 to enable this feature. It's recommended for PvP servers to set it to 1. You can read more details about this feature in [https://atomictorch.com/Post/Id2218/A28-Justice-Update-Release A28 Update announcement].

CryoFall/Server/Setup

2022-07-28T23:25:50Z

Ai enabled: /* How to setup your own server (on any OS): */

= Local server / Singleplayer =
Starting with R31 "Singleplayer Update" the local server is seamlessly integrated into the game client. Other players can also connect to you over LAN (new tab in Multiplayer menu) and even over the internet with virtual LAN (with software such as Hamachi).

= Using game server hosting providers =

==== Game server rent service ====
''If you don't want to hassle with the game server setup, you can rent your own CryoFall server from any third party game server hosting company in just a few minutes. They provide data center locations in almost every country around the world!''
* [https://pingperfect.com/gameservers/cryofall-game-server-hosting-rental.php?aff=586 PingPerfect]
* [https://gameserver.4players.de/server-hosting/cryofall-server-mieten/ 4PLAYERS] (the website is available in German only)
''Please note that AtomicTorch Studio is not affiliated with any of these companies and not responsible for their service quality so in case of any issues please reach them directly. So far we've heard only positive feedback about their services.''

= Self-hosting =

== Requirements ==
====Hardware requirements====
(for up to about 30 players online) 1-core CPU 1.6-2 GHz, 1.5 GB RAM, 2-3 Mbit/s bandwidth (each way)
 (for up to about 100 players online) 2-core CPU 1.6-2 GHz, 2 GB RAM, 3-6 Mbit/s bandwidth
 (for up to about 200 players online) 2-core CPU 2.4-3 GHz, 2 GB RAM, 6-12 Mbit/s bandwidth
 (for up to about 300 players online) 2-core CPU 3+ GHz, 2.5 GB RAM, 12-20 Mbit/s bandwidth
 Usually, VPS (virtual machines) hosting such as [https://www.vultr.com/?ref=7238385 Vultr.com] (this is our referral link as we're using this company services to host our own servers) is sufficient for hosting a game server. Using 1-core machines is not recommended as the game requires a secondary CPU to ensure smooth performance without hiccups during intensive background operations (such as world snapshot saving). Using more than a 2-core machine for a single game server hosting is redundant as the game cannot utilize more than two cores due to the sequential execution of the game simulation (except networking).

====Software (system) requirements====
The server could run on Windows, Linux, and Mac.
To achieve this the game server is using .NET Runtime 6.0.
For hosting the official game servers we prefer using CentOS 7 with Docker or CentOS 8 with podman (OSS alternative to Docker).

== Server installation with Docker (best way for Linux) ==
We recommend this for Linux only. Please follow this guide [https://hub.docker.com/r/atomictorch/cryofall-server CryoFall Dedicated Server Docker Image] then return back here to '''"Server installation"''' section and follow the list after number 7. Ignore instructions on how to start the server with "dotnet" as you should use "docker run ..." instead as explained in the Docker guide above.

== Server installation / direct download (Windows, Linux, Mac) ==

==== How to setup your own server (on any OS): ====
# Download and '''install''' .NET Runtime 6.0 x64ΓÇöplease visit [https://dotnet.microsoft.com/download/dotnet/6.0/runtime Download .NET page] and follow the installation guide for your OS (for Windows you need to download x64 version from the "Run console apps" section).
# Download the game server package. There are several ways to do this:
## You can download it directly from our website:
### '''[https://atomictorch.com/Files/CryoFall_Server_v1.33.1.15.zip SERVER DOWNLOAD LINK (any OS)]'''
### Extract the downloaded package (it's a regular ZIP archive).
## Alternatively, you can download it from '''Steam Client''': ''(preferable, as this way you can easily download updates)''
### Launch Steam Client
### Select LIBRARY tab
### Click on "ALL" and toggle "Tools"
### Search for "CryoFall Dedicated Server" and install it
## Alternatively, you can download it with '''SteamCMD''' (if you're familiar with it):
### launch SteamCMD
### enter:
###: <code>
###: login anonymous
###: app_update 1061710
###: </code>
### navigate to the installation folder (usually in steamapps/Common/CryoFall Dedicated Server)
# The server executable is located in the subfolder: "Binaries/Server". Open the command line/terminal/SSH (or PowerShell in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable first time with <code>loadOrNew</code> flag. The server will start and create the game world.
#:<code>dotnet CryoFall_Server.dll loadOrNew</code>
# Usually it takes about 1-2 minutes to create a new world (or load a savegame). After that the server will keep writing performance statistics information every 20 seconds among other information such as the spawn scripts reporting and network events.
# Stop the server. To do so enter the command below and press Enter key.
#:<code>stop 0</code>
#The server will save and quit. Now you have the "SettingsServer.xml" and "ModsConfig.xml" files.
# Now you need to navigate to the subfolder "Data" (in the root of the server folder, '''not''' in the "Binaries/Server") and modify "SettingsServer.xml" to set the unique server '''name''' and set other settings, etc (there are XML comments explaining every setting so it should be straightforward). ''Please note that you can (and should) edit '''Description''' and '''Welcome message''' from the '''CURRENT GAME''' menu right from the game after connecting to your server.''
# If you are interested in making your server visible in the community servers list make sure to edit <is_public_server> and change the value from 0 to 1. Also, please make sure your router is configured correctly (port forwarding) to enable other people to connect to your machine from outside. But ideally, you should use dedicated server hardware (VPS or VDS) to host public servers.
# While you're still editing "SettingsServer.xml" file, please find the value '''<server_operators_list>''' and change it to include '''your nickname'''! Otherwise, you will be unable to access your server console from the game and also you will be unable to edit the server's Description and Welcome message.
# If you want to have a custom server icon, please replace the ServerIcon.png file in the "Data" subfolder. The icon image file requirements: '''PNG24 format, 256x256 size, up to 100 KB'''.

'''Important (for Windows only):''' you need to allow the dotnet process in the Windows Firewall settingsΓÇöif the Firewall access request was not shown automatically by Windows you can add the <code>C:\Program Files\dotnet\dotnet.exe</code> file into Firewall whitelist. To do this, open Windows Start menu and search for "Allow an app through Windows Firewall" -> button "Allow another app".

==== Starting the server ====
# Launch the command line (we recommending '''PowerShell''' in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable with <code>load</code> flag.
#:<code>dotnet CryoFall_Server.dll load</code>
# Stop your server by typing command below and pressing Enter key (it will save the world before stopping).
#:<code>stop 60 The shutdown message text goes here</code>
(Where <code>60</code> is the shutdown delay (in seconds) so the connected players will have some time to find a safe location)

'''''Please note that typing this message is really hard as the console is updating regularly! The best way is to simply copy-paste from the text editor the whole command text into the game console window (hint: you can paste in PowerShell by simply pressing the right mouse button) and pressing Enter key.'''''

You can always wipe the world by launching the game with <code>new</code> flag:
:<code>dotnet CryoFall_Server.dll new</code>

Currently, we don't support the savegame migration between the major game versions (if there are changes to the game data serialization scheme). We plan to implement the proper data migration feature ASAP.

==== Connecting to the server ====
If you want to connect to your local game server, simply add SERVERS->Custom list as <code>localhost</code>

To connect to the public server you need to navigate to SERVERS->Community servers list (please note that this might not work if you host this server on the same PC as the client, read below).

If you're attempting to host your server on a home computer and other players cannot connect to it, you need to manually forward the port '''UDP 6000''' on your home router to '''your local IP address''' (the game has the auto port forwarding feature but it often fails due to the difference in UPnP implementation on many routers). E.g. if your PC's IP address in local network is 192.168.1.100 (you can check it with ipconfig tool or in Windows network adapter's settings) you will need to setup a port forward rule on your router to forward traffic from port 6000 UDP to port 6000 UDP on IP address 192.168.1.100.

'''If you're running a game server on the same PC as the game client:'''
 Please note that you might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its address as <code>localhost:6000</code> and connect to it directly.

'''If you're running a game server in the same local network as the game client (for example you want to play over LAN with your friends and family):'''
 You might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its local IP address (IPv4) and connect to it directly. To get your local IP address please use ipconfig command-line tool or check the network adapter properties in the network center. You need to get the local network IP address of the PC that is hosting the game server. Then add it in the custom servers list on your PC. You can lookup the IP address in the Windows network settings or by using CMD tool called ipconfig in Windows. For example, here we've run the ipconfig tool here and see the IPv4 address as 192.168.1.200 ([https://cdn.discordapp.com/attachments/421250395298332672/739147674367950908/Screenshot_at_19-48-06.png screenshot]). We can use it on any other PC in the local network to connect to that PC hosting the game server.

Connecting to the private servers requires adding it via the Custom servers menu.

6000 is the default port but you can change it in the Data/SettingsServer.xml file.

== Server update/upgrade to new version ==
When we're releasing a new version of the game server, you need to follow these steps to update it:
# (If you have not done this) Install ".NET Runtime" (version 6.0) https://dotnet.microsoft.com/download/dotnet/6.0/runtime
# Ensure you've made a '''backup''' of the "'''Data'''" folder inside the game server installation folder.
# If you're updating from A28 or earlier versions (ONLY), delete "Data/Saves" folder as the savegame is not compatible (breaking changes). Update from A29 to R30/R31/R32 (or to any patch versions) '''doesn't require this step''' (savegame is compatible).
# Download the new version of the server and overwrite your current installation with it (you can find the actual download link above in the "Installation" section).
# Stop the game server (if it's running).
# Important: please '''overwrite''' both Binaries and Core folders!
# Start the server as usual.

== Server commands ==
# Ensure you're the server operator (you've edited the ServerSettings.xml file and added yourself into the server_operators_list).
# Connect to your game server.
# The game console can be toggled by pressing <code>~</code> (the key on the left from <code>1</code> key) like in old-school games (you can change the key binding for console in the controls options).
# Please add <code>/</code> (slash) prefix to the server commands you want to execute.
# You can use '''Tab''' key to fill autocomplete, and you can use '''arrow Up/Down keys''' to navigate the suggestions list. Press '''Tab''' or '''Enter''' to accept the suggestion.

Here is the page with the server commands list: [[CryoFall/Server/Commands|Server Commands List]]

== Moderation (whitelist, blacklist, kicking, muting) ==
Server operator can access special moderation commands. To invoke these commands, please ensure you're the server operator, connect to your game server, open the console (~ key) and then you can use these commands: (replace username with the actual player nickname)

Whitelist management:

<code>/mod.whiteList.add username</code>

<code>/mod.whiteList.remove username</code>

<code>/mod.whiteList.print</code>

To enable whitelist:

<code>/mod.whiteList.enabled 1</code>

Blacklist management:

<code>/mod.blackList.add username</code>

<code>/mod.blackList.remove username</code>

<code>/mod.blackList.print</code>

Kicking players (temporary removing from server and blocking from connecting):

<code>/mod.kickList.add username durationInMinutes</code>

<code>/mod.kickList.remove username</code>

<code>/mod.kickList.print</code>

Muting players (temporary removing their ability to send messages to chat):

<code>/mod.muteList.add username durationInMinutes</code>

<code>/mod.muteList.remove username</code>

<code>/mod.muteList.print</code>

== Server rates adjusting / Enabling PvP mode ==
Server rates (and PvP mode setting) are exposed in a separate "rates" config file. You can quickly change things like LP gain rate, increase item drops, reduce the player to player damage to zero, or even increase the damage from creatures and make it really tough for the players!

'''Important:''' Now you can edit the server rates right from the game if you have server operator access rights (if you don't, please see the guide above how to gain server operator rights by editing SettingsServer.xml file).
If you're a server operator, please log in to your server, press ESC key and you will see a menu containing a button to browse the server ratesΓÇöthere is also a '''"Edit"''' button right next to it (if you don't see it, please ensure that you have server operator access rights).

The guide below will explain how to edit the server rates config manually:
To adjust the server rates, stop the server and check the file <game server>/Data/ServerRates.config
Please read carefullyΓÇöall the rates are disabled and in order to apply them '''you need to remove the # char at the start of the line'''!
If you want to '''enable PvP''', search PvP in the file. By default, this setting's value is 0 and you need to change it to 1 and remove the # char at the start of the line.

== Server raiding hours (for PvP) ==
'''(Please note: with A27 this feature is not recommend anymore as there is a better feature now ΓÇö S.H.I.E.L.D. protection that is enabled by default for PvP servers)'''

On PvP server, you could set up specific hours during which the raiding is possible.
 By default, offline raiding protection is not enabled so players could raid other players' bases at any time.
 To enable offline raiding protection, please use this in-game console command:
 <code>/admin.setRaidingWindow 4 14 1.5</code>
 In this code we're using (first number) +4 GMT/UTC timezone, (second number) hour of day when raiding is possible (value from 0 to 24), and (third number) is the duration of the raiding window (value from 0 to 24).
 So the code in the example will allow raiding from 14:00 (or 2PM) for 1.5 hours.
 After changing the value you could open Politics/Diplomacy menu ([P] key) and verify whether you set the correct numbers.
 Please note that Politics/Diplomacy menu displaying your local time (in your PC timezone)!

== How to prohibit client modifications ==
If you wish to restrict usage of any client modifications on your server, please find "<no_client_mods>" setting in the SettingsServer.xml file. Change the value from 0 to 1 to enable this feature. It's recommended for PvP servers to set it to 1. You can read more details about this feature in [https://atomictorch.com/Post/Id2218/A28-Justice-Update-Release A28 Update announcement].

CryoFall/Server/Setup

2022-05-24T00:05:46Z

Ai enabled: /* Server rates adjusting / Enabling PvP mode */

= Local server / Singleplayer =
Starting with R31 "Singleplayer Update" the local server is seamlessly integrated into the game client. Other players can also connect to you over LAN (new tab in Multiplayer menu) and even over the internet with virtual LAN (with software such as Hamachi).

= Using game server hosting providers =

==== Game server rent service ====
''If you don't want to hassle with the game server setup, you can rent your own CryoFall server from any third party game server hosting company in just a few minutes. They provide data center locations in almost every country around the world!''
* [https://pingperfect.com/gameservers/cryofall-game-server-hosting-rental.php?aff=586 PingPerfect]
* [https://gameserver.4players.de/server-hosting/cryofall-server-mieten/ 4PLAYERS] (the website is available in German only)
''Please note that AtomicTorch Studio is not affiliated with any of these companies and not responsible for their service quality so in case of any issues please reach them directly. So far we've heard only positive feedback about their services.''

= Self-hosting =

== Requirements ==
====Hardware requirements====
(for up to about 30 players online) 1-core CPU 1.6-2 GHz, 1.5 GB RAM, 2-3 Mbit/s bandwidth (each way)
 (for up to about 100 players online) 2-core CPU 1.6-2 GHz, 2 GB RAM, 3-6 Mbit/s bandwidth
 (for up to about 200 players online) 2-core CPU 2.4-3 GHz, 2 GB RAM, 6-12 Mbit/s bandwidth
 (for up to about 300 players online) 2-core CPU 3+ GHz, 2.5 GB RAM, 12-20 Mbit/s bandwidth
 Usually, VPS (virtual machines) hosting such as [https://www.vultr.com/?ref=7238385 Vultr.com] (this is our referral link as we're using this company services to host our own servers) is sufficient for hosting a game server. Using 1-core machines is not recommended as the game requires a secondary CPU to ensure smooth performance without hiccups during intensive background operations (such as world snapshot saving). Using more than a 2-core machine for a single game server hosting is redundant as the game cannot utilize more than two cores due to the sequential execution of the game simulation (except networking).

====Software (system) requirements====
The server could run on Windows, Linux, and Mac.
To achieve this the game server is using .NET Runtime 6.0.
For hosting the official game servers we prefer using CentOS 7 with Docker or CentOS 8 with podman (OSS alternative to Docker).

== Server installation with Docker (best way for Linux) ==
We recommend this for Linux only. Please follow this guide [https://hub.docker.com/r/atomictorch/cryofall-server CryoFall Dedicated Server Docker Image] then return back here to '''"Server installation"''' section and follow the list after number 7. Ignore instructions on how to start the server with "dotnet" as you should use "docker run ..." instead as explained in the Docker guide above.

== Server installation / direct download (Windows, Linux, Mac) ==

==== How to setup your own server (on any OS): ====
# Download and '''install''' .NET Runtime 6.0 x64ΓÇöplease visit [https://dotnet.microsoft.com/download/dotnet/6.0/runtime Download .NET page] and follow the installation guide for your OS (for Windows you need to download x64 version from the "Run console apps" section).
# Download the game server package. There are several ways to do this:
## You can download it directly from our website:
### '''[https://atomictorch.com/Files/CryoFall_Server_v1.33.1.8.zip SERVER DOWNLOAD LINK (any OS)]'''
### Extract the downloaded package (it's a regular ZIP archive).
## Alternatively, you can download it from '''Steam Client''': ''(preferable, as this way you can easily download updates)''
### Launch Steam Client
### Select LIBRARY tab
### Click on "ALL" and toggle "Tools"
### Search for "CryoFall Dedicated Server" and install it
## Alternatively, you can download it with '''SteamCMD''' (if you're familiar with it):
### launch SteamCMD
### enter:
###: <code>
###: login anonymous
###: app_update 1061710
###: </code>
### navigate to the installation folder (usually in steamapps/Common/CryoFall Dedicated Server)
# The server executable is located in the subfolder: "Binaries/Server". Open the command line/terminal/SSH (or PowerShell in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable first time with <code>loadOrNew</code> flag. The server will start and create the game world.
#:<code>dotnet CryoFall_Server.dll loadOrNew</code>
# Usually it takes about 1-2 minutes to create a new world (or load a savegame). After that the server will keep writing performance statistics information every 20 seconds among other information such as the spawn scripts reporting and network events.
# Stop the server. To do so enter the command below and press Enter key.
#:<code>stop 0</code>
#The server will save and quit. Now you have the "SettingsServer.xml" and "ModsConfig.xml" files.
# Now you need to navigate to the subfolder "Data" (in the root of the server folder, '''not''' in the "Binaries/Server") and modify "SettingsServer.xml" to set the unique server '''name''' and set other settings, etc (there are XML comments explaining every setting so it should be straightforward). ''Please note that you can (and should) edit '''Description''' and '''Welcome message''' from the '''CURRENT GAME''' menu right from the game after connecting to your server.''
# If you are interested in making your server visible in the community servers list make sure to edit <is_public_server> and change the value from 0 to 1. Also, please make sure your router is configured correctly (port forwarding) to enable other people to connect to your machine from outside. But ideally, you should use dedicated server hardware (VPS or VDS) to host public servers.
# While you're still editing "SettingsServer.xml" file, please find the value '''<server_operators_list>''' and change it to include '''your nickname'''! Otherwise, you will be unable to access your server console from the game and also you will be unable to edit the server's Description and Welcome message.
# If you want to have a custom server icon, please replace the ServerIcon.png file in the "Data" subfolder. The icon image file requirements: '''PNG24 format, 256x256 size, up to 100 KB'''.

'''Important (for Windows only):''' you need to allow the dotnet process in the Windows Firewall settingsΓÇöif the Firewall access request was not shown automatically by Windows you can add the <code>C:\Program Files\dotnet\dotnet.exe</code> file into Firewall whitelist. To do this, open Windows Start menu and search for "Allow an app through Windows Firewall" -> button "Allow another app".

==== Starting the server ====
# Launch the command line (we recommending '''PowerShell''' in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable with <code>load</code> flag.
#:<code>dotnet CryoFall_Server.dll load</code>
# Stop your server by typing command below and pressing Enter key (it will save the world before stopping).
#:<code>stop 60 The shutdown message text goes here</code>
(Where <code>60</code> is the shutdown delay (in seconds) so the connected players will have some time to find a safe location)

'''''Please note that typing this message is really hard as the console is updating regularly! The best way is to simply copy-paste from the text editor the whole command text into the game console window (hint: you can paste in PowerShell by simply pressing the right mouse button) and pressing Enter key.'''''

You can always wipe the world by launching the game with <code>new</code> flag:
:<code>dotnet CryoFall_Server.dll new</code>

Currently, we don't support the savegame migration between the major game versions (if there are changes to the game data serialization scheme). We plan to implement the proper data migration feature ASAP.

==== Connecting to the server ====
If you want to connect to your local game server, simply add SERVERS->Custom list as <code>localhost</code>

To connect to the public server you need to navigate to SERVERS->Community servers list (please note that this might not work if you host this server on the same PC as the client, read below).

If you're attempting to host your server on a home computer and other players cannot connect to it, you need to manually forward the port '''UDP 6000''' on your home router to '''your local IP address''' (the game has the auto port forwarding feature but it often fails due to the difference in UPnP implementation on many routers). E.g. if your PC's IP address in local network is 192.168.1.100 (you can check it with ipconfig tool or in Windows network adapter's settings) you will need to setup a port forward rule on your router to forward traffic from port 6000 UDP to port 6000 UDP on IP address 192.168.1.100.

'''If you're running a game server on the same PC as the game client:'''
 Please note that you might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its address as <code>localhost:6000</code> and connect to it directly.

'''If you're running a game server in the same local network as the game client (for example you want to play over LAN with your friends and family):'''
 You might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its local IP address (IPv4) and connect to it directly. To get your local IP address please use ipconfig command-line tool or check the network adapter properties in the network center. You need to get the local network IP address of the PC that is hosting the game server. Then add it in the custom servers list on your PC. You can lookup the IP address in the Windows network settings or by using CMD tool called ipconfig in Windows. For example, here we've run the ipconfig tool here and see the IPv4 address as 192.168.1.200 ([https://cdn.discordapp.com/attachments/421250395298332672/739147674367950908/Screenshot_at_19-48-06.png screenshot]). We can use it on any other PC in the local network to connect to that PC hosting the game server.

Connecting to the private servers requires adding it via the Custom servers menu.

6000 is the default port but you can change it in the Data/SettingsServer.xml file.

== Server update/upgrade to new version ==
When we're releasing a new version of the game server, you need to follow these steps to update it:
# (If you have not done this) Install ".NET Runtime" (version 6.0) https://dotnet.microsoft.com/download/dotnet/6.0/runtime
# Ensure you've made a '''backup''' of the "'''Data'''" folder inside the game server installation folder.
# If you're updating from A28 or earlier versions (ONLY), delete "Data/Saves" folder as the savegame is not compatible (breaking changes). Update from A29 to R30/R31/R32 (or to any patch versions) '''doesn't require this step''' (savegame is compatible).
# Download the new version of the server and overwrite your current installation with it (you can find the actual download link above in the "Installation" section).
# Stop the game server (if it's running).
# Important: please '''overwrite''' both Binaries and Core folders!
# Start the server as usual.

== Server commands ==
# Ensure you're the server operator (you've edited the ServerSettings.xml file and added yourself into the server_operators_list).
# Connect to your game server.
# The game console can be toggled by pressing <code>~</code> (the key on the left from <code>1</code> key) like in old-school games (you can change the key binding for console in the controls options).
# Please add <code>/</code> (slash) prefix to the server commands you want to execute.
# You can use '''Tab''' key to fill autocomplete, and you can use '''arrow Up/Down keys''' to navigate the suggestions list. Press '''Tab''' or '''Enter''' to accept the suggestion.

Here is the page with the server commands list: [[CryoFall/Server/Commands|Server Commands List]]

== Moderation (whitelist, blacklist, kicking, muting) ==
Server operator can access special moderation commands. To invoke these commands, please ensure you're the server operator, connect to your game server, open the console (~ key) and then you can use these commands: (replace username with the actual player nickname)

Whitelist management:

<code>/mod.whiteList.add username</code>

<code>/mod.whiteList.remove username</code>

<code>/mod.whiteList.print</code>

To enable whitelist:

<code>/mod.whiteList.enabled 1</code>

Blacklist management:

<code>/mod.blackList.add username</code>

<code>/mod.blackList.remove username</code>

<code>/mod.blackList.print</code>

Kicking players (temporary removing from server and blocking from connecting):

<code>/mod.kickList.add username durationInMinutes</code>

<code>/mod.kickList.remove username</code>

<code>/mod.kickList.print</code>

Muting players (temporary removing their ability to send messages to chat):

<code>/mod.muteList.add username durationInMinutes</code>

<code>/mod.muteList.remove username</code>

<code>/mod.muteList.print</code>

== Server rates adjusting / Enabling PvP mode ==
Server rates (and PvP mode setting) are exposed in a separate "rates" config file. You can quickly change things like LP gain rate, increase item drops, reduce the player to player damage to zero, or even increase the damage from creatures and make it really tough for the players!

'''Important:''' Now you can edit the server rates right from the game if you have server operator access rights (if you don't, please see the guide above how to gain server operator rights by editing SettingsServer.xml file).
If you're a server operator, please log in to your server, press ESC key and you will see a menu containing a button to browse the server ratesΓÇöthere is also a '''"Edit"''' button right next to it (if you don't see it, please ensure that you have server operator access rights).

The guide below will explain how to edit the server rates config manually:
To adjust the server rates, stop the server and check the file <game server>/Data/ServerRates.config
Please read carefullyΓÇöall the rates are disabled and in order to apply them '''you need to remove the # char at the start of the line'''!
If you want to '''enable PvP''', search PvP in the file. By default, this setting's value is 0 and you need to change it to 1 and remove the # char at the start of the line.

== Server raiding hours (for PvP) ==
'''(Please note: with A27 this feature is not recommend anymore as there is a better feature now ΓÇö S.H.I.E.L.D. protection that is enabled by default for PvP servers)'''

On PvP server, you could set up specific hours during which the raiding is possible.
 By default, offline raiding protection is not enabled so players could raid other players' bases at any time.
 To enable offline raiding protection, please use this in-game console command:
 <code>/admin.setRaidingWindow 4 14 1.5</code>
 In this code we're using (first number) +4 GMT/UTC timezone, (second number) hour of day when raiding is possible (value from 0 to 24), and (third number) is the duration of the raiding window (value from 0 to 24).
 So the code in the example will allow raiding from 14:00 (or 2PM) for 1.5 hours.
 After changing the value you could open Politics/Diplomacy menu ([P] key) and verify whether you set the correct numbers.
 Please note that Politics/Diplomacy menu displaying your local time (in your PC timezone)!

== How to prohibit client modifications ==
If you wish to restrict usage of any client modifications on your server, please find "<no_client_mods>" setting in the SettingsServer.xml file. Change the value from 0 to 1 to enable this feature. It's recommended for PvP servers to set it to 1. You can read more details about this feature in [https://atomictorch.com/Post/Id2218/A28-Justice-Update-Release A28 Update announcement].

CryoFall/Server/Setup

2022-05-24T00:02:36Z

Ai enabled: /* Server rates adjusting / Enabling PvP mode */

= Local server / Singleplayer =
Starting with R31 "Singleplayer Update" the local server is seamlessly integrated into the game client. Other players can also connect to you over LAN (new tab in Multiplayer menu) and even over the internet with virtual LAN (with software such as Hamachi).

= Using game server hosting providers =

==== Game server rent service ====
''If you don't want to hassle with the game server setup, you can rent your own CryoFall server from any third party game server hosting company in just a few minutes. They provide data center locations in almost every country around the world!''
* [https://pingperfect.com/gameservers/cryofall-game-server-hosting-rental.php?aff=586 PingPerfect]
* [https://gameserver.4players.de/server-hosting/cryofall-server-mieten/ 4PLAYERS] (the website is available in German only)
''Please note that AtomicTorch Studio is not affiliated with any of these companies and not responsible for their service quality so in case of any issues please reach them directly. So far we've heard only positive feedback about their services.''

= Self-hosting =

== Requirements ==
====Hardware requirements====
(for up to about 30 players online) 1-core CPU 1.6-2 GHz, 1.5 GB RAM, 2-3 Mbit/s bandwidth (each way)
 (for up to about 100 players online) 2-core CPU 1.6-2 GHz, 2 GB RAM, 3-6 Mbit/s bandwidth
 (for up to about 200 players online) 2-core CPU 2.4-3 GHz, 2 GB RAM, 6-12 Mbit/s bandwidth
 (for up to about 300 players online) 2-core CPU 3+ GHz, 2.5 GB RAM, 12-20 Mbit/s bandwidth
 Usually, VPS (virtual machines) hosting such as [https://www.vultr.com/?ref=7238385 Vultr.com] (this is our referral link as we're using this company services to host our own servers) is sufficient for hosting a game server. Using 1-core machines is not recommended as the game requires a secondary CPU to ensure smooth performance without hiccups during intensive background operations (such as world snapshot saving). Using more than a 2-core machine for a single game server hosting is redundant as the game cannot utilize more than two cores due to the sequential execution of the game simulation (except networking).

====Software (system) requirements====
The server could run on Windows, Linux, and Mac.
To achieve this the game server is using .NET Runtime 6.0.
For hosting the official game servers we prefer using CentOS 7 with Docker or CentOS 8 with podman (OSS alternative to Docker).

== Server installation with Docker (best way for Linux) ==
We recommend this for Linux only. Please follow this guide [https://hub.docker.com/r/atomictorch/cryofall-server CryoFall Dedicated Server Docker Image] then return back here to '''"Server installation"''' section and follow the list after number 7. Ignore instructions on how to start the server with "dotnet" as you should use "docker run ..." instead as explained in the Docker guide above.

== Server installation / direct download (Windows, Linux, Mac) ==

==== How to setup your own server (on any OS): ====
# Download and '''install''' .NET Runtime 6.0 x64ΓÇöplease visit [https://dotnet.microsoft.com/download/dotnet/6.0/runtime Download .NET page] and follow the installation guide for your OS (for Windows you need to download x64 version from the "Run console apps" section).
# Download the game server package. There are several ways to do this:
## You can download it directly from our website:
### '''[https://atomictorch.com/Files/CryoFall_Server_v1.33.1.8.zip SERVER DOWNLOAD LINK (any OS)]'''
### Extract the downloaded package (it's a regular ZIP archive).
## Alternatively, you can download it from '''Steam Client''': ''(preferable, as this way you can easily download updates)''
### Launch Steam Client
### Select LIBRARY tab
### Click on "ALL" and toggle "Tools"
### Search for "CryoFall Dedicated Server" and install it
## Alternatively, you can download it with '''SteamCMD''' (if you're familiar with it):
### launch SteamCMD
### enter:
###: <code>
###: login anonymous
###: app_update 1061710
###: </code>
### navigate to the installation folder (usually in steamapps/Common/CryoFall Dedicated Server)
# The server executable is located in the subfolder: "Binaries/Server". Open the command line/terminal/SSH (or PowerShell in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable first time with <code>loadOrNew</code> flag. The server will start and create the game world.
#:<code>dotnet CryoFall_Server.dll loadOrNew</code>
# Usually it takes about 1-2 minutes to create a new world (or load a savegame). After that the server will keep writing performance statistics information every 20 seconds among other information such as the spawn scripts reporting and network events.
# Stop the server. To do so enter the command below and press Enter key.
#:<code>stop 0</code>
#The server will save and quit. Now you have the "SettingsServer.xml" and "ModsConfig.xml" files.
# Now you need to navigate to the subfolder "Data" (in the root of the server folder, '''not''' in the "Binaries/Server") and modify "SettingsServer.xml" to set the unique server '''name''' and set other settings, etc (there are XML comments explaining every setting so it should be straightforward). ''Please note that you can (and should) edit '''Description''' and '''Welcome message''' from the '''CURRENT GAME''' menu right from the game after connecting to your server.''
# If you are interested in making your server visible in the community servers list make sure to edit <is_public_server> and change the value from 0 to 1. Also, please make sure your router is configured correctly (port forwarding) to enable other people to connect to your machine from outside. But ideally, you should use dedicated server hardware (VPS or VDS) to host public servers.
# While you're still editing "SettingsServer.xml" file, please find the value '''<server_operators_list>''' and change it to include '''your nickname'''! Otherwise, you will be unable to access your server console from the game and also you will be unable to edit the server's Description and Welcome message.
# If you want to have a custom server icon, please replace the ServerIcon.png file in the "Data" subfolder. The icon image file requirements: '''PNG24 format, 256x256 size, up to 100 KB'''.

'''Important (for Windows only):''' you need to allow the dotnet process in the Windows Firewall settingsΓÇöif the Firewall access request was not shown automatically by Windows you can add the <code>C:\Program Files\dotnet\dotnet.exe</code> file into Firewall whitelist. To do this, open Windows Start menu and search for "Allow an app through Windows Firewall" -> button "Allow another app".

==== Starting the server ====
# Launch the command line (we recommending '''PowerShell''' in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable with <code>load</code> flag.
#:<code>dotnet CryoFall_Server.dll load</code>
# Stop your server by typing command below and pressing Enter key (it will save the world before stopping).
#:<code>stop 60 The shutdown message text goes here</code>
(Where <code>60</code> is the shutdown delay (in seconds) so the connected players will have some time to find a safe location)

'''''Please note that typing this message is really hard as the console is updating regularly! The best way is to simply copy-paste from the text editor the whole command text into the game console window (hint: you can paste in PowerShell by simply pressing the right mouse button) and pressing Enter key.'''''

You can always wipe the world by launching the game with <code>new</code> flag:
:<code>dotnet CryoFall_Server.dll new</code>

Currently, we don't support the savegame migration between the major game versions (if there are changes to the game data serialization scheme). We plan to implement the proper data migration feature ASAP.

==== Connecting to the server ====
If you want to connect to your local game server, simply add SERVERS->Custom list as <code>localhost</code>

To connect to the public server you need to navigate to SERVERS->Community servers list (please note that this might not work if you host this server on the same PC as the client, read below).

If you're attempting to host your server on a home computer and other players cannot connect to it, you need to manually forward the port '''UDP 6000''' on your home router to '''your local IP address''' (the game has the auto port forwarding feature but it often fails due to the difference in UPnP implementation on many routers). E.g. if your PC's IP address in local network is 192.168.1.100 (you can check it with ipconfig tool or in Windows network adapter's settings) you will need to setup a port forward rule on your router to forward traffic from port 6000 UDP to port 6000 UDP on IP address 192.168.1.100.

'''If you're running a game server on the same PC as the game client:'''
 Please note that you might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its address as <code>localhost:6000</code> and connect to it directly.

'''If you're running a game server in the same local network as the game client (for example you want to play over LAN with your friends and family):'''
 You might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its local IP address (IPv4) and connect to it directly. To get your local IP address please use ipconfig command-line tool or check the network adapter properties in the network center. You need to get the local network IP address of the PC that is hosting the game server. Then add it in the custom servers list on your PC. You can lookup the IP address in the Windows network settings or by using CMD tool called ipconfig in Windows. For example, here we've run the ipconfig tool here and see the IPv4 address as 192.168.1.200 ([https://cdn.discordapp.com/attachments/421250395298332672/739147674367950908/Screenshot_at_19-48-06.png screenshot]). We can use it on any other PC in the local network to connect to that PC hosting the game server.

Connecting to the private servers requires adding it via the Custom servers menu.

6000 is the default port but you can change it in the Data/SettingsServer.xml file.

== Server update/upgrade to new version ==
When we're releasing a new version of the game server, you need to follow these steps to update it:
# (If you have not done this) Install ".NET Runtime" (version 6.0) https://dotnet.microsoft.com/download/dotnet/6.0/runtime
# Ensure you've made a '''backup''' of the "'''Data'''" folder inside the game server installation folder.
# If you're updating from A28 or earlier versions (ONLY), delete "Data/Saves" folder as the savegame is not compatible (breaking changes). Update from A29 to R30/R31/R32 (or to any patch versions) '''doesn't require this step''' (savegame is compatible).
# Download the new version of the server and overwrite your current installation with it (you can find the actual download link above in the "Installation" section).
# Stop the game server (if it's running).
# Important: please '''overwrite''' both Binaries and Core folders!
# Start the server as usual.

== Server commands ==
# Ensure you're the server operator (you've edited the ServerSettings.xml file and added yourself into the server_operators_list).
# Connect to your game server.
# The game console can be toggled by pressing <code>~</code> (the key on the left from <code>1</code> key) like in old-school games (you can change the key binding for console in the controls options).
# Please add <code>/</code> (slash) prefix to the server commands you want to execute.
# You can use '''Tab''' key to fill autocomplete, and you can use '''arrow Up/Down keys''' to navigate the suggestions list. Press '''Tab''' or '''Enter''' to accept the suggestion.

Here is the page with the server commands list: [[CryoFall/Server/Commands|Server Commands List]]

== Moderation (whitelist, blacklist, kicking, muting) ==
Server operator can access special moderation commands. To invoke these commands, please ensure you're the server operator, connect to your game server, open the console (~ key) and then you can use these commands: (replace username with the actual player nickname)

Whitelist management:

<code>/mod.whiteList.add username</code>

<code>/mod.whiteList.remove username</code>

<code>/mod.whiteList.print</code>

To enable whitelist:

<code>/mod.whiteList.enabled 1</code>

Blacklist management:

<code>/mod.blackList.add username</code>

<code>/mod.blackList.remove username</code>

<code>/mod.blackList.print</code>

Kicking players (temporary removing from server and blocking from connecting):

<code>/mod.kickList.add username durationInMinutes</code>

<code>/mod.kickList.remove username</code>

<code>/mod.kickList.print</code>

Muting players (temporary removing their ability to send messages to chat):

<code>/mod.muteList.add username durationInMinutes</code>

<code>/mod.muteList.remove username</code>

<code>/mod.muteList.print</code>

== Server rates adjusting / Enabling PvP mode ==
Server rates (and PvP mode setting) are exposed in a separate "rates" config file. You can quickly change things like LP gain rate, increase item drops, reduce the player to player damage to zero, or even increase the damage from creatures and make it really tough for the players!

'''Important:''' Now you can edit the server rates right from the game if you have server operator access rights (if you don't, please see the guide above how to gain server operator rights by editing SettingsServer.xml file).
If you're a server operator, please log in to your server, press ESC key and you will a menu containing a button to browse the server ratesΓÇöthere is also a '''"Edit"''' button right next to it (if you don't see it, please ensure that you have server operator access rights).

The guide below will explain how to edit the server rates config manually:
To adjust the server rates, stop the server and check the file <game server>/Data/ServerRates.config
Please read carefullyΓÇöall the rates are disabled and in order to apply them '''you need to remove the # char at the start of the line'''!
If you want to '''enable PvP''', search PvP in the file. By default, this setting's value is 0 and you need to change it to 1 and remove the # char at the start of the line.

== Server raiding hours (for PvP) ==
'''(Please note: with A27 this feature is not recommend anymore as there is a better feature now ΓÇö S.H.I.E.L.D. protection that is enabled by default for PvP servers)'''

On PvP server, you could set up specific hours during which the raiding is possible.
 By default, offline raiding protection is not enabled so players could raid other players' bases at any time.
 To enable offline raiding protection, please use this in-game console command:
 <code>/admin.setRaidingWindow 4 14 1.5</code>
 In this code we're using (first number) +4 GMT/UTC timezone, (second number) hour of day when raiding is possible (value from 0 to 24), and (third number) is the duration of the raiding window (value from 0 to 24).
 So the code in the example will allow raiding from 14:00 (or 2PM) for 1.5 hours.
 After changing the value you could open Politics/Diplomacy menu ([P] key) and verify whether you set the correct numbers.
 Please note that Politics/Diplomacy menu displaying your local time (in your PC timezone)!

== How to prohibit client modifications ==
If you wish to restrict usage of any client modifications on your server, please find "<no_client_mods>" setting in the SettingsServer.xml file. Change the value from 0 to 1 to enable this feature. It's recommended for PvP servers to set it to 1. You can read more details about this feature in [https://atomictorch.com/Post/Id2218/A28-Justice-Update-Release A28 Update announcement].

CryoFall/Server/Setup

2022-02-18T12:54:18Z

Ai enabled: /* Server update/upgrade to new version */

= Local server / Singleplayer =
Starting with R31 "Singleplayer Update" the local server is seamlessly integrated into the game client. Other players can also connect to you over LAN (new tab in Multiplayer menu) and even over the internet with virtual LAN (with software such as Hamachi).

= Using game server hosting providers =

==== Game server rent service ====
''If you don't want to hassle with the game server setup, you can rent your own CryoFall server from any third party game server hosting company in just a few minutes. They provide data center locations in almost every country around the world!''
* [https://pingperfect.com/gameservers/cryofall-game-server-hosting-rental.php?aff=586 PingPerfect]
* [https://gameserver.4players.de/server-hosting/cryofall-server-mieten/ 4PLAYERS] (the website is available in German only)
''Please note that AtomicTorch Studio is not affiliated with any of these companies and not responsible for their service quality so in case of any issues please reach them directly. So far we've heard only positive feedback about their services.''

= Self-hosting =

== Requirements ==
====Hardware requirements====
(for up to about 30 players online) 1-core CPU 1.6-2 GHz, 1.5 GB RAM, 2-3 Mbit/s bandwidth (each way)
 (for up to about 100 players online) 2-core CPU 1.6-2 GHz, 2 GB RAM, 3-6 Mbit/s bandwidth
 (for up to about 200 players online) 2-core CPU 2.4-3 GHz, 2 GB RAM, 6-12 Mbit/s bandwidth
 (for up to about 300 players online) 2-core CPU 3+ GHz, 2.5 GB RAM, 12-20 Mbit/s bandwidth
 Usually, VPS (virtual machines) hosting such as [https://www.vultr.com/?ref=7238385 Vultr.com] (this is our referral link as we're using this company services to host our own servers) is sufficient for hosting a game server. Using 1-core machines is not recommended as the game requires a secondary CPU to ensure smooth performance without hiccups during intensive background operations (such as world snapshot saving). Using more than a 2-core machine for a single game server hosting is redundant as the game cannot utilize more than two cores due to the sequential execution of the game simulation (except networking).

====Software (system) requirements====
The server could run on Windows, Linux, and Mac.
To achieve this the game server is using .NET Runtime 6.0.
For hosting the official game servers we prefer using CentOS 7 with Docker or CentOS 8 with podman (OSS alternative to Docker).

== Server installation with Docker (best way for Linux) ==
We recommend this for Linux only. Please follow this guide [https://hub.docker.com/r/atomictorch/cryofall-server CryoFall Dedicated Server Docker Image] then return back here to '''"Server installation"''' section and follow the list after number 7. Ignore instructions on how to start the server with "dotnet" as you should use "docker run ..." instead as explained in the Docker guide above.

== Server installation / direct download (Windows, Linux, Mac) ==

==== How to setup your own server (on any OS): ====
# Download and '''install''' .NET Runtime 6.0 x64ΓÇöplease visit [https://dotnet.microsoft.com/download/dotnet/6.0/runtime Download .NET page] and follow the installation guide for your OS (for Windows you need to download x64 version from the "Run console apps" section).
# Download the game server package. There are several ways to do this:
## You can download it directly from our website:
### '''[https://atomictorch.com/Files/CryoFall_Server_v1.33.1.8.zip SERVER DOWNLOAD LINK (any OS)]'''
### Extract the downloaded package (it's a regular ZIP archive).
## Alternatively, you can download it from '''Steam Client''': ''(preferable, as this way you can easily download updates)''
### Launch Steam Client
### Select LIBRARY tab
### Click on "ALL" and toggle "Tools"
### Search for "CryoFall Dedicated Server" and install it
## Alternatively, you can download it with '''SteamCMD''' (if you're familiar with it):
### launch SteamCMD
### enter:
###: <code>
###: login anonymous
###: app_update 1061710
###: </code>
### navigate to the installation folder (usually in steamapps/Common/CryoFall Dedicated Server)
# The server executable is located in the subfolder: "Binaries/Server". Open the command line/terminal/SSH (or PowerShell in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable first time with <code>loadOrNew</code> flag. The server will start and create the game world.
#:<code>dotnet CryoFall_Server.dll loadOrNew</code>
# Usually it takes about 1-2 minutes to create a new world (or load a savegame). After that the server will keep writing performance statistics information every 20 seconds among other information such as the spawn scripts reporting and network events.
# Stop the server. To do so enter the command below and press Enter key.
#:<code>stop 0</code>
#The server will save and quit. Now you have the "SettingsServer.xml" and "ModsConfig.xml" files.
# Now you need to navigate to the subfolder "Data" (in the root of the server folder, '''not''' in the "Binaries/Server") and modify "SettingsServer.xml" to set the unique server '''name''' and set other settings, etc (there are XML comments explaining every setting so it should be straightforward). ''Please note that you can (and should) edit '''Description''' and '''Welcome message''' from the '''CURRENT GAME''' menu right from the game after connecting to your server.''
# If you are interested in making your server visible in the community servers list make sure to edit <is_public_server> and change the value from 0 to 1. Also, please make sure your router is configured correctly (port forwarding) to enable other people to connect to your machine from outside. But ideally, you should use dedicated server hardware (VPS or VDS) to host public servers.
# While you're still editing "SettingsServer.xml" file, please find the value '''<server_operators_list>''' and change it to include '''your nickname'''! Otherwise, you will be unable to access your server console from the game and also you will be unable to edit the server's Description and Welcome message.
# If you want to have a custom server icon, please replace the ServerIcon.png file in the "Data" subfolder. The icon image file requirements: '''PNG24 format, 256x256 size, up to 100 KB'''.

'''Important (for Windows only):''' you need to allow the dotnet process in the Windows Firewall settingsΓÇöif the Firewall access request was not shown automatically by Windows you can add the <code>C:\Program Files\dotnet\dotnet.exe</code> file into Firewall whitelist. To do this, open Windows Start menu and search for "Allow an app through Windows Firewall" -> button "Allow another app".

==== Starting the server ====
# Launch the command line (we recommending '''PowerShell''' in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable with <code>load</code> flag.
#:<code>dotnet CryoFall_Server.dll load</code>
# Stop your server by typing command below and pressing Enter key (it will save the world before stopping).
#:<code>stop 60 The shutdown message text goes here</code>
(Where <code>60</code> is the shutdown delay (in seconds) so the connected players will have some time to find a safe location)

'''''Please note that typing this message is really hard as the console is updating regularly! The best way is to simply copy-paste from the text editor the whole command text into the game console window (hint: you can paste in PowerShell by simply pressing the right mouse button) and pressing Enter key.'''''

You can always wipe the world by launching the game with <code>new</code> flag:
:<code>dotnet CryoFall_Server.dll new</code>

Currently, we don't support the savegame migration between the major game versions (if there are changes to the game data serialization scheme). We plan to implement the proper data migration feature ASAP.

==== Connecting to the server ====
If you want to connect to your local game server, simply add SERVERS->Custom list as <code>localhost</code>

To connect to the public server you need to navigate to SERVERS->Community servers list (please note that this might not work if you host this server on the same PC as the client, read below).

If you're attempting to host your server on a home computer and other players cannot connect to it, you need to manually forward the port '''UDP 6000''' on your home router to '''your local IP address''' (the game has the auto port forwarding feature but it often fails due to the difference in UPnP implementation on many routers). E.g. if your PC's IP address in local network is 192.168.1.100 (you can check it with ipconfig tool or in Windows network adapter's settings) you will need to setup a port forward rule on your router to forward traffic from port 6000 UDP to port 6000 UDP on IP address 192.168.1.100.

'''If you're running a game server on the same PC as the game client:'''
 Please note that you might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its address as <code>localhost:6000</code> and connect to it directly.

'''If you're running a game server in the same local network as the game client (for example you want to play over LAN with your friends and family):'''
 You might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its local IP address (IPv4) and connect to it directly. To get your local IP address please use ipconfig command-line tool or check the network adapter properties in the network center. You need to get the local network IP address of the PC that is hosting the game server. Then add it in the custom servers list on your PC. You can lookup the IP address in the Windows network settings or by using CMD tool called ipconfig in Windows. For example, here we've run the ipconfig tool here and see the IPv4 address as 192.168.1.200 ([https://cdn.discordapp.com/attachments/421250395298332672/739147674367950908/Screenshot_at_19-48-06.png screenshot]). We can use it on any other PC in the local network to connect to that PC hosting the game server.

Connecting to the private servers requires adding it via the Custom servers menu.

6000 is the default port but you can change it in the Data/SettingsServer.xml file.

== Server update/upgrade to new version ==
When we're releasing a new version of the game server, you need to follow these steps to update it:
# (If you have not done this) Install ".NET Runtime" (version 6.0) https://dotnet.microsoft.com/download/dotnet/6.0/runtime
# Ensure you've made a '''backup''' of the "'''Data'''" folder inside the game server installation folder.
# If you're updating from A28 or earlier versions (ONLY), delete "Data/Saves" folder as the savegame is not compatible (breaking changes). Update from A29 to R30/R31/R32 (or to any patch versions) '''doesn't require this step''' (savegame is compatible).
# Download the new version of the server and overwrite your current installation with it (you can find the actual download link above in the "Installation" section).
# Stop the game server (if it's running).
# Important: please '''overwrite''' both Binaries and Core folders!
# Start the server as usual.

== Server commands ==
# Ensure you're the server operator (you've edited the ServerSettings.xml file and added yourself into the server_operators_list).
# Connect to your game server.
# The game console can be toggled by pressing <code>~</code> (the key on the left from <code>1</code> key) like in old-school games (you can change the key binding for console in the controls options).
# Please add <code>/</code> (slash) prefix to the server commands you want to execute.
# You can use '''Tab''' key to fill autocomplete, and you can use '''arrow Up/Down keys''' to navigate the suggestions list. Press '''Tab''' or '''Enter''' to accept the suggestion.

Here is the page with the server commands list: [[CryoFall/Server/Commands|Server Commands List]]

== Moderation (whitelist, blacklist, kicking, muting) ==
Server operator can access special moderation commands. To invoke these commands, please ensure you're the server operator, connect to your game server, open the console (~ key) and then you can use these commands: (replace username with the actual player nickname)

Whitelist management:

<code>/mod.whiteList.add username</code>

<code>/mod.whiteList.remove username</code>

<code>/mod.whiteList.print</code>

To enable whitelist:

<code>/mod.whiteList.enabled 1</code>

Blacklist management:

<code>/mod.blackList.add username</code>

<code>/mod.blackList.remove username</code>

<code>/mod.blackList.print</code>

Kicking players (temporary removing from server and blocking from connecting):

<code>/mod.kickList.add username durationInMinutes</code>

<code>/mod.kickList.remove username</code>

<code>/mod.kickList.print</code>

Muting players (temporary removing their ability to send messages to chat):

<code>/mod.muteList.add username durationInMinutes</code>

<code>/mod.muteList.remove username</code>

<code>/mod.muteList.print</code>

== Server rates adjusting / Enabling PvP mode ==
Server rates (and PvP mode setting) are exposed in a separate config file. You can quickly change things like LP gain rate, increase item drops, reduce the player to player damage to zero, or even increase the damage from creatures and make it really tough for the players!

To adjust the server rates, stop the server and check the file <game server>/Data/ServerRates.config
Please read carefullyΓÇöall the rates are disabled and in order to apply them '''you need to remove the # char at the start of the line'''!

If you want to '''enable PvP''', search PvP in the file. By default, this setting's value is 0 and you need to change it to 1 and remove the # char at the start of the line.

For advanced modding please read [http://forums.atomictorch.com/index.php?topic=1027.0 modding prerequisites].

== Server raiding hours (for PvP) ==
'''(Please note: with A27 this feature is not recommend anymore as there is a better feature now ΓÇö S.H.I.E.L.D. protection that is enabled by default for PvP servers)'''

On PvP server, you could set up specific hours during which the raiding is possible.
 By default, offline raiding protection is not enabled so players could raid other players' bases at any time.
 To enable offline raiding protection, please use this in-game console command:
 <code>/admin.setRaidingWindow 4 14 1.5</code>
 In this code we're using (first number) +4 GMT/UTC timezone, (second number) hour of day when raiding is possible (value from 0 to 24), and (third number) is the duration of the raiding window (value from 0 to 24).
 So the code in the example will allow raiding from 14:00 (or 2PM) for 1.5 hours.
 After changing the value you could open Politics/Diplomacy menu ([P] key) and verify whether you set the correct numbers.
 Please note that Politics/Diplomacy menu displaying your local time (in your PC timezone)!

== How to prohibit client modifications ==
If you wish to restrict usage of any client modifications on your server, please find "<no_client_mods>" setting in the SettingsServer.xml file. Change the value from 0 to 1 to enable this feature. It's recommended for PvP servers to set it to 1. You can read more details about this feature in [https://atomictorch.com/Post/Id2218/A28-Justice-Update-Release A28 Update announcement].

CryoFall/Server/Setup

2022-02-18T12:54:08Z

Ai enabled: /* Software (system) requirements */

= Local server / Singleplayer =
Starting with R31 "Singleplayer Update" the local server is seamlessly integrated into the game client. Other players can also connect to you over LAN (new tab in Multiplayer menu) and even over the internet with virtual LAN (with software such as Hamachi).

= Using game server hosting providers =

==== Game server rent service ====
''If you don't want to hassle with the game server setup, you can rent your own CryoFall server from any third party game server hosting company in just a few minutes. They provide data center locations in almost every country around the world!''
* [https://pingperfect.com/gameservers/cryofall-game-server-hosting-rental.php?aff=586 PingPerfect]
* [https://gameserver.4players.de/server-hosting/cryofall-server-mieten/ 4PLAYERS] (the website is available in German only)
''Please note that AtomicTorch Studio is not affiliated with any of these companies and not responsible for their service quality so in case of any issues please reach them directly. So far we've heard only positive feedback about their services.''

= Self-hosting =

== Requirements ==
====Hardware requirements====
(for up to about 30 players online) 1-core CPU 1.6-2 GHz, 1.5 GB RAM, 2-3 Mbit/s bandwidth (each way)
 (for up to about 100 players online) 2-core CPU 1.6-2 GHz, 2 GB RAM, 3-6 Mbit/s bandwidth
 (for up to about 200 players online) 2-core CPU 2.4-3 GHz, 2 GB RAM, 6-12 Mbit/s bandwidth
 (for up to about 300 players online) 2-core CPU 3+ GHz, 2.5 GB RAM, 12-20 Mbit/s bandwidth
 Usually, VPS (virtual machines) hosting such as [https://www.vultr.com/?ref=7238385 Vultr.com] (this is our referral link as we're using this company services to host our own servers) is sufficient for hosting a game server. Using 1-core machines is not recommended as the game requires a secondary CPU to ensure smooth performance without hiccups during intensive background operations (such as world snapshot saving). Using more than a 2-core machine for a single game server hosting is redundant as the game cannot utilize more than two cores due to the sequential execution of the game simulation (except networking).

====Software (system) requirements====
The server could run on Windows, Linux, and Mac.
To achieve this the game server is using .NET Runtime 6.0.
For hosting the official game servers we prefer using CentOS 7 with Docker or CentOS 8 with podman (OSS alternative to Docker).

== Server installation with Docker (best way for Linux) ==
We recommend this for Linux only. Please follow this guide [https://hub.docker.com/r/atomictorch/cryofall-server CryoFall Dedicated Server Docker Image] then return back here to '''"Server installation"''' section and follow the list after number 7. Ignore instructions on how to start the server with "dotnet" as you should use "docker run ..." instead as explained in the Docker guide above.

== Server installation / direct download (Windows, Linux, Mac) ==

==== How to setup your own server (on any OS): ====
# Download and '''install''' .NET Runtime 6.0 x64ΓÇöplease visit [https://dotnet.microsoft.com/download/dotnet/6.0/runtime Download .NET page] and follow the installation guide for your OS (for Windows you need to download x64 version from the "Run console apps" section).
# Download the game server package. There are several ways to do this:
## You can download it directly from our website:
### '''[https://atomictorch.com/Files/CryoFall_Server_v1.33.1.8.zip SERVER DOWNLOAD LINK (any OS)]'''
### Extract the downloaded package (it's a regular ZIP archive).
## Alternatively, you can download it from '''Steam Client''': ''(preferable, as this way you can easily download updates)''
### Launch Steam Client
### Select LIBRARY tab
### Click on "ALL" and toggle "Tools"
### Search for "CryoFall Dedicated Server" and install it
## Alternatively, you can download it with '''SteamCMD''' (if you're familiar with it):
### launch SteamCMD
### enter:
###: <code>
###: login anonymous
###: app_update 1061710
###: </code>
### navigate to the installation folder (usually in steamapps/Common/CryoFall Dedicated Server)
# The server executable is located in the subfolder: "Binaries/Server". Open the command line/terminal/SSH (or PowerShell in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable first time with <code>loadOrNew</code> flag. The server will start and create the game world.
#:<code>dotnet CryoFall_Server.dll loadOrNew</code>
# Usually it takes about 1-2 minutes to create a new world (or load a savegame). After that the server will keep writing performance statistics information every 20 seconds among other information such as the spawn scripts reporting and network events.
# Stop the server. To do so enter the command below and press Enter key.
#:<code>stop 0</code>
#The server will save and quit. Now you have the "SettingsServer.xml" and "ModsConfig.xml" files.
# Now you need to navigate to the subfolder "Data" (in the root of the server folder, '''not''' in the "Binaries/Server") and modify "SettingsServer.xml" to set the unique server '''name''' and set other settings, etc (there are XML comments explaining every setting so it should be straightforward). ''Please note that you can (and should) edit '''Description''' and '''Welcome message''' from the '''CURRENT GAME''' menu right from the game after connecting to your server.''
# If you are interested in making your server visible in the community servers list make sure to edit <is_public_server> and change the value from 0 to 1. Also, please make sure your router is configured correctly (port forwarding) to enable other people to connect to your machine from outside. But ideally, you should use dedicated server hardware (VPS or VDS) to host public servers.
# While you're still editing "SettingsServer.xml" file, please find the value '''<server_operators_list>''' and change it to include '''your nickname'''! Otherwise, you will be unable to access your server console from the game and also you will be unable to edit the server's Description and Welcome message.
# If you want to have a custom server icon, please replace the ServerIcon.png file in the "Data" subfolder. The icon image file requirements: '''PNG24 format, 256x256 size, up to 100 KB'''.

'''Important (for Windows only):''' you need to allow the dotnet process in the Windows Firewall settingsΓÇöif the Firewall access request was not shown automatically by Windows you can add the <code>C:\Program Files\dotnet\dotnet.exe</code> file into Firewall whitelist. To do this, open Windows Start menu and search for "Allow an app through Windows Firewall" -> button "Allow another app".

==== Starting the server ====
# Launch the command line (we recommending '''PowerShell''' in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable with <code>load</code> flag.
#:<code>dotnet CryoFall_Server.dll load</code>
# Stop your server by typing command below and pressing Enter key (it will save the world before stopping).
#:<code>stop 60 The shutdown message text goes here</code>
(Where <code>60</code> is the shutdown delay (in seconds) so the connected players will have some time to find a safe location)

'''''Please note that typing this message is really hard as the console is updating regularly! The best way is to simply copy-paste from the text editor the whole command text into the game console window (hint: you can paste in PowerShell by simply pressing the right mouse button) and pressing Enter key.'''''

You can always wipe the world by launching the game with <code>new</code> flag:
:<code>dotnet CryoFall_Server.dll new</code>

Currently, we don't support the savegame migration between the major game versions (if there are changes to the game data serialization scheme). We plan to implement the proper data migration feature ASAP.

==== Connecting to the server ====
If you want to connect to your local game server, simply add SERVERS->Custom list as <code>localhost</code>

To connect to the public server you need to navigate to SERVERS->Community servers list (please note that this might not work if you host this server on the same PC as the client, read below).

If you're attempting to host your server on a home computer and other players cannot connect to it, you need to manually forward the port '''UDP 6000''' on your home router to '''your local IP address''' (the game has the auto port forwarding feature but it often fails due to the difference in UPnP implementation on many routers). E.g. if your PC's IP address in local network is 192.168.1.100 (you can check it with ipconfig tool or in Windows network adapter's settings) you will need to setup a port forward rule on your router to forward traffic from port 6000 UDP to port 6000 UDP on IP address 192.168.1.100.

'''If you're running a game server on the same PC as the game client:'''
 Please note that you might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its address as <code>localhost:6000</code> and connect to it directly.

'''If you're running a game server in the same local network as the game client (for example you want to play over LAN with your friends and family):'''
 You might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its local IP address (IPv4) and connect to it directly. To get your local IP address please use ipconfig command-line tool or check the network adapter properties in the network center. You need to get the local network IP address of the PC that is hosting the game server. Then add it in the custom servers list on your PC. You can lookup the IP address in the Windows network settings or by using CMD tool called ipconfig in Windows. For example, here we've run the ipconfig tool here and see the IPv4 address as 192.168.1.200 ([https://cdn.discordapp.com/attachments/421250395298332672/739147674367950908/Screenshot_at_19-48-06.png screenshot]). We can use it on any other PC in the local network to connect to that PC hosting the game server.

Connecting to the private servers requires adding it via the Custom servers menu.

6000 is the default port but you can change it in the Data/SettingsServer.xml file.

== Server update/upgrade to new version ==
When we're releasing a new version of the game server, you need to follow these steps to update it:
# (If you have not done this) Install ".NET Runtime" (version 5.0) https://dotnet.microsoft.com/download/dotnet/5.0/runtime
# Ensure you've made a '''backup''' of the "'''Data'''" folder inside the game server installation folder.
# If you're updating from A28 or earlier versions (ONLY), delete "Data/Saves" folder as the savegame is not compatible (breaking changes). Update from A29 to R30/R31/R32 (or to any patch versions) '''doesn't require this step''' (savegame is compatible).
# Download the new version of the server and overwrite your current installation with it (you can find the actual download link above in the "Installation" section).
# Stop the game server (if it's running).
# Important: please '''overwrite''' both Binaries and Core folders!
# Start the server as usual.

== Server commands ==
# Ensure you're the server operator (you've edited the ServerSettings.xml file and added yourself into the server_operators_list).
# Connect to your game server.
# The game console can be toggled by pressing <code>~</code> (the key on the left from <code>1</code> key) like in old-school games (you can change the key binding for console in the controls options).
# Please add <code>/</code> (slash) prefix to the server commands you want to execute.
# You can use '''Tab''' key to fill autocomplete, and you can use '''arrow Up/Down keys''' to navigate the suggestions list. Press '''Tab''' or '''Enter''' to accept the suggestion.

Here is the page with the server commands list: [[CryoFall/Server/Commands|Server Commands List]]

== Moderation (whitelist, blacklist, kicking, muting) ==
Server operator can access special moderation commands. To invoke these commands, please ensure you're the server operator, connect to your game server, open the console (~ key) and then you can use these commands: (replace username with the actual player nickname)

Whitelist management:

<code>/mod.whiteList.add username</code>

<code>/mod.whiteList.remove username</code>

<code>/mod.whiteList.print</code>

To enable whitelist:

<code>/mod.whiteList.enabled 1</code>

Blacklist management:

<code>/mod.blackList.add username</code>

<code>/mod.blackList.remove username</code>

<code>/mod.blackList.print</code>

Kicking players (temporary removing from server and blocking from connecting):

<code>/mod.kickList.add username durationInMinutes</code>

<code>/mod.kickList.remove username</code>

<code>/mod.kickList.print</code>

Muting players (temporary removing their ability to send messages to chat):

<code>/mod.muteList.add username durationInMinutes</code>

<code>/mod.muteList.remove username</code>

<code>/mod.muteList.print</code>

== Server rates adjusting / Enabling PvP mode ==
Server rates (and PvP mode setting) are exposed in a separate config file. You can quickly change things like LP gain rate, increase item drops, reduce the player to player damage to zero, or even increase the damage from creatures and make it really tough for the players!

To adjust the server rates, stop the server and check the file <game server>/Data/ServerRates.config
Please read carefullyΓÇöall the rates are disabled and in order to apply them '''you need to remove the # char at the start of the line'''!

If you want to '''enable PvP''', search PvP in the file. By default, this setting's value is 0 and you need to change it to 1 and remove the # char at the start of the line.

For advanced modding please read [http://forums.atomictorch.com/index.php?topic=1027.0 modding prerequisites].

== Server raiding hours (for PvP) ==
'''(Please note: with A27 this feature is not recommend anymore as there is a better feature now ΓÇö S.H.I.E.L.D. protection that is enabled by default for PvP servers)'''

On PvP server, you could set up specific hours during which the raiding is possible.
 By default, offline raiding protection is not enabled so players could raid other players' bases at any time.
 To enable offline raiding protection, please use this in-game console command:
 <code>/admin.setRaidingWindow 4 14 1.5</code>
 In this code we're using (first number) +4 GMT/UTC timezone, (second number) hour of day when raiding is possible (value from 0 to 24), and (third number) is the duration of the raiding window (value from 0 to 24).
 So the code in the example will allow raiding from 14:00 (or 2PM) for 1.5 hours.
 After changing the value you could open Politics/Diplomacy menu ([P] key) and verify whether you set the correct numbers.
 Please note that Politics/Diplomacy menu displaying your local time (in your PC timezone)!

== How to prohibit client modifications ==
If you wish to restrict usage of any client modifications on your server, please find "<no_client_mods>" setting in the SettingsServer.xml file. Change the value from 0 to 1 to enable this feature. It's recommended for PvP servers to set it to 1. You can read more details about this feature in [https://atomictorch.com/Post/Id2218/A28-Justice-Update-Release A28 Update announcement].

CryoFall/Server/Setup

2022-02-18T12:54:01Z

Ai enabled: /* How to setup your own server (on any OS): */

= Local server / Singleplayer =
Starting with R31 "Singleplayer Update" the local server is seamlessly integrated into the game client. Other players can also connect to you over LAN (new tab in Multiplayer menu) and even over the internet with virtual LAN (with software such as Hamachi).

= Using game server hosting providers =

==== Game server rent service ====
''If you don't want to hassle with the game server setup, you can rent your own CryoFall server from any third party game server hosting company in just a few minutes. They provide data center locations in almost every country around the world!''
* [https://pingperfect.com/gameservers/cryofall-game-server-hosting-rental.php?aff=586 PingPerfect]
* [https://gameserver.4players.de/server-hosting/cryofall-server-mieten/ 4PLAYERS] (the website is available in German only)
''Please note that AtomicTorch Studio is not affiliated with any of these companies and not responsible for their service quality so in case of any issues please reach them directly. So far we've heard only positive feedback about their services.''

= Self-hosting =

== Requirements ==
====Hardware requirements====
(for up to about 30 players online) 1-core CPU 1.6-2 GHz, 1.5 GB RAM, 2-3 Mbit/s bandwidth (each way)
 (for up to about 100 players online) 2-core CPU 1.6-2 GHz, 2 GB RAM, 3-6 Mbit/s bandwidth
 (for up to about 200 players online) 2-core CPU 2.4-3 GHz, 2 GB RAM, 6-12 Mbit/s bandwidth
 (for up to about 300 players online) 2-core CPU 3+ GHz, 2.5 GB RAM, 12-20 Mbit/s bandwidth
 Usually, VPS (virtual machines) hosting such as [https://www.vultr.com/?ref=7238385 Vultr.com] (this is our referral link as we're using this company services to host our own servers) is sufficient for hosting a game server. Using 1-core machines is not recommended as the game requires a secondary CPU to ensure smooth performance without hiccups during intensive background operations (such as world snapshot saving). Using more than a 2-core machine for a single game server hosting is redundant as the game cannot utilize more than two cores due to the sequential execution of the game simulation (except networking).

====Software (system) requirements====
The server could run on Windows, Linux, and Mac.
To achieve this the game server is using .NET Runtime 5.0.
For hosting the official game servers we prefer using CentOS 7 with Docker or CentOS 8 with podman (OSS alternative to Docker).

== Server installation with Docker (best way for Linux) ==
We recommend this for Linux only. Please follow this guide [https://hub.docker.com/r/atomictorch/cryofall-server CryoFall Dedicated Server Docker Image] then return back here to '''"Server installation"''' section and follow the list after number 7. Ignore instructions on how to start the server with "dotnet" as you should use "docker run ..." instead as explained in the Docker guide above.

== Server installation / direct download (Windows, Linux, Mac) ==

==== How to setup your own server (on any OS): ====
# Download and '''install''' .NET Runtime 6.0 x64ΓÇöplease visit [https://dotnet.microsoft.com/download/dotnet/6.0/runtime Download .NET page] and follow the installation guide for your OS (for Windows you need to download x64 version from the "Run console apps" section).
# Download the game server package. There are several ways to do this:
## You can download it directly from our website:
### '''[https://atomictorch.com/Files/CryoFall_Server_v1.33.1.8.zip SERVER DOWNLOAD LINK (any OS)]'''
### Extract the downloaded package (it's a regular ZIP archive).
## Alternatively, you can download it from '''Steam Client''': ''(preferable, as this way you can easily download updates)''
### Launch Steam Client
### Select LIBRARY tab
### Click on "ALL" and toggle "Tools"
### Search for "CryoFall Dedicated Server" and install it
## Alternatively, you can download it with '''SteamCMD''' (if you're familiar with it):
### launch SteamCMD
### enter:
###: <code>
###: login anonymous
###: app_update 1061710
###: </code>
### navigate to the installation folder (usually in steamapps/Common/CryoFall Dedicated Server)
# The server executable is located in the subfolder: "Binaries/Server". Open the command line/terminal/SSH (or PowerShell in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable first time with <code>loadOrNew</code> flag. The server will start and create the game world.
#:<code>dotnet CryoFall_Server.dll loadOrNew</code>
# Usually it takes about 1-2 minutes to create a new world (or load a savegame). After that the server will keep writing performance statistics information every 20 seconds among other information such as the spawn scripts reporting and network events.
# Stop the server. To do so enter the command below and press Enter key.
#:<code>stop 0</code>
#The server will save and quit. Now you have the "SettingsServer.xml" and "ModsConfig.xml" files.
# Now you need to navigate to the subfolder "Data" (in the root of the server folder, '''not''' in the "Binaries/Server") and modify "SettingsServer.xml" to set the unique server '''name''' and set other settings, etc (there are XML comments explaining every setting so it should be straightforward). ''Please note that you can (and should) edit '''Description''' and '''Welcome message''' from the '''CURRENT GAME''' menu right from the game after connecting to your server.''
# If you are interested in making your server visible in the community servers list make sure to edit <is_public_server> and change the value from 0 to 1. Also, please make sure your router is configured correctly (port forwarding) to enable other people to connect to your machine from outside. But ideally, you should use dedicated server hardware (VPS or VDS) to host public servers.
# While you're still editing "SettingsServer.xml" file, please find the value '''<server_operators_list>''' and change it to include '''your nickname'''! Otherwise, you will be unable to access your server console from the game and also you will be unable to edit the server's Description and Welcome message.
# If you want to have a custom server icon, please replace the ServerIcon.png file in the "Data" subfolder. The icon image file requirements: '''PNG24 format, 256x256 size, up to 100 KB'''.

'''Important (for Windows only):''' you need to allow the dotnet process in the Windows Firewall settingsΓÇöif the Firewall access request was not shown automatically by Windows you can add the <code>C:\Program Files\dotnet\dotnet.exe</code> file into Firewall whitelist. To do this, open Windows Start menu and search for "Allow an app through Windows Firewall" -> button "Allow another app".

==== Starting the server ====
# Launch the command line (we recommending '''PowerShell''' in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable with <code>load</code> flag.
#:<code>dotnet CryoFall_Server.dll load</code>
# Stop your server by typing command below and pressing Enter key (it will save the world before stopping).
#:<code>stop 60 The shutdown message text goes here</code>
(Where <code>60</code> is the shutdown delay (in seconds) so the connected players will have some time to find a safe location)

'''''Please note that typing this message is really hard as the console is updating regularly! The best way is to simply copy-paste from the text editor the whole command text into the game console window (hint: you can paste in PowerShell by simply pressing the right mouse button) and pressing Enter key.'''''

You can always wipe the world by launching the game with <code>new</code> flag:
:<code>dotnet CryoFall_Server.dll new</code>

Currently, we don't support the savegame migration between the major game versions (if there are changes to the game data serialization scheme). We plan to implement the proper data migration feature ASAP.

==== Connecting to the server ====
If you want to connect to your local game server, simply add SERVERS->Custom list as <code>localhost</code>

To connect to the public server you need to navigate to SERVERS->Community servers list (please note that this might not work if you host this server on the same PC as the client, read below).

If you're attempting to host your server on a home computer and other players cannot connect to it, you need to manually forward the port '''UDP 6000''' on your home router to '''your local IP address''' (the game has the auto port forwarding feature but it often fails due to the difference in UPnP implementation on many routers). E.g. if your PC's IP address in local network is 192.168.1.100 (you can check it with ipconfig tool or in Windows network adapter's settings) you will need to setup a port forward rule on your router to forward traffic from port 6000 UDP to port 6000 UDP on IP address 192.168.1.100.

'''If you're running a game server on the same PC as the game client:'''
 Please note that you might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its address as <code>localhost:6000</code> and connect to it directly.

'''If you're running a game server in the same local network as the game client (for example you want to play over LAN with your friends and family):'''
 You might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its local IP address (IPv4) and connect to it directly. To get your local IP address please use ipconfig command-line tool or check the network adapter properties in the network center. You need to get the local network IP address of the PC that is hosting the game server. Then add it in the custom servers list on your PC. You can lookup the IP address in the Windows network settings or by using CMD tool called ipconfig in Windows. For example, here we've run the ipconfig tool here and see the IPv4 address as 192.168.1.200 ([https://cdn.discordapp.com/attachments/421250395298332672/739147674367950908/Screenshot_at_19-48-06.png screenshot]). We can use it on any other PC in the local network to connect to that PC hosting the game server.

Connecting to the private servers requires adding it via the Custom servers menu.

6000 is the default port but you can change it in the Data/SettingsServer.xml file.

== Server update/upgrade to new version ==
When we're releasing a new version of the game server, you need to follow these steps to update it:
# (If you have not done this) Install ".NET Runtime" (version 5.0) https://dotnet.microsoft.com/download/dotnet/5.0/runtime
# Ensure you've made a '''backup''' of the "'''Data'''" folder inside the game server installation folder.
# If you're updating from A28 or earlier versions (ONLY), delete "Data/Saves" folder as the savegame is not compatible (breaking changes). Update from A29 to R30/R31/R32 (or to any patch versions) '''doesn't require this step''' (savegame is compatible).
# Download the new version of the server and overwrite your current installation with it (you can find the actual download link above in the "Installation" section).
# Stop the game server (if it's running).
# Important: please '''overwrite''' both Binaries and Core folders!
# Start the server as usual.

== Server commands ==
# Ensure you're the server operator (you've edited the ServerSettings.xml file and added yourself into the server_operators_list).
# Connect to your game server.
# The game console can be toggled by pressing <code>~</code> (the key on the left from <code>1</code> key) like in old-school games (you can change the key binding for console in the controls options).
# Please add <code>/</code> (slash) prefix to the server commands you want to execute.
# You can use '''Tab''' key to fill autocomplete, and you can use '''arrow Up/Down keys''' to navigate the suggestions list. Press '''Tab''' or '''Enter''' to accept the suggestion.

Here is the page with the server commands list: [[CryoFall/Server/Commands|Server Commands List]]

== Moderation (whitelist, blacklist, kicking, muting) ==
Server operator can access special moderation commands. To invoke these commands, please ensure you're the server operator, connect to your game server, open the console (~ key) and then you can use these commands: (replace username with the actual player nickname)

Whitelist management:

<code>/mod.whiteList.add username</code>

<code>/mod.whiteList.remove username</code>

<code>/mod.whiteList.print</code>

To enable whitelist:

<code>/mod.whiteList.enabled 1</code>

Blacklist management:

<code>/mod.blackList.add username</code>

<code>/mod.blackList.remove username</code>

<code>/mod.blackList.print</code>

Kicking players (temporary removing from server and blocking from connecting):

<code>/mod.kickList.add username durationInMinutes</code>

<code>/mod.kickList.remove username</code>

<code>/mod.kickList.print</code>

Muting players (temporary removing their ability to send messages to chat):

<code>/mod.muteList.add username durationInMinutes</code>

<code>/mod.muteList.remove username</code>

<code>/mod.muteList.print</code>

== Server rates adjusting / Enabling PvP mode ==
Server rates (and PvP mode setting) are exposed in a separate config file. You can quickly change things like LP gain rate, increase item drops, reduce the player to player damage to zero, or even increase the damage from creatures and make it really tough for the players!

To adjust the server rates, stop the server and check the file <game server>/Data/ServerRates.config
Please read carefullyΓÇöall the rates are disabled and in order to apply them '''you need to remove the # char at the start of the line'''!

If you want to '''enable PvP''', search PvP in the file. By default, this setting's value is 0 and you need to change it to 1 and remove the # char at the start of the line.

For advanced modding please read [http://forums.atomictorch.com/index.php?topic=1027.0 modding prerequisites].

== Server raiding hours (for PvP) ==
'''(Please note: with A27 this feature is not recommend anymore as there is a better feature now ΓÇö S.H.I.E.L.D. protection that is enabled by default for PvP servers)'''

On PvP server, you could set up specific hours during which the raiding is possible.
 By default, offline raiding protection is not enabled so players could raid other players' bases at any time.
 To enable offline raiding protection, please use this in-game console command:
 <code>/admin.setRaidingWindow 4 14 1.5</code>
 In this code we're using (first number) +4 GMT/UTC timezone, (second number) hour of day when raiding is possible (value from 0 to 24), and (third number) is the duration of the raiding window (value from 0 to 24).
 So the code in the example will allow raiding from 14:00 (or 2PM) for 1.5 hours.
 After changing the value you could open Politics/Diplomacy menu ([P] key) and verify whether you set the correct numbers.
 Please note that Politics/Diplomacy menu displaying your local time (in your PC timezone)!

== How to prohibit client modifications ==
If you wish to restrict usage of any client modifications on your server, please find "<no_client_mods>" setting in the SettingsServer.xml file. Change the value from 0 to 1 to enable this feature. It's recommended for PvP servers to set it to 1. You can read more details about this feature in [https://atomictorch.com/Post/Id2218/A28-Justice-Update-Release A28 Update announcement].

CryoFall/Server/Setup

2022-02-18T12:53:46Z

Ai enabled: /* How to setup your own server (on any OS): */

= Local server / Singleplayer =
Starting with R31 "Singleplayer Update" the local server is seamlessly integrated into the game client. Other players can also connect to you over LAN (new tab in Multiplayer menu) and even over the internet with virtual LAN (with software such as Hamachi).

= Using game server hosting providers =

==== Game server rent service ====
''If you don't want to hassle with the game server setup, you can rent your own CryoFall server from any third party game server hosting company in just a few minutes. They provide data center locations in almost every country around the world!''
* [https://pingperfect.com/gameservers/cryofall-game-server-hosting-rental.php?aff=586 PingPerfect]
* [https://gameserver.4players.de/server-hosting/cryofall-server-mieten/ 4PLAYERS] (the website is available in German only)
''Please note that AtomicTorch Studio is not affiliated with any of these companies and not responsible for their service quality so in case of any issues please reach them directly. So far we've heard only positive feedback about their services.''

= Self-hosting =

== Requirements ==
====Hardware requirements====
(for up to about 30 players online) 1-core CPU 1.6-2 GHz, 1.5 GB RAM, 2-3 Mbit/s bandwidth (each way)
 (for up to about 100 players online) 2-core CPU 1.6-2 GHz, 2 GB RAM, 3-6 Mbit/s bandwidth
 (for up to about 200 players online) 2-core CPU 2.4-3 GHz, 2 GB RAM, 6-12 Mbit/s bandwidth
 (for up to about 300 players online) 2-core CPU 3+ GHz, 2.5 GB RAM, 12-20 Mbit/s bandwidth
 Usually, VPS (virtual machines) hosting such as [https://www.vultr.com/?ref=7238385 Vultr.com] (this is our referral link as we're using this company services to host our own servers) is sufficient for hosting a game server. Using 1-core machines is not recommended as the game requires a secondary CPU to ensure smooth performance without hiccups during intensive background operations (such as world snapshot saving). Using more than a 2-core machine for a single game server hosting is redundant as the game cannot utilize more than two cores due to the sequential execution of the game simulation (except networking).

====Software (system) requirements====
The server could run on Windows, Linux, and Mac.
To achieve this the game server is using .NET Runtime 5.0.
For hosting the official game servers we prefer using CentOS 7 with Docker or CentOS 8 with podman (OSS alternative to Docker).

== Server installation with Docker (best way for Linux) ==
We recommend this for Linux only. Please follow this guide [https://hub.docker.com/r/atomictorch/cryofall-server CryoFall Dedicated Server Docker Image] then return back here to '''"Server installation"''' section and follow the list after number 7. Ignore instructions on how to start the server with "dotnet" as you should use "docker run ..." instead as explained in the Docker guide above.

== Server installation / direct download (Windows, Linux, Mac) ==

==== How to setup your own server (on any OS): ====
# Download and '''install''' .NET Runtime 5.0 x64ΓÇöplease visit [https://dotnet.microsoft.com/download/dotnet/5.0/runtime Download .NET page] and follow the installation guide for your OS (for Windows you need to download x64 version from the "Run console apps" section).
# Download the game server package. There are several ways to do this:
## You can download it directly from our website:
### '''[https://atomictorch.com/Files/CryoFall_Server_v1.33.1.8.zip SERVER DOWNLOAD LINK (any OS)]'''
### Extract the downloaded package (it's a regular ZIP archive).
## Alternatively, you can download it from '''Steam Client''': ''(preferable, as this way you can easily download updates)''
### Launch Steam Client
### Select LIBRARY tab
### Click on "ALL" and toggle "Tools"
### Search for "CryoFall Dedicated Server" and install it
## Alternatively, you can download it with '''SteamCMD''' (if you're familiar with it):
### launch SteamCMD
### enter:
###: <code>
###: login anonymous
###: app_update 1061710
###: </code>
### navigate to the installation folder (usually in steamapps/Common/CryoFall Dedicated Server)
# The server executable is located in the subfolder: "Binaries/Server". Open the command line/terminal/SSH (or PowerShell in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable first time with <code>loadOrNew</code> flag. The server will start and create the game world.
#:<code>dotnet CryoFall_Server.dll loadOrNew</code>
# Usually it takes about 1-2 minutes to create a new world (or load a savegame). After that the server will keep writing performance statistics information every 20 seconds among other information such as the spawn scripts reporting and network events.
# Stop the server. To do so enter the command below and press Enter key.
#:<code>stop 0</code>
#The server will save and quit. Now you have the "SettingsServer.xml" and "ModsConfig.xml" files.
# Now you need to navigate to the subfolder "Data" (in the root of the server folder, '''not''' in the "Binaries/Server") and modify "SettingsServer.xml" to set the unique server '''name''' and set other settings, etc (there are XML comments explaining every setting so it should be straightforward). ''Please note that you can (and should) edit '''Description''' and '''Welcome message''' from the '''CURRENT GAME''' menu right from the game after connecting to your server.''
# If you are interested in making your server visible in the community servers list make sure to edit <is_public_server> and change the value from 0 to 1. Also, please make sure your router is configured correctly (port forwarding) to enable other people to connect to your machine from outside. But ideally, you should use dedicated server hardware (VPS or VDS) to host public servers.
# While you're still editing "SettingsServer.xml" file, please find the value '''<server_operators_list>''' and change it to include '''your nickname'''! Otherwise, you will be unable to access your server console from the game and also you will be unable to edit the server's Description and Welcome message.
# If you want to have a custom server icon, please replace the ServerIcon.png file in the "Data" subfolder. The icon image file requirements: '''PNG24 format, 256x256 size, up to 100 KB'''.

'''Important (for Windows only):''' you need to allow the dotnet process in the Windows Firewall settingsΓÇöif the Firewall access request was not shown automatically by Windows you can add the <code>C:\Program Files\dotnet\dotnet.exe</code> file into Firewall whitelist. To do this, open Windows Start menu and search for "Allow an app through Windows Firewall" -> button "Allow another app".

==== Starting the server ====
# Launch the command line (we recommending '''PowerShell''' in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable with <code>load</code> flag.
#:<code>dotnet CryoFall_Server.dll load</code>
# Stop your server by typing command below and pressing Enter key (it will save the world before stopping).
#:<code>stop 60 The shutdown message text goes here</code>
(Where <code>60</code> is the shutdown delay (in seconds) so the connected players will have some time to find a safe location)

'''''Please note that typing this message is really hard as the console is updating regularly! The best way is to simply copy-paste from the text editor the whole command text into the game console window (hint: you can paste in PowerShell by simply pressing the right mouse button) and pressing Enter key.'''''

You can always wipe the world by launching the game with <code>new</code> flag:
:<code>dotnet CryoFall_Server.dll new</code>

Currently, we don't support the savegame migration between the major game versions (if there are changes to the game data serialization scheme). We plan to implement the proper data migration feature ASAP.

==== Connecting to the server ====
If you want to connect to your local game server, simply add SERVERS->Custom list as <code>localhost</code>

To connect to the public server you need to navigate to SERVERS->Community servers list (please note that this might not work if you host this server on the same PC as the client, read below).

If you're attempting to host your server on a home computer and other players cannot connect to it, you need to manually forward the port '''UDP 6000''' on your home router to '''your local IP address''' (the game has the auto port forwarding feature but it often fails due to the difference in UPnP implementation on many routers). E.g. if your PC's IP address in local network is 192.168.1.100 (you can check it with ipconfig tool or in Windows network adapter's settings) you will need to setup a port forward rule on your router to forward traffic from port 6000 UDP to port 6000 UDP on IP address 192.168.1.100.

'''If you're running a game server on the same PC as the game client:'''
 Please note that you might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its address as <code>localhost:6000</code> and connect to it directly.

'''If you're running a game server in the same local network as the game client (for example you want to play over LAN with your friends and family):'''
 You might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its local IP address (IPv4) and connect to it directly. To get your local IP address please use ipconfig command-line tool or check the network adapter properties in the network center. You need to get the local network IP address of the PC that is hosting the game server. Then add it in the custom servers list on your PC. You can lookup the IP address in the Windows network settings or by using CMD tool called ipconfig in Windows. For example, here we've run the ipconfig tool here and see the IPv4 address as 192.168.1.200 ([https://cdn.discordapp.com/attachments/421250395298332672/739147674367950908/Screenshot_at_19-48-06.png screenshot]). We can use it on any other PC in the local network to connect to that PC hosting the game server.

Connecting to the private servers requires adding it via the Custom servers menu.

6000 is the default port but you can change it in the Data/SettingsServer.xml file.

== Server update/upgrade to new version ==
When we're releasing a new version of the game server, you need to follow these steps to update it:
# (If you have not done this) Install ".NET Runtime" (version 5.0) https://dotnet.microsoft.com/download/dotnet/5.0/runtime
# Ensure you've made a '''backup''' of the "'''Data'''" folder inside the game server installation folder.
# If you're updating from A28 or earlier versions (ONLY), delete "Data/Saves" folder as the savegame is not compatible (breaking changes). Update from A29 to R30/R31/R32 (or to any patch versions) '''doesn't require this step''' (savegame is compatible).
# Download the new version of the server and overwrite your current installation with it (you can find the actual download link above in the "Installation" section).
# Stop the game server (if it's running).
# Important: please '''overwrite''' both Binaries and Core folders!
# Start the server as usual.

== Server commands ==
# Ensure you're the server operator (you've edited the ServerSettings.xml file and added yourself into the server_operators_list).
# Connect to your game server.
# The game console can be toggled by pressing <code>~</code> (the key on the left from <code>1</code> key) like in old-school games (you can change the key binding for console in the controls options).
# Please add <code>/</code> (slash) prefix to the server commands you want to execute.
# You can use '''Tab''' key to fill autocomplete, and you can use '''arrow Up/Down keys''' to navigate the suggestions list. Press '''Tab''' or '''Enter''' to accept the suggestion.

Here is the page with the server commands list: [[CryoFall/Server/Commands|Server Commands List]]

== Moderation (whitelist, blacklist, kicking, muting) ==
Server operator can access special moderation commands. To invoke these commands, please ensure you're the server operator, connect to your game server, open the console (~ key) and then you can use these commands: (replace username with the actual player nickname)

Whitelist management:

<code>/mod.whiteList.add username</code>

<code>/mod.whiteList.remove username</code>

<code>/mod.whiteList.print</code>

To enable whitelist:

<code>/mod.whiteList.enabled 1</code>

Blacklist management:

<code>/mod.blackList.add username</code>

<code>/mod.blackList.remove username</code>

<code>/mod.blackList.print</code>

Kicking players (temporary removing from server and blocking from connecting):

<code>/mod.kickList.add username durationInMinutes</code>

<code>/mod.kickList.remove username</code>

<code>/mod.kickList.print</code>

Muting players (temporary removing their ability to send messages to chat):

<code>/mod.muteList.add username durationInMinutes</code>

<code>/mod.muteList.remove username</code>

<code>/mod.muteList.print</code>

== Server rates adjusting / Enabling PvP mode ==
Server rates (and PvP mode setting) are exposed in a separate config file. You can quickly change things like LP gain rate, increase item drops, reduce the player to player damage to zero, or even increase the damage from creatures and make it really tough for the players!

To adjust the server rates, stop the server and check the file <game server>/Data/ServerRates.config
Please read carefullyΓÇöall the rates are disabled and in order to apply them '''you need to remove the # char at the start of the line'''!

If you want to '''enable PvP''', search PvP in the file. By default, this setting's value is 0 and you need to change it to 1 and remove the # char at the start of the line.

For advanced modding please read [http://forums.atomictorch.com/index.php?topic=1027.0 modding prerequisites].

== Server raiding hours (for PvP) ==
'''(Please note: with A27 this feature is not recommend anymore as there is a better feature now ΓÇö S.H.I.E.L.D. protection that is enabled by default for PvP servers)'''

On PvP server, you could set up specific hours during which the raiding is possible.
 By default, offline raiding protection is not enabled so players could raid other players' bases at any time.
 To enable offline raiding protection, please use this in-game console command:
 <code>/admin.setRaidingWindow 4 14 1.5</code>
 In this code we're using (first number) +4 GMT/UTC timezone, (second number) hour of day when raiding is possible (value from 0 to 24), and (third number) is the duration of the raiding window (value from 0 to 24).
 So the code in the example will allow raiding from 14:00 (or 2PM) for 1.5 hours.
 After changing the value you could open Politics/Diplomacy menu ([P] key) and verify whether you set the correct numbers.
 Please note that Politics/Diplomacy menu displaying your local time (in your PC timezone)!

== How to prohibit client modifications ==
If you wish to restrict usage of any client modifications on your server, please find "<no_client_mods>" setting in the SettingsServer.xml file. Change the value from 0 to 1 to enable this feature. It's recommended for PvP servers to set it to 1. You can read more details about this feature in [https://atomictorch.com/Post/Id2218/A28-Justice-Update-Release A28 Update announcement].

CryoFall/Server/Setup

2021-12-31T13:16:33Z

Ai enabled: /* Server update/upgrade to new version */

= Local server / Singleplayer =
Starting with R31 "Singleplayer Update" the local server is seamlessly integrated into the game client. Other players can also connect to you over LAN (new tab in Multiplayer menu) and even over the internet with virtual LAN (with software such as Hamachi).

= Using game server hosting providers =

==== Game server rent service ====
''If you don't want to hassle with the game server setup, you can rent your own CryoFall server from any third party game server hosting company in just a few minutes. They provide data center locations in almost every country around the world!''
* [https://pingperfect.com/gameservers/cryofall-game-server-hosting-rental.php?aff=586 PingPerfect]
* [https://gameserver.4players.de/server-hosting/cryofall-server-mieten/ 4PLAYERS] (the website is available in German only)
''Please note that AtomicTorch Studio is not affiliated with any of these companies and not responsible for their service quality so in case of any issues please reach them directly. So far we've heard only positive feedback about their services.''

= Self-hosting =

== Requirements ==
====Hardware requirements====
(for up to about 30 players online) 1-core CPU 1.6-2 GHz, 1.5 GB RAM, 2-3 Mbit/s bandwidth (each way)
 (for up to about 100 players online) 2-core CPU 1.6-2 GHz, 2 GB RAM, 3-6 Mbit/s bandwidth
 (for up to about 200 players online) 2-core CPU 2.4-3 GHz, 2 GB RAM, 6-12 Mbit/s bandwidth
 (for up to about 300 players online) 2-core CPU 3+ GHz, 2.5 GB RAM, 12-20 Mbit/s bandwidth
 Usually, VPS (virtual machines) hosting such as [https://www.vultr.com/?ref=7238385 Vultr.com] (this is our referral link as we're using this company services to host our own servers) is sufficient for hosting a game server. Using 1-core machines is not recommended as the game requires a secondary CPU to ensure smooth performance without hiccups during intensive background operations (such as world snapshot saving). Using more than a 2-core machine for a single game server hosting is redundant as the game cannot utilize more than two cores due to the sequential execution of the game simulation (except networking).

====Software (system) requirements====
The server could run on Windows, Linux, and Mac.
To achieve this the game server is using .NET Runtime 5.0.
For hosting the official game servers we prefer using CentOS 7 with Docker or CentOS 8 with podman (OSS alternative to Docker).

== Server installation with Docker (best way for Linux) ==
We recommend this for Linux only. Please follow this guide [https://hub.docker.com/r/atomictorch/cryofall-server CryoFall Dedicated Server Docker Image] then return back here to '''"Server installation"''' section and follow the list after number 7. Ignore instructions on how to start the server with "dotnet" as you should use "docker run ..." instead as explained in the Docker guide above.

== Server installation / direct download (Windows, Linux, Mac) ==

==== How to setup your own server (on any OS): ====
# Download and '''install''' .NET Runtime 5.0 x64ΓÇöplease visit [https://dotnet.microsoft.com/download/dotnet/5.0/runtime Download .NET page] and follow the installation guide for your OS (for Windows you need to download x64 version from the "Run console apps" section).
# Download the game server package. There are several ways to do this:
## You can download it directly from our website:
### '''[https://atomictorch.com/Files/CryoFall_Server_v1.32.2.1.zip SERVER DOWNLOAD LINK (any OS)]'''
### Extract the downloaded package (it's a regular ZIP archive).
## Alternatively, you can download it from '''Steam Client''': ''(preferable, as this way you can easily download updates)''
### Launch Steam Client
### Select LIBRARY tab
### Click on "ALL" and toggle "Tools"
### Search for "CryoFall Dedicated Server" and install it
## Alternatively, you can download it with '''SteamCMD''' (if you're familiar with it):
### launch SteamCMD
### enter:
###: <code>
###: login anonymous
###: app_update 1061710
###: </code>
### navigate to the installation folder (usually in steamapps/Common/CryoFall Dedicated Server)
# The server executable is located in the subfolder: "Binaries/Server". Open the command line/terminal/SSH (or PowerShell in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable first time with <code>loadOrNew</code> flag. The server will start and create the game world.
#:<code>dotnet CryoFall_Server.dll loadOrNew</code>
# Usually it takes about 1-2 minutes to create a new world (or load a savegame). After that the server will keep writing performance statistics information every 20 seconds among other information such as the spawn scripts reporting and network events.
# Stop the server. To do so enter the command below and press Enter key.
#:<code>stop 0</code>
#The server will save and quit. Now you have the "SettingsServer.xml" and "ModsConfig.xml" files.
# Now you need to navigate to the subfolder "Data" (in the root of the server folder, '''not''' in the "Binaries/Server") and modify "SettingsServer.xml" to set the unique server '''name''' and set other settings, etc (there are XML comments explaining every setting so it should be straightforward). ''Please note that you can (and should) edit '''Description''' and '''Welcome message''' from the '''CURRENT GAME''' menu right from the game after connecting to your server.''
# If you are interested in making your server visible in the community servers list make sure to edit <is_public_server> and change the value from 0 to 1. Also, please make sure your router is configured correctly (port forwarding) to enable other people to connect to your machine from outside. But ideally, you should use dedicated server hardware (VPS or VDS) to host public servers.
# While you're still editing "SettingsServer.xml" file, please find the value '''<server_operators_list>''' and change it to include '''your nickname'''! Otherwise, you will be unable to access your server console from the game and also you will be unable to edit the server's Description and Welcome message.
# If you want to have a custom server icon, please replace the ServerIcon.png file in the "Data" subfolder. The icon image file requirements: '''PNG24 format, 256x256 size, up to 100 KB'''.

'''Important (for Windows only):''' you need to allow the dotnet process in the Windows Firewall settingsΓÇöif the Firewall access request was not shown automatically by Windows you can add the <code>C:\Program Files\dotnet\dotnet.exe</code> file into Firewall whitelist. To do this, open Windows Start menu and search for "Allow an app through Windows Firewall" -> button "Allow another app".

==== Starting the server ====
# Launch the command line (we recommending '''PowerShell''' in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable with <code>load</code> flag.
#:<code>dotnet CryoFall_Server.dll load</code>
# Stop your server by typing command below and pressing Enter key (it will save the world before stopping).
#:<code>stop 60 The shutdown message text goes here</code>
(Where <code>60</code> is the shutdown delay (in seconds) so the connected players will have some time to find a safe location)

'''''Please note that typing this message is really hard as the console is updating regularly! The best way is to simply copy-paste from the text editor the whole command text into the game console window (hint: you can paste in PowerShell by simply pressing the right mouse button) and pressing Enter key.'''''

You can always wipe the world by launching the game with <code>new</code> flag:
:<code>dotnet CryoFall_Server.dll new</code>

Currently, we don't support the savegame migration between the major game versions (if there are changes to the game data serialization scheme). We plan to implement the proper data migration feature ASAP.

==== Connecting to the server ====
If you want to connect to your local game server, simply add SERVERS->Custom list as <code>localhost</code>

To connect to the public server you need to navigate to SERVERS->Community servers list (please note that this might not work if you host this server on the same PC as the client, read below).

If you're attempting to host your server on a home computer and other players cannot connect to it, you need to manually forward the port '''UDP 6000''' on your home router to '''your local IP address''' (the game has the auto port forwarding feature but it often fails due to the difference in UPnP implementation on many routers). E.g. if your PC's IP address in local network is 192.168.1.100 (you can check it with ipconfig tool or in Windows network adapter's settings) you will need to setup a port forward rule on your router to forward traffic from port 6000 UDP to port 6000 UDP on IP address 192.168.1.100.

'''If you're running a game server on the same PC as the game client:'''
 Please note that you might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its address as <code>localhost:6000</code> and connect to it directly.

'''If you're running a game server in the same local network as the game client (for example you want to play over LAN with your friends and family):'''
 You might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its local IP address (IPv4) and connect to it directly. To get your local IP address please use ipconfig command-line tool or check the network adapter properties in the network center. You need to get the local network IP address of the PC that is hosting the game server. Then add it in the custom servers list on your PC. You can lookup the IP address in the Windows network settings or by using CMD tool called ipconfig in Windows. For example, here we've run the ipconfig tool here and see the IPv4 address as 192.168.1.200 ([https://cdn.discordapp.com/attachments/421250395298332672/739147674367950908/Screenshot_at_19-48-06.png screenshot]). We can use it on any other PC in the local network to connect to that PC hosting the game server.

Connecting to the private servers requires adding it via the Custom servers menu.

6000 is the default port but you can change it in the Data/SettingsServer.xml file.

== Server update/upgrade to new version ==
When we're releasing a new version of the game server, you need to follow these steps to update it:
# (If you have not done this) Install ".NET Runtime" (version 5.0) https://dotnet.microsoft.com/download/dotnet/5.0/runtime
# Ensure you've made a '''backup''' of the "'''Data'''" folder inside the game server installation folder.
# If you're updating from A28 or earlier versions (ONLY), delete "Data/Saves" folder as the savegame is not compatible (breaking changes). Update from A29 to R30/R31/R32 (or to any patch versions) '''doesn't require this step''' (savegame is compatible).
# Download the new version of the server and overwrite your current installation with it (you can find the actual download link above in the "Installation" section).
# Stop the game server (if it's running).
# Important: please '''overwrite''' both Binaries and Core folders!
# Start the server as usual.

== Server commands ==
# Ensure you're the server operator (you've edited the ServerSettings.xml file and added yourself into the server_operators_list).
# Connect to your game server.
# The game console can be toggled by pressing <code>~</code> (the key on the left from <code>1</code> key) like in old-school games (you can change the key binding for console in the controls options).
# Please add <code>/</code> (slash) prefix to the server commands you want to execute.
# You can use '''Tab''' key to fill autocomplete, and you can use '''arrow Up/Down keys''' to navigate the suggestions list. Press '''Tab''' or '''Enter''' to accept the suggestion.

Here is the page with the server commands list: [[CryoFall/Server/Commands|Server Commands List]]

== Moderation (whitelist, blacklist, kicking, muting) ==
Server operator can access special moderation commands. To invoke these commands, please ensure you're the server operator, connect to your game server, open the console (~ key) and then you can use these commands: (replace username with the actual player nickname)

Whitelist management:

<code>/mod.whiteList.add username</code>

<code>/mod.whiteList.remove username</code>

<code>/mod.whiteList.print</code>

To enable whitelist:

<code>/mod.whiteList.enabled 1</code>

Blacklist management:

<code>/mod.blackList.add username</code>

<code>/mod.blackList.remove username</code>

<code>/mod.blackList.print</code>

Kicking players (temporary removing from server and blocking from connecting):

<code>/mod.kickList.add username durationInMinutes</code>

<code>/mod.kickList.remove username</code>

<code>/mod.kickList.print</code>

Muting players (temporary removing their ability to send messages to chat):

<code>/mod.muteList.add username durationInMinutes</code>

<code>/mod.muteList.remove username</code>

<code>/mod.muteList.print</code>

== Server rates adjusting / Enabling PvP mode ==
Server rates (and PvP mode setting) are exposed in a separate config file. You can quickly change things like LP gain rate, increase item drops, reduce the player to player damage to zero, or even increase the damage from creatures and make it really tough for the players!

To adjust the server rates, stop the server and check the file <game server>/Data/ServerRates.config
Please read carefullyΓÇöall the rates are disabled and in order to apply them '''you need to remove the # char at the start of the line'''!

If you want to '''enable PvP''', search PvP in the file. By default, this setting's value is 0 and you need to change it to 1 and remove the # char at the start of the line.

For advanced modding please read [http://forums.atomictorch.com/index.php?topic=1027.0 modding prerequisites].

== Server raiding hours (for PvP) ==
'''(Please note: with A27 this feature is not recommend anymore as there is a better feature now ΓÇö S.H.I.E.L.D. protection that is enabled by default for PvP servers)'''

On PvP server, you could set up specific hours during which the raiding is possible.
 By default, offline raiding protection is not enabled so players could raid other players' bases at any time.
 To enable offline raiding protection, please use this in-game console command:
 <code>/admin.setRaidingWindow 4 14 1.5</code>
 In this code we're using (first number) +4 GMT/UTC timezone, (second number) hour of day when raiding is possible (value from 0 to 24), and (third number) is the duration of the raiding window (value from 0 to 24).
 So the code in the example will allow raiding from 14:00 (or 2PM) for 1.5 hours.
 After changing the value you could open Politics/Diplomacy menu ([P] key) and verify whether you set the correct numbers.
 Please note that Politics/Diplomacy menu displaying your local time (in your PC timezone)!

== How to prohibit client modifications ==
If you wish to restrict usage of any client modifications on your server, please find "<no_client_mods>" setting in the SettingsServer.xml file. Change the value from 0 to 1 to enable this feature. It's recommended for PvP servers to set it to 1. You can read more details about this feature in [https://atomictorch.com/Post/Id2218/A28-Justice-Update-Release A28 Update announcement].

CryoFall/Server/Setup

2021-12-31T12:58:44Z

Ai enabled: /* How to setup your own server (on any OS): */

= Local server / Singleplayer =
Starting with R31 "Singleplayer Update" the local server is seamlessly integrated into the game client. Other players can also connect to you over LAN (new tab in Multiplayer menu) and even over the internet with virtual LAN (with software such as Hamachi).

= Using game server hosting providers =

==== Game server rent service ====
''If you don't want to hassle with the game server setup, you can rent your own CryoFall server from any third party game server hosting company in just a few minutes. They provide data center locations in almost every country around the world!''
* [https://pingperfect.com/gameservers/cryofall-game-server-hosting-rental.php?aff=586 PingPerfect]
* [https://gameserver.4players.de/server-hosting/cryofall-server-mieten/ 4PLAYERS] (the website is available in German only)
''Please note that AtomicTorch Studio is not affiliated with any of these companies and not responsible for their service quality so in case of any issues please reach them directly. So far we've heard only positive feedback about their services.''

= Self-hosting =

== Requirements ==
====Hardware requirements====
(for up to about 30 players online) 1-core CPU 1.6-2 GHz, 1.5 GB RAM, 2-3 Mbit/s bandwidth (each way)
 (for up to about 100 players online) 2-core CPU 1.6-2 GHz, 2 GB RAM, 3-6 Mbit/s bandwidth
 (for up to about 200 players online) 2-core CPU 2.4-3 GHz, 2 GB RAM, 6-12 Mbit/s bandwidth
 (for up to about 300 players online) 2-core CPU 3+ GHz, 2.5 GB RAM, 12-20 Mbit/s bandwidth
 Usually, VPS (virtual machines) hosting such as [https://www.vultr.com/?ref=7238385 Vultr.com] (this is our referral link as we're using this company services to host our own servers) is sufficient for hosting a game server. Using 1-core machines is not recommended as the game requires a secondary CPU to ensure smooth performance without hiccups during intensive background operations (such as world snapshot saving). Using more than a 2-core machine for a single game server hosting is redundant as the game cannot utilize more than two cores due to the sequential execution of the game simulation (except networking).

====Software (system) requirements====
The server could run on Windows, Linux, and Mac.
To achieve this the game server is using .NET Runtime 5.0.
For hosting the official game servers we prefer using CentOS 7 with Docker or CentOS 8 with podman (OSS alternative to Docker).

== Server installation with Docker (best way for Linux) ==
We recommend this for Linux only. Please follow this guide [https://hub.docker.com/r/atomictorch/cryofall-server CryoFall Dedicated Server Docker Image] then return back here to '''"Server installation"''' section and follow the list after number 7. Ignore instructions on how to start the server with "dotnet" as you should use "docker run ..." instead as explained in the Docker guide above.

== Server installation / direct download (Windows, Linux, Mac) ==

==== How to setup your own server (on any OS): ====
# Download and '''install''' .NET Runtime 5.0 x64ΓÇöplease visit [https://dotnet.microsoft.com/download/dotnet/5.0/runtime Download .NET page] and follow the installation guide for your OS (for Windows you need to download x64 version from the "Run console apps" section).
# Download the game server package. There are several ways to do this:
## You can download it directly from our website:
### '''[https://atomictorch.com/Files/CryoFall_Server_v1.32.2.1.zip SERVER DOWNLOAD LINK (any OS)]'''
### Extract the downloaded package (it's a regular ZIP archive).
## Alternatively, you can download it from '''Steam Client''': ''(preferable, as this way you can easily download updates)''
### Launch Steam Client
### Select LIBRARY tab
### Click on "ALL" and toggle "Tools"
### Search for "CryoFall Dedicated Server" and install it
## Alternatively, you can download it with '''SteamCMD''' (if you're familiar with it):
### launch SteamCMD
### enter:
###: <code>
###: login anonymous
###: app_update 1061710
###: </code>
### navigate to the installation folder (usually in steamapps/Common/CryoFall Dedicated Server)
# The server executable is located in the subfolder: "Binaries/Server". Open the command line/terminal/SSH (or PowerShell in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable first time with <code>loadOrNew</code> flag. The server will start and create the game world.
#:<code>dotnet CryoFall_Server.dll loadOrNew</code>
# Usually it takes about 1-2 minutes to create a new world (or load a savegame). After that the server will keep writing performance statistics information every 20 seconds among other information such as the spawn scripts reporting and network events.
# Stop the server. To do so enter the command below and press Enter key.
#:<code>stop 0</code>
#The server will save and quit. Now you have the "SettingsServer.xml" and "ModsConfig.xml" files.
# Now you need to navigate to the subfolder "Data" (in the root of the server folder, '''not''' in the "Binaries/Server") and modify "SettingsServer.xml" to set the unique server '''name''' and set other settings, etc (there are XML comments explaining every setting so it should be straightforward). ''Please note that you can (and should) edit '''Description''' and '''Welcome message''' from the '''CURRENT GAME''' menu right from the game after connecting to your server.''
# If you are interested in making your server visible in the community servers list make sure to edit <is_public_server> and change the value from 0 to 1. Also, please make sure your router is configured correctly (port forwarding) to enable other people to connect to your machine from outside. But ideally, you should use dedicated server hardware (VPS or VDS) to host public servers.
# While you're still editing "SettingsServer.xml" file, please find the value '''<server_operators_list>''' and change it to include '''your nickname'''! Otherwise, you will be unable to access your server console from the game and also you will be unable to edit the server's Description and Welcome message.
# If you want to have a custom server icon, please replace the ServerIcon.png file in the "Data" subfolder. The icon image file requirements: '''PNG24 format, 256x256 size, up to 100 KB'''.

'''Important (for Windows only):''' you need to allow the dotnet process in the Windows Firewall settingsΓÇöif the Firewall access request was not shown automatically by Windows you can add the <code>C:\Program Files\dotnet\dotnet.exe</code> file into Firewall whitelist. To do this, open Windows Start menu and search for "Allow an app through Windows Firewall" -> button "Allow another app".

==== Starting the server ====
# Launch the command line (we recommending '''PowerShell''' in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable with <code>load</code> flag.
#:<code>dotnet CryoFall_Server.dll load</code>
# Stop your server by typing command below and pressing Enter key (it will save the world before stopping).
#:<code>stop 60 The shutdown message text goes here</code>
(Where <code>60</code> is the shutdown delay (in seconds) so the connected players will have some time to find a safe location)

'''''Please note that typing this message is really hard as the console is updating regularly! The best way is to simply copy-paste from the text editor the whole command text into the game console window (hint: you can paste in PowerShell by simply pressing the right mouse button) and pressing Enter key.'''''

You can always wipe the world by launching the game with <code>new</code> flag:
:<code>dotnet CryoFall_Server.dll new</code>

Currently, we don't support the savegame migration between the major game versions (if there are changes to the game data serialization scheme). We plan to implement the proper data migration feature ASAP.

==== Connecting to the server ====
If you want to connect to your local game server, simply add SERVERS->Custom list as <code>localhost</code>

To connect to the public server you need to navigate to SERVERS->Community servers list (please note that this might not work if you host this server on the same PC as the client, read below).

If you're attempting to host your server on a home computer and other players cannot connect to it, you need to manually forward the port '''UDP 6000''' on your home router to '''your local IP address''' (the game has the auto port forwarding feature but it often fails due to the difference in UPnP implementation on many routers). E.g. if your PC's IP address in local network is 192.168.1.100 (you can check it with ipconfig tool or in Windows network adapter's settings) you will need to setup a port forward rule on your router to forward traffic from port 6000 UDP to port 6000 UDP on IP address 192.168.1.100.

'''If you're running a game server on the same PC as the game client:'''
 Please note that you might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its address as <code>localhost:6000</code> and connect to it directly.

'''If you're running a game server in the same local network as the game client (for example you want to play over LAN with your friends and family):'''
 You might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its local IP address (IPv4) and connect to it directly. To get your local IP address please use ipconfig command-line tool or check the network adapter properties in the network center. You need to get the local network IP address of the PC that is hosting the game server. Then add it in the custom servers list on your PC. You can lookup the IP address in the Windows network settings or by using CMD tool called ipconfig in Windows. For example, here we've run the ipconfig tool here and see the IPv4 address as 192.168.1.200 ([https://cdn.discordapp.com/attachments/421250395298332672/739147674367950908/Screenshot_at_19-48-06.png screenshot]). We can use it on any other PC in the local network to connect to that PC hosting the game server.

Connecting to the private servers requires adding it via the Custom servers menu.

6000 is the default port but you can change it in the Data/SettingsServer.xml file.

== Server update/upgrade to new version ==
When we're releasing a new version of the game server, you need to follow these steps to update it:
# (If you have not done this) Install ".NET Runtime" (version 5.0) https://dotnet.microsoft.com/download/dotnet/5.0/runtime
# Ensure you've made a '''backup''' of the "'''Data'''" folder inside the game server installation folder.
# If you're updating from A28 or earlier versions, DELETE "Data/Saves" folder as the savegame is not compatible (breaking changes). Update from A29 to R30/R31 (or to any patch versions) '''doesn't require this step''' (savegame is compatible).
# Download the new version of the server and overwrite your current installation with it (you can find the actual download link above in the "Installation" section).
# Stop the game server (if it's running).
# Important: please '''overwrite''' both Binaries and Core folders!
# Start the server as usual.

== Server commands ==
# Ensure you're the server operator (you've edited the ServerSettings.xml file and added yourself into the server_operators_list).
# Connect to your game server.
# The game console can be toggled by pressing <code>~</code> (the key on the left from <code>1</code> key) like in old-school games (you can change the key binding for console in the controls options).
# Please add <code>/</code> (slash) prefix to the server commands you want to execute.
# You can use '''Tab''' key to fill autocomplete, and you can use '''arrow Up/Down keys''' to navigate the suggestions list. Press '''Tab''' or '''Enter''' to accept the suggestion.

Here is the page with the server commands list: [[CryoFall/Server/Commands|Server Commands List]]

== Moderation (whitelist, blacklist, kicking, muting) ==
Server operator can access special moderation commands. To invoke these commands, please ensure you're the server operator, connect to your game server, open the console (~ key) and then you can use these commands: (replace username with the actual player nickname)

Whitelist management:

<code>/mod.whiteList.add username</code>

<code>/mod.whiteList.remove username</code>

<code>/mod.whiteList.print</code>

To enable whitelist:

<code>/mod.whiteList.enabled 1</code>

Blacklist management:

<code>/mod.blackList.add username</code>

<code>/mod.blackList.remove username</code>

<code>/mod.blackList.print</code>

Kicking players (temporary removing from server and blocking from connecting):

<code>/mod.kickList.add username durationInMinutes</code>

<code>/mod.kickList.remove username</code>

<code>/mod.kickList.print</code>

Muting players (temporary removing their ability to send messages to chat):

<code>/mod.muteList.add username durationInMinutes</code>

<code>/mod.muteList.remove username</code>

<code>/mod.muteList.print</code>

== Server rates adjusting / Enabling PvP mode ==
Server rates (and PvP mode setting) are exposed in a separate config file. You can quickly change things like LP gain rate, increase item drops, reduce the player to player damage to zero, or even increase the damage from creatures and make it really tough for the players!

To adjust the server rates, stop the server and check the file <game server>/Data/ServerRates.config
Please read carefullyΓÇöall the rates are disabled and in order to apply them '''you need to remove the # char at the start of the line'''!

If you want to '''enable PvP''', search PvP in the file. By default, this setting's value is 0 and you need to change it to 1 and remove the # char at the start of the line.

For advanced modding please read [http://forums.atomictorch.com/index.php?topic=1027.0 modding prerequisites].

== Server raiding hours (for PvP) ==
'''(Please note: with A27 this feature is not recommend anymore as there is a better feature now ΓÇö S.H.I.E.L.D. protection that is enabled by default for PvP servers)'''

On PvP server, you could set up specific hours during which the raiding is possible.
 By default, offline raiding protection is not enabled so players could raid other players' bases at any time.
 To enable offline raiding protection, please use this in-game console command:
 <code>/admin.setRaidingWindow 4 14 1.5</code>
 In this code we're using (first number) +4 GMT/UTC timezone, (second number) hour of day when raiding is possible (value from 0 to 24), and (third number) is the duration of the raiding window (value from 0 to 24).
 So the code in the example will allow raiding from 14:00 (or 2PM) for 1.5 hours.
 After changing the value you could open Politics/Diplomacy menu ([P] key) and verify whether you set the correct numbers.
 Please note that Politics/Diplomacy menu displaying your local time (in your PC timezone)!

== How to prohibit client modifications ==
If you wish to restrict usage of any client modifications on your server, please find "<no_client_mods>" setting in the SettingsServer.xml file. Change the value from 0 to 1 to enable this feature. It's recommended for PvP servers to set it to 1. You can read more details about this feature in [https://atomictorch.com/Post/Id2218/A28-Justice-Update-Release A28 Update announcement].

CryoFall/Server/Setup

2021-12-31T12:58:36Z

Ai enabled: /* How to setup your own server (on any OS): */

= Local server / Singleplayer =
Starting with R31 "Singleplayer Update" the local server is seamlessly integrated into the game client. Other players can also connect to you over LAN (new tab in Multiplayer menu) and even over the internet with virtual LAN (with software such as Hamachi).

= Using game server hosting providers =

==== Game server rent service ====
''If you don't want to hassle with the game server setup, you can rent your own CryoFall server from any third party game server hosting company in just a few minutes. They provide data center locations in almost every country around the world!''
* [https://pingperfect.com/gameservers/cryofall-game-server-hosting-rental.php?aff=586 PingPerfect]
* [https://gameserver.4players.de/server-hosting/cryofall-server-mieten/ 4PLAYERS] (the website is available in German only)
''Please note that AtomicTorch Studio is not affiliated with any of these companies and not responsible for their service quality so in case of any issues please reach them directly. So far we've heard only positive feedback about their services.''

= Self-hosting =

== Requirements ==
====Hardware requirements====
(for up to about 30 players online) 1-core CPU 1.6-2 GHz, 1.5 GB RAM, 2-3 Mbit/s bandwidth (each way)
 (for up to about 100 players online) 2-core CPU 1.6-2 GHz, 2 GB RAM, 3-6 Mbit/s bandwidth
 (for up to about 200 players online) 2-core CPU 2.4-3 GHz, 2 GB RAM, 6-12 Mbit/s bandwidth
 (for up to about 300 players online) 2-core CPU 3+ GHz, 2.5 GB RAM, 12-20 Mbit/s bandwidth
 Usually, VPS (virtual machines) hosting such as [https://www.vultr.com/?ref=7238385 Vultr.com] (this is our referral link as we're using this company services to host our own servers) is sufficient for hosting a game server. Using 1-core machines is not recommended as the game requires a secondary CPU to ensure smooth performance without hiccups during intensive background operations (such as world snapshot saving). Using more than a 2-core machine for a single game server hosting is redundant as the game cannot utilize more than two cores due to the sequential execution of the game simulation (except networking).

====Software (system) requirements====
The server could run on Windows, Linux, and Mac.
To achieve this the game server is using .NET Runtime 5.0.
For hosting the official game servers we prefer using CentOS 7 with Docker or CentOS 8 with podman (OSS alternative to Docker).

== Server installation with Docker (best way for Linux) ==
We recommend this for Linux only. Please follow this guide [https://hub.docker.com/r/atomictorch/cryofall-server CryoFall Dedicated Server Docker Image] then return back here to '''"Server installation"''' section and follow the list after number 7. Ignore instructions on how to start the server with "dotnet" as you should use "docker run ..." instead as explained in the Docker guide above.

== Server installation / direct download (Windows, Linux, Mac) ==

==== How to setup your own server (on any OS): ====
# Download and '''install''' .NET Runtime 5.0 x64ΓÇöplease visit [https://dotnet.microsoft.com/download/dotnet/5.0/runtime Download .NET page] and follow the installation guide for your OS (for Windows you need to download x64 version from the "Run console apps" section).
# Download the game server package. There are several ways to do this:
## You can download it directly from our website:
### '''[https://atomictorch.com/Files/CryoFall_Server_v1.33.2.1.zip SERVER DOWNLOAD LINK (any OS)]'''
### Extract the downloaded package (it's a regular ZIP archive).
## Alternatively, you can download it from '''Steam Client''': ''(preferable, as this way you can easily download updates)''
### Launch Steam Client
### Select LIBRARY tab
### Click on "ALL" and toggle "Tools"
### Search for "CryoFall Dedicated Server" and install it
## Alternatively, you can download it with '''SteamCMD''' (if you're familiar with it):
### launch SteamCMD
### enter:
###: <code>
###: login anonymous
###: app_update 1061710
###: </code>
### navigate to the installation folder (usually in steamapps/Common/CryoFall Dedicated Server)
# The server executable is located in the subfolder: "Binaries/Server". Open the command line/terminal/SSH (or PowerShell in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable first time with <code>loadOrNew</code> flag. The server will start and create the game world.
#:<code>dotnet CryoFall_Server.dll loadOrNew</code>
# Usually it takes about 1-2 minutes to create a new world (or load a savegame). After that the server will keep writing performance statistics information every 20 seconds among other information such as the spawn scripts reporting and network events.
# Stop the server. To do so enter the command below and press Enter key.
#:<code>stop 0</code>
#The server will save and quit. Now you have the "SettingsServer.xml" and "ModsConfig.xml" files.
# Now you need to navigate to the subfolder "Data" (in the root of the server folder, '''not''' in the "Binaries/Server") and modify "SettingsServer.xml" to set the unique server '''name''' and set other settings, etc (there are XML comments explaining every setting so it should be straightforward). ''Please note that you can (and should) edit '''Description''' and '''Welcome message''' from the '''CURRENT GAME''' menu right from the game after connecting to your server.''
# If you are interested in making your server visible in the community servers list make sure to edit <is_public_server> and change the value from 0 to 1. Also, please make sure your router is configured correctly (port forwarding) to enable other people to connect to your machine from outside. But ideally, you should use dedicated server hardware (VPS or VDS) to host public servers.
# While you're still editing "SettingsServer.xml" file, please find the value '''<server_operators_list>''' and change it to include '''your nickname'''! Otherwise, you will be unable to access your server console from the game and also you will be unable to edit the server's Description and Welcome message.
# If you want to have a custom server icon, please replace the ServerIcon.png file in the "Data" subfolder. The icon image file requirements: '''PNG24 format, 256x256 size, up to 100 KB'''.

'''Important (for Windows only):''' you need to allow the dotnet process in the Windows Firewall settingsΓÇöif the Firewall access request was not shown automatically by Windows you can add the <code>C:\Program Files\dotnet\dotnet.exe</code> file into Firewall whitelist. To do this, open Windows Start menu and search for "Allow an app through Windows Firewall" -> button "Allow another app".

==== Starting the server ====
# Launch the command line (we recommending '''PowerShell''' in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable with <code>load</code> flag.
#:<code>dotnet CryoFall_Server.dll load</code>
# Stop your server by typing command below and pressing Enter key (it will save the world before stopping).
#:<code>stop 60 The shutdown message text goes here</code>
(Where <code>60</code> is the shutdown delay (in seconds) so the connected players will have some time to find a safe location)

'''''Please note that typing this message is really hard as the console is updating regularly! The best way is to simply copy-paste from the text editor the whole command text into the game console window (hint: you can paste in PowerShell by simply pressing the right mouse button) and pressing Enter key.'''''

You can always wipe the world by launching the game with <code>new</code> flag:
:<code>dotnet CryoFall_Server.dll new</code>

Currently, we don't support the savegame migration between the major game versions (if there are changes to the game data serialization scheme). We plan to implement the proper data migration feature ASAP.

==== Connecting to the server ====
If you want to connect to your local game server, simply add SERVERS->Custom list as <code>localhost</code>

To connect to the public server you need to navigate to SERVERS->Community servers list (please note that this might not work if you host this server on the same PC as the client, read below).

If you're attempting to host your server on a home computer and other players cannot connect to it, you need to manually forward the port '''UDP 6000''' on your home router to '''your local IP address''' (the game has the auto port forwarding feature but it often fails due to the difference in UPnP implementation on many routers). E.g. if your PC's IP address in local network is 192.168.1.100 (you can check it with ipconfig tool or in Windows network adapter's settings) you will need to setup a port forward rule on your router to forward traffic from port 6000 UDP to port 6000 UDP on IP address 192.168.1.100.

'''If you're running a game server on the same PC as the game client:'''
 Please note that you might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its address as <code>localhost:6000</code> and connect to it directly.

'''If you're running a game server in the same local network as the game client (for example you want to play over LAN with your friends and family):'''
 You might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its local IP address (IPv4) and connect to it directly. To get your local IP address please use ipconfig command-line tool or check the network adapter properties in the network center. You need to get the local network IP address of the PC that is hosting the game server. Then add it in the custom servers list on your PC. You can lookup the IP address in the Windows network settings or by using CMD tool called ipconfig in Windows. For example, here we've run the ipconfig tool here and see the IPv4 address as 192.168.1.200 ([https://cdn.discordapp.com/attachments/421250395298332672/739147674367950908/Screenshot_at_19-48-06.png screenshot]). We can use it on any other PC in the local network to connect to that PC hosting the game server.

Connecting to the private servers requires adding it via the Custom servers menu.

6000 is the default port but you can change it in the Data/SettingsServer.xml file.

== Server update/upgrade to new version ==
When we're releasing a new version of the game server, you need to follow these steps to update it:
# (If you have not done this) Install ".NET Runtime" (version 5.0) https://dotnet.microsoft.com/download/dotnet/5.0/runtime
# Ensure you've made a '''backup''' of the "'''Data'''" folder inside the game server installation folder.
# If you're updating from A28 or earlier versions, DELETE "Data/Saves" folder as the savegame is not compatible (breaking changes). Update from A29 to R30/R31 (or to any patch versions) '''doesn't require this step''' (savegame is compatible).
# Download the new version of the server and overwrite your current installation with it (you can find the actual download link above in the "Installation" section).
# Stop the game server (if it's running).
# Important: please '''overwrite''' both Binaries and Core folders!
# Start the server as usual.

== Server commands ==
# Ensure you're the server operator (you've edited the ServerSettings.xml file and added yourself into the server_operators_list).
# Connect to your game server.
# The game console can be toggled by pressing <code>~</code> (the key on the left from <code>1</code> key) like in old-school games (you can change the key binding for console in the controls options).
# Please add <code>/</code> (slash) prefix to the server commands you want to execute.
# You can use '''Tab''' key to fill autocomplete, and you can use '''arrow Up/Down keys''' to navigate the suggestions list. Press '''Tab''' or '''Enter''' to accept the suggestion.

Here is the page with the server commands list: [[CryoFall/Server/Commands|Server Commands List]]

== Moderation (whitelist, blacklist, kicking, muting) ==
Server operator can access special moderation commands. To invoke these commands, please ensure you're the server operator, connect to your game server, open the console (~ key) and then you can use these commands: (replace username with the actual player nickname)

Whitelist management:

<code>/mod.whiteList.add username</code>

<code>/mod.whiteList.remove username</code>

<code>/mod.whiteList.print</code>

To enable whitelist:

<code>/mod.whiteList.enabled 1</code>

Blacklist management:

<code>/mod.blackList.add username</code>

<code>/mod.blackList.remove username</code>

<code>/mod.blackList.print</code>

Kicking players (temporary removing from server and blocking from connecting):

<code>/mod.kickList.add username durationInMinutes</code>

<code>/mod.kickList.remove username</code>

<code>/mod.kickList.print</code>

Muting players (temporary removing their ability to send messages to chat):

<code>/mod.muteList.add username durationInMinutes</code>

<code>/mod.muteList.remove username</code>

<code>/mod.muteList.print</code>

== Server rates adjusting / Enabling PvP mode ==
Server rates (and PvP mode setting) are exposed in a separate config file. You can quickly change things like LP gain rate, increase item drops, reduce the player to player damage to zero, or even increase the damage from creatures and make it really tough for the players!

To adjust the server rates, stop the server and check the file <game server>/Data/ServerRates.config
Please read carefullyΓÇöall the rates are disabled and in order to apply them '''you need to remove the # char at the start of the line'''!

If you want to '''enable PvP''', search PvP in the file. By default, this setting's value is 0 and you need to change it to 1 and remove the # char at the start of the line.

For advanced modding please read [http://forums.atomictorch.com/index.php?topic=1027.0 modding prerequisites].

== Server raiding hours (for PvP) ==
'''(Please note: with A27 this feature is not recommend anymore as there is a better feature now ΓÇö S.H.I.E.L.D. protection that is enabled by default for PvP servers)'''

On PvP server, you could set up specific hours during which the raiding is possible.
 By default, offline raiding protection is not enabled so players could raid other players' bases at any time.
 To enable offline raiding protection, please use this in-game console command:
 <code>/admin.setRaidingWindow 4 14 1.5</code>
 In this code we're using (first number) +4 GMT/UTC timezone, (second number) hour of day when raiding is possible (value from 0 to 24), and (third number) is the duration of the raiding window (value from 0 to 24).
 So the code in the example will allow raiding from 14:00 (or 2PM) for 1.5 hours.
 After changing the value you could open Politics/Diplomacy menu ([P] key) and verify whether you set the correct numbers.
 Please note that Politics/Diplomacy menu displaying your local time (in your PC timezone)!

== How to prohibit client modifications ==
If you wish to restrict usage of any client modifications on your server, please find "<no_client_mods>" setting in the SettingsServer.xml file. Change the value from 0 to 1 to enable this feature. It's recommended for PvP servers to set it to 1. You can read more details about this feature in [https://atomictorch.com/Post/Id2218/A28-Justice-Update-Release A28 Update announcement].

CryoFall/Server/Setup

2021-12-04T01:20:45Z

Ai enabled: /* How to setup your own server (on any OS): */

= Local server / Singleplayer =
Starting with R31 "Singleplayer Update" the local server is seamlessly integrated into the game client. Other players can also connect to you over LAN (new tab in Multiplayer menu) and even over the internet with virtual LAN (with software such as Hamachi).

= Using game server hosting providers =

==== Game server rent service ====
''If you don't want to hassle with the game server setup, you can rent your own CryoFall server from any third party game server hosting company in just a few minutes. They provide data center locations in almost every country around the world!''
* [https://pingperfect.com/gameservers/cryofall-game-server-hosting-rental.php?aff=586 PingPerfect]
* [https://gameserver.4players.de/server-hosting/cryofall-server-mieten/ 4PLAYERS] (the website is available in German only)
''Please note that AtomicTorch Studio is not affiliated with any of these companies and not responsible for their service quality so in case of any issues please reach them directly. So far we've heard only positive feedback about their services.''

= Self-hosting =

== Requirements ==
====Hardware requirements====
(for up to about 30 players online) 1-core CPU 1.6-2 GHz, 1.5 GB RAM, 2-3 Mbit/s bandwidth (each way)
 (for up to about 100 players online) 2-core CPU 1.6-2 GHz, 2 GB RAM, 3-6 Mbit/s bandwidth
 (for up to about 200 players online) 2-core CPU 2.4-3 GHz, 2 GB RAM, 6-12 Mbit/s bandwidth
 (for up to about 300 players online) 2-core CPU 3+ GHz, 2.5 GB RAM, 12-20 Mbit/s bandwidth
 Usually, VPS (virtual machines) hosting such as [https://www.vultr.com/?ref=7238385 Vultr.com] (this is our referral link as we're using this company services to host our own servers) is sufficient for hosting a game server. Using 1-core machines is not recommended as the game requires a secondary CPU to ensure smooth performance without hiccups during intensive background operations (such as world snapshot saving). Using more than a 2-core machine for a single game server hosting is redundant as the game cannot utilize more than two cores due to the sequential execution of the game simulation (except networking).

====Software (system) requirements====
The server could run on Windows, Linux, and Mac.
To achieve this the game server is using .NET Runtime 5.0.
For hosting the official game servers we prefer using CentOS 7 with Docker or CentOS 8 with podman (OSS alternative to Docker).

== Server installation with Docker (best way for Linux) ==
We recommend this for Linux only. Please follow this guide [https://hub.docker.com/r/atomictorch/cryofall-server CryoFall Dedicated Server Docker Image] then return back here to '''"Server installation"''' section and follow the list after number 7. Ignore instructions on how to start the server with "dotnet" as you should use "docker run ..." instead as explained in the Docker guide above.

== Server installation / direct download (Windows, Linux, Mac) ==

==== How to setup your own server (on any OS): ====
# Download and '''install''' .NET Runtime 5.0 x64ΓÇöplease visit [https://dotnet.microsoft.com/download/dotnet/5.0/runtime Download .NET page] and follow the installation guide for your OS (for Windows you need to download x64 version from the "Run console apps" section).
# Download the game server package. There are several ways to do this:
## You can download it directly from our website:
### '''[https://atomictorch.com/Files/CryoFall_Server_v1.31.9.2.zip SERVER DOWNLOAD LINK (any OS)]'''
### Extract the downloaded package (it's a regular ZIP archive).
## Alternatively, you can download it from '''Steam Client''': ''(preferable, as this way you can easily download updates)''
### Launch Steam Client
### Select LIBRARY tab
### Click on "ALL" and toggle "Tools"
### Search for "CryoFall Dedicated Server" and install it
## Alternatively, you can download it with '''SteamCMD''' (if you're familiar with it):
### launch SteamCMD
### enter:
###: <code>
###: login anonymous
###: app_update 1061710
###: </code>
### navigate to the installation folder (usually in steamapps/Common/CryoFall Dedicated Server)
# The server executable is located in the subfolder: "Binaries/Server". Open the command line/terminal/SSH (or PowerShell in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable first time with <code>loadOrNew</code> flag. The server will start and create the game world.
#:<code>dotnet CryoFall_Server.dll loadOrNew</code>
# Usually it takes about 1-2 minutes to create a new world (or load a savegame). After that the server will keep writing performance statistics information every 20 seconds among other information such as the spawn scripts reporting and network events.
# Stop the server. To do so enter the command below and press Enter key.
#:<code>stop 0</code>
#The server will save and quit. Now you have the "SettingsServer.xml" and "ModsConfig.xml" files.
# Now you need to navigate to the subfolder "Data" (in the root of the server folder, '''not''' in the "Binaries/Server") and modify "SettingsServer.xml" to set the unique server '''name''' and set other settings, etc (there are XML comments explaining every setting so it should be straightforward). ''Please note that you can (and should) edit '''Description''' and '''Welcome message''' from the '''CURRENT GAME''' menu right from the game after connecting to your server.''
# If you are interested in making your server visible in the community servers list make sure to edit <is_public_server> and change the value from 0 to 1. Also, please make sure your router is configured correctly (port forwarding) to enable other people to connect to your machine from outside. But ideally, you should use dedicated server hardware (VPS or VDS) to host public servers.
# While you're still editing "SettingsServer.xml" file, please find the value '''<server_operators_list>''' and change it to include '''your nickname'''! Otherwise, you will be unable to access your server console from the game and also you will be unable to edit the server's Description and Welcome message.
# If you want to have a custom server icon, please replace the ServerIcon.png file in the "Data" subfolder. The icon image file requirements: '''PNG24 format, 256x256 size, up to 100 KB'''.

'''Important (for Windows only):''' you need to allow the dotnet process in the Windows Firewall settingsΓÇöif the Firewall access request was not shown automatically by Windows you can add the <code>C:\Program Files\dotnet\dotnet.exe</code> file into Firewall whitelist. To do this, open Windows Start menu and search for "Allow an app through Windows Firewall" -> button "Allow another app".

==== Starting the server ====
# Launch the command line (we recommending '''PowerShell''' in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable with <code>load</code> flag.
#:<code>dotnet CryoFall_Server.dll load</code>
# Stop your server by typing command below and pressing Enter key (it will save the world before stopping).
#:<code>stop 60 The shutdown message text goes here</code>
(Where <code>60</code> is the shutdown delay (in seconds) so the connected players will have some time to find a safe location)

'''''Please note that typing this message is really hard as the console is updating regularly! The best way is to simply copy-paste from the text editor the whole command text into the game console window (hint: you can paste in PowerShell by simply pressing the right mouse button) and pressing Enter key.'''''

You can always wipe the world by launching the game with <code>new</code> flag:
:<code>dotnet CryoFall_Server.dll new</code>

Currently, we don't support the savegame migration between the major game versions (if there are changes to the game data serialization scheme). We plan to implement the proper data migration feature ASAP.

==== Connecting to the server ====
If you want to connect to your local game server, simply add SERVERS->Custom list as <code>localhost</code>

To connect to the public server you need to navigate to SERVERS->Community servers list (please note that this might not work if you host this server on the same PC as the client, read below).

If you're attempting to host your server on a home computer and other players cannot connect to it, you need to manually forward the port '''UDP 6000''' on your home router to '''your local IP address''' (the game has the auto port forwarding feature but it often fails due to the difference in UPnP implementation on many routers). E.g. if your PC's IP address in local network is 192.168.1.100 (you can check it with ipconfig tool or in Windows network adapter's settings) you will need to setup a port forward rule on your router to forward traffic from port 6000 UDP to port 6000 UDP on IP address 192.168.1.100.

'''If you're running a game server on the same PC as the game client:'''
 Please note that you might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its address as <code>localhost:6000</code> and connect to it directly.

'''If you're running a game server in the same local network as the game client (for example you want to play over LAN with your friends and family):'''
 You might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its local IP address (IPv4) and connect to it directly. To get your local IP address please use ipconfig command-line tool or check the network adapter properties in the network center. You need to get the local network IP address of the PC that is hosting the game server. Then add it in the custom servers list on your PC. You can lookup the IP address in the Windows network settings or by using CMD tool called ipconfig in Windows. For example, here we've run the ipconfig tool here and see the IPv4 address as 192.168.1.200 ([https://cdn.discordapp.com/attachments/421250395298332672/739147674367950908/Screenshot_at_19-48-06.png screenshot]). We can use it on any other PC in the local network to connect to that PC hosting the game server.

Connecting to the private servers requires adding it via the Custom servers menu.

6000 is the default port but you can change it in the Data/SettingsServer.xml file.

== Server update/upgrade to new version ==
When we're releasing a new version of the game server, you need to follow these steps to update it:
# (If you have not done this) Install ".NET Runtime" (version 5.0) https://dotnet.microsoft.com/download/dotnet/5.0/runtime
# Ensure you've made a '''backup''' of the "'''Data'''" folder inside the game server installation folder.
# If you're updating from A28 or earlier versions, DELETE "Data/Saves" folder as the savegame is not compatible (breaking changes). Update from A29 to R30/R31 (or to any patch versions) '''doesn't require this step''' (savegame is compatible).
# Download the new version of the server and overwrite your current installation with it (you can find the actual download link above in the "Installation" section).
# Stop the game server (if it's running).
# Important: please '''overwrite''' both Binaries and Core folders!
# Start the server as usual.

== Server commands ==
# Ensure you're the server operator (you've edited the ServerSettings.xml file and added yourself into the server_operators_list).
# Connect to your game server.
# The game console can be toggled by pressing <code>~</code> (the key on the left from <code>1</code> key) like in old-school games (you can change the key binding for console in the controls options).
# Please add <code>/</code> (slash) prefix to the server commands you want to execute.
# You can use '''Tab''' key to fill autocomplete, and you can use '''arrow Up/Down keys''' to navigate the suggestions list. Press '''Tab''' or '''Enter''' to accept the suggestion.

Here is the page with the server commands list: [[CryoFall/Server/Commands|Server Commands List]]

== Moderation (whitelist, blacklist, kicking, muting) ==
Server operator can access special moderation commands. To invoke these commands, please ensure you're the server operator, connect to your game server, open the console (~ key) and then you can use these commands: (replace username with the actual player nickname)

Whitelist management:

<code>/mod.whiteList.add username</code>

<code>/mod.whiteList.remove username</code>

<code>/mod.whiteList.print</code>

To enable whitelist:

<code>/mod.whiteList.enabled 1</code>

Blacklist management:

<code>/mod.blackList.add username</code>

<code>/mod.blackList.remove username</code>

<code>/mod.blackList.print</code>

Kicking players (temporary removing from server and blocking from connecting):

<code>/mod.kickList.add username durationInMinutes</code>

<code>/mod.kickList.remove username</code>

<code>/mod.kickList.print</code>

Muting players (temporary removing their ability to send messages to chat):

<code>/mod.muteList.add username durationInMinutes</code>

<code>/mod.muteList.remove username</code>

<code>/mod.muteList.print</code>

== Server rates adjusting / Enabling PvP mode ==
Server rates (and PvP mode setting) are exposed in a separate config file. You can quickly change things like LP gain rate, increase item drops, reduce the player to player damage to zero, or even increase the damage from creatures and make it really tough for the players!

To adjust the server rates, stop the server and check the file <game server>/Data/ServerRates.config
Please read carefullyΓÇöall the rates are disabled and in order to apply them '''you need to remove the # char at the start of the line'''!

If you want to '''enable PvP''', search PvP in the file. By default, this setting's value is 0 and you need to change it to 1 and remove the # char at the start of the line.

For advanced modding please read [http://forums.atomictorch.com/index.php?topic=1027.0 modding prerequisites].

== Server raiding hours (for PvP) ==
'''(Please note: with A27 this feature is not recommend anymore as there is a better feature now ΓÇö S.H.I.E.L.D. protection that is enabled by default for PvP servers)'''

On PvP server, you could set up specific hours during which the raiding is possible.
 By default, offline raiding protection is not enabled so players could raid other players' bases at any time.
 To enable offline raiding protection, please use this in-game console command:
 <code>/admin.setRaidingWindow 4 14 1.5</code>
 In this code we're using (first number) +4 GMT/UTC timezone, (second number) hour of day when raiding is possible (value from 0 to 24), and (third number) is the duration of the raiding window (value from 0 to 24).
 So the code in the example will allow raiding from 14:00 (or 2PM) for 1.5 hours.
 After changing the value you could open Politics/Diplomacy menu ([P] key) and verify whether you set the correct numbers.
 Please note that Politics/Diplomacy menu displaying your local time (in your PC timezone)!

== How to prohibit client modifications ==
If you wish to restrict usage of any client modifications on your server, please find "<no_client_mods>" setting in the SettingsServer.xml file. Change the value from 0 to 1 to enable this feature. It's recommended for PvP servers to set it to 1. You can read more details about this feature in [https://atomictorch.com/Post/Id2218/A28-Justice-Update-Release A28 Update announcement].

CryoFall/Server/Setup

2021-10-28T12:06:22Z

Ai enabled: /* How to setup your own server (on any OS): */

= Local server / Singleplayer =
Starting with R31 "Singleplayer Update" the local server is seamlessly integrated into the game client. Other players can also connect to you over LAN (new tab in Multiplayer menu) and even over the internet with virtual LAN (with software such as Hamachi).

= Using game server hosting providers =

==== Game server rent service ====
''If you don't want to hassle with the game server setup, you can rent your own CryoFall server from any third party game server hosting company in just a few minutes. They provide data center locations in almost every country around the world!''
* [https://pingperfect.com/gameservers/cryofall-game-server-hosting-rental.php?aff=586 PingPerfect]
* [https://gameserver.4players.de/server-hosting/cryofall-server-mieten/ 4PLAYERS] (the website is available in German only)
''Please note that AtomicTorch Studio is not affiliated with any of these companies and not responsible for their service quality so in case of any issues please reach them directly. So far we've heard only positive feedback about their services.''

= Self-hosting =

== Requirements ==
====Hardware requirements====
(for up to about 30 players online) 1-core CPU 1.6-2 GHz, 1.5 GB RAM, 2-3 Mbit/s bandwidth (each way)
 (for up to about 100 players online) 2-core CPU 1.6-2 GHz, 2 GB RAM, 3-6 Mbit/s bandwidth
 (for up to about 200 players online) 2-core CPU 2.4-3 GHz, 2 GB RAM, 6-12 Mbit/s bandwidth
 (for up to about 300 players online) 2-core CPU 3+ GHz, 2.5 GB RAM, 12-20 Mbit/s bandwidth
 Usually, VPS (virtual machines) hosting such as [https://www.vultr.com/?ref=7238385 Vultr.com] (this is our referral link as we're using this company services to host our own servers) is sufficient for hosting a game server. Using 1-core machines is not recommended as the game requires a secondary CPU to ensure smooth performance without hiccups during intensive background operations (such as world snapshot saving). Using more than a 2-core machine for a single game server hosting is redundant as the game cannot utilize more than two cores due to the sequential execution of the game simulation (except networking).

====Software (system) requirements====
The server could run on Windows, Linux, and Mac.
To achieve this the game server is using .NET Runtime 5.0.
For hosting the official game servers we prefer using CentOS 7 with Docker or CentOS 8 with podman (OSS alternative to Docker).

== Server installation with Docker (best way for Linux) ==
We recommend this for Linux only. Please follow this guide [https://hub.docker.com/r/atomictorch/cryofall-server CryoFall Dedicated Server Docker Image] then return back here to '''"Server installation"''' section and follow the list after number 7. Ignore instructions on how to start the server with "dotnet" as you should use "docker run ..." instead as explained in the Docker guide above.

== Server installation / direct download (Windows, Linux, Mac) ==

==== How to setup your own server (on any OS): ====
# Download and '''install''' .NET Runtime 5.0 x64ΓÇöplease visit [https://dotnet.microsoft.com/download/dotnet/5.0/runtime Download .NET page] and follow the installation guide for your OS (for Windows you need to download x64 version from the "Run console apps" section).
# Download the game server package. There are several ways to do this:
## You can download it directly from our website:
### '''[https://atomictorch.com/Files/CryoFall_Server_v1.31.8.1.zip SERVER DOWNLOAD LINK (any OS)]'''
### Extract the downloaded package (it's a regular ZIP archive).
## Alternatively, you can download it from '''Steam Client''': ''(preferable, as this way you can easily download updates)''
### Launch Steam Client
### Select LIBRARY tab
### Click on "ALL" and toggle "Tools"
### Search for "CryoFall Dedicated Server" and install it
## Alternatively, you can download it with '''SteamCMD''' (if you're familiar with it):
### launch SteamCMD
### enter:
###: <code>
###: login anonymous
###: app_update 1061710
###: </code>
### navigate to the installation folder (usually in steamapps/Common/CryoFall Dedicated Server)
# The server executable is located in the subfolder: "Binaries/Server". Open the command line/terminal/SSH (or PowerShell in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable first time with <code>loadOrNew</code> flag. The server will start and create the game world.
#:<code>dotnet CryoFall_Server.dll loadOrNew</code>
# Usually it takes about 1-2 minutes to create a new world (or load a savegame). After that the server will keep writing performance statistics information every 20 seconds among other information such as the spawn scripts reporting and network events.
# Stop the server. To do so enter the command below and press Enter key.
#:<code>stop 0</code>
#The server will save and quit. Now you have the "SettingsServer.xml" and "ModsConfig.xml" files.
# Now you need to navigate to the subfolder "Data" (in the root of the server folder, '''not''' in the "Binaries/Server") and modify "SettingsServer.xml" to set the unique server '''name''' and set other settings, etc (there are XML comments explaining every setting so it should be straightforward). ''Please note that you can (and should) edit '''Description''' and '''Welcome message''' from the '''CURRENT GAME''' menu right from the game after connecting to your server.''
# If you are interested in making your server visible in the community servers list make sure to edit <is_public_server> and change the value from 0 to 1. Also, please make sure your router is configured correctly (port forwarding) to enable other people to connect to your machine from outside. But ideally, you should use dedicated server hardware (VPS or VDS) to host public servers.
# While you're still editing "SettingsServer.xml" file, please find the value '''<server_operators_list>''' and change it to include '''your nickname'''! Otherwise, you will be unable to access your server console from the game and also you will be unable to edit the server's Description and Welcome message.
# If you want to have a custom server icon, please replace the ServerIcon.png file in the "Data" subfolder. The icon image file requirements: '''PNG24 format, 256x256 size, up to 100 KB'''.

'''Important (for Windows only):''' you need to allow the dotnet process in the Windows Firewall settingsΓÇöif the Firewall access request was not shown automatically by Windows you can add the <code>C:\Program Files\dotnet\dotnet.exe</code> file into Firewall whitelist. To do this, open Windows Start menu and search for "Allow an app through Windows Firewall" -> button "Allow another app".

==== Starting the server ====
# Launch the command line (we recommending '''PowerShell''' in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable with <code>load</code> flag.
#:<code>dotnet CryoFall_Server.dll load</code>
# Stop your server by typing command below and pressing Enter key (it will save the world before stopping).
#:<code>stop 60 The shutdown message text goes here</code>
(Where <code>60</code> is the shutdown delay (in seconds) so the connected players will have some time to find a safe location)

'''''Please note that typing this message is really hard as the console is updating regularly! The best way is to simply copy-paste from the text editor the whole command text into the game console window (hint: you can paste in PowerShell by simply pressing the right mouse button) and pressing Enter key.'''''

You can always wipe the world by launching the game with <code>new</code> flag:
:<code>dotnet CryoFall_Server.dll new</code>

Currently, we don't support the savegame migration between the major game versions (if there are changes to the game data serialization scheme). We plan to implement the proper data migration feature ASAP.

==== Connecting to the server ====
If you want to connect to your local game server, simply add SERVERS->Custom list as <code>localhost</code>

To connect to the public server you need to navigate to SERVERS->Community servers list (please note that this might not work if you host this server on the same PC as the client, read below).

If you're attempting to host your server on a home computer and other players cannot connect to it, you need to manually forward the port '''UDP 6000''' on your home router to '''your local IP address''' (the game has the auto port forwarding feature but it often fails due to the difference in UPnP implementation on many routers). E.g. if your PC's IP address in local network is 192.168.1.100 (you can check it with ipconfig tool or in Windows network adapter's settings) you will need to setup a port forward rule on your router to forward traffic from port 6000 UDP to port 6000 UDP on IP address 192.168.1.100.

'''If you're running a game server on the same PC as the game client:'''
 Please note that you might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its address as <code>localhost:6000</code> and connect to it directly.

'''If you're running a game server in the same local network as the game client (for example you want to play over LAN with your friends and family):'''
 You might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its local IP address (IPv4) and connect to it directly. To get your local IP address please use ipconfig command-line tool or check the network adapter properties in the network center. You need to get the local network IP address of the PC that is hosting the game server. Then add it in the custom servers list on your PC. You can lookup the IP address in the Windows network settings or by using CMD tool called ipconfig in Windows. For example, here we've run the ipconfig tool here and see the IPv4 address as 192.168.1.200 ([https://cdn.discordapp.com/attachments/421250395298332672/739147674367950908/Screenshot_at_19-48-06.png screenshot]). We can use it on any other PC in the local network to connect to that PC hosting the game server.

Connecting to the private servers requires adding it via the Custom servers menu.

6000 is the default port but you can change it in the Data/SettingsServer.xml file.

== Server update/upgrade to new version ==
When we're releasing a new version of the game server, you need to follow these steps to update it:
# (If you have not done this) Install ".NET Runtime" (version 5.0) https://dotnet.microsoft.com/download/dotnet/5.0/runtime
# Ensure you've made a '''backup''' of the "'''Data'''" folder inside the game server installation folder.
# If you're updating from A28 or earlier versions, DELETE "Data/Saves" folder as the savegame is not compatible (breaking changes). Update from A29 to R30/R31 (or to any patch versions) '''doesn't require this step''' (savegame is compatible).
# Download the new version of the server and overwrite your current installation with it (you can find the actual download link above in the "Installation" section).
# Stop the game server (if it's running).
# Important: please '''overwrite''' both Binaries and Core folders!
# Start the server as usual.

== Server commands ==
# Ensure you're the server operator (you've edited the ServerSettings.xml file and added yourself into the server_operators_list).
# Connect to your game server.
# The game console can be toggled by pressing <code>~</code> (the key on the left from <code>1</code> key) like in old-school games (you can change the key binding for console in the controls options).
# Please add <code>/</code> (slash) prefix to the server commands you want to execute.
# You can use '''Tab''' key to fill autocomplete, and you can use '''arrow Up/Down keys''' to navigate the suggestions list. Press '''Tab''' or '''Enter''' to accept the suggestion.

Here is the page with the server commands list: [[CryoFall/Server/Commands|Server Commands List]]

== Moderation (whitelist, blacklist, kicking, muting) ==
Server operator can access special moderation commands. To invoke these commands, please ensure you're the server operator, connect to your game server, open the console (~ key) and then you can use these commands: (replace username with the actual player nickname)

Whitelist management:

<code>/mod.whiteList.add username</code>

<code>/mod.whiteList.remove username</code>

<code>/mod.whiteList.print</code>

To enable whitelist:

<code>/mod.whiteList.enabled 1</code>

Blacklist management:

<code>/mod.blackList.add username</code>

<code>/mod.blackList.remove username</code>

<code>/mod.blackList.print</code>

Kicking players (temporary removing from server and blocking from connecting):

<code>/mod.kickList.add username durationInMinutes</code>

<code>/mod.kickList.remove username</code>

<code>/mod.kickList.print</code>

Muting players (temporary removing their ability to send messages to chat):

<code>/mod.muteList.add username durationInMinutes</code>

<code>/mod.muteList.remove username</code>

<code>/mod.muteList.print</code>

== Server rates adjusting / Enabling PvP mode ==
Server rates (and PvP mode setting) are exposed in a separate config file. You can quickly change things like LP gain rate, increase item drops, reduce the player to player damage to zero, or even increase the damage from creatures and make it really tough for the players!

To adjust the server rates, stop the server and check the file <game server>/Data/ServerRates.config
Please read carefullyΓÇöall the rates are disabled and in order to apply them '''you need to remove the # char at the start of the line'''!

If you want to '''enable PvP''', search PvP in the file. By default, this setting's value is 0 and you need to change it to 1 and remove the # char at the start of the line.

For advanced modding please read [http://forums.atomictorch.com/index.php?topic=1027.0 modding prerequisites].

== Server raiding hours (for PvP) ==
'''(Please note: with A27 this feature is not recommend anymore as there is a better feature now ΓÇö S.H.I.E.L.D. protection that is enabled by default for PvP servers)'''

On PvP server, you could set up specific hours during which the raiding is possible.
 By default, offline raiding protection is not enabled so players could raid other players' bases at any time.
 To enable offline raiding protection, please use this in-game console command:
 <code>/admin.setRaidingWindow 4 14 1.5</code>
 In this code we're using (first number) +4 GMT/UTC timezone, (second number) hour of day when raiding is possible (value from 0 to 24), and (third number) is the duration of the raiding window (value from 0 to 24).
 So the code in the example will allow raiding from 14:00 (or 2PM) for 1.5 hours.
 After changing the value you could open Politics/Diplomacy menu ([P] key) and verify whether you set the correct numbers.
 Please note that Politics/Diplomacy menu displaying your local time (in your PC timezone)!

== How to prohibit client modifications ==
If you wish to restrict usage of any client modifications on your server, please find "<no_client_mods>" setting in the SettingsServer.xml file. Change the value from 0 to 1 to enable this feature. It's recommended for PvP servers to set it to 1. You can read more details about this feature in [https://atomictorch.com/Post/Id2218/A28-Justice-Update-Release A28 Update announcement].

CryoFall/Server/Setup

2021-10-28T12:05:58Z

Ai enabled: /* How to setup your own server (on any OS): */

= Local server / Singleplayer =
Starting with R31 "Singleplayer Update" the local server is seamlessly integrated into the game client. Other players can also connect to you over LAN (new tab in Multiplayer menu) and even over the internet with virtual LAN (with software such as Hamachi).

= Using game server hosting providers =

==== Game server rent service ====
''If you don't want to hassle with the game server setup, you can rent your own CryoFall server from any third party game server hosting company in just a few minutes. They provide data center locations in almost every country around the world!''
* [https://pingperfect.com/gameservers/cryofall-game-server-hosting-rental.php?aff=586 PingPerfect]
* [https://gameserver.4players.de/server-hosting/cryofall-server-mieten/ 4PLAYERS] (the website is available in German only)
''Please note that AtomicTorch Studio is not affiliated with any of these companies and not responsible for their service quality so in case of any issues please reach them directly. So far we've heard only positive feedback about their services.''

= Self-hosting =

== Requirements ==
====Hardware requirements====
(for up to about 30 players online) 1-core CPU 1.6-2 GHz, 1.5 GB RAM, 2-3 Mbit/s bandwidth (each way)
 (for up to about 100 players online) 2-core CPU 1.6-2 GHz, 2 GB RAM, 3-6 Mbit/s bandwidth
 (for up to about 200 players online) 2-core CPU 2.4-3 GHz, 2 GB RAM, 6-12 Mbit/s bandwidth
 (for up to about 300 players online) 2-core CPU 3+ GHz, 2.5 GB RAM, 12-20 Mbit/s bandwidth
 Usually, VPS (virtual machines) hosting such as [https://www.vultr.com/?ref=7238385 Vultr.com] (this is our referral link as we're using this company services to host our own servers) is sufficient for hosting a game server. Using 1-core machines is not recommended as the game requires a secondary CPU to ensure smooth performance without hiccups during intensive background operations (such as world snapshot saving). Using more than a 2-core machine for a single game server hosting is redundant as the game cannot utilize more than two cores due to the sequential execution of the game simulation (except networking).

====Software (system) requirements====
The server could run on Windows, Linux, and Mac.
To achieve this the game server is using .NET Runtime 5.0.
For hosting the official game servers we prefer using CentOS 7 with Docker or CentOS 8 with podman (OSS alternative to Docker).

== Server installation with Docker (best way for Linux) ==
We recommend this for Linux only. Please follow this guide [https://hub.docker.com/r/atomictorch/cryofall-server CryoFall Dedicated Server Docker Image] then return back here to '''"Server installation"''' section and follow the list after number 7. Ignore instructions on how to start the server with "dotnet" as you should use "docker run ..." instead as explained in the Docker guide above.

== Server installation / direct download (Windows, Linux, Mac) ==

==== How to setup your own server (on any OS): ====
# Install .NET Runtime 5.0 x64ΓÇöplease visit [https://dotnet.microsoft.com/download/dotnet/5.0/runtime Download .NET page] and follow the installation guide for your OS (for Windows you need to download x64 version from the "Run console apps" section).
# Download the game server package. There are several ways to do this:
## You can download it directly from our website:
### '''[https://atomictorch.com/Files/CryoFall_Server_v1.31.8.1.zip SERVER DOWNLOAD LINK (any OS)]'''
### Extract the downloaded package (it's a regular ZIP archive).
## Alternatively, you can download it from '''Steam Client''': ''(preferable, as this way you can easily download updates)''
### Launch Steam Client
### Select LIBRARY tab
### Click on "ALL" and toggle "Tools"
### Search for "CryoFall Dedicated Server" and install it
## Alternatively, you can download it with '''SteamCMD''' (if you're familiar with it):
### launch SteamCMD
### enter:
###: <code>
###: login anonymous
###: app_update 1061710
###: </code>
### navigate to the installation folder (usually in steamapps/Common/CryoFall Dedicated Server)
# The server executable is located in the subfolder: "Binaries/Server". Open the command line/terminal/SSH (or PowerShell in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable first time with <code>loadOrNew</code> flag. The server will start and create the game world.
#:<code>dotnet CryoFall_Server.dll loadOrNew</code>
# Usually it takes about 1-2 minutes to create a new world (or load a savegame). After that the server will keep writing performance statistics information every 20 seconds among other information such as the spawn scripts reporting and network events.
# Stop the server. To do so enter the command below and press Enter key.
#:<code>stop 0</code>
#The server will save and quit. Now you have the "SettingsServer.xml" and "ModsConfig.xml" files.
# Now you need to navigate to the subfolder "Data" (in the root of the server folder, '''not''' in the "Binaries/Server") and modify "SettingsServer.xml" to set the unique server '''name''' and set other settings, etc (there are XML comments explaining every setting so it should be straightforward). ''Please note that you can (and should) edit '''Description''' and '''Welcome message''' from the '''CURRENT GAME''' menu right from the game after connecting to your server.''
# If you are interested in making your server visible in the community servers list make sure to edit <is_public_server> and change the value from 0 to 1. Also, please make sure your router is configured correctly (port forwarding) to enable other people to connect to your machine from outside. But ideally, you should use dedicated server hardware (VPS or VDS) to host public servers.
# While you're still editing "SettingsServer.xml" file, please find the value '''<server_operators_list>''' and change it to include '''your nickname'''! Otherwise, you will be unable to access your server console from the game and also you will be unable to edit the server's Description and Welcome message.
# If you want to have a custom server icon, please replace the ServerIcon.png file in the "Data" subfolder. The icon image file requirements: '''PNG24 format, 256x256 size, up to 100 KB'''.

'''Important (for Windows only):''' you need to allow the dotnet process in the Windows Firewall settingsΓÇöif the Firewall access request was not shown automatically by Windows you can add the <code>C:\Program Files\dotnet\dotnet.exe</code> file into Firewall whitelist. To do this, open Windows Start menu and search for "Allow an app through Windows Firewall" -> button "Allow another app".

==== Starting the server ====
# Launch the command line (we recommending '''PowerShell''' in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable with <code>load</code> flag.
#:<code>dotnet CryoFall_Server.dll load</code>
# Stop your server by typing command below and pressing Enter key (it will save the world before stopping).
#:<code>stop 60 The shutdown message text goes here</code>
(Where <code>60</code> is the shutdown delay (in seconds) so the connected players will have some time to find a safe location)

'''''Please note that typing this message is really hard as the console is updating regularly! The best way is to simply copy-paste from the text editor the whole command text into the game console window (hint: you can paste in PowerShell by simply pressing the right mouse button) and pressing Enter key.'''''

You can always wipe the world by launching the game with <code>new</code> flag:
:<code>dotnet CryoFall_Server.dll new</code>

Currently, we don't support the savegame migration between the major game versions (if there are changes to the game data serialization scheme). We plan to implement the proper data migration feature ASAP.

==== Connecting to the server ====
If you want to connect to your local game server, simply add SERVERS->Custom list as <code>localhost</code>

To connect to the public server you need to navigate to SERVERS->Community servers list (please note that this might not work if you host this server on the same PC as the client, read below).

If you're attempting to host your server on a home computer and other players cannot connect to it, you need to manually forward the port '''UDP 6000''' on your home router to '''your local IP address''' (the game has the auto port forwarding feature but it often fails due to the difference in UPnP implementation on many routers). E.g. if your PC's IP address in local network is 192.168.1.100 (you can check it with ipconfig tool or in Windows network adapter's settings) you will need to setup a port forward rule on your router to forward traffic from port 6000 UDP to port 6000 UDP on IP address 192.168.1.100.

'''If you're running a game server on the same PC as the game client:'''
 Please note that you might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its address as <code>localhost:6000</code> and connect to it directly.

'''If you're running a game server in the same local network as the game client (for example you want to play over LAN with your friends and family):'''
 You might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its local IP address (IPv4) and connect to it directly. To get your local IP address please use ipconfig command-line tool or check the network adapter properties in the network center. You need to get the local network IP address of the PC that is hosting the game server. Then add it in the custom servers list on your PC. You can lookup the IP address in the Windows network settings or by using CMD tool called ipconfig in Windows. For example, here we've run the ipconfig tool here and see the IPv4 address as 192.168.1.200 ([https://cdn.discordapp.com/attachments/421250395298332672/739147674367950908/Screenshot_at_19-48-06.png screenshot]). We can use it on any other PC in the local network to connect to that PC hosting the game server.

Connecting to the private servers requires adding it via the Custom servers menu.

6000 is the default port but you can change it in the Data/SettingsServer.xml file.

== Server update/upgrade to new version ==
When we're releasing a new version of the game server, you need to follow these steps to update it:
# (If you have not done this) Install ".NET Runtime" (version 5.0) https://dotnet.microsoft.com/download/dotnet/5.0/runtime
# Ensure you've made a '''backup''' of the "'''Data'''" folder inside the game server installation folder.
# If you're updating from A28 or earlier versions, DELETE "Data/Saves" folder as the savegame is not compatible (breaking changes). Update from A29 to R30/R31 (or to any patch versions) '''doesn't require this step''' (savegame is compatible).
# Download the new version of the server and overwrite your current installation with it (you can find the actual download link above in the "Installation" section).
# Stop the game server (if it's running).
# Important: please '''overwrite''' both Binaries and Core folders!
# Start the server as usual.

== Server commands ==
# Ensure you're the server operator (you've edited the ServerSettings.xml file and added yourself into the server_operators_list).
# Connect to your game server.
# The game console can be toggled by pressing <code>~</code> (the key on the left from <code>1</code> key) like in old-school games (you can change the key binding for console in the controls options).
# Please add <code>/</code> (slash) prefix to the server commands you want to execute.
# You can use '''Tab''' key to fill autocomplete, and you can use '''arrow Up/Down keys''' to navigate the suggestions list. Press '''Tab''' or '''Enter''' to accept the suggestion.

Here is the page with the server commands list: [[CryoFall/Server/Commands|Server Commands List]]

== Moderation (whitelist, blacklist, kicking, muting) ==
Server operator can access special moderation commands. To invoke these commands, please ensure you're the server operator, connect to your game server, open the console (~ key) and then you can use these commands: (replace username with the actual player nickname)

Whitelist management:

<code>/mod.whiteList.add username</code>

<code>/mod.whiteList.remove username</code>

<code>/mod.whiteList.print</code>

To enable whitelist:

<code>/mod.whiteList.enabled 1</code>

Blacklist management:

<code>/mod.blackList.add username</code>

<code>/mod.blackList.remove username</code>

<code>/mod.blackList.print</code>

Kicking players (temporary removing from server and blocking from connecting):

<code>/mod.kickList.add username durationInMinutes</code>

<code>/mod.kickList.remove username</code>

<code>/mod.kickList.print</code>

Muting players (temporary removing their ability to send messages to chat):

<code>/mod.muteList.add username durationInMinutes</code>

<code>/mod.muteList.remove username</code>

<code>/mod.muteList.print</code>

== Server rates adjusting / Enabling PvP mode ==
Server rates (and PvP mode setting) are exposed in a separate config file. You can quickly change things like LP gain rate, increase item drops, reduce the player to player damage to zero, or even increase the damage from creatures and make it really tough for the players!

To adjust the server rates, stop the server and check the file <game server>/Data/ServerRates.config
Please read carefullyΓÇöall the rates are disabled and in order to apply them '''you need to remove the # char at the start of the line'''!

If you want to '''enable PvP''', search PvP in the file. By default, this setting's value is 0 and you need to change it to 1 and remove the # char at the start of the line.

For advanced modding please read [http://forums.atomictorch.com/index.php?topic=1027.0 modding prerequisites].

== Server raiding hours (for PvP) ==
'''(Please note: with A27 this feature is not recommend anymore as there is a better feature now ΓÇö S.H.I.E.L.D. protection that is enabled by default for PvP servers)'''

On PvP server, you could set up specific hours during which the raiding is possible.
 By default, offline raiding protection is not enabled so players could raid other players' bases at any time.
 To enable offline raiding protection, please use this in-game console command:
 <code>/admin.setRaidingWindow 4 14 1.5</code>
 In this code we're using (first number) +4 GMT/UTC timezone, (second number) hour of day when raiding is possible (value from 0 to 24), and (third number) is the duration of the raiding window (value from 0 to 24).
 So the code in the example will allow raiding from 14:00 (or 2PM) for 1.5 hours.
 After changing the value you could open Politics/Diplomacy menu ([P] key) and verify whether you set the correct numbers.
 Please note that Politics/Diplomacy menu displaying your local time (in your PC timezone)!

== How to prohibit client modifications ==
If you wish to restrict usage of any client modifications on your server, please find "<no_client_mods>" setting in the SettingsServer.xml file. Change the value from 0 to 1 to enable this feature. It's recommended for PvP servers to set it to 1. You can read more details about this feature in [https://atomictorch.com/Post/Id2218/A28-Justice-Update-Release A28 Update announcement].

CryoFall/Server/Setup

2021-10-28T00:06:00Z

Ai enabled: /* How to setup your own server (on any OS): */

= Local server / Singleplayer =
Starting with R31 "Singleplayer Update" the local server is seamlessly integrated into the game client. Other players can also connect to you over LAN (new tab in Multiplayer menu) and even over the internet with virtual LAN (with software such as Hamachi).

= Using game server hosting providers =

==== Game server rent service ====
''If you don't want to hassle with the game server setup, you can rent your own CryoFall server from any third party game server hosting company in just a few minutes. They provide data center locations in almost every country around the world!''
* [https://pingperfect.com/gameservers/cryofall-game-server-hosting-rental.php?aff=586 PingPerfect]
* [https://gameserver.4players.de/server-hosting/cryofall-server-mieten/ 4PLAYERS] (the website is available in German only)
''Please note that AtomicTorch Studio is not affiliated with any of these companies and not responsible for their service quality so in case of any issues please reach them directly. So far we've heard only positive feedback about their services.''

= Self-hosting =

== Requirements ==
====Hardware requirements====
(for up to about 30 players online) 1-core CPU 1.6-2 GHz, 1.5 GB RAM, 2-3 Mbit/s bandwidth (each way)
 (for up to about 100 players online) 2-core CPU 1.6-2 GHz, 2 GB RAM, 3-6 Mbit/s bandwidth
 (for up to about 200 players online) 2-core CPU 2.4-3 GHz, 2 GB RAM, 6-12 Mbit/s bandwidth
 (for up to about 300 players online) 2-core CPU 3+ GHz, 2.5 GB RAM, 12-20 Mbit/s bandwidth
 Usually, VPS (virtual machines) hosting such as [https://www.vultr.com/?ref=7238385 Vultr.com] (this is our referral link as we're using this company services to host our own servers) is sufficient for hosting a game server. Using 1-core machines is not recommended as the game requires a secondary CPU to ensure smooth performance without hiccups during intensive background operations (such as world snapshot saving). Using more than a 2-core machine for a single game server hosting is redundant as the game cannot utilize more than two cores due to the sequential execution of the game simulation (except networking).

====Software (system) requirements====
The server could run on Windows, Linux, and Mac.
To achieve this the game server is using .NET Runtime 5.0.
For hosting the official game servers we prefer using CentOS 7 with Docker or CentOS 8 with podman (OSS alternative to Docker).

== Server installation with Docker (best way for Linux) ==
We recommend this for Linux only. Please follow this guide [https://hub.docker.com/r/atomictorch/cryofall-server CryoFall Dedicated Server Docker Image] then return back here to '''"Server installation"''' section and follow the list after number 7. Ignore instructions on how to start the server with "dotnet" as you should use "docker run ..." instead as explained in the Docker guide above.

== Server installation / direct download (Windows, Linux, Mac) ==

==== How to setup your own server (on any OS): ====
# Install .NET Runtime 5.0 x64ΓÇöplease visit [https://dotnet.microsoft.com/download/dotnet/5.0/runtime Download .NET page] and follow the installation guide for your OS.
# Download the game server package. There are several ways to do this:
## You can download it directly from our website:
### '''[https://atomictorch.com/Files/CryoFall_Server_v1.31.8.1.zip SERVER DOWNLOAD LINK (any OS)]'''
### Extract the downloaded package (it's a regular ZIP archive).
## Alternatively, you can download it from '''Steam Client''': ''(preferable, as this way you can easily download updates)''
### Launch Steam Client
### Select LIBRARY tab
### Click on "ALL" and toggle "Tools"
### Search for "CryoFall Dedicated Server" and install it
## Alternatively, you can download it with '''SteamCMD''' (if you're familiar with it):
### launch SteamCMD
### enter:
###: <code>
###: login anonymous
###: app_update 1061710
###: </code>
### navigate to the installation folder (usually in steamapps/Common/CryoFall Dedicated Server)
# The server executable is located in the subfolder: "Binaries/Server". Open the command line/terminal/SSH (or PowerShell in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable first time with <code>loadOrNew</code> flag. The server will start and create the game world.
#:<code>dotnet CryoFall_Server.dll loadOrNew</code>
# Usually it takes about 1-2 minutes to create a new world (or load a savegame). After that the server will keep writing performance statistics information every 20 seconds among other information such as the spawn scripts reporting and network events.
# Stop the server. To do so enter the command below and press Enter key.
#:<code>stop 0</code>
#The server will save and quit. Now you have the "SettingsServer.xml" and "ModsConfig.xml" files.
# Now you need to navigate to the subfolder "Data" (in the root of the server folder, '''not''' in the "Binaries/Server") and modify "SettingsServer.xml" to set the unique server '''name''' and set other settings, etc (there are XML comments explaining every setting so it should be straightforward). ''Please note that you can (and should) edit '''Description''' and '''Welcome message''' from the '''CURRENT GAME''' menu right from the game after connecting to your server.''
# If you are interested in making your server visible in the community servers list make sure to edit <is_public_server> and change the value from 0 to 1. Also, please make sure your router is configured correctly (port forwarding) to enable other people to connect to your machine from outside. But ideally, you should use dedicated server hardware (VPS or VDS) to host public servers.
# While you're still editing "SettingsServer.xml" file, please find the value '''<server_operators_list>''' and change it to include '''your nickname'''! Otherwise, you will be unable to access your server console from the game and also you will be unable to edit the server's Description and Welcome message.
# If you want to have a custom server icon, please replace the ServerIcon.png file in the "Data" subfolder. The icon image file requirements: '''PNG24 format, 256x256 size, up to 100 KB'''.

'''Important (for Windows only):''' you need to allow the dotnet process in the Windows Firewall settingsΓÇöif the Firewall access request was not shown automatically by Windows you can add the <code>C:\Program Files\dotnet\dotnet.exe</code> file into Firewall whitelist. To do this, open Windows Start menu and search for "Allow an app through Windows Firewall" -> button "Allow another app".

==== Starting the server ====
# Launch the command line (we recommending '''PowerShell''' in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable with <code>load</code> flag.
#:<code>dotnet CryoFall_Server.dll load</code>
# Stop your server by typing command below and pressing Enter key (it will save the world before stopping).
#:<code>stop 60 The shutdown message text goes here</code>
(Where <code>60</code> is the shutdown delay (in seconds) so the connected players will have some time to find a safe location)

'''''Please note that typing this message is really hard as the console is updating regularly! The best way is to simply copy-paste from the text editor the whole command text into the game console window (hint: you can paste in PowerShell by simply pressing the right mouse button) and pressing Enter key.'''''

You can always wipe the world by launching the game with <code>new</code> flag:
:<code>dotnet CryoFall_Server.dll new</code>

Currently, we don't support the savegame migration between the major game versions (if there are changes to the game data serialization scheme). We plan to implement the proper data migration feature ASAP.

==== Connecting to the server ====
If you want to connect to your local game server, simply add SERVERS->Custom list as <code>localhost</code>

To connect to the public server you need to navigate to SERVERS->Community servers list (please note that this might not work if you host this server on the same PC as the client, read below).

If you're attempting to host your server on a home computer and other players cannot connect to it, you need to manually forward the port '''UDP 6000''' on your home router to '''your local IP address''' (the game has the auto port forwarding feature but it often fails due to the difference in UPnP implementation on many routers). E.g. if your PC's IP address in local network is 192.168.1.100 (you can check it with ipconfig tool or in Windows network adapter's settings) you will need to setup a port forward rule on your router to forward traffic from port 6000 UDP to port 6000 UDP on IP address 192.168.1.100.

'''If you're running a game server on the same PC as the game client:'''
 Please note that you might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its address as <code>localhost:6000</code> and connect to it directly.

'''If you're running a game server in the same local network as the game client (for example you want to play over LAN with your friends and family):'''
 You might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its local IP address (IPv4) and connect to it directly. To get your local IP address please use ipconfig command-line tool or check the network adapter properties in the network center. You need to get the local network IP address of the PC that is hosting the game server. Then add it in the custom servers list on your PC. You can lookup the IP address in the Windows network settings or by using CMD tool called ipconfig in Windows. For example, here we've run the ipconfig tool here and see the IPv4 address as 192.168.1.200 ([https://cdn.discordapp.com/attachments/421250395298332672/739147674367950908/Screenshot_at_19-48-06.png screenshot]). We can use it on any other PC in the local network to connect to that PC hosting the game server.

Connecting to the private servers requires adding it via the Custom servers menu.

6000 is the default port but you can change it in the Data/SettingsServer.xml file.

== Server update/upgrade to new version ==
When we're releasing a new version of the game server, you need to follow these steps to update it:
# (If you have not done this) Install ".NET Runtime" (version 5.0) https://dotnet.microsoft.com/download/dotnet/5.0/runtime
# Ensure you've made a '''backup''' of the "'''Data'''" folder inside the game server installation folder.
# If you're updating from A28 or earlier versions, DELETE "Data/Saves" folder as the savegame is not compatible (breaking changes). Update from A29 to R30/R31 (or to any patch versions) '''doesn't require this step''' (savegame is compatible).
# Download the new version of the server and overwrite your current installation with it (you can find the actual download link above in the "Installation" section).
# Stop the game server (if it's running).
# Important: please '''overwrite''' both Binaries and Core folders!
# Start the server as usual.

== Server commands ==
# Ensure you're the server operator (you've edited the ServerSettings.xml file and added yourself into the server_operators_list).
# Connect to your game server.
# The game console can be toggled by pressing <code>~</code> (the key on the left from <code>1</code> key) like in old-school games (you can change the key binding for console in the controls options).
# Please add <code>/</code> (slash) prefix to the server commands you want to execute.
# You can use '''Tab''' key to fill autocomplete, and you can use '''arrow Up/Down keys''' to navigate the suggestions list. Press '''Tab''' or '''Enter''' to accept the suggestion.

Here is the page with the server commands list: [[CryoFall/Server/Commands|Server Commands List]]

== Moderation (whitelist, blacklist, kicking, muting) ==
Server operator can access special moderation commands. To invoke these commands, please ensure you're the server operator, connect to your game server, open the console (~ key) and then you can use these commands: (replace username with the actual player nickname)

Whitelist management:

<code>/mod.whiteList.add username</code>

<code>/mod.whiteList.remove username</code>

<code>/mod.whiteList.print</code>

To enable whitelist:

<code>/mod.whiteList.enabled 1</code>

Blacklist management:

<code>/mod.blackList.add username</code>

<code>/mod.blackList.remove username</code>

<code>/mod.blackList.print</code>

Kicking players (temporary removing from server and blocking from connecting):

<code>/mod.kickList.add username durationInMinutes</code>

<code>/mod.kickList.remove username</code>

<code>/mod.kickList.print</code>

Muting players (temporary removing their ability to send messages to chat):

<code>/mod.muteList.add username durationInMinutes</code>

<code>/mod.muteList.remove username</code>

<code>/mod.muteList.print</code>

== Server rates adjusting / Enabling PvP mode ==
Server rates (and PvP mode setting) are exposed in a separate config file. You can quickly change things like LP gain rate, increase item drops, reduce the player to player damage to zero, or even increase the damage from creatures and make it really tough for the players!

To adjust the server rates, stop the server and check the file <game server>/Data/ServerRates.config
Please read carefullyΓÇöall the rates are disabled and in order to apply them '''you need to remove the # char at the start of the line'''!

If you want to '''enable PvP''', search PvP in the file. By default, this setting's value is 0 and you need to change it to 1 and remove the # char at the start of the line.

For advanced modding please read [http://forums.atomictorch.com/index.php?topic=1027.0 modding prerequisites].

== Server raiding hours (for PvP) ==
'''(Please note: with A27 this feature is not recommend anymore as there is a better feature now ΓÇö S.H.I.E.L.D. protection that is enabled by default for PvP servers)'''

On PvP server, you could set up specific hours during which the raiding is possible.
 By default, offline raiding protection is not enabled so players could raid other players' bases at any time.
 To enable offline raiding protection, please use this in-game console command:
 <code>/admin.setRaidingWindow 4 14 1.5</code>
 In this code we're using (first number) +4 GMT/UTC timezone, (second number) hour of day when raiding is possible (value from 0 to 24), and (third number) is the duration of the raiding window (value from 0 to 24).
 So the code in the example will allow raiding from 14:00 (or 2PM) for 1.5 hours.
 After changing the value you could open Politics/Diplomacy menu ([P] key) and verify whether you set the correct numbers.
 Please note that Politics/Diplomacy menu displaying your local time (in your PC timezone)!

== How to prohibit client modifications ==
If you wish to restrict usage of any client modifications on your server, please find "<no_client_mods>" setting in the SettingsServer.xml file. Change the value from 0 to 1 to enable this feature. It's recommended for PvP servers to set it to 1. You can read more details about this feature in [https://atomictorch.com/Post/Id2218/A28-Justice-Update-Release A28 Update announcement].

CryoFall/Server/Setup

2021-10-18T13:51:31Z

Ai enabled: /* How to setup your own server (on any OS): */

= Local server / Singleplayer =
Starting with R31 "Singleplayer Update" the local server is seamlessly integrated into the game client. Other players can also connect to you over LAN (new tab in Multiplayer menu) and even over the internet with virtual LAN (with software such as Hamachi).

= Using game server hosting providers =

==== Game server rent service ====
''If you don't want to hassle with the game server setup, you can rent your own CryoFall server from any third party game server hosting company in just a few minutes. They provide data center locations in almost every country around the world!''
* [https://pingperfect.com/gameservers/cryofall-game-server-hosting-rental.php?aff=586 PingPerfect]
* [https://gameserver.4players.de/server-hosting/cryofall-server-mieten/ 4PLAYERS] (the website is available in German only)
''Please note that AtomicTorch Studio is not affiliated with any of these companies and not responsible for their service quality so in case of any issues please reach them directly. So far we've heard only positive feedback about their services.''

= Self-hosting =

== Requirements ==
====Hardware requirements====
(for up to about 30 players online) 1-core CPU 1.6-2 GHz, 1.5 GB RAM, 2-3 Mbit/s bandwidth (each way)
 (for up to about 100 players online) 2-core CPU 1.6-2 GHz, 2 GB RAM, 3-6 Mbit/s bandwidth
 (for up to about 200 players online) 2-core CPU 2.4-3 GHz, 2 GB RAM, 6-12 Mbit/s bandwidth
 (for up to about 300 players online) 2-core CPU 3+ GHz, 2.5 GB RAM, 12-20 Mbit/s bandwidth
 Usually, VPS (virtual machines) hosting such as [https://www.vultr.com/?ref=7238385 Vultr.com] (this is our referral link as we're using this company services to host our own servers) is sufficient for hosting a game server. Using 1-core machines is not recommended as the game requires a secondary CPU to ensure smooth performance without hiccups during intensive background operations (such as world snapshot saving). Using more than a 2-core machine for a single game server hosting is redundant as the game cannot utilize more than two cores due to the sequential execution of the game simulation (except networking).

====Software (system) requirements====
The server could run on Windows, Linux, and Mac.
To achieve this the game server is using .NET Runtime 5.0.
For hosting the official game servers we prefer using CentOS 7 with Docker or CentOS 8 with podman (OSS alternative to Docker).

== Server installation with Docker (best way for Linux) ==
We recommend this for Linux only. Please follow this guide [https://hub.docker.com/r/atomictorch/cryofall-server CryoFall Dedicated Server Docker Image] then return back here to '''"Server installation"''' section and follow the list after number 7. Ignore instructions on how to start the server with "dotnet" as you should use "docker run ..." instead as explained in the Docker guide above.

== Server installation / direct download (Windows, Linux, Mac) ==

==== How to setup your own server (on any OS): ====
# Install .NET Runtime 5.0 x64ΓÇöplease visit [https://dotnet.microsoft.com/download/dotnet/5.0/runtime Download .NET page] and follow the installation guide for your OS.
# Download the game server package. There are several ways to do this:
## You can download it directly from our website:
### '''[https://atomictorch.com/Files/CryoFall_Server_v1.31.7.2.zip SERVER DOWNLOAD LINK (any OS)]'''
### Extract the downloaded package (it's a regular ZIP archive).
## Alternatively, you can download it from '''Steam Client''': ''(preferable, as this way you can easily download updates)''
### Launch Steam Client
### Select LIBRARY tab
### Click on "ALL" and toggle "Tools"
### Search for "CryoFall Dedicated Server" and install it
## Alternatively, you can download it with '''SteamCMD''' (if you're familiar with it):
### launch SteamCMD
### enter:
###: <code>
###: login anonymous
###: app_update 1061710
###: </code>
### navigate to the installation folder (usually in steamapps/Common/CryoFall Dedicated Server)
# The server executable is located in the subfolder: "Binaries/Server". Open the command line/terminal/SSH (or PowerShell in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable first time with <code>loadOrNew</code> flag. The server will start and create the game world.
#:<code>dotnet CryoFall_Server.dll loadOrNew</code>
# Usually it takes about 1-2 minutes to create a new world (or load a savegame). After that the server will keep writing performance statistics information every 20 seconds among other information such as the spawn scripts reporting and network events.
# Stop the server. To do so enter the command below and press Enter key.
#:<code>stop 0</code>
#The server will save and quit. Now you have the "SettingsServer.xml" and "ModsConfig.xml" files.
# Now you need to navigate to the subfolder "Data" (in the root of the server folder, '''not''' in the "Binaries/Server") and modify "SettingsServer.xml" to set the unique server '''name''' and set other settings, etc (there are XML comments explaining every setting so it should be straightforward). ''Please note that you can (and should) edit '''Description''' and '''Welcome message''' from the '''CURRENT GAME''' menu right from the game after connecting to your server.''
# If you are interested in making your server visible in the community servers list make sure to edit <is_public_server> and change the value from 0 to 1. Also, please make sure your router is configured correctly (port forwarding) to enable other people to connect to your machine from outside. But ideally, you should use dedicated server hardware (VPS or VDS) to host public servers.
# While you're still editing "SettingsServer.xml" file, please find the value '''<server_operators_list>''' and change it to include '''your nickname'''! Otherwise, you will be unable to access your server console from the game and also you will be unable to edit the server's Description and Welcome message.
# If you want to have a custom server icon, please replace the ServerIcon.png file in the "Data" subfolder. The icon image file requirements: '''PNG24 format, 256x256 size, up to 100 KB'''.

'''Important (for Windows only):''' you need to allow the dotnet process in the Windows Firewall settingsΓÇöif the Firewall access request was not shown automatically by Windows you can add the <code>C:\Program Files\dotnet\dotnet.exe</code> file into Firewall whitelist. To do this, open Windows Start menu and search for "Allow an app through Windows Firewall" -> button "Allow another app".

==== Starting the server ====
# Launch the command line (we recommending '''PowerShell''' in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable with <code>load</code> flag.
#:<code>dotnet CryoFall_Server.dll load</code>
# Stop your server by typing command below and pressing Enter key (it will save the world before stopping).
#:<code>stop 60 The shutdown message text goes here</code>
(Where <code>60</code> is the shutdown delay (in seconds) so the connected players will have some time to find a safe location)

'''''Please note that typing this message is really hard as the console is updating regularly! The best way is to simply copy-paste from the text editor the whole command text into the game console window (hint: you can paste in PowerShell by simply pressing the right mouse button) and pressing Enter key.'''''

You can always wipe the world by launching the game with <code>new</code> flag:
:<code>dotnet CryoFall_Server.dll new</code>

Currently, we don't support the savegame migration between the major game versions (if there are changes to the game data serialization scheme). We plan to implement the proper data migration feature ASAP.

==== Connecting to the server ====
If you want to connect to your local game server, simply add SERVERS->Custom list as <code>localhost</code>

To connect to the public server you need to navigate to SERVERS->Community servers list (please note that this might not work if you host this server on the same PC as the client, read below).

If you're attempting to host your server on a home computer and other players cannot connect to it, you need to manually forward the port '''UDP 6000''' on your home router to '''your local IP address''' (the game has the auto port forwarding feature but it often fails due to the difference in UPnP implementation on many routers). E.g. if your PC's IP address in local network is 192.168.1.100 (you can check it with ipconfig tool or in Windows network adapter's settings) you will need to setup a port forward rule on your router to forward traffic from port 6000 UDP to port 6000 UDP on IP address 192.168.1.100.

'''If you're running a game server on the same PC as the game client:'''
 Please note that you might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its address as <code>localhost:6000</code> and connect to it directly.

'''If you're running a game server in the same local network as the game client (for example you want to play over LAN with your friends and family):'''
 You might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its local IP address (IPv4) and connect to it directly. To get your local IP address please use ipconfig command-line tool or check the network adapter properties in the network center. You need to get the local network IP address of the PC that is hosting the game server. Then add it in the custom servers list on your PC. You can lookup the IP address in the Windows network settings or by using CMD tool called ipconfig in Windows. For example, here we've run the ipconfig tool here and see the IPv4 address as 192.168.1.200 ([https://cdn.discordapp.com/attachments/421250395298332672/739147674367950908/Screenshot_at_19-48-06.png screenshot]). We can use it on any other PC in the local network to connect to that PC hosting the game server.

Connecting to the private servers requires adding it via the Custom servers menu.

6000 is the default port but you can change it in the Data/SettingsServer.xml file.

== Server update/upgrade to new version ==
When we're releasing a new version of the game server, you need to follow these steps to update it:
# (If you have not done this) Install ".NET Runtime" (version 5.0) https://dotnet.microsoft.com/download/dotnet/5.0/runtime
# Ensure you've made a '''backup''' of the "'''Data'''" folder inside the game server installation folder.
# If you're updating from A28 or earlier versions, DELETE "Data/Saves" folder as the savegame is not compatible (breaking changes). Update from A29 to R30/R31 (or to any patch versions) '''doesn't require this step''' (savegame is compatible).
# Download the new version of the server and overwrite your current installation with it (you can find the actual download link above in the "Installation" section).
# Stop the game server (if it's running).
# Important: please '''overwrite''' both Binaries and Core folders!
# Start the server as usual.

== Server commands ==
# Ensure you're the server operator (you've edited the ServerSettings.xml file and added yourself into the server_operators_list).
# Connect to your game server.
# The game console can be toggled by pressing <code>~</code> (the key on the left from <code>1</code> key) like in old-school games (you can change the key binding for console in the controls options).
# Please add <code>/</code> (slash) prefix to the server commands you want to execute.
# You can use '''Tab''' key to fill autocomplete, and you can use '''arrow Up/Down keys''' to navigate the suggestions list. Press '''Tab''' or '''Enter''' to accept the suggestion.

Here is the page with the server commands list: [[CryoFall/Server/Commands|Server Commands List]]

== Moderation (whitelist, blacklist, kicking, muting) ==
Server operator can access special moderation commands. To invoke these commands, please ensure you're the server operator, connect to your game server, open the console (~ key) and then you can use these commands: (replace username with the actual player nickname)

Whitelist management:

<code>/mod.whiteList.add username</code>

<code>/mod.whiteList.remove username</code>

<code>/mod.whiteList.print</code>

To enable whitelist:

<code>/mod.whiteList.enabled 1</code>

Blacklist management:

<code>/mod.blackList.add username</code>

<code>/mod.blackList.remove username</code>

<code>/mod.blackList.print</code>

Kicking players (temporary removing from server and blocking from connecting):

<code>/mod.kickList.add username durationInMinutes</code>

<code>/mod.kickList.remove username</code>

<code>/mod.kickList.print</code>

Muting players (temporary removing their ability to send messages to chat):

<code>/mod.muteList.add username durationInMinutes</code>

<code>/mod.muteList.remove username</code>

<code>/mod.muteList.print</code>

== Server rates adjusting / Enabling PvP mode ==
Server rates (and PvP mode setting) are exposed in a separate config file. You can quickly change things like LP gain rate, increase item drops, reduce the player to player damage to zero, or even increase the damage from creatures and make it really tough for the players!

To adjust the server rates, stop the server and check the file <game server>/Data/ServerRates.config
Please read carefullyΓÇöall the rates are disabled and in order to apply them '''you need to remove the # char at the start of the line'''!

If you want to '''enable PvP''', search PvP in the file. By default, this setting's value is 0 and you need to change it to 1 and remove the # char at the start of the line.

For advanced modding please read [http://forums.atomictorch.com/index.php?topic=1027.0 modding prerequisites].

== Server raiding hours (for PvP) ==
'''(Please note: with A27 this feature is not recommend anymore as there is a better feature now ΓÇö S.H.I.E.L.D. protection that is enabled by default for PvP servers)'''

On PvP server, you could set up specific hours during which the raiding is possible.
 By default, offline raiding protection is not enabled so players could raid other players' bases at any time.
 To enable offline raiding protection, please use this in-game console command:
 <code>/admin.setRaidingWindow 4 14 1.5</code>
 In this code we're using (first number) +4 GMT/UTC timezone, (second number) hour of day when raiding is possible (value from 0 to 24), and (third number) is the duration of the raiding window (value from 0 to 24).
 So the code in the example will allow raiding from 14:00 (or 2PM) for 1.5 hours.
 After changing the value you could open Politics/Diplomacy menu ([P] key) and verify whether you set the correct numbers.
 Please note that Politics/Diplomacy menu displaying your local time (in your PC timezone)!

== How to prohibit client modifications ==
If you wish to restrict usage of any client modifications on your server, please find "<no_client_mods>" setting in the SettingsServer.xml file. Change the value from 0 to 1 to enable this feature. It's recommended for PvP servers to set it to 1. You can read more details about this feature in [https://atomictorch.com/Post/Id2218/A28-Justice-Update-Release A28 Update announcement].

CryoFall/Server/Setup

2021-10-12T23:49:15Z

Ai enabled: /* How to setup your own server (on any OS): */

= Local server / Singleplayer =
Starting with R31 "Singleplayer Update" the local server is seamlessly integrated into the game client. Other players can also connect to you over LAN (new tab in Multiplayer menu) and even over the internet with virtual LAN (with software such as Hamachi).

= Using game server hosting providers =

==== Game server rent service ====
''If you don't want to hassle with the game server setup, you can rent your own CryoFall server from any third party game server hosting company in just a few minutes. They provide data center locations in almost every country around the world!''
* [https://pingperfect.com/gameservers/cryofall-game-server-hosting-rental.php?aff=586 PingPerfect]
* [https://gameserver.4players.de/server-hosting/cryofall-server-mieten/ 4PLAYERS] (the website is available in German only)
''Please note that AtomicTorch Studio is not affiliated with any of these companies and not responsible for their service quality so in case of any issues please reach them directly. So far we've heard only positive feedback about their services.''

= Self-hosting =

== Requirements ==
====Hardware requirements====
(for up to about 30 players online) 1-core CPU 1.6-2 GHz, 1.5 GB RAM, 2-3 Mbit/s bandwidth (each way)
 (for up to about 100 players online) 2-core CPU 1.6-2 GHz, 2 GB RAM, 3-6 Mbit/s bandwidth
 (for up to about 200 players online) 2-core CPU 2.4-3 GHz, 2 GB RAM, 6-12 Mbit/s bandwidth
 (for up to about 300 players online) 2-core CPU 3+ GHz, 2.5 GB RAM, 12-20 Mbit/s bandwidth
 Usually, VPS (virtual machines) hosting such as [https://www.vultr.com/?ref=7238385 Vultr.com] (this is our referral link as we're using this company services to host our own servers) is sufficient for hosting a game server. Using 1-core machines is not recommended as the game requires a secondary CPU to ensure smooth performance without hiccups during intensive background operations (such as world snapshot saving). Using more than a 2-core machine for a single game server hosting is redundant as the game cannot utilize more than two cores due to the sequential execution of the game simulation (except networking).

====Software (system) requirements====
The server could run on Windows, Linux, and Mac.
To achieve this the game server is using .NET Runtime 5.0.
For hosting the official game servers we prefer using CentOS 7 with Docker or CentOS 8 with podman (OSS alternative to Docker).

== Server installation with Docker (best way for Linux) ==
We recommend this for Linux only. Please follow this guide [https://hub.docker.com/r/atomictorch/cryofall-server CryoFall Dedicated Server Docker Image] then return back here to '''"Server installation"''' section and follow the list after number 7. Ignore instructions on how to start the server with "dotnet" as you should use "docker run ..." instead as explained in the Docker guide above.

== Server installation / direct download (Windows, Linux, Mac) ==

==== How to setup your own server (on any OS): ====
# Install .NET Runtime 5.0 x64ΓÇöplease visit [https://dotnet.microsoft.com/download/dotnet/5.0/runtime Download .NET page] and follow the installation guide for your OS.
# Download the game server package. There are several ways to do this:
## You can download it directly from our website:
### '''[https://atomictorch.com/Files/CryoFall_Server_v1.31.6.8.zip SERVER DOWNLOAD LINK (any OS)]'''
### Extract the downloaded package (it's a regular ZIP archive).
## Alternatively, you can download it from '''Steam Client''': ''(preferable, as this way you can easily download updates)''
### Launch Steam Client
### Select LIBRARY tab
### Click on "ALL" and toggle "Tools"
### Search for "CryoFall Dedicated Server" and install it
## Alternatively, you can download it with '''SteamCMD''' (if you're familiar with it):
### launch SteamCMD
### enter:
###: <code>
###: login anonymous
###: app_update 1061710
###: </code>
### navigate to the installation folder (usually in steamapps/Common/CryoFall Dedicated Server)
# The server executable is located in the subfolder: "Binaries/Server". Open the command line/terminal/SSH (or PowerShell in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable first time with <code>loadOrNew</code> flag. The server will start and create the game world.
#:<code>dotnet CryoFall_Server.dll loadOrNew</code>
# Usually it takes about 1-2 minutes to create a new world (or load a savegame). After that the server will keep writing performance statistics information every 20 seconds among other information such as the spawn scripts reporting and network events.
# Stop the server. To do so enter the command below and press Enter key.
#:<code>stop 0</code>
#The server will save and quit. Now you have the "SettingsServer.xml" and "ModsConfig.xml" files.
# Now you need to navigate to the subfolder "Data" (in the root of the server folder, '''not''' in the "Binaries/Server") and modify "SettingsServer.xml" to set the unique server '''name''' and set other settings, etc (there are XML comments explaining every setting so it should be straightforward). ''Please note that you can (and should) edit '''Description''' and '''Welcome message''' from the '''CURRENT GAME''' menu right from the game after connecting to your server.''
# If you are interested in making your server visible in the community servers list make sure to edit <is_public_server> and change the value from 0 to 1. Also, please make sure your router is configured correctly (port forwarding) to enable other people to connect to your machine from outside. But ideally, you should use dedicated server hardware (VPS or VDS) to host public servers.
# While you're still editing "SettingsServer.xml" file, please find the value '''<server_operators_list>''' and change it to include '''your nickname'''! Otherwise, you will be unable to access your server console from the game and also you will be unable to edit the server's Description and Welcome message.
# If you want to have a custom server icon, please replace the ServerIcon.png file in the "Data" subfolder. The icon image file requirements: '''PNG24 format, 256x256 size, up to 100 KB'''.

'''Important (for Windows only):''' you need to allow the dotnet process in the Windows Firewall settingsΓÇöif the Firewall access request was not shown automatically by Windows you can add the <code>C:\Program Files\dotnet\dotnet.exe</code> file into Firewall whitelist. To do this, open Windows Start menu and search for "Allow an app through Windows Firewall" -> button "Allow another app".

==== Starting the server ====
# Launch the command line (we recommending '''PowerShell''' in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable with <code>load</code> flag.
#:<code>dotnet CryoFall_Server.dll load</code>
# Stop your server by typing command below and pressing Enter key (it will save the world before stopping).
#:<code>stop 60 The shutdown message text goes here</code>
(Where <code>60</code> is the shutdown delay (in seconds) so the connected players will have some time to find a safe location)

'''''Please note that typing this message is really hard as the console is updating regularly! The best way is to simply copy-paste from the text editor the whole command text into the game console window (hint: you can paste in PowerShell by simply pressing the right mouse button) and pressing Enter key.'''''

You can always wipe the world by launching the game with <code>new</code> flag:
:<code>dotnet CryoFall_Server.dll new</code>

Currently, we don't support the savegame migration between the major game versions (if there are changes to the game data serialization scheme). We plan to implement the proper data migration feature ASAP.

==== Connecting to the server ====
If you want to connect to your local game server, simply add SERVERS->Custom list as <code>localhost</code>

To connect to the public server you need to navigate to SERVERS->Community servers list (please note that this might not work if you host this server on the same PC as the client, read below).

If you're attempting to host your server on a home computer and other players cannot connect to it, you need to manually forward the port '''UDP 6000''' on your home router to '''your local IP address''' (the game has the auto port forwarding feature but it often fails due to the difference in UPnP implementation on many routers). E.g. if your PC's IP address in local network is 192.168.1.100 (you can check it with ipconfig tool or in Windows network adapter's settings) you will need to setup a port forward rule on your router to forward traffic from port 6000 UDP to port 6000 UDP on IP address 192.168.1.100.

'''If you're running a game server on the same PC as the game client:'''
 Please note that you might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its address as <code>localhost:6000</code> and connect to it directly.

'''If you're running a game server in the same local network as the game client (for example you want to play over LAN with your friends and family):'''
 You might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its local IP address (IPv4) and connect to it directly. To get your local IP address please use ipconfig command-line tool or check the network adapter properties in the network center. You need to get the local network IP address of the PC that is hosting the game server. Then add it in the custom servers list on your PC. You can lookup the IP address in the Windows network settings or by using CMD tool called ipconfig in Windows. For example, here we've run the ipconfig tool here and see the IPv4 address as 192.168.1.200 ([https://cdn.discordapp.com/attachments/421250395298332672/739147674367950908/Screenshot_at_19-48-06.png screenshot]). We can use it on any other PC in the local network to connect to that PC hosting the game server.

Connecting to the private servers requires adding it via the Custom servers menu.

6000 is the default port but you can change it in the Data/SettingsServer.xml file.

== Server update/upgrade to new version ==
When we're releasing a new version of the game server, you need to follow these steps to update it:
# (If you have not done this) Install ".NET Runtime" (version 5.0) https://dotnet.microsoft.com/download/dotnet/5.0/runtime
# Ensure you've made a '''backup''' of the "'''Data'''" folder inside the game server installation folder.
# If you're updating from A28 or earlier versions, DELETE "Data/Saves" folder as the savegame is not compatible (breaking changes). Update from A29 to R30/R31 (or to any patch versions) '''doesn't require this step''' (savegame is compatible).
# Download the new version of the server and overwrite your current installation with it (you can find the actual download link above in the "Installation" section).
# Stop the game server (if it's running).
# Important: please '''overwrite''' both Binaries and Core folders!
# Start the server as usual.

== Server commands ==
# Ensure you're the server operator (you've edited the ServerSettings.xml file and added yourself into the server_operators_list).
# Connect to your game server.
# The game console can be toggled by pressing <code>~</code> (the key on the left from <code>1</code> key) like in old-school games (you can change the key binding for console in the controls options).
# Please add <code>/</code> (slash) prefix to the server commands you want to execute.
# You can use '''Tab''' key to fill autocomplete, and you can use '''arrow Up/Down keys''' to navigate the suggestions list. Press '''Tab''' or '''Enter''' to accept the suggestion.

Here is the page with the server commands list: [[CryoFall/Server/Commands|Server Commands List]]

== Moderation (whitelist, blacklist, kicking, muting) ==
Server operator can access special moderation commands. To invoke these commands, please ensure you're the server operator, connect to your game server, open the console (~ key) and then you can use these commands: (replace username with the actual player nickname)

Whitelist management:

<code>/mod.whiteList.add username</code>

<code>/mod.whiteList.remove username</code>

<code>/mod.whiteList.print</code>

To enable whitelist:

<code>/mod.whiteList.enabled 1</code>

Blacklist management:

<code>/mod.blackList.add username</code>

<code>/mod.blackList.remove username</code>

<code>/mod.blackList.print</code>

Kicking players (temporary removing from server and blocking from connecting):

<code>/mod.kickList.add username durationInMinutes</code>

<code>/mod.kickList.remove username</code>

<code>/mod.kickList.print</code>

Muting players (temporary removing their ability to send messages to chat):

<code>/mod.muteList.add username durationInMinutes</code>

<code>/mod.muteList.remove username</code>

<code>/mod.muteList.print</code>

== Server rates adjusting / Enabling PvP mode ==
Server rates (and PvP mode setting) are exposed in a separate config file. You can quickly change things like LP gain rate, increase item drops, reduce the player to player damage to zero, or even increase the damage from creatures and make it really tough for the players!

To adjust the server rates, stop the server and check the file <game server>/Data/ServerRates.config
Please read carefullyΓÇöall the rates are disabled and in order to apply them '''you need to remove the # char at the start of the line'''!

If you want to '''enable PvP''', search PvP in the file. By default, this setting's value is 0 and you need to change it to 1 and remove the # char at the start of the line.

For advanced modding please read [http://forums.atomictorch.com/index.php?topic=1027.0 modding prerequisites].

== Server raiding hours (for PvP) ==
'''(Please note: with A27 this feature is not recommend anymore as there is a better feature now ΓÇö S.H.I.E.L.D. protection that is enabled by default for PvP servers)'''

On PvP server, you could set up specific hours during which the raiding is possible.
 By default, offline raiding protection is not enabled so players could raid other players' bases at any time.
 To enable offline raiding protection, please use this in-game console command:
 <code>/admin.setRaidingWindow 4 14 1.5</code>
 In this code we're using (first number) +4 GMT/UTC timezone, (second number) hour of day when raiding is possible (value from 0 to 24), and (third number) is the duration of the raiding window (value from 0 to 24).
 So the code in the example will allow raiding from 14:00 (or 2PM) for 1.5 hours.
 After changing the value you could open Politics/Diplomacy menu ([P] key) and verify whether you set the correct numbers.
 Please note that Politics/Diplomacy menu displaying your local time (in your PC timezone)!

== How to prohibit client modifications ==
If you wish to restrict usage of any client modifications on your server, please find "<no_client_mods>" setting in the SettingsServer.xml file. Change the value from 0 to 1 to enable this feature. It's recommended for PvP servers to set it to 1. You can read more details about this feature in [https://atomictorch.com/Post/Id2218/A28-Justice-Update-Release A28 Update announcement].

CryoFall/Server/Setup

2021-10-12T23:48:56Z

Ai enabled: /* How to setup your own server (on any OS): */

= Local server / Singleplayer =
Starting with R31 "Singleplayer Update" the local server is seamlessly integrated into the game client. Other players can also connect to you over LAN (new tab in Multiplayer menu) and even over the internet with virtual LAN (with software such as Hamachi).

= Using game server hosting providers =

==== Game server rent service ====
''If you don't want to hassle with the game server setup, you can rent your own CryoFall server from any third party game server hosting company in just a few minutes. They provide data center locations in almost every country around the world!''
* [https://pingperfect.com/gameservers/cryofall-game-server-hosting-rental.php?aff=586 PingPerfect]
* [https://gameserver.4players.de/server-hosting/cryofall-server-mieten/ 4PLAYERS] (the website is available in German only)
''Please note that AtomicTorch Studio is not affiliated with any of these companies and not responsible for their service quality so in case of any issues please reach them directly. So far we've heard only positive feedback about their services.''

= Self-hosting =

== Requirements ==
====Hardware requirements====
(for up to about 30 players online) 1-core CPU 1.6-2 GHz, 1.5 GB RAM, 2-3 Mbit/s bandwidth (each way)
 (for up to about 100 players online) 2-core CPU 1.6-2 GHz, 2 GB RAM, 3-6 Mbit/s bandwidth
 (for up to about 200 players online) 2-core CPU 2.4-3 GHz, 2 GB RAM, 6-12 Mbit/s bandwidth
 (for up to about 300 players online) 2-core CPU 3+ GHz, 2.5 GB RAM, 12-20 Mbit/s bandwidth
 Usually, VPS (virtual machines) hosting such as [https://www.vultr.com/?ref=7238385 Vultr.com] (this is our referral link as we're using this company services to host our own servers) is sufficient for hosting a game server. Using 1-core machines is not recommended as the game requires a secondary CPU to ensure smooth performance without hiccups during intensive background operations (such as world snapshot saving). Using more than a 2-core machine for a single game server hosting is redundant as the game cannot utilize more than two cores due to the sequential execution of the game simulation (except networking).

====Software (system) requirements====
The server could run on Windows, Linux, and Mac.
To achieve this the game server is using .NET Runtime 5.0.
For hosting the official game servers we prefer using CentOS 7 with Docker or CentOS 8 with podman (OSS alternative to Docker).

== Server installation with Docker (best way for Linux) ==
We recommend this for Linux only. Please follow this guide [https://hub.docker.com/r/atomictorch/cryofall-server CryoFall Dedicated Server Docker Image] then return back here to '''"Server installation"''' section and follow the list after number 7. Ignore instructions on how to start the server with "dotnet" as you should use "docker run ..." instead as explained in the Docker guide above.

== Server installation / direct download (Windows, Linux, Mac) ==

==== How to setup your own server (on any OS): ====
# Install .NET Runtime 5.0 x64ΓÇöplease visit [https://dotnet.microsoft.com/download/dotnet/5.0/runtime Download .NET page] and follow the installation guide for your OS.
# Download the game server package. There are several ways to do this:
## You can download it directly from our website:
### '''[https://atomictorch.com/Files/CryoFall_Server_v1.31.6.8.zip SERVER DOWNLOAD LINK (any OS)]'''
### Extract the downloaded package (it's a regular ZIP archive).
## Alternatively, you can download it from '''Steam Client''': (preferable, as this way you can easily download updates)
### Launch Steam Client
### Select LIBRARY tab
### Click on "ALL" and toggle "Tools"
### Search for "CryoFall Dedicated Server" and install it
## Alternatively, you can download it with '''SteamCMD''' (if you're familiar with it):
### launch SteamCMD
### enter:
###: <code>
###: login anonymous
###: app_update 1061710
###: </code>
### navigate to the installation folder (usually in steamapps/Common/CryoFall Dedicated Server)
# The server executable is located in the subfolder: "Binaries/Server". Open the command line/terminal/SSH (or PowerShell in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable first time with <code>loadOrNew</code> flag. The server will start and create the game world.
#:<code>dotnet CryoFall_Server.dll loadOrNew</code>
# Usually it takes about 1-2 minutes to create a new world (or load a savegame). After that the server will keep writing performance statistics information every 20 seconds among other information such as the spawn scripts reporting and network events.
# Stop the server. To do so enter the command below and press Enter key.
#:<code>stop 0</code>
#The server will save and quit. Now you have the "SettingsServer.xml" and "ModsConfig.xml" files.
# Now you need to navigate to the subfolder "Data" (in the root of the server folder, '''not''' in the "Binaries/Server") and modify "SettingsServer.xml" to set the unique server '''name''' and set other settings, etc (there are XML comments explaining every setting so it should be straightforward). ''Please note that you can (and should) edit '''Description''' and '''Welcome message''' from the '''CURRENT GAME''' menu right from the game after connecting to your server.''
# If you are interested in making your server visible in the community servers list make sure to edit <is_public_server> and change the value from 0 to 1. Also, please make sure your router is configured correctly (port forwarding) to enable other people to connect to your machine from outside. But ideally, you should use dedicated server hardware (VPS or VDS) to host public servers.
# While you're still editing "SettingsServer.xml" file, please find the value '''<server_operators_list>''' and change it to include '''your nickname'''! Otherwise, you will be unable to access your server console from the game and also you will be unable to edit the server's Description and Welcome message.
# If you want to have a custom server icon, please replace the ServerIcon.png file in the "Data" subfolder. The icon image file requirements: '''PNG24 format, 256x256 size, up to 100 KB'''.

'''Important (for Windows only):''' you need to allow the dotnet process in the Windows Firewall settingsΓÇöif the Firewall access request was not shown automatically by Windows you can add the <code>C:\Program Files\dotnet\dotnet.exe</code> file into Firewall whitelist. To do this, open Windows Start menu and search for "Allow an app through Windows Firewall" -> button "Allow another app".

==== Starting the server ====
# Launch the command line (we recommending '''PowerShell''' in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable with <code>load</code> flag.
#:<code>dotnet CryoFall_Server.dll load</code>
# Stop your server by typing command below and pressing Enter key (it will save the world before stopping).
#:<code>stop 60 The shutdown message text goes here</code>
(Where <code>60</code> is the shutdown delay (in seconds) so the connected players will have some time to find a safe location)

'''''Please note that typing this message is really hard as the console is updating regularly! The best way is to simply copy-paste from the text editor the whole command text into the game console window (hint: you can paste in PowerShell by simply pressing the right mouse button) and pressing Enter key.'''''

You can always wipe the world by launching the game with <code>new</code> flag:
:<code>dotnet CryoFall_Server.dll new</code>

Currently, we don't support the savegame migration between the major game versions (if there are changes to the game data serialization scheme). We plan to implement the proper data migration feature ASAP.

==== Connecting to the server ====
If you want to connect to your local game server, simply add SERVERS->Custom list as <code>localhost</code>

To connect to the public server you need to navigate to SERVERS->Community servers list (please note that this might not work if you host this server on the same PC as the client, read below).

If you're attempting to host your server on a home computer and other players cannot connect to it, you need to manually forward the port '''UDP 6000''' on your home router to '''your local IP address''' (the game has the auto port forwarding feature but it often fails due to the difference in UPnP implementation on many routers). E.g. if your PC's IP address in local network is 192.168.1.100 (you can check it with ipconfig tool or in Windows network adapter's settings) you will need to setup a port forward rule on your router to forward traffic from port 6000 UDP to port 6000 UDP on IP address 192.168.1.100.

'''If you're running a game server on the same PC as the game client:'''
 Please note that you might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its address as <code>localhost:6000</code> and connect to it directly.

'''If you're running a game server in the same local network as the game client (for example you want to play over LAN with your friends and family):'''
 You might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its local IP address (IPv4) and connect to it directly. To get your local IP address please use ipconfig command-line tool or check the network adapter properties in the network center. You need to get the local network IP address of the PC that is hosting the game server. Then add it in the custom servers list on your PC. You can lookup the IP address in the Windows network settings or by using CMD tool called ipconfig in Windows. For example, here we've run the ipconfig tool here and see the IPv4 address as 192.168.1.200 ([https://cdn.discordapp.com/attachments/421250395298332672/739147674367950908/Screenshot_at_19-48-06.png screenshot]). We can use it on any other PC in the local network to connect to that PC hosting the game server.

Connecting to the private servers requires adding it via the Custom servers menu.

6000 is the default port but you can change it in the Data/SettingsServer.xml file.

== Server update/upgrade to new version ==
When we're releasing a new version of the game server, you need to follow these steps to update it:
# (If you have not done this) Install ".NET Runtime" (version 5.0) https://dotnet.microsoft.com/download/dotnet/5.0/runtime
# Ensure you've made a '''backup''' of the "'''Data'''" folder inside the game server installation folder.
# If you're updating from A28 or earlier versions, DELETE "Data/Saves" folder as the savegame is not compatible (breaking changes). Update from A29 to R30/R31 (or to any patch versions) '''doesn't require this step''' (savegame is compatible).
# Download the new version of the server and overwrite your current installation with it (you can find the actual download link above in the "Installation" section).
# Stop the game server (if it's running).
# Important: please '''overwrite''' both Binaries and Core folders!
# Start the server as usual.

== Server commands ==
# Ensure you're the server operator (you've edited the ServerSettings.xml file and added yourself into the server_operators_list).
# Connect to your game server.
# The game console can be toggled by pressing <code>~</code> (the key on the left from <code>1</code> key) like in old-school games (you can change the key binding for console in the controls options).
# Please add <code>/</code> (slash) prefix to the server commands you want to execute.
# You can use '''Tab''' key to fill autocomplete, and you can use '''arrow Up/Down keys''' to navigate the suggestions list. Press '''Tab''' or '''Enter''' to accept the suggestion.

Here is the page with the server commands list: [[CryoFall/Server/Commands|Server Commands List]]

== Moderation (whitelist, blacklist, kicking, muting) ==
Server operator can access special moderation commands. To invoke these commands, please ensure you're the server operator, connect to your game server, open the console (~ key) and then you can use these commands: (replace username with the actual player nickname)

Whitelist management:

<code>/mod.whiteList.add username</code>

<code>/mod.whiteList.remove username</code>

<code>/mod.whiteList.print</code>

To enable whitelist:

<code>/mod.whiteList.enabled 1</code>

Blacklist management:

<code>/mod.blackList.add username</code>

<code>/mod.blackList.remove username</code>

<code>/mod.blackList.print</code>

Kicking players (temporary removing from server and blocking from connecting):

<code>/mod.kickList.add username durationInMinutes</code>

<code>/mod.kickList.remove username</code>

<code>/mod.kickList.print</code>

Muting players (temporary removing their ability to send messages to chat):

<code>/mod.muteList.add username durationInMinutes</code>

<code>/mod.muteList.remove username</code>

<code>/mod.muteList.print</code>

== Server rates adjusting / Enabling PvP mode ==
Server rates (and PvP mode setting) are exposed in a separate config file. You can quickly change things like LP gain rate, increase item drops, reduce the player to player damage to zero, or even increase the damage from creatures and make it really tough for the players!

To adjust the server rates, stop the server and check the file <game server>/Data/ServerRates.config
Please read carefullyΓÇöall the rates are disabled and in order to apply them '''you need to remove the # char at the start of the line'''!

If you want to '''enable PvP''', search PvP in the file. By default, this setting's value is 0 and you need to change it to 1 and remove the # char at the start of the line.

For advanced modding please read [http://forums.atomictorch.com/index.php?topic=1027.0 modding prerequisites].

== Server raiding hours (for PvP) ==
'''(Please note: with A27 this feature is not recommend anymore as there is a better feature now ΓÇö S.H.I.E.L.D. protection that is enabled by default for PvP servers)'''

On PvP server, you could set up specific hours during which the raiding is possible.
 By default, offline raiding protection is not enabled so players could raid other players' bases at any time.
 To enable offline raiding protection, please use this in-game console command:
 <code>/admin.setRaidingWindow 4 14 1.5</code>
 In this code we're using (first number) +4 GMT/UTC timezone, (second number) hour of day when raiding is possible (value from 0 to 24), and (third number) is the duration of the raiding window (value from 0 to 24).
 So the code in the example will allow raiding from 14:00 (or 2PM) for 1.5 hours.
 After changing the value you could open Politics/Diplomacy menu ([P] key) and verify whether you set the correct numbers.
 Please note that Politics/Diplomacy menu displaying your local time (in your PC timezone)!

== How to prohibit client modifications ==
If you wish to restrict usage of any client modifications on your server, please find "<no_client_mods>" setting in the SettingsServer.xml file. Change the value from 0 to 1 to enable this feature. It's recommended for PvP servers to set it to 1. You can read more details about this feature in [https://atomictorch.com/Post/Id2218/A28-Justice-Update-Release A28 Update announcement].

CryoFall/Server/Setup

2021-10-12T23:48:20Z

Ai enabled: /* How to setup your own server (on any OS): */

= Local server / Singleplayer =
Starting with R31 "Singleplayer Update" the local server is seamlessly integrated into the game client. Other players can also connect to you over LAN (new tab in Multiplayer menu) and even over the internet with virtual LAN (with software such as Hamachi).

= Using game server hosting providers =

==== Game server rent service ====
''If you don't want to hassle with the game server setup, you can rent your own CryoFall server from any third party game server hosting company in just a few minutes. They provide data center locations in almost every country around the world!''
* [https://pingperfect.com/gameservers/cryofall-game-server-hosting-rental.php?aff=586 PingPerfect]
* [https://gameserver.4players.de/server-hosting/cryofall-server-mieten/ 4PLAYERS] (the website is available in German only)
''Please note that AtomicTorch Studio is not affiliated with any of these companies and not responsible for their service quality so in case of any issues please reach them directly. So far we've heard only positive feedback about their services.''

= Self-hosting =

== Requirements ==
====Hardware requirements====
(for up to about 30 players online) 1-core CPU 1.6-2 GHz, 1.5 GB RAM, 2-3 Mbit/s bandwidth (each way)
 (for up to about 100 players online) 2-core CPU 1.6-2 GHz, 2 GB RAM, 3-6 Mbit/s bandwidth
 (for up to about 200 players online) 2-core CPU 2.4-3 GHz, 2 GB RAM, 6-12 Mbit/s bandwidth
 (for up to about 300 players online) 2-core CPU 3+ GHz, 2.5 GB RAM, 12-20 Mbit/s bandwidth
 Usually, VPS (virtual machines) hosting such as [https://www.vultr.com/?ref=7238385 Vultr.com] (this is our referral link as we're using this company services to host our own servers) is sufficient for hosting a game server. Using 1-core machines is not recommended as the game requires a secondary CPU to ensure smooth performance without hiccups during intensive background operations (such as world snapshot saving). Using more than a 2-core machine for a single game server hosting is redundant as the game cannot utilize more than two cores due to the sequential execution of the game simulation (except networking).

====Software (system) requirements====
The server could run on Windows, Linux, and Mac.
To achieve this the game server is using .NET Runtime 5.0.
For hosting the official game servers we prefer using CentOS 7 with Docker or CentOS 8 with podman (OSS alternative to Docker).

== Server installation with Docker (best way for Linux) ==
We recommend this for Linux only. Please follow this guide [https://hub.docker.com/r/atomictorch/cryofall-server CryoFall Dedicated Server Docker Image] then return back here to '''"Server installation"''' section and follow the list after number 7. Ignore instructions on how to start the server with "dotnet" as you should use "docker run ..." instead as explained in the Docker guide above.

== Server installation / direct download (Windows, Linux, Mac) ==

==== How to setup your own server (on any OS): ====
# Install .NET Runtime 5.0 x64ΓÇöplease visit [https://dotnet.microsoft.com/download/dotnet/5.0/runtime Download .NET page] and follow the installation guide for your OS.
# Download the game server package. There are several ways to do this:
## You can download it from our website:
### '''[https://atomictorch.com/Files/CryoFall_Server_v1.31.6.8.zip SERVER DOWNLOAD LINK (any OS)]'''
### Extract the downloaded package (it's a regular ZIP archive).
## Alternatively, you can download it from '''Steam Client''':
### Launch Steam Client
### Select LIBRARY tab
### Click on "ALL" and toggle "Tools"
### Search for "CryoFall Dedicated Server" and install it
## Alternatively, you can download it with '''SteamCMD''' (if you're familiar with it):
### launch SteamCMD
### enter:
###: <code>
###: login anonymous
###: app_update 1061710
###: </code>
### navigate to the installation folder (usually in steamapps/Common/CryoFall Dedicated Server)
# The server executable is located in the subfolder: "Binaries/Server". Open the command line/terminal/SSH (or PowerShell in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable first time with <code>loadOrNew</code> flag. The server will start and create the game world.
#:<code>dotnet CryoFall_Server.dll loadOrNew</code>
# Usually it takes about 1-2 minutes to create a new world (or load a savegame). After that the server will keep writing performance statistics information every 20 seconds among other information such as the spawn scripts reporting and network events.
# Stop the server. To do so enter the command below and press Enter key.
#:<code>stop 0</code>
#The server will save and quit. Now you have the "SettingsServer.xml" and "ModsConfig.xml" files.
# Now you need to navigate to the subfolder "Data" (in the root of the server folder, '''not''' in the "Binaries/Server") and modify "SettingsServer.xml" to set the unique server '''name''' and set other settings, etc (there are XML comments explaining every setting so it should be straightforward). ''Please note that you can (and should) edit '''Description''' and '''Welcome message''' from the '''CURRENT GAME''' menu right from the game after connecting to your server.''
# If you are interested in making your server visible in the community servers list make sure to edit <is_public_server> and change the value from 0 to 1. Also, please make sure your router is configured correctly (port forwarding) to enable other people to connect to your machine from outside. But ideally, you should use dedicated server hardware (VPS or VDS) to host public servers.
# While you're still editing "SettingsServer.xml" file, please find the value '''<server_operators_list>''' and change it to include '''your nickname'''! Otherwise, you will be unable to access your server console from the game and also you will be unable to edit the server's Description and Welcome message.
# If you want to have a custom server icon, please replace the ServerIcon.png file in the "Data" subfolder. The icon image file requirements: '''PNG24 format, 256x256 size, up to 100 KB'''.

'''Important (for Windows only):''' you need to allow the dotnet process in the Windows Firewall settingsΓÇöif the Firewall access request was not shown automatically by Windows you can add the <code>C:\Program Files\dotnet\dotnet.exe</code> file into Firewall whitelist. To do this, open Windows Start menu and search for "Allow an app through Windows Firewall" -> button "Allow another app".

==== Starting the server ====
# Launch the command line (we recommending '''PowerShell''' in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable with <code>load</code> flag.
#:<code>dotnet CryoFall_Server.dll load</code>
# Stop your server by typing command below and pressing Enter key (it will save the world before stopping).
#:<code>stop 60 The shutdown message text goes here</code>
(Where <code>60</code> is the shutdown delay (in seconds) so the connected players will have some time to find a safe location)

'''''Please note that typing this message is really hard as the console is updating regularly! The best way is to simply copy-paste from the text editor the whole command text into the game console window (hint: you can paste in PowerShell by simply pressing the right mouse button) and pressing Enter key.'''''

You can always wipe the world by launching the game with <code>new</code> flag:
:<code>dotnet CryoFall_Server.dll new</code>

Currently, we don't support the savegame migration between the major game versions (if there are changes to the game data serialization scheme). We plan to implement the proper data migration feature ASAP.

==== Connecting to the server ====
If you want to connect to your local game server, simply add SERVERS->Custom list as <code>localhost</code>

To connect to the public server you need to navigate to SERVERS->Community servers list (please note that this might not work if you host this server on the same PC as the client, read below).

If you're attempting to host your server on a home computer and other players cannot connect to it, you need to manually forward the port '''UDP 6000''' on your home router to '''your local IP address''' (the game has the auto port forwarding feature but it often fails due to the difference in UPnP implementation on many routers). E.g. if your PC's IP address in local network is 192.168.1.100 (you can check it with ipconfig tool or in Windows network adapter's settings) you will need to setup a port forward rule on your router to forward traffic from port 6000 UDP to port 6000 UDP on IP address 192.168.1.100.

'''If you're running a game server on the same PC as the game client:'''
 Please note that you might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its address as <code>localhost:6000</code> and connect to it directly.

'''If you're running a game server in the same local network as the game client (for example you want to play over LAN with your friends and family):'''
 You might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its local IP address (IPv4) and connect to it directly. To get your local IP address please use ipconfig command-line tool or check the network adapter properties in the network center. You need to get the local network IP address of the PC that is hosting the game server. Then add it in the custom servers list on your PC. You can lookup the IP address in the Windows network settings or by using CMD tool called ipconfig in Windows. For example, here we've run the ipconfig tool here and see the IPv4 address as 192.168.1.200 ([https://cdn.discordapp.com/attachments/421250395298332672/739147674367950908/Screenshot_at_19-48-06.png screenshot]). We can use it on any other PC in the local network to connect to that PC hosting the game server.

Connecting to the private servers requires adding it via the Custom servers menu.

6000 is the default port but you can change it in the Data/SettingsServer.xml file.

== Server update/upgrade to new version ==
When we're releasing a new version of the game server, you need to follow these steps to update it:
# (If you have not done this) Install ".NET Runtime" (version 5.0) https://dotnet.microsoft.com/download/dotnet/5.0/runtime
# Ensure you've made a '''backup''' of the "'''Data'''" folder inside the game server installation folder.
# If you're updating from A28 or earlier versions, DELETE "Data/Saves" folder as the savegame is not compatible (breaking changes). Update from A29 to R30/R31 (or to any patch versions) '''doesn't require this step''' (savegame is compatible).
# Download the new version of the server and overwrite your current installation with it (you can find the actual download link above in the "Installation" section).
# Stop the game server (if it's running).
# Important: please '''overwrite''' both Binaries and Core folders!
# Start the server as usual.

== Server commands ==
# Ensure you're the server operator (you've edited the ServerSettings.xml file and added yourself into the server_operators_list).
# Connect to your game server.
# The game console can be toggled by pressing <code>~</code> (the key on the left from <code>1</code> key) like in old-school games (you can change the key binding for console in the controls options).
# Please add <code>/</code> (slash) prefix to the server commands you want to execute.
# You can use '''Tab''' key to fill autocomplete, and you can use '''arrow Up/Down keys''' to navigate the suggestions list. Press '''Tab''' or '''Enter''' to accept the suggestion.

Here is the page with the server commands list: [[CryoFall/Server/Commands|Server Commands List]]

== Moderation (whitelist, blacklist, kicking, muting) ==
Server operator can access special moderation commands. To invoke these commands, please ensure you're the server operator, connect to your game server, open the console (~ key) and then you can use these commands: (replace username with the actual player nickname)

Whitelist management:

<code>/mod.whiteList.add username</code>

<code>/mod.whiteList.remove username</code>

<code>/mod.whiteList.print</code>

To enable whitelist:

<code>/mod.whiteList.enabled 1</code>

Blacklist management:

<code>/mod.blackList.add username</code>

<code>/mod.blackList.remove username</code>

<code>/mod.blackList.print</code>

Kicking players (temporary removing from server and blocking from connecting):

<code>/mod.kickList.add username durationInMinutes</code>

<code>/mod.kickList.remove username</code>

<code>/mod.kickList.print</code>

Muting players (temporary removing their ability to send messages to chat):

<code>/mod.muteList.add username durationInMinutes</code>

<code>/mod.muteList.remove username</code>

<code>/mod.muteList.print</code>

== Server rates adjusting / Enabling PvP mode ==
Server rates (and PvP mode setting) are exposed in a separate config file. You can quickly change things like LP gain rate, increase item drops, reduce the player to player damage to zero, or even increase the damage from creatures and make it really tough for the players!

To adjust the server rates, stop the server and check the file <game server>/Data/ServerRates.config
Please read carefullyΓÇöall the rates are disabled and in order to apply them '''you need to remove the # char at the start of the line'''!

If you want to '''enable PvP''', search PvP in the file. By default, this setting's value is 0 and you need to change it to 1 and remove the # char at the start of the line.

For advanced modding please read [http://forums.atomictorch.com/index.php?topic=1027.0 modding prerequisites].

== Server raiding hours (for PvP) ==
'''(Please note: with A27 this feature is not recommend anymore as there is a better feature now ΓÇö S.H.I.E.L.D. protection that is enabled by default for PvP servers)'''

On PvP server, you could set up specific hours during which the raiding is possible.
 By default, offline raiding protection is not enabled so players could raid other players' bases at any time.
 To enable offline raiding protection, please use this in-game console command:
 <code>/admin.setRaidingWindow 4 14 1.5</code>
 In this code we're using (first number) +4 GMT/UTC timezone, (second number) hour of day when raiding is possible (value from 0 to 24), and (third number) is the duration of the raiding window (value from 0 to 24).
 So the code in the example will allow raiding from 14:00 (or 2PM) for 1.5 hours.
 After changing the value you could open Politics/Diplomacy menu ([P] key) and verify whether you set the correct numbers.
 Please note that Politics/Diplomacy menu displaying your local time (in your PC timezone)!

== How to prohibit client modifications ==
If you wish to restrict usage of any client modifications on your server, please find "<no_client_mods>" setting in the SettingsServer.xml file. Change the value from 0 to 1 to enable this feature. It's recommended for PvP servers to set it to 1. You can read more details about this feature in [https://atomictorch.com/Post/Id2218/A28-Justice-Update-Release A28 Update announcement].

CryoFall/Server/Setup

2021-10-12T22:53:19Z

Ai enabled: /* How to setup your own server (on any OS): */

= Local server / Singleplayer =
Starting with R31 "Singleplayer Update" the local server is seamlessly integrated into the game client. Other players can also connect to you over LAN (new tab in Multiplayer menu) and even over the internet with virtual LAN (with software such as Hamachi).

= Using game server hosting providers =

==== Game server rent service ====
''If you don't want to hassle with the game server setup, you can rent your own CryoFall server from any third party game server hosting company in just a few minutes. They provide data center locations in almost every country around the world!''
* [https://pingperfect.com/gameservers/cryofall-game-server-hosting-rental.php?aff=586 PingPerfect]
* [https://gameserver.4players.de/server-hosting/cryofall-server-mieten/ 4PLAYERS] (the website is available in German only)
''Please note that AtomicTorch Studio is not affiliated with any of these companies and not responsible for their service quality so in case of any issues please reach them directly. So far we've heard only positive feedback about their services.''

= Self-hosting =

== Requirements ==
====Hardware requirements====
(for up to about 30 players online) 1-core CPU 1.6-2 GHz, 1.5 GB RAM, 2-3 Mbit/s bandwidth (each way)
 (for up to about 100 players online) 2-core CPU 1.6-2 GHz, 2 GB RAM, 3-6 Mbit/s bandwidth
 (for up to about 200 players online) 2-core CPU 2.4-3 GHz, 2 GB RAM, 6-12 Mbit/s bandwidth
 (for up to about 300 players online) 2-core CPU 3+ GHz, 2.5 GB RAM, 12-20 Mbit/s bandwidth
 Usually, VPS (virtual machines) hosting such as [https://www.vultr.com/?ref=7238385 Vultr.com] (this is our referral link as we're using this company services to host our own servers) is sufficient for hosting a game server. Using 1-core machines is not recommended as the game requires a secondary CPU to ensure smooth performance without hiccups during intensive background operations (such as world snapshot saving). Using more than a 2-core machine for a single game server hosting is redundant as the game cannot utilize more than two cores due to the sequential execution of the game simulation (except networking).

====Software (system) requirements====
The server could run on Windows, Linux, and Mac.
To achieve this the game server is using .NET Runtime 5.0.
For hosting the official game servers we prefer using CentOS 7 with Docker or CentOS 8 with podman (OSS alternative to Docker).

== Server installation with Docker (best way for Linux) ==
We recommend this for Linux only. Please follow this guide [https://hub.docker.com/r/atomictorch/cryofall-server CryoFall Dedicated Server Docker Image] then return back here to '''"Server installation"''' section and follow the list after number 7. Ignore instructions on how to start the server with "dotnet" as you should use "docker run ..." instead as explained in the Docker guide above.

== Server installation / direct download (Windows, Linux, Mac) ==

==== How to setup your own server (on any OS): ====
# Install .NET Runtime 5.0 x64ΓÇöplease visit [https://dotnet.microsoft.com/download/dotnet/5.0/runtime Download .NET page] and follow the installation guide for your OS.
# Download the game server package. There are several ways to do this:
## You can download it from our website:
### '''[https://atomictorch.com/Files/CryoFall_Server_v1.31.6.8.zip SERVER DOWNLOAD LINK (any OS)]'''
### Extract the downloaded package (it's a regular ZIP archive).
## Alternatively, you can download it from Steam Client:
### Launch Steam Client
### Select LIBRARY tab
### Click on "ALL" and toggle "Tools"
### Search for "CryoFall Dedicated Server" and install it
## Alternatively, you can download it with SteamCMD (if you're familiar with it):
### launch SteamCMD
### enter:
###: <code>
###: login anonymous
###: app_update 1061710
###: </code>
### navigate to the installation folder (usually in steamapps/Common/CryoFall Dedicated Server)
# The server executable is located in the subfolder: "Binaries/Server". Open the command line/terminal/SSH (or PowerShell in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable first time with <code>loadOrNew</code> flag. The server will start and create the game world.
#:<code>dotnet CryoFall_Server.dll loadOrNew</code>
# Usually it takes about 1-2 minutes to create a new world (or load a savegame). After that the server will keep writing performance statistics information every 20 seconds among other information such as the spawn scripts reporting and network events.
# Stop the server. To do so enter the command below and press Enter key.
#:<code>stop 0</code>
#The server will save and quit. Now you have the "SettingsServer.xml" and "ModsConfig.xml" files.
# Now you need to navigate to the subfolder "Data" (in the root of the server folder, '''not''' in the "Binaries/Server") and modify "SettingsServer.xml" to set the unique server '''name''' and set other settings, etc (there are XML comments explaining every setting so it should be straightforward). ''Please note that you can (and should) edit '''Description''' and '''Welcome message''' from the '''CURRENT GAME''' menu right from the game after connecting to your server.''
# If you are interested in making your server visible in the community servers list make sure to edit <is_public_server> and change the value from 0 to 1. Also, please make sure your router is configured correctly (port forwarding) to enable other people to connect to your machine from outside. But ideally, you should use dedicated server hardware (VPS or VDS) to host public servers.
# While you're still editing "SettingsServer.xml" file, please find the value '''<server_operators_list>''' and change it to include '''your nickname'''! Otherwise, you will be unable to access your server console from the game and also you will be unable to edit the server's Description and Welcome message.
# If you want to have a custom server icon, please replace the ServerIcon.png file in the "Data" subfolder. The icon image file requirements: '''PNG24 format, 256x256 size, up to 100 KB'''.

'''Important (for Windows only):''' you need to allow the dotnet process in the Windows Firewall settingsΓÇöif the Firewall access request was not shown automatically by Windows you can add the <code>C:\Program Files\dotnet\dotnet.exe</code> file into Firewall whitelist. To do this, open Windows Start menu and search for "Allow an app through Windows Firewall" -> button "Allow another app".

==== Starting the server ====
# Launch the command line (we recommending '''PowerShell''' in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable with <code>load</code> flag.
#:<code>dotnet CryoFall_Server.dll load</code>
# Stop your server by typing command below and pressing Enter key (it will save the world before stopping).
#:<code>stop 60 The shutdown message text goes here</code>
(Where <code>60</code> is the shutdown delay (in seconds) so the connected players will have some time to find a safe location)

'''''Please note that typing this message is really hard as the console is updating regularly! The best way is to simply copy-paste from the text editor the whole command text into the game console window (hint: you can paste in PowerShell by simply pressing the right mouse button) and pressing Enter key.'''''

You can always wipe the world by launching the game with <code>new</code> flag:
:<code>dotnet CryoFall_Server.dll new</code>

Currently, we don't support the savegame migration between the major game versions (if there are changes to the game data serialization scheme). We plan to implement the proper data migration feature ASAP.

==== Connecting to the server ====
If you want to connect to your local game server, simply add SERVERS->Custom list as <code>localhost</code>

To connect to the public server you need to navigate to SERVERS->Community servers list (please note that this might not work if you host this server on the same PC as the client, read below).

If you're attempting to host your server on a home computer and other players cannot connect to it, you need to manually forward the port '''UDP 6000''' on your home router to '''your local IP address''' (the game has the auto port forwarding feature but it often fails due to the difference in UPnP implementation on many routers). E.g. if your PC's IP address in local network is 192.168.1.100 (you can check it with ipconfig tool or in Windows network adapter's settings) you will need to setup a port forward rule on your router to forward traffic from port 6000 UDP to port 6000 UDP on IP address 192.168.1.100.

'''If you're running a game server on the same PC as the game client:'''
 Please note that you might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its address as <code>localhost:6000</code> and connect to it directly.

'''If you're running a game server in the same local network as the game client (for example you want to play over LAN with your friends and family):'''
 You might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its local IP address (IPv4) and connect to it directly. To get your local IP address please use ipconfig command-line tool or check the network adapter properties in the network center. You need to get the local network IP address of the PC that is hosting the game server. Then add it in the custom servers list on your PC. You can lookup the IP address in the Windows network settings or by using CMD tool called ipconfig in Windows. For example, here we've run the ipconfig tool here and see the IPv4 address as 192.168.1.200 ([https://cdn.discordapp.com/attachments/421250395298332672/739147674367950908/Screenshot_at_19-48-06.png screenshot]). We can use it on any other PC in the local network to connect to that PC hosting the game server.

Connecting to the private servers requires adding it via the Custom servers menu.

6000 is the default port but you can change it in the Data/SettingsServer.xml file.

== Server update/upgrade to new version ==
When we're releasing a new version of the game server, you need to follow these steps to update it:
# (If you have not done this) Install ".NET Runtime" (version 5.0) https://dotnet.microsoft.com/download/dotnet/5.0/runtime
# Ensure you've made a '''backup''' of the "'''Data'''" folder inside the game server installation folder.
# If you're updating from A28 or earlier versions, DELETE "Data/Saves" folder as the savegame is not compatible (breaking changes). Update from A29 to R30/R31 (or to any patch versions) '''doesn't require this step''' (savegame is compatible).
# Download the new version of the server and overwrite your current installation with it (you can find the actual download link above in the "Installation" section).
# Stop the game server (if it's running).
# Important: please '''overwrite''' both Binaries and Core folders!
# Start the server as usual.

== Server commands ==
# Ensure you're the server operator (you've edited the ServerSettings.xml file and added yourself into the server_operators_list).
# Connect to your game server.
# The game console can be toggled by pressing <code>~</code> (the key on the left from <code>1</code> key) like in old-school games (you can change the key binding for console in the controls options).
# Please add <code>/</code> (slash) prefix to the server commands you want to execute.
# You can use '''Tab''' key to fill autocomplete, and you can use '''arrow Up/Down keys''' to navigate the suggestions list. Press '''Tab''' or '''Enter''' to accept the suggestion.

Here is the page with the server commands list: [[CryoFall/Server/Commands|Server Commands List]]

== Moderation (whitelist, blacklist, kicking, muting) ==
Server operator can access special moderation commands. To invoke these commands, please ensure you're the server operator, connect to your game server, open the console (~ key) and then you can use these commands: (replace username with the actual player nickname)

Whitelist management:

<code>/mod.whiteList.add username</code>

<code>/mod.whiteList.remove username</code>

<code>/mod.whiteList.print</code>

To enable whitelist:

<code>/mod.whiteList.enabled 1</code>

Blacklist management:

<code>/mod.blackList.add username</code>

<code>/mod.blackList.remove username</code>

<code>/mod.blackList.print</code>

Kicking players (temporary removing from server and blocking from connecting):

<code>/mod.kickList.add username durationInMinutes</code>

<code>/mod.kickList.remove username</code>

<code>/mod.kickList.print</code>

Muting players (temporary removing their ability to send messages to chat):

<code>/mod.muteList.add username durationInMinutes</code>

<code>/mod.muteList.remove username</code>

<code>/mod.muteList.print</code>

== Server rates adjusting / Enabling PvP mode ==
Server rates (and PvP mode setting) are exposed in a separate config file. You can quickly change things like LP gain rate, increase item drops, reduce the player to player damage to zero, or even increase the damage from creatures and make it really tough for the players!

To adjust the server rates, stop the server and check the file <game server>/Data/ServerRates.config
Please read carefullyΓÇöall the rates are disabled and in order to apply them '''you need to remove the # char at the start of the line'''!

If you want to '''enable PvP''', search PvP in the file. By default, this setting's value is 0 and you need to change it to 1 and remove the # char at the start of the line.

For advanced modding please read [http://forums.atomictorch.com/index.php?topic=1027.0 modding prerequisites].

== Server raiding hours (for PvP) ==
'''(Please note: with A27 this feature is not recommend anymore as there is a better feature now ΓÇö S.H.I.E.L.D. protection that is enabled by default for PvP servers)'''

On PvP server, you could set up specific hours during which the raiding is possible.
 By default, offline raiding protection is not enabled so players could raid other players' bases at any time.
 To enable offline raiding protection, please use this in-game console command:
 <code>/admin.setRaidingWindow 4 14 1.5</code>
 In this code we're using (first number) +4 GMT/UTC timezone, (second number) hour of day when raiding is possible (value from 0 to 24), and (third number) is the duration of the raiding window (value from 0 to 24).
 So the code in the example will allow raiding from 14:00 (or 2PM) for 1.5 hours.
 After changing the value you could open Politics/Diplomacy menu ([P] key) and verify whether you set the correct numbers.
 Please note that Politics/Diplomacy menu displaying your local time (in your PC timezone)!

== How to prohibit client modifications ==
If you wish to restrict usage of any client modifications on your server, please find "<no_client_mods>" setting in the SettingsServer.xml file. Change the value from 0 to 1 to enable this feature. It's recommended for PvP servers to set it to 1. You can read more details about this feature in [https://atomictorch.com/Post/Id2218/A28-Justice-Update-Release A28 Update announcement].

CryoFall/Server/Setup

2021-10-12T12:35:13Z

Ai enabled: /* How to setup your own server (on any OS): */

= Local server / Singleplayer =
Starting with R31 "Singleplayer Update" the local server is seamlessly integrated into the game client. Other players can also connect to you over LAN (new tab in Multiplayer menu) and even over the internet with virtual LAN (with software such as Hamachi).

= Using game server hosting providers =

==== Game server rent service ====
''If you don't want to hassle with the game server setup, you can rent your own CryoFall server from any third party game server hosting company in just a few minutes. They provide data center locations in almost every country around the world!''
* [https://pingperfect.com/gameservers/cryofall-game-server-hosting-rental.php?aff=586 PingPerfect]
* [https://gameserver.4players.de/server-hosting/cryofall-server-mieten/ 4PLAYERS] (the website is available in German only)
''Please note that AtomicTorch Studio is not affiliated with any of these companies and not responsible for their service quality so in case of any issues please reach them directly. So far we've heard only positive feedback about their services.''

= Self-hosting =

== Requirements ==
====Hardware requirements====
(for up to about 30 players online) 1-core CPU 1.6-2 GHz, 1.5 GB RAM, 2-3 Mbit/s bandwidth (each way)
 (for up to about 100 players online) 2-core CPU 1.6-2 GHz, 2 GB RAM, 3-6 Mbit/s bandwidth
 (for up to about 200 players online) 2-core CPU 2.4-3 GHz, 2 GB RAM, 6-12 Mbit/s bandwidth
 (for up to about 300 players online) 2-core CPU 3+ GHz, 2.5 GB RAM, 12-20 Mbit/s bandwidth
 Usually, VPS (virtual machines) hosting such as [https://www.vultr.com/?ref=7238385 Vultr.com] (this is our referral link as we're using this company services to host our own servers) is sufficient for hosting a game server. Using 1-core machines is not recommended as the game requires a secondary CPU to ensure smooth performance without hiccups during intensive background operations (such as world snapshot saving). Using more than a 2-core machine for a single game server hosting is redundant as the game cannot utilize more than two cores due to the sequential execution of the game simulation (except networking).

====Software (system) requirements====
The server could run on Windows, Linux, and Mac.
To achieve this the game server is using .NET Runtime 5.0.
For hosting the official game servers we prefer using CentOS 7 with Docker or CentOS 8 with podman (OSS alternative to Docker).

== Server installation with Docker (best way for Linux) ==
We recommend this for Linux only. Please follow this guide [https://hub.docker.com/r/atomictorch/cryofall-server CryoFall Dedicated Server Docker Image] then return back here to '''"Server installation"''' section and follow the list after number 7. Ignore instructions on how to start the server with "dotnet" as you should use "docker run ..." instead as explained in the Docker guide above.

== Server installation / direct download (Windows, Linux, Mac) ==

==== How to setup your own server (on any OS): ====
# Install .NET Runtime 5.0 x64ΓÇöplease visit [https://dotnet.microsoft.com/download/dotnet/5.0/runtime Download .NET page] and follow the installation guide for your OS.
# Download the game server package from '''[https://atomictorch.com/Files/CryoFall_Server_v1.31.6.8.zip SERVER DOWNLOAD LINK (any OS)]'''.
# Extract the downloaded package (it's a regular ZIP archive).
# The server executable is located in the subfolder: "Binaries/Server". Open the command line/terminal/SSH (or PowerShell in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable first time with <code>loadOrNew</code> flag. The server will start and create the game world.
#:<code>dotnet CryoFall_Server.dll loadOrNew</code>
# Usually it takes about 1-2 minutes to create a new world (or load a savegame). After that the server will keep writing performance statistics information every 20 seconds among other information such as the spawn scripts reporting and network events.
# Stop the server. To do so enter the command below and press Enter key.
#:<code>stop 0</code>
#The server will save and quit. Now you have the "SettingsServer.xml" and "ModsConfig.xml" files.
# Now you need to navigate to the subfolder "Data" (in the root of the server folder, '''not''' in the "Binaries/Server") and modify "SettingsServer.xml" to set the unique server '''name''' and set other settings, etc (there are XML comments explaining every setting so it should be straightforward). ''Please note that you can (and should) edit '''Description''' and '''Welcome message''' from the '''CURRENT GAME''' menu right from the game after connecting to your server.''
# If you are interested in making your server visible in the community servers list make sure to edit <is_public_server> and change the value from 0 to 1. Also, please make sure your router is configured correctly (port forwarding) to enable other people to connect to your machine from outside. But ideally, you should use dedicated server hardware (VPS or VDS) to host public servers.
# While you're still editing "SettingsServer.xml" file, please find the value '''<server_operators_list>''' and change it to include '''your nickname'''! Otherwise, you will be unable to access your server console from the game and also you will be unable to edit the server's Description and Welcome message.
# If you want to have a custom server icon, please replace the ServerIcon.png file in the "Data" subfolder. The icon image file requirements: '''PNG24 format, 256x256 size, up to 100 KB'''.

'''Important (for Windows only):''' you need to allow the dotnet process in the Windows Firewall settingsΓÇöif the Firewall access request was not shown automatically by Windows you can add the <code>C:\Program Files\dotnet\dotnet.exe</code> file into Firewall whitelist. To do this, open Windows Start menu and search for "Allow an app through Windows Firewall" -> button "Allow another app".

==== Starting the server ====
# Launch the command line (we recommending '''PowerShell''' in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable with <code>load</code> flag.
#:<code>dotnet CryoFall_Server.dll load</code>
# Stop your server by typing command below and pressing Enter key (it will save the world before stopping).
#:<code>stop 60 The shutdown message text goes here</code>
(Where <code>60</code> is the shutdown delay (in seconds) so the connected players will have some time to find a safe location)

'''''Please note that typing this message is really hard as the console is updating regularly! The best way is to simply copy-paste from the text editor the whole command text into the game console window (hint: you can paste in PowerShell by simply pressing the right mouse button) and pressing Enter key.'''''

You can always wipe the world by launching the game with <code>new</code> flag:
:<code>dotnet CryoFall_Server.dll new</code>

Currently, we don't support the savegame migration between the major game versions (if there are changes to the game data serialization scheme). We plan to implement the proper data migration feature ASAP.

==== Connecting to the server ====
If you want to connect to your local game server, simply add SERVERS->Custom list as <code>localhost</code>

To connect to the public server you need to navigate to SERVERS->Community servers list (please note that this might not work if you host this server on the same PC as the client, read below).

If you're attempting to host your server on a home computer and other players cannot connect to it, you need to manually forward the port '''UDP 6000''' on your home router to '''your local IP address''' (the game has the auto port forwarding feature but it often fails due to the difference in UPnP implementation on many routers). E.g. if your PC's IP address in local network is 192.168.1.100 (you can check it with ipconfig tool or in Windows network adapter's settings) you will need to setup a port forward rule on your router to forward traffic from port 6000 UDP to port 6000 UDP on IP address 192.168.1.100.

'''If you're running a game server on the same PC as the game client:'''
 Please note that you might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its address as <code>localhost:6000</code> and connect to it directly.

'''If you're running a game server in the same local network as the game client (for example you want to play over LAN with your friends and family):'''
 You might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its local IP address (IPv4) and connect to it directly. To get your local IP address please use ipconfig command-line tool or check the network adapter properties in the network center. You need to get the local network IP address of the PC that is hosting the game server. Then add it in the custom servers list on your PC. You can lookup the IP address in the Windows network settings or by using CMD tool called ipconfig in Windows. For example, here we've run the ipconfig tool here and see the IPv4 address as 192.168.1.200 ([https://cdn.discordapp.com/attachments/421250395298332672/739147674367950908/Screenshot_at_19-48-06.png screenshot]). We can use it on any other PC in the local network to connect to that PC hosting the game server.

Connecting to the private servers requires adding it via the Custom servers menu.

6000 is the default port but you can change it in the Data/SettingsServer.xml file.

== Server update/upgrade to new version ==
When we're releasing a new version of the game server, you need to follow these steps to update it:
# (If you have not done this) Install ".NET Runtime" (version 5.0) https://dotnet.microsoft.com/download/dotnet/5.0/runtime
# Ensure you've made a '''backup''' of the "'''Data'''" folder inside the game server installation folder.
# If you're updating from A28 or earlier versions, DELETE "Data/Saves" folder as the savegame is not compatible (breaking changes). Update from A29 to R30/R31 (or to any patch versions) '''doesn't require this step''' (savegame is compatible).
# Download the new version of the server and overwrite your current installation with it (you can find the actual download link above in the "Installation" section).
# Stop the game server (if it's running).
# Important: please '''overwrite''' both Binaries and Core folders!
# Start the server as usual.

== Server commands ==
# Ensure you're the server operator (you've edited the ServerSettings.xml file and added yourself into the server_operators_list).
# Connect to your game server.
# The game console can be toggled by pressing <code>~</code> (the key on the left from <code>1</code> key) like in old-school games (you can change the key binding for console in the controls options).
# Please add <code>/</code> (slash) prefix to the server commands you want to execute.
# You can use '''Tab''' key to fill autocomplete, and you can use '''arrow Up/Down keys''' to navigate the suggestions list. Press '''Tab''' or '''Enter''' to accept the suggestion.

Here is the page with the server commands list: [[CryoFall/Server/Commands|Server Commands List]]

== Moderation (whitelist, blacklist, kicking, muting) ==
Server operator can access special moderation commands. To invoke these commands, please ensure you're the server operator, connect to your game server, open the console (~ key) and then you can use these commands: (replace username with the actual player nickname)

Whitelist management:

<code>/mod.whiteList.add username</code>

<code>/mod.whiteList.remove username</code>

<code>/mod.whiteList.print</code>

To enable whitelist:

<code>/mod.whiteList.enabled 1</code>

Blacklist management:

<code>/mod.blackList.add username</code>

<code>/mod.blackList.remove username</code>

<code>/mod.blackList.print</code>

Kicking players (temporary removing from server and blocking from connecting):

<code>/mod.kickList.add username durationInMinutes</code>

<code>/mod.kickList.remove username</code>

<code>/mod.kickList.print</code>

Muting players (temporary removing their ability to send messages to chat):

<code>/mod.muteList.add username durationInMinutes</code>

<code>/mod.muteList.remove username</code>

<code>/mod.muteList.print</code>

== Server rates adjusting / Enabling PvP mode ==
Server rates (and PvP mode setting) are exposed in a separate config file. You can quickly change things like LP gain rate, increase item drops, reduce the player to player damage to zero, or even increase the damage from creatures and make it really tough for the players!

To adjust the server rates, stop the server and check the file <game server>/Data/ServerRates.config
Please read carefullyΓÇöall the rates are disabled and in order to apply them '''you need to remove the # char at the start of the line'''!

If you want to '''enable PvP''', search PvP in the file. By default, this setting's value is 0 and you need to change it to 1 and remove the # char at the start of the line.

For advanced modding please read [http://forums.atomictorch.com/index.php?topic=1027.0 modding prerequisites].

== Server raiding hours (for PvP) ==
'''(Please note: with A27 this feature is not recommend anymore as there is a better feature now ΓÇö S.H.I.E.L.D. protection that is enabled by default for PvP servers)'''

On PvP server, you could set up specific hours during which the raiding is possible.
 By default, offline raiding protection is not enabled so players could raid other players' bases at any time.
 To enable offline raiding protection, please use this in-game console command:
 <code>/admin.setRaidingWindow 4 14 1.5</code>
 In this code we're using (first number) +4 GMT/UTC timezone, (second number) hour of day when raiding is possible (value from 0 to 24), and (third number) is the duration of the raiding window (value from 0 to 24).
 So the code in the example will allow raiding from 14:00 (or 2PM) for 1.5 hours.
 After changing the value you could open Politics/Diplomacy menu ([P] key) and verify whether you set the correct numbers.
 Please note that Politics/Diplomacy menu displaying your local time (in your PC timezone)!

== How to prohibit client modifications ==
If you wish to restrict usage of any client modifications on your server, please find "<no_client_mods>" setting in the SettingsServer.xml file. Change the value from 0 to 1 to enable this feature. It's recommended for PvP servers to set it to 1. You can read more details about this feature in [https://atomictorch.com/Post/Id2218/A28-Justice-Update-Release A28 Update announcement].

CryoFall/Server/Setup

2021-10-11T22:09:56Z

Ai enabled: /* How to setup your own server (on any OS): */

= Local server / Singleplayer =
Starting with R31 "Singleplayer Update" the local server is seamlessly integrated into the game client. Other players can also connect to you over LAN (new tab in Multiplayer menu) and even over the internet with virtual LAN (with software such as Hamachi).

= Using game server hosting providers =

==== Game server rent service ====
''If you don't want to hassle with the game server setup, you can rent your own CryoFall server from any third party game server hosting company in just a few minutes. They provide data center locations in almost every country around the world!''
* [https://pingperfect.com/gameservers/cryofall-game-server-hosting-rental.php?aff=586 PingPerfect]
* [https://gameserver.4players.de/server-hosting/cryofall-server-mieten/ 4PLAYERS] (the website is available in German only)
''Please note that AtomicTorch Studio is not affiliated with any of these companies and not responsible for their service quality so in case of any issues please reach them directly. So far we've heard only positive feedback about their services.''

= Self-hosting =

== Requirements ==
====Hardware requirements====
(for up to about 30 players online) 1-core CPU 1.6-2 GHz, 1.5 GB RAM, 2-3 Mbit/s bandwidth (each way)
 (for up to about 100 players online) 2-core CPU 1.6-2 GHz, 2 GB RAM, 3-6 Mbit/s bandwidth
 (for up to about 200 players online) 2-core CPU 2.4-3 GHz, 2 GB RAM, 6-12 Mbit/s bandwidth
 (for up to about 300 players online) 2-core CPU 3+ GHz, 2.5 GB RAM, 12-20 Mbit/s bandwidth
 Usually, VPS (virtual machines) hosting such as [https://www.vultr.com/?ref=7238385 Vultr.com] (this is our referral link as we're using this company services to host our own servers) is sufficient for hosting a game server. Using 1-core machines is not recommended as the game requires a secondary CPU to ensure smooth performance without hiccups during intensive background operations (such as world snapshot saving). Using more than a 2-core machine for a single game server hosting is redundant as the game cannot utilize more than two cores due to the sequential execution of the game simulation (except networking).

====Software (system) requirements====
The server could run on Windows, Linux, and Mac.
To achieve this the game server is using .NET Runtime 5.0.
For hosting the official game servers we prefer using CentOS 7 with Docker or CentOS 8 with podman (OSS alternative to Docker).

== Server installation with Docker (best way for Linux) ==
We recommend this for Linux only. Please follow this guide [https://hub.docker.com/r/atomictorch/cryofall-server CryoFall Dedicated Server Docker Image] then return back here to '''"Server installation"''' section and follow the list after number 7. Ignore instructions on how to start the server with "dotnet" as you should use "docker run ..." instead as explained in the Docker guide above.

== Server installation / direct download (Windows, Linux, Mac) ==

==== How to setup your own server (on any OS): ====
# Install .NET Runtime 5.0 x64ΓÇöplease visit [https://dotnet.microsoft.com/download/dotnet/5.0/runtime Download .NET page] and follow the installation guide for your OS.
# Download the game server package from '''[https://atomictorch.com/Files/CryoFall_Server_v1.31.6.8_NetCore.zip SERVER DOWNLOAD LINK (any OS)]'''.
# Extract the downloaded package (it's a regular ZIP archive).
# The server executable is located in the subfolder: "Binaries/Server". Open the command line/terminal/SSH (or PowerShell in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable first time with <code>loadOrNew</code> flag. The server will start and create the game world.
#:<code>dotnet CryoFall_Server.dll loadOrNew</code>
# Usually it takes about 1-2 minutes to create a new world (or load a savegame). After that the server will keep writing performance statistics information every 20 seconds among other information such as the spawn scripts reporting and network events.
# Stop the server. To do so enter the command below and press Enter key.
#:<code>stop 0</code>
#The server will save and quit. Now you have the "SettingsServer.xml" and "ModsConfig.xml" files.
# Now you need to navigate to the subfolder "Data" (in the root of the server folder, '''not''' in the "Binaries/Server") and modify "SettingsServer.xml" to set the unique server '''name''' and set other settings, etc (there are XML comments explaining every setting so it should be straightforward). ''Please note that you can (and should) edit '''Description''' and '''Welcome message''' from the '''CURRENT GAME''' menu right from the game after connecting to your server.''
# If you are interested in making your server visible in the community servers list make sure to edit <is_public_server> and change the value from 0 to 1. Also, please make sure your router is configured correctly (port forwarding) to enable other people to connect to your machine from outside. But ideally, you should use dedicated server hardware (VPS or VDS) to host public servers.
# While you're still editing "SettingsServer.xml" file, please find the value '''<server_operators_list>''' and change it to include '''your nickname'''! Otherwise, you will be unable to access your server console from the game and also you will be unable to edit the server's Description and Welcome message.
# If you want to have a custom server icon, please replace the ServerIcon.png file in the "Data" subfolder. The icon image file requirements: '''PNG24 format, 256x256 size, up to 100 KB'''.

'''Important (for Windows only):''' you need to allow the dotnet process in the Windows Firewall settingsΓÇöif the Firewall access request was not shown automatically by Windows you can add the <code>C:\Program Files\dotnet\dotnet.exe</code> file into Firewall whitelist. To do this, open Windows Start menu and search for "Allow an app through Windows Firewall" -> button "Allow another app".

==== Starting the server ====
# Launch the command line (we recommending '''PowerShell''' in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable with <code>load</code> flag.
#:<code>dotnet CryoFall_Server.dll load</code>
# Stop your server by typing command below and pressing Enter key (it will save the world before stopping).
#:<code>stop 60 The shutdown message text goes here</code>
(Where <code>60</code> is the shutdown delay (in seconds) so the connected players will have some time to find a safe location)

'''''Please note that typing this message is really hard as the console is updating regularly! The best way is to simply copy-paste from the text editor the whole command text into the game console window (hint: you can paste in PowerShell by simply pressing the right mouse button) and pressing Enter key.'''''

You can always wipe the world by launching the game with <code>new</code> flag:
:<code>dotnet CryoFall_Server.dll new</code>

Currently, we don't support the savegame migration between the major game versions (if there are changes to the game data serialization scheme). We plan to implement the proper data migration feature ASAP.

==== Connecting to the server ====
If you want to connect to your local game server, simply add SERVERS->Custom list as <code>localhost</code>

To connect to the public server you need to navigate to SERVERS->Community servers list (please note that this might not work if you host this server on the same PC as the client, read below).

If you're attempting to host your server on a home computer and other players cannot connect to it, you need to manually forward the port '''UDP 6000''' on your home router to '''your local IP address''' (the game has the auto port forwarding feature but it often fails due to the difference in UPnP implementation on many routers). E.g. if your PC's IP address in local network is 192.168.1.100 (you can check it with ipconfig tool or in Windows network adapter's settings) you will need to setup a port forward rule on your router to forward traffic from port 6000 UDP to port 6000 UDP on IP address 192.168.1.100.

'''If you're running a game server on the same PC as the game client:'''
 Please note that you might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its address as <code>localhost:6000</code> and connect to it directly.

'''If you're running a game server in the same local network as the game client (for example you want to play over LAN with your friends and family):'''
 You might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its local IP address (IPv4) and connect to it directly. To get your local IP address please use ipconfig command-line tool or check the network adapter properties in the network center. You need to get the local network IP address of the PC that is hosting the game server. Then add it in the custom servers list on your PC. You can lookup the IP address in the Windows network settings or by using CMD tool called ipconfig in Windows. For example, here we've run the ipconfig tool here and see the IPv4 address as 192.168.1.200 ([https://cdn.discordapp.com/attachments/421250395298332672/739147674367950908/Screenshot_at_19-48-06.png screenshot]). We can use it on any other PC in the local network to connect to that PC hosting the game server.

Connecting to the private servers requires adding it via the Custom servers menu.

6000 is the default port but you can change it in the Data/SettingsServer.xml file.

== Server update/upgrade to new version ==
When we're releasing a new version of the game server, you need to follow these steps to update it:
# (If you have not done this) Install ".NET Runtime" (version 5.0) https://dotnet.microsoft.com/download/dotnet/5.0/runtime
# Ensure you've made a '''backup''' of the "'''Data'''" folder inside the game server installation folder.
# If you're updating from A28 or earlier versions, DELETE "Data/Saves" folder as the savegame is not compatible (breaking changes). Update from A29 to R30/R31 (or to any patch versions) '''doesn't require this step''' (savegame is compatible).
# Download the new version of the server and overwrite your current installation with it (you can find the actual download link above in the "Installation" section).
# Stop the game server (if it's running).
# Important: please '''overwrite''' both Binaries and Core folders!
# Start the server as usual.

== Server commands ==
# Ensure you're the server operator (you've edited the ServerSettings.xml file and added yourself into the server_operators_list).
# Connect to your game server.
# The game console can be toggled by pressing <code>~</code> (the key on the left from <code>1</code> key) like in old-school games (you can change the key binding for console in the controls options).
# Please add <code>/</code> (slash) prefix to the server commands you want to execute.
# You can use '''Tab''' key to fill autocomplete, and you can use '''arrow Up/Down keys''' to navigate the suggestions list. Press '''Tab''' or '''Enter''' to accept the suggestion.

Here is the page with the server commands list: [[CryoFall/Server/Commands|Server Commands List]]

== Moderation (whitelist, blacklist, kicking, muting) ==
Server operator can access special moderation commands. To invoke these commands, please ensure you're the server operator, connect to your game server, open the console (~ key) and then you can use these commands: (replace username with the actual player nickname)

Whitelist management:

<code>/mod.whiteList.add username</code>

<code>/mod.whiteList.remove username</code>

<code>/mod.whiteList.print</code>

To enable whitelist:

<code>/mod.whiteList.enabled 1</code>

Blacklist management:

<code>/mod.blackList.add username</code>

<code>/mod.blackList.remove username</code>

<code>/mod.blackList.print</code>

Kicking players (temporary removing from server and blocking from connecting):

<code>/mod.kickList.add username durationInMinutes</code>

<code>/mod.kickList.remove username</code>

<code>/mod.kickList.print</code>

Muting players (temporary removing their ability to send messages to chat):

<code>/mod.muteList.add username durationInMinutes</code>

<code>/mod.muteList.remove username</code>

<code>/mod.muteList.print</code>

== Server rates adjusting / Enabling PvP mode ==
Server rates (and PvP mode setting) are exposed in a separate config file. You can quickly change things like LP gain rate, increase item drops, reduce the player to player damage to zero, or even increase the damage from creatures and make it really tough for the players!

To adjust the server rates, stop the server and check the file <game server>/Data/ServerRates.config
Please read carefullyΓÇöall the rates are disabled and in order to apply them '''you need to remove the # char at the start of the line'''!

If you want to '''enable PvP''', search PvP in the file. By default, this setting's value is 0 and you need to change it to 1 and remove the # char at the start of the line.

For advanced modding please read [http://forums.atomictorch.com/index.php?topic=1027.0 modding prerequisites].

== Server raiding hours (for PvP) ==
'''(Please note: with A27 this feature is not recommend anymore as there is a better feature now ΓÇö S.H.I.E.L.D. protection that is enabled by default for PvP servers)'''

On PvP server, you could set up specific hours during which the raiding is possible.
 By default, offline raiding protection is not enabled so players could raid other players' bases at any time.
 To enable offline raiding protection, please use this in-game console command:
 <code>/admin.setRaidingWindow 4 14 1.5</code>
 In this code we're using (first number) +4 GMT/UTC timezone, (second number) hour of day when raiding is possible (value from 0 to 24), and (third number) is the duration of the raiding window (value from 0 to 24).
 So the code in the example will allow raiding from 14:00 (or 2PM) for 1.5 hours.
 After changing the value you could open Politics/Diplomacy menu ([P] key) and verify whether you set the correct numbers.
 Please note that Politics/Diplomacy menu displaying your local time (in your PC timezone)!

== How to prohibit client modifications ==
If you wish to restrict usage of any client modifications on your server, please find "<no_client_mods>" setting in the SettingsServer.xml file. Change the value from 0 to 1 to enable this feature. It's recommended for PvP servers to set it to 1. You can read more details about this feature in [https://atomictorch.com/Post/Id2218/A28-Justice-Update-Release A28 Update announcement].

CryoFall/Server/Commands

2021-10-11T21:08:55Z

Ai enabled: /* Server commands list */

== CryoFall server commands ==
Please read the [[CryoFall/Server/Setup|Server Setup Guide]] first.
 This is just a list of all the server console commands.
 You need to '''execute them right from the game''' by using in-game console as described in the [[CryoFall/Server/Setup|Server Setup Guide]].
 Most of these commands are requiring '''server operator access'''.

== Server commands list ==

<pre>
/admin.clearEventPastLocations
* Description: Clear all the past locations for all the events (so new events could happen there again).
* Type: server (operator only)
* Usage:
/admin.clearEventPastLocations

/admin.finishEvents
* Description: Finishes all the active world events.
* Type: server (operator only)
* Usage:
/admin.finishEvents

/admin.giveawayItem
* Description: Adds specified item(s) to all player characters.
* Type: server (operator only)
* Usage:
/admin.giveawayItem <item> [count]

/admin.giveawayLP
* Description: Adds specified item(s) to all player characters.
* Type: server (operator only)
* Usage:
/admin.giveawayLP <learningPoints>

/admin.listCreativeModePlayers
* Description: Lists players currently in creative mode
* Type: server (operator only)
* Usage:
/admin.listCreativeModePlayers

/admin.listLandClaims
* Description: List all the land claims of the specified player or of all the players.
* Type: server (operator only)
* Usage:
/admin.listLandClaims
/admin.listLandClaims <player>

/admin.listLandClaimsOwners
* Description: List all the land claims with their owners.
* Type: server (operator only)
* Usage:
/admin.listLandClaimsOwners [minOwnersNumber]

/moderatorAdd
/admin.moderator.add
* Description: Adds server moderator.
* Type: server (operator only)
* Usage:
/moderatorAdd [character]
/admin.moderator.add [character]

/moderatorList
/admin.moderator.list
* Description: Lists server moderators.
* Type: server (operator only)
* Usage:
/moderatorList
/admin.moderator.list

/moderatorRemove
/admin.moderator.remove
* Description: Removes server moderator.
* Type: server (operator only)
* Usage:
/moderatorRemove [character]
/admin.moderator.remove [character]

/admin.notifyAll
* Description: Notifies all players on the server.
Important: wrap the "message text in quotes"!
* Type: server (operator only)
* Usage:
/admin.notifyAll <messageInQuotes>

/admin.notifyPlayer
* Description: Notifies a player on the server.
Important: wrap the "message text in quotes"!
* Type: server (operator only)
* Usage:
/admin.notifyPlayer <player> <messageInQuotes>

/opAdd
/admin.operator.add
* Description: Adds server operator.
* Type: server (operator only)
* Usage:
/opAdd [character]
/admin.operator.add [character]

/opList
/admin.operator.list
* Description: Lists server operators.
* Type: server (operator only)
* Usage:
/opList
/admin.operator.list

/opRemove
/admin.operator.remove
* Description: Removes server operator.
* Type: server (operator only)
* Usage:
/opRemove [character]
/admin.operator.remove [character]

/pwn
/admin.pwn
* Description: Special debug command to add useful items to the player character.
* Type: server (operator only)
* Usage:
/pwn [player]
/admin.pwn [player]

/admin.setRaidingWindow
* Description: Set raiding window. Please ensure you're using a correct UTC offset!
To disable raiding protection completely, please set 24 hours duration from any hour with any UTC offset.
* Type: server (operator only)
* Usage:
/admin.setRaidingWindow <UTC> <fromHour> <duration>

/admin.spawnAll
* Description: Executes all spawn scripts.
* Type: server (operator only)
* Usage:
/admin.spawnAll

/admin.spawnZone
* Description: Executes all spawn scripts for the specified zone.
* Type: server (operator only)
* Usage:
/admin.spawnZone <protoZone>
/admin.spawnZone <protoZone> [isInitialSpawn]

/startEvent
/admin.startEvent
* Description: Creates and starts an event. Use autocomplete to browse all the available events. To finish all the ongoing events you can use /admin.finishEvents
* Type: server (operator only)
* Usage:
/startEvent <eventName>
/admin.startEvent <eventName>

/completionist.addAll
* Description: Add all completionist entries to player.
* Type: server (operator only)
* Usage:
/completionist.addAll [player]

/completionist.list
* Description: Lists all completionist entries for player.
* Type: server (operator only)
* Usage:
/completionist.list [player]

/completionist.reset
* Description: Reset completionist entries for player.
* Type: server (operator only)
* Usage:
/completionist.reset [player]

(/)help
(/)console.help
* Description: Prints information about all the available console commands.
* Type: client & server (operator only)
* Usage:
/help [searchCommand]
/console.help [searchCommand]

(/)console.logSeverity
* Description: Gets or sets current log severity.
* Type: client & server (operator only)
* Usage:
/console.logSeverity [severity]

/kit
/demo.kit
* Description: Adds sets of items according to specified category to the player character.
* Type: server (operator only)
* Usage:
/kit [category] [player]
/demo.kit [category] [player]

/faction.accept
* Description: Accepts player to the faction. The player must submit an application to the faction first.
* Type: server (operator only)
* Usage:
/faction.accept <player> <clanTag>

/faction.browse
* Description: Browse the faction of the specified player.
* Type: server (moderator/operator only)
* Usage:
/faction.browse <player>

/faction.resetFactionJoinCooldown
* Description: Resets the faction leave join cooldown. Player can join any faction instantly.
* Type: server (moderator/operator only)
* Usage:
/faction.resetFactionJoinCooldown [player]

/faction.setLevel
* Description: Sets the faction level.
* Type: server (operator only)
* Usage:
/faction.setLevel <clanTag> <level>

/faction.setRole
* Description: Changes the faction role of the provided character. Cannot change to leader and cannot change from leader to another role.
* Type: server (operator only)
* Usage:
/faction.setRole [player] <role>

/faction.updateLeaderboard
* Description: Forces an update of the factions leaderboard.
* Type: server (operator only)
* Usage:
/faction.updateLeaderboard

/spawn
/mobs.spawn
* Description: Spawns a mob of the specified type to the specified tile position in the world or near the specified character, depending on arguments used.
* Type: server (operator only)
* Usage:
/spawn <protoMob> [count] [nearPlayer]
/spawn <protoMob> <x> <y> [count]
/mobs.spawn <protoMob> [count] [nearPlayer]
/mobs.spawn <protoMob> <x> <y> [count]

/ban
/mod.blackList.add
* Description: Adds a player name into the blacklist.
Players from this list cannot connect to the game server
(unless a player is an admin or moderator).
Please note: there is also a whitelist that is intended
to work in an opposite way by allowing access only to those players
that are listed in a whitelist while everyone else is not allowed.
* Type: server (moderator/operator only)
* Usage:
/ban <playerName>
/mod.blackList.add <playerName>

/banFaction
/mod.blackList.addFaction
* Description: Adds members of the specified faction into the blacklist.
Players from this list cannot connect to the game server
(unless a player is an admin or moderator).
Please note: there is also a whitelist that is intended
to work in an opposite way by allowing access only to those players
that are listed in a whitelist while everyone else is not allowed.
* Type: server (moderator/operator only)
* Usage:
/banFaction <clanTag>
/mod.blackList.addFaction <clanTag>

/mod.blackList.print
* Description: Prints the blacklist content.
* Type: server (moderator/operator only)
* Usage:
/mod.blackList.print

/mod.blackList.remove
* Description: Removes a player name from the blacklist.
* Type: server (moderator/operator only)
* Usage:
/mod.blackList.remove <playerName>

/kick
/mod.kickList.add
* Description: Kicks the player from the server for the defined amount of time. If you want to add a kick reason, you can do this by writing it in the "quotes" right after the number of minutes.
* Type: server (moderator/operator only)
* Usage:
/kick <character> [minutes] [kickMessageInQuotes]
/mod.kickList.add <character> [minutes] [kickMessageInQuotes]

/kickFaction
/mod.kickList.addFaction
* Description: Kicks members of the specified faction from the server for the specified amount of time.
If you want to add a kick reason, you can do this by writing it in the "quotes"
right after the number of minutes.
* Type: server (moderator/operator only)
* Usage:
/kickFaction <clanTag> [minutes] [kickMessageInQuotes]
/mod.kickList.addFaction <clanTag> [minutes] [kickMessageInQuotes]

/mod.kickList.print
* Description: Prints the kicked players list content.
* Type: server (moderator/operator only)
* Usage:
/mod.kickList.print

/mod.kickList.remove
* Description: Un-kicks the player (remove from the temporary kick list on the server).
* Type: server (moderator/operator only)
* Usage:
/mod.kickList.remove <playerName>

/mute
/mod.muteList.add
* Description: Mutes the player on the server for the defined amount of time.
* Type: server (moderator/operator only)
* Usage:
/mute <character> [minutes]
/mod.muteList.add <character> [minutes]

/mod.muteList.print
* Description: Prints the muted players list content.
* Type: server (moderator/operator only)
* Usage:
/mod.muteList.print

/mod.muteList.remove
* Description: Un-mutes the player (remove from the temporary mute list on the server).
* Type: server (moderator/operator only)
* Usage:
/mod.muteList.remove <playerName>

/whiteListAdd
/mod.whiteList.add
* Description: Adds a player name into the whitelist.
Please don't forget to enable the whitelist after adding a player there.
* Type: server (moderator/operator only)
* Usage:
/whiteListAdd <playerName>
/mod.whiteList.add <playerName>

/mod.whiteList.enabled
* Description: Enables or disables the whitelist.
When the whitelist enabled, only players added to the whitelist
can connect to the server (plus admins and moderators).
Please note: there is also a blacklist that is intended
to work in an opposite way by disallowing access only to those players
that are listed in a blacklist while everyone else is allowed.
* Type: server (moderator/operator only)
* Usage:
/mod.whiteList.enabled
/mod.whiteList.enabled <isEnabled>

/mod.whiteList.print
* Description: Prints the whitelist content.
* Type: server (moderator/operator only)
* Usage:
/mod.whiteList.print

/mod.whiteList.remove
* Description: Removes a player name from the whitelist.
* Type: server (moderator/operator only)
* Usage:
/mod.whiteList.remove <playerName>

/party.browse
* Description: Browse the party of the specified player.
* Type: server (moderator/operator only)
* Usage:
/party.browse <player>

/player.addLP
* Description: Add technology learning points value for a player character.
* Type: server (operator only)
* Usage:
/player.addLP <learningPoints> [player]

/player.despawn
* Description: Despawns the specified player's character.
* Type: server (operator only)
* Usage:
/player.despawn [player]

/player.discoverMap
* Description: Discover whole map for the player character.
* Type: server (operator only)
* Usage:
/player.discoverMap [player]

/pos
/player.getPosition
* Description: Get the world position of a player character.
* Type: server (operator only)
* Usage:
/pos [player]
/player.getPosition [player]

/heal
/player.heal
* Description: Restore 100% of the player character health, energy, etc.
* Type: server (operator only)
* Usage:
/heal [player]
/player.heal [player]

/addItem
/player.items.add
* Description: Adds specified item(s) to a player character.
* Type: server (operator only)
* Usage:
/addItem <item> [count] [player]
/player.items.add <item> [count] [player]

/player.items.reset
* Description: Removes all items from a given player character.
* Type: server (operator only)
* Usage:
/player.items.reset [player]

/killMe
/player.killMe
* Description: Kills you. Use when you desperately need to get rid of yourself and respawn. You cannot kill yourself more often than once in 5 minutes.
* Type: server (operator only)
* Usage:
/killMe
/player.killMe

(/)player.printFinalCache
* Description: Prints the current final stats cache of the player character.
It lists all the applied stats with their sources.
* Type: client & server (operator only)
* Usage:
/player.printFinalCache [player]

/creative
/player.setCreativeMode
* Description: Toggles creative mode.
This mode allows you to build without using any resources also skipping the entire build phases.
This mode is enabled by default in the Editor mode.
* Type: server (operator only)
* Usage:
/creative <isEnabled> [character]
/player.setCreativeMode <isEnabled> [character]

/player.setEnergy
* Description: Sets energy value to a player character. The energy value is automatically clamped into the available range.
* Type: server (operator only)
* Usage:
/player.setEnergy <energy> [character]

/player.setFood
* Description: Sets food value to a player character. The food value is automatically clamped into the available range.
* Type: server (operator only)
* Usage:
/player.setFood <food> [character]

/player.setHealth
* Description: Sets health value to a player character. The health value is automatically clamped into the available range.
* Type: server (operator only)
* Usage:
/player.setHealth <health> [character]

/god
/player.setInvincibility
* Description: Sets invincibility to a player character.
* Type: server (operator only)
* Usage:
/god [isEnabled] [character]
/player.setInvincibility [isEnabled] [character]

/player.setLP
* Description: Set technology learning points value for a player character.
* Type: server (operator only)
* Usage:
/player.setLP <learningPoints> [player]

/player.setNewbieMode
* Description: Toggles newbie protection.
* Type: server (operator only)
* Usage:
/player.setNewbieMode <isEnabled> [character]

/player.setOrigin
* Description: Change origin for a player character.
* Type: server (operator only)
* Usage:
/player.setOrigin <origin> [player]

/spectator
/player.setSpectatorMode
* Description: Toggles spectator mode.
* Type: server (moderator/operator only)
* Usage:
/spectator <isEnabled> [character]
/player.setSpectatorMode <isEnabled> [character]

/player.setTotalAccumulatedLP
* Description: Set total accumulated technology learning points value for a player character.
* Type: server (operator only)
* Usage:
/player.setTotalAccumulatedLP <learningPoints> [player]

/player.setWater
* Description: Sets water value to a player character. The water value is automatically clamped into the available range.
* Type: server (operator only)
* Usage:
/player.setWater <water> [character]

/tp
/player.teleport
* Description: Teleports a player character to the specified tile position in the world or to another player depending on arguments used.
* Type: server (moderator/operator only)
* Usage:
/tp <toPlayer> [player]
/tp <x> <y> [player]
/player.teleport <toPlayer> [player]
/player.teleport <x> <y> [player]

/quest.add
* Description: Add quest to a player (even if prerequisites are not satisfied).
* Type: server (operator only)
* Usage:
/quest.add <quest> [player]

/quest.addAll
* Description: Add all quests to a player (even if prerequisites are not satisfied).
* Type: server (operator only)
* Usage:
/quest.addAll [player]

/quest.complete
* Description: Complete a specific active quest for player (even if prerequisites are not satisfied).
* Type: server (operator only)
* Usage:
/quest.complete <quest> [player]

/quest.completeAll
* Description: Complete all quests to a player (even if the quest is not added or the prerequisites are not satisfied).
* Type: server (operator only)
* Usage:
/quest.completeAll [player]

/quest.completeAllActive
* Description: Complete all active quests to a player (even if prerequisites are not satisfied).
* Type: server (operator only)
* Usage:
/quest.completeAllActive [player]

/quest.remove
* Description: Remove quest from a player (if exist).
* Type: server (operator only)
* Usage:
/quest.remove <quest> [player]

/quest.removeAll
* Description: Remove all quests from a player.
* Type: server (operator only)
* Usage:
/quest.removeAll [player]

/quest.reset
* Description: Reset quest to a player (if exist).
* Type: server (operator only)
* Usage:
/quest.reset <quest> [player]

/skills.addExp
* Description: Add skill experience for a specified skill.
* Type: server (operator only)
* Usage:
/skills.addExp <skill> <exp> [player]

/skills.list
* Description: Print full list of skills of a player.
* Type: server (operator only)
* Usage:
/skills.list [player]

/skills.resetAll
* Description: Reset all the player skills.
* Type: server (operator only)
* Usage:
/skills.resetAll [player]

/skills.set
* Description: Set a given skill for a player.
* Type: server (operator only)
* Usage:
/skills.set <skill> [level] [player]

/skills.setAll
* Description: Set specific level for all skills of a player.
* Type: server (operator only)
* Usage:
/skills.setAll [level] [player]

/statusEffects.add
* Description: Adds specified status effect to a player character.
* Type: server (operator only)
* Usage:
/statusEffects.add <statusEffect> [intensityToAdd] [player]

/statusEffects.addAll
* Description: Adds all possible status effects (some of them will be immediately remowed, however, as they cannot exist together).
* Type: server (operator only)
* Usage:
/statusEffects.addAll [player]

/statusEffects.remove
* Description: Removes specified status effect from a player character.
* Type: server (operator only)
* Usage:
/statusEffects.remove <statusEffect> [player]

/statusEffects.reset
* Description: Remove all status effects.
* Type: server (operator only)
* Usage:
/statusEffects.reset [player]

/tech.addAll
* Description: Add all tech groups and all nodes to a player.
* Type: server (operator only)
* Usage:
/tech.addAll [player]

/tech.addAllGroups
* Description: Add all tech groups to a player (without their nodes).
* Type: server (operator only)
* Usage:
/tech.addAllGroups [player]

/tech.addGroup
* Description: Add a particular tech group to a player.
* Type: server (operator only)
* Usage:
/tech.addGroup <group> [player]

/tech.addNode
* Description: Add a tech node to a player. It will also add all other required nodes if there's a conflict.
* Type: server (operator only)
* Usage:
/tech.addNode <node> [player]

/tech.addTier
* Description: Add a particular tech tier to a player. The argument controls whether the tech nodes of the tech gr
* Type: server (operator only)
* Usage:
/tech.addTier <tier> <withNodes> [player]

/tech.removeAll
* Description: Remove all tech groups/nodes from a player.
* Type: server (operator only)
* Usage:
/tech.removeAll [player]

/tech.removeGroup
* Description: Remove a tech group from a player.
* Type: server (operator only)
* Usage:
/tech.removeGroup <group> [player]

/tech.removeNode
* Description: Remove a tech node from a player.
* Type: server (operator only)
* Usage:
/tech.removeNode <node> [player]

/tech.resetTechTreeAndRefundLP
* Description: Reset player's tech tree and refund all the LP.
* Type: server (operator only)
* Usage:
/tech.resetTechTreeAndRefundLP [player]

/tech.setGroupCompletion
* Description: Add tech group and enable nodes to have desired percent of completion (value from 0 to 1, inclusive) to a player. This is useful when you need a particular tech group to have some nodes, but not all.
* Type: server (operator only)
* Usage:
/tech.setGroupCompletion <techGroup> <completionPercent> [player]

/world.activateBaseRaidblock
* Description: Activates raidblock status for the base where character is present now.
* Type: server (operator only)
* Usage:
/world.activateBaseRaidblock [character]

/world.destroy
* Description: Destroys the closest world object in the player character position or neighbor tiles.
You can use this to destroy any creatures, buildings or objects such as resources.
* Type: server (operator only)
* Usage:
/world.destroy [character]
/world.destroy <x> <y>

/world.destroyAll
* Description: Destroys all static world objects of the specific prototype.
* Type: server (operator only)
* Usage:
/world.destroyAll <protoObject>

/place
/world.place
* Description: Places a static world object in the player character position or in any specified position.
You can use this to spawn new buildings and resources.
You need to provide a player character name to place an object in its position.
Please note that the character must be in spectator mode.
* Type: server (operator only)
* Usage:
/place <protoStaticWorldObject> [character]
/place <objTypeName> <x> <y>
/world.place <protoStaticWorldObject> [character]
/world.place <objTypeName> <x> <y>

/world.setTimeOfDay
* Description: Forces specified time of day on the server.
To reset please execute this command without any arguments.
* Type: server (operator only)
* Usage:
/world.setTimeOfDay [hour] [minute]

/spawnVehicle
/world.spawnVehicle
* Description: Spawns a vehicle in the player character position or in any specified position.
You need to provide a player character name to place a vehicle in its position.
Please note that the character must be in spectator mode.
* Type: server (operator only)
* Usage:
/spawnVehicle <protoDynamicWorldObject> [character]
/spawnVehicle <objTypeName> <x> <y>
/world.spawnVehicle <protoDynamicWorldObject> [character]
/world.spawnVehicle <objTypeName> <x> <y>
</pre>

CryoFall/Server/Commands

2021-10-09T09:28:43Z

Ai enabled: /* Server commands list */

== CryoFall server commands ==
Please read the [[CryoFall/Server/Setup|Server Setup Guide]] first.
 This is just a list of all the server console commands.
 You need to '''execute them right from the game''' by using in-game console as described in the [[CryoFall/Server/Setup|Server Setup Guide]].
 Most of these commands are requiring '''server operator access'''.

== Server commands list ==

<pre>
/achievement.add
* Description: Add (unlock) achievement to a player.
* Type: server (operator only)
* Usage:
/achievement.add <achievement> [player]

/achievement.addAll
* Description: Add all achievements to a player.
* Type: server (operator only)
* Usage:
/achievement.addAll [player]

(/)achievement.listUnlocked
* Description: List unlocked achievements of a player.
* Type: client & server (operator only)
* Usage:
/achievement.listUnlocked [player]

/achievement.remove
* Description: Remove achievement from a player.
* Type: server (operator only)
* Usage:
/achievement.remove <achievement> [player]

/achievement.removeAll
* Description: Remove all achievements from a player.
* Type: server (operator only)
* Usage:
/achievement.removeAll [player]

/admin.clearEventPastLocations
* Description: Clear all the past locations for all the events (so new events could happen there again).
* Type: server (operator only)
* Usage:
/admin.clearEventPastLocations

/admin.finishEvents
* Description: Finishes all the active world events.
* Type: server (operator only)
* Usage:
/admin.finishEvents

/admin.giveawayItem
* Description: Adds specified item(s) to all player characters.
* Type: server (operator only)
* Usage:
/admin.giveawayItem <item> [count]

/admin.giveawayLP
* Description: Adds specified item(s) to all player characters.
* Type: server (operator only)
* Usage:
/admin.giveawayLP <learningPoints>

/admin.listCreativeModePlayers
* Description: Lists players currently in creative mode
* Type: server (operator only)
* Usage:
/admin.listCreativeModePlayers

/admin.listLandClaims
* Description: List all the land claims of the specified player or of all the players.
* Type: server (operator only)
* Usage:
/admin.listLandClaims
/admin.listLandClaims <player>

/admin.listLandClaimsOwners
* Description: List all the land claims with their owners.
* Type: server (operator only)
* Usage:
/admin.listLandClaimsOwners [minOwnersNumber]

/moderatorAdd
/admin.moderator.add
* Description: Adds server moderator.
* Type: server (operator only)
* Usage:
/moderatorAdd [character]
/admin.moderator.add [character]

/moderatorList
/admin.moderator.list
* Description: Lists server moderators.
* Type: server (operator only)
* Usage:
/moderatorList
/admin.moderator.list

/moderatorRemove
/admin.moderator.remove
* Description: Removes server moderator.
* Type: server (operator only)
* Usage:
/moderatorRemove [character]
/admin.moderator.remove [character]

/admin.notifyAll
* Description: Notifies all players on the server.
Important: wrap the "message text in quotes"!
* Type: server (operator only)
* Usage:
/admin.notifyAll <messageInQuotes>

/admin.notifyPlayer
* Description: Notifies a player on the server.
Important: wrap the "message text in quotes"!
* Type: server (operator only)
* Usage:
/admin.notifyPlayer <player> <messageInQuotes>

/opAdd
/admin.operator.add
* Description: Adds server operator.
* Type: server (operator only)
* Usage:
/opAdd [character]
/admin.operator.add [character]

/opList
/admin.operator.list
* Description: Lists server operators.
* Type: server (operator only)
* Usage:
/opList
/admin.operator.list

/opRemove
/admin.operator.remove
* Description: Removes server operator.
* Type: server (operator only)
* Usage:
/opRemove [character]
/admin.operator.remove [character]

/pwn
/admin.pwn
* Description: Special debug command to add useful items to the player character.
* Type: server (operator only)
* Usage:
/pwn [player]
/admin.pwn [player]

/admin.setRaidingWindow
* Description: Set raiding window. Please ensure you're using a correct UTC offset!
To disable raiding protection completely, please set 24 hours duration from any hour with any UTC offset.
* Type: server (operator only)
* Usage:
/admin.setRaidingWindow <UTC> <fromHour> <duration>

/admin.spawnAll
* Description: Executes all spawn scripts.
* Type: server (operator only)
* Usage:
/admin.spawnAll

/admin.spawnZone
* Description: Executes all spawn scripts for the specified zone.
* Type: server (operator only)
* Usage:
/admin.spawnZone <protoZone>
/admin.spawnZone <protoZone> [isInitialSpawn]

/startEvent
/admin.startEvent
* Description: Creates and starts an event. Use autocomplete to browse all the available events. To finish all the ongoing events you can use /admin.finishEvents
* Type: server (operator only)
* Usage:
/startEvent <eventName>
/admin.startEvent <eventName>

/completionist.addAll
* Description: Add all completionist entries to player.
* Type: server (operator only)
* Usage:
/completionist.addAll [player]

/completionist.list
* Description: Lists all completionist entries for player.
* Type: server (operator only)
* Usage:
/completionist.list [player]

/completionist.reset
* Description: Reset completionist entries for player.
* Type: server (operator only)
* Usage:
/completionist.reset [player]

(/)help
(/)console.help
* Description: Prints information about all the available console commands.
* Type: client & server (operator only)
* Usage:
/help [searchCommand]
/console.help [searchCommand]

(/)console.logSeverity
* Description: Gets or sets current log severity.
* Type: client & server (operator only)
* Usage:
/console.logSeverity [severity]

/kit
/demo.kit
* Description: Adds sets of items according to specified category to the player character.
* Type: server (operator only)
* Usage:
/kit [category] [player]
/demo.kit [category] [player]

/faction.accept
* Description: Accepts player to the faction. The player must submit an application to the faction first.
* Type: server (operator only)
* Usage:
/faction.accept <player> <clanTag>

/faction.browse
* Description: Browse the faction of the specified player.
* Type: server (moderator/operator only)
* Usage:
/faction.browse <player>

/faction.resetFactionJoinCooldown
* Description: Resets the faction leave join cooldown. Player can join any faction instantly.
* Type: server (moderator/operator only)
* Usage:
/faction.resetFactionJoinCooldown [player]

/faction.setLevel
* Description: Sets the faction level.
* Type: server (operator only)
* Usage:
/faction.setLevel <clanTag> <level>

/faction.setRole
* Description: Changes the faction role of the provided character. Cannot change to leader and cannot change from leader to another role.
* Type: server (operator only)
* Usage:
/faction.setRole [player] <role>

/faction.updateLeaderboard
* Description: Forces an update of the factions leaderboard.
* Type: server (operator only)
* Usage:
/faction.updateLeaderboard

/spawn
/mobs.spawn
* Description: Spawns a mob of the specified type to the specified tile position in the world or near the specified character, depending on arguments used.
* Type: server (operator only)
* Usage:
/spawn <protoMob> [count] [nearPlayer]
/spawn <protoMob> <x> <y> [count]
/mobs.spawn <protoMob> [count] [nearPlayer]
/mobs.spawn <protoMob> <x> <y> [count]

/ban
/mod.blackList.add
* Description: Adds a player name into the blacklist.
Players from this list cannot connect to the game server
(unless a player is an admin or moderator).
Please note: there is also a whitelist that is intended
to work in an opposite way by allowing access only to those players
that are listed in a whitelist while everyone else is not allowed.
* Type: server (moderator/operator only)
* Usage:
/ban <playerName>
/mod.blackList.add <playerName>

/banFaction
/mod.blackList.addFaction
* Description: Adds members of the specified faction into the blacklist.
Players from this list cannot connect to the game server
(unless a player is an admin or moderator).
Please note: there is also a whitelist that is intended
to work in an opposite way by allowing access only to those players
that are listed in a whitelist while everyone else is not allowed.
* Type: server (moderator/operator only)
* Usage:
/banFaction <clanTag>
/mod.blackList.addFaction <clanTag>

/mod.blackList.print
* Description: Prints the blacklist content.
* Type: server (moderator/operator only)
* Usage:
/mod.blackList.print

/mod.blackList.remove
* Description: Removes a player name from the blacklist.
* Type: server (moderator/operator only)
* Usage:
/mod.blackList.remove <playerName>

/kick
/mod.kickList.add
* Description: Kicks the player from the server for the defined amount of time. If you want to add a kick reason, you can do this by writing it in the "quotes" right after the number of minutes.
* Type: server (moderator/operator only)
* Usage:
/kick <character> [minutes] [kickMessageInQuotes]
/mod.kickList.add <character> [minutes] [kickMessageInQuotes]

/kickFaction
/mod.kickList.addFaction
* Description: Kicks members of the specified faction from the server for the specified amount of time.
If you want to add a kick reason, you can do this by writing it in the "quotes"
right after the number of minutes.
* Type: server (moderator/operator only)
* Usage:
/kickFaction <clanTag> [minutes] [kickMessageInQuotes]
/mod.kickList.addFaction <clanTag> [minutes] [kickMessageInQuotes]

/mod.kickList.print
* Description: Prints the kicked players list content.
* Type: server (moderator/operator only)
* Usage:
/mod.kickList.print

/mod.kickList.remove
* Description: Un-kicks the player (remove from the temporary kick list on the server).
* Type: server (moderator/operator only)
* Usage:
/mod.kickList.remove <playerName>

/mute
/mod.muteList.add
* Description: Mutes the player on the server for the defined amount of time.
* Type: server (moderator/operator only)
* Usage:
/mute <character> [minutes]
/mod.muteList.add <character> [minutes]

/mod.muteList.print
* Description: Prints the muted players list content.
* Type: server (moderator/operator only)
* Usage:
/mod.muteList.print

/mod.muteList.remove
* Description: Un-mutes the player (remove from the temporary mute list on the server).
* Type: server (moderator/operator only)
* Usage:
/mod.muteList.remove <playerName>

/whiteListAdd
/mod.whiteList.add
* Description: Adds a player name into the whitelist.
Please don't forget to enable the whitelist after adding a player there.
* Type: server (moderator/operator only)
* Usage:
/whiteListAdd <playerName>
/mod.whiteList.add <playerName>

/mod.whiteList.enabled
* Description: Enables or disables the whitelist.
When the whitelist enabled, only players added to the whitelist
can connect to the server (plus admins and moderators).
Please note: there is also a blacklist that is intended
to work in an opposite way by disallowing access only to those players
that are listed in a blacklist while everyone else is allowed.
* Type: server (moderator/operator only)
* Usage:
/mod.whiteList.enabled
/mod.whiteList.enabled <isEnabled>

/mod.whiteList.print
* Description: Prints the whitelist content.
* Type: server (moderator/operator only)
* Usage:
/mod.whiteList.print

/mod.whiteList.remove
* Description: Removes a player name from the whitelist.
* Type: server (moderator/operator only)
* Usage:
/mod.whiteList.remove <playerName>

/party.browse
* Description: Browse the party of the specified player.
* Type: server (moderator/operator only)
* Usage:
/party.browse <player>

/player.addLP
* Description: Add technology learning points value for a player character.
* Type: server (operator only)
* Usage:
/player.addLP <learningPoints> [player]

/player.despawn
* Description: Despawns the specified player's character.
* Type: server (operator only)
* Usage:
/player.despawn [player]

/player.discoverMap
* Description: Discover whole map for the player character.
* Type: server (operator only)
* Usage:
/player.discoverMap [player]

/pos
/player.getPosition
* Description: Get the world position of a player character.
* Type: server (operator only)
* Usage:
/pos [player]
/player.getPosition [player]

/heal
/player.heal
* Description: Restore 100% of the player character health, energy, etc.
* Type: server (operator only)
* Usage:
/heal [player]
/player.heal [player]

/addItem
/player.items.add
* Description: Adds specified item(s) to a player character.
* Type: server (operator only)
* Usage:
/addItem <item> [count] [player]
/player.items.add <item> [count] [player]

/player.items.reset
* Description: Removes all items from a given player character.
* Type: server (operator only)
* Usage:
/player.items.reset [player]

/killMe
/player.killMe
* Description: Kills you. Use when you desperately need to get rid of yourself and respawn. You cannot kill yourself more often than once in 5 minutes.
* Type: server (operator only)
* Usage:
/killMe
/player.killMe

(/)player.printFinalCache
* Description: Prints the current final stats cache of the player character.
It lists all the applied stats with their sources.
* Type: client & server (operator only)
* Usage:
/player.printFinalCache [player]

/creative
/player.setCreativeMode
* Description: Toggles creative mode.
This mode allows you to build without using any resources also skipping the entire build phases.
This mode is enabled by default in the Editor mode.
* Type: server (operator only)
* Usage:
/creative <isEnabled> [character]
/player.setCreativeMode <isEnabled> [character]

/player.setEnergy
* Description: Sets energy value to a player character. The energy value is automatically clamped into the available range.
* Type: server (operator only)
* Usage:
/player.setEnergy <energy> [character]

/player.setFood
* Description: Sets food value to a player character. The food value is automatically clamped into the available range.
* Type: server (operator only)
* Usage:
/player.setFood <food> [character]

/player.setHealth
* Description: Sets health value to a player character. The health value is automatically clamped into the available range.
* Type: server (operator only)
* Usage:
/player.setHealth <health> [character]

/god
/player.setInvincibility
* Description: Sets invincibility to a player character.
* Type: server (operator only)
* Usage:
/god [isEnabled] [character]
/player.setInvincibility [isEnabled] [character]

/player.setLP
* Description: Set technology learning points value for a player character.
* Type: server (operator only)
* Usage:
/player.setLP <learningPoints> [player]

/player.setNewbieMode
* Description: Toggles newbie protection.
* Type: server (operator only)
* Usage:
/player.setNewbieMode <isEnabled> [character]

/player.setOrigin
* Description: Change origin for a player character.
* Type: server (operator only)
* Usage:
/player.setOrigin <origin> [player]

/spectator
/player.setSpectatorMode
* Description: Toggles spectator mode.
* Type: server (moderator/operator only)
* Usage:
/spectator <isEnabled> [character]
/player.setSpectatorMode <isEnabled> [character]

/player.setTotalAccumulatedLP
* Description: Set total accumulated technology learning points value for a player character.
* Type: server (operator only)
* Usage:
/player.setTotalAccumulatedLP <learningPoints> [player]

/player.setWater
* Description: Sets water value to a player character. The water value is automatically clamped into the available range.
* Type: server (operator only)
* Usage:
/player.setWater <water> [character]

/tp
/player.teleport
* Description: Teleports a player character to the specified tile position in the world or to another player depending on arguments used.
* Type: server (moderator/operator only)
* Usage:
/tp <toPlayer> [player]
/tp <x> <y> [player]
/player.teleport <toPlayer> [player]
/player.teleport <x> <y> [player]

/quest.add
* Description: Add quest to a player (even if prerequisites are not satisfied).
* Type: server (operator only)
* Usage:
/quest.add <quest> [player]

/quest.addAll
* Description: Add all quests to a player (even if prerequisites are not satisfied).
* Type: server (operator only)
* Usage:
/quest.addAll [player]

/quest.complete
* Description: Complete a specific active quest for player (even if prerequisites are not satisfied).
* Type: server (operator only)
* Usage:
/quest.complete <quest> [player]

/quest.completeAll
* Description: Complete all quests to a player (even if the quest is not added or the prerequisites are not satisfied).
* Type: server (operator only)
* Usage:
/quest.completeAll [player]

/quest.completeAllActive
* Description: Complete all active quests to a player (even if prerequisites are not satisfied).
* Type: server (operator only)
* Usage:
/quest.completeAllActive [player]

/quest.remove
* Description: Remove quest from a player (if exist).
* Type: server (operator only)
* Usage:
/quest.remove <quest> [player]

/quest.removeAll
* Description: Remove all quests from a player.
* Type: server (operator only)
* Usage:
/quest.removeAll [player]

/quest.reset
* Description: Reset quest to a player (if exist).
* Type: server (operator only)
* Usage:
/quest.reset <quest> [player]

/skills.addExp
* Description: Add skill experience for a specified skill.
* Type: server (operator only)
* Usage:
/skills.addExp <skill> <exp> [player]

/skills.list
* Description: Print full list of skills of a player.
* Type: server (operator only)
* Usage:
/skills.list [player]

/skills.resetAll
* Description: Reset all the player skills.
* Type: server (operator only)
* Usage:
/skills.resetAll [player]

/skills.set
* Description: Set a given skill for a player.
* Type: server (operator only)
* Usage:
/skills.set <skill> [level] [player]

/skills.setAll
* Description: Set specific level for all skills of a player.
* Type: server (operator only)
* Usage:
/skills.setAll [level] [player]

/statusEffects.add
* Description: Adds specified status effect to a player character.
* Type: server (operator only)
* Usage:
/statusEffects.add <statusEffect> [intensityToAdd] [player]

/statusEffects.addAll
* Description: Adds all possible status effects (some of them will be immediately remowed, however, as they cannot exist together).
* Type: server (operator only)
* Usage:
/statusEffects.addAll [player]

/statusEffects.remove
* Description: Removes specified status effect from a player character.
* Type: server (operator only)
* Usage:
/statusEffects.remove <statusEffect> [player]

/statusEffects.reset
* Description: Remove all status effects.
* Type: server (operator only)
* Usage:
/statusEffects.reset [player]

/tech.addAll
* Description: Add all tech groups and all nodes to a player.
* Type: server (operator only)
* Usage:
/tech.addAll [player]

/tech.addAllGroups
* Description: Add all tech groups to a player (without their nodes).
* Type: server (operator only)
* Usage:
/tech.addAllGroups [player]

/tech.addGroup
* Description: Add a particular tech group to a player.
* Type: server (operator only)
* Usage:
/tech.addGroup <group> [player]

/tech.addNode
* Description: Add a tech node to a player. It will also add all other required nodes if there's a conflict.
* Type: server (operator only)
* Usage:
/tech.addNode <node> [player]

/tech.addTier
* Description: Add a particular tech tier to a player. The argument controls whether the tech nodes of the tech gr
* Type: server (operator only)
* Usage:
/tech.addTier <tier> <withNodes> [player]

/tech.removeAll
* Description: Remove all tech groups/nodes from a player.
* Type: server (operator only)
* Usage:
/tech.removeAll [player]

/tech.removeGroup
* Description: Remove a tech group from a player.
* Type: server (operator only)
* Usage:
/tech.removeGroup <group> [player]

/tech.removeNode
* Description: Remove a tech node from a player.
* Type: server (operator only)
* Usage:
/tech.removeNode <node> [player]

/tech.resetTechTreeAndRefundLP
* Description: Reset player's tech tree and refund all the LP.
* Type: server (operator only)
* Usage:
/tech.resetTechTreeAndRefundLP [player]

/tech.setGroupCompletion
* Description: Add tech group and enable nodes to have desired percent of completion (value from 0 to 1, inclusive) to a player. This is useful when you need a particular tech group to have some nodes, but not all.
* Type: server (operator only)
* Usage:
/tech.setGroupCompletion <techGroup> <completionPercent> [player]

/world.activateBaseRaidblock
* Description: Activates raidblock status for the base where character is present now.
* Type: server (operator only)
* Usage:
/world.activateBaseRaidblock [character]

/world.destroy
* Description: Destroys the closest world object in the player character position or neighbor tiles.
You can use this to destroy any creatures, buildings or objects such as resources.
* Type: server (operator only)
* Usage:
/world.destroy [character]
/world.destroy <x> <y>

/world.destroyAll
* Description: Destroys all static world objects of the specific prototype.
* Type: server (operator only)
* Usage:
/world.destroyAll <protoObject>

/place
/world.place
* Description: Places a static world object in the player character position or in any specified position.
You can use this to spawn new buildings and resources.
You need to provide a player character name to place an object in its position.
Please note that the character must be in spectator mode.
* Type: server (operator only)
* Usage:
/place <protoStaticWorldObject> [character]
/place <objTypeName> <x> <y>
/world.place <protoStaticWorldObject> [character]
/world.place <objTypeName> <x> <y>

/world.setTimeOfDay
* Description: Forces specified time of day on the server.
To reset please execute this command without any arguments.
* Type: server (operator only)
* Usage:
/world.setTimeOfDay [hour] [minute]

/spawnVehicle
/world.spawnVehicle
* Description: Spawns a vehicle in the player character position or in any specified position.
You need to provide a player character name to place a vehicle in its position.
Please note that the character must be in spectator mode.
* Type: server (operator only)
* Usage:
/spawnVehicle <protoDynamicWorldObject> [character]
/spawnVehicle <objTypeName> <x> <y>
/world.spawnVehicle <protoDynamicWorldObject> [character]
/world.spawnVehicle <objTypeName> <x> <y>
</pre>

CryoFall/Server/Commands

2021-10-09T09:25:44Z

Ai enabled: /* Server commands list */

== CryoFall server commands ==
Please read the [[CryoFall/Server/Setup|Server Setup Guide]] first.
 This is just a list of all the server console commands.
 You need to '''execute them right from the game''' by using in-game console as described in the [[CryoFall/Server/Setup|Server Setup Guide]].
 Most of these commands are requiring '''server operator access'''.

== Server commands list ==

<pre>
/achievement.add
* Description: Add (unlock) achievement to a player.
* Type: server (operator only)
* Usage:
/achievement.add <achievement> [player]

/achievement.addAll
* Description: Add all achievements to a player.
* Type: server (operator only)
* Usage:
/achievement.addAll [player]

(/)achievement.listUnlocked
* Description: List unlocked achievements of a player.
* Type: client & server (operator only)
* Usage:
/achievement.listUnlocked [player]

/achievement.remove
* Description: Remove achievement from a player.
* Type: server (operator only)
* Usage:
/achievement.remove <achievement> [player]

/achievement.removeAll
* Description: Remove all achievements from a player.
* Type: server (operator only)
* Usage:
/achievement.removeAll [player]

/admin.clearEventPastLocations
* Description: Clear all the past locations for all the events (so new events could happen there again).
* Type: server (operator only)
* Usage:
/admin.clearEventPastLocations

/admin.finishEvents
* Description: Finishes all the active world events.
* Type: server (operator only)
* Usage:
/admin.finishEvents

/admin.giveawayItem
* Description: Adds specified item(s) to all player characters.
* Type: server (operator only)
* Usage:
/admin.giveawayItem <item> [count]

/admin.giveawayLP
* Description: Adds specified item(s) to all player characters.
* Type: server (operator only)
* Usage:
/admin.giveawayLP <learningPoints>

/admin.listCreativeModePlayers
* Description: Lists players currently in creative mode
* Type: server (operator only)
* Usage:
/admin.listCreativeModePlayers

/admin.listLandClaims
* Description: List all the land claims of the specified player or of all the players.
* Type: server (operator only)
* Usage:
/admin.listLandClaims
/admin.listLandClaims <player>

/admin.listLandClaimsOwners
* Description: List all the land claims with their owners.
* Type: server (operator only)
* Usage:
/admin.listLandClaimsOwners [minOwnersNumber]

/moderatorAdd
/admin.moderator.add
* Description: Adds server moderator.
* Type: server (operator only)
* Usage:
/moderatorAdd [character]
/admin.moderator.add [character]

/moderatorList
/admin.moderator.list
* Description: Lists server moderators.
* Type: server (operator only)
* Usage:
/moderatorList
/admin.moderator.list

/moderatorRemove
/admin.moderator.remove
* Description: Removes server moderator.
* Type: server (operator only)
* Usage:
/moderatorRemove [character]
/admin.moderator.remove [character]

/admin.notifyAll
* Description: Notifies all players on the server.
Important: wrap the "message text in quotes"!
* Type: server (operator only)
* Usage:
/admin.notifyAll <messageInQuotes>

/admin.notifyPlayer
* Description: Notifies a player on the server.
Important: wrap the "message text in quotes"!
* Type: server (operator only)
* Usage:
/admin.notifyPlayer <player> <messageInQuotes>

/opAdd
/admin.operator.add
* Description: Adds server operator.
* Type: server (operator only)
* Usage:
/opAdd [character]
/admin.operator.add [character]

/opList
/admin.operator.list
* Description: Lists server operators.
* Type: server (operator only)
* Usage:
/opList
/admin.operator.list

/opRemove
/admin.operator.remove
* Description: Removes server operator.
* Type: server (operator only)
* Usage:
/opRemove [character]
/admin.operator.remove [character]

/pwn
/admin.pwn
* Description: Special debug command to add useful items to the player character.
* Type: server (operator only)
* Usage:
/pwn [player]
/admin.pwn [player]

/admin.setRaidingWindow
* Description: Set raiding window. Please ensure you're using a correct UTC offset!
To disable raiding protection completely, please set 24 hours duration from any hour with any UTC offset.
* Type: server (operator only)
* Usage:
/admin.setRaidingWindow <UTC> <fromHour> <duration>

/admin.spawnAll
* Description: Executes all spawn scripts.
* Type: server (operator only)
* Usage:
/admin.spawnAll

/admin.spawnZone
* Description: Executes all spawn scripts for the specified zone.
* Type: server (operator only)
* Usage:
/admin.spawnZone <protoZone>
/admin.spawnZone <protoZone> [isInitialSpawn]

/startEvent
/admin.startEvent
* Description: Creates and starts an event. Use autocomplete to browse all the available events. To finish all the ongoing events you can use /admin.finishEvents
* Type: server (operator only)
* Usage:
/startEvent <eventName>
/admin.startEvent <eventName>

/completionist.addAll
* Description: Add all completionist entries to player.
* Type: server (operator only)
* Usage:
/completionist.addAll [player]

/completionist.list
* Description: Lists all completionist entries for player.
* Type: server (operator only)
* Usage:
/completionist.list [player]

/completionist.reset
* Description: Reset completionist entries for player.
* Type: server (operator only)
* Usage:
/completionist.reset [player]

(/)help
(/)console.help
* Description: Prints information about all the available console commands.
* Type: client & server (operator only)
* Usage:
/help [searchCommand]
/console.help [searchCommand]

(/)console.logSeverity
* Description: Gets or sets current log severity.
* Type: client & server (operator only)
* Usage:
/console.logSeverity [severity]

/debug.breakRoads
* Description: Replace roads with broken roads according to a special position-derived algorithm. Can be run multiple times as further executions will not do any changes to the already replaced roads.
* Type: server (operator only)
* Usage:
/debug.breakRoads

/debug.destroyItemsEverywhere
* Description: Finds and destroy all items of specified type from all containers and inventories.
* Type: server (operator only)
* Usage:
/debug.destroyItemsEverywhere <protoItem>

(/)debug.findInvalidNames
* Description: Finds prototypes which have invalid names.
* Type: client & server (operator only)
* Usage:
/debug.findInvalidNames

(/)debug.findNameCollisions
* Description: Finds prototypes which have the duplicate name.
* Type: client & server (operator only)
* Usage:
/debug.findNameCollisions

/debug.forcePragmiumSourceUpdate
* Description: Forces update of all pragmium source minerals in the game. They will attempt to spawn nodes and guardian creatures.
* Type: server (operator only)
* Usage:
/debug.forcePragmiumSourceUpdate

(/)gc
(/)debug.gc
* Description: Invoke GC (garbage collection).
* Type: client & server (operator only)
* Usage:
/gc
/gc <generation>
/debug.gc
/debug.gc <generation>

(/)debug.listRecipes
* Description: Lists all the recipes and buildings and their status (except for recipes/buildings that already belong to any technology nodes). This command is used to find orphaned recipes/buildings.
* Type: client & server (operator only)
* Usage:
/debug.listRecipes <AutoUnlocked|Unavailable>

/debug.listSelectedCharacterOrigins
* Description: Lists how many players selected each character origin.
* Type: server (operator only)
* Usage:
/debug.listSelectedCharacterOrigins

/debug.printConnectionStats
* Description: Print network stats for all the connected clients
* Type: server (operator only)
* Usage:
/debug.printConnectionStats

/debug.resetLandClaimOwner
* Description: Resets the land claim founder to null and resets the access list.
* Type: server (operator only)
* Usage:
/debug.resetLandClaimOwner [nearCharacter]
/debug.resetLandClaimOwner <x> <y>

/debug.resetRaidblock
* Description: Resets server raid block for the base.
* Type: server (operator only)
* Usage:
/debug.resetRaidblock [character]
/debug.resetRaidblock <x> <y>

/debug.save
* Description: Invoke server autosave. You should not normally use itΓÇöthe server should automatically do a snapshot as it's configured. When the server is shutting down it should also performs an autosave.
* Type: server (operator only)
* Usage:
/debug.save

/debug.setAllStructuresHP
* Description: Set structures bar to % of the max value to all structures in the world. Percent is specified as value from 0 to 100.
* Type: server (operator only)
* Usage:
/debug.setAllStructuresHP <hpPercent>

/debug.setAllVegetationFullGrown
* Description: Set all vegetation to full grown state.
* Type: server (operator only)
* Usage:
/debug.setAllVegetationFullGrown

/debug.setBaseShieldCharge
* Description: Modifies charge amount of the S.H.I.E.L.D. (PvP) for the base located near the player.
* Type: server (operator only)
* Usage:
/debug.setBaseShieldCharge [chargePercent] [character]

/debug.setBaseShieldStatus
* Description: Modifies status of the S.H.I.E.L.D. protection (PvP) for the base located near the player.
* Type: server (operator only)
* Usage:
/debug.setBaseShieldStatus <Inactive|Activating|Active> [character]

/debug.setItemsCharge
* Description: Modifies charge/fuel amount of all items in player's inventory/equipment/hotbar to match the required charge percent (provided as value from 0 to 100).
* Type: server (operator only)
* Usage:
/debug.setItemsCharge [chargePercent] [character]

/debug.setItemsDurability
* Description: Modifies durability of all items in player's inventory/equipment/hotbar to match the required durability percent (provided as value from 0 to 100).
* Type: server (operator only)
* Usage:
/debug.setItemsDurability [durabilityPercent] [character]

/debug.setItemsFreshness
* Description: Modifies freshness of all items in player's inventory/equipment/hotbar to match the required freshness percent (provided as value from 0 to 100).
* Type: server (operator only)
* Usage:
/debug.setItemsFreshness [freshnessPercent] [character]

/debug.setLandClaimOwner
* Description: Sets the land claim founder and resets the access list.
* Type: server (operator only)
* Usage:
/debug.setLandClaimOwner [nearCharacter] <newOwner>
/debug.setLandClaimOwner <x> <y> <newOwner>

/debug.setPowerGridCharge
* Description: Modifies charge amount of the power grid for the power grid located near the player.
* Type: server (operator only)
* Usage:
/debug.setPowerGridCharge [chargePercent] [character]

(/)debug.showTechStatistics
* Description: Provides detailed statistics for all technology in the game.
* Type: client & server (operator only)
* Usage:
/debug.showTechStatistics

/debug.testRaidblock
* Description: Enable raid block for the base.
* Type: server (operator only)
* Usage:
/debug.testRaidblock [durationMultiplier] [character]
/debug.testRaidblock <x> <y> [durationMultiplier]

/kit
/demo.kit
* Description: Adds sets of items according to specified category to the player character.
* Type: server (operator only)
* Usage:
/kit [category] [player]
/demo.kit [category] [player]

/editor.breakRuinWalls
* Description: Replace ruin/radtown walls with broken wall according to a special position-derived algorithm. Can be run multiple times as further executions will not do any changes to the already replaced walls.
* Type: server (operator only)
* Usage:
/editor.breakRuinWalls

/faction.accept
* Description: Accepts player to the faction. The player must submit an application to the faction first.
* Type: server (operator only)
* Usage:
/faction.accept <player> <clanTag>

/faction.browse
* Description: Browse the faction of the specified player.
* Type: server (moderator/operator only)
* Usage:
/faction.browse <player>

/faction.resetFactionJoinCooldown
* Description: Resets the faction leave join cooldown. Player can join any faction instantly.
* Type: server (moderator/operator only)
* Usage:
/faction.resetFactionJoinCooldown [player]

/faction.setLevel
* Description: Sets the faction level.
* Type: server (operator only)
* Usage:
/faction.setLevel <clanTag> <level>

/faction.setRole
* Description: Changes the faction role of the provided character. Cannot change to leader and cannot change from leader to another role.
* Type: server (operator only)
* Usage:
/faction.setRole [player] <role>

/faction.updateLeaderboard
* Description: Forces an update of the factions leaderboard.
* Type: server (operator only)
* Usage:
/faction.updateLeaderboard

/spawn
/mobs.spawn
* Description: Spawns a mob of the specified type to the specified tile position in the world or near the specified character, depending on arguments used.
* Type: server (operator only)
* Usage:
/spawn <protoMob> [count] [nearPlayer]
/spawn <protoMob> <x> <y> [count]
/mobs.spawn <protoMob> [count] [nearPlayer]
/mobs.spawn <protoMob> <x> <y> [count]

/ban
/mod.blackList.add
* Description: Adds a player name into the blacklist.
Players from this list cannot connect to the game server
(unless a player is an admin or moderator).
Please note: there is also a whitelist that is intended
to work in an opposite way by allowing access only to those players
that are listed in a whitelist while everyone else is not allowed.
* Type: server (moderator/operator only)
* Usage:
/ban <playerName>
/mod.blackList.add <playerName>

/banFaction
/mod.blackList.addFaction
* Description: Adds members of the specified faction into the blacklist.
Players from this list cannot connect to the game server
(unless a player is an admin or moderator).
Please note: there is also a whitelist that is intended
to work in an opposite way by allowing access only to those players
that are listed in a whitelist while everyone else is not allowed.
* Type: server (moderator/operator only)
* Usage:
/banFaction <clanTag>
/mod.blackList.addFaction <clanTag>

/mod.blackList.print
* Description: Prints the blacklist content.
* Type: server (moderator/operator only)
* Usage:
/mod.blackList.print

/mod.blackList.remove
* Description: Removes a player name from the blacklist.
* Type: server (moderator/operator only)
* Usage:
/mod.blackList.remove <playerName>

/kick
/mod.kickList.add
* Description: Kicks the player from the server for the defined amount of time. If you want to add a kick reason, you can do this by writing it in the "quotes" right after the number of minutes.
* Type: server (moderator/operator only)
* Usage:
/kick <character> [minutes] [kickMessageInQuotes]
/mod.kickList.add <character> [minutes] [kickMessageInQuotes]

/kickFaction
/mod.kickList.addFaction
* Description: Kicks members of the specified faction from the server for the specified amount of time.
If you want to add a kick reason, you can do this by writing it in the "quotes"
right after the number of minutes.
* Type: server (moderator/operator only)
* Usage:
/kickFaction <clanTag> [minutes] [kickMessageInQuotes]
/mod.kickList.addFaction <clanTag> [minutes] [kickMessageInQuotes]

/mod.kickList.print
* Description: Prints the kicked players list content.
* Type: server (moderator/operator only)
* Usage:
/mod.kickList.print

/mod.kickList.remove
* Description: Un-kicks the player (remove from the temporary kick list on the server).
* Type: server (moderator/operator only)
* Usage:
/mod.kickList.remove <playerName>

/mute
/mod.muteList.add
* Description: Mutes the player on the server for the defined amount of time.
* Type: server (moderator/operator only)
* Usage:
/mute <character> [minutes]
/mod.muteList.add <character> [minutes]

/mod.muteList.print
* Description: Prints the muted players list content.
* Type: server (moderator/operator only)
* Usage:
/mod.muteList.print

/mod.muteList.remove
* Description: Un-mutes the player (remove from the temporary mute list on the server).
* Type: server (moderator/operator only)
* Usage:
/mod.muteList.remove <playerName>

/whiteListAdd
/mod.whiteList.add
* Description: Adds a player name into the whitelist.
Please don't forget to enable the whitelist after adding a player there.
* Type: server (moderator/operator only)
* Usage:
/whiteListAdd <playerName>
/mod.whiteList.add <playerName>

/mod.whiteList.enabled
* Description: Enables or disables the whitelist.
When the whitelist enabled, only players added to the whitelist
can connect to the server (plus admins and moderators).
Please note: there is also a blacklist that is intended
to work in an opposite way by disallowing access only to those players
that are listed in a blacklist while everyone else is allowed.
* Type: server (moderator/operator only)
* Usage:
/mod.whiteList.enabled
/mod.whiteList.enabled <isEnabled>

/mod.whiteList.print
* Description: Prints the whitelist content.
* Type: server (moderator/operator only)
* Usage:
/mod.whiteList.print

/mod.whiteList.remove
* Description: Removes a player name from the whitelist.
* Type: server (moderator/operator only)
* Usage:
/mod.whiteList.remove <playerName>

/party.browse
* Description: Browse the party of the specified player.
* Type: server (moderator/operator only)
* Usage:
/party.browse <player>

/player.addLP
* Description: Add technology learning points value for a player character.
* Type: server (operator only)
* Usage:
/player.addLP <learningPoints> [player]

/player.despawn
* Description: Despawns the specified player's character.
* Type: server (operator only)
* Usage:
/player.despawn [player]

/player.discoverMap
* Description: Discover whole map for the player character.
* Type: server (operator only)
* Usage:
/player.discoverMap [player]

/pos
/player.getPosition
* Description: Get the world position of a player character.
* Type: server (operator only)
* Usage:
/pos [player]
/player.getPosition [player]

/heal
/player.heal
* Description: Restore 100% of the player character health, energy, etc.
* Type: server (operator only)
* Usage:
/heal [player]
/player.heal [player]

/addItem
/player.items.add
* Description: Adds specified item(s) to a player character.
* Type: server (operator only)
* Usage:
/addItem <item> [count] [player]
/player.items.add <item> [count] [player]

/player.items.reset
* Description: Removes all items from a given player character.
* Type: server (operator only)
* Usage:
/player.items.reset [player]

/killMe
/player.killMe
* Description: Kills you. Use when you desperately need to get rid of yourself and respawn. You cannot kill yourself more often than once in 5 minutes.
* Type: server (operator only)
* Usage:
/killMe
/player.killMe

(/)player.printFinalCache
* Description: Prints the current final stats cache of the player character.
It lists all the applied stats with their sources.
* Type: client & server (operator only)
* Usage:
/player.printFinalCache [player]

/creative
/player.setCreativeMode
* Description: Toggles creative mode.
This mode allows you to build without using any resources also skipping the entire build phases.
This mode is enabled by default in the Editor mode.
* Type: server (operator only)
* Usage:
/creative <isEnabled> [character]
/player.setCreativeMode <isEnabled> [character]

/player.setEnergy
* Description: Sets energy value to a player character. The energy value is automatically clamped into the available range.
* Type: server (operator only)
* Usage:
/player.setEnergy <energy> [character]

/player.setFood
* Description: Sets food value to a player character. The food value is automatically clamped into the available range.
* Type: server (operator only)
* Usage:
/player.setFood <food> [character]

/player.setHealth
* Description: Sets health value to a player character. The health value is automatically clamped into the available range.
* Type: server (operator only)
* Usage:
/player.setHealth <health> [character]

/god
/player.setInvincibility
* Description: Sets invincibility to a player character.
* Type: server (operator only)
* Usage:
/god [isEnabled] [character]
/player.setInvincibility [isEnabled] [character]

/player.setLP
* Description: Set technology learning points value for a player character.
* Type: server (operator only)
* Usage:
/player.setLP <learningPoints> [player]

/player.setNewbieMode
* Description: Toggles newbie protection.
* Type: server (operator only)
* Usage:
/player.setNewbieMode <isEnabled> [character]

/player.setOrigin
* Description: Change origin for a player character.
* Type: server (operator only)
* Usage:
/player.setOrigin <origin> [player]

/spectator
/player.setSpectatorMode
* Description: Toggles spectator mode.
* Type: server (moderator/operator only)
* Usage:
/spectator <isEnabled> [character]
/player.setSpectatorMode <isEnabled> [character]

/player.setTotalAccumulatedLP
* Description: Set total accumulated technology learning points value for a player character.
* Type: server (operator only)
* Usage:
/player.setTotalAccumulatedLP <learningPoints> [player]

/player.setWater
* Description: Sets water value to a player character. The water value is automatically clamped into the available range.
* Type: server (operator only)
* Usage:
/player.setWater <water> [character]

/tp
/player.teleport
* Description: Teleports a player character to the specified tile position in the world or to another player depending on arguments used.
* Type: server (moderator/operator only)
* Usage:
/tp <toPlayer> [player]
/tp <x> <y> [player]
/player.teleport <toPlayer> [player]
/player.teleport <x> <y> [player]

/quest.add
* Description: Add quest to a player (even if prerequisites are not satisfied).
* Type: server (operator only)
* Usage:
/quest.add <quest> [player]

/quest.addAll
* Description: Add all quests to a player (even if prerequisites are not satisfied).
* Type: server (operator only)
* Usage:
/quest.addAll [player]

/quest.complete
* Description: Complete a specific active quest for player (even if prerequisites are not satisfied).
* Type: server (operator only)
* Usage:
/quest.complete <quest> [player]

/quest.completeAll
* Description: Complete all quests to a player (even if the quest is not added or the prerequisites are not satisfied).
* Type: server (operator only)
* Usage:
/quest.completeAll [player]

/quest.completeAllActive
* Description: Complete all active quests to a player (even if prerequisites are not satisfied).
* Type: server (operator only)
* Usage:
/quest.completeAllActive [player]

/quest.remove
* Description: Remove quest from a player (if exist).
* Type: server (operator only)
* Usage:
/quest.remove <quest> [player]

/quest.removeAll
* Description: Remove all quests from a player.
* Type: server (operator only)
* Usage:
/quest.removeAll [player]

/quest.reset
* Description: Reset quest to a player (if exist).
* Type: server (operator only)
* Usage:
/quest.reset <quest> [player]

/skills.addExp
* Description: Add skill experience for a specified skill.
* Type: server (operator only)
* Usage:
/skills.addExp <skill> <exp> [player]

/skills.list
* Description: Print full list of skills of a player.
* Type: server (operator only)
* Usage:
/skills.list [player]

/skills.resetAll
* Description: Reset all the player skills.
* Type: server (operator only)
* Usage:
/skills.resetAll [player]

/skills.set
* Description: Set a given skill for a player.
* Type: server (operator only)
* Usage:
/skills.set <skill> [level] [player]

/skills.setAll
* Description: Set specific level for all skills of a player.
* Type: server (operator only)
* Usage:
/skills.setAll [level] [player]

/statusEffects.add
* Description: Adds specified status effect to a player character.
* Type: server (operator only)
* Usage:
/statusEffects.add <statusEffect> [intensityToAdd] [player]

/statusEffects.addAll
* Description: Adds all possible status effects (some of them will be immediately remowed, however, as they cannot exist together).
* Type: server (operator only)
* Usage:
/statusEffects.addAll [player]

/statusEffects.remove
* Description: Removes specified status effect from a player character.
* Type: server (operator only)
* Usage:
/statusEffects.remove <statusEffect> [player]

/statusEffects.reset
* Description: Remove all status effects.
* Type: server (operator only)
* Usage:
/statusEffects.reset [player]

/tech.addAll
* Description: Add all tech groups and all nodes to a player.
* Type: server (operator only)
* Usage:
/tech.addAll [player]

/tech.addAllGroups
* Description: Add all tech groups to a player (without their nodes).
* Type: server (operator only)
* Usage:
/tech.addAllGroups [player]

/tech.addGroup
* Description: Add a particular tech group to a player.
* Type: server (operator only)
* Usage:
/tech.addGroup <group> [player]

/tech.addNode
* Description: Add a tech node to a player. It will also add all other required nodes if there's a conflict.
* Type: server (operator only)
* Usage:
/tech.addNode <node> [player]

/tech.addTier
* Description: Add a particular tech tier to a player. The argument controls whether the tech nodes of the tech gr
* Type: server (operator only)
* Usage:
/tech.addTier <tier> <withNodes> [player]

/tech.removeAll
* Description: Remove all tech groups/nodes from a player.
* Type: server (operator only)
* Usage:
/tech.removeAll [player]

/tech.removeGroup
* Description: Remove a tech group from a player.
* Type: server (operator only)
* Usage:
/tech.removeGroup <group> [player]

/tech.removeNode
* Description: Remove a tech node from a player.
* Type: server (operator only)
* Usage:
/tech.removeNode <node> [player]

/tech.resetTechTreeAndRefundLP
* Description: Reset player's tech tree and refund all the LP.
* Type: server (operator only)
* Usage:
/tech.resetTechTreeAndRefundLP [player]

/tech.setGroupCompletion
* Description: Add tech group and enable nodes to have desired percent of completion (value from 0 to 1, inclusive) to a player. This is useful when you need a particular tech group to have some nodes, but not all.
* Type: server (operator only)
* Usage:
/tech.setGroupCompletion <techGroup> <completionPercent> [player]

/world.activateBaseRaidblock
* Description: Activates raidblock status for the base where character is present now.
* Type: server (operator only)
* Usage:
/world.activateBaseRaidblock [character]

/world.destroy
* Description: Destroys the closest world object in the player character position or neighbor tiles.
You can use this to destroy any creatures, buildings or objects such as resources.
* Type: server (operator only)
* Usage:
/world.destroy [character]
/world.destroy <x> <y>

/world.destroyAll
* Description: Destroys all static world objects of the specific prototype.
* Type: server (operator only)
* Usage:
/world.destroyAll <protoObject>

/place
/world.place
* Description: Places a static world object in the player character position or in any specified position.
You can use this to spawn new buildings and resources.
You need to provide a player character name to place an object in its position.
Please note that the character must be in spectator mode.
* Type: server (operator only)
* Usage:
/place <protoStaticWorldObject> [character]
/place <objTypeName> <x> <y>
/world.place <protoStaticWorldObject> [character]
/world.place <objTypeName> <x> <y>

/world.setTimeOfDay
* Description: Forces specified time of day on the server.
To reset please execute this command without any arguments.
* Type: server (operator only)
* Usage:
/world.setTimeOfDay [hour] [minute]

/spawnVehicle
/world.spawnVehicle
* Description: Spawns a vehicle in the player character position or in any specified position.
You need to provide a player character name to place a vehicle in its position.
Please note that the character must be in spectator mode.
* Type: server (operator only)
* Usage:
/spawnVehicle <protoDynamicWorldObject> [character]
/spawnVehicle <objTypeName> <x> <y>
/world.spawnVehicle <protoDynamicWorldObject> [character]
/world.spawnVehicle <objTypeName> <x> <y>
</pre>

CryoFall/Server/Setup

2021-10-09T09:24:20Z

Ai enabled: /* Local server / Singleplayer */

= Local server / Singleplayer =
Starting with R31 "Singleplayer Update" the local server is seamlessly integrated into the game client. Other players can also connect to you over LAN (new tab in Multiplayer menu) and even over the internet with virtual LAN (with software such as Hamachi).

= Using game server hosting providers =

==== Game server rent service ====
''If you don't want to hassle with the game server setup, you can rent your own CryoFall server from any third party game server hosting company in just a few minutes. They provide data center locations in almost every country around the world!''
* [https://pingperfect.com/gameservers/cryofall-game-server-hosting-rental.php?aff=586 PingPerfect]
* [https://gameserver.4players.de/server-hosting/cryofall-server-mieten/ 4PLAYERS] (the website is available in German only)
''Please note that AtomicTorch Studio is not affiliated with any of these companies and not responsible for their service quality so in case of any issues please reach them directly. So far we've heard only positive feedback about their services.''

= Self-hosting =

== Requirements ==
====Hardware requirements====
(for up to about 30 players online) 1-core CPU 1.6-2 GHz, 1.5 GB RAM, 2-3 Mbit/s bandwidth (each way)
 (for up to about 100 players online) 2-core CPU 1.6-2 GHz, 2 GB RAM, 3-6 Mbit/s bandwidth
 (for up to about 200 players online) 2-core CPU 2.4-3 GHz, 2 GB RAM, 6-12 Mbit/s bandwidth
 (for up to about 300 players online) 2-core CPU 3+ GHz, 2.5 GB RAM, 12-20 Mbit/s bandwidth
 Usually, VPS (virtual machines) hosting such as [https://www.vultr.com/?ref=7238385 Vultr.com] (this is our referral link as we're using this company services to host our own servers) is sufficient for hosting a game server. Using 1-core machines is not recommended as the game requires a secondary CPU to ensure smooth performance without hiccups during intensive background operations (such as world snapshot saving). Using more than a 2-core machine for a single game server hosting is redundant as the game cannot utilize more than two cores due to the sequential execution of the game simulation (except networking).

====Software (system) requirements====
The server could run on Windows, Linux, and Mac.
To achieve this the game server is using .NET Runtime 5.0.
For hosting the official game servers we prefer using CentOS 7 with Docker or CentOS 8 with podman (OSS alternative to Docker).

== Server installation with Docker (best way for Linux) ==
We recommend this for Linux only. Please follow this guide [https://hub.docker.com/r/atomictorch/cryofall-server CryoFall Dedicated Server Docker Image] then return back here to '''"Server installation"''' section and follow the list after number 7. Ignore instructions on how to start the server with "dotnet" as you should use "docker run ..." instead as explained in the Docker guide above.

== Server installation / direct download (Windows, Linux, Mac) ==

==== How to setup your own server (on any OS): ====
# Install .NET Runtime 5.0 x64ΓÇöplease visit [https://dotnet.microsoft.com/download/dotnet/5.0/runtime Download .NET page] and follow the installation guide for your OS.
# Download the game server package from '''[https://atomictorch.com/Files/CryoFall_Server_v1.31.6.7_NetCore.zip SERVER DOWNLOAD LINK (any OS)]'''.
# Extract the downloaded package (it's a regular ZIP archive).
# The server executable is located in the subfolder: "Binaries/Server". Open the command line/terminal/SSH (or PowerShell in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable first time with <code>loadOrNew</code> flag. The server will start and create the game world.
#:<code>dotnet CryoFall_Server.dll loadOrNew</code>
# Usually it takes about 1-2 minutes to create a new world (or load a savegame). After that the server will keep writing performance statistics information every 20 seconds among other information such as the spawn scripts reporting and network events.
# Stop the server. To do so enter the command below and press Enter key.
#:<code>stop 0</code>
#The server will save and quit. Now you have the "SettingsServer.xml" and "ModsConfig.xml" files.
# Now you need to navigate to the subfolder "Data" (in the root of the server folder, '''not''' in the "Binaries/Server") and modify "SettingsServer.xml" to set the unique server '''name''' and set other settings, etc (there are XML comments explaining every setting so it should be straightforward). ''Please note that you can (and should) edit '''Description''' and '''Welcome message''' from the '''CURRENT GAME''' menu right from the game after connecting to your server.''
# If you are interested in making your server visible in the community servers list make sure to edit <is_public_server> and change the value from 0 to 1. Also, please make sure your router is configured correctly (port forwarding) to enable other people to connect to your machine from outside. But ideally, you should use dedicated server hardware (VPS or VDS) to host public servers.
# While you're still editing "SettingsServer.xml" file, please find the value '''<server_operators_list>''' and change it to include '''your nickname'''! Otherwise, you will be unable to access your server console from the game and also you will be unable to edit the server's Description and Welcome message.
# If you want to have a custom server icon, please replace the ServerIcon.png file in the "Data" subfolder. The icon image file requirements: '''PNG24 format, 256x256 size, up to 100 KB'''.

'''Important (for Windows only):''' you need to allow the dotnet process in the Windows Firewall settingsΓÇöif the Firewall access request was not shown automatically by Windows you can add the <code>C:\Program Files\dotnet\dotnet.exe</code> file into Firewall whitelist. To do this, open Windows Start menu and search for "Allow an app through Windows Firewall" -> button "Allow another app".

==== Starting the server ====
# Launch the command line (we recommending '''PowerShell''' in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable with <code>load</code> flag.
#:<code>dotnet CryoFall_Server.dll load</code>
# Stop your server by typing command below and pressing Enter key (it will save the world before stopping).
#:<code>stop 60 The shutdown message text goes here</code>
(Where <code>60</code> is the shutdown delay (in seconds) so the connected players will have some time to find a safe location)

'''''Please note that typing this message is really hard as the console is updating regularly! The best way is to simply copy-paste from the text editor the whole command text into the game console window (hint: you can paste in PowerShell by simply pressing the right mouse button) and pressing Enter key.'''''

You can always wipe the world by launching the game with <code>new</code> flag:
:<code>dotnet CryoFall_Server.dll new</code>

Currently, we don't support the savegame migration between the major game versions (if there are changes to the game data serialization scheme). We plan to implement the proper data migration feature ASAP.

==== Connecting to the server ====
If you want to connect to your local game server, simply add SERVERS->Custom list as <code>localhost</code>

To connect to the public server you need to navigate to SERVERS->Community servers list (please note that this might not work if you host this server on the same PC as the client, read below).

If you're attempting to host your server on a home computer and other players cannot connect to it, you need to manually forward the port '''UDP 6000''' on your home router to '''your local IP address''' (the game has the auto port forwarding feature but it often fails due to the difference in UPnP implementation on many routers). E.g. if your PC's IP address in local network is 192.168.1.100 (you can check it with ipconfig tool or in Windows network adapter's settings) you will need to setup a port forward rule on your router to forward traffic from port 6000 UDP to port 6000 UDP on IP address 192.168.1.100.

'''If you're running a game server on the same PC as the game client:'''
 Please note that you might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its address as <code>localhost:6000</code> and connect to it directly.

'''If you're running a game server in the same local network as the game client (for example you want to play over LAN with your friends and family):'''
 You might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its local IP address (IPv4) and connect to it directly. To get your local IP address please use ipconfig command-line tool or check the network adapter properties in the network center. You need to get the local network IP address of the PC that is hosting the game server. Then add it in the custom servers list on your PC. You can lookup the IP address in the Windows network settings or by using CMD tool called ipconfig in Windows. For example, here we've run the ipconfig tool here and see the IPv4 address as 192.168.1.200 ([https://cdn.discordapp.com/attachments/421250395298332672/739147674367950908/Screenshot_at_19-48-06.png screenshot]). We can use it on any other PC in the local network to connect to that PC hosting the game server.

Connecting to the private servers requires adding it via the Custom servers menu.

6000 is the default port but you can change it in the Data/SettingsServer.xml file.

== Server update/upgrade to new version ==
When we're releasing a new version of the game server, you need to follow these steps to update it:
# (If you have not done this) Install ".NET Runtime" (version 5.0) https://dotnet.microsoft.com/download/dotnet/5.0/runtime
# Ensure you've made a '''backup''' of the "'''Data'''" folder inside the game server installation folder.
# If you're updating from A28 or earlier versions, DELETE "Data/Saves" folder as the savegame is not compatible (breaking changes). Update from A29 to R30/R31 (or to any patch versions) '''doesn't require this step''' (savegame is compatible).
# Download the new version of the server and overwrite your current installation with it (you can find the actual download link above in the "Installation" section).
# Stop the game server (if it's running).
# Important: please '''overwrite''' both Binaries and Core folders!
# Start the server as usual.

== Server commands ==
# Ensure you're the server operator (you've edited the ServerSettings.xml file and added yourself into the server_operators_list).
# Connect to your game server.
# The game console can be toggled by pressing <code>~</code> (the key on the left from <code>1</code> key) like in old-school games (you can change the key binding for console in the controls options).
# Please add <code>/</code> (slash) prefix to the server commands you want to execute.
# You can use '''Tab''' key to fill autocomplete, and you can use '''arrow Up/Down keys''' to navigate the suggestions list. Press '''Tab''' or '''Enter''' to accept the suggestion.

Here is the page with the server commands list: [[CryoFall/Server/Commands|Server Commands List]]

== Moderation (whitelist, blacklist, kicking, muting) ==
Server operator can access special moderation commands. To invoke these commands, please ensure you're the server operator, connect to your game server, open the console (~ key) and then you can use these commands: (replace username with the actual player nickname)

Whitelist management:

<code>/mod.whiteList.add username</code>

<code>/mod.whiteList.remove username</code>

<code>/mod.whiteList.print</code>

To enable whitelist:

<code>/mod.whiteList.enabled 1</code>

Blacklist management:

<code>/mod.blackList.add username</code>

<code>/mod.blackList.remove username</code>

<code>/mod.blackList.print</code>

Kicking players (temporary removing from server and blocking from connecting):

<code>/mod.kickList.add username durationInMinutes</code>

<code>/mod.kickList.remove username</code>

<code>/mod.kickList.print</code>

Muting players (temporary removing their ability to send messages to chat):

<code>/mod.muteList.add username durationInMinutes</code>

<code>/mod.muteList.remove username</code>

<code>/mod.muteList.print</code>

== Server rates adjusting / Enabling PvP mode ==
Server rates (and PvP mode setting) are exposed in a separate config file. You can quickly change things like LP gain rate, increase item drops, reduce the player to player damage to zero, or even increase the damage from creatures and make it really tough for the players!

To adjust the server rates, stop the server and check the file <game server>/Data/ServerRates.config
Please read carefullyΓÇöall the rates are disabled and in order to apply them '''you need to remove the # char at the start of the line'''!

If you want to '''enable PvP''', search PvP in the file. By default, this setting's value is 0 and you need to change it to 1 and remove the # char at the start of the line.

For advanced modding please read [http://forums.atomictorch.com/index.php?topic=1027.0 modding prerequisites].

== Server raiding hours (for PvP) ==
'''(Please note: with A27 this feature is not recommend anymore as there is a better feature now ΓÇö S.H.I.E.L.D. protection that is enabled by default for PvP servers)'''

On PvP server, you could set up specific hours during which the raiding is possible.
 By default, offline raiding protection is not enabled so players could raid other players' bases at any time.
 To enable offline raiding protection, please use this in-game console command:
 <code>/admin.setRaidingWindow 4 14 1.5</code>
 In this code we're using (first number) +4 GMT/UTC timezone, (second number) hour of day when raiding is possible (value from 0 to 24), and (third number) is the duration of the raiding window (value from 0 to 24).
 So the code in the example will allow raiding from 14:00 (or 2PM) for 1.5 hours.
 After changing the value you could open Politics/Diplomacy menu ([P] key) and verify whether you set the correct numbers.
 Please note that Politics/Diplomacy menu displaying your local time (in your PC timezone)!

== How to prohibit client modifications ==
If you wish to restrict usage of any client modifications on your server, please find "<no_client_mods>" setting in the SettingsServer.xml file. Change the value from 0 to 1 to enable this feature. It's recommended for PvP servers to set it to 1. You can read more details about this feature in [https://atomictorch.com/Post/Id2218/A28-Justice-Update-Release A28 Update announcement].

CryoFall/Server/Setup

2021-10-08T14:16:59Z

Ai enabled: /* How to setup your own server (on any OS): */

= Local server / Singleplayer =
If you wish to play in singleplayer, you're just two clicks away from starting playing on your own local server!
 Local server is currently provided as an experimental feature. We've received plenty of players' feedback that it works rock-stable already!
 Please follow the [https://store.steampowered.com/news/app/829590/view/3034840264061004771 short guide here] on how to start the local game server!

= Using game server hosting providers =

==== Game server rent service ====
''If you don't want to hassle with the game server setup, you can rent your own CryoFall server from any third party game server hosting company in just a few minutes. They provide data center locations in almost every country around the world!''
* [https://pingperfect.com/gameservers/cryofall-game-server-hosting-rental.php?aff=586 PingPerfect]
* [https://gameserver.4players.de/server-hosting/cryofall-server-mieten/ 4PLAYERS] (the website is available in German only)
''Please note that AtomicTorch Studio is not affiliated with any of these companies and not responsible for their service quality so in case of any issues please reach them directly. So far we've heard only positive feedback about their services.''

= Self-hosting =

== Requirements ==
====Hardware requirements====
(for up to about 30 players online) 1-core CPU 1.6-2 GHz, 1.5 GB RAM, 2-3 Mbit/s bandwidth (each way)
 (for up to about 100 players online) 2-core CPU 1.6-2 GHz, 2 GB RAM, 3-6 Mbit/s bandwidth
 (for up to about 200 players online) 2-core CPU 2.4-3 GHz, 2 GB RAM, 6-12 Mbit/s bandwidth
 (for up to about 300 players online) 2-core CPU 3+ GHz, 2.5 GB RAM, 12-20 Mbit/s bandwidth
 Usually, VPS (virtual machines) hosting such as [https://www.vultr.com/?ref=7238385 Vultr.com] (this is our referral link as we're using this company services to host our own servers) is sufficient for hosting a game server. Using 1-core machines is not recommended as the game requires a secondary CPU to ensure smooth performance without hiccups during intensive background operations (such as world snapshot saving). Using more than a 2-core machine for a single game server hosting is redundant as the game cannot utilize more than two cores due to the sequential execution of the game simulation (except networking).

====Software (system) requirements====
The server could run on Windows, Linux, and Mac.
To achieve this the game server is using .NET Runtime 5.0.
For hosting the official game servers we prefer using CentOS 7 with Docker or CentOS 8 with podman (OSS alternative to Docker).

== Server installation with Docker (best way for Linux) ==
We recommend this for Linux only. Please follow this guide [https://hub.docker.com/r/atomictorch/cryofall-server CryoFall Dedicated Server Docker Image] then return back here to '''"Server installation"''' section and follow the list after number 7. Ignore instructions on how to start the server with "dotnet" as you should use "docker run ..." instead as explained in the Docker guide above.

== Server installation / direct download (Windows, Linux, Mac) ==

==== How to setup your own server (on any OS): ====
# Install .NET Runtime 5.0 x64ΓÇöplease visit [https://dotnet.microsoft.com/download/dotnet/5.0/runtime Download .NET page] and follow the installation guide for your OS.
# Download the game server package from '''[https://atomictorch.com/Files/CryoFall_Server_v1.31.6.7_NetCore.zip SERVER DOWNLOAD LINK (any OS)]'''.
# Extract the downloaded package (it's a regular ZIP archive).
# The server executable is located in the subfolder: "Binaries/Server". Open the command line/terminal/SSH (or PowerShell in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable first time with <code>loadOrNew</code> flag. The server will start and create the game world.
#:<code>dotnet CryoFall_Server.dll loadOrNew</code>
# Usually it takes about 1-2 minutes to create a new world (or load a savegame). After that the server will keep writing performance statistics information every 20 seconds among other information such as the spawn scripts reporting and network events.
# Stop the server. To do so enter the command below and press Enter key.
#:<code>stop 0</code>
#The server will save and quit. Now you have the "SettingsServer.xml" and "ModsConfig.xml" files.
# Now you need to navigate to the subfolder "Data" (in the root of the server folder, '''not''' in the "Binaries/Server") and modify "SettingsServer.xml" to set the unique server '''name''' and set other settings, etc (there are XML comments explaining every setting so it should be straightforward). ''Please note that you can (and should) edit '''Description''' and '''Welcome message''' from the '''CURRENT GAME''' menu right from the game after connecting to your server.''
# If you are interested in making your server visible in the community servers list make sure to edit <is_public_server> and change the value from 0 to 1. Also, please make sure your router is configured correctly (port forwarding) to enable other people to connect to your machine from outside. But ideally, you should use dedicated server hardware (VPS or VDS) to host public servers.
# While you're still editing "SettingsServer.xml" file, please find the value '''<server_operators_list>''' and change it to include '''your nickname'''! Otherwise, you will be unable to access your server console from the game and also you will be unable to edit the server's Description and Welcome message.
# If you want to have a custom server icon, please replace the ServerIcon.png file in the "Data" subfolder. The icon image file requirements: '''PNG24 format, 256x256 size, up to 100 KB'''.

'''Important (for Windows only):''' you need to allow the dotnet process in the Windows Firewall settingsΓÇöif the Firewall access request was not shown automatically by Windows you can add the <code>C:\Program Files\dotnet\dotnet.exe</code> file into Firewall whitelist. To do this, open Windows Start menu and search for "Allow an app through Windows Firewall" -> button "Allow another app".

==== Starting the server ====
# Launch the command line (we recommending '''PowerShell''' in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable with <code>load</code> flag.
#:<code>dotnet CryoFall_Server.dll load</code>
# Stop your server by typing command below and pressing Enter key (it will save the world before stopping).
#:<code>stop 60 The shutdown message text goes here</code>
(Where <code>60</code> is the shutdown delay (in seconds) so the connected players will have some time to find a safe location)

'''''Please note that typing this message is really hard as the console is updating regularly! The best way is to simply copy-paste from the text editor the whole command text into the game console window (hint: you can paste in PowerShell by simply pressing the right mouse button) and pressing Enter key.'''''

You can always wipe the world by launching the game with <code>new</code> flag:
:<code>dotnet CryoFall_Server.dll new</code>

Currently, we don't support the savegame migration between the major game versions (if there are changes to the game data serialization scheme). We plan to implement the proper data migration feature ASAP.

==== Connecting to the server ====
If you want to connect to your local game server, simply add SERVERS->Custom list as <code>localhost</code>

To connect to the public server you need to navigate to SERVERS->Community servers list (please note that this might not work if you host this server on the same PC as the client, read below).

If you're attempting to host your server on a home computer and other players cannot connect to it, you need to manually forward the port '''UDP 6000''' on your home router to '''your local IP address''' (the game has the auto port forwarding feature but it often fails due to the difference in UPnP implementation on many routers). E.g. if your PC's IP address in local network is 192.168.1.100 (you can check it with ipconfig tool or in Windows network adapter's settings) you will need to setup a port forward rule on your router to forward traffic from port 6000 UDP to port 6000 UDP on IP address 192.168.1.100.

'''If you're running a game server on the same PC as the game client:'''
 Please note that you might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its address as <code>localhost:6000</code> and connect to it directly.

'''If you're running a game server in the same local network as the game client (for example you want to play over LAN with your friends and family):'''
 You might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its local IP address (IPv4) and connect to it directly. To get your local IP address please use ipconfig command-line tool or check the network adapter properties in the network center. You need to get the local network IP address of the PC that is hosting the game server. Then add it in the custom servers list on your PC. You can lookup the IP address in the Windows network settings or by using CMD tool called ipconfig in Windows. For example, here we've run the ipconfig tool here and see the IPv4 address as 192.168.1.200 ([https://cdn.discordapp.com/attachments/421250395298332672/739147674367950908/Screenshot_at_19-48-06.png screenshot]). We can use it on any other PC in the local network to connect to that PC hosting the game server.

Connecting to the private servers requires adding it via the Custom servers menu.

6000 is the default port but you can change it in the Data/SettingsServer.xml file.

== Server update/upgrade to new version ==
When we're releasing a new version of the game server, you need to follow these steps to update it:
# (If you have not done this) Install ".NET Runtime" (version 5.0) https://dotnet.microsoft.com/download/dotnet/5.0/runtime
# Ensure you've made a '''backup''' of the "'''Data'''" folder inside the game server installation folder.
# If you're updating from A28 or earlier versions, DELETE "Data/Saves" folder as the savegame is not compatible (breaking changes). Update from A29 to R30/R31 (or to any patch versions) '''doesn't require this step''' (savegame is compatible).
# Download the new version of the server and overwrite your current installation with it (you can find the actual download link above in the "Installation" section).
# Stop the game server (if it's running).
# Important: please '''overwrite''' both Binaries and Core folders!
# Start the server as usual.

== Server commands ==
# Ensure you're the server operator (you've edited the ServerSettings.xml file and added yourself into the server_operators_list).
# Connect to your game server.
# The game console can be toggled by pressing <code>~</code> (the key on the left from <code>1</code> key) like in old-school games (you can change the key binding for console in the controls options).
# Please add <code>/</code> (slash) prefix to the server commands you want to execute.
# You can use '''Tab''' key to fill autocomplete, and you can use '''arrow Up/Down keys''' to navigate the suggestions list. Press '''Tab''' or '''Enter''' to accept the suggestion.

Here is the page with the server commands list: [[CryoFall/Server/Commands|Server Commands List]]

== Moderation (whitelist, blacklist, kicking, muting) ==
Server operator can access special moderation commands. To invoke these commands, please ensure you're the server operator, connect to your game server, open the console (~ key) and then you can use these commands: (replace username with the actual player nickname)

Whitelist management:

<code>/mod.whiteList.add username</code>

<code>/mod.whiteList.remove username</code>

<code>/mod.whiteList.print</code>

To enable whitelist:

<code>/mod.whiteList.enabled 1</code>

Blacklist management:

<code>/mod.blackList.add username</code>

<code>/mod.blackList.remove username</code>

<code>/mod.blackList.print</code>

Kicking players (temporary removing from server and blocking from connecting):

<code>/mod.kickList.add username durationInMinutes</code>

<code>/mod.kickList.remove username</code>

<code>/mod.kickList.print</code>

Muting players (temporary removing their ability to send messages to chat):

<code>/mod.muteList.add username durationInMinutes</code>

<code>/mod.muteList.remove username</code>

<code>/mod.muteList.print</code>

== Server rates adjusting / Enabling PvP mode ==
Server rates (and PvP mode setting) are exposed in a separate config file. You can quickly change things like LP gain rate, increase item drops, reduce the player to player damage to zero, or even increase the damage from creatures and make it really tough for the players!

To adjust the server rates, stop the server and check the file <game server>/Data/ServerRates.config
Please read carefullyΓÇöall the rates are disabled and in order to apply them '''you need to remove the # char at the start of the line'''!

If you want to '''enable PvP''', search PvP in the file. By default, this setting's value is 0 and you need to change it to 1 and remove the # char at the start of the line.

For advanced modding please read [http://forums.atomictorch.com/index.php?topic=1027.0 modding prerequisites].

== Server raiding hours (for PvP) ==
'''(Please note: with A27 this feature is not recommend anymore as there is a better feature now ΓÇö S.H.I.E.L.D. protection that is enabled by default for PvP servers)'''

On PvP server, you could set up specific hours during which the raiding is possible.
 By default, offline raiding protection is not enabled so players could raid other players' bases at any time.
 To enable offline raiding protection, please use this in-game console command:
 <code>/admin.setRaidingWindow 4 14 1.5</code>
 In this code we're using (first number) +4 GMT/UTC timezone, (second number) hour of day when raiding is possible (value from 0 to 24), and (third number) is the duration of the raiding window (value from 0 to 24).
 So the code in the example will allow raiding from 14:00 (or 2PM) for 1.5 hours.
 After changing the value you could open Politics/Diplomacy menu ([P] key) and verify whether you set the correct numbers.
 Please note that Politics/Diplomacy menu displaying your local time (in your PC timezone)!

== How to prohibit client modifications ==
If you wish to restrict usage of any client modifications on your server, please find "<no_client_mods>" setting in the SettingsServer.xml file. Change the value from 0 to 1 to enable this feature. It's recommended for PvP servers to set it to 1. You can read more details about this feature in [https://atomictorch.com/Post/Id2218/A28-Justice-Update-Release A28 Update announcement].

CryoFall/Server/Setup

2021-10-08T13:36:33Z

Ai enabled: /* How to setup your own server (on any OS): */

= Local server / Singleplayer =
If you wish to play in singleplayer, you're just two clicks away from starting playing on your own local server!
 Local server is currently provided as an experimental feature. We've received plenty of players' feedback that it works rock-stable already!
 Please follow the [https://store.steampowered.com/news/app/829590/view/3034840264061004771 short guide here] on how to start the local game server!

= Using game server hosting providers =

==== Game server rent service ====
''If you don't want to hassle with the game server setup, you can rent your own CryoFall server from any third party game server hosting company in just a few minutes. They provide data center locations in almost every country around the world!''
* [https://pingperfect.com/gameservers/cryofall-game-server-hosting-rental.php?aff=586 PingPerfect]
* [https://gameserver.4players.de/server-hosting/cryofall-server-mieten/ 4PLAYERS] (the website is available in German only)
''Please note that AtomicTorch Studio is not affiliated with any of these companies and not responsible for their service quality so in case of any issues please reach them directly. So far we've heard only positive feedback about their services.''

= Self-hosting =

== Requirements ==
====Hardware requirements====
(for up to about 30 players online) 1-core CPU 1.6-2 GHz, 1.5 GB RAM, 2-3 Mbit/s bandwidth (each way)
 (for up to about 100 players online) 2-core CPU 1.6-2 GHz, 2 GB RAM, 3-6 Mbit/s bandwidth
 (for up to about 200 players online) 2-core CPU 2.4-3 GHz, 2 GB RAM, 6-12 Mbit/s bandwidth
 (for up to about 300 players online) 2-core CPU 3+ GHz, 2.5 GB RAM, 12-20 Mbit/s bandwidth
 Usually, VPS (virtual machines) hosting such as [https://www.vultr.com/?ref=7238385 Vultr.com] (this is our referral link as we're using this company services to host our own servers) is sufficient for hosting a game server. Using 1-core machines is not recommended as the game requires a secondary CPU to ensure smooth performance without hiccups during intensive background operations (such as world snapshot saving). Using more than a 2-core machine for a single game server hosting is redundant as the game cannot utilize more than two cores due to the sequential execution of the game simulation (except networking).

====Software (system) requirements====
The server could run on Windows, Linux, and Mac.
To achieve this the game server is using .NET Runtime 5.0.
For hosting the official game servers we prefer using CentOS 7 with Docker or CentOS 8 with podman (OSS alternative to Docker).

== Server installation with Docker (best way for Linux) ==
We recommend this for Linux only. Please follow this guide [https://hub.docker.com/r/atomictorch/cryofall-server CryoFall Dedicated Server Docker Image] then return back here to '''"Server installation"''' section and follow the list after number 7. Ignore instructions on how to start the server with "dotnet" as you should use "docker run ..." instead as explained in the Docker guide above.

== Server installation / direct download (Windows, Linux, Mac) ==

==== How to setup your own server (on any OS): ====
# Install .NET Runtime 5.0 x64ΓÇöplease visit [https://dotnet.microsoft.com/download/dotnet/5.0/runtime Download .NET page] and follow the installation guide for your OS.
# Download the game server package from '''[https://atomictorch.com/Files/CryoFall_Server_v1.31.6.5_NetCore.zip SERVER DOWNLOAD LINK (any OS)]'''.
# Extract the downloaded package (it's a regular ZIP archive).
# The server executable is located in the subfolder: "Binaries/Server". Open the command line/terminal/SSH (or PowerShell in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable first time with <code>loadOrNew</code> flag. The server will start and create the game world.
#:<code>dotnet CryoFall_Server.dll loadOrNew</code>
# Usually it takes about 1-2 minutes to create a new world (or load a savegame). After that the server will keep writing performance statistics information every 20 seconds among other information such as the spawn scripts reporting and network events.
# Stop the server. To do so enter the command below and press Enter key.
#:<code>stop 0</code>
#The server will save and quit. Now you have the "SettingsServer.xml" and "ModsConfig.xml" files.
# Now you need to navigate to the subfolder "Data" (in the root of the server folder, '''not''' in the "Binaries/Server") and modify "SettingsServer.xml" to set the unique server '''name''' and set other settings, etc (there are XML comments explaining every setting so it should be straightforward). ''Please note that you can (and should) edit '''Description''' and '''Welcome message''' from the '''CURRENT GAME''' menu right from the game after connecting to your server.''
# If you are interested in making your server visible in the community servers list make sure to edit <is_public_server> and change the value from 0 to 1. Also, please make sure your router is configured correctly (port forwarding) to enable other people to connect to your machine from outside. But ideally, you should use dedicated server hardware (VPS or VDS) to host public servers.
# While you're still editing "SettingsServer.xml" file, please find the value '''<server_operators_list>''' and change it to include '''your nickname'''! Otherwise, you will be unable to access your server console from the game and also you will be unable to edit the server's Description and Welcome message.
# If you want to have a custom server icon, please replace the ServerIcon.png file in the "Data" subfolder. The icon image file requirements: '''PNG24 format, 256x256 size, up to 100 KB'''.

'''Important (for Windows only):''' you need to allow the dotnet process in the Windows Firewall settingsΓÇöif the Firewall access request was not shown automatically by Windows you can add the <code>C:\Program Files\dotnet\dotnet.exe</code> file into Firewall whitelist. To do this, open Windows Start menu and search for "Allow an app through Windows Firewall" -> button "Allow another app".

==== Starting the server ====
# Launch the command line (we recommending '''PowerShell''' in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable with <code>load</code> flag.
#:<code>dotnet CryoFall_Server.dll load</code>
# Stop your server by typing command below and pressing Enter key (it will save the world before stopping).
#:<code>stop 60 The shutdown message text goes here</code>
(Where <code>60</code> is the shutdown delay (in seconds) so the connected players will have some time to find a safe location)

'''''Please note that typing this message is really hard as the console is updating regularly! The best way is to simply copy-paste from the text editor the whole command text into the game console window (hint: you can paste in PowerShell by simply pressing the right mouse button) and pressing Enter key.'''''

You can always wipe the world by launching the game with <code>new</code> flag:
:<code>dotnet CryoFall_Server.dll new</code>

Currently, we don't support the savegame migration between the major game versions (if there are changes to the game data serialization scheme). We plan to implement the proper data migration feature ASAP.

==== Connecting to the server ====
If you want to connect to your local game server, simply add SERVERS->Custom list as <code>localhost</code>

To connect to the public server you need to navigate to SERVERS->Community servers list (please note that this might not work if you host this server on the same PC as the client, read below).

If you're attempting to host your server on a home computer and other players cannot connect to it, you need to manually forward the port '''UDP 6000''' on your home router to '''your local IP address''' (the game has the auto port forwarding feature but it often fails due to the difference in UPnP implementation on many routers). E.g. if your PC's IP address in local network is 192.168.1.100 (you can check it with ipconfig tool or in Windows network adapter's settings) you will need to setup a port forward rule on your router to forward traffic from port 6000 UDP to port 6000 UDP on IP address 192.168.1.100.

'''If you're running a game server on the same PC as the game client:'''
 Please note that you might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its address as <code>localhost:6000</code> and connect to it directly.

'''If you're running a game server in the same local network as the game client (for example you want to play over LAN with your friends and family):'''
 You might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its local IP address (IPv4) and connect to it directly. To get your local IP address please use ipconfig command-line tool or check the network adapter properties in the network center. You need to get the local network IP address of the PC that is hosting the game server. Then add it in the custom servers list on your PC. You can lookup the IP address in the Windows network settings or by using CMD tool called ipconfig in Windows. For example, here we've run the ipconfig tool here and see the IPv4 address as 192.168.1.200 ([https://cdn.discordapp.com/attachments/421250395298332672/739147674367950908/Screenshot_at_19-48-06.png screenshot]). We can use it on any other PC in the local network to connect to that PC hosting the game server.

Connecting to the private servers requires adding it via the Custom servers menu.

6000 is the default port but you can change it in the Data/SettingsServer.xml file.

== Server update/upgrade to new version ==
When we're releasing a new version of the game server, you need to follow these steps to update it:
# (If you have not done this) Install ".NET Runtime" (version 5.0) https://dotnet.microsoft.com/download/dotnet/5.0/runtime
# Ensure you've made a '''backup''' of the "'''Data'''" folder inside the game server installation folder.
# If you're updating from A28 or earlier versions, DELETE "Data/Saves" folder as the savegame is not compatible (breaking changes). Update from A29 to R30/R31 (or to any patch versions) '''doesn't require this step''' (savegame is compatible).
# Download the new version of the server and overwrite your current installation with it (you can find the actual download link above in the "Installation" section).
# Stop the game server (if it's running).
# Important: please '''overwrite''' both Binaries and Core folders!
# Start the server as usual.

== Server commands ==
# Ensure you're the server operator (you've edited the ServerSettings.xml file and added yourself into the server_operators_list).
# Connect to your game server.
# The game console can be toggled by pressing <code>~</code> (the key on the left from <code>1</code> key) like in old-school games (you can change the key binding for console in the controls options).
# Please add <code>/</code> (slash) prefix to the server commands you want to execute.
# You can use '''Tab''' key to fill autocomplete, and you can use '''arrow Up/Down keys''' to navigate the suggestions list. Press '''Tab''' or '''Enter''' to accept the suggestion.

Here is the page with the server commands list: [[CryoFall/Server/Commands|Server Commands List]]

== Moderation (whitelist, blacklist, kicking, muting) ==
Server operator can access special moderation commands. To invoke these commands, please ensure you're the server operator, connect to your game server, open the console (~ key) and then you can use these commands: (replace username with the actual player nickname)

Whitelist management:

<code>/mod.whiteList.add username</code>

<code>/mod.whiteList.remove username</code>

<code>/mod.whiteList.print</code>

To enable whitelist:

<code>/mod.whiteList.enabled 1</code>

Blacklist management:

<code>/mod.blackList.add username</code>

<code>/mod.blackList.remove username</code>

<code>/mod.blackList.print</code>

Kicking players (temporary removing from server and blocking from connecting):

<code>/mod.kickList.add username durationInMinutes</code>

<code>/mod.kickList.remove username</code>

<code>/mod.kickList.print</code>

Muting players (temporary removing their ability to send messages to chat):

<code>/mod.muteList.add username durationInMinutes</code>

<code>/mod.muteList.remove username</code>

<code>/mod.muteList.print</code>

== Server rates adjusting / Enabling PvP mode ==
Server rates (and PvP mode setting) are exposed in a separate config file. You can quickly change things like LP gain rate, increase item drops, reduce the player to player damage to zero, or even increase the damage from creatures and make it really tough for the players!

To adjust the server rates, stop the server and check the file <game server>/Data/ServerRates.config
Please read carefullyΓÇöall the rates are disabled and in order to apply them '''you need to remove the # char at the start of the line'''!

If you want to '''enable PvP''', search PvP in the file. By default, this setting's value is 0 and you need to change it to 1 and remove the # char at the start of the line.

For advanced modding please read [http://forums.atomictorch.com/index.php?topic=1027.0 modding prerequisites].

== Server raiding hours (for PvP) ==
'''(Please note: with A27 this feature is not recommend anymore as there is a better feature now ΓÇö S.H.I.E.L.D. protection that is enabled by default for PvP servers)'''

On PvP server, you could set up specific hours during which the raiding is possible.
 By default, offline raiding protection is not enabled so players could raid other players' bases at any time.
 To enable offline raiding protection, please use this in-game console command:
 <code>/admin.setRaidingWindow 4 14 1.5</code>
 In this code we're using (first number) +4 GMT/UTC timezone, (second number) hour of day when raiding is possible (value from 0 to 24), and (third number) is the duration of the raiding window (value from 0 to 24).
 So the code in the example will allow raiding from 14:00 (or 2PM) for 1.5 hours.
 After changing the value you could open Politics/Diplomacy menu ([P] key) and verify whether you set the correct numbers.
 Please note that Politics/Diplomacy menu displaying your local time (in your PC timezone)!

== How to prohibit client modifications ==
If you wish to restrict usage of any client modifications on your server, please find "<no_client_mods>" setting in the SettingsServer.xml file. Change the value from 0 to 1 to enable this feature. It's recommended for PvP servers to set it to 1. You can read more details about this feature in [https://atomictorch.com/Post/Id2218/A28-Justice-Update-Release A28 Update announcement].

CryoFall/Server/Setup

2021-10-08T13:19:58Z

Ai enabled: /* Server update/upgrade to new version */

= Local server / Singleplayer =
If you wish to play in singleplayer, you're just two clicks away from starting playing on your own local server!
 Local server is currently provided as an experimental feature. We've received plenty of players' feedback that it works rock-stable already!
 Please follow the [https://store.steampowered.com/news/app/829590/view/3034840264061004771 short guide here] on how to start the local game server!

= Using game server hosting providers =

==== Game server rent service ====
''If you don't want to hassle with the game server setup, you can rent your own CryoFall server from any third party game server hosting company in just a few minutes. They provide data center locations in almost every country around the world!''
* [https://pingperfect.com/gameservers/cryofall-game-server-hosting-rental.php?aff=586 PingPerfect]
* [https://gameserver.4players.de/server-hosting/cryofall-server-mieten/ 4PLAYERS] (the website is available in German only)
''Please note that AtomicTorch Studio is not affiliated with any of these companies and not responsible for their service quality so in case of any issues please reach them directly. So far we've heard only positive feedback about their services.''

= Self-hosting =

== Requirements ==
====Hardware requirements====
(for up to about 30 players online) 1-core CPU 1.6-2 GHz, 1.5 GB RAM, 2-3 Mbit/s bandwidth (each way)
 (for up to about 100 players online) 2-core CPU 1.6-2 GHz, 2 GB RAM, 3-6 Mbit/s bandwidth
 (for up to about 200 players online) 2-core CPU 2.4-3 GHz, 2 GB RAM, 6-12 Mbit/s bandwidth
 (for up to about 300 players online) 2-core CPU 3+ GHz, 2.5 GB RAM, 12-20 Mbit/s bandwidth
 Usually, VPS (virtual machines) hosting such as [https://www.vultr.com/?ref=7238385 Vultr.com] (this is our referral link as we're using this company services to host our own servers) is sufficient for hosting a game server. Using 1-core machines is not recommended as the game requires a secondary CPU to ensure smooth performance without hiccups during intensive background operations (such as world snapshot saving). Using more than a 2-core machine for a single game server hosting is redundant as the game cannot utilize more than two cores due to the sequential execution of the game simulation (except networking).

====Software (system) requirements====
The server could run on Windows, Linux, and Mac.
To achieve this the game server is using .NET Runtime 5.0.
For hosting the official game servers we prefer using CentOS 7 with Docker or CentOS 8 with podman (OSS alternative to Docker).

== Server installation with Docker (best way for Linux) ==
We recommend this for Linux only. Please follow this guide [https://hub.docker.com/r/atomictorch/cryofall-server CryoFall Dedicated Server Docker Image] then return back here to '''"Server installation"''' section and follow the list after number 7. Ignore instructions on how to start the server with "dotnet" as you should use "docker run ..." instead as explained in the Docker guide above.

== Server installation / direct download (Windows, Linux, Mac) ==

==== How to setup your own server (on any OS): ====
# Install .NET Runtime 5.0 x64ΓÇöplease visit [https://dotnet.microsoft.com/download/dotnet/5.0/runtime Download .NET page] and follow the installation guide for your OS.
# Download the game server package from '''[https://atomictorch.com/Files/CryoFall_Server_v1.31.6.4_NetCore.zip SERVER DOWNLOAD LINK (any OS)]'''.
# Extract the downloaded package (it's a regular ZIP archive).
# The server executable is located in the subfolder: "Binaries/Server". Open the command line/terminal/SSH (or PowerShell in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable first time with <code>loadOrNew</code> flag. The server will start and create the game world.
#:<code>dotnet CryoFall_Server.dll loadOrNew</code>
# Usually it takes about 1-2 minutes to create a new world (or load a savegame). After that the server will keep writing performance statistics information every 20 seconds among other information such as the spawn scripts reporting and network events.
# Stop the server. To do so enter the command below and press Enter key.
#:<code>stop 0</code>
#The server will save and quit. Now you have the "SettingsServer.xml" and "ModsConfig.xml" files.
# Now you need to navigate to the subfolder "Data" (in the root of the server folder, '''not''' in the "Binaries/Server") and modify "SettingsServer.xml" to set the unique server '''name''' and set other settings, etc (there are XML comments explaining every setting so it should be straightforward). ''Please note that you can (and should) edit '''Description''' and '''Welcome message''' from the '''CURRENT GAME''' menu right from the game after connecting to your server.''
# If you are interested in making your server visible in the community servers list make sure to edit <is_public_server> and change the value from 0 to 1. Also, please make sure your router is configured correctly (port forwarding) to enable other people to connect to your machine from outside. But ideally, you should use dedicated server hardware (VPS or VDS) to host public servers.
# While you're still editing "SettingsServer.xml" file, please find the value '''<server_operators_list>''' and change it to include '''your nickname'''! Otherwise, you will be unable to access your server console from the game and also you will be unable to edit the server's Description and Welcome message.
# If you want to have a custom server icon, please replace the ServerIcon.png file in the "Data" subfolder. The icon image file requirements: '''PNG24 format, 256x256 size, up to 100 KB'''.

'''Important (for Windows only):''' you need to allow the dotnet process in the Windows Firewall settingsΓÇöif the Firewall access request was not shown automatically by Windows you can add the <code>C:\Program Files\dotnet\dotnet.exe</code> file into Firewall whitelist. To do this, open Windows Start menu and search for "Allow an app through Windows Firewall" -> button "Allow another app".

==== Starting the server ====
# Launch the command line (we recommending '''PowerShell''' in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable with <code>load</code> flag.
#:<code>dotnet CryoFall_Server.dll load</code>
# Stop your server by typing command below and pressing Enter key (it will save the world before stopping).
#:<code>stop 60 The shutdown message text goes here</code>
(Where <code>60</code> is the shutdown delay (in seconds) so the connected players will have some time to find a safe location)

'''''Please note that typing this message is really hard as the console is updating regularly! The best way is to simply copy-paste from the text editor the whole command text into the game console window (hint: you can paste in PowerShell by simply pressing the right mouse button) and pressing Enter key.'''''

You can always wipe the world by launching the game with <code>new</code> flag:
:<code>dotnet CryoFall_Server.dll new</code>

Currently, we don't support the savegame migration between the major game versions (if there are changes to the game data serialization scheme). We plan to implement the proper data migration feature ASAP.

==== Connecting to the server ====
If you want to connect to your local game server, simply add SERVERS->Custom list as <code>localhost</code>

To connect to the public server you need to navigate to SERVERS->Community servers list (please note that this might not work if you host this server on the same PC as the client, read below).

If you're attempting to host your server on a home computer and other players cannot connect to it, you need to manually forward the port '''UDP 6000''' on your home router to '''your local IP address''' (the game has the auto port forwarding feature but it often fails due to the difference in UPnP implementation on many routers). E.g. if your PC's IP address in local network is 192.168.1.100 (you can check it with ipconfig tool or in Windows network adapter's settings) you will need to setup a port forward rule on your router to forward traffic from port 6000 UDP to port 6000 UDP on IP address 192.168.1.100.

'''If you're running a game server on the same PC as the game client:'''
 Please note that you might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its address as <code>localhost:6000</code> and connect to it directly.

'''If you're running a game server in the same local network as the game client (for example you want to play over LAN with your friends and family):'''
 You might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its local IP address (IPv4) and connect to it directly. To get your local IP address please use ipconfig command-line tool or check the network adapter properties in the network center. You need to get the local network IP address of the PC that is hosting the game server. Then add it in the custom servers list on your PC. You can lookup the IP address in the Windows network settings or by using CMD tool called ipconfig in Windows. For example, here we've run the ipconfig tool here and see the IPv4 address as 192.168.1.200 ([https://cdn.discordapp.com/attachments/421250395298332672/739147674367950908/Screenshot_at_19-48-06.png screenshot]). We can use it on any other PC in the local network to connect to that PC hosting the game server.

Connecting to the private servers requires adding it via the Custom servers menu.

6000 is the default port but you can change it in the Data/SettingsServer.xml file.

== Server update/upgrade to new version ==
When we're releasing a new version of the game server, you need to follow these steps to update it:
# (If you have not done this) Install ".NET Runtime" (version 5.0) https://dotnet.microsoft.com/download/dotnet/5.0/runtime
# Ensure you've made a '''backup''' of the "'''Data'''" folder inside the game server installation folder.
# If you're updating from A28 or earlier versions, DELETE "Data/Saves" folder as the savegame is not compatible (breaking changes). Update from A29 to R30/R31 (or to any patch versions) '''doesn't require this step''' (savegame is compatible).
# Download the new version of the server and overwrite your current installation with it (you can find the actual download link above in the "Installation" section).
# Stop the game server (if it's running).
# Important: please '''overwrite''' both Binaries and Core folders!
# Start the server as usual.

== Server commands ==
# Ensure you're the server operator (you've edited the ServerSettings.xml file and added yourself into the server_operators_list).
# Connect to your game server.
# The game console can be toggled by pressing <code>~</code> (the key on the left from <code>1</code> key) like in old-school games (you can change the key binding for console in the controls options).
# Please add <code>/</code> (slash) prefix to the server commands you want to execute.
# You can use '''Tab''' key to fill autocomplete, and you can use '''arrow Up/Down keys''' to navigate the suggestions list. Press '''Tab''' or '''Enter''' to accept the suggestion.

Here is the page with the server commands list: [[CryoFall/Server/Commands|Server Commands List]]

== Moderation (whitelist, blacklist, kicking, muting) ==
Server operator can access special moderation commands. To invoke these commands, please ensure you're the server operator, connect to your game server, open the console (~ key) and then you can use these commands: (replace username with the actual player nickname)

Whitelist management:

<code>/mod.whiteList.add username</code>

<code>/mod.whiteList.remove username</code>

<code>/mod.whiteList.print</code>

To enable whitelist:

<code>/mod.whiteList.enabled 1</code>

Blacklist management:

<code>/mod.blackList.add username</code>

<code>/mod.blackList.remove username</code>

<code>/mod.blackList.print</code>

Kicking players (temporary removing from server and blocking from connecting):

<code>/mod.kickList.add username durationInMinutes</code>

<code>/mod.kickList.remove username</code>

<code>/mod.kickList.print</code>

Muting players (temporary removing their ability to send messages to chat):

<code>/mod.muteList.add username durationInMinutes</code>

<code>/mod.muteList.remove username</code>

<code>/mod.muteList.print</code>

== Server rates adjusting / Enabling PvP mode ==
Server rates (and PvP mode setting) are exposed in a separate config file. You can quickly change things like LP gain rate, increase item drops, reduce the player to player damage to zero, or even increase the damage from creatures and make it really tough for the players!

To adjust the server rates, stop the server and check the file <game server>/Data/ServerRates.config
Please read carefullyΓÇöall the rates are disabled and in order to apply them '''you need to remove the # char at the start of the line'''!

If you want to '''enable PvP''', search PvP in the file. By default, this setting's value is 0 and you need to change it to 1 and remove the # char at the start of the line.

For advanced modding please read [http://forums.atomictorch.com/index.php?topic=1027.0 modding prerequisites].

== Server raiding hours (for PvP) ==
'''(Please note: with A27 this feature is not recommend anymore as there is a better feature now ΓÇö S.H.I.E.L.D. protection that is enabled by default for PvP servers)'''

On PvP server, you could set up specific hours during which the raiding is possible.
 By default, offline raiding protection is not enabled so players could raid other players' bases at any time.
 To enable offline raiding protection, please use this in-game console command:
 <code>/admin.setRaidingWindow 4 14 1.5</code>
 In this code we're using (first number) +4 GMT/UTC timezone, (second number) hour of day when raiding is possible (value from 0 to 24), and (third number) is the duration of the raiding window (value from 0 to 24).
 So the code in the example will allow raiding from 14:00 (or 2PM) for 1.5 hours.
 After changing the value you could open Politics/Diplomacy menu ([P] key) and verify whether you set the correct numbers.
 Please note that Politics/Diplomacy menu displaying your local time (in your PC timezone)!

== How to prohibit client modifications ==
If you wish to restrict usage of any client modifications on your server, please find "<no_client_mods>" setting in the SettingsServer.xml file. Change the value from 0 to 1 to enable this feature. It's recommended for PvP servers to set it to 1. You can read more details about this feature in [https://atomictorch.com/Post/Id2218/A28-Justice-Update-Release A28 Update announcement].

CryoFall/Server/Setup

2021-10-08T13:19:29Z

Ai enabled: /* How to setup your own server (on any OS): */

= Local server / Singleplayer =
If you wish to play in singleplayer, you're just two clicks away from starting playing on your own local server!
 Local server is currently provided as an experimental feature. We've received plenty of players' feedback that it works rock-stable already!
 Please follow the [https://store.steampowered.com/news/app/829590/view/3034840264061004771 short guide here] on how to start the local game server!

= Using game server hosting providers =

==== Game server rent service ====
''If you don't want to hassle with the game server setup, you can rent your own CryoFall server from any third party game server hosting company in just a few minutes. They provide data center locations in almost every country around the world!''
* [https://pingperfect.com/gameservers/cryofall-game-server-hosting-rental.php?aff=586 PingPerfect]
* [https://gameserver.4players.de/server-hosting/cryofall-server-mieten/ 4PLAYERS] (the website is available in German only)
''Please note that AtomicTorch Studio is not affiliated with any of these companies and not responsible for their service quality so in case of any issues please reach them directly. So far we've heard only positive feedback about their services.''

= Self-hosting =

== Requirements ==
====Hardware requirements====
(for up to about 30 players online) 1-core CPU 1.6-2 GHz, 1.5 GB RAM, 2-3 Mbit/s bandwidth (each way)
 (for up to about 100 players online) 2-core CPU 1.6-2 GHz, 2 GB RAM, 3-6 Mbit/s bandwidth
 (for up to about 200 players online) 2-core CPU 2.4-3 GHz, 2 GB RAM, 6-12 Mbit/s bandwidth
 (for up to about 300 players online) 2-core CPU 3+ GHz, 2.5 GB RAM, 12-20 Mbit/s bandwidth
 Usually, VPS (virtual machines) hosting such as [https://www.vultr.com/?ref=7238385 Vultr.com] (this is our referral link as we're using this company services to host our own servers) is sufficient for hosting a game server. Using 1-core machines is not recommended as the game requires a secondary CPU to ensure smooth performance without hiccups during intensive background operations (such as world snapshot saving). Using more than a 2-core machine for a single game server hosting is redundant as the game cannot utilize more than two cores due to the sequential execution of the game simulation (except networking).

====Software (system) requirements====
The server could run on Windows, Linux, and Mac.
To achieve this the game server is using .NET Runtime 5.0.
For hosting the official game servers we prefer using CentOS 7 with Docker or CentOS 8 with podman (OSS alternative to Docker).

== Server installation with Docker (best way for Linux) ==
We recommend this for Linux only. Please follow this guide [https://hub.docker.com/r/atomictorch/cryofall-server CryoFall Dedicated Server Docker Image] then return back here to '''"Server installation"''' section and follow the list after number 7. Ignore instructions on how to start the server with "dotnet" as you should use "docker run ..." instead as explained in the Docker guide above.

== Server installation / direct download (Windows, Linux, Mac) ==

==== How to setup your own server (on any OS): ====
# Install .NET Runtime 5.0 x64ΓÇöplease visit [https://dotnet.microsoft.com/download/dotnet/5.0/runtime Download .NET page] and follow the installation guide for your OS.
# Download the game server package from '''[https://atomictorch.com/Files/CryoFall_Server_v1.31.6.4_NetCore.zip SERVER DOWNLOAD LINK (any OS)]'''.
# Extract the downloaded package (it's a regular ZIP archive).
# The server executable is located in the subfolder: "Binaries/Server". Open the command line/terminal/SSH (or PowerShell in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable first time with <code>loadOrNew</code> flag. The server will start and create the game world.
#:<code>dotnet CryoFall_Server.dll loadOrNew</code>
# Usually it takes about 1-2 minutes to create a new world (or load a savegame). After that the server will keep writing performance statistics information every 20 seconds among other information such as the spawn scripts reporting and network events.
# Stop the server. To do so enter the command below and press Enter key.
#:<code>stop 0</code>
#The server will save and quit. Now you have the "SettingsServer.xml" and "ModsConfig.xml" files.
# Now you need to navigate to the subfolder "Data" (in the root of the server folder, '''not''' in the "Binaries/Server") and modify "SettingsServer.xml" to set the unique server '''name''' and set other settings, etc (there are XML comments explaining every setting so it should be straightforward). ''Please note that you can (and should) edit '''Description''' and '''Welcome message''' from the '''CURRENT GAME''' menu right from the game after connecting to your server.''
# If you are interested in making your server visible in the community servers list make sure to edit <is_public_server> and change the value from 0 to 1. Also, please make sure your router is configured correctly (port forwarding) to enable other people to connect to your machine from outside. But ideally, you should use dedicated server hardware (VPS or VDS) to host public servers.
# While you're still editing "SettingsServer.xml" file, please find the value '''<server_operators_list>''' and change it to include '''your nickname'''! Otherwise, you will be unable to access your server console from the game and also you will be unable to edit the server's Description and Welcome message.
# If you want to have a custom server icon, please replace the ServerIcon.png file in the "Data" subfolder. The icon image file requirements: '''PNG24 format, 256x256 size, up to 100 KB'''.

'''Important (for Windows only):''' you need to allow the dotnet process in the Windows Firewall settingsΓÇöif the Firewall access request was not shown automatically by Windows you can add the <code>C:\Program Files\dotnet\dotnet.exe</code> file into Firewall whitelist. To do this, open Windows Start menu and search for "Allow an app through Windows Firewall" -> button "Allow another app".

==== Starting the server ====
# Launch the command line (we recommending '''PowerShell''' in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable with <code>load</code> flag.
#:<code>dotnet CryoFall_Server.dll load</code>
# Stop your server by typing command below and pressing Enter key (it will save the world before stopping).
#:<code>stop 60 The shutdown message text goes here</code>
(Where <code>60</code> is the shutdown delay (in seconds) so the connected players will have some time to find a safe location)

'''''Please note that typing this message is really hard as the console is updating regularly! The best way is to simply copy-paste from the text editor the whole command text into the game console window (hint: you can paste in PowerShell by simply pressing the right mouse button) and pressing Enter key.'''''

You can always wipe the world by launching the game with <code>new</code> flag:
:<code>dotnet CryoFall_Server.dll new</code>

Currently, we don't support the savegame migration between the major game versions (if there are changes to the game data serialization scheme). We plan to implement the proper data migration feature ASAP.

==== Connecting to the server ====
If you want to connect to your local game server, simply add SERVERS->Custom list as <code>localhost</code>

To connect to the public server you need to navigate to SERVERS->Community servers list (please note that this might not work if you host this server on the same PC as the client, read below).

If you're attempting to host your server on a home computer and other players cannot connect to it, you need to manually forward the port '''UDP 6000''' on your home router to '''your local IP address''' (the game has the auto port forwarding feature but it often fails due to the difference in UPnP implementation on many routers). E.g. if your PC's IP address in local network is 192.168.1.100 (you can check it with ipconfig tool or in Windows network adapter's settings) you will need to setup a port forward rule on your router to forward traffic from port 6000 UDP to port 6000 UDP on IP address 192.168.1.100.

'''If you're running a game server on the same PC as the game client:'''
 Please note that you might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its address as <code>localhost:6000</code> and connect to it directly.

'''If you're running a game server in the same local network as the game client (for example you want to play over LAN with your friends and family):'''
 You might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its local IP address (IPv4) and connect to it directly. To get your local IP address please use ipconfig command-line tool or check the network adapter properties in the network center. You need to get the local network IP address of the PC that is hosting the game server. Then add it in the custom servers list on your PC. You can lookup the IP address in the Windows network settings or by using CMD tool called ipconfig in Windows. For example, here we've run the ipconfig tool here and see the IPv4 address as 192.168.1.200 ([https://cdn.discordapp.com/attachments/421250395298332672/739147674367950908/Screenshot_at_19-48-06.png screenshot]). We can use it on any other PC in the local network to connect to that PC hosting the game server.

Connecting to the private servers requires adding it via the Custom servers menu.

6000 is the default port but you can change it in the Data/SettingsServer.xml file.

== Server update/upgrade to new version ==
When we're releasing a new version of the game server, you need to follow these steps to update it:
# (If you have not done this) Install ".NET Runtime" (version 5.0) https://dotnet.microsoft.com/download/dotnet/5.0/runtime
# Ensure you've made a '''backup''' of the "'''Data'''" folder inside the game server installation folder.
# If you're updating from A28 or earlier versions, DELETE "Data/Saves" folder as the savegame is not compatible (breaking changes). Update from A29 to R30 (and from R30 to its patch versions) '''doesn't require this step''' (savegame is compatible).
# Download the new version of the server and overwrite your current installation with it (you can find the actual download link above in the "Installation" section).
# Stop the game server (if it's running).
# Important: please '''overwrite''' both Binaries and Core folders!
# Start the server as usual.

== Server commands ==
# Ensure you're the server operator (you've edited the ServerSettings.xml file and added yourself into the server_operators_list).
# Connect to your game server.
# The game console can be toggled by pressing <code>~</code> (the key on the left from <code>1</code> key) like in old-school games (you can change the key binding for console in the controls options).
# Please add <code>/</code> (slash) prefix to the server commands you want to execute.
# You can use '''Tab''' key to fill autocomplete, and you can use '''arrow Up/Down keys''' to navigate the suggestions list. Press '''Tab''' or '''Enter''' to accept the suggestion.

Here is the page with the server commands list: [[CryoFall/Server/Commands|Server Commands List]]

== Moderation (whitelist, blacklist, kicking, muting) ==
Server operator can access special moderation commands. To invoke these commands, please ensure you're the server operator, connect to your game server, open the console (~ key) and then you can use these commands: (replace username with the actual player nickname)

Whitelist management:

<code>/mod.whiteList.add username</code>

<code>/mod.whiteList.remove username</code>

<code>/mod.whiteList.print</code>

To enable whitelist:

<code>/mod.whiteList.enabled 1</code>

Blacklist management:

<code>/mod.blackList.add username</code>

<code>/mod.blackList.remove username</code>

<code>/mod.blackList.print</code>

Kicking players (temporary removing from server and blocking from connecting):

<code>/mod.kickList.add username durationInMinutes</code>

<code>/mod.kickList.remove username</code>

<code>/mod.kickList.print</code>

Muting players (temporary removing their ability to send messages to chat):

<code>/mod.muteList.add username durationInMinutes</code>

<code>/mod.muteList.remove username</code>

<code>/mod.muteList.print</code>

== Server rates adjusting / Enabling PvP mode ==
Server rates (and PvP mode setting) are exposed in a separate config file. You can quickly change things like LP gain rate, increase item drops, reduce the player to player damage to zero, or even increase the damage from creatures and make it really tough for the players!

To adjust the server rates, stop the server and check the file <game server>/Data/ServerRates.config
Please read carefullyΓÇöall the rates are disabled and in order to apply them '''you need to remove the # char at the start of the line'''!

If you want to '''enable PvP''', search PvP in the file. By default, this setting's value is 0 and you need to change it to 1 and remove the # char at the start of the line.

For advanced modding please read [http://forums.atomictorch.com/index.php?topic=1027.0 modding prerequisites].

== Server raiding hours (for PvP) ==
'''(Please note: with A27 this feature is not recommend anymore as there is a better feature now ΓÇö S.H.I.E.L.D. protection that is enabled by default for PvP servers)'''

On PvP server, you could set up specific hours during which the raiding is possible.
 By default, offline raiding protection is not enabled so players could raid other players' bases at any time.
 To enable offline raiding protection, please use this in-game console command:
 <code>/admin.setRaidingWindow 4 14 1.5</code>
 In this code we're using (first number) +4 GMT/UTC timezone, (second number) hour of day when raiding is possible (value from 0 to 24), and (third number) is the duration of the raiding window (value from 0 to 24).
 So the code in the example will allow raiding from 14:00 (or 2PM) for 1.5 hours.
 After changing the value you could open Politics/Diplomacy menu ([P] key) and verify whether you set the correct numbers.
 Please note that Politics/Diplomacy menu displaying your local time (in your PC timezone)!

== How to prohibit client modifications ==
If you wish to restrict usage of any client modifications on your server, please find "<no_client_mods>" setting in the SettingsServer.xml file. Change the value from 0 to 1 to enable this feature. It's recommended for PvP servers to set it to 1. You can read more details about this feature in [https://atomictorch.com/Post/Id2218/A28-Justice-Update-Release A28 Update announcement].

CryoFall/Server/Setup

2021-07-04T12:47:56Z

Ai enabled: /* How to setup your own server (on any OS): */

= Local server / Singleplayer =
If you wish to play in singleplayer, you're just two clicks away from starting playing on your own local server!
 Local server is currently provided as an experimental feature. We've received plenty of players' feedback that it works rock-stable already!
 Please follow the [https://store.steampowered.com/news/app/829590/view/3034840264061004771 short guide here] on how to start the local game server!

= Using game server hosting providers =

==== Game server rent service ====
''If you don't want to hassle with the game server setup, you can rent your own CryoFall server from any third party game server hosting company in just a few minutes. They provide data center locations in almost every country around the world!''
* [https://pingperfect.com/gameservers/cryofall-game-server-hosting-rental.php?aff=586 PingPerfect]
* [https://gameserver.4players.de/server-hosting/cryofall-server-mieten/ 4PLAYERS] (the website is available in German only)
''Please note that AtomicTorch Studio is not affiliated with any of these companies and not responsible for their service quality so in case of any issues please reach them directly. So far we've heard only positive feedback about their services.''

= Self-hosting =

== Requirements ==
====Hardware requirements====
(for up to about 30 players online) 1-core CPU 1.6-2 GHz, 1.5 GB RAM, 2-3 Mbit/s bandwidth (each way)
 (for up to about 100 players online) 2-core CPU 1.6-2 GHz, 2 GB RAM, 3-6 Mbit/s bandwidth
 (for up to about 200 players online) 2-core CPU 2.4-3 GHz, 2 GB RAM, 6-12 Mbit/s bandwidth
 (for up to about 300 players online) 2-core CPU 3+ GHz, 2.5 GB RAM, 12-20 Mbit/s bandwidth
 Usually, VPS (virtual machines) hosting such as [https://www.vultr.com/?ref=7238385 Vultr.com] (this is our referral link as we're using this company services to host our own servers) is sufficient for hosting a game server. Using 1-core machines is not recommended as the game requires a secondary CPU to ensure smooth performance without hiccups during intensive background operations (such as world snapshot saving). Using more than a 2-core machine for a single game server hosting is redundant as the game cannot utilize more than two cores due to the sequential execution of the game simulation (except networking).

====Software (system) requirements====
The server could run on Windows, Linux, and Mac.
To achieve this the game server is using .NET Runtime 5.0.
For hosting the official game servers we prefer using CentOS 7 with Docker or CentOS 8 with podman (OSS alternative to Docker).

== Server installation with Docker (best way for Linux) ==
We recommend this for Linux only. Please follow this guide [https://hub.docker.com/r/atomictorch/cryofall-server CryoFall Dedicated Server Docker Image] then return back here to '''"Server installation"''' section and follow the list after number 7. Ignore instructions on how to start the server with "dotnet" as you should use "docker run ..." instead as explained in the Docker guide above.

== Server installation / direct download (Windows, Linux, Mac) ==

==== How to setup your own server (on any OS): ====
# Install .NET Runtime 5.0 x64ΓÇöplease visit [https://dotnet.microsoft.com/download/dotnet/5.0/runtime Download .NET page] and follow the installation guide for your OS.
# Download the game server package from '''[https://atomictorch.com/Files/CryoFall_Server_v1.30.7.6_NetCore.zip SERVER DOWNLOAD LINK (any OS)]'''.
# Extract the downloaded package (it's a regular ZIP archive).
# The server executable is located in the subfolder: "Binaries/Server". Open the command line/terminal/SSH (or PowerShell in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable first time with <code>loadOrNew</code> flag. The server will start and create the game world.
#:<code>dotnet CryoFall_Server.dll loadOrNew</code>
# Usually it takes about 1-2 minutes to create a new world (or load a savegame). After that the server will keep writing performance statistics information every 20 seconds among other information such as the spawn scripts reporting and network events.
# Stop the server. To do so enter the command below and press Enter key.
#:<code>stop 0</code>
#The server will save and quit. Now you have the "SettingsServer.xml" and "ModsConfig.xml" files.
# Now you need to navigate to the subfolder "Data" (in the root of the server folder, '''not''' in the "Binaries/Server") and modify "SettingsServer.xml" to set the unique server '''name''' and set other settings, etc (there are XML comments explaining every setting so it should be straightforward). ''Please note that you can (and should) edit '''Description''' and '''Welcome message''' from the '''CURRENT GAME''' menu right from the game after connecting to your server.''
# If you are interested in making your server visible in the community servers list make sure to edit <is_public_server> and change the value from 0 to 1. Also, please make sure your router is configured correctly (port forwarding) to enable other people to connect to your machine from outside. But ideally, you should use dedicated server hardware (VPS or VDS) to host public servers.
# While you're still editing "SettingsServer.xml" file, please find the value '''<server_operators_list>''' and change it to include '''your nickname'''! Otherwise, you will be unable to access your server console from the game and also you will be unable to edit the server's Description and Welcome message.
# If you want to have a custom server icon, please replace the ServerIcon.png file in the "Data" subfolder. The icon image file requirements: '''PNG24 format, 256x256 size, up to 100 KB'''.

'''Important (for Windows only):''' you need to allow the dotnet process in the Windows Firewall settingsΓÇöif the Firewall access request was not shown automatically by Windows you can add the <code>C:\Program Files\dotnet\dotnet.exe</code> file into Firewall whitelist. To do this, open Windows Start menu and search for "Allow an app through Windows Firewall" -> button "Allow another app".

==== Starting the server ====
# Launch the command line (we recommending '''PowerShell''' in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable with <code>load</code> flag.
#:<code>dotnet CryoFall_Server.dll load</code>
# Stop your server by typing command below and pressing Enter key (it will save the world before stopping).
#:<code>stop 60 The shutdown message text goes here</code>
(Where <code>60</code> is the shutdown delay (in seconds) so the connected players will have some time to find a safe location)

'''''Please note that typing this message is really hard as the console is updating regularly! The best way is to simply copy-paste from the text editor the whole command text into the game console window (hint: you can paste in PowerShell by simply pressing the right mouse button) and pressing Enter key.'''''

You can always wipe the world by launching the game with <code>new</code> flag:
:<code>dotnet CryoFall_Server.dll new</code>

Currently, we don't support the savegame migration between the major game versions (if there are changes to the game data serialization scheme). We plan to implement the proper data migration feature ASAP.

==== Connecting to the server ====
If you want to connect to your local game server, simply add SERVERS->Custom list as <code>localhost</code>

To connect to the public server you need to navigate to SERVERS->Community servers list (please note that this might not work if you host this server on the same PC as the client, read below).

If you're attempting to host your server on a home computer and other players cannot connect to it, you need to manually forward the port '''UDP 6000''' on your home router to '''your local IP address''' (the game has the auto port forwarding feature but it often fails due to the difference in UPnP implementation on many routers). E.g. if your PC's IP address in local network is 192.168.1.100 (you can check it with ipconfig tool or in Windows network adapter's settings) you will need to setup a port forward rule on your router to forward traffic from port 6000 UDP to port 6000 UDP on IP address 192.168.1.100.

'''If you're running a game server on the same PC as the game client:'''
 Please note that you might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its address as <code>localhost:6000</code> and connect to it directly.

'''If you're running a game server in the same local network as the game client (for example you want to play over LAN with your friends and family):'''
 You might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its local IP address (IPv4) and connect to it directly. To get your local IP address please use ipconfig command-line tool or check the network adapter properties in the network center. You need to get the local network IP address of the PC that is hosting the game server. Then add it in the custom servers list on your PC. You can lookup the IP address in the Windows network settings or by using CMD tool called ipconfig in Windows. For example, here we've run the ipconfig tool here and see the IPv4 address as 192.168.1.200 ([https://cdn.discordapp.com/attachments/421250395298332672/739147674367950908/Screenshot_at_19-48-06.png screenshot]). We can use it on any other PC in the local network to connect to that PC hosting the game server.

Connecting to the private servers requires adding it via the Custom servers menu.

6000 is the default port but you can change it in the Data/SettingsServer.xml file.

== Server update/upgrade to new version ==
When we're releasing a new version of the game server, you need to follow these steps to update it:
# (If you have not done this) Install ".NET Runtime" (version 5.0) https://dotnet.microsoft.com/download/dotnet/5.0/runtime
# Ensure you've made a '''backup''' of the "'''Data'''" folder inside the game server installation folder.
# If you're updating from A28 or earlier versions, DELETE "Data/Saves" folder as the savegame is not compatible (breaking changes). Update from A29 to R30 (and from R30 to its patch versions) '''doesn't require this step''' (savegame is compatible).
# Download the new version of the server and overwrite your current installation with it (you can find the actual download link above in the "Installation" section).
# Stop the game server (if it's running).
# Important: please '''overwrite''' both Binaries and Core folders!
# Start the server as usual.

== Server commands ==
# Ensure you're the server operator (you've edited the ServerSettings.xml file and added yourself into the server_operators_list).
# Connect to your game server.
# The game console can be toggled by pressing <code>~</code> (the key on the left from <code>1</code> key) like in old-school games (you can change the key binding for console in the controls options).
# Please add <code>/</code> (slash) prefix to the server commands you want to execute.
# You can use '''Tab''' key to fill autocomplete, and you can use '''arrow Up/Down keys''' to navigate the suggestions list. Press '''Tab''' or '''Enter''' to accept the suggestion.

Here is the page with the server commands list: [[CryoFall/Server/Commands|Server Commands List]]

== Moderation (whitelist, blacklist, kicking, muting) ==
Server operator can access special moderation commands. To invoke these commands, please ensure you're the server operator, connect to your game server, open the console (~ key) and then you can use these commands: (replace username with the actual player nickname)

Whitelist management:

<code>/mod.whiteList.add username</code>

<code>/mod.whiteList.remove username</code>

<code>/mod.whiteList.print</code>

To enable whitelist:

<code>/mod.whiteList.enabled 1</code>

Blacklist management:

<code>/mod.blackList.add username</code>

<code>/mod.blackList.remove username</code>

<code>/mod.blackList.print</code>

Kicking players (temporary removing from server and blocking from connecting):

<code>/mod.kickList.add username durationInMinutes</code>

<code>/mod.kickList.remove username</code>

<code>/mod.kickList.print</code>

Muting players (temporary removing their ability to send messages to chat):

<code>/mod.muteList.add username durationInMinutes</code>

<code>/mod.muteList.remove username</code>

<code>/mod.muteList.print</code>

== Server rates adjusting / Enabling PvP mode ==
Server rates (and PvP mode setting) are exposed in a separate config file. You can quickly change things like LP gain rate, increase item drops, reduce the player to player damage to zero, or even increase the damage from creatures and make it really tough for the players!

To adjust the server rates, stop the server and check the file <game server>/Data/ServerRates.config
Please read carefullyΓÇöall the rates are disabled and in order to apply them '''you need to remove the # char at the start of the line'''!

If you want to '''enable PvP''', search PvP in the file. By default, this setting's value is 0 and you need to change it to 1 and remove the # char at the start of the line.

For advanced modding please read [http://forums.atomictorch.com/index.php?topic=1027.0 modding prerequisites].

== Server raiding hours (for PvP) ==
'''(Please note: with A27 this feature is not recommend anymore as there is a better feature now ΓÇö S.H.I.E.L.D. protection that is enabled by default for PvP servers)'''

On PvP server, you could set up specific hours during which the raiding is possible.
 By default, offline raiding protection is not enabled so players could raid other players' bases at any time.
 To enable offline raiding protection, please use this in-game console command:
 <code>/admin.setRaidingWindow 4 14 1.5</code>
 In this code we're using (first number) +4 GMT/UTC timezone, (second number) hour of day when raiding is possible (value from 0 to 24), and (third number) is the duration of the raiding window (value from 0 to 24).
 So the code in the example will allow raiding from 14:00 (or 2PM) for 1.5 hours.
 After changing the value you could open Politics/Diplomacy menu ([P] key) and verify whether you set the correct numbers.
 Please note that Politics/Diplomacy menu displaying your local time (in your PC timezone)!

== How to prohibit client modifications ==
If you wish to restrict usage of any client modifications on your server, please find "<no_client_mods>" setting in the SettingsServer.xml file. Change the value from 0 to 1 to enable this feature. It's recommended for PvP servers to set it to 1. You can read more details about this feature in [https://atomictorch.com/Post/Id2218/A28-Justice-Update-Release A28 Update announcement].

CryoFall/Server/Setup

2021-06-30T17:13:05Z

Ai enabled: /* How to setup your own server (on any OS): */

= Local server / Singleplayer =
If you wish to play in singleplayer, you're just two clicks away from starting playing on your own local server!
 Local server is currently provided as an experimental feature. We've received plenty of players' feedback that it works rock-stable already!
 Please follow the [https://store.steampowered.com/news/app/829590/view/3034840264061004771 short guide here] on how to start the local game server!

= Using game server hosting providers =

==== Game server rent service ====
''If you don't want to hassle with the game server setup, you can rent your own CryoFall server from any third party game server hosting company in just a few minutes. They provide data center locations in almost every country around the world!''
* [https://pingperfect.com/gameservers/cryofall-game-server-hosting-rental.php?aff=586 PingPerfect]
* [https://gameserver.4players.de/server-hosting/cryofall-server-mieten/ 4PLAYERS] (the website is available in German only)
''Please note that AtomicTorch Studio is not affiliated with any of these companies and not responsible for their service quality so in case of any issues please reach them directly. So far we've heard only positive feedback about their services.''

= Self-hosting =

== Requirements ==
====Hardware requirements====
(for up to about 30 players online) 1-core CPU 1.6-2 GHz, 1.5 GB RAM, 2-3 Mbit/s bandwidth (each way)
 (for up to about 100 players online) 2-core CPU 1.6-2 GHz, 2 GB RAM, 3-6 Mbit/s bandwidth
 (for up to about 200 players online) 2-core CPU 2.4-3 GHz, 2 GB RAM, 6-12 Mbit/s bandwidth
 (for up to about 300 players online) 2-core CPU 3+ GHz, 2.5 GB RAM, 12-20 Mbit/s bandwidth
 Usually, VPS (virtual machines) hosting such as [https://www.vultr.com/?ref=7238385 Vultr.com] (this is our referral link as we're using this company services to host our own servers) is sufficient for hosting a game server. Using 1-core machines is not recommended as the game requires a secondary CPU to ensure smooth performance without hiccups during intensive background operations (such as world snapshot saving). Using more than a 2-core machine for a single game server hosting is redundant as the game cannot utilize more than two cores due to the sequential execution of the game simulation (except networking).

====Software (system) requirements====
The server could run on Windows, Linux, and Mac.
To achieve this the game server is using .NET Runtime 5.0.
For hosting the official game servers we prefer using CentOS 7 with Docker or CentOS 8 with podman (OSS alternative to Docker).

== Server installation with Docker (best way for Linux) ==
We recommend this for Linux only. Please follow this guide [https://hub.docker.com/r/atomictorch/cryofall-server CryoFall Dedicated Server Docker Image] then return back here to '''"Server installation"''' section and follow the list after number 7. Ignore instructions on how to start the server with "dotnet" as you should use "docker run ..." instead as explained in the Docker guide above.

== Server installation / direct download (Windows, Linux, Mac) ==

==== How to setup your own server (on any OS): ====
# Install .NET Runtime 5.0 x64ΓÇöplease visit [https://dotnet.microsoft.com/download/dotnet/5.0/runtime Download .NET page] and follow the installation guide for your OS.
# Download the game server package from '''[https://atomictorch.com/Files/CryoFall_Server_v1.30.7.5_NetCore.zip SERVER DOWNLOAD LINK (any OS)]'''.
# Extract the downloaded package (it's a regular ZIP archive).
# The server executable is located in the subfolder: "Binaries/Server". Open the command line/terminal/SSH (or PowerShell in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable first time with <code>loadOrNew</code> flag. The server will start and create the game world.
#:<code>dotnet CryoFall_Server.dll loadOrNew</code>
# Usually it takes about 1-2 minutes to create a new world (or load a savegame). After that the server will keep writing performance statistics information every 20 seconds among other information such as the spawn scripts reporting and network events.
# Stop the server. To do so enter the command below and press Enter key.
#:<code>stop 0</code>
#The server will save and quit. Now you have the "SettingsServer.xml" and "ModsConfig.xml" files.
# Now you need to navigate to the subfolder "Data" (in the root of the server folder, '''not''' in the "Binaries/Server") and modify "SettingsServer.xml" to set the unique server '''name''' and set other settings, etc (there are XML comments explaining every setting so it should be straightforward). ''Please note that you can (and should) edit '''Description''' and '''Welcome message''' from the '''CURRENT GAME''' menu right from the game after connecting to your server.''
# If you are interested in making your server visible in the community servers list make sure to edit <is_public_server> and change the value from 0 to 1. Also, please make sure your router is configured correctly (port forwarding) to enable other people to connect to your machine from outside. But ideally, you should use dedicated server hardware (VPS or VDS) to host public servers.
# While you're still editing "SettingsServer.xml" file, please find the value '''<server_operators_list>''' and change it to include '''your nickname'''! Otherwise, you will be unable to access your server console from the game and also you will be unable to edit the server's Description and Welcome message.
# If you want to have a custom server icon, please replace the ServerIcon.png file in the "Data" subfolder. The icon image file requirements: '''PNG24 format, 256x256 size, up to 100 KB'''.

'''Important (for Windows only):''' you need to allow the dotnet process in the Windows Firewall settingsΓÇöif the Firewall access request was not shown automatically by Windows you can add the <code>C:\Program Files\dotnet\dotnet.exe</code> file into Firewall whitelist. To do this, open Windows Start menu and search for "Allow an app through Windows Firewall" -> button "Allow another app".

==== Starting the server ====
# Launch the command line (we recommending '''PowerShell''' in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable with <code>load</code> flag.
#:<code>dotnet CryoFall_Server.dll load</code>
# Stop your server by typing command below and pressing Enter key (it will save the world before stopping).
#:<code>stop 60 The shutdown message text goes here</code>
(Where <code>60</code> is the shutdown delay (in seconds) so the connected players will have some time to find a safe location)

'''''Please note that typing this message is really hard as the console is updating regularly! The best way is to simply copy-paste from the text editor the whole command text into the game console window (hint: you can paste in PowerShell by simply pressing the right mouse button) and pressing Enter key.'''''

You can always wipe the world by launching the game with <code>new</code> flag:
:<code>dotnet CryoFall_Server.dll new</code>

Currently, we don't support the savegame migration between the major game versions (if there are changes to the game data serialization scheme). We plan to implement the proper data migration feature ASAP.

==== Connecting to the server ====
If you want to connect to your local game server, simply add SERVERS->Custom list as <code>localhost</code>

To connect to the public server you need to navigate to SERVERS->Community servers list (please note that this might not work if you host this server on the same PC as the client, read below).

If you're attempting to host your server on a home computer and other players cannot connect to it, you need to manually forward the port '''UDP 6000''' on your home router to '''your local IP address''' (the game has the auto port forwarding feature but it often fails due to the difference in UPnP implementation on many routers). E.g. if your PC's IP address in local network is 192.168.1.100 (you can check it with ipconfig tool or in Windows network adapter's settings) you will need to setup a port forward rule on your router to forward traffic from port 6000 UDP to port 6000 UDP on IP address 192.168.1.100.

'''If you're running a game server on the same PC as the game client:'''
 Please note that you might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its address as <code>localhost:6000</code> and connect to it directly.

'''If you're running a game server in the same local network as the game client (for example you want to play over LAN with your friends and family):'''
 You might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its local IP address (IPv4) and connect to it directly. To get your local IP address please use ipconfig command-line tool or check the network adapter properties in the network center. You need to get the local network IP address of the PC that is hosting the game server. Then add it in the custom servers list on your PC. You can lookup the IP address in the Windows network settings or by using CMD tool called ipconfig in Windows. For example, here we've run the ipconfig tool here and see the IPv4 address as 192.168.1.200 ([https://cdn.discordapp.com/attachments/421250395298332672/739147674367950908/Screenshot_at_19-48-06.png screenshot]). We can use it on any other PC in the local network to connect to that PC hosting the game server.

Connecting to the private servers requires adding it via the Custom servers menu.

6000 is the default port but you can change it in the Data/SettingsServer.xml file.

== Server update/upgrade to new version ==
When we're releasing a new version of the game server, you need to follow these steps to update it:
# (If you have not done this) Install ".NET Runtime" (version 5.0) https://dotnet.microsoft.com/download/dotnet/5.0/runtime
# Ensure you've made a '''backup''' of the "'''Data'''" folder inside the game server installation folder.
# If you're updating from A28 or earlier versions, DELETE "Data/Saves" folder as the savegame is not compatible (breaking changes). Update from A29 to R30 (and from R30 to its patch versions) '''doesn't require this step''' (savegame is compatible).
# Download the new version of the server and overwrite your current installation with it (you can find the actual download link above in the "Installation" section).
# Stop the game server (if it's running).
# Important: please '''overwrite''' both Binaries and Core folders!
# Start the server as usual.

== Server commands ==
# Ensure you're the server operator (you've edited the ServerSettings.xml file and added yourself into the server_operators_list).
# Connect to your game server.
# The game console can be toggled by pressing <code>~</code> (the key on the left from <code>1</code> key) like in old-school games (you can change the key binding for console in the controls options).
# Please add <code>/</code> (slash) prefix to the server commands you want to execute.
# You can use '''Tab''' key to fill autocomplete, and you can use '''arrow Up/Down keys''' to navigate the suggestions list. Press '''Tab''' or '''Enter''' to accept the suggestion.

Here is the page with the server commands list: [[CryoFall/Server/Commands|Server Commands List]]

== Moderation (whitelist, blacklist, kicking, muting) ==
Server operator can access special moderation commands. To invoke these commands, please ensure you're the server operator, connect to your game server, open the console (~ key) and then you can use these commands: (replace username with the actual player nickname)

Whitelist management:

<code>/mod.whiteList.add username</code>

<code>/mod.whiteList.remove username</code>

<code>/mod.whiteList.print</code>

To enable whitelist:

<code>/mod.whiteList.enabled 1</code>

Blacklist management:

<code>/mod.blackList.add username</code>

<code>/mod.blackList.remove username</code>

<code>/mod.blackList.print</code>

Kicking players (temporary removing from server and blocking from connecting):

<code>/mod.kickList.add username durationInMinutes</code>

<code>/mod.kickList.remove username</code>

<code>/mod.kickList.print</code>

Muting players (temporary removing their ability to send messages to chat):

<code>/mod.muteList.add username durationInMinutes</code>

<code>/mod.muteList.remove username</code>

<code>/mod.muteList.print</code>

== Server rates adjusting / Enabling PvP mode ==
Server rates (and PvP mode setting) are exposed in a separate config file. You can quickly change things like LP gain rate, increase item drops, reduce the player to player damage to zero, or even increase the damage from creatures and make it really tough for the players!

To adjust the server rates, stop the server and check the file <game server>/Data/ServerRates.config
Please read carefullyΓÇöall the rates are disabled and in order to apply them '''you need to remove the # char at the start of the line'''!

If you want to '''enable PvP''', search PvP in the file. By default, this setting's value is 0 and you need to change it to 1 and remove the # char at the start of the line.

For advanced modding please read [http://forums.atomictorch.com/index.php?topic=1027.0 modding prerequisites].

== Server raiding hours (for PvP) ==
'''(Please note: with A27 this feature is not recommend anymore as there is a better feature now ΓÇö S.H.I.E.L.D. protection that is enabled by default for PvP servers)'''

On PvP server, you could set up specific hours during which the raiding is possible.
 By default, offline raiding protection is not enabled so players could raid other players' bases at any time.
 To enable offline raiding protection, please use this in-game console command:
 <code>/admin.setRaidingWindow 4 14 1.5</code>
 In this code we're using (first number) +4 GMT/UTC timezone, (second number) hour of day when raiding is possible (value from 0 to 24), and (third number) is the duration of the raiding window (value from 0 to 24).
 So the code in the example will allow raiding from 14:00 (or 2PM) for 1.5 hours.
 After changing the value you could open Politics/Diplomacy menu ([P] key) and verify whether you set the correct numbers.
 Please note that Politics/Diplomacy menu displaying your local time (in your PC timezone)!

== How to prohibit client modifications ==
If you wish to restrict usage of any client modifications on your server, please find "<no_client_mods>" setting in the SettingsServer.xml file. Change the value from 0 to 1 to enable this feature. It's recommended for PvP servers to set it to 1. You can read more details about this feature in [https://atomictorch.com/Post/Id2218/A28-Justice-Update-Release A28 Update announcement].

CryoFall/Server/Setup

2021-06-25T15:15:29Z

Ai enabled: /* How to setup your own server (on any OS): */

= Local server / Singleplayer =
If you wish to play in singleplayer, you're just two clicks away from starting playing on your own local server!
 Local server is currently provided as an experimental feature. We've received plenty of players' feedback that it works rock-stable already!
 Please follow the [https://store.steampowered.com/news/app/829590/view/3034840264061004771 short guide here] on how to start the local game server!

= Using game server hosting providers =

==== Game server rent service ====
''If you don't want to hassle with the game server setup, you can rent your own CryoFall server from any third party game server hosting company in just a few minutes. They provide data center locations in almost every country around the world!''
* [https://pingperfect.com/gameservers/cryofall-game-server-hosting-rental.php?aff=586 PingPerfect]
* [https://gameserver.4players.de/server-hosting/cryofall-server-mieten/ 4PLAYERS] (the website is available in German only)
''Please note that AtomicTorch Studio is not affiliated with any of these companies and not responsible for their service quality so in case of any issues please reach them directly. So far we've heard only positive feedback about their services.''

= Self-hosting =

== Requirements ==
====Hardware requirements====
(for up to about 30 players online) 1-core CPU 1.6-2 GHz, 1.5 GB RAM, 2-3 Mbit/s bandwidth (each way)
 (for up to about 100 players online) 2-core CPU 1.6-2 GHz, 2 GB RAM, 3-6 Mbit/s bandwidth
 (for up to about 200 players online) 2-core CPU 2.4-3 GHz, 2 GB RAM, 6-12 Mbit/s bandwidth
 (for up to about 300 players online) 2-core CPU 3+ GHz, 2.5 GB RAM, 12-20 Mbit/s bandwidth
 Usually, VPS (virtual machines) hosting such as [https://www.vultr.com/?ref=7238385 Vultr.com] (this is our referral link as we're using this company services to host our own servers) is sufficient for hosting a game server. Using 1-core machines is not recommended as the game requires a secondary CPU to ensure smooth performance without hiccups during intensive background operations (such as world snapshot saving). Using more than a 2-core machine for a single game server hosting is redundant as the game cannot utilize more than two cores due to the sequential execution of the game simulation (except networking).

====Software (system) requirements====
The server could run on Windows, Linux, and Mac.
To achieve this the game server is using .NET Runtime 5.0.
For hosting the official game servers we prefer using CentOS 7 with Docker or CentOS 8 with podman (OSS alternative to Docker).

== Server installation with Docker (best way for Linux) ==
We recommend this for Linux only. Please follow this guide [https://hub.docker.com/r/atomictorch/cryofall-server CryoFall Dedicated Server Docker Image] then return back here to '''"Server installation"''' section and follow the list after number 7. Ignore instructions on how to start the server with "dotnet" as you should use "docker run ..." instead as explained in the Docker guide above.

== Server installation / direct download (Windows, Linux, Mac) ==

==== How to setup your own server (on any OS): ====
# Install .NET Runtime 5.0 x64ΓÇöplease visit [https://dotnet.microsoft.com/download/dotnet/5.0/runtime Download .NET page] and follow the installation guide for your OS.
# Download the game server package from '''[https://atomictorch.com/Files/CryoFall_Server_v1.30.7.4_NetCore.zip SERVER DOWNLOAD LINK (any OS)]'''.
# Extract the downloaded package (it's a regular ZIP archive).
# The server executable is located in the subfolder: "Binaries/Server". Open the command line/terminal/SSH (or PowerShell in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable first time with <code>loadOrNew</code> flag. The server will start and create the game world.
#:<code>dotnet CryoFall_Server.dll loadOrNew</code>
# Usually it takes about 1-2 minutes to create a new world (or load a savegame). After that the server will keep writing performance statistics information every 20 seconds among other information such as the spawn scripts reporting and network events.
# Stop the server. To do so enter the command below and press Enter key.
#:<code>stop 0</code>
#The server will save and quit. Now you have the "SettingsServer.xml" and "ModsConfig.xml" files.
# Now you need to navigate to the subfolder "Data" (in the root of the server folder, '''not''' in the "Binaries/Server") and modify "SettingsServer.xml" to set the unique server '''name''' and set other settings, etc (there are XML comments explaining every setting so it should be straightforward). ''Please note that you can (and should) edit '''Description''' and '''Welcome message''' from the '''CURRENT GAME''' menu right from the game after connecting to your server.''
# If you are interested in making your server visible in the community servers list make sure to edit <is_public_server> and change the value from 0 to 1. Also, please make sure your router is configured correctly (port forwarding) to enable other people to connect to your machine from outside. But ideally, you should use dedicated server hardware (VPS or VDS) to host public servers.
# While you're still editing "SettingsServer.xml" file, please find the value '''<server_operators_list>''' and change it to include '''your nickname'''! Otherwise, you will be unable to access your server console from the game and also you will be unable to edit the server's Description and Welcome message.
# If you want to have a custom server icon, please replace the ServerIcon.png file in the "Data" subfolder. The icon image file requirements: '''PNG24 format, 256x256 size, up to 100 KB'''.

'''Important (for Windows only):''' you need to allow the dotnet process in the Windows Firewall settingsΓÇöif the Firewall access request was not shown automatically by Windows you can add the <code>C:\Program Files\dotnet\dotnet.exe</code> file into Firewall whitelist. To do this, open Windows Start menu and search for "Allow an app through Windows Firewall" -> button "Allow another app".

==== Starting the server ====
# Launch the command line (we recommending '''PowerShell''' in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable with <code>load</code> flag.
#:<code>dotnet CryoFall_Server.dll load</code>
# Stop your server by typing command below and pressing Enter key (it will save the world before stopping).
#:<code>stop 60 The shutdown message text goes here</code>
(Where <code>60</code> is the shutdown delay (in seconds) so the connected players will have some time to find a safe location)

'''''Please note that typing this message is really hard as the console is updating regularly! The best way is to simply copy-paste from the text editor the whole command text into the game console window (hint: you can paste in PowerShell by simply pressing the right mouse button) and pressing Enter key.'''''

You can always wipe the world by launching the game with <code>new</code> flag:
:<code>dotnet CryoFall_Server.dll new</code>

Currently, we don't support the savegame migration between the major game versions (if there are changes to the game data serialization scheme). We plan to implement the proper data migration feature ASAP.

==== Connecting to the server ====
If you want to connect to your local game server, simply add SERVERS->Custom list as <code>localhost</code>

To connect to the public server you need to navigate to SERVERS->Community servers list (please note that this might not work if you host this server on the same PC as the client, read below).

If you're attempting to host your server on a home computer and other players cannot connect to it, you need to manually forward the port '''UDP 6000''' on your home router to '''your local IP address''' (the game has the auto port forwarding feature but it often fails due to the difference in UPnP implementation on many routers). E.g. if your PC's IP address in local network is 192.168.1.100 (you can check it with ipconfig tool or in Windows network adapter's settings) you will need to setup a port forward rule on your router to forward traffic from port 6000 UDP to port 6000 UDP on IP address 192.168.1.100.

'''If you're running a game server on the same PC as the game client:'''
 Please note that you might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its address as <code>localhost:6000</code> and connect to it directly.

'''If you're running a game server in the same local network as the game client (for example you want to play over LAN with your friends and family):'''
 You might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its local IP address (IPv4) and connect to it directly. To get your local IP address please use ipconfig command-line tool or check the network adapter properties in the network center. You need to get the local network IP address of the PC that is hosting the game server. Then add it in the custom servers list on your PC. You can lookup the IP address in the Windows network settings or by using CMD tool called ipconfig in Windows. For example, here we've run the ipconfig tool here and see the IPv4 address as 192.168.1.200 ([https://cdn.discordapp.com/attachments/421250395298332672/739147674367950908/Screenshot_at_19-48-06.png screenshot]). We can use it on any other PC in the local network to connect to that PC hosting the game server.

Connecting to the private servers requires adding it via the Custom servers menu.

6000 is the default port but you can change it in the Data/SettingsServer.xml file.

== Server update/upgrade to new version ==
When we're releasing a new version of the game server, you need to follow these steps to update it:
# (If you have not done this) Install ".NET Runtime" (version 5.0) https://dotnet.microsoft.com/download/dotnet/5.0/runtime
# Ensure you've made a '''backup''' of the "'''Data'''" folder inside the game server installation folder.
# If you're updating from A28 or earlier versions, DELETE "Data/Saves" folder as the savegame is not compatible (breaking changes). Update from A29 to R30 (and from R30 to its patch versions) '''doesn't require this step''' (savegame is compatible).
# Download the new version of the server and overwrite your current installation with it (you can find the actual download link above in the "Installation" section).
# Stop the game server (if it's running).
# Important: please '''overwrite''' both Binaries and Core folders!
# Start the server as usual.

== Server commands ==
# Ensure you're the server operator (you've edited the ServerSettings.xml file and added yourself into the server_operators_list).
# Connect to your game server.
# The game console can be toggled by pressing <code>~</code> (the key on the left from <code>1</code> key) like in old-school games (you can change the key binding for console in the controls options).
# Please add <code>/</code> (slash) prefix to the server commands you want to execute.
# You can use '''Tab''' key to fill autocomplete, and you can use '''arrow Up/Down keys''' to navigate the suggestions list. Press '''Tab''' or '''Enter''' to accept the suggestion.

Here is the page with the server commands list: [[CryoFall/Server/Commands|Server Commands List]]

== Moderation (whitelist, blacklist, kicking, muting) ==
Server operator can access special moderation commands. To invoke these commands, please ensure you're the server operator, connect to your game server, open the console (~ key) and then you can use these commands: (replace username with the actual player nickname)

Whitelist management:

<code>/mod.whiteList.add username</code>

<code>/mod.whiteList.remove username</code>

<code>/mod.whiteList.print</code>

To enable whitelist:

<code>/mod.whiteList.enabled 1</code>

Blacklist management:

<code>/mod.blackList.add username</code>

<code>/mod.blackList.remove username</code>

<code>/mod.blackList.print</code>

Kicking players (temporary removing from server and blocking from connecting):

<code>/mod.kickList.add username durationInMinutes</code>

<code>/mod.kickList.remove username</code>

<code>/mod.kickList.print</code>

Muting players (temporary removing their ability to send messages to chat):

<code>/mod.muteList.add username durationInMinutes</code>

<code>/mod.muteList.remove username</code>

<code>/mod.muteList.print</code>

== Server rates adjusting / Enabling PvP mode ==
Server rates (and PvP mode setting) are exposed in a separate config file. You can quickly change things like LP gain rate, increase item drops, reduce the player to player damage to zero, or even increase the damage from creatures and make it really tough for the players!

To adjust the server rates, stop the server and check the file <game server>/Data/ServerRates.config
Please read carefullyΓÇöall the rates are disabled and in order to apply them '''you need to remove the # char at the start of the line'''!

If you want to '''enable PvP''', search PvP in the file. By default, this setting's value is 0 and you need to change it to 1 and remove the # char at the start of the line.

For advanced modding please read [http://forums.atomictorch.com/index.php?topic=1027.0 modding prerequisites].

== Server raiding hours (for PvP) ==
'''(Please note: with A27 this feature is not recommend anymore as there is a better feature now ΓÇö S.H.I.E.L.D. protection that is enabled by default for PvP servers)'''

On PvP server, you could set up specific hours during which the raiding is possible.
 By default, offline raiding protection is not enabled so players could raid other players' bases at any time.
 To enable offline raiding protection, please use this in-game console command:
 <code>/admin.setRaidingWindow 4 14 1.5</code>
 In this code we're using (first number) +4 GMT/UTC timezone, (second number) hour of day when raiding is possible (value from 0 to 24), and (third number) is the duration of the raiding window (value from 0 to 24).
 So the code in the example will allow raiding from 14:00 (or 2PM) for 1.5 hours.
 After changing the value you could open Politics/Diplomacy menu ([P] key) and verify whether you set the correct numbers.
 Please note that Politics/Diplomacy menu displaying your local time (in your PC timezone)!

== How to prohibit client modifications ==
If you wish to restrict usage of any client modifications on your server, please find "<no_client_mods>" setting in the SettingsServer.xml file. Change the value from 0 to 1 to enable this feature. It's recommended for PvP servers to set it to 1. You can read more details about this feature in [https://atomictorch.com/Post/Id2218/A28-Justice-Update-Release A28 Update announcement].

CryoFall/Server/Setup

2021-06-25T14:54:11Z

Ai enabled: /* How to setup your own server (on any OS): */

= Local server / Singleplayer =
If you wish to play in singleplayer, you're just two clicks away from starting playing on your own local server!
 Local server is currently provided as an experimental feature. We've received plenty of players' feedback that it works rock-stable already!
 Please follow the [https://store.steampowered.com/news/app/829590/view/3034840264061004771 short guide here] on how to start the local game server!

= Using game server hosting providers =

==== Game server rent service ====
''If you don't want to hassle with the game server setup, you can rent your own CryoFall server from any third party game server hosting company in just a few minutes. They provide data center locations in almost every country around the world!''
* [https://pingperfect.com/gameservers/cryofall-game-server-hosting-rental.php?aff=586 PingPerfect]
* [https://gameserver.4players.de/server-hosting/cryofall-server-mieten/ 4PLAYERS] (the website is available in German only)
''Please note that AtomicTorch Studio is not affiliated with any of these companies and not responsible for their service quality so in case of any issues please reach them directly. So far we've heard only positive feedback about their services.''

= Self-hosting =

== Requirements ==
====Hardware requirements====
(for up to about 30 players online) 1-core CPU 1.6-2 GHz, 1.5 GB RAM, 2-3 Mbit/s bandwidth (each way)
 (for up to about 100 players online) 2-core CPU 1.6-2 GHz, 2 GB RAM, 3-6 Mbit/s bandwidth
 (for up to about 200 players online) 2-core CPU 2.4-3 GHz, 2 GB RAM, 6-12 Mbit/s bandwidth
 (for up to about 300 players online) 2-core CPU 3+ GHz, 2.5 GB RAM, 12-20 Mbit/s bandwidth
 Usually, VPS (virtual machines) hosting such as [https://www.vultr.com/?ref=7238385 Vultr.com] (this is our referral link as we're using this company services to host our own servers) is sufficient for hosting a game server. Using 1-core machines is not recommended as the game requires a secondary CPU to ensure smooth performance without hiccups during intensive background operations (such as world snapshot saving). Using more than a 2-core machine for a single game server hosting is redundant as the game cannot utilize more than two cores due to the sequential execution of the game simulation (except networking).

====Software (system) requirements====
The server could run on Windows, Linux, and Mac.
To achieve this the game server is using .NET Runtime 5.0.
For hosting the official game servers we prefer using CentOS 7 with Docker or CentOS 8 with podman (OSS alternative to Docker).

== Server installation with Docker (best way for Linux) ==
We recommend this for Linux only. Please follow this guide [https://hub.docker.com/r/atomictorch/cryofall-server CryoFall Dedicated Server Docker Image] then return back here to '''"Server installation"''' section and follow the list after number 7. Ignore instructions on how to start the server with "dotnet" as you should use "docker run ..." instead as explained in the Docker guide above.

== Server installation / direct download (Windows, Linux, Mac) ==

==== How to setup your own server (on any OS): ====
# Install .NET Runtime 5.0 x64ΓÇöplease visit [https://dotnet.microsoft.com/download/dotnet/5.0/runtime Download .NET page] and follow the installation guide for your OS.
# Download the game server package from '''[https://atomictorch.com/Files/CryoFall_Server_v1.30.7.3_NetCore.zip SERVER DOWNLOAD LINK (any OS)]'''.
# Extract the downloaded package (it's a regular ZIP archive).
# The server executable is located in the subfolder: "Binaries/Server". Open the command line/terminal/SSH (or PowerShell in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable first time with <code>loadOrNew</code> flag. The server will start and create the game world.
#:<code>dotnet CryoFall_Server.dll loadOrNew</code>
# Usually it takes about 1-2 minutes to create a new world (or load a savegame). After that the server will keep writing performance statistics information every 20 seconds among other information such as the spawn scripts reporting and network events.
# Stop the server. To do so enter the command below and press Enter key.
#:<code>stop 0</code>
#The server will save and quit. Now you have the "SettingsServer.xml" and "ModsConfig.xml" files.
# Now you need to navigate to the subfolder "Data" (in the root of the server folder, '''not''' in the "Binaries/Server") and modify "SettingsServer.xml" to set the unique server '''name''' and set other settings, etc (there are XML comments explaining every setting so it should be straightforward). ''Please note that you can (and should) edit '''Description''' and '''Welcome message''' from the '''CURRENT GAME''' menu right from the game after connecting to your server.''
# If you are interested in making your server visible in the community servers list make sure to edit <is_public_server> and change the value from 0 to 1. Also, please make sure your router is configured correctly (port forwarding) to enable other people to connect to your machine from outside. But ideally, you should use dedicated server hardware (VPS or VDS) to host public servers.
# While you're still editing "SettingsServer.xml" file, please find the value '''<server_operators_list>''' and change it to include '''your nickname'''! Otherwise, you will be unable to access your server console from the game and also you will be unable to edit the server's Description and Welcome message.
# If you want to have a custom server icon, please replace the ServerIcon.png file in the "Data" subfolder. The icon image file requirements: '''PNG24 format, 256x256 size, up to 100 KB'''.

'''Important (for Windows only):''' you need to allow the dotnet process in the Windows Firewall settingsΓÇöif the Firewall access request was not shown automatically by Windows you can add the <code>C:\Program Files\dotnet\dotnet.exe</code> file into Firewall whitelist. To do this, open Windows Start menu and search for "Allow an app through Windows Firewall" -> button "Allow another app".

==== Starting the server ====
# Launch the command line (we recommending '''PowerShell''' in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable with <code>load</code> flag.
#:<code>dotnet CryoFall_Server.dll load</code>
# Stop your server by typing command below and pressing Enter key (it will save the world before stopping).
#:<code>stop 60 The shutdown message text goes here</code>
(Where <code>60</code> is the shutdown delay (in seconds) so the connected players will have some time to find a safe location)

'''''Please note that typing this message is really hard as the console is updating regularly! The best way is to simply copy-paste from the text editor the whole command text into the game console window (hint: you can paste in PowerShell by simply pressing the right mouse button) and pressing Enter key.'''''

You can always wipe the world by launching the game with <code>new</code> flag:
:<code>dotnet CryoFall_Server.dll new</code>

Currently, we don't support the savegame migration between the major game versions (if there are changes to the game data serialization scheme). We plan to implement the proper data migration feature ASAP.

==== Connecting to the server ====
If you want to connect to your local game server, simply add SERVERS->Custom list as <code>localhost</code>

To connect to the public server you need to navigate to SERVERS->Community servers list (please note that this might not work if you host this server on the same PC as the client, read below).

If you're attempting to host your server on a home computer and other players cannot connect to it, you need to manually forward the port '''UDP 6000''' on your home router to '''your local IP address''' (the game has the auto port forwarding feature but it often fails due to the difference in UPnP implementation on many routers). E.g. if your PC's IP address in local network is 192.168.1.100 (you can check it with ipconfig tool or in Windows network adapter's settings) you will need to setup a port forward rule on your router to forward traffic from port 6000 UDP to port 6000 UDP on IP address 192.168.1.100.

'''If you're running a game server on the same PC as the game client:'''
 Please note that you might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its address as <code>localhost:6000</code> and connect to it directly.

'''If you're running a game server in the same local network as the game client (for example you want to play over LAN with your friends and family):'''
 You might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its local IP address (IPv4) and connect to it directly. To get your local IP address please use ipconfig command-line tool or check the network adapter properties in the network center. You need to get the local network IP address of the PC that is hosting the game server. Then add it in the custom servers list on your PC. You can lookup the IP address in the Windows network settings or by using CMD tool called ipconfig in Windows. For example, here we've run the ipconfig tool here and see the IPv4 address as 192.168.1.200 ([https://cdn.discordapp.com/attachments/421250395298332672/739147674367950908/Screenshot_at_19-48-06.png screenshot]). We can use it on any other PC in the local network to connect to that PC hosting the game server.

Connecting to the private servers requires adding it via the Custom servers menu.

6000 is the default port but you can change it in the Data/SettingsServer.xml file.

== Server update/upgrade to new version ==
When we're releasing a new version of the game server, you need to follow these steps to update it:
# (If you have not done this) Install ".NET Runtime" (version 5.0) https://dotnet.microsoft.com/download/dotnet/5.0/runtime
# Ensure you've made a '''backup''' of the "'''Data'''" folder inside the game server installation folder.
# If you're updating from A28 or earlier versions, DELETE "Data/Saves" folder as the savegame is not compatible (breaking changes). Update from A29 to R30 (and from R30 to its patch versions) '''doesn't require this step''' (savegame is compatible).
# Download the new version of the server and overwrite your current installation with it (you can find the actual download link above in the "Installation" section).
# Stop the game server (if it's running).
# Important: please '''overwrite''' both Binaries and Core folders!
# Start the server as usual.

== Server commands ==
# Ensure you're the server operator (you've edited the ServerSettings.xml file and added yourself into the server_operators_list).
# Connect to your game server.
# The game console can be toggled by pressing <code>~</code> (the key on the left from <code>1</code> key) like in old-school games (you can change the key binding for console in the controls options).
# Please add <code>/</code> (slash) prefix to the server commands you want to execute.
# You can use '''Tab''' key to fill autocomplete, and you can use '''arrow Up/Down keys''' to navigate the suggestions list. Press '''Tab''' or '''Enter''' to accept the suggestion.

Here is the page with the server commands list: [[CryoFall/Server/Commands|Server Commands List]]

== Moderation (whitelist, blacklist, kicking, muting) ==
Server operator can access special moderation commands. To invoke these commands, please ensure you're the server operator, connect to your game server, open the console (~ key) and then you can use these commands: (replace username with the actual player nickname)

Whitelist management:

<code>/mod.whiteList.add username</code>

<code>/mod.whiteList.remove username</code>

<code>/mod.whiteList.print</code>

To enable whitelist:

<code>/mod.whiteList.enabled 1</code>

Blacklist management:

<code>/mod.blackList.add username</code>

<code>/mod.blackList.remove username</code>

<code>/mod.blackList.print</code>

Kicking players (temporary removing from server and blocking from connecting):

<code>/mod.kickList.add username durationInMinutes</code>

<code>/mod.kickList.remove username</code>

<code>/mod.kickList.print</code>

Muting players (temporary removing their ability to send messages to chat):

<code>/mod.muteList.add username durationInMinutes</code>

<code>/mod.muteList.remove username</code>

<code>/mod.muteList.print</code>

== Server rates adjusting / Enabling PvP mode ==
Server rates (and PvP mode setting) are exposed in a separate config file. You can quickly change things like LP gain rate, increase item drops, reduce the player to player damage to zero, or even increase the damage from creatures and make it really tough for the players!

To adjust the server rates, stop the server and check the file <game server>/Data/ServerRates.config
Please read carefullyΓÇöall the rates are disabled and in order to apply them '''you need to remove the # char at the start of the line'''!

If you want to '''enable PvP''', search PvP in the file. By default, this setting's value is 0 and you need to change it to 1 and remove the # char at the start of the line.

For advanced modding please read [http://forums.atomictorch.com/index.php?topic=1027.0 modding prerequisites].

== Server raiding hours (for PvP) ==
'''(Please note: with A27 this feature is not recommend anymore as there is a better feature now ΓÇö S.H.I.E.L.D. protection that is enabled by default for PvP servers)'''

On PvP server, you could set up specific hours during which the raiding is possible.
 By default, offline raiding protection is not enabled so players could raid other players' bases at any time.
 To enable offline raiding protection, please use this in-game console command:
 <code>/admin.setRaidingWindow 4 14 1.5</code>
 In this code we're using (first number) +4 GMT/UTC timezone, (second number) hour of day when raiding is possible (value from 0 to 24), and (third number) is the duration of the raiding window (value from 0 to 24).
 So the code in the example will allow raiding from 14:00 (or 2PM) for 1.5 hours.
 After changing the value you could open Politics/Diplomacy menu ([P] key) and verify whether you set the correct numbers.
 Please note that Politics/Diplomacy menu displaying your local time (in your PC timezone)!

== How to prohibit client modifications ==
If you wish to restrict usage of any client modifications on your server, please find "<no_client_mods>" setting in the SettingsServer.xml file. Change the value from 0 to 1 to enable this feature. It's recommended for PvP servers to set it to 1. You can read more details about this feature in [https://atomictorch.com/Post/Id2218/A28-Justice-Update-Release A28 Update announcement].

CryoFall/Server/Setup

2021-06-25T13:34:47Z

Ai enabled: /* Server update/upgrade to new version */

= Local server / Singleplayer =
If you wish to play in singleplayer, you're just two clicks away from starting playing on your own local server!
 Local server is currently provided as an experimental feature. We've received plenty of players' feedback that it works rock-stable already!
 Please follow the [https://store.steampowered.com/news/app/829590/view/3034840264061004771 short guide here] on how to start the local game server!

= Using game server hosting providers =

==== Game server rent service ====
''If you don't want to hassle with the game server setup, you can rent your own CryoFall server from any third party game server hosting company in just a few minutes. They provide data center locations in almost every country around the world!''
* [https://pingperfect.com/gameservers/cryofall-game-server-hosting-rental.php?aff=586 PingPerfect]
* [https://gameserver.4players.de/server-hosting/cryofall-server-mieten/ 4PLAYERS] (the website is available in German only)
''Please note that AtomicTorch Studio is not affiliated with any of these companies and not responsible for their service quality so in case of any issues please reach them directly. So far we've heard only positive feedback about their services.''

= Self-hosting =

== Requirements ==
====Hardware requirements====
(for up to about 30 players online) 1-core CPU 1.6-2 GHz, 1.5 GB RAM, 2-3 Mbit/s bandwidth (each way)
 (for up to about 100 players online) 2-core CPU 1.6-2 GHz, 2 GB RAM, 3-6 Mbit/s bandwidth
 (for up to about 200 players online) 2-core CPU 2.4-3 GHz, 2 GB RAM, 6-12 Mbit/s bandwidth
 (for up to about 300 players online) 2-core CPU 3+ GHz, 2.5 GB RAM, 12-20 Mbit/s bandwidth
 Usually, VPS (virtual machines) hosting such as [https://www.vultr.com/?ref=7238385 Vultr.com] (this is our referral link as we're using this company services to host our own servers) is sufficient for hosting a game server. Using 1-core machines is not recommended as the game requires a secondary CPU to ensure smooth performance without hiccups during intensive background operations (such as world snapshot saving). Using more than a 2-core machine for a single game server hosting is redundant as the game cannot utilize more than two cores due to the sequential execution of the game simulation (except networking).

====Software (system) requirements====
The server could run on Windows, Linux, and Mac.
To achieve this the game server is using .NET Runtime 5.0.
For hosting the official game servers we prefer using CentOS 7 with Docker or CentOS 8 with podman (OSS alternative to Docker).

== Server installation with Docker (best way for Linux) ==
We recommend this for Linux only. Please follow this guide [https://hub.docker.com/r/atomictorch/cryofall-server CryoFall Dedicated Server Docker Image] then return back here to '''"Server installation"''' section and follow the list after number 7. Ignore instructions on how to start the server with "dotnet" as you should use "docker run ..." instead as explained in the Docker guide above.

== Server installation / direct download (Windows, Linux, Mac) ==

==== How to setup your own server (on any OS): ====
# Install .NET Runtime 5.0 x64ΓÇöplease visit [https://dotnet.microsoft.com/download/dotnet/5.0/runtime Download .NET page] and follow the installation guide for your OS.
# Download the game server package from '''[https://atomictorch.com/Files/CryoFall_Server_v1.30.6.8_NetCore.zip SERVER DOWNLOAD LINK (any OS)]'''.
# Extract the downloaded package (it's a regular ZIP archive).
# The server executable is located in the subfolder: "Binaries/Server". Open the command line/terminal/SSH (or PowerShell in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable first time with <code>loadOrNew</code> flag. The server will start and create the game world.
#:<code>dotnet CryoFall_Server.dll loadOrNew</code>
# Usually it takes about 1-2 minutes to create a new world (or load a savegame). After that the server will keep writing performance statistics information every 20 seconds among other information such as the spawn scripts reporting and network events.
# Stop the server. To do so enter the command below and press Enter key.
#:<code>stop 0</code>
#The server will save and quit. Now you have the "SettingsServer.xml" and "ModsConfig.xml" files.
# Now you need to navigate to the subfolder "Data" (in the root of the server folder, '''not''' in the "Binaries/Server") and modify "SettingsServer.xml" to set the unique server '''name''' and set other settings, etc (there are XML comments explaining every setting so it should be straightforward). ''Please note that you can (and should) edit '''Description''' and '''Welcome message''' from the '''CURRENT GAME''' menu right from the game after connecting to your server.''
# If you are interested in making your server visible in the community servers list make sure to edit <is_public_server> and change the value from 0 to 1. Also, please make sure your router is configured correctly (port forwarding) to enable other people to connect to your machine from outside. But ideally, you should use dedicated server hardware (VPS or VDS) to host public servers.
# While you're still editing "SettingsServer.xml" file, please find the value '''<server_operators_list>''' and change it to include '''your nickname'''! Otherwise, you will be unable to access your server console from the game and also you will be unable to edit the server's Description and Welcome message.
# If you want to have a custom server icon, please replace the ServerIcon.png file in the "Data" subfolder. The icon image file requirements: '''PNG24 format, 256x256 size, up to 100 KB'''.

'''Important (for Windows only):''' you need to allow the dotnet process in the Windows Firewall settingsΓÇöif the Firewall access request was not shown automatically by Windows you can add the <code>C:\Program Files\dotnet\dotnet.exe</code> file into Firewall whitelist. To do this, open Windows Start menu and search for "Allow an app through Windows Firewall" -> button "Allow another app".

==== Starting the server ====
# Launch the command line (we recommending '''PowerShell''' in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable with <code>load</code> flag.
#:<code>dotnet CryoFall_Server.dll load</code>
# Stop your server by typing command below and pressing Enter key (it will save the world before stopping).
#:<code>stop 60 The shutdown message text goes here</code>
(Where <code>60</code> is the shutdown delay (in seconds) so the connected players will have some time to find a safe location)

'''''Please note that typing this message is really hard as the console is updating regularly! The best way is to simply copy-paste from the text editor the whole command text into the game console window (hint: you can paste in PowerShell by simply pressing the right mouse button) and pressing Enter key.'''''

You can always wipe the world by launching the game with <code>new</code> flag:
:<code>dotnet CryoFall_Server.dll new</code>

Currently, we don't support the savegame migration between the major game versions (if there are changes to the game data serialization scheme). We plan to implement the proper data migration feature ASAP.

==== Connecting to the server ====
If you want to connect to your local game server, simply add SERVERS->Custom list as <code>localhost</code>

To connect to the public server you need to navigate to SERVERS->Community servers list (please note that this might not work if you host this server on the same PC as the client, read below).

If you're attempting to host your server on a home computer and other players cannot connect to it, you need to manually forward the port '''UDP 6000''' on your home router to '''your local IP address''' (the game has the auto port forwarding feature but it often fails due to the difference in UPnP implementation on many routers). E.g. if your PC's IP address in local network is 192.168.1.100 (you can check it with ipconfig tool or in Windows network adapter's settings) you will need to setup a port forward rule on your router to forward traffic from port 6000 UDP to port 6000 UDP on IP address 192.168.1.100.

'''If you're running a game server on the same PC as the game client:'''
 Please note that you might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its address as <code>localhost:6000</code> and connect to it directly.

'''If you're running a game server in the same local network as the game client (for example you want to play over LAN with your friends and family):'''
 You might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its local IP address (IPv4) and connect to it directly. To get your local IP address please use ipconfig command-line tool or check the network adapter properties in the network center. You need to get the local network IP address of the PC that is hosting the game server. Then add it in the custom servers list on your PC. You can lookup the IP address in the Windows network settings or by using CMD tool called ipconfig in Windows. For example, here we've run the ipconfig tool here and see the IPv4 address as 192.168.1.200 ([https://cdn.discordapp.com/attachments/421250395298332672/739147674367950908/Screenshot_at_19-48-06.png screenshot]). We can use it on any other PC in the local network to connect to that PC hosting the game server.

Connecting to the private servers requires adding it via the Custom servers menu.

6000 is the default port but you can change it in the Data/SettingsServer.xml file.

== Server update/upgrade to new version ==
When we're releasing a new version of the game server, you need to follow these steps to update it:
# (If you have not done this) Install ".NET Runtime" (version 5.0) https://dotnet.microsoft.com/download/dotnet/5.0/runtime
# Ensure you've made a '''backup''' of the "'''Data'''" folder inside the game server installation folder.
# If you're updating from A28 or earlier versions, DELETE "Data/Saves" folder as the savegame is not compatible (breaking changes). Update from A29 to R30 (and from R30 to its patch versions) '''doesn't require this step''' (savegame is compatible).
# Download the new version of the server and overwrite your current installation with it (you can find the actual download link above in the "Installation" section).
# Stop the game server (if it's running).
# Important: please '''overwrite''' both Binaries and Core folders!
# Start the server as usual.

== Server commands ==
# Ensure you're the server operator (you've edited the ServerSettings.xml file and added yourself into the server_operators_list).
# Connect to your game server.
# The game console can be toggled by pressing <code>~</code> (the key on the left from <code>1</code> key) like in old-school games (you can change the key binding for console in the controls options).
# Please add <code>/</code> (slash) prefix to the server commands you want to execute.
# You can use '''Tab''' key to fill autocomplete, and you can use '''arrow Up/Down keys''' to navigate the suggestions list. Press '''Tab''' or '''Enter''' to accept the suggestion.

Here is the page with the server commands list: [[CryoFall/Server/Commands|Server Commands List]]

== Moderation (whitelist, blacklist, kicking, muting) ==
Server operator can access special moderation commands. To invoke these commands, please ensure you're the server operator, connect to your game server, open the console (~ key) and then you can use these commands: (replace username with the actual player nickname)

Whitelist management:

<code>/mod.whiteList.add username</code>

<code>/mod.whiteList.remove username</code>

<code>/mod.whiteList.print</code>

To enable whitelist:

<code>/mod.whiteList.enabled 1</code>

Blacklist management:

<code>/mod.blackList.add username</code>

<code>/mod.blackList.remove username</code>

<code>/mod.blackList.print</code>

Kicking players (temporary removing from server and blocking from connecting):

<code>/mod.kickList.add username durationInMinutes</code>

<code>/mod.kickList.remove username</code>

<code>/mod.kickList.print</code>

Muting players (temporary removing their ability to send messages to chat):

<code>/mod.muteList.add username durationInMinutes</code>

<code>/mod.muteList.remove username</code>

<code>/mod.muteList.print</code>

== Server rates adjusting / Enabling PvP mode ==
Server rates (and PvP mode setting) are exposed in a separate config file. You can quickly change things like LP gain rate, increase item drops, reduce the player to player damage to zero, or even increase the damage from creatures and make it really tough for the players!

To adjust the server rates, stop the server and check the file <game server>/Data/ServerRates.config
Please read carefullyΓÇöall the rates are disabled and in order to apply them '''you need to remove the # char at the start of the line'''!

If you want to '''enable PvP''', search PvP in the file. By default, this setting's value is 0 and you need to change it to 1 and remove the # char at the start of the line.

For advanced modding please read [http://forums.atomictorch.com/index.php?topic=1027.0 modding prerequisites].

== Server raiding hours (for PvP) ==
'''(Please note: with A27 this feature is not recommend anymore as there is a better feature now ΓÇö S.H.I.E.L.D. protection that is enabled by default for PvP servers)'''

On PvP server, you could set up specific hours during which the raiding is possible.
 By default, offline raiding protection is not enabled so players could raid other players' bases at any time.
 To enable offline raiding protection, please use this in-game console command:
 <code>/admin.setRaidingWindow 4 14 1.5</code>
 In this code we're using (first number) +4 GMT/UTC timezone, (second number) hour of day when raiding is possible (value from 0 to 24), and (third number) is the duration of the raiding window (value from 0 to 24).
 So the code in the example will allow raiding from 14:00 (or 2PM) for 1.5 hours.
 After changing the value you could open Politics/Diplomacy menu ([P] key) and verify whether you set the correct numbers.
 Please note that Politics/Diplomacy menu displaying your local time (in your PC timezone)!

== How to prohibit client modifications ==
If you wish to restrict usage of any client modifications on your server, please find "<no_client_mods>" setting in the SettingsServer.xml file. Change the value from 0 to 1 to enable this feature. It's recommended for PvP servers to set it to 1. You can read more details about this feature in [https://atomictorch.com/Post/Id2218/A28-Justice-Update-Release A28 Update announcement].

CryoFall/Server/Setup

2021-05-07T03:31:03Z

Ai enabled: /* How to setup your own server (on any OS): */

= Local server / Singleplayer =
If you wish to play in singleplayer, you're just two clicks away from starting playing on your own local server!
 Local server is currently provided as an experimental feature. We've received plenty of players' feedback that it works rock-stable already!
 Please follow the [https://store.steampowered.com/news/app/829590/view/3034840264061004771 short guide here] on how to start the local game server!

= Using game server hosting providers =

==== Game server rent service ====
''If you don't want to hassle with the game server setup, you can rent your own CryoFall server from any third party game server hosting company in just a few minutes. They provide data center locations in almost every country around the world!''
* [https://pingperfect.com/gameservers/cryofall-game-server-hosting-rental.php?aff=586 PingPerfect]
* [https://gameserver.4players.de/server-hosting/cryofall-server-mieten/ 4PLAYERS] (the website is available in German only)
''Please note that AtomicTorch Studio is not affiliated with any of these companies and not responsible for their service quality so in case of any issues please reach them directly. So far we've heard only positive feedback about their services.''

= Self-hosting =

== Requirements ==
====Hardware requirements====
(for up to about 30 players online) 1-core CPU 1.6-2 GHz, 1.5 GB RAM, 2-3 Mbit/s bandwidth (each way)
 (for up to about 100 players online) 2-core CPU 1.6-2 GHz, 2 GB RAM, 3-6 Mbit/s bandwidth
 (for up to about 200 players online) 2-core CPU 2.4-3 GHz, 2 GB RAM, 6-12 Mbit/s bandwidth
 (for up to about 300 players online) 2-core CPU 3+ GHz, 2.5 GB RAM, 12-20 Mbit/s bandwidth
 Usually, VPS (virtual machines) hosting such as [https://www.vultr.com/?ref=7238385 Vultr.com] (this is our referral link as we're using this company services to host our own servers) is sufficient for hosting a game server. Using 1-core machines is not recommended as the game requires a secondary CPU to ensure smooth performance without hiccups during intensive background operations (such as world snapshot saving). Using more than a 2-core machine for a single game server hosting is redundant as the game cannot utilize more than two cores due to the sequential execution of the game simulation (except networking).

====Software (system) requirements====
The server could run on Windows, Linux, and Mac.
To achieve this the game server is using .NET Runtime 5.0.
For hosting the official game servers we prefer using CentOS 7 with Docker or CentOS 8 with podman (OSS alternative to Docker).

== Server installation with Docker (best way for Linux) ==
We recommend this for Linux only. Please follow this guide [https://hub.docker.com/r/atomictorch/cryofall-server CryoFall Dedicated Server Docker Image] then return back here to '''"Server installation"''' section and follow the list after number 7. Ignore instructions on how to start the server with "dotnet" as you should use "docker run ..." instead as explained in the Docker guide above.

== Server installation / direct download (Windows, Linux, Mac) ==

==== How to setup your own server (on any OS): ====
# Install .NET Runtime 5.0 x64ΓÇöplease visit [https://dotnet.microsoft.com/download/dotnet/5.0/runtime Download .NET page] and follow the installation guide for your OS.
# Download the game server package from '''[https://atomictorch.com/Files/CryoFall_Server_v1.30.6.8_NetCore.zip SERVER DOWNLOAD LINK (any OS)]'''.
# Extract the downloaded package (it's a regular ZIP archive).
# The server executable is located in the subfolder: "Binaries/Server". Open the command line/terminal/SSH (or PowerShell in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable first time with <code>loadOrNew</code> flag. The server will start and create the game world.
#:<code>dotnet CryoFall_Server.dll loadOrNew</code>
# Usually it takes about 1-2 minutes to create a new world (or load a savegame). After that the server will keep writing performance statistics information every 20 seconds among other information such as the spawn scripts reporting and network events.
# Stop the server. To do so enter the command below and press Enter key.
#:<code>stop 0</code>
#The server will save and quit. Now you have the "SettingsServer.xml" and "ModsConfig.xml" files.
# Now you need to navigate to the subfolder "Data" (in the root of the server folder, '''not''' in the "Binaries/Server") and modify "SettingsServer.xml" to set the unique server '''name''' and set other settings, etc (there are XML comments explaining every setting so it should be straightforward). ''Please note that you can (and should) edit '''Description''' and '''Welcome message''' from the '''CURRENT GAME''' menu right from the game after connecting to your server.''
# If you are interested in making your server visible in the community servers list make sure to edit <is_public_server> and change the value from 0 to 1. Also, please make sure your router is configured correctly (port forwarding) to enable other people to connect to your machine from outside. But ideally, you should use dedicated server hardware (VPS or VDS) to host public servers.
# While you're still editing "SettingsServer.xml" file, please find the value '''<server_operators_list>''' and change it to include '''your nickname'''! Otherwise, you will be unable to access your server console from the game and also you will be unable to edit the server's Description and Welcome message.
# If you want to have a custom server icon, please replace the ServerIcon.png file in the "Data" subfolder. The icon image file requirements: '''PNG24 format, 256x256 size, up to 100 KB'''.

'''Important (for Windows only):''' you need to allow the dotnet process in the Windows Firewall settingsΓÇöif the Firewall access request was not shown automatically by Windows you can add the <code>C:\Program Files\dotnet\dotnet.exe</code> file into Firewall whitelist. To do this, open Windows Start menu and search for "Allow an app through Windows Firewall" -> button "Allow another app".

==== Starting the server ====
# Launch the command line (we recommending '''PowerShell''' in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable with <code>load</code> flag.
#:<code>dotnet CryoFall_Server.dll load</code>
# Stop your server by typing command below and pressing Enter key (it will save the world before stopping).
#:<code>stop 60 The shutdown message text goes here</code>
(Where <code>60</code> is the shutdown delay (in seconds) so the connected players will have some time to find a safe location)

'''''Please note that typing this message is really hard as the console is updating regularly! The best way is to simply copy-paste from the text editor the whole command text into the game console window (hint: you can paste in PowerShell by simply pressing the right mouse button) and pressing Enter key.'''''

You can always wipe the world by launching the game with <code>new</code> flag:
:<code>dotnet CryoFall_Server.dll new</code>

Currently, we don't support the savegame migration between the major game versions (if there are changes to the game data serialization scheme). We plan to implement the proper data migration feature ASAP.

==== Connecting to the server ====
If you want to connect to your local game server, simply add SERVERS->Custom list as <code>localhost</code>

To connect to the public server you need to navigate to SERVERS->Community servers list (please note that this might not work if you host this server on the same PC as the client, read below).

If you're attempting to host your server on a home computer and other players cannot connect to it, you need to manually forward the port '''UDP 6000''' on your home router to '''your local IP address''' (the game has the auto port forwarding feature but it often fails due to the difference in UPnP implementation on many routers). E.g. if your PC's IP address in local network is 192.168.1.100 (you can check it with ipconfig tool or in Windows network adapter's settings) you will need to setup a port forward rule on your router to forward traffic from port 6000 UDP to port 6000 UDP on IP address 192.168.1.100.

'''If you're running a game server on the same PC as the game client:'''
 Please note that you might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its address as <code>localhost:6000</code> and connect to it directly.

'''If you're running a game server in the same local network as the game client (for example you want to play over LAN with your friends and family):'''
 You might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its local IP address (IPv4) and connect to it directly. To get your local IP address please use ipconfig command-line tool or check the network adapter properties in the network center. You need to get the local network IP address of the PC that is hosting the game server. Then add it in the custom servers list on your PC. You can lookup the IP address in the Windows network settings or by using CMD tool called ipconfig in Windows. For example, here we've run the ipconfig tool here and see the IPv4 address as 192.168.1.200 ([https://cdn.discordapp.com/attachments/421250395298332672/739147674367950908/Screenshot_at_19-48-06.png screenshot]). We can use it on any other PC in the local network to connect to that PC hosting the game server.

Connecting to the private servers requires adding it via the Custom servers menu.

6000 is the default port but you can change it in the Data/SettingsServer.xml file.

== Server update/upgrade to new version ==
When we're releasing a new version of the game server, you need to follow these steps to update it:
# (If you have not done this) Install ".NET Runtime" (version 5.0) https://dotnet.microsoft.com/download/dotnet/5.0/runtime
# Ensure you've made a '''backup''' of the "'''Data'''" folder inside the game server installation folder.
# If you're updating from A28 or earlier versions, DELETE "Data/Saves" folder as the savegame is not compatible (breaking changes). Update from A29 to any A30 (and A30 to its patch versions) '''doesn't require this step''' (savegame is compatible).
# Download the new version of the server and overwrite your current installation with it (you can find the actual download link above in the "Installation" section).
# Stop the game server (if it's running).
# Important: please '''overwrite''' both Binaries and Core folders!
# Start the server as usual.

== Server commands ==
# Ensure you're the server operator (you've edited the ServerSettings.xml file and added yourself into the server_operators_list).
# Connect to your game server.
# The game console can be toggled by pressing <code>~</code> (the key on the left from <code>1</code> key) like in old-school games (you can change the key binding for console in the controls options).
# Please add <code>/</code> (slash) prefix to the server commands you want to execute.
# You can use '''Tab''' key to fill autocomplete, and you can use '''arrow Up/Down keys''' to navigate the suggestions list. Press '''Tab''' or '''Enter''' to accept the suggestion.

Here is the page with the server commands list: [[CryoFall/Server/Commands|Server Commands List]]

== Moderation (whitelist, blacklist, kicking, muting) ==
Server operator can access special moderation commands. To invoke these commands, please ensure you're the server operator, connect to your game server, open the console (~ key) and then you can use these commands: (replace username with the actual player nickname)

Whitelist management:

<code>/mod.whiteList.add username</code>

<code>/mod.whiteList.remove username</code>

<code>/mod.whiteList.print</code>

To enable whitelist:

<code>/mod.whiteList.enabled 1</code>

Blacklist management:

<code>/mod.blackList.add username</code>

<code>/mod.blackList.remove username</code>

<code>/mod.blackList.print</code>

Kicking players (temporary removing from server and blocking from connecting):

<code>/mod.kickList.add username durationInMinutes</code>

<code>/mod.kickList.remove username</code>

<code>/mod.kickList.print</code>

Muting players (temporary removing their ability to send messages to chat):

<code>/mod.muteList.add username durationInMinutes</code>

<code>/mod.muteList.remove username</code>

<code>/mod.muteList.print</code>

== Server rates adjusting / Enabling PvP mode ==
Server rates (and PvP mode setting) are exposed in a separate config file. You can quickly change things like LP gain rate, increase item drops, reduce the player to player damage to zero, or even increase the damage from creatures and make it really tough for the players!

To adjust the server rates, stop the server and check the file <game server>/Data/ServerRates.config
Please read carefullyΓÇöall the rates are disabled and in order to apply them '''you need to remove the # char at the start of the line'''!

If you want to '''enable PvP''', search PvP in the file. By default, this setting's value is 0 and you need to change it to 1 and remove the # char at the start of the line.

For advanced modding please read [http://forums.atomictorch.com/index.php?topic=1027.0 modding prerequisites].

== Server raiding hours (for PvP) ==
'''(Please note: with A27 this feature is not recommend anymore as there is a better feature now ΓÇö S.H.I.E.L.D. protection that is enabled by default for PvP servers)'''

On PvP server, you could set up specific hours during which the raiding is possible.
 By default, offline raiding protection is not enabled so players could raid other players' bases at any time.
 To enable offline raiding protection, please use this in-game console command:
 <code>/admin.setRaidingWindow 4 14 1.5</code>
 In this code we're using (first number) +4 GMT/UTC timezone, (second number) hour of day when raiding is possible (value from 0 to 24), and (third number) is the duration of the raiding window (value from 0 to 24).
 So the code in the example will allow raiding from 14:00 (or 2PM) for 1.5 hours.
 After changing the value you could open Politics/Diplomacy menu ([P] key) and verify whether you set the correct numbers.
 Please note that Politics/Diplomacy menu displaying your local time (in your PC timezone)!

== How to prohibit client modifications ==
If you wish to restrict usage of any client modifications on your server, please find "<no_client_mods>" setting in the SettingsServer.xml file. Change the value from 0 to 1 to enable this feature. It's recommended for PvP servers to set it to 1. You can read more details about this feature in [https://atomictorch.com/Post/Id2218/A28-Justice-Update-Release A28 Update announcement].

CryoFall/Server/Setup

2021-05-06T14:36:55Z

Ai enabled: /* How to setup your own server (on any OS): */

= Local server / Singleplayer =
If you wish to play in singleplayer, you're just two clicks away from starting playing on your own local server!
 Local server is currently provided as an experimental feature. We've received plenty of players' feedback that it works rock-stable already!
 Please follow the [https://store.steampowered.com/news/app/829590/view/3034840264061004771 short guide here] on how to start the local game server!

= Using game server hosting providers =

==== Game server rent service ====
''If you don't want to hassle with the game server setup, you can rent your own CryoFall server from any third party game server hosting company in just a few minutes. They provide data center locations in almost every country around the world!''
* [https://pingperfect.com/gameservers/cryofall-game-server-hosting-rental.php?aff=586 PingPerfect]
* [https://gameserver.4players.de/server-hosting/cryofall-server-mieten/ 4PLAYERS] (the website is available in German only)
''Please note that AtomicTorch Studio is not affiliated with any of these companies and not responsible for their service quality so in case of any issues please reach them directly. So far we've heard only positive feedback about their services.''

= Self-hosting =

== Requirements ==
====Hardware requirements====
(for up to about 30 players online) 1-core CPU 1.6-2 GHz, 1.5 GB RAM, 2-3 Mbit/s bandwidth (each way)
 (for up to about 100 players online) 2-core CPU 1.6-2 GHz, 2 GB RAM, 3-6 Mbit/s bandwidth
 (for up to about 200 players online) 2-core CPU 2.4-3 GHz, 2 GB RAM, 6-12 Mbit/s bandwidth
 (for up to about 300 players online) 2-core CPU 3+ GHz, 2.5 GB RAM, 12-20 Mbit/s bandwidth
 Usually, VPS (virtual machines) hosting such as [https://www.vultr.com/?ref=7238385 Vultr.com] (this is our referral link as we're using this company services to host our own servers) is sufficient for hosting a game server. Using 1-core machines is not recommended as the game requires a secondary CPU to ensure smooth performance without hiccups during intensive background operations (such as world snapshot saving). Using more than a 2-core machine for a single game server hosting is redundant as the game cannot utilize more than two cores due to the sequential execution of the game simulation (except networking).

====Software (system) requirements====
The server could run on Windows, Linux, and Mac.
To achieve this the game server is using .NET Runtime 5.0.
For hosting the official game servers we prefer using CentOS 7 with Docker or CentOS 8 with podman (OSS alternative to Docker).

== Server installation with Docker (best way for Linux) ==
We recommend this for Linux only. Please follow this guide [https://hub.docker.com/r/atomictorch/cryofall-server CryoFall Dedicated Server Docker Image] then return back here to '''"Server installation"''' section and follow the list after number 7. Ignore instructions on how to start the server with "dotnet" as you should use "docker run ..." instead as explained in the Docker guide above.

== Server installation / direct download (Windows, Linux, Mac) ==

==== How to setup your own server (on any OS): ====
# Install .NET Runtime 5.0 x64ΓÇöplease visit [https://dotnet.microsoft.com/download/dotnet/5.0/runtime Download .NET page] and follow the installation guide for your OS.
# Download the game server package from '''[https://atomictorch.com/Files/CryoFall_Server_v1.30.6.3_NetCore.zip SERVER DOWNLOAD LINK (any OS)]'''.
# Extract the downloaded package (it's a regular ZIP archive).
# The server executable is located in the subfolder: "Binaries/Server". Open the command line/terminal/SSH (or PowerShell in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable first time with <code>loadOrNew</code> flag. The server will start and create the game world.
#:<code>dotnet CryoFall_Server.dll loadOrNew</code>
# Usually it takes about 1-2 minutes to create a new world (or load a savegame). After that the server will keep writing performance statistics information every 20 seconds among other information such as the spawn scripts reporting and network events.
# Stop the server. To do so enter the command below and press Enter key.
#:<code>stop 0</code>
#The server will save and quit. Now you have the "SettingsServer.xml" and "ModsConfig.xml" files.
# Now you need to navigate to the subfolder "Data" (in the root of the server folder, '''not''' in the "Binaries/Server") and modify "SettingsServer.xml" to set the unique server '''name''' and set other settings, etc (there are XML comments explaining every setting so it should be straightforward). ''Please note that you can (and should) edit '''Description''' and '''Welcome message''' from the '''CURRENT GAME''' menu right from the game after connecting to your server.''
# If you are interested in making your server visible in the community servers list make sure to edit <is_public_server> and change the value from 0 to 1. Also, please make sure your router is configured correctly (port forwarding) to enable other people to connect to your machine from outside. But ideally, you should use dedicated server hardware (VPS or VDS) to host public servers.
# While you're still editing "SettingsServer.xml" file, please find the value '''<server_operators_list>''' and change it to include '''your nickname'''! Otherwise, you will be unable to access your server console from the game and also you will be unable to edit the server's Description and Welcome message.
# If you want to have a custom server icon, please replace the ServerIcon.png file in the "Data" subfolder. The icon image file requirements: '''PNG24 format, 256x256 size, up to 100 KB'''.

'''Important (for Windows only):''' you need to allow the dotnet process in the Windows Firewall settingsΓÇöif the Firewall access request was not shown automatically by Windows you can add the <code>C:\Program Files\dotnet\dotnet.exe</code> file into Firewall whitelist. To do this, open Windows Start menu and search for "Allow an app through Windows Firewall" -> button "Allow another app".

==== Starting the server ====
# Launch the command line (we recommending '''PowerShell''' in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable with <code>load</code> flag.
#:<code>dotnet CryoFall_Server.dll load</code>
# Stop your server by typing command below and pressing Enter key (it will save the world before stopping).
#:<code>stop 60 The shutdown message text goes here</code>
(Where <code>60</code> is the shutdown delay (in seconds) so the connected players will have some time to find a safe location)

'''''Please note that typing this message is really hard as the console is updating regularly! The best way is to simply copy-paste from the text editor the whole command text into the game console window (hint: you can paste in PowerShell by simply pressing the right mouse button) and pressing Enter key.'''''

You can always wipe the world by launching the game with <code>new</code> flag:
:<code>dotnet CryoFall_Server.dll new</code>

Currently, we don't support the savegame migration between the major game versions (if there are changes to the game data serialization scheme). We plan to implement the proper data migration feature ASAP.

==== Connecting to the server ====
If you want to connect to your local game server, simply add SERVERS->Custom list as <code>localhost</code>

To connect to the public server you need to navigate to SERVERS->Community servers list (please note that this might not work if you host this server on the same PC as the client, read below).

If you're attempting to host your server on a home computer and other players cannot connect to it, you need to manually forward the port '''UDP 6000''' on your home router to '''your local IP address''' (the game has the auto port forwarding feature but it often fails due to the difference in UPnP implementation on many routers). E.g. if your PC's IP address in local network is 192.168.1.100 (you can check it with ipconfig tool or in Windows network adapter's settings) you will need to setup a port forward rule on your router to forward traffic from port 6000 UDP to port 6000 UDP on IP address 192.168.1.100.

'''If you're running a game server on the same PC as the game client:'''
 Please note that you might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its address as <code>localhost:6000</code> and connect to it directly.

'''If you're running a game server in the same local network as the game client (for example you want to play over LAN with your friends and family):'''
 You might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its local IP address (IPv4) and connect to it directly. To get your local IP address please use ipconfig command-line tool or check the network adapter properties in the network center. You need to get the local network IP address of the PC that is hosting the game server. Then add it in the custom servers list on your PC. You can lookup the IP address in the Windows network settings or by using CMD tool called ipconfig in Windows. For example, here we've run the ipconfig tool here and see the IPv4 address as 192.168.1.200 ([https://cdn.discordapp.com/attachments/421250395298332672/739147674367950908/Screenshot_at_19-48-06.png screenshot]). We can use it on any other PC in the local network to connect to that PC hosting the game server.

Connecting to the private servers requires adding it via the Custom servers menu.

6000 is the default port but you can change it in the Data/SettingsServer.xml file.

== Server update/upgrade to new version ==
When we're releasing a new version of the game server, you need to follow these steps to update it:
# (If you have not done this) Install ".NET Runtime" (version 5.0) https://dotnet.microsoft.com/download/dotnet/5.0/runtime
# Ensure you've made a '''backup''' of the "'''Data'''" folder inside the game server installation folder.
# If you're updating from A28 or earlier versions, DELETE "Data/Saves" folder as the savegame is not compatible (breaking changes). Update from A29 to any A30 (and A30 to its patch versions) '''doesn't require this step''' (savegame is compatible).
# Download the new version of the server and overwrite your current installation with it (you can find the actual download link above in the "Installation" section).
# Stop the game server (if it's running).
# Important: please '''overwrite''' both Binaries and Core folders!
# Start the server as usual.

== Server commands ==
# Ensure you're the server operator (you've edited the ServerSettings.xml file and added yourself into the server_operators_list).
# Connect to your game server.
# The game console can be toggled by pressing <code>~</code> (the key on the left from <code>1</code> key) like in old-school games (you can change the key binding for console in the controls options).
# Please add <code>/</code> (slash) prefix to the server commands you want to execute.
# You can use '''Tab''' key to fill autocomplete, and you can use '''arrow Up/Down keys''' to navigate the suggestions list. Press '''Tab''' or '''Enter''' to accept the suggestion.

Here is the page with the server commands list: [[CryoFall/Server/Commands|Server Commands List]]

== Moderation (whitelist, blacklist, kicking, muting) ==
Server operator can access special moderation commands. To invoke these commands, please ensure you're the server operator, connect to your game server, open the console (~ key) and then you can use these commands: (replace username with the actual player nickname)

Whitelist management:

<code>/mod.whiteList.add username</code>

<code>/mod.whiteList.remove username</code>

<code>/mod.whiteList.print</code>

To enable whitelist:

<code>/mod.whiteList.enabled 1</code>

Blacklist management:

<code>/mod.blackList.add username</code>

<code>/mod.blackList.remove username</code>

<code>/mod.blackList.print</code>

Kicking players (temporary removing from server and blocking from connecting):

<code>/mod.kickList.add username durationInMinutes</code>

<code>/mod.kickList.remove username</code>

<code>/mod.kickList.print</code>

Muting players (temporary removing their ability to send messages to chat):

<code>/mod.muteList.add username durationInMinutes</code>

<code>/mod.muteList.remove username</code>

<code>/mod.muteList.print</code>

== Server rates adjusting / Enabling PvP mode ==
Server rates (and PvP mode setting) are exposed in a separate config file. You can quickly change things like LP gain rate, increase item drops, reduce the player to player damage to zero, or even increase the damage from creatures and make it really tough for the players!

To adjust the server rates, stop the server and check the file <game server>/Data/ServerRates.config
Please read carefullyΓÇöall the rates are disabled and in order to apply them '''you need to remove the # char at the start of the line'''!

If you want to '''enable PvP''', search PvP in the file. By default, this setting's value is 0 and you need to change it to 1 and remove the # char at the start of the line.

For advanced modding please read [http://forums.atomictorch.com/index.php?topic=1027.0 modding prerequisites].

== Server raiding hours (for PvP) ==
'''(Please note: with A27 this feature is not recommend anymore as there is a better feature now ΓÇö S.H.I.E.L.D. protection that is enabled by default for PvP servers)'''

On PvP server, you could set up specific hours during which the raiding is possible.
 By default, offline raiding protection is not enabled so players could raid other players' bases at any time.
 To enable offline raiding protection, please use this in-game console command:
 <code>/admin.setRaidingWindow 4 14 1.5</code>
 In this code we're using (first number) +4 GMT/UTC timezone, (second number) hour of day when raiding is possible (value from 0 to 24), and (third number) is the duration of the raiding window (value from 0 to 24).
 So the code in the example will allow raiding from 14:00 (or 2PM) for 1.5 hours.
 After changing the value you could open Politics/Diplomacy menu ([P] key) and verify whether you set the correct numbers.
 Please note that Politics/Diplomacy menu displaying your local time (in your PC timezone)!

== How to prohibit client modifications ==
If you wish to restrict usage of any client modifications on your server, please find "<no_client_mods>" setting in the SettingsServer.xml file. Change the value from 0 to 1 to enable this feature. It's recommended for PvP servers to set it to 1. You can read more details about this feature in [https://atomictorch.com/Post/Id2218/A28-Justice-Update-Release A28 Update announcement].

CryoFall/Server/Setup

2021-05-01T16:32:33Z

Ai enabled: /* Local server / Singleplayer */

= Local server / Singleplayer =
If you wish to play in singleplayer, you're just two clicks away from starting playing on your own local server!
 Local server is currently provided as an experimental feature. We've received plenty of players' feedback that it works rock-stable already!
 Please follow the [https://store.steampowered.com/news/app/829590/view/3034840264061004771 short guide here] on how to start the local game server!

= Using game server hosting providers =

==== Game server rent service ====
''If you don't want to hassle with the game server setup, you can rent your own CryoFall server from any third party game server hosting company in just a few minutes. They provide data center locations in almost every country around the world!''
* [https://pingperfect.com/gameservers/cryofall-game-server-hosting-rental.php?aff=586 PingPerfect]
* [https://gameserver.4players.de/server-hosting/cryofall-server-mieten/ 4PLAYERS] (the website is available in German only)
''Please note that AtomicTorch Studio is not affiliated with any of these companies and not responsible for their service quality so in case of any issues please reach them directly. So far we've heard only positive feedback about their services.''

= Self-hosting =

== Requirements ==
====Hardware requirements====
(for up to about 30 players online) 1-core CPU 1.6-2 GHz, 1.5 GB RAM, 2-3 Mbit/s bandwidth (each way)
 (for up to about 100 players online) 2-core CPU 1.6-2 GHz, 2 GB RAM, 3-6 Mbit/s bandwidth
 (for up to about 200 players online) 2-core CPU 2.4-3 GHz, 2 GB RAM, 6-12 Mbit/s bandwidth
 (for up to about 300 players online) 2-core CPU 3+ GHz, 2.5 GB RAM, 12-20 Mbit/s bandwidth
 Usually, VPS (virtual machines) hosting such as [https://www.vultr.com/?ref=7238385 Vultr.com] (this is our referral link as we're using this company services to host our own servers) is sufficient for hosting a game server. Using 1-core machines is not recommended as the game requires a secondary CPU to ensure smooth performance without hiccups during intensive background operations (such as world snapshot saving). Using more than a 2-core machine for a single game server hosting is redundant as the game cannot utilize more than two cores due to the sequential execution of the game simulation (except networking).

====Software (system) requirements====
The server could run on Windows, Linux, and Mac.
To achieve this the game server is using .NET Runtime 5.0.
For hosting the official game servers we prefer using CentOS 7 with Docker or CentOS 8 with podman (OSS alternative to Docker).

== Server installation with Docker (best way for Linux) ==
We recommend this for Linux only. Please follow this guide [https://hub.docker.com/r/atomictorch/cryofall-server CryoFall Dedicated Server Docker Image] then return back here to '''"Server installation"''' section and follow the list after number 7. Ignore instructions on how to start the server with "dotnet" as you should use "docker run ..." instead as explained in the Docker guide above.

== Server installation / direct download (Windows, Linux, Mac) ==

==== How to setup your own server (on any OS): ====
# Install .NET Runtime 5.0 x64ΓÇöplease visit [https://dotnet.microsoft.com/download/dotnet/5.0/runtime Download .NET page] and follow the installation guide for your OS.
# Download the game server package from '''[https://atomictorch.com/Files/CryoFall_Server_v1.30.6.3_NetCore.zip SERVER DOWNLOAD LINK (any OS)]''' and extract it (it's a regular Zip archive). (on Linux you can use wget and unzip command line tools to download and extract it)
# The server package is including everything necessary to run the game server (not only executable but also "Core" folder containing the game scripts in a packaged zip archive named "Core.cpk").
# The server executable is located in the subfolder: "Binaries/Server". Open the command line/terminal/SSH (or PowerShell in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable first time with <code>loadOrNew</code> flag. The server will start and create the game world.
#:<code>dotnet CryoFall_Server.dll loadOrNew</code>
# Usually it takes about 1-2 minutes to create a new world (or load a savegame). After that the server will keep writing performance statistics information every 20 seconds among other information such as the spawn scripts reporting and network events.
# Stop the server. To do so enter the command below and press Enter key.
#:<code>stop 0</code>
#The server will save and quit. Now you have the "SettingsServer.xml" and "ModsConfig.xml" files.
# Now you need to navigate to the subfolder "Data" (in the root of the server folder, '''not''' in the "Binaries/Server") and modify "SettingsServer.xml" to set the unique server '''name''' and set other settings, etc (there are XML comments explaining every setting so it should be straightforward). ''Please note that you can (and should) edit '''Description''' and '''Welcome message''' from the '''CURRENT GAME''' menu right from the game after connecting to your server.''
# If you are interested in making your server visible in the community servers list make sure to edit <is_public_server> and change the value from 0 to 1. Also, please make sure your router is configured correctly (port forwarding) to enable other people to connect to your machine from outside. But ideally, you should use dedicated server hardware (VPS or VDS) to host public servers.
# While you're still editing "SettingsServer.xml" file, please find the value '''<server_operators_list>''' and change it to include '''your nickname'''! Otherwise, you will be unable to access your server console from the game and also you will be unable to edit the server's Description and Welcome message.
# If you want to have a custom server icon, please replace the ServerIcon.png file in the "Data" subfolder. The icon image file requirements: '''PNG24 format, 256x256 size, up to 100 KB'''.

'''Important (for Windows only):''' you need to allow the dotnet process in the Windows Firewall settingsΓÇöif the Firewall access request was not shown automatically by Windows you can add the <code>C:\Program Files\dotnet\dotnet.exe</code> file into Firewall whitelist. To do this, open Windows Start menu and search for "Allow an app through Windows Firewall" -> button "Allow another app".

==== Starting the server ====
# Launch the command line (we recommending '''PowerShell''' in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable with <code>load</code> flag.
#:<code>dotnet CryoFall_Server.dll load</code>
# Stop your server by typing command below and pressing Enter key (it will save the world before stopping).
#:<code>stop 60 The shutdown message text goes here</code>
(Where <code>60</code> is the shutdown delay (in seconds) so the connected players will have some time to find a safe location)

'''''Please note that typing this message is really hard as the console is updating regularly! The best way is to simply copy-paste from the text editor the whole command text into the game console window (hint: you can paste in PowerShell by simply pressing the right mouse button) and pressing Enter key.'''''

You can always wipe the world by launching the game with <code>new</code> flag:
:<code>dotnet CryoFall_Server.dll new</code>

Currently, we don't support the savegame migration between the major game versions (if there are changes to the game data serialization scheme). We plan to implement the proper data migration feature ASAP.

==== Connecting to the server ====
If you want to connect to your local game server, simply add SERVERS->Custom list as <code>localhost</code>

To connect to the public server you need to navigate to SERVERS->Community servers list (please note that this might not work if you host this server on the same PC as the client, read below).

If you're attempting to host your server on a home computer and other players cannot connect to it, you need to manually forward the port '''UDP 6000''' on your home router to '''your local IP address''' (the game has the auto port forwarding feature but it often fails due to the difference in UPnP implementation on many routers). E.g. if your PC's IP address in local network is 192.168.1.100 (you can check it with ipconfig tool or in Windows network adapter's settings) you will need to setup a port forward rule on your router to forward traffic from port 6000 UDP to port 6000 UDP on IP address 192.168.1.100.

'''If you're running a game server on the same PC as the game client:'''
 Please note that you might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its address as <code>localhost:6000</code> and connect to it directly.

'''If you're running a game server in the same local network as the game client (for example you want to play over LAN with your friends and family):'''
 You might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its local IP address (IPv4) and connect to it directly. To get your local IP address please use ipconfig command-line tool or check the network adapter properties in the network center. You need to get the local network IP address of the PC that is hosting the game server. Then add it in the custom servers list on your PC. You can lookup the IP address in the Windows network settings or by using CMD tool called ipconfig in Windows. For example, here we've run the ipconfig tool here and see the IPv4 address as 192.168.1.200 ([https://cdn.discordapp.com/attachments/421250395298332672/739147674367950908/Screenshot_at_19-48-06.png screenshot]). We can use it on any other PC in the local network to connect to that PC hosting the game server.

Connecting to the private servers requires adding it via the Custom servers menu.

6000 is the default port but you can change it in the Data/SettingsServer.xml file.

== Server update/upgrade to new version ==
When we're releasing a new version of the game server, you need to follow these steps to update it:
# (If you have not done this) Install ".NET Runtime" (version 5.0) https://dotnet.microsoft.com/download/dotnet/5.0/runtime
# Ensure you've made a '''backup''' of the "'''Data'''" folder inside the game server installation folder.
# If you're updating from A28 or earlier versions, DELETE "Data/Saves" folder as the savegame is not compatible (breaking changes). Update from A29 to any A30 (and A30 to its patch versions) '''doesn't require this step''' (savegame is compatible).
# Download the new version of the server and overwrite your current installation with it (you can find the actual download link above in the "Installation" section).
# Stop the game server (if it's running).
# Important: please '''overwrite''' both Binaries and Core folders!
# Start the server as usual.

== Server commands ==
# Ensure you're the server operator (you've edited the ServerSettings.xml file and added yourself into the server_operators_list).
# Connect to your game server.
# The game console can be toggled by pressing <code>~</code> (the key on the left from <code>1</code> key) like in old-school games (you can change the key binding for console in the controls options).
# Please add <code>/</code> (slash) prefix to the server commands you want to execute.
# You can use '''Tab''' key to fill autocomplete, and you can use '''arrow Up/Down keys''' to navigate the suggestions list. Press '''Tab''' or '''Enter''' to accept the suggestion.

Here is the page with the server commands list: [[CryoFall/Server/Commands|Server Commands List]]

== Moderation (whitelist, blacklist, kicking, muting) ==
Server operator can access special moderation commands. To invoke these commands, please ensure you're the server operator, connect to your game server, open the console (~ key) and then you can use these commands: (replace username with the actual player nickname)

Whitelist management:

<code>/mod.whiteList.add username</code>

<code>/mod.whiteList.remove username</code>

<code>/mod.whiteList.print</code>

To enable whitelist:

<code>/mod.whiteList.enabled 1</code>

Blacklist management:

<code>/mod.blackList.add username</code>

<code>/mod.blackList.remove username</code>

<code>/mod.blackList.print</code>

Kicking players (temporary removing from server and blocking from connecting):

<code>/mod.kickList.add username durationInMinutes</code>

<code>/mod.kickList.remove username</code>

<code>/mod.kickList.print</code>

Muting players (temporary removing their ability to send messages to chat):

<code>/mod.muteList.add username durationInMinutes</code>

<code>/mod.muteList.remove username</code>

<code>/mod.muteList.print</code>

== Server rates adjusting / Enabling PvP mode ==
Server rates (and PvP mode setting) are exposed in a separate config file. You can quickly change things like LP gain rate, increase item drops, reduce the player to player damage to zero, or even increase the damage from creatures and make it really tough for the players!

To adjust the server rates, stop the server and check the file <game server>/Data/ServerRates.config
Please read carefullyΓÇöall the rates are disabled and in order to apply them '''you need to remove the # char at the start of the line'''!

If you want to '''enable PvP''', search PvP in the file. By default, this setting's value is 0 and you need to change it to 1 and remove the # char at the start of the line.

For advanced modding please read [http://forums.atomictorch.com/index.php?topic=1027.0 modding prerequisites].

== Server raiding hours (for PvP) ==
'''(Please note: with A27 this feature is not recommend anymore as there is a better feature now ΓÇö S.H.I.E.L.D. protection that is enabled by default for PvP servers)'''

On PvP server, you could set up specific hours during which the raiding is possible.
 By default, offline raiding protection is not enabled so players could raid other players' bases at any time.
 To enable offline raiding protection, please use this in-game console command:
 <code>/admin.setRaidingWindow 4 14 1.5</code>
 In this code we're using (first number) +4 GMT/UTC timezone, (second number) hour of day when raiding is possible (value from 0 to 24), and (third number) is the duration of the raiding window (value from 0 to 24).
 So the code in the example will allow raiding from 14:00 (or 2PM) for 1.5 hours.
 After changing the value you could open Politics/Diplomacy menu ([P] key) and verify whether you set the correct numbers.
 Please note that Politics/Diplomacy menu displaying your local time (in your PC timezone)!

== How to prohibit client modifications ==
If you wish to restrict usage of any client modifications on your server, please find "<no_client_mods>" setting in the SettingsServer.xml file. Change the value from 0 to 1 to enable this feature. It's recommended for PvP servers to set it to 1. You can read more details about this feature in [https://atomictorch.com/Post/Id2218/A28-Justice-Update-Release A28 Update announcement].

CryoFall/Server/Setup

2021-05-01T16:32:16Z

Ai enabled: /* Local game server */

= Local server / Singleplayer =
If you wish to play in singleplayer, you're just two clicks away from starting playing on your own local server!
Local server is currently provided as an experimental feature. We've received plenty of players' feedback that it works rock-stable already!
Please follow the [https://store.steampowered.com/news/app/829590/view/3034840264061004771 short guide here] on how to start the local game server!

= Using game server hosting providers =

==== Game server rent service ====
''If you don't want to hassle with the game server setup, you can rent your own CryoFall server from any third party game server hosting company in just a few minutes. They provide data center locations in almost every country around the world!''
* [https://pingperfect.com/gameservers/cryofall-game-server-hosting-rental.php?aff=586 PingPerfect]
* [https://gameserver.4players.de/server-hosting/cryofall-server-mieten/ 4PLAYERS] (the website is available in German only)
''Please note that AtomicTorch Studio is not affiliated with any of these companies and not responsible for their service quality so in case of any issues please reach them directly. So far we've heard only positive feedback about their services.''

= Self-hosting =

== Requirements ==
====Hardware requirements====
(for up to about 30 players online) 1-core CPU 1.6-2 GHz, 1.5 GB RAM, 2-3 Mbit/s bandwidth (each way)
 (for up to about 100 players online) 2-core CPU 1.6-2 GHz, 2 GB RAM, 3-6 Mbit/s bandwidth
 (for up to about 200 players online) 2-core CPU 2.4-3 GHz, 2 GB RAM, 6-12 Mbit/s bandwidth
 (for up to about 300 players online) 2-core CPU 3+ GHz, 2.5 GB RAM, 12-20 Mbit/s bandwidth
 Usually, VPS (virtual machines) hosting such as [https://www.vultr.com/?ref=7238385 Vultr.com] (this is our referral link as we're using this company services to host our own servers) is sufficient for hosting a game server. Using 1-core machines is not recommended as the game requires a secondary CPU to ensure smooth performance without hiccups during intensive background operations (such as world snapshot saving). Using more than a 2-core machine for a single game server hosting is redundant as the game cannot utilize more than two cores due to the sequential execution of the game simulation (except networking).

====Software (system) requirements====
The server could run on Windows, Linux, and Mac.
To achieve this the game server is using .NET Runtime 5.0.
For hosting the official game servers we prefer using CentOS 7 with Docker or CentOS 8 with podman (OSS alternative to Docker).

== Server installation with Docker (best way for Linux) ==
We recommend this for Linux only. Please follow this guide [https://hub.docker.com/r/atomictorch/cryofall-server CryoFall Dedicated Server Docker Image] then return back here to '''"Server installation"''' section and follow the list after number 7. Ignore instructions on how to start the server with "dotnet" as you should use "docker run ..." instead as explained in the Docker guide above.

== Server installation / direct download (Windows, Linux, Mac) ==

==== How to setup your own server (on any OS): ====
# Install .NET Runtime 5.0 x64ΓÇöplease visit [https://dotnet.microsoft.com/download/dotnet/5.0/runtime Download .NET page] and follow the installation guide for your OS.
# Download the game server package from '''[https://atomictorch.com/Files/CryoFall_Server_v1.30.6.3_NetCore.zip SERVER DOWNLOAD LINK (any OS)]''' and extract it (it's a regular Zip archive). (on Linux you can use wget and unzip command line tools to download and extract it)
# The server package is including everything necessary to run the game server (not only executable but also "Core" folder containing the game scripts in a packaged zip archive named "Core.cpk").
# The server executable is located in the subfolder: "Binaries/Server". Open the command line/terminal/SSH (or PowerShell in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable first time with <code>loadOrNew</code> flag. The server will start and create the game world.
#:<code>dotnet CryoFall_Server.dll loadOrNew</code>
# Usually it takes about 1-2 minutes to create a new world (or load a savegame). After that the server will keep writing performance statistics information every 20 seconds among other information such as the spawn scripts reporting and network events.
# Stop the server. To do so enter the command below and press Enter key.
#:<code>stop 0</code>
#The server will save and quit. Now you have the "SettingsServer.xml" and "ModsConfig.xml" files.
# Now you need to navigate to the subfolder "Data" (in the root of the server folder, '''not''' in the "Binaries/Server") and modify "SettingsServer.xml" to set the unique server '''name''' and set other settings, etc (there are XML comments explaining every setting so it should be straightforward). ''Please note that you can (and should) edit '''Description''' and '''Welcome message''' from the '''CURRENT GAME''' menu right from the game after connecting to your server.''
# If you are interested in making your server visible in the community servers list make sure to edit <is_public_server> and change the value from 0 to 1. Also, please make sure your router is configured correctly (port forwarding) to enable other people to connect to your machine from outside. But ideally, you should use dedicated server hardware (VPS or VDS) to host public servers.
# While you're still editing "SettingsServer.xml" file, please find the value '''<server_operators_list>''' and change it to include '''your nickname'''! Otherwise, you will be unable to access your server console from the game and also you will be unable to edit the server's Description and Welcome message.
# If you want to have a custom server icon, please replace the ServerIcon.png file in the "Data" subfolder. The icon image file requirements: '''PNG24 format, 256x256 size, up to 100 KB'''.

'''Important (for Windows only):''' you need to allow the dotnet process in the Windows Firewall settingsΓÇöif the Firewall access request was not shown automatically by Windows you can add the <code>C:\Program Files\dotnet\dotnet.exe</code> file into Firewall whitelist. To do this, open Windows Start menu and search for "Allow an app through Windows Firewall" -> button "Allow another app".

==== Starting the server ====
# Launch the command line (we recommending '''PowerShell''' in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable with <code>load</code> flag.
#:<code>dotnet CryoFall_Server.dll load</code>
# Stop your server by typing command below and pressing Enter key (it will save the world before stopping).
#:<code>stop 60 The shutdown message text goes here</code>
(Where <code>60</code> is the shutdown delay (in seconds) so the connected players will have some time to find a safe location)

'''''Please note that typing this message is really hard as the console is updating regularly! The best way is to simply copy-paste from the text editor the whole command text into the game console window (hint: you can paste in PowerShell by simply pressing the right mouse button) and pressing Enter key.'''''

You can always wipe the world by launching the game with <code>new</code> flag:
:<code>dotnet CryoFall_Server.dll new</code>

Currently, we don't support the savegame migration between the major game versions (if there are changes to the game data serialization scheme). We plan to implement the proper data migration feature ASAP.

==== Connecting to the server ====
If you want to connect to your local game server, simply add SERVERS->Custom list as <code>localhost</code>

To connect to the public server you need to navigate to SERVERS->Community servers list (please note that this might not work if you host this server on the same PC as the client, read below).

If you're attempting to host your server on a home computer and other players cannot connect to it, you need to manually forward the port '''UDP 6000''' on your home router to '''your local IP address''' (the game has the auto port forwarding feature but it often fails due to the difference in UPnP implementation on many routers). E.g. if your PC's IP address in local network is 192.168.1.100 (you can check it with ipconfig tool or in Windows network adapter's settings) you will need to setup a port forward rule on your router to forward traffic from port 6000 UDP to port 6000 UDP on IP address 192.168.1.100.

'''If you're running a game server on the same PC as the game client:'''
 Please note that you might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its address as <code>localhost:6000</code> and connect to it directly.

'''If you're running a game server in the same local network as the game client (for example you want to play over LAN with your friends and family):'''
 You might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its local IP address (IPv4) and connect to it directly. To get your local IP address please use ipconfig command-line tool or check the network adapter properties in the network center. You need to get the local network IP address of the PC that is hosting the game server. Then add it in the custom servers list on your PC. You can lookup the IP address in the Windows network settings or by using CMD tool called ipconfig in Windows. For example, here we've run the ipconfig tool here and see the IPv4 address as 192.168.1.200 ([https://cdn.discordapp.com/attachments/421250395298332672/739147674367950908/Screenshot_at_19-48-06.png screenshot]). We can use it on any other PC in the local network to connect to that PC hosting the game server.

Connecting to the private servers requires adding it via the Custom servers menu.

6000 is the default port but you can change it in the Data/SettingsServer.xml file.

== Server update/upgrade to new version ==
When we're releasing a new version of the game server, you need to follow these steps to update it:
# (If you have not done this) Install ".NET Runtime" (version 5.0) https://dotnet.microsoft.com/download/dotnet/5.0/runtime
# Ensure you've made a '''backup''' of the "'''Data'''" folder inside the game server installation folder.
# If you're updating from A28 or earlier versions, DELETE "Data/Saves" folder as the savegame is not compatible (breaking changes). Update from A29 to any A30 (and A30 to its patch versions) '''doesn't require this step''' (savegame is compatible).
# Download the new version of the server and overwrite your current installation with it (you can find the actual download link above in the "Installation" section).
# Stop the game server (if it's running).
# Important: please '''overwrite''' both Binaries and Core folders!
# Start the server as usual.

== Server commands ==
# Ensure you're the server operator (you've edited the ServerSettings.xml file and added yourself into the server_operators_list).
# Connect to your game server.
# The game console can be toggled by pressing <code>~</code> (the key on the left from <code>1</code> key) like in old-school games (you can change the key binding for console in the controls options).
# Please add <code>/</code> (slash) prefix to the server commands you want to execute.
# You can use '''Tab''' key to fill autocomplete, and you can use '''arrow Up/Down keys''' to navigate the suggestions list. Press '''Tab''' or '''Enter''' to accept the suggestion.

Here is the page with the server commands list: [[CryoFall/Server/Commands|Server Commands List]]

== Moderation (whitelist, blacklist, kicking, muting) ==
Server operator can access special moderation commands. To invoke these commands, please ensure you're the server operator, connect to your game server, open the console (~ key) and then you can use these commands: (replace username with the actual player nickname)

Whitelist management:

<code>/mod.whiteList.add username</code>

<code>/mod.whiteList.remove username</code>

<code>/mod.whiteList.print</code>

To enable whitelist:

<code>/mod.whiteList.enabled 1</code>

Blacklist management:

<code>/mod.blackList.add username</code>

<code>/mod.blackList.remove username</code>

<code>/mod.blackList.print</code>

Kicking players (temporary removing from server and blocking from connecting):

<code>/mod.kickList.add username durationInMinutes</code>

<code>/mod.kickList.remove username</code>

<code>/mod.kickList.print</code>

Muting players (temporary removing their ability to send messages to chat):

<code>/mod.muteList.add username durationInMinutes</code>

<code>/mod.muteList.remove username</code>

<code>/mod.muteList.print</code>

== Server rates adjusting / Enabling PvP mode ==
Server rates (and PvP mode setting) are exposed in a separate config file. You can quickly change things like LP gain rate, increase item drops, reduce the player to player damage to zero, or even increase the damage from creatures and make it really tough for the players!

To adjust the server rates, stop the server and check the file <game server>/Data/ServerRates.config
Please read carefullyΓÇöall the rates are disabled and in order to apply them '''you need to remove the # char at the start of the line'''!

If you want to '''enable PvP''', search PvP in the file. By default, this setting's value is 0 and you need to change it to 1 and remove the # char at the start of the line.

For advanced modding please read [http://forums.atomictorch.com/index.php?topic=1027.0 modding prerequisites].

== Server raiding hours (for PvP) ==
'''(Please note: with A27 this feature is not recommend anymore as there is a better feature now ΓÇö S.H.I.E.L.D. protection that is enabled by default for PvP servers)'''

On PvP server, you could set up specific hours during which the raiding is possible.
 By default, offline raiding protection is not enabled so players could raid other players' bases at any time.
 To enable offline raiding protection, please use this in-game console command:
 <code>/admin.setRaidingWindow 4 14 1.5</code>
 In this code we're using (first number) +4 GMT/UTC timezone, (second number) hour of day when raiding is possible (value from 0 to 24), and (third number) is the duration of the raiding window (value from 0 to 24).
 So the code in the example will allow raiding from 14:00 (or 2PM) for 1.5 hours.
 After changing the value you could open Politics/Diplomacy menu ([P] key) and verify whether you set the correct numbers.
 Please note that Politics/Diplomacy menu displaying your local time (in your PC timezone)!

== How to prohibit client modifications ==
If you wish to restrict usage of any client modifications on your server, please find "<no_client_mods>" setting in the SettingsServer.xml file. Change the value from 0 to 1 to enable this feature. It's recommended for PvP servers to set it to 1. You can read more details about this feature in [https://atomictorch.com/Post/Id2218/A28-Justice-Update-Release A28 Update announcement].

CryoFall/Server/Setup

2021-05-01T13:27:35Z

Ai enabled: /* Hardware requirements */

= Local game server =
If you wish to play in single-player mode please note that the local game server was added as an experimental feature in February 2021.
 It makes it much easier to run the local server on your PC and playing on itΓÇöno further downloads and setup required and you don't need to manually type any console commands.
Please follow the [https://forums.atomictorch.com/index.php?topic=1858.msg9546#msg9546 short guide here] on how to start the local game server!

= Using game server hosting providers =

==== Game server rent service ====
''If you don't want to hassle with the game server setup, you can rent your own CryoFall server from any third party game server hosting company in just a few minutes. They provide data center locations in almost every country around the world!''
* [https://pingperfect.com/gameservers/cryofall-game-server-hosting-rental.php?aff=586 PingPerfect]
* [https://gameserver.4players.de/server-hosting/cryofall-server-mieten/ 4PLAYERS] (the website is available in German only)
''Please note that AtomicTorch Studio is not affiliated with any of these companies and not responsible for their service quality so in case of any issues please reach them directly. So far we've heard only positive feedback about their services.''

= Self-hosting =

== Requirements ==
====Hardware requirements====
(for up to about 30 players online) 1-core CPU 1.6-2 GHz, 1.5 GB RAM, 2-3 Mbit/s bandwidth (each way)
 (for up to about 100 players online) 2-core CPU 1.6-2 GHz, 2 GB RAM, 3-6 Mbit/s bandwidth
 (for up to about 200 players online) 2-core CPU 2.4-3 GHz, 2 GB RAM, 6-12 Mbit/s bandwidth
 (for up to about 300 players online) 2-core CPU 3+ GHz, 2.5 GB RAM, 12-20 Mbit/s bandwidth
 Usually, VPS (virtual machines) hosting such as [https://www.vultr.com/?ref=7238385 Vultr.com] (this is our referral link as we're using this company services to host our own servers) is sufficient for hosting a game server. Using 1-core machines is not recommended as the game requires a secondary CPU to ensure smooth performance without hiccups during intensive background operations (such as world snapshot saving). Using more than a 2-core machine for a single game server hosting is redundant as the game cannot utilize more than two cores due to the sequential execution of the game simulation (except networking).

====Software (system) requirements====
The server could run on Windows, Linux, and Mac.
To achieve this the game server is using .NET Runtime 5.0.
For hosting the official game servers we prefer using CentOS 7 with Docker or CentOS 8 with podman (OSS alternative to Docker).

== Server installation with Docker (best way for Linux) ==
We recommend this for Linux only. Please follow this guide [https://hub.docker.com/r/atomictorch/cryofall-server CryoFall Dedicated Server Docker Image] then return back here to '''"Server installation"''' section and follow the list after number 7. Ignore instructions on how to start the server with "dotnet" as you should use "docker run ..." instead as explained in the Docker guide above.

== Server installation / direct download (Windows, Linux, Mac) ==

==== How to setup your own server (on any OS): ====
# Install .NET Runtime 5.0 x64ΓÇöplease visit [https://dotnet.microsoft.com/download/dotnet/5.0/runtime Download .NET page] and follow the installation guide for your OS.
# Download the game server package from '''[https://atomictorch.com/Files/CryoFall_Server_v1.30.6.3_NetCore.zip SERVER DOWNLOAD LINK (any OS)]''' and extract it (it's a regular Zip archive). (on Linux you can use wget and unzip command line tools to download and extract it)
# The server package is including everything necessary to run the game server (not only executable but also "Core" folder containing the game scripts in a packaged zip archive named "Core.cpk").
# The server executable is located in the subfolder: "Binaries/Server". Open the command line/terminal/SSH (or PowerShell in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable first time with <code>loadOrNew</code> flag. The server will start and create the game world.
#:<code>dotnet CryoFall_Server.dll loadOrNew</code>
# Usually it takes about 1-2 minutes to create a new world (or load a savegame). After that the server will keep writing performance statistics information every 20 seconds among other information such as the spawn scripts reporting and network events.
# Stop the server. To do so enter the command below and press Enter key.
#:<code>stop 0</code>
#The server will save and quit. Now you have the "SettingsServer.xml" and "ModsConfig.xml" files.
# Now you need to navigate to the subfolder "Data" (in the root of the server folder, '''not''' in the "Binaries/Server") and modify "SettingsServer.xml" to set the unique server '''name''' and set other settings, etc (there are XML comments explaining every setting so it should be straightforward). ''Please note that you can (and should) edit '''Description''' and '''Welcome message''' from the '''CURRENT GAME''' menu right from the game after connecting to your server.''
# If you are interested in making your server visible in the community servers list make sure to edit <is_public_server> and change the value from 0 to 1. Also, please make sure your router is configured correctly (port forwarding) to enable other people to connect to your machine from outside. But ideally, you should use dedicated server hardware (VPS or VDS) to host public servers.
# While you're still editing "SettingsServer.xml" file, please find the value '''<server_operators_list>''' and change it to include '''your nickname'''! Otherwise, you will be unable to access your server console from the game and also you will be unable to edit the server's Description and Welcome message.
# If you want to have a custom server icon, please replace the ServerIcon.png file in the "Data" subfolder. The icon image file requirements: '''PNG24 format, 256x256 size, up to 100 KB'''.

'''Important (for Windows only):''' you need to allow the dotnet process in the Windows Firewall settingsΓÇöif the Firewall access request was not shown automatically by Windows you can add the <code>C:\Program Files\dotnet\dotnet.exe</code> file into Firewall whitelist. To do this, open Windows Start menu and search for "Allow an app through Windows Firewall" -> button "Allow another app".

==== Starting the server ====
# Launch the command line (we recommending '''PowerShell''' in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable with <code>load</code> flag.
#:<code>dotnet CryoFall_Server.dll load</code>
# Stop your server by typing command below and pressing Enter key (it will save the world before stopping).
#:<code>stop 60 The shutdown message text goes here</code>
(Where <code>60</code> is the shutdown delay (in seconds) so the connected players will have some time to find a safe location)

'''''Please note that typing this message is really hard as the console is updating regularly! The best way is to simply copy-paste from the text editor the whole command text into the game console window (hint: you can paste in PowerShell by simply pressing the right mouse button) and pressing Enter key.'''''

You can always wipe the world by launching the game with <code>new</code> flag:
:<code>dotnet CryoFall_Server.dll new</code>

Currently, we don't support the savegame migration between the major game versions (if there are changes to the game data serialization scheme). We plan to implement the proper data migration feature ASAP.

==== Connecting to the server ====
If you want to connect to your local game server, simply add SERVERS->Custom list as <code>localhost</code>

To connect to the public server you need to navigate to SERVERS->Community servers list (please note that this might not work if you host this server on the same PC as the client, read below).

If you're attempting to host your server on a home computer and other players cannot connect to it, you need to manually forward the port '''UDP 6000''' on your home router to '''your local IP address''' (the game has the auto port forwarding feature but it often fails due to the difference in UPnP implementation on many routers). E.g. if your PC's IP address in local network is 192.168.1.100 (you can check it with ipconfig tool or in Windows network adapter's settings) you will need to setup a port forward rule on your router to forward traffic from port 6000 UDP to port 6000 UDP on IP address 192.168.1.100.

'''If you're running a game server on the same PC as the game client:'''
 Please note that you might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its address as <code>localhost:6000</code> and connect to it directly.

'''If you're running a game server in the same local network as the game client (for example you want to play over LAN with your friends and family):'''
 You might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its local IP address (IPv4) and connect to it directly. To get your local IP address please use ipconfig command-line tool or check the network adapter properties in the network center. You need to get the local network IP address of the PC that is hosting the game server. Then add it in the custom servers list on your PC. You can lookup the IP address in the Windows network settings or by using CMD tool called ipconfig in Windows. For example, here we've run the ipconfig tool here and see the IPv4 address as 192.168.1.200 ([https://cdn.discordapp.com/attachments/421250395298332672/739147674367950908/Screenshot_at_19-48-06.png screenshot]). We can use it on any other PC in the local network to connect to that PC hosting the game server.

Connecting to the private servers requires adding it via the Custom servers menu.

6000 is the default port but you can change it in the Data/SettingsServer.xml file.

== Server update/upgrade to new version ==
When we're releasing a new version of the game server, you need to follow these steps to update it:
# (If you have not done this) Install ".NET Runtime" (version 5.0) https://dotnet.microsoft.com/download/dotnet/5.0/runtime
# Ensure you've made a '''backup''' of the "'''Data'''" folder inside the game server installation folder.
# If you're updating from A28 or earlier versions, DELETE "Data/Saves" folder as the savegame is not compatible (breaking changes). Update from A29 to any A30 (and A30 to its patch versions) '''doesn't require this step''' (savegame is compatible).
# Download the new version of the server and overwrite your current installation with it (you can find the actual download link above in the "Installation" section).
# Stop the game server (if it's running).
# Important: please '''overwrite''' both Binaries and Core folders!
# Start the server as usual.

== Server commands ==
# Ensure you're the server operator (you've edited the ServerSettings.xml file and added yourself into the server_operators_list).
# Connect to your game server.
# The game console can be toggled by pressing <code>~</code> (the key on the left from <code>1</code> key) like in old-school games (you can change the key binding for console in the controls options).
# Please add <code>/</code> (slash) prefix to the server commands you want to execute.
# You can use '''Tab''' key to fill autocomplete, and you can use '''arrow Up/Down keys''' to navigate the suggestions list. Press '''Tab''' or '''Enter''' to accept the suggestion.

Here is the page with the server commands list: [[CryoFall/Server/Commands|Server Commands List]]

== Moderation (whitelist, blacklist, kicking, muting) ==
Server operator can access special moderation commands. To invoke these commands, please ensure you're the server operator, connect to your game server, open the console (~ key) and then you can use these commands: (replace username with the actual player nickname)

Whitelist management:

<code>/mod.whiteList.add username</code>

<code>/mod.whiteList.remove username</code>

<code>/mod.whiteList.print</code>

To enable whitelist:

<code>/mod.whiteList.enabled 1</code>

Blacklist management:

<code>/mod.blackList.add username</code>

<code>/mod.blackList.remove username</code>

<code>/mod.blackList.print</code>

Kicking players (temporary removing from server and blocking from connecting):

<code>/mod.kickList.add username durationInMinutes</code>

<code>/mod.kickList.remove username</code>

<code>/mod.kickList.print</code>

Muting players (temporary removing their ability to send messages to chat):

<code>/mod.muteList.add username durationInMinutes</code>

<code>/mod.muteList.remove username</code>

<code>/mod.muteList.print</code>

== Server rates adjusting / Enabling PvP mode ==
Server rates (and PvP mode setting) are exposed in a separate config file. You can quickly change things like LP gain rate, increase item drops, reduce the player to player damage to zero, or even increase the damage from creatures and make it really tough for the players!

To adjust the server rates, stop the server and check the file <game server>/Data/ServerRates.config
Please read carefullyΓÇöall the rates are disabled and in order to apply them '''you need to remove the # char at the start of the line'''!

If you want to '''enable PvP''', search PvP in the file. By default, this setting's value is 0 and you need to change it to 1 and remove the # char at the start of the line.

For advanced modding please read [http://forums.atomictorch.com/index.php?topic=1027.0 modding prerequisites].

== Server raiding hours (for PvP) ==
'''(Please note: with A27 this feature is not recommend anymore as there is a better feature now ΓÇö S.H.I.E.L.D. protection that is enabled by default for PvP servers)'''

On PvP server, you could set up specific hours during which the raiding is possible.
 By default, offline raiding protection is not enabled so players could raid other players' bases at any time.
 To enable offline raiding protection, please use this in-game console command:
 <code>/admin.setRaidingWindow 4 14 1.5</code>
 In this code we're using (first number) +4 GMT/UTC timezone, (second number) hour of day when raiding is possible (value from 0 to 24), and (third number) is the duration of the raiding window (value from 0 to 24).
 So the code in the example will allow raiding from 14:00 (or 2PM) for 1.5 hours.
 After changing the value you could open Politics/Diplomacy menu ([P] key) and verify whether you set the correct numbers.
 Please note that Politics/Diplomacy menu displaying your local time (in your PC timezone)!

== How to prohibit client modifications ==
If you wish to restrict usage of any client modifications on your server, please find "<no_client_mods>" setting in the SettingsServer.xml file. Change the value from 0 to 1 to enable this feature. It's recommended for PvP servers to set it to 1. You can read more details about this feature in [https://atomictorch.com/Post/Id2218/A28-Justice-Update-Release A28 Update announcement].

CryoFall/Server/Setup

2021-04-30T22:37:00Z

Ai enabled: /* Starting the server: */

= Local game server =
If you wish to play in single-player mode please note that the local game server was added as an experimental feature in February 2021.
 It makes it much easier to run the local server on your PC and playing on itΓÇöno further downloads and setup required and you don't need to manually type any console commands.
Please follow the [https://forums.atomictorch.com/index.php?topic=1858.msg9546#msg9546 short guide here] on how to start the local game server!

= Using game server hosting providers =

==== Game server rent service ====
''If you don't want to hassle with the game server setup, you can rent your own CryoFall server from any third party game server hosting company in just a few minutes. They provide data center locations in almost every country around the world!''
* [https://pingperfect.com/gameservers/cryofall-game-server-hosting-rental.php?aff=586 PingPerfect]
* [https://gameserver.4players.de/server-hosting/cryofall-server-mieten/ 4PLAYERS] (the website is available in German only)
''Please note that AtomicTorch Studio is not affiliated with any of these companies and not responsible for their service quality so in case of any issues please reach them directly. So far we've heard only positive feedback about their services.''

= Self-hosting =

== Requirements ==
====Hardware requirements====
(for up to about 30 players online) 1-core CPU 1.6-2 GHz, 1.5 GB RAM, 2-3 Mbit/s bandwidth (each way)
 (for up to about 100 players online) 2-core CPU 1.6-2 GHz, 2 GB RAM, 3-6 Mbit/s bandwidth
 (for up to about 200 players online) 2-core CPU 2.4-3 GHz, 2-3 GB RAM, 6-12 Mbit/s bandwidth
 (for up to about 300 players online) 2-core CPU 3+ GHz, 3-4 GB RAM, 12-20 Mbit/s bandwidth
 Usually, VPS (virtual machines) hosting such as [https://www.vultr.com/?ref=7238385 Vultr.com] (this is our referral link as we're using this company services to host our own servers) is sufficient for hosting a game server. Using 1-core machines is not recommended as the game requires a secondary CPU to ensure smooth performance without hiccups during intensive background operations (such as world snapshot saving). Using more than a 2-core machine for a single game server hosting is redundant as the game cannot utilize more than two cores due to the sequential execution of the game simulation (except networking).

====Software (system) requirements====
The server could run on Windows, Linux, and Mac.
To achieve this the game server is using .NET Runtime 5.0.
For hosting the official game servers we prefer using CentOS 7 with Docker or CentOS 8 with podman (OSS alternative to Docker).

== Server installation with Docker (best way for Linux) ==
We recommend this for Linux only. Please follow this guide [https://hub.docker.com/r/atomictorch/cryofall-server CryoFall Dedicated Server Docker Image] then return back here to '''"Server installation"''' section and follow the list after number 7. Ignore instructions on how to start the server with "dotnet" as you should use "docker run ..." instead as explained in the Docker guide above.

== Server installation / direct download (Windows, Linux, Mac) ==

==== How to setup your own server (on any OS): ====
# Install .NET Runtime 5.0 x64ΓÇöplease visit [https://dotnet.microsoft.com/download/dotnet/5.0/runtime Download .NET page] and follow the installation guide for your OS.
# Download the game server package from '''[https://atomictorch.com/Files/CryoFall_Server_v1.30.6.3_NetCore.zip SERVER DOWNLOAD LINK (any OS)]''' and extract it (it's a regular Zip archive). (on Linux you can use wget and unzip command line tools to download and extract it)
# The server package is including everything necessary to run the game server (not only executable but also "Core" folder containing the game scripts in a packaged zip archive named "Core.cpk").
# The server executable is located in the subfolder: "Binaries/Server". Open the command line/terminal/SSH (or PowerShell in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable first time with <code>loadOrNew</code> flag. The server will start and create the game world.
#:<code>dotnet CryoFall_Server.dll loadOrNew</code>
# Usually it takes about 1-2 minutes to create a new world (or load a savegame). After that the server will keep writing performance statistics information every 20 seconds among other information such as the spawn scripts reporting and network events.
# Stop the server. To do so enter the command below and press Enter key.
#:<code>stop 0</code>
#The server will save and quit. Now you have the "SettingsServer.xml" and "ModsConfig.xml" files.
# Now you need to navigate to the subfolder "Data" (in the root of the server folder, '''not''' in the "Binaries/Server") and modify "SettingsServer.xml" to set the unique server '''name''' and set other settings, etc (there are XML comments explaining every setting so it should be straightforward). ''Please note that you can (and should) edit '''Description''' and '''Welcome message''' from the '''CURRENT GAME''' menu right from the game after connecting to your server.''
# If you are interested in making your server visible in the community servers list make sure to edit <is_public_server> and change the value from 0 to 1. Also, please make sure your router is configured correctly (port forwarding) to enable other people to connect to your machine from outside. But ideally, you should use dedicated server hardware (VPS or VDS) to host public servers.
# While you're still editing "SettingsServer.xml" file, please find the value '''<server_operators_list>''' and change it to include '''your nickname'''! Otherwise, you will be unable to access your server console from the game and also you will be unable to edit the server's Description and Welcome message.
# If you want to have a custom server icon, please replace the ServerIcon.png file in the "Data" subfolder. The icon image file requirements: '''PNG24 format, 256x256 size, up to 100 KB'''.

'''Important (for Windows only):''' you need to allow the dotnet process in the Windows Firewall settingsΓÇöif the Firewall access request was not shown automatically by Windows you can add the <code>C:\Program Files\dotnet\dotnet.exe</code> file into Firewall whitelist. To do this, open Windows Start menu and search for "Allow an app through Windows Firewall" -> button "Allow another app".

==== Starting the server ====
# Launch the command line (we recommending '''PowerShell''' in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable with <code>load</code> flag.
#:<code>dotnet CryoFall_Server.dll load</code>
# Stop your server by typing command below and pressing Enter key (it will save the world before stopping).
#:<code>stop 60 The shutdown message text goes here</code>
(Where <code>60</code> is the shutdown delay (in seconds) so the connected players will have some time to find a safe location)

'''''Please note that typing this message is really hard as the console is updating regularly! The best way is to simply copy-paste from the text editor the whole command text into the game console window (hint: you can paste in PowerShell by simply pressing the right mouse button) and pressing Enter key.'''''

You can always wipe the world by launching the game with <code>new</code> flag:
:<code>dotnet CryoFall_Server.dll new</code>

Currently, we don't support the savegame migration between the major game versions (if there are changes to the game data serialization scheme). We plan to implement the proper data migration feature ASAP.

==== Connecting to the server ====
If you want to connect to your local game server, simply add SERVERS->Custom list as <code>localhost</code>

To connect to the public server you need to navigate to SERVERS->Community servers list (please note that this might not work if you host this server on the same PC as the client, read below).

If you're attempting to host your server on a home computer and other players cannot connect to it, you need to manually forward the port '''UDP 6000''' on your home router to '''your local IP address''' (the game has the auto port forwarding feature but it often fails due to the difference in UPnP implementation on many routers). E.g. if your PC's IP address in local network is 192.168.1.100 (you can check it with ipconfig tool or in Windows network adapter's settings) you will need to setup a port forward rule on your router to forward traffic from port 6000 UDP to port 6000 UDP on IP address 192.168.1.100.

'''If you're running a game server on the same PC as the game client:'''
 Please note that you might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its address as <code>localhost:6000</code> and connect to it directly.

'''If you're running a game server in the same local network as the game client (for example you want to play over LAN with your friends and family):'''
 You might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its local IP address (IPv4) and connect to it directly. To get your local IP address please use ipconfig command-line tool or check the network adapter properties in the network center. You need to get the local network IP address of the PC that is hosting the game server. Then add it in the custom servers list on your PC. You can lookup the IP address in the Windows network settings or by using CMD tool called ipconfig in Windows. For example, here we've run the ipconfig tool here and see the IPv4 address as 192.168.1.200 ([https://cdn.discordapp.com/attachments/421250395298332672/739147674367950908/Screenshot_at_19-48-06.png screenshot]). We can use it on any other PC in the local network to connect to that PC hosting the game server.

Connecting to the private servers requires adding it via the Custom servers menu.

6000 is the default port but you can change it in the Data/SettingsServer.xml file.

== Server update/upgrade to new version ==
When we're releasing a new version of the game server, you need to follow these steps to update it:
# (If you have not done this) Install ".NET Runtime" (version 5.0) https://dotnet.microsoft.com/download/dotnet/5.0/runtime
# Ensure you've made a '''backup''' of the "'''Data'''" folder inside the game server installation folder.
# If you're updating from A28 or earlier versions, DELETE "Data/Saves" folder as the savegame is not compatible (breaking changes). Update from A29 to any A30 (and A30 to its patch versions) '''doesn't require this step''' (savegame is compatible).
# Download the new version of the server and overwrite your current installation with it (you can find the actual download link above in the "Installation" section).
# Stop the game server (if it's running).
# Important: please '''overwrite''' both Binaries and Core folders!
# Start the server as usual.

== Server commands ==
# Ensure you're the server operator (you've edited the ServerSettings.xml file and added yourself into the server_operators_list).
# Connect to your game server.
# The game console can be toggled by pressing <code>~</code> (the key on the left from <code>1</code> key) like in old-school games (you can change the key binding for console in the controls options).
# Please add <code>/</code> (slash) prefix to the server commands you want to execute.
# You can use '''Tab''' key to fill autocomplete, and you can use '''arrow Up/Down keys''' to navigate the suggestions list. Press '''Tab''' or '''Enter''' to accept the suggestion.

Here is the page with the server commands list: [[CryoFall/Server/Commands|Server Commands List]]

== Moderation (whitelist, blacklist, kicking, muting) ==
Server operator can access special moderation commands. To invoke these commands, please ensure you're the server operator, connect to your game server, open the console (~ key) and then you can use these commands: (replace username with the actual player nickname)

Whitelist management:

<code>/mod.whiteList.add username</code>

<code>/mod.whiteList.remove username</code>

<code>/mod.whiteList.print</code>

To enable whitelist:

<code>/mod.whiteList.enabled 1</code>

Blacklist management:

<code>/mod.blackList.add username</code>

<code>/mod.blackList.remove username</code>

<code>/mod.blackList.print</code>

Kicking players (temporary removing from server and blocking from connecting):

<code>/mod.kickList.add username durationInMinutes</code>

<code>/mod.kickList.remove username</code>

<code>/mod.kickList.print</code>

Muting players (temporary removing their ability to send messages to chat):

<code>/mod.muteList.add username durationInMinutes</code>

<code>/mod.muteList.remove username</code>

<code>/mod.muteList.print</code>

== Server rates adjusting / Enabling PvP mode ==
Server rates (and PvP mode setting) are exposed in a separate config file. You can quickly change things like LP gain rate, increase item drops, reduce the player to player damage to zero, or even increase the damage from creatures and make it really tough for the players!

To adjust the server rates, stop the server and check the file <game server>/Data/ServerRates.config
Please read carefullyΓÇöall the rates are disabled and in order to apply them '''you need to remove the # char at the start of the line'''!

If you want to '''enable PvP''', search PvP in the file. By default, this setting's value is 0 and you need to change it to 1 and remove the # char at the start of the line.

For advanced modding please read [http://forums.atomictorch.com/index.php?topic=1027.0 modding prerequisites].

== Server raiding hours (for PvP) ==
'''(Please note: with A27 this feature is not recommend anymore as there is a better feature now ΓÇö S.H.I.E.L.D. protection that is enabled by default for PvP servers)'''

On PvP server, you could set up specific hours during which the raiding is possible.
 By default, offline raiding protection is not enabled so players could raid other players' bases at any time.
 To enable offline raiding protection, please use this in-game console command:
 <code>/admin.setRaidingWindow 4 14 1.5</code>
 In this code we're using (first number) +4 GMT/UTC timezone, (second number) hour of day when raiding is possible (value from 0 to 24), and (third number) is the duration of the raiding window (value from 0 to 24).
 So the code in the example will allow raiding from 14:00 (or 2PM) for 1.5 hours.
 After changing the value you could open Politics/Diplomacy menu ([P] key) and verify whether you set the correct numbers.
 Please note that Politics/Diplomacy menu displaying your local time (in your PC timezone)!

== How to prohibit client modifications ==
If you wish to restrict usage of any client modifications on your server, please find "<no_client_mods>" setting in the SettingsServer.xml file. Change the value from 0 to 1 to enable this feature. It's recommended for PvP servers to set it to 1. You can read more details about this feature in [https://atomictorch.com/Post/Id2218/A28-Justice-Update-Release A28 Update announcement].

CryoFall/Server/Setup

2021-04-30T22:36:51Z

Ai enabled: /* Connecting to the server: */

= Local game server =
If you wish to play in single-player mode please note that the local game server was added as an experimental feature in February 2021.
 It makes it much easier to run the local server on your PC and playing on itΓÇöno further downloads and setup required and you don't need to manually type any console commands.
Please follow the [https://forums.atomictorch.com/index.php?topic=1858.msg9546#msg9546 short guide here] on how to start the local game server!

= Using game server hosting providers =

==== Game server rent service ====
''If you don't want to hassle with the game server setup, you can rent your own CryoFall server from any third party game server hosting company in just a few minutes. They provide data center locations in almost every country around the world!''
* [https://pingperfect.com/gameservers/cryofall-game-server-hosting-rental.php?aff=586 PingPerfect]
* [https://gameserver.4players.de/server-hosting/cryofall-server-mieten/ 4PLAYERS] (the website is available in German only)
''Please note that AtomicTorch Studio is not affiliated with any of these companies and not responsible for their service quality so in case of any issues please reach them directly. So far we've heard only positive feedback about their services.''

= Self-hosting =

== Requirements ==
====Hardware requirements====
(for up to about 30 players online) 1-core CPU 1.6-2 GHz, 1.5 GB RAM, 2-3 Mbit/s bandwidth (each way)
 (for up to about 100 players online) 2-core CPU 1.6-2 GHz, 2 GB RAM, 3-6 Mbit/s bandwidth
 (for up to about 200 players online) 2-core CPU 2.4-3 GHz, 2-3 GB RAM, 6-12 Mbit/s bandwidth
 (for up to about 300 players online) 2-core CPU 3+ GHz, 3-4 GB RAM, 12-20 Mbit/s bandwidth
 Usually, VPS (virtual machines) hosting such as [https://www.vultr.com/?ref=7238385 Vultr.com] (this is our referral link as we're using this company services to host our own servers) is sufficient for hosting a game server. Using 1-core machines is not recommended as the game requires a secondary CPU to ensure smooth performance without hiccups during intensive background operations (such as world snapshot saving). Using more than a 2-core machine for a single game server hosting is redundant as the game cannot utilize more than two cores due to the sequential execution of the game simulation (except networking).

====Software (system) requirements====
The server could run on Windows, Linux, and Mac.
To achieve this the game server is using .NET Runtime 5.0.
For hosting the official game servers we prefer using CentOS 7 with Docker or CentOS 8 with podman (OSS alternative to Docker).

== Server installation with Docker (best way for Linux) ==
We recommend this for Linux only. Please follow this guide [https://hub.docker.com/r/atomictorch/cryofall-server CryoFall Dedicated Server Docker Image] then return back here to '''"Server installation"''' section and follow the list after number 7. Ignore instructions on how to start the server with "dotnet" as you should use "docker run ..." instead as explained in the Docker guide above.

== Server installation / direct download (Windows, Linux, Mac) ==

==== How to setup your own server (on any OS): ====
# Install .NET Runtime 5.0 x64ΓÇöplease visit [https://dotnet.microsoft.com/download/dotnet/5.0/runtime Download .NET page] and follow the installation guide for your OS.
# Download the game server package from '''[https://atomictorch.com/Files/CryoFall_Server_v1.30.6.3_NetCore.zip SERVER DOWNLOAD LINK (any OS)]''' and extract it (it's a regular Zip archive). (on Linux you can use wget and unzip command line tools to download and extract it)
# The server package is including everything necessary to run the game server (not only executable but also "Core" folder containing the game scripts in a packaged zip archive named "Core.cpk").
# The server executable is located in the subfolder: "Binaries/Server". Open the command line/terminal/SSH (or PowerShell in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable first time with <code>loadOrNew</code> flag. The server will start and create the game world.
#:<code>dotnet CryoFall_Server.dll loadOrNew</code>
# Usually it takes about 1-2 minutes to create a new world (or load a savegame). After that the server will keep writing performance statistics information every 20 seconds among other information such as the spawn scripts reporting and network events.
# Stop the server. To do so enter the command below and press Enter key.
#:<code>stop 0</code>
#The server will save and quit. Now you have the "SettingsServer.xml" and "ModsConfig.xml" files.
# Now you need to navigate to the subfolder "Data" (in the root of the server folder, '''not''' in the "Binaries/Server") and modify "SettingsServer.xml" to set the unique server '''name''' and set other settings, etc (there are XML comments explaining every setting so it should be straightforward). ''Please note that you can (and should) edit '''Description''' and '''Welcome message''' from the '''CURRENT GAME''' menu right from the game after connecting to your server.''
# If you are interested in making your server visible in the community servers list make sure to edit <is_public_server> and change the value from 0 to 1. Also, please make sure your router is configured correctly (port forwarding) to enable other people to connect to your machine from outside. But ideally, you should use dedicated server hardware (VPS or VDS) to host public servers.
# While you're still editing "SettingsServer.xml" file, please find the value '''<server_operators_list>''' and change it to include '''your nickname'''! Otherwise, you will be unable to access your server console from the game and also you will be unable to edit the server's Description and Welcome message.
# If you want to have a custom server icon, please replace the ServerIcon.png file in the "Data" subfolder. The icon image file requirements: '''PNG24 format, 256x256 size, up to 100 KB'''.

'''Important (for Windows only):''' you need to allow the dotnet process in the Windows Firewall settingsΓÇöif the Firewall access request was not shown automatically by Windows you can add the <code>C:\Program Files\dotnet\dotnet.exe</code> file into Firewall whitelist. To do this, open Windows Start menu and search for "Allow an app through Windows Firewall" -> button "Allow another app".

==== Starting the server: ====
# Launch the command line (we recommending '''PowerShell''' in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable with <code>load</code> flag.
#:<code>dotnet CryoFall_Server.dll load</code>
# Stop your server by typing command below and pressing Enter key (it will save the world before stopping).
#:<code>stop 60 The shutdown message text goes here</code>
(Where <code>60</code> is the shutdown delay (in seconds) so the connected players will have some time to find a safe location)

'''''Please note that typing this message is really hard as the console is updating regularly! The best way is to simply copy-paste from the text editor the whole command text into the game console window (hint: you can paste in PowerShell by simply pressing the right mouse button) and pressing Enter key.'''''

You can always wipe the world by launching the game with <code>new</code> flag:
:<code>dotnet CryoFall_Server.dll new</code>

Currently, we don't support the savegame migration between the major game versions (if there are changes to the game data serialization scheme). We plan to implement the proper data migration feature ASAP.

==== Connecting to the server ====
If you want to connect to your local game server, simply add SERVERS->Custom list as <code>localhost</code>

To connect to the public server you need to navigate to SERVERS->Community servers list (please note that this might not work if you host this server on the same PC as the client, read below).

If you're attempting to host your server on a home computer and other players cannot connect to it, you need to manually forward the port '''UDP 6000''' on your home router to '''your local IP address''' (the game has the auto port forwarding feature but it often fails due to the difference in UPnP implementation on many routers). E.g. if your PC's IP address in local network is 192.168.1.100 (you can check it with ipconfig tool or in Windows network adapter's settings) you will need to setup a port forward rule on your router to forward traffic from port 6000 UDP to port 6000 UDP on IP address 192.168.1.100.

'''If you're running a game server on the same PC as the game client:'''
 Please note that you might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its address as <code>localhost:6000</code> and connect to it directly.

'''If you're running a game server in the same local network as the game client (for example you want to play over LAN with your friends and family):'''
 You might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its local IP address (IPv4) and connect to it directly. To get your local IP address please use ipconfig command-line tool or check the network adapter properties in the network center. You need to get the local network IP address of the PC that is hosting the game server. Then add it in the custom servers list on your PC. You can lookup the IP address in the Windows network settings or by using CMD tool called ipconfig in Windows. For example, here we've run the ipconfig tool here and see the IPv4 address as 192.168.1.200 ([https://cdn.discordapp.com/attachments/421250395298332672/739147674367950908/Screenshot_at_19-48-06.png screenshot]). We can use it on any other PC in the local network to connect to that PC hosting the game server.

Connecting to the private servers requires adding it via the Custom servers menu.

6000 is the default port but you can change it in the Data/SettingsServer.xml file.

== Server update/upgrade to new version ==
When we're releasing a new version of the game server, you need to follow these steps to update it:
# (If you have not done this) Install ".NET Runtime" (version 5.0) https://dotnet.microsoft.com/download/dotnet/5.0/runtime
# Ensure you've made a '''backup''' of the "'''Data'''" folder inside the game server installation folder.
# If you're updating from A28 or earlier versions, DELETE "Data/Saves" folder as the savegame is not compatible (breaking changes). Update from A29 to any A30 (and A30 to its patch versions) '''doesn't require this step''' (savegame is compatible).
# Download the new version of the server and overwrite your current installation with it (you can find the actual download link above in the "Installation" section).
# Stop the game server (if it's running).
# Important: please '''overwrite''' both Binaries and Core folders!
# Start the server as usual.

== Server commands ==
# Ensure you're the server operator (you've edited the ServerSettings.xml file and added yourself into the server_operators_list).
# Connect to your game server.
# The game console can be toggled by pressing <code>~</code> (the key on the left from <code>1</code> key) like in old-school games (you can change the key binding for console in the controls options).
# Please add <code>/</code> (slash) prefix to the server commands you want to execute.
# You can use '''Tab''' key to fill autocomplete, and you can use '''arrow Up/Down keys''' to navigate the suggestions list. Press '''Tab''' or '''Enter''' to accept the suggestion.

Here is the page with the server commands list: [[CryoFall/Server/Commands|Server Commands List]]

== Moderation (whitelist, blacklist, kicking, muting) ==
Server operator can access special moderation commands. To invoke these commands, please ensure you're the server operator, connect to your game server, open the console (~ key) and then you can use these commands: (replace username with the actual player nickname)

Whitelist management:

<code>/mod.whiteList.add username</code>

<code>/mod.whiteList.remove username</code>

<code>/mod.whiteList.print</code>

To enable whitelist:

<code>/mod.whiteList.enabled 1</code>

Blacklist management:

<code>/mod.blackList.add username</code>

<code>/mod.blackList.remove username</code>

<code>/mod.blackList.print</code>

Kicking players (temporary removing from server and blocking from connecting):

<code>/mod.kickList.add username durationInMinutes</code>

<code>/mod.kickList.remove username</code>

<code>/mod.kickList.print</code>

Muting players (temporary removing their ability to send messages to chat):

<code>/mod.muteList.add username durationInMinutes</code>

<code>/mod.muteList.remove username</code>

<code>/mod.muteList.print</code>

== Server rates adjusting / Enabling PvP mode ==
Server rates (and PvP mode setting) are exposed in a separate config file. You can quickly change things like LP gain rate, increase item drops, reduce the player to player damage to zero, or even increase the damage from creatures and make it really tough for the players!

To adjust the server rates, stop the server and check the file <game server>/Data/ServerRates.config
Please read carefullyΓÇöall the rates are disabled and in order to apply them '''you need to remove the # char at the start of the line'''!

If you want to '''enable PvP''', search PvP in the file. By default, this setting's value is 0 and you need to change it to 1 and remove the # char at the start of the line.

For advanced modding please read [http://forums.atomictorch.com/index.php?topic=1027.0 modding prerequisites].

== Server raiding hours (for PvP) ==
'''(Please note: with A27 this feature is not recommend anymore as there is a better feature now ΓÇö S.H.I.E.L.D. protection that is enabled by default for PvP servers)'''

On PvP server, you could set up specific hours during which the raiding is possible.
 By default, offline raiding protection is not enabled so players could raid other players' bases at any time.
 To enable offline raiding protection, please use this in-game console command:
 <code>/admin.setRaidingWindow 4 14 1.5</code>
 In this code we're using (first number) +4 GMT/UTC timezone, (second number) hour of day when raiding is possible (value from 0 to 24), and (third number) is the duration of the raiding window (value from 0 to 24).
 So the code in the example will allow raiding from 14:00 (or 2PM) for 1.5 hours.
 After changing the value you could open Politics/Diplomacy menu ([P] key) and verify whether you set the correct numbers.
 Please note that Politics/Diplomacy menu displaying your local time (in your PC timezone)!

== How to prohibit client modifications ==
If you wish to restrict usage of any client modifications on your server, please find "<no_client_mods>" setting in the SettingsServer.xml file. Change the value from 0 to 1 to enable this feature. It's recommended for PvP servers to set it to 1. You can read more details about this feature in [https://atomictorch.com/Post/Id2218/A28-Justice-Update-Release A28 Update announcement].

CryoFall/Server/Setup

2021-04-29T12:22:58Z

Ai enabled: /* How to setup your own server (on any OS): */

= Local game server =
If you wish to play in single-player mode please note that the local game server was added as an experimental feature in February 2021.
 It makes it much easier to run the local server on your PC and playing on itΓÇöno further downloads and setup required and you don't need to manually type any console commands.
Please follow the [https://forums.atomictorch.com/index.php?topic=1858.msg9546#msg9546 short guide here] on how to start the local game server!

= Using game server hosting providers =

==== Game server rent service ====
''If you don't want to hassle with the game server setup, you can rent your own CryoFall server from any third party game server hosting company in just a few minutes. They provide data center locations in almost every country around the world!''
* [https://pingperfect.com/gameservers/cryofall-game-server-hosting-rental.php?aff=586 PingPerfect]
* [https://gameserver.4players.de/server-hosting/cryofall-server-mieten/ 4PLAYERS] (the website is available in German only)
''Please note that AtomicTorch Studio is not affiliated with any of these companies and not responsible for their service quality so in case of any issues please reach them directly. So far we've heard only positive feedback about their services.''

= Self-hosting =

== Requirements ==
====Hardware requirements====
(for up to about 30 players online) 1-core CPU 1.6-2 GHz, 1.5 GB RAM, 2-3 Mbit/s bandwidth (each way)
 (for up to about 100 players online) 2-core CPU 1.6-2 GHz, 2 GB RAM, 3-6 Mbit/s bandwidth
 (for up to about 200 players online) 2-core CPU 2.4-3 GHz, 2-3 GB RAM, 6-12 Mbit/s bandwidth
 (for up to about 300 players online) 2-core CPU 3+ GHz, 3-4 GB RAM, 12-20 Mbit/s bandwidth
 Usually, VPS (virtual machines) hosting such as [https://www.vultr.com/?ref=7238385 Vultr.com] (this is our referral link as we're using this company services to host our own servers) is sufficient for hosting a game server. Using 1-core machines is not recommended as the game requires a secondary CPU to ensure smooth performance without hiccups during intensive background operations (such as world snapshot saving). Using more than a 2-core machine for a single game server hosting is redundant as the game cannot utilize more than two cores due to the sequential execution of the game simulation (except networking).

====Software (system) requirements====
The server could run on Windows, Linux, and Mac.
To achieve this the game server is using .NET Runtime 5.0.
For hosting the official game servers we prefer using CentOS 7 with Docker or CentOS 8 with podman (OSS alternative to Docker).

== Server installation with Docker (best way for Linux) ==
We recommend this for Linux only. Please follow this guide [https://hub.docker.com/r/atomictorch/cryofall-server CryoFall Dedicated Server Docker Image] then return back here to '''"Server installation"''' section and follow the list after number 7. Ignore instructions on how to start the server with "dotnet" as you should use "docker run ..." instead as explained in the Docker guide above.

== Server installation / direct download (Windows, Linux, Mac) ==

==== How to setup your own server (on any OS): ====
# Install .NET Runtime 5.0 x64ΓÇöplease visit [https://dotnet.microsoft.com/download/dotnet/5.0/runtime Download .NET page] and follow the installation guide for your OS.
# Download the game server package from '''[https://atomictorch.com/Files/CryoFall_Server_v1.30.6.3_NetCore.zip SERVER DOWNLOAD LINK (any OS)]''' and extract it (it's a regular Zip archive). (on Linux you can use wget and unzip command line tools to download and extract it)
# The server package is including everything necessary to run the game server (not only executable but also "Core" folder containing the game scripts in a packaged zip archive named "Core.cpk").
# The server executable is located in the subfolder: "Binaries/Server". Open the command line/terminal/SSH (or PowerShell in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable first time with <code>loadOrNew</code> flag. The server will start and create the game world.
#:<code>dotnet CryoFall_Server.dll loadOrNew</code>
# Usually it takes about 1-2 minutes to create a new world (or load a savegame). After that the server will keep writing performance statistics information every 20 seconds among other information such as the spawn scripts reporting and network events.
# Stop the server. To do so enter the command below and press Enter key.
#:<code>stop 0</code>
#The server will save and quit. Now you have the "SettingsServer.xml" and "ModsConfig.xml" files.
# Now you need to navigate to the subfolder "Data" (in the root of the server folder, '''not''' in the "Binaries/Server") and modify "SettingsServer.xml" to set the unique server '''name''' and set other settings, etc (there are XML comments explaining every setting so it should be straightforward). ''Please note that you can (and should) edit '''Description''' and '''Welcome message''' from the '''CURRENT GAME''' menu right from the game after connecting to your server.''
# If you are interested in making your server visible in the community servers list make sure to edit <is_public_server> and change the value from 0 to 1. Also, please make sure your router is configured correctly (port forwarding) to enable other people to connect to your machine from outside. But ideally, you should use dedicated server hardware (VPS or VDS) to host public servers.
# While you're still editing "SettingsServer.xml" file, please find the value '''<server_operators_list>''' and change it to include '''your nickname'''! Otherwise, you will be unable to access your server console from the game and also you will be unable to edit the server's Description and Welcome message.
# If you want to have a custom server icon, please replace the ServerIcon.png file in the "Data" subfolder. The icon image file requirements: '''PNG24 format, 256x256 size, up to 100 KB'''.

'''Important (for Windows only):''' you need to allow the dotnet process in the Windows Firewall settingsΓÇöif the Firewall access request was not shown automatically by Windows you can add the <code>C:\Program Files\dotnet\dotnet.exe</code> file into Firewall whitelist. To do this, open Windows Start menu and search for "Allow an app through Windows Firewall" -> button "Allow another app".

==== Starting the server: ====
# Launch the command line (we recommending '''PowerShell''' in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable with <code>load</code> flag.
#:<code>dotnet CryoFall_Server.dll load</code>
# Stop your server by typing command below and pressing Enter key (it will save the world before stopping).
#:<code>stop 60 The shutdown message text goes here</code>
(Where <code>60</code> is the shutdown delay (in seconds) so the connected players will have some time to find a safe location)

'''''Please note that typing this message is really hard as the console is updating regularly! The best way is to simply copy-paste from the text editor the whole command text into the game console window (hint: you can paste in PowerShell by simply pressing the right mouse button) and pressing Enter key.'''''

You can always wipe the world by launching the game with <code>new</code> flag:
:<code>dotnet CryoFall_Server.dll new</code>

Currently, we don't support the savegame migration between the major game versions (if there are changes to the game data serialization scheme). We plan to implement the proper data migration feature ASAP.

==== Connecting to the server: ====
If you want to connect to your local game server, simply add SERVERS->Custom list as <code>localhost</code>

To connect to the public server you need to navigate to SERVERS->Community servers list (please note that this might not work if you host this server on the same PC as the client, read below).

If you're attempting to host your server on a home computer and other players cannot connect to it, you need to manually forward the port '''UDP 6000''' on your home router to '''your local IP address''' (the game has the auto port forwarding feature but it often fails due to the difference in UPnP implementation on many routers). E.g. if your PC's IP address in local network is 192.168.1.100 (you can check it with ipconfig tool or in Windows network adapter's settings) you will need to setup a port forward rule on your router to forward traffic from port 6000 UDP to port 6000 UDP on IP address 192.168.1.100.

'''If you're running a game server on the same PC as the game client:'''
 Please note that you might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its address as <code>localhost:6000</code> and connect to it directly.

'''If you're running a game server in the same local network as the game client (for example you want to play over LAN with your friends and family):'''
 You might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its local IP address (IPv4) and connect to it directly. To get your local IP address please use ipconfig command-line tool or check the network adapter properties in the network center. You need to get the local network IP address of the PC that is hosting the game server. Then add it in the custom servers list on your PC. You can lookup the IP address in the Windows network settings or by using CMD tool called ipconfig in Windows. For example, here we've run the ipconfig tool here and see the IPv4 address as 192.168.1.200 ([https://cdn.discordapp.com/attachments/421250395298332672/739147674367950908/Screenshot_at_19-48-06.png screenshot]). We can use it on any other PC in the local network to connect to that PC hosting the game server.

Connecting to the private servers requires adding it via the Custom servers menu.

6000 is the default port but you can change it in the Data/SettingsServer.xml file.

== Server update/upgrade to new version ==
When we're releasing a new version of the game server, you need to follow these steps to update it:
# (If you have not done this) Install ".NET Runtime" (version 5.0) https://dotnet.microsoft.com/download/dotnet/5.0/runtime
# Ensure you've made a '''backup''' of the "'''Data'''" folder inside the game server installation folder.
# If you're updating from A28 or earlier versions, DELETE "Data/Saves" folder as the savegame is not compatible (breaking changes). Update from A29 to any A30 (and A30 to its patch versions) '''doesn't require this step''' (savegame is compatible).
# Download the new version of the server and overwrite your current installation with it (you can find the actual download link above in the "Installation" section).
# Stop the game server (if it's running).
# Important: please '''overwrite''' both Binaries and Core folders!
# Start the server as usual.

== Server commands ==
# Ensure you're the server operator (you've edited the ServerSettings.xml file and added yourself into the server_operators_list).
# Connect to your game server.
# The game console can be toggled by pressing <code>~</code> (the key on the left from <code>1</code> key) like in old-school games (you can change the key binding for console in the controls options).
# Please add <code>/</code> (slash) prefix to the server commands you want to execute.
# You can use '''Tab''' key to fill autocomplete, and you can use '''arrow Up/Down keys''' to navigate the suggestions list. Press '''Tab''' or '''Enter''' to accept the suggestion.

Here is the page with the server commands list: [[CryoFall/Server/Commands|Server Commands List]]

== Moderation (whitelist, blacklist, kicking, muting) ==
Server operator can access special moderation commands. To invoke these commands, please ensure you're the server operator, connect to your game server, open the console (~ key) and then you can use these commands: (replace username with the actual player nickname)

Whitelist management:

<code>/mod.whiteList.add username</code>

<code>/mod.whiteList.remove username</code>

<code>/mod.whiteList.print</code>

To enable whitelist:

<code>/mod.whiteList.enabled 1</code>

Blacklist management:

<code>/mod.blackList.add username</code>

<code>/mod.blackList.remove username</code>

<code>/mod.blackList.print</code>

Kicking players (temporary removing from server and blocking from connecting):

<code>/mod.kickList.add username durationInMinutes</code>

<code>/mod.kickList.remove username</code>

<code>/mod.kickList.print</code>

Muting players (temporary removing their ability to send messages to chat):

<code>/mod.muteList.add username durationInMinutes</code>

<code>/mod.muteList.remove username</code>

<code>/mod.muteList.print</code>

== Server rates adjusting / Enabling PvP mode ==
Server rates (and PvP mode setting) are exposed in a separate config file. You can quickly change things like LP gain rate, increase item drops, reduce the player to player damage to zero, or even increase the damage from creatures and make it really tough for the players!

To adjust the server rates, stop the server and check the file <game server>/Data/ServerRates.config
Please read carefullyΓÇöall the rates are disabled and in order to apply them '''you need to remove the # char at the start of the line'''!

If you want to '''enable PvP''', search PvP in the file. By default, this setting's value is 0 and you need to change it to 1 and remove the # char at the start of the line.

For advanced modding please read [http://forums.atomictorch.com/index.php?topic=1027.0 modding prerequisites].

== Server raiding hours (for PvP) ==
'''(Please note: with A27 this feature is not recommend anymore as there is a better feature now ΓÇö S.H.I.E.L.D. protection that is enabled by default for PvP servers)'''

On PvP server, you could set up specific hours during which the raiding is possible.
 By default, offline raiding protection is not enabled so players could raid other players' bases at any time.
 To enable offline raiding protection, please use this in-game console command:
 <code>/admin.setRaidingWindow 4 14 1.5</code>
 In this code we're using (first number) +4 GMT/UTC timezone, (second number) hour of day when raiding is possible (value from 0 to 24), and (third number) is the duration of the raiding window (value from 0 to 24).
 So the code in the example will allow raiding from 14:00 (or 2PM) for 1.5 hours.
 After changing the value you could open Politics/Diplomacy menu ([P] key) and verify whether you set the correct numbers.
 Please note that Politics/Diplomacy menu displaying your local time (in your PC timezone)!

== How to prohibit client modifications ==
If you wish to restrict usage of any client modifications on your server, please find "<no_client_mods>" setting in the SettingsServer.xml file. Change the value from 0 to 1 to enable this feature. It's recommended for PvP servers to set it to 1. You can read more details about this feature in [https://atomictorch.com/Post/Id2218/A28-Justice-Update-Release A28 Update announcement].

CryoFall/Server/Setup

2021-04-29T11:01:43Z

Ai enabled: /* How to setup your own server (on any OS): */

= Local game server =
If you wish to play in single-player mode please note that the local game server was added as an experimental feature in February 2021.
 It makes it much easier to run the local server on your PC and playing on itΓÇöno further downloads and setup required and you don't need to manually type any console commands.
Please follow the [https://forums.atomictorch.com/index.php?topic=1858.msg9546#msg9546 short guide here] on how to start the local game server!

= Using game server hosting providers =

==== Game server rent service ====
''If you don't want to hassle with the game server setup, you can rent your own CryoFall server from any third party game server hosting company in just a few minutes. They provide data center locations in almost every country around the world!''
* [https://pingperfect.com/gameservers/cryofall-game-server-hosting-rental.php?aff=586 PingPerfect]
* [https://gameserver.4players.de/server-hosting/cryofall-server-mieten/ 4PLAYERS] (the website is available in German only)
''Please note that AtomicTorch Studio is not affiliated with any of these companies and not responsible for their service quality so in case of any issues please reach them directly. So far we've heard only positive feedback about their services.''

= Self-hosting =

== Requirements ==
====Hardware requirements====
(for up to about 30 players online) 1-core CPU 1.6-2 GHz, 1.5 GB RAM, 2-3 Mbit/s bandwidth (each way)
 (for up to about 100 players online) 2-core CPU 1.6-2 GHz, 2 GB RAM, 3-6 Mbit/s bandwidth
 (for up to about 200 players online) 2-core CPU 2.4-3 GHz, 2-3 GB RAM, 6-12 Mbit/s bandwidth
 (for up to about 300 players online) 2-core CPU 3+ GHz, 3-4 GB RAM, 12-20 Mbit/s bandwidth
 Usually, VPS (virtual machines) hosting such as [https://www.vultr.com/?ref=7238385 Vultr.com] (this is our referral link as we're using this company services to host our own servers) is sufficient for hosting a game server. Using 1-core machines is not recommended as the game requires a secondary CPU to ensure smooth performance without hiccups during intensive background operations (such as world snapshot saving). Using more than a 2-core machine for a single game server hosting is redundant as the game cannot utilize more than two cores due to the sequential execution of the game simulation (except networking).

====Software (system) requirements====
The server could run on Windows, Linux, and Mac.
To achieve this the game server is using .NET Runtime 5.0.
For hosting the official game servers we prefer using CentOS 7 with Docker or CentOS 8 with podman (OSS alternative to Docker).

== Server installation with Docker (best way for Linux) ==
We recommend this for Linux only. Please follow this guide [https://hub.docker.com/r/atomictorch/cryofall-server CryoFall Dedicated Server Docker Image] then return back here to '''"Server installation"''' section and follow the list after number 7. Ignore instructions on how to start the server with "dotnet" as you should use "docker run ..." instead as explained in the Docker guide above.

== Server installation / direct download (Windows, Linux, Mac) ==

==== How to setup your own server (on any OS): ====
# Install .NET Runtime 5.0 x64ΓÇöplease visit [https://dotnet.microsoft.com/download/dotnet/5.0/runtime Download .NET page] and follow the installation guide for your OS.
# Download the game server package from '''[https://atomictorch.com/Files/CryoFall_Server_v0.30.6.2_NetCore.zip SERVER DOWNLOAD LINK (any OS)]''' and extract it (it's a regular Zip archive). (on Linux you can use wget and unzip command line tools to download and extract it)
# The server package is including everything necessary to run the game server (not only executable but also "Core" folder containing the game scripts in a packaged zip archive named "Core.cpk").
# The server executable is located in the subfolder: "Binaries/Server". Open the command line/terminal/SSH (or PowerShell in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable first time with <code>loadOrNew</code> flag. The server will start and create the game world.
#:<code>dotnet CryoFall_Server.dll loadOrNew</code>
# Usually it takes about 1-2 minutes to create a new world (or load a savegame). After that the server will keep writing performance statistics information every 20 seconds among other information such as the spawn scripts reporting and network events.
# Stop the server. To do so enter the command below and press Enter key.
#:<code>stop 0</code>
#The server will save and quit. Now you have the "SettingsServer.xml" and "ModsConfig.xml" files.
# Now you need to navigate to the subfolder "Data" (in the root of the server folder, '''not''' in the "Binaries/Server") and modify "SettingsServer.xml" to set the unique server '''name''' and set other settings, etc (there are XML comments explaining every setting so it should be straightforward). ''Please note that you can (and should) edit '''Description''' and '''Welcome message''' from the '''CURRENT GAME''' menu right from the game after connecting to your server.''
# If you are interested in making your server visible in the community servers list make sure to edit <is_public_server> and change the value from 0 to 1. Also, please make sure your router is configured correctly (port forwarding) to enable other people to connect to your machine from outside. But ideally, you should use dedicated server hardware (VPS or VDS) to host public servers.
# While you're still editing "SettingsServer.xml" file, please find the value '''<server_operators_list>''' and change it to include '''your nickname'''! Otherwise, you will be unable to access your server console from the game and also you will be unable to edit the server's Description and Welcome message.
# If you want to have a custom server icon, please replace the ServerIcon.png file in the "Data" subfolder. The icon image file requirements: '''PNG24 format, 256x256 size, up to 100 KB'''.

'''Important (for Windows only):''' you need to allow the dotnet process in the Windows Firewall settingsΓÇöif the Firewall access request was not shown automatically by Windows you can add the <code>C:\Program Files\dotnet\dotnet.exe</code> file into Firewall whitelist. To do this, open Windows Start menu and search for "Allow an app through Windows Firewall" -> button "Allow another app".

==== Starting the server: ====
# Launch the command line (we recommending '''PowerShell''' in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable with <code>load</code> flag.
#:<code>dotnet CryoFall_Server.dll load</code>
# Stop your server by typing command below and pressing Enter key (it will save the world before stopping).
#:<code>stop 60 The shutdown message text goes here</code>
(Where <code>60</code> is the shutdown delay (in seconds) so the connected players will have some time to find a safe location)

'''''Please note that typing this message is really hard as the console is updating regularly! The best way is to simply copy-paste from the text editor the whole command text into the game console window (hint: you can paste in PowerShell by simply pressing the right mouse button) and pressing Enter key.'''''

You can always wipe the world by launching the game with <code>new</code> flag:
:<code>dotnet CryoFall_Server.dll new</code>

Currently, we don't support the savegame migration between the major game versions (if there are changes to the game data serialization scheme). We plan to implement the proper data migration feature ASAP.

==== Connecting to the server: ====
If you want to connect to your local game server, simply add SERVERS->Custom list as <code>localhost</code>

To connect to the public server you need to navigate to SERVERS->Community servers list (please note that this might not work if you host this server on the same PC as the client, read below).

If you're attempting to host your server on a home computer and other players cannot connect to it, you need to manually forward the port '''UDP 6000''' on your home router to '''your local IP address''' (the game has the auto port forwarding feature but it often fails due to the difference in UPnP implementation on many routers). E.g. if your PC's IP address in local network is 192.168.1.100 (you can check it with ipconfig tool or in Windows network adapter's settings) you will need to setup a port forward rule on your router to forward traffic from port 6000 UDP to port 6000 UDP on IP address 192.168.1.100.

'''If you're running a game server on the same PC as the game client:'''
 Please note that you might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its address as <code>localhost:6000</code> and connect to it directly.

'''If you're running a game server in the same local network as the game client (for example you want to play over LAN with your friends and family):'''
 You might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its local IP address (IPv4) and connect to it directly. To get your local IP address please use ipconfig command-line tool or check the network adapter properties in the network center. You need to get the local network IP address of the PC that is hosting the game server. Then add it in the custom servers list on your PC. You can lookup the IP address in the Windows network settings or by using CMD tool called ipconfig in Windows. For example, here we've run the ipconfig tool here and see the IPv4 address as 192.168.1.200 ([https://cdn.discordapp.com/attachments/421250395298332672/739147674367950908/Screenshot_at_19-48-06.png screenshot]). We can use it on any other PC in the local network to connect to that PC hosting the game server.

Connecting to the private servers requires adding it via the Custom servers menu.

6000 is the default port but you can change it in the Data/SettingsServer.xml file.

== Server update/upgrade to new version ==
When we're releasing a new version of the game server, you need to follow these steps to update it:
# (If you have not done this) Install ".NET Runtime" (version 5.0) https://dotnet.microsoft.com/download/dotnet/5.0/runtime
# Ensure you've made a '''backup''' of the "'''Data'''" folder inside the game server installation folder.
# If you're updating from A28 or earlier versions, DELETE "Data/Saves" folder as the savegame is not compatible (breaking changes). Update from A29 to any A30 (and A30 to its patch versions) '''doesn't require this step''' (savegame is compatible).
# Download the new version of the server and overwrite your current installation with it (you can find the actual download link above in the "Installation" section).
# Stop the game server (if it's running).
# Important: please '''overwrite''' both Binaries and Core folders!
# Start the server as usual.

== Server commands ==
# Ensure you're the server operator (you've edited the ServerSettings.xml file and added yourself into the server_operators_list).
# Connect to your game server.
# The game console can be toggled by pressing <code>~</code> (the key on the left from <code>1</code> key) like in old-school games (you can change the key binding for console in the controls options).
# Please add <code>/</code> (slash) prefix to the server commands you want to execute.
# You can use '''Tab''' key to fill autocomplete, and you can use '''arrow Up/Down keys''' to navigate the suggestions list. Press '''Tab''' or '''Enter''' to accept the suggestion.

Here is the page with the server commands list: [[CryoFall/Server/Commands|Server Commands List]]

== Moderation (whitelist, blacklist, kicking, muting) ==
Server operator can access special moderation commands. To invoke these commands, please ensure you're the server operator, connect to your game server, open the console (~ key) and then you can use these commands: (replace username with the actual player nickname)

Whitelist management:

<code>/mod.whiteList.add username</code>

<code>/mod.whiteList.remove username</code>

<code>/mod.whiteList.print</code>

To enable whitelist:

<code>/mod.whiteList.enabled 1</code>

Blacklist management:

<code>/mod.blackList.add username</code>

<code>/mod.blackList.remove username</code>

<code>/mod.blackList.print</code>

Kicking players (temporary removing from server and blocking from connecting):

<code>/mod.kickList.add username durationInMinutes</code>

<code>/mod.kickList.remove username</code>

<code>/mod.kickList.print</code>

Muting players (temporary removing their ability to send messages to chat):

<code>/mod.muteList.add username durationInMinutes</code>

<code>/mod.muteList.remove username</code>

<code>/mod.muteList.print</code>

== Server rates adjusting / Enabling PvP mode ==
Server rates (and PvP mode setting) are exposed in a separate config file. You can quickly change things like LP gain rate, increase item drops, reduce the player to player damage to zero, or even increase the damage from creatures and make it really tough for the players!

To adjust the server rates, stop the server and check the file <game server>/Data/ServerRates.config
Please read carefullyΓÇöall the rates are disabled and in order to apply them '''you need to remove the # char at the start of the line'''!

If you want to '''enable PvP''', search PvP in the file. By default, this setting's value is 0 and you need to change it to 1 and remove the # char at the start of the line.

For advanced modding please read [http://forums.atomictorch.com/index.php?topic=1027.0 modding prerequisites].

== Server raiding hours (for PvP) ==
'''(Please note: with A27 this feature is not recommend anymore as there is a better feature now ΓÇö S.H.I.E.L.D. protection that is enabled by default for PvP servers)'''

On PvP server, you could set up specific hours during which the raiding is possible.
 By default, offline raiding protection is not enabled so players could raid other players' bases at any time.
 To enable offline raiding protection, please use this in-game console command:
 <code>/admin.setRaidingWindow 4 14 1.5</code>
 In this code we're using (first number) +4 GMT/UTC timezone, (second number) hour of day when raiding is possible (value from 0 to 24), and (third number) is the duration of the raiding window (value from 0 to 24).
 So the code in the example will allow raiding from 14:00 (or 2PM) for 1.5 hours.
 After changing the value you could open Politics/Diplomacy menu ([P] key) and verify whether you set the correct numbers.
 Please note that Politics/Diplomacy menu displaying your local time (in your PC timezone)!

== How to prohibit client modifications ==
If you wish to restrict usage of any client modifications on your server, please find "<no_client_mods>" setting in the SettingsServer.xml file. Change the value from 0 to 1 to enable this feature. It's recommended for PvP servers to set it to 1. You can read more details about this feature in [https://atomictorch.com/Post/Id2218/A28-Justice-Update-Release A28 Update announcement].

CryoFall/Server/Setup

2021-04-19T22:43:11Z

Ai enabled: /* How to setup your own server (on any OS): */

= Local game server =
If you wish to play in single-player mode please note that the local game server was added as an experimental feature in February 2021.
 It makes it much easier to run the local server on your PC and playing on itΓÇöno further downloads and setup required and you don't need to manually type any console commands.
Please follow the [https://forums.atomictorch.com/index.php?topic=1858.msg9546#msg9546 short guide here] on how to start the local game server!

= Using game server hosting providers =

==== Game server rent service ====
''If you don't want to hassle with the game server setup, you can rent your own CryoFall server from any third party game server hosting company in just a few minutes. They provide data center locations in almost every country around the world!''
* [https://pingperfect.com/gameservers/cryofall-game-server-hosting-rental.php?aff=586 PingPerfect]
* [https://gameserver.4players.de/server-hosting/cryofall-server-mieten/ 4PLAYERS] (the website is available in German only)
''Please note that AtomicTorch Studio is not affiliated with any of these companies and not responsible for their service quality so in case of any issues please reach them directly. So far we've heard only positive feedback about their services.''

= Self-hosting =

== Requirements ==
====Hardware requirements====
(for up to about 30 players online) 1-core CPU 1.6-2 GHz, 1.5 GB RAM, 2-3 Mbit/s bandwidth (each way)
 (for up to about 100 players online) 2-core CPU 1.6-2 GHz, 2 GB RAM, 3-6 Mbit/s bandwidth
 (for up to about 200 players online) 2-core CPU 2.4-3 GHz, 2-3 GB RAM, 6-12 Mbit/s bandwidth
 (for up to about 300 players online) 2-core CPU 3+ GHz, 3-4 GB RAM, 12-20 Mbit/s bandwidth
 Usually, VPS (virtual machines) hosting such as [https://www.vultr.com/?ref=7238385 Vultr.com] (this is our referral link as we're using this company services to host our own servers) is sufficient for hosting a game server. Using 1-core machines is not recommended as the game requires a secondary CPU to ensure smooth performance without hiccups during intensive background operations (such as world snapshot saving). Using more than a 2-core machine for a single game server hosting is redundant as the game cannot utilize more than two cores due to the sequential execution of the game simulation (except networking).

====Software (system) requirements====
The server could run on Windows, Linux, and Mac.
To achieve this the game server is using .NET Runtime 5.0.
For hosting the official game servers we prefer using CentOS 7 with Docker or CentOS 8 with podman (OSS alternative to Docker).

== Server installation with Docker (best way for Linux) ==
We recommend this for Linux only. Please follow this guide [https://hub.docker.com/r/atomictorch/cryofall-server CryoFall Dedicated Server Docker Image] then return back here to '''"Server installation"''' section and follow the list after number 7. Ignore instructions on how to start the server with "dotnet" as you should use "docker run ..." instead as explained in the Docker guide above.

== Server installation / direct download (Windows, Linux, Mac) ==

==== How to setup your own server (on any OS): ====
# Install .NET Runtime 5.0ΓÇöplease visit [https://dotnet.microsoft.com/download/dotnet/5.0/runtime Download .NET page] and follow the installation guide for your OS.
# Download the game server package from '''[https://atomictorch.com/Files/CryoFall_Server_v0.30.6.2_NetCore.zip SERVER DOWNLOAD LINK (any OS)]''' and extract it (it's a regular Zip archive). (on Linux you can use wget and unzip command line tools to download and extract it)
# The server package is including everything necessary to run the game server (not only executable but also "Core" folder containing the game scripts in a packaged zip archive named "Core.cpk").
# The server executable is located in the subfolder: "Binaries/Server". Open the command line/terminal/SSH (or PowerShell in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable first time with <code>loadOrNew</code> flag. The server will start and create the game world.
#:<code>dotnet CryoFall_Server.dll loadOrNew</code>
# Usually it takes about 1-2 minutes to create a new world (or load a savegame). After that the server will keep writing performance statistics information every 20 seconds among other information such as the spawn scripts reporting and network events.
# Stop the server. To do so enter the command below and press Enter key.
#:<code>stop 0</code>
#The server will save and quit. Now you have the "SettingsServer.xml" and "ModsConfig.xml" files.
# Now you need to navigate to the subfolder "Data" (in the root of the server folder, '''not''' in the "Binaries/Server") and modify "SettingsServer.xml" to set the unique server '''name''' and set other settings, etc (there are XML comments explaining every setting so it should be straightforward). ''Please note that you can (and should) edit '''Description''' and '''Welcome message''' from the '''CURRENT GAME''' menu right from the game after connecting to your server.''
# If you are interested in making your server visible in the community servers list make sure to edit <is_public_server> and change the value from 0 to 1. Also, please make sure your router is configured correctly (port forwarding) to enable other people to connect to your machine from outside. But ideally, you should use dedicated server hardware (VPS or VDS) to host public servers.
# While you're still editing "SettingsServer.xml" file, please find the value '''<server_operators_list>''' and change it to include '''your nickname'''! Otherwise, you will be unable to access your server console from the game and also you will be unable to edit the server's Description and Welcome message.
# If you want to have a custom server icon, please replace the ServerIcon.png file in the "Data" subfolder. The icon image file requirements: '''PNG24 format, 256x256 size, up to 100 KB'''.

'''Important (for Windows only):''' you need to allow the dotnet process in the Windows Firewall settingsΓÇöif the Firewall access request was not shown automatically by Windows you can add the <code>C:\Program Files\dotnet\dotnet.exe</code> file into Firewall whitelist. To do this, open Windows Start menu and search for "Allow an app through Windows Firewall" -> button "Allow another app".

==== Starting the server: ====
# Launch the command line (we recommending '''PowerShell''' in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable with <code>load</code> flag.
#:<code>dotnet CryoFall_Server.dll load</code>
# Stop your server by typing command below and pressing Enter key (it will save the world before stopping).
#:<code>stop 60 The shutdown message text goes here</code>
(Where <code>60</code> is the shutdown delay (in seconds) so the connected players will have some time to find a safe location)

'''''Please note that typing this message is really hard as the console is updating regularly! The best way is to simply copy-paste from the text editor the whole command text into the game console window (hint: you can paste in PowerShell by simply pressing the right mouse button) and pressing Enter key.'''''

You can always wipe the world by launching the game with <code>new</code> flag:
:<code>dotnet CryoFall_Server.dll new</code>

Currently, we don't support the savegame migration between the major game versions (if there are changes to the game data serialization scheme). We plan to implement the proper data migration feature ASAP.

==== Connecting to the server: ====
If you want to connect to your local game server, simply add SERVERS->Custom list as <code>localhost</code>

To connect to the public server you need to navigate to SERVERS->Community servers list (please note that this might not work if you host this server on the same PC as the client, read below).

If you're attempting to host your server on a home computer and other players cannot connect to it, you need to manually forward the port '''UDP 6000''' on your home router to '''your local IP address''' (the game has the auto port forwarding feature but it often fails due to the difference in UPnP implementation on many routers). E.g. if your PC's IP address in local network is 192.168.1.100 (you can check it with ipconfig tool or in Windows network adapter's settings) you will need to setup a port forward rule on your router to forward traffic from port 6000 UDP to port 6000 UDP on IP address 192.168.1.100.

'''If you're running a game server on the same PC as the game client:'''
 Please note that you might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its address as <code>localhost:6000</code> and connect to it directly.

'''If you're running a game server in the same local network as the game client (for example you want to play over LAN with your friends and family):'''
 You might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its local IP address (IPv4) and connect to it directly. To get your local IP address please use ipconfig command-line tool or check the network adapter properties in the network center. You need to get the local network IP address of the PC that is hosting the game server. Then add it in the custom servers list on your PC. You can lookup the IP address in the Windows network settings or by using CMD tool called ipconfig in Windows. For example, here we've run the ipconfig tool here and see the IPv4 address as 192.168.1.200 ([https://cdn.discordapp.com/attachments/421250395298332672/739147674367950908/Screenshot_at_19-48-06.png screenshot]). We can use it on any other PC in the local network to connect to that PC hosting the game server.

Connecting to the private servers requires adding it via the Custom servers menu.

6000 is the default port but you can change it in the Data/SettingsServer.xml file.

== Server update/upgrade to new version ==
When we're releasing a new version of the game server, you need to follow these steps to update it:
# (If you have not done this) Install ".NET Runtime" (version 5.0) https://dotnet.microsoft.com/download/dotnet/5.0/runtime
# Ensure you've made a '''backup''' of the "'''Data'''" folder inside the game server installation folder.
# If you're updating from A28 or earlier versions, DELETE "Data/Saves" folder as the savegame is not compatible (breaking changes). Update from A29 to any A30 (and A30 to its patch versions) '''doesn't require this step''' (savegame is compatible).
# Download the new version of the server and overwrite your current installation with it (you can find the actual download link above in the "Installation" section).
# Stop the game server (if it's running).
# Important: please '''overwrite''' both Binaries and Core folders!
# Start the server as usual.

== Server commands ==
# Ensure you're the server operator (you've edited the ServerSettings.xml file and added yourself into the server_operators_list).
# Connect to your game server.
# The game console can be toggled by pressing <code>~</code> (the key on the left from <code>1</code> key) like in old-school games (you can change the key binding for console in the controls options).
# Please add <code>/</code> (slash) prefix to the server commands you want to execute.
# You can use '''Tab''' key to fill autocomplete, and you can use '''arrow Up/Down keys''' to navigate the suggestions list. Press '''Tab''' or '''Enter''' to accept the suggestion.

Here is the page with the server commands list: [[CryoFall/Server/Commands|Server Commands List]]

== Moderation (whitelist, blacklist, kicking, muting) ==
Server operator can access special moderation commands. To invoke these commands, please ensure you're the server operator, connect to your game server, open the console (~ key) and then you can use these commands: (replace username with the actual player nickname)

Whitelist management:

<code>/mod.whiteList.add username</code>

<code>/mod.whiteList.remove username</code>

<code>/mod.whiteList.print</code>

To enable whitelist:

<code>/mod.whiteList.enabled 1</code>

Blacklist management:

<code>/mod.blackList.add username</code>

<code>/mod.blackList.remove username</code>

<code>/mod.blackList.print</code>

Kicking players (temporary removing from server and blocking from connecting):

<code>/mod.kickList.add username durationInMinutes</code>

<code>/mod.kickList.remove username</code>

<code>/mod.kickList.print</code>

Muting players (temporary removing their ability to send messages to chat):

<code>/mod.muteList.add username durationInMinutes</code>

<code>/mod.muteList.remove username</code>

<code>/mod.muteList.print</code>

== Server rates adjusting / Enabling PvP mode ==
Server rates (and PvP mode setting) are exposed in a separate config file. You can quickly change things like LP gain rate, increase item drops, reduce the player to player damage to zero, or even increase the damage from creatures and make it really tough for the players!

To adjust the server rates, stop the server and check the file <game server>/Data/ServerRates.config
Please read carefullyΓÇöall the rates are disabled and in order to apply them '''you need to remove the # char at the start of the line'''!

If you want to '''enable PvP''', search PvP in the file. By default, this setting's value is 0 and you need to change it to 1 and remove the # char at the start of the line.

For advanced modding please read [http://forums.atomictorch.com/index.php?topic=1027.0 modding prerequisites].

== Server raiding hours (for PvP) ==
'''(Please note: with A27 this feature is not recommend anymore as there is a better feature now ΓÇö S.H.I.E.L.D. protection that is enabled by default for PvP servers)'''

On PvP server, you could set up specific hours during which the raiding is possible.
 By default, offline raiding protection is not enabled so players could raid other players' bases at any time.
 To enable offline raiding protection, please use this in-game console command:
 <code>/admin.setRaidingWindow 4 14 1.5</code>
 In this code we're using (first number) +4 GMT/UTC timezone, (second number) hour of day when raiding is possible (value from 0 to 24), and (third number) is the duration of the raiding window (value from 0 to 24).
 So the code in the example will allow raiding from 14:00 (or 2PM) for 1.5 hours.
 After changing the value you could open Politics/Diplomacy menu ([P] key) and verify whether you set the correct numbers.
 Please note that Politics/Diplomacy menu displaying your local time (in your PC timezone)!

== How to prohibit client modifications ==
If you wish to restrict usage of any client modifications on your server, please find "<no_client_mods>" setting in the SettingsServer.xml file. Change the value from 0 to 1 to enable this feature. It's recommended for PvP servers to set it to 1. You can read more details about this feature in [https://atomictorch.com/Post/Id2218/A28-Justice-Update-Release A28 Update announcement].

CryoFall/Server/Setup

2021-04-16T12:29:10Z

Ai enabled: /* How to setup your own server (on any OS): */

= Local game server =
If you wish to play in single-player mode please note that the local game server was added as an experimental feature in February 2021.
 It makes it much easier to run the local server on your PC and playing on itΓÇöno further downloads and setup required and you don't need to manually type any console commands.
Please follow the [https://forums.atomictorch.com/index.php?topic=1858.msg9546#msg9546 short guide here] on how to start the local game server!

= Using game server hosting providers =

==== Game server rent service ====
''If you don't want to hassle with the game server setup, you can rent your own CryoFall server from any third party game server hosting company in just a few minutes. They provide data center locations in almost every country around the world!''
* [https://pingperfect.com/gameservers/cryofall-game-server-hosting-rental.php?aff=586 PingPerfect]
* [https://gameserver.4players.de/server-hosting/cryofall-server-mieten/ 4PLAYERS] (the website is available in German only)
''Please note that AtomicTorch Studio is not affiliated with any of these companies and not responsible for their service quality so in case of any issues please reach them directly. So far we've heard only positive feedback about their services.''

= Self-hosting =

== Requirements ==
====Hardware requirements====
(for up to about 30 players online) 1-core CPU 1.6-2 GHz, 1.5 GB RAM, 2-3 Mbit/s bandwidth (each way)
 (for up to about 100 players online) 2-core CPU 1.6-2 GHz, 2 GB RAM, 3-6 Mbit/s bandwidth
 (for up to about 200 players online) 2-core CPU 2.4-3 GHz, 2-3 GB RAM, 6-12 Mbit/s bandwidth
 (for up to about 300 players online) 2-core CPU 3+ GHz, 3-4 GB RAM, 12-20 Mbit/s bandwidth
 Usually, VPS (virtual machines) hosting such as [https://www.vultr.com/?ref=7238385 Vultr.com] (this is our referral link as we're using this company services to host our own servers) is sufficient for hosting a game server. Using 1-core machines is not recommended as the game requires a secondary CPU to ensure smooth performance without hiccups during intensive background operations (such as world snapshot saving). Using more than a 2-core machine for a single game server hosting is redundant as the game cannot utilize more than two cores due to the sequential execution of the game simulation (except networking).

====Software (system) requirements====
The server could run on Windows, Linux, and Mac.
To achieve this the game server is using .NET Runtime 5.0.
For hosting the official game servers we prefer using CentOS 7 with Docker or CentOS 8 with podman (OSS alternative to Docker).

== Server installation with Docker (best way for Linux) ==
We recommend this for Linux only. Please follow this guide [https://hub.docker.com/r/atomictorch/cryofall-server CryoFall Dedicated Server Docker Image] then return back here to '''"Server installation"''' section and follow the list after number 7. Ignore instructions on how to start the server with "dotnet" as you should use "docker run ..." instead as explained in the Docker guide above.

== Server installation / direct download (Windows, Linux, Mac) ==

==== How to setup your own server (on any OS): ====
# Install .NET Runtime 5.0ΓÇöplease visit [https://dotnet.microsoft.com/download/dotnet/5.0/runtime Download .NET page] and follow the installation guide for your OS.
# Download the game server package from '''[https://atomictorch.com/Files/CryoFall_Server_v0.30.6.1_NetCore.zip SERVER DOWNLOAD LINK (any OS)]''' and extract it (it's a regular Zip archive). (on Linux you can use wget and unzip command line tools to download and extract it)
# The server package is including everything necessary to run the game server (not only executable but also "Core" folder containing the game scripts in a packaged zip archive named "Core.cpk").
# The server executable is located in the subfolder: "Binaries/Server". Open the command line/terminal/SSH (or PowerShell in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable first time with <code>loadOrNew</code> flag. The server will start and create the game world.
#:<code>dotnet CryoFall_Server.dll loadOrNew</code>
# Usually it takes about 1-2 minutes to create a new world (or load a savegame). After that the server will keep writing performance statistics information every 20 seconds among other information such as the spawn scripts reporting and network events.
# Stop the server. To do so enter the command below and press Enter key.
#:<code>stop 0</code>
#The server will save and quit. Now you have the "SettingsServer.xml" and "ModsConfig.xml" files.
# Now you need to navigate to the subfolder "Data" (in the root of the server folder, '''not''' in the "Binaries/Server") and modify "SettingsServer.xml" to set the unique server '''name''' and set other settings, etc (there are XML comments explaining every setting so it should be straightforward). ''Please note that you can (and should) edit '''Description''' and '''Welcome message''' from the '''CURRENT GAME''' menu right from the game after connecting to your server.''
# If you are interested in making your server visible in the community servers list make sure to edit <is_public_server> and change the value from 0 to 1. Also, please make sure your router is configured correctly (port forwarding) to enable other people to connect to your machine from outside. But ideally, you should use dedicated server hardware (VPS or VDS) to host public servers.
# While you're still editing "SettingsServer.xml" file, please find the value '''<server_operators_list>''' and change it to include '''your nickname'''! Otherwise, you will be unable to access your server console from the game and also you will be unable to edit the server's Description and Welcome message.
# If you want to have a custom server icon, please replace the ServerIcon.png file in the "Data" subfolder. The icon image file requirements: '''PNG24 format, 256x256 size, up to 100 KB'''.

'''Important (for Windows only):''' you need to allow the dotnet process in the Windows Firewall settingsΓÇöif the Firewall access request was not shown automatically by Windows you can add the <code>C:\Program Files\dotnet\dotnet.exe</code> file into Firewall whitelist. To do this, open Windows Start menu and search for "Allow an app through Windows Firewall" -> button "Allow another app".

==== Starting the server: ====
# Launch the command line (we recommending '''PowerShell''' in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable with <code>load</code> flag.
#:<code>dotnet CryoFall_Server.dll load</code>
# Stop your server by typing command below and pressing Enter key (it will save the world before stopping).
#:<code>stop 60 The shutdown message text goes here</code>
(Where <code>60</code> is the shutdown delay (in seconds) so the connected players will have some time to find a safe location)

'''''Please note that typing this message is really hard as the console is updating regularly! The best way is to simply copy-paste from the text editor the whole command text into the game console window (hint: you can paste in PowerShell by simply pressing the right mouse button) and pressing Enter key.'''''

You can always wipe the world by launching the game with <code>new</code> flag:
:<code>dotnet CryoFall_Server.dll new</code>

Currently, we don't support the savegame migration between the major game versions (if there are changes to the game data serialization scheme). We plan to implement the proper data migration feature ASAP.

==== Connecting to the server: ====
If you want to connect to your local game server, simply add SERVERS->Custom list as <code>localhost</code>

To connect to the public server you need to navigate to SERVERS->Community servers list (please note that this might not work if you host this server on the same PC as the client, read below).

If you're attempting to host your server on a home computer and other players cannot connect to it, you need to manually forward the port '''UDP 6000''' on your home router to '''your local IP address''' (the game has the auto port forwarding feature but it often fails due to the difference in UPnP implementation on many routers). E.g. if your PC's IP address in local network is 192.168.1.100 (you can check it with ipconfig tool or in Windows network adapter's settings) you will need to setup a port forward rule on your router to forward traffic from port 6000 UDP to port 6000 UDP on IP address 192.168.1.100.

'''If you're running a game server on the same PC as the game client:'''
 Please note that you might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its address as <code>localhost:6000</code> and connect to it directly.

'''If you're running a game server in the same local network as the game client (for example you want to play over LAN with your friends and family):'''
 You might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its local IP address (IPv4) and connect to it directly. To get your local IP address please use ipconfig command-line tool or check the network adapter properties in the network center. You need to get the local network IP address of the PC that is hosting the game server. Then add it in the custom servers list on your PC. You can lookup the IP address in the Windows network settings or by using CMD tool called ipconfig in Windows. For example, here we've run the ipconfig tool here and see the IPv4 address as 192.168.1.200 ([https://cdn.discordapp.com/attachments/421250395298332672/739147674367950908/Screenshot_at_19-48-06.png screenshot]). We can use it on any other PC in the local network to connect to that PC hosting the game server.

Connecting to the private servers requires adding it via the Custom servers menu.

6000 is the default port but you can change it in the Data/SettingsServer.xml file.

== Server update/upgrade to new version ==
When we're releasing a new version of the game server, you need to follow these steps to update it:
# (If you have not done this) Install ".NET Runtime" (version 5.0) https://dotnet.microsoft.com/download/dotnet/5.0/runtime
# Ensure you've made a '''backup''' of the "'''Data'''" folder inside the game server installation folder.
# If you're updating from A28 or earlier versions, DELETE "Data/Saves" folder as the savegame is not compatible (breaking changes). Update from A29 to any A30 (and A30 to its patch versions) '''doesn't require this step''' (savegame is compatible).
# Download the new version of the server and overwrite your current installation with it (you can find the actual download link above in the "Installation" section).
# Stop the game server (if it's running).
# Important: please '''overwrite''' both Binaries and Core folders!
# Start the server as usual.

== Server commands ==
# Ensure you're the server operator (you've edited the ServerSettings.xml file and added yourself into the server_operators_list).
# Connect to your game server.
# The game console can be toggled by pressing <code>~</code> (the key on the left from <code>1</code> key) like in old-school games (you can change the key binding for console in the controls options).
# Please add <code>/</code> (slash) prefix to the server commands you want to execute.
# You can use '''Tab''' key to fill autocomplete, and you can use '''arrow Up/Down keys''' to navigate the suggestions list. Press '''Tab''' or '''Enter''' to accept the suggestion.

Here is the page with the server commands list: [[CryoFall/Server/Commands|Server Commands List]]

== Moderation (whitelist, blacklist, kicking, muting) ==
Server operator can access special moderation commands. To invoke these commands, please ensure you're the server operator, connect to your game server, open the console (~ key) and then you can use these commands: (replace username with the actual player nickname)

Whitelist management:

<code>/mod.whiteList.add username</code>

<code>/mod.whiteList.remove username</code>

<code>/mod.whiteList.print</code>

To enable whitelist:

<code>/mod.whiteList.enabled 1</code>

Blacklist management:

<code>/mod.blackList.add username</code>

<code>/mod.blackList.remove username</code>

<code>/mod.blackList.print</code>

Kicking players (temporary removing from server and blocking from connecting):

<code>/mod.kickList.add username durationInMinutes</code>

<code>/mod.kickList.remove username</code>

<code>/mod.kickList.print</code>

Muting players (temporary removing their ability to send messages to chat):

<code>/mod.muteList.add username durationInMinutes</code>

<code>/mod.muteList.remove username</code>

<code>/mod.muteList.print</code>

== Server rates adjusting / Enabling PvP mode ==
Server rates (and PvP mode setting) are exposed in a separate config file. You can quickly change things like LP gain rate, increase item drops, reduce the player to player damage to zero, or even increase the damage from creatures and make it really tough for the players!

To adjust the server rates, stop the server and check the file <game server>/Data/ServerRates.config
Please read carefullyΓÇöall the rates are disabled and in order to apply them '''you need to remove the # char at the start of the line'''!

If you want to '''enable PvP''', search PvP in the file. By default, this setting's value is 0 and you need to change it to 1 and remove the # char at the start of the line.

For advanced modding please read [http://forums.atomictorch.com/index.php?topic=1027.0 modding prerequisites].

== Server raiding hours (for PvP) ==
'''(Please note: with A27 this feature is not recommend anymore as there is a better feature now ΓÇö S.H.I.E.L.D. protection that is enabled by default for PvP servers)'''

On PvP server, you could set up specific hours during which the raiding is possible.
 By default, offline raiding protection is not enabled so players could raid other players' bases at any time.
 To enable offline raiding protection, please use this in-game console command:
 <code>/admin.setRaidingWindow 4 14 1.5</code>
 In this code we're using (first number) +4 GMT/UTC timezone, (second number) hour of day when raiding is possible (value from 0 to 24), and (third number) is the duration of the raiding window (value from 0 to 24).
 So the code in the example will allow raiding from 14:00 (or 2PM) for 1.5 hours.
 After changing the value you could open Politics/Diplomacy menu ([P] key) and verify whether you set the correct numbers.
 Please note that Politics/Diplomacy menu displaying your local time (in your PC timezone)!

== How to prohibit client modifications ==
If you wish to restrict usage of any client modifications on your server, please find "<no_client_mods>" setting in the SettingsServer.xml file. Change the value from 0 to 1 to enable this feature. It's recommended for PvP servers to set it to 1. You can read more details about this feature in [https://atomictorch.com/Post/Id2218/A28-Justice-Update-Release A28 Update announcement].

CryoFall/Server/Setup

2021-04-15T22:11:11Z

Ai enabled: /* Server rates adjusting / Enabling PvP mode */

= Local game server =
If you wish to play in single-player mode please note that the local game server was added as an experimental feature in February 2021.
 It makes it much easier to run the local server on your PC and playing on itΓÇöno further downloads and setup required and you don't need to manually type any console commands.
Please follow the [https://forums.atomictorch.com/index.php?topic=1858.msg9546#msg9546 short guide here] on how to start the local game server!

= Using game server hosting providers =

==== Game server rent service ====
''If you don't want to hassle with the game server setup, you can rent your own CryoFall server from any third party game server hosting company in just a few minutes. They provide data center locations in almost every country around the world!''
* [https://pingperfect.com/gameservers/cryofall-game-server-hosting-rental.php?aff=586 PingPerfect]
* [https://gameserver.4players.de/server-hosting/cryofall-server-mieten/ 4PLAYERS] (the website is available in German only)
''Please note that AtomicTorch Studio is not affiliated with any of these companies and not responsible for their service quality so in case of any issues please reach them directly. So far we've heard only positive feedback about their services.''

= Self-hosting =

== Requirements ==
====Hardware requirements====
(for up to about 30 players online) 1-core CPU 1.6-2 GHz, 1.5 GB RAM, 2-3 Mbit/s bandwidth (each way)
 (for up to about 100 players online) 2-core CPU 1.6-2 GHz, 2 GB RAM, 3-6 Mbit/s bandwidth
 (for up to about 200 players online) 2-core CPU 2.4-3 GHz, 2-3 GB RAM, 6-12 Mbit/s bandwidth
 (for up to about 300 players online) 2-core CPU 3+ GHz, 3-4 GB RAM, 12-20 Mbit/s bandwidth
 Usually, VPS (virtual machines) hosting such as [https://www.vultr.com/?ref=7238385 Vultr.com] (this is our referral link as we're using this company services to host our own servers) is sufficient for hosting a game server. Using 1-core machines is not recommended as the game requires a secondary CPU to ensure smooth performance without hiccups during intensive background operations (such as world snapshot saving). Using more than a 2-core machine for a single game server hosting is redundant as the game cannot utilize more than two cores due to the sequential execution of the game simulation (except networking).

====Software (system) requirements====
The server could run on Windows, Linux, and Mac.
To achieve this the game server is using .NET Runtime 5.0.
For hosting the official game servers we prefer using CentOS 7 with Docker or CentOS 8 with podman (OSS alternative to Docker).

== Server installation with Docker (best way for Linux) ==
We recommend this for Linux only. Please follow this guide [https://hub.docker.com/r/atomictorch/cryofall-server CryoFall Dedicated Server Docker Image] then return back here to '''"Server installation"''' section and follow the list after number 7. Ignore instructions on how to start the server with "dotnet" as you should use "docker run ..." instead as explained in the Docker guide above.

== Server installation / direct download (Windows, Linux, Mac) ==

==== How to setup your own server (on any OS): ====
# Install .NET Runtime 5.0ΓÇöplease visit [https://dotnet.microsoft.com/download/dotnet/5.0/runtime Download .NET page] and follow the installation guide for your OS.
# Download the game server package from '''[https://atomictorch.com/Files/CryoFall_Server_v0.29.12.13_NetCore.zip SERVER DOWNLOAD LINK (any OS)]''' and extract it (it's a regular Zip archive). (on Linux you can use wget and unzip command line tools to download and extract it)
# The server package is including everything necessary to run the game server (not only executable but also "Core" folder containing the game scripts in a packaged zip archive named "Core.cpk").
# The server executable is located in the subfolder: "Binaries/Server". Open the command line/terminal/SSH (or PowerShell in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable first time with <code>loadOrNew</code> flag. The server will start and create the game world.
#:<code>dotnet CryoFall_Server.dll loadOrNew</code>
# Usually it takes about 1-2 minutes to create a new world (or load a savegame). After that the server will keep writing performance statistics information every 20 seconds among other information such as the spawn scripts reporting and network events.
# Stop the server. To do so enter the command below and press Enter key.
#:<code>stop 0</code>
#The server will save and quit. Now you have the "SettingsServer.xml" and "ModsConfig.xml" files.
# Now you need to navigate to the subfolder "Data" (in the root of the server folder, '''not''' in the "Binaries/Server") and modify "SettingsServer.xml" to set the unique server '''name''' and set other settings, etc (there are XML comments explaining every setting so it should be straightforward). ''Please note that you can (and should) edit '''Description''' and '''Welcome message''' from the '''CURRENT GAME''' menu right from the game after connecting to your server.''
# If you are interested in making your server visible in the community servers list make sure to edit <is_public_server> and change the value from 0 to 1. Also, please make sure your router is configured correctly (port forwarding) to enable other people to connect to your machine from outside. But ideally, you should use dedicated server hardware (VPS or VDS) to host public servers.
# While you're still editing "SettingsServer.xml" file, please find the value '''<server_operators_list>''' and change it to include '''your nickname'''! Otherwise, you will be unable to access your server console from the game and also you will be unable to edit the server's Description and Welcome message.
# If you want to have a custom server icon, please replace the ServerIcon.png file in the "Data" subfolder. The icon image file requirements: '''PNG24 format, 256x256 size, up to 100 KB'''.

'''Important (for Windows only):''' you need to allow the dotnet process in the Windows Firewall settingsΓÇöif the Firewall access request was not shown automatically by Windows you can add the <code>C:\Program Files\dotnet\dotnet.exe</code> file into Firewall whitelist. To do this, open Windows Start menu and search for "Allow an app through Windows Firewall" -> button "Allow another app".

==== Starting the server: ====
# Launch the command line (we recommending '''PowerShell''' in Windows) and navigate to this folder (hint: in Windows you can simply '''SHIFT + Right-click''' on the "Server" folder in Explorer and select "Open PowerShell window here").
# Start the server executable with <code>load</code> flag.
#:<code>dotnet CryoFall_Server.dll load</code>
# Stop your server by typing command below and pressing Enter key (it will save the world before stopping).
#:<code>stop 60 The shutdown message text goes here</code>
(Where <code>60</code> is the shutdown delay (in seconds) so the connected players will have some time to find a safe location)

'''''Please note that typing this message is really hard as the console is updating regularly! The best way is to simply copy-paste from the text editor the whole command text into the game console window (hint: you can paste in PowerShell by simply pressing the right mouse button) and pressing Enter key.'''''

You can always wipe the world by launching the game with <code>new</code> flag:
:<code>dotnet CryoFall_Server.dll new</code>

Currently, we don't support the savegame migration between the major game versions (if there are changes to the game data serialization scheme). We plan to implement the proper data migration feature ASAP.

==== Connecting to the server: ====
If you want to connect to your local game server, simply add SERVERS->Custom list as <code>localhost</code>

To connect to the public server you need to navigate to SERVERS->Community servers list (please note that this might not work if you host this server on the same PC as the client, read below).

If you're attempting to host your server on a home computer and other players cannot connect to it, you need to manually forward the port '''UDP 6000''' on your home router to '''your local IP address''' (the game has the auto port forwarding feature but it often fails due to the difference in UPnP implementation on many routers). E.g. if your PC's IP address in local network is 192.168.1.100 (you can check it with ipconfig tool or in Windows network adapter's settings) you will need to setup a port forward rule on your router to forward traffic from port 6000 UDP to port 6000 UDP on IP address 192.168.1.100.

'''If you're running a game server on the same PC as the game client:'''
 Please note that you might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its address as <code>localhost:6000</code> and connect to it directly.

'''If you're running a game server in the same local network as the game client (for example you want to play over LAN with your friends and family):'''
 You might be unable to connect to the game server from the Community servers list on that PC due to NAT routing even with the proper port forwarding. In that case, simply add your server into the client custom servers list by providing its local IP address (IPv4) and connect to it directly. To get your local IP address please use ipconfig command-line tool or check the network adapter properties in the network center. You need to get the local network IP address of the PC that is hosting the game server. Then add it in the custom servers list on your PC. You can lookup the IP address in the Windows network settings or by using CMD tool called ipconfig in Windows. For example, here we've run the ipconfig tool here and see the IPv4 address as 192.168.1.200 ([https://cdn.discordapp.com/attachments/421250395298332672/739147674367950908/Screenshot_at_19-48-06.png screenshot]). We can use it on any other PC in the local network to connect to that PC hosting the game server.

Connecting to the private servers requires adding it via the Custom servers menu.

6000 is the default port but you can change it in the Data/SettingsServer.xml file.

== Server update/upgrade to new version ==
When we're releasing a new version of the game server, you need to follow these steps to update it:
# (If you have not done this) Install ".NET Runtime" (version 5.0) https://dotnet.microsoft.com/download/dotnet/5.0/runtime
# Ensure you've made a '''backup''' of the "'''Data'''" folder inside the game server installation folder.
# If you're updating from A28 or earlier versions, DELETE "Data/Saves" folder as the savegame is not compatible (breaking changes). Update from A29 to any A30 (and A30 to its patch versions) '''doesn't require this step''' (savegame is compatible).
# Download the new version of the server and overwrite your current installation with it (you can find the actual download link above in the "Installation" section).
# Stop the game server (if it's running).
# Important: please '''overwrite''' both Binaries and Core folders!
# Start the server as usual.

== Server commands ==
# Ensure you're the server operator (you've edited the ServerSettings.xml file and added yourself into the server_operators_list).
# Connect to your game server.
# The game console can be toggled by pressing <code>~</code> (the key on the left from <code>1</code> key) like in old-school games (you can change the key binding for console in the controls options).
# Please add <code>/</code> (slash) prefix to the server commands you want to execute.
# You can use '''Tab''' key to fill autocomplete, and you can use '''arrow Up/Down keys''' to navigate the suggestions list. Press '''Tab''' or '''Enter''' to accept the suggestion.

Here is the page with the server commands list: [[CryoFall/Server/Commands|Server Commands List]]

== Moderation (whitelist, blacklist, kicking, muting) ==
Server operator can access special moderation commands. To invoke these commands, please ensure you're the server operator, connect to your game server, open the console (~ key) and then you can use these commands: (replace username with the actual player nickname)

Whitelist management:

<code>/mod.whiteList.add username</code>

<code>/mod.whiteList.remove username</code>

<code>/mod.whiteList.print</code>

To enable whitelist:

<code>/mod.whiteList.enabled 1</code>

Blacklist management:

<code>/mod.blackList.add username</code>

<code>/mod.blackList.remove username</code>

<code>/mod.blackList.print</code>

Kicking players (temporary removing from server and blocking from connecting):

<code>/mod.kickList.add username durationInMinutes</code>

<code>/mod.kickList.remove username</code>

<code>/mod.kickList.print</code>

Muting players (temporary removing their ability to send messages to chat):

<code>/mod.muteList.add username durationInMinutes</code>

<code>/mod.muteList.remove username</code>

<code>/mod.muteList.print</code>

== Server rates adjusting / Enabling PvP mode ==
Server rates (and PvP mode setting) are exposed in a separate config file. You can quickly change things like LP gain rate, increase item drops, reduce the player to player damage to zero, or even increase the damage from creatures and make it really tough for the players!

To adjust the server rates, stop the server and check the file <game server>/Data/ServerRates.config
Please read carefullyΓÇöall the rates are disabled and in order to apply them '''you need to remove the # char at the start of the line'''!

If you want to '''enable PvP''', search PvP in the file. By default, this setting's value is 0 and you need to change it to 1 and remove the # char at the start of the line.

For advanced modding please read [http://forums.atomictorch.com/index.php?topic=1027.0 modding prerequisites].

== Server raiding hours (for PvP) ==
'''(Please note: with A27 this feature is not recommend anymore as there is a better feature now ΓÇö S.H.I.E.L.D. protection that is enabled by default for PvP servers)'''

On PvP server, you could set up specific hours during which the raiding is possible.
 By default, offline raiding protection is not enabled so players could raid other players' bases at any time.
 To enable offline raiding protection, please use this in-game console command:
 <code>/admin.setRaidingWindow 4 14 1.5</code>
 In this code we're using (first number) +4 GMT/UTC timezone, (second number) hour of day when raiding is possible (value from 0 to 24), and (third number) is the duration of the raiding window (value from 0 to 24).
 So the code in the example will allow raiding from 14:00 (or 2PM) for 1.5 hours.
 After changing the value you could open Politics/Diplomacy menu ([P] key) and verify whether you set the correct numbers.
 Please note that Politics/Diplomacy menu displaying your local time (in your PC timezone)!

== How to prohibit client modifications ==
If you wish to restrict usage of any client modifications on your server, please find "<no_client_mods>" setting in the SettingsServer.xml file. Change the value from 0 to 1 to enable this feature. It's recommended for PvP servers to set it to 1. You can read more details about this feature in [https://atomictorch.com/Post/Id2218/A28-Justice-Update-Release A28 Update announcement].