Installation on Windows

This page describes basic installation on Windows. It will help you install the Mod on a home server. This guide is not helpful when you host your server with a game server provider (GSP). If that's the case, we suggest you read the Config.cfg file carefully on your FTP or ask your GSP to configure it.

Prerequisites

Before you start fiddling with 1fx. Mod, you should first check the integrity of the SoF2 installation directory you're going to install the Mod in. We often see lots of oddities and bugs arise due to all sorts of client-side Mods already installed, that due to sharing files with the server-side of SoF2MP interfere with the proper working of 1fx. Mod.

As a general rule of thumb, always install 1fx. Mod in a clean SoF2 installation directory that you only use to host the server. It will save you lots of trouble later on.

Requirements

The requirements of running 1fx. Mod on Windows are a little higher than SoF2, yet still ridiculously low by today's standards:

• Windows version: Windows NT 4.0, Windows 2000, Windows XP and higher are supported.
  Windows 95/98 with KernelEx might work, but are unsupported and have not been tested for a long time.
• Executable: Depending on the SoF2 version you're planning to run 1fx. Mod on, it is necessary to either use an unpatched or patched version of the main executable in order for 1fx. Mod to work correctly. This is described in the section below.

Installing the correct executable

It is imperative to use the executable inside the 1fx. Mod download to ensure 1fx. Mod works as expected. You will find the executable file in the "Server files" directory.

Retail versions (v1.00/v1.03)

This SoF2MP.exe is the retail executable, with no patches applied at all, since 1fx. Mod patches your executable dynamically during startup. Using a patched executable will likely lead to crashes. If you are sure you don't use any kind of patched executable, you can go ahead and skip this step.

You may use the following checkums to ensure the integrity of your executable (md5sum):

• SoF2MP.exe for v1.00 (Full): 6a5109bacb8fac68e82b61f6d7892cc5
• SoF2MP.exe for v1.03 (Gold): 0263922b67e3474f9e77e769f217f53a

MP TEST version (v1.02t)

The SoF2MP-Test.exe in the 1fx. Mod download for MP TEST/Demo is the original executable with the exception that the demo/filesystem restrictions are lifted. This is the only way to let MP TEST load the required 1fx. Mod files: 1fx. Mod won't work without it. The rest of the executable is untouched so 1fx. Mod is able to apply the remaining patches during startup.

You may use the following checkums to ensure the integrity of your executable (md5sum):

• SoF2MP.exe for v1.02t (MP TEST/Demo): 0a81a15f611433352992ea7df8a4c741

Installing 1fx. Mod

Head over to the 1fx. Mod download page and head down to the download section. Take note of the SoF2 version and download the appropriate Windows version of 1fx. Mod. The package downloaded is a .zip archive.

After downloading the package, extract the contents. You can do this either from the ribbon bar (as shown in the image below), or by rightclicking the .zip archive (look for a similar "Extract all" option).

Open the newly extracted directory. Inside, you'll find two directories:

• Server files: The directory with the actual server files. This is the directory you'll need.
• Utility scripts: Extra scripts to perform additional maintenance. Aimed at power-users only.

Open the "Server files" directory and copy all directories found to the SoF2 installation directory you're going to use to host 1fx. Mod. In our example, this is only the "1fx" directory.

Please note: There may be more directories in the "Server files" directory, next to the "1fx" directory. Be sure to copy all directories and files found in the "Server files" directory to the SoF2 installation, even if they aren't on the screenshot above.

After you finished copying, it will look a little like this (your mileage may vary):

Congratulations! You just installed 1fx. Mod! Yes, it's really this easy.

Configuring 1fx. Mod

Next on, you probably want to configure your server before starting it. Fortunately, it's very easy to configure your server. First on, go into your "1fx" directory and find the Config.cfg file. This file contains 90% of your server configuration.

Please note: By default, Windows does not know how to open .cfg files. You can safely open the 1fx. Mod Config file in Notepad. It's recommended to set the file association so you won't have to do this each time you dive into the Config.cfg file.

Open the Config.cfg file and select Notepad as the application to open the file with. The steps below are done with Windows 10, but should be similar on different versions of Windows.

Start configuring the server by editing the file and save the file when done. Don't forget to also adjust the intial mapcycle found in the "files" directory (mapcycle.txt).

Running 1fx. Mod

Look for the "Start Server.bat" file in the "1fx" directory to start your server. If you downloaded the Universal package, it may also be called "Start Windows Server.bat".

Double click it, and you're done! Your server is now running. You can use the "1fxver" command to check what 1fx. Mod version you're running. By opening the game you should be able to find this new server in your local server list!

Tips and tricks

Below are a few tips and tricks that may come in handy, but didn't really fit in the main tutorial. Use them how you see fit.

Running the 1fx. Utility scripts

Included in the downloaded 1fx. Mod download package are the extra utility scripts. Those are scripts written in Python and will run on every major platform without issues.

You will need at least Python 3.3 to run them correctly. You can download Python 3 for Windows from the Python website.
Downloading the latest Python 3 release is fine.

Running legacy 1fx. Mod versions

Legacy 1fx. Mod versions prior to 0.70 use QVMs instead of DLLs. Running such version leads to a crash on startup on newer Windows Server operating systems. SoF2MP.exe will stop working immediately after loading the sof2mp_game.qvm file.

The following procedure describes how to disable Data Execution Prevention (DEP) for SoF2MP.exe:

• Click Start, click Run, type sysdm.cpl, and then click OK.
• On the Advanced tab, under Performance, click Settings.
• On the Data Execution Prevention tab, select: Turn on DEP for all programs and services except those I select.
• Add your SoF2MP.exe executable to the exception list with the Add button.
• Click OK two times.

Legacy 1fx. Mod versions prior to 0.70 will now start correctly.