Barotrauma Mod Installation Guide

Barotrauma Mod Installation Guide - Baza znanja

This guide covers how to install, manage, and update Steam Workshop mods on your Barotrauma dedicated server hosted with Legion Hosting. Mods can add custom submarines, creatures, items, and gameplay changes to your server.

Looking for basic server setup? See Barotrauma Dedicated Server Setup Guide for server settings, submarine selection, campaign saves, and connection instructions.

How Mods Work on Dedicated Servers
Installing Workshop Mods
Configuring Mods in serversettings.xml
Keeping Mods Updated
Mod Compatibility
Removing Mods

How Mods Work on Dedicated Servers

Barotrauma supports Steam Workshop mods for custom content including submarines, creatures, items, and gameplay overhauls. On a dedicated server, mods are not downloaded automatically from the Workshop. You must manually transfer the mod files to your server.

Important: The server must have the same mods installed as the connecting clients. If there is a version mismatch or a missing mod, players will be unable to join.

Installing Workshop Mods

The recommended approach for installing mods on your hosted server is to download them on your local PC first, then upload the files to the server.

Step-by-Step Installation

On your own PC, subscribe to the mod on the Steam Workshop and launch Barotrauma once to download it.
Locate the downloaded mod folder on your PC. Workshop mods are typically stored at:
```
Steam\steamapps\workshop\content\602960\<ModID>\
```
The <ModID> is the numeric ID from the mod's Workshop URL.
Connect to your server via SFTP or open the file manager in GPanel.
Navigate to the LocalMods/ directory in your Barotrauma server folder. If the directory does not exist, create it.
Upload the entire mod folder (the one named with the mod's numeric ID) into LocalMods/.
Configure the mod in serversettings.xml as described in the next section.
Restart the server for changes to take effect.

Tip: Each mod folder should contain a filelist.xml file that identifies the mod. If this file is missing, the mod will not be detected by the server.

Configuring Mods in serversettings.xml

After uploading mod files, you need to register them in your server configuration. Open serversettings.xml and add the mod to the installed content packages list.

Important: Always stop your server before editing serversettings.xml. The server overwrites this file on shutdown, so any changes made while the server is running will be lost.

Refer to the mod's filelist.xml for the correct internal name. The exact configuration format depends on your Barotrauma version, but typically mods appear in the ContentPackage entries within serversettings.xml.

Verifying Mod Loading

After restarting the server with the mod configured:

Open the server console in GPanel.
Look for log lines referencing the mod name or ID. Successfully loaded mods will appear during the startup sequence.
If you see [ERROR] lines referencing the mod, check that all files were uploaded correctly and the mod is compatible with your server version.

Keeping Mods Updated

The server does not automatically pull Workshop updates. When a mod author pushes an update, you must manually re-download and re-upload the updated files.

Update Process

On your local PC, ensure your Steam client has downloaded the latest version of the mod (unsubscribe and resubscribe if needed to force a fresh download).
Connect to your server via SFTP.
Stop the server from GPanel.
Navigate to LocalMods/<ModID>/ and replace the contents with the newly downloaded files.
Start the server.

Tell your players: All players must also update the same mod on their clients before joining. A version mismatch will prevent connections.

Mod Compatibility

Mod conflicts are one of the most common causes of server issues. Keep these guidelines in mind:

Issue	Cause	Solution
Server crashes on startup	Two mods modifying the same game content (items, creatures, etc.)	Disable all mods, then re-enable one at a time to find the conflict
Players disconnected on join	Client-server mod version mismatch	Ensure all players and the server have the same mod versions
Content errors in server log	Missing dependency or outdated mod	Check the mod's Workshop page for required dependencies and update
Mod works in singleplayer but not on server	Client-side only mod	Check the mod's Workshop description; some mods are client-only and should not be installed on the server

General rule: The fewer mods you run, the more stable your server will be. Add mods incrementally and test after each addition rather than installing many at once.

Removing Mods

Stop your server from GPanel.
Open serversettings.xml and remove the mod's content package entry.
Delete the mod's folder from LocalMods/ via SFTP or the GPanel file manager.
Start the server.

Campaign saves: If you remove a mod that added items or content used in an active campaign, the save may become corrupted or produce errors. Back up your campaign save before removing mods. See the main setup guide for backup instructions.

Need help? Open a support ticket at legionhosting.net/submitticket.php and include your server name, the mod name/ID, and any error messages from the GPanel console.

Barotrauma Mod Installation Guide - Baza znanja

Podrška

Kategorije

Barotrauma Mod Installation Guide