Menu
 

Mods & Customization - Sons of the Forest Wiki

Sons of the Forest: Mods & Customization Guide

Install and manage mods for Sons of the Forest servers. Learn mod installation, compatibility checking, configuration optimization, and server customization for enhanced multiplayer experiences. This comprehensive guide covers everything from basic installation to advanced mod management and troubleshooting.

🔌 BepInEx Framework

Essential plugin system for loading and managing Sons of the Forest mods.

⚙️ Configuration

Fine-tune mod settings for optimal performance and gameplay balance.

🛡️ Compatibility

Ensure mods work together and don't cause conflicts or crashes.

Popular Mods

Essential Server Mods

These mods enhance server functionality and are recommended for most multiplayer setups:

Mod Purpose Compatibility Difficulty
Better Building Enhanced construction options, snap improvements, decorative items Server + Client Easy
Inventory Plus Expanded inventory space, quick sorting, stack size increases Server + Client Easy
Admin Tools Advanced server management, player commands, debugging tools Server only Medium
Spawn Menu In-game item and entity spawning menu for admins Server + Client Easy
Weather Control Adjust weather, time, and environmental conditions Server + Client Medium
Crafting Plus Additional crafting recipes, faster crafting times Server + Client Medium
Multiplayer Fixes Addresses common multiplayer bugs and desync issues Server only Easy
Performance Optimizer Reduces lag, improves FPS, optimizes resource usage Server + Client Hard

Gameplay Enhancement Mods

Mods that add new features and gameplay mechanics:

  • Survival Overhaul: Increases difficulty, adds new survival mechanics.
  • Building Expansion: Adds new building types, structures, and decoration options.
  • Enemy Variety: Introduces new enemy types with unique behaviors.
  • Item Expansion: Adds new weapons, tools, and consumable items.
  • Exploration Tools: Better maps, compasses, and navigation aids.

Mod Installation

BepInEx Setup

BepInEx is the essential plugin framework for Sons of the Forest mods:

# Step 1: Download BepInEx
wget https://github.com/BepInEx/BepInEx/releases/latest
# Or download from: https://github.com/BepInEx/BepInEx/releases

# Step 2: Extract to server directory
unzip BepInEx_*.zip -d /home/steam/sotf/

# Step 3: Verify installation
# You should see BepInEx folder in your server directory

# Step 4: Install mods to plugins folder
cp your_mod.dll /home/steam/sotf/BepInEx/plugins/

# Step 5: Configure mods (if needed)
# Create/edit config files in /home/steam/sotf/BepInEx/config/

# Step 6: Start server
./SonsOfTheForestDS.exe

# Step 7: Verify mod loading
# Check server console for "Loading plugin [mod name]" messages

Mod Directory Structure

Understanding where to place mod files is crucial:

/home/steam/sotf/
├── BepInEx/
│   ├── core/                  # BepInEx core files (don't modify)
│   ├── plugins/                # Install mods here (.dll files)
│   ├── config/                 # Mod configuration files
│   └── patchers/              # Advanced mod patching (rarely used)
└── ...other game files...

Verification Steps

Ensure mods are installed correctly:

  1. Check Console Output: Look for "Loading plugin [mod name]" messages during server startup.
  2. Test Functionality: Join the server and test mod features in-game.
  3. Monitor Performance: Check CPU and RAM usage after mod installation.
  4. Player Testing: Have players verify they can use mod features.
  5. Save Integrity: Ensure saves load correctly with mods enabled.

Mod Configuration

Config File Structure

Most mods use configuration files for customization:

# Example mod config
[ModSettings]
# General Settings
EnableFeature=true
DifficultyMultiplier=1.5
CustomSpawns=true

# Network Settings
NetworkUpdateRate=30
MaxPlayers=16

# Gameplay Settings
ItemDropRate=1.5
CraftingSpeed=1.2
EnemySpawnRate=1.0

Configuration Best Practices

  • Back Up Original Config: Always keep a copy of default settings.
  • Adjust One Setting at a Time: Test changes individually to identify impact.
  • Document Changes: Keep notes about what each setting does and why you changed it.
  • Balance Settings: Avoid overpowered configurations that break game balance.
  • Test on Small Scale: Apply changes on test server before production.

Mod Compatibility

Common Conflicts

Some mods may conflict with each other. Watch for:

  • Duplicate Functionality: Two mods doing the same thing may conflict.
  • Core File Modifications: Mods that modify core game files can be incompatible.
  • Network Protocol Changes: Mods affecting networking may cause desync between clients.
  • Save File Modifications: Mods that change save formats may corrupt saves.
  • Version Compatibility: Mods must match game version to work correctly.

