Server Configuration

​

Configuration File Location

%AppData%\Nitrox\saves\<World Name>\server.cfg

​

Configuration File Format

# Comments start with #
ServerPort=11000
MaxConnections=100
ServerPassword=
GameMode=SURVIVAL

​

Core Settings

​

Network Configuration

​

ServerPort

ServerPort=11000

• Type: Integer
• Default: 11000
• Description: UDP port the server listens on for incoming connections
• Note: Must be forwarded through your router for internet play

​

MaxConnections

MaxConnections=100

• Type: Integer
• Default: 100
• Range: Must be greater than 0
• Description: Maximum number of simultaneous player connections

​

AutoPortForward

AutoPortForward=true

• Type: Boolean
• Default: true
• Description: Automatically attempts to open the server port on your router via UPnP
• Note: Requires UPnP support on your router

​

LANDiscoveryEnabled

LANDiscoveryEnabled=true

• Type: Boolean
• Default: true
• Description: Allow the server to respond to LAN discovery broadcasts
• Note: Enables automatic server detection for players on the same local network

​

Authentication & Security

​

ServerPassword

ServerPassword=

• Type: String
• Default: Empty (no password)
• Description: Password required for players to join the server
• Note: Leave empty for a public server

​

AdminPassword

AdminPassword=abc123XYZ789

• Type: String
• Default: Randomly generated 12-character string
• Description: Password for admin privileges
• Important: Change this from the default!

public string AdminPassword { get; set; } = StringHelper.GenerateRandomString(12);

​

DefaultPlayerPerm

DefaultPlayerPerm=PLAYER

• Type: Enum
• Default: PLAYER
• Options:
  • NONE - No permissions
  • PLAYER - Basic player permissions, cannot use cheats
  • MODERATOR - Can manage players, use vanilla cheats
  • ADMIN - Full server administration
  • CONSOLE - All permissions (reserved for console)
• Description: Default permission level for new players

​

LocalhostIsAdmin

LocalhostIsAdmin=true

• Type: Boolean
• Default: true
• Description: Players connecting from localhost (127.0.0.1) automatically get admin permissions
• Warning: Disable this if using a proxy server

​

Gameplay Settings

​

Game Mode

GameMode=SURVIVAL

• Type: Enum
• Default: SURVIVAL
• Options:
  • SURVIVAL (0) - Standard survival mode
  • FREEDOM (2) - No hunger/thirst
  • HARDCORE (257) - Permadeath
  • CREATIVE (1790) - Unlimited resources, no threats
• Description: World game mode

public enum NitroxGameMode
{
    SURVIVAL = 0,
    FREEDOM = 2,
    HARDCORE = 257,
    CREATIVE = 1790,
}

​

World Seed

Seed=

• Type: String
• Default: Empty (random)
• Description: Leave blank for random spawn position, or specify a seed for reproducible worlds

​

PvP Settings

PvPEnabled=true

• Type: Boolean
• Default: true
• Description: Enables or disables player-versus-player damage and interactions

​

Death Settings

KeepInventoryOnDeath=false

• Type: Boolean
• Default: false
• Description: Prevents players from losing items when they die

​

Save & Backup Configuration

​

Save Interval

SaveInterval=120000

• Type: Integer (milliseconds)
• Default: 120000 (2 minutes)
• Minimum: 1000 (1 second)
• Description: Time between automatic world saves
• Note: More frequent saves = more safety but slightly more disk I/O

​

Auto-Save Control

DisableAutoSave=false

• Type: Boolean
• Default: false
• Description: Completely disable automatic saving
• Warning: Not recommended - use manual save commands only

​

Backup Settings

MaxBackups=10
DisableAutoBackup=false

• Type: Integer
• Default: 10
• Range: 0 or greater (0 = unlimited)
• Description: Number of backup saves to retain

• Type: Boolean
• Default: false
• Description: Disable automatic backup creation

​

Post-Save Command

PostSaveCommandPath=

• Type: String (file path)
• Default: Empty
• Description: Path to executable/script to run after successful save (e.g., for custom backup solutions)
• Examples:
  • Windows: C:\Scripts\backup.bat
  • Linux: /home/user/scripts/backup.sh

​

Performance Settings

​

Entity Cache

CreateFullEntityCache=false

• Type: Boolean
• Default: false
• Description: Pre-load all 504,732 world entities on server start
• Warning: Initial startup will take several minutes, but improves player experience in new areas

# WARNING! Will make server load take longer on the cache run
# but players will gain a performance boost when entering new areas.
CreateFullEntityCache=false

​

Initial Sync Timeout

InitialSyncTimeout=120000

• Type: Integer (milliseconds)
• Default: 120000 (2 minutes)
• Description: Maximum time allowed for initial world sync when a player joins
• Note: Increase if players with slow connections timeout during join

​

Safe Building

SafeBuilding=true

• Type: Boolean
• Default: true
• Description: Reject build actions detected as desynced
• Note: Prevents building glitches but may occasionally reject valid builds

​

Serialization Settings

​

Serializer Mode

SerializerMode=JSON

• Type: Enum
• Default: JSON
• Options:
  • JSON - Human-readable, easier to debug
  • PROTOBUF - Binary format, smaller file size
• Description: Format for save files
• Warning: Cannot easily switch between formats without data conversion

​

UI Settings

​

Console Disable

DisableConsole=false

• Type: Boolean
• Default: false
• Description: Disable server console for all players

​

Embedded Mode

IsEmbedded=true  

• Type: Boolean
• Default: true
• Description: When started via launcher, use launcher UI instead of external window

​

Player Stats Configuration

# Oxygen
DefaultOxygenValue=45
DefaultMaxOxygenValue=45

# Health
DefaultHealthValue=80

# Survival stats
DefaultHungerValue=50.5
DefaultThirstValue=90.5

# Infection
DefaultInfectionValue=0.1

​

Example Configurations

​

Public Casual Server

# Open to everyone, relaxed gameplay
ServerPort=11000
MaxConnections=50
ServerPassword=
GameMode=FREEDOM
PvPEnabled=false
KeepInventoryOnDeath=true
SaveInterval=120000
MaxBackups=10
AutoPortForward=true
LANDiscoveryEnabled=true

​

Private Hardcore Server

# Password-protected, challenging gameplay  
ServerPort=11000
MaxConnections=10
ServerPassword=MySecretPassword123
AdminPassword=SuperSecretAdmin456
GameMode=HARDCORE
PvPEnabled=true
KeepInventoryOnDeath=false
SaveInterval=60000
MaxBackups=20
AutoPortForward=true
LANDiscoveryEnabled=false

​

High-Performance Server

# Optimized for large player counts
ServerPort=11000
MaxConnections=100
ServerPassword=
GameMode=SURVIVAL
CreateFullEntityCache=true
SaveInterval=300000
MaxBackups=5
InitialSyncTimeout=180000
SafeBuilding=true

​

Applying Configuration Changes

​

Configuration via Console Commands

# Change admin password
changeadminpassword <new_password>

# Change server password  
changeserverpassword <new_password>

# Toggle autosave
autosave

# View/modify config
config

​

Troubleshooting Configuration Issues

​

Next Steps