Skip to main content
Version: 0.7.0

Installing Mods on a Server

This guide explains how to enable mods on a dedicated server.
At this time, server-side mods work only on the dedicated server with Windows edition.

note
  • Only mods that are built to run on servers will work on the server.
  • Use mods at your own risk. They may cause save-data corruption or crashes.

Placing Workshop Mods​

Unlike the game client, the dedicated server must be made aware of Workshop items using one of the methods below.

Use the default directory​

By default, the dedicated server reads Mods/Workshop located in the same directory as the server executable file.
Copy the Workshop item(s) into this directory. Use any folder name, and place Info.json directly under that folder.

.\PalServer.exe
.\Mods\PalModSettings.ini
.\Mods\Workshop\[any folder name]\Info.json

Specify the Workshop directory explicitly​

You can also point the server directly to a Workshop directory.
With this method, all compatible mods found under the Workshop directory will be loaded.
Use either of the following to specify the Workshop directory:

  • Add WorkshopRootDir=<absolute path> under the [PalModSettings] section in Mods/PalModSettings.ini
  • Add the launch option -workshopdir="<absolute path>"
tip

On the client, the default Workshop folder path is:

C:\Program Files (x86)\Steam\steamapps\workshop\content\1623730

Enabling Mods via PalModSettings.ini​

Configure settings in the Mods/PalModSettings.ini file.
Set the global enable flag to true, and list the PackageName entries you want to load. PackageName is the value found in Info.json (note: it is not the folder name).

[PalModSettings]
bGlobalEnableMod=true
ActiveModList=GamingCattiva
ActiveModList=FarmingQuivern
# WorkshopRootDir=C:\Program Files (x86)\Steam\steamapps\workshop\content\1623730
tip
  • The Mods/PalModSettings.ini file is generated automatically after you launch the dedicated server once.
  • Add multiple ActiveModList lines to enable multiple mods at the same time.
  • Adding the -NoMods launch argument forcibly disables all mods.

Deploy Mods by Restarting the Server​

To apply mods on the server, you must restart the dedicated server.
When the server restarts, Mods/ManagedMods/<PackageName>/InstallManifest.json is created automatically, and files are deployed according to the InstallRules in Info.json.

UE4SS -> Mods\NativeMods\UE4SS Lua -> Mods\NativeMods\UE4SS\Mods\{PackageName} PalSchema -> Mods\NativeMods\UE4SS\Mods\PalSchema\mods\{PackageName} LogicMods -> Pal\Content\Paks\LogicMods Paks -> Pal\Content\Paks\~WorkshopMods\{PackageName}

Tips for Updating / Removing​

  • If the Version in Info.json changes, restarting the dedicated server will automatically uninstall the old version and redeploy the new one.
  • To disable a mod, remove its PackageName from ActiveModList. If needed, delete Mods/Workshop/<WorkshopId>/, then restart the dedicated server.

Troubleshooting​

Mod doesn’t work or won’t enable​

  • Is the mod compatible with dedicated servers?
    • If the InstallRule section in Info.json does not include "IsServer": true, the mod is not designed to run on servers.
  • Are the prerequisite mods installed?
    • Some mods require other mods as dependencies.
  • Was the mod deployed correctly?