Testing Compatibility

Method to ensure mods work together:

  1. Install Mods Individually: Test each mod alone to verify it works.
  2. Add Mods One by One: Add each mod to your setup and test after each addition.
  3. Monitor Logs: Check server logs for error messages related to mod conflicts.
  4. Test Multiplayer: Ensure mods work correctly with multiple players connected.
  5. Test Save/Load: Verify saves can be saved and loaded with all mods active.

Incompatible Mod Pairs

Known incompatible mod combinations:

Mod A Mod B Conflict Type Resolution
Inventory PlusCrafting OverhaulBoth modify inventory systemUse one or the other
Spawn MenuHardcore ModeSpawn menu defeats hardcore challengeDisable one mod
Weather ControlSeasonal ModBoth control weather systemsConfigure one to disable weather control

Advanced Mod Management

Mod Load Order

The order in which mods load can affect functionality:

  • Core Mods First: Load framework and core mods before content mods.
  • Dependencies: Mods that depend on other mods must load after their dependencies.
  • Configuration Overwrites: Later mods may overwrite earlier mod settings.
  • Load Order File: Create `load_order.txt` in plugins folder to specify order.

Mod Updates & Maintenance

Keep mods updated and maintained:

  • Check for Updates: Regularly check mod pages for updates and bug fixes.
  • Read Changelogs: Understand what changed in each update.
  • Test Updates: Apply updates on test server before production.
  • Backup Before Updates: Always create full backups before mod updates.
  • Remove Unused Mods: Delete mods you no longer use to reduce complexity.

Mod Performance Optimization

Ensure mods don't degrade server performance:

  • Monitor Resource Usage: Check CPU, RAM, and disk I/O with mods enabled.
  • Limit Resource-Heavy Mods: Reduce settings in performance-heavy mods.
  • Disable Unused Features: Turn off mod features you don't use.
  • Regular Cleanup: Remove temporary files and logs generated by mods.
  • Benchmark Before/After: Measure performance impact of each mod.

Troubleshooting Mod Issues

Common Problems

Solutions to frequent mod-related issues:

Issue Causes Solution
Mod Not LoadingWrong file location, incompatible versionVerify file path and game version
Server Crashes on StartupIncompatible mod, missing dependencyRemove mods one by one to identify culprit
Desync Between PlayersNetwork-modifying mods, version mismatchEnsure all players have same mod versions
Save CorruptionSave-modifying mods, improper shutdownRestore from backup, disable risky mods
Performance DegradationResource-heavy mods, too many modsRemove or optimize resource-heavy mods

Diagnostic Steps

Systematic approach to identifying mod issues:

  1. Check Server Logs: Look for error messages related to specific mods.
  2. Disable All Mods: Start server with no mods to verify base functionality.
  3. Enable Mods Individually: Add mods one at a time to identify which causes issues.
  4. Test with Single Player: Verify mods work in single-player before testing multiplayer.
  5. Verify Client Installation: Ensure players have mods installed correctly.

Safe Mod Removal

Properly remove mods to prevent save corruption:

  • Backup Saves: Always create full backups before removing mods.
  • Disable Mod Features: First disable mod features in-game to allow clean shutdown.
  • Remove Mod Files: Delete mod files from plugins folder.
  • Check Config Files: Remove or comment out mod configuration entries.
  • Test Save Loading: Verify saves load correctly after mod removal.

Modding Best Practices

🔄 Regular Backups

Create full server backups before installing, updating, or removing mods.

🧪 Test Environment

Always test mods on a separate server before production deployment.

📚 Documentation

Read mod documentation thoroughly and keep configuration notes.

Security Considerations

  • Verify Source: Only download mods from reputable sources (GitHub, official mod sites).
  • Scan Files: Use antivirus to scan downloaded mod files.
  • Check Permissions: Be cautious of mods requesting excessive permissions.
  • Review Code: If possible, review mod code for suspicious behavior.
  • Community Feedback: Read community reviews and feedback before installing mods.

Community Resources

Important: Always backup your server before installing mods. Test mods on a local server before deploying to production. Never install mods directly to your production server without testing first.

Pro Tip: Keep a "mod manifest" document listing all installed mods, their versions, configurations, and known issues. This makes troubleshooting much easier when problems arise.

Customize your server with mods and create unique gameplay experiences! Host your SOTF server with Supercraft for easy mod management, one-click installations, and expert support for modding your server.

Top