Chapter 7.4: Config Persistence

Home | << Previous: RPC Patterns | Config Persistence | Next: Permission Systems >>

Einführung

Almost every DayZ mod needs to save and load configuration data: server settings, spawn tables, ban lists, player data, teleport locations. The engine provides JsonFileLoader for simple JSON serialization and raw file I/O (FileHandle, FPrintln) for everything else. Professional mods layer config versioning and auto-migration on top.

This chapter covers the standard patterns for config persistence, from basic JSON load/save through versioned migration systems, directory management, and auto-save timers.

JsonFileLoader Pattern

JsonFileLoader is the engine's built-in serializer. It converts between Enforce Script objects and JSON files using reflection --- it reads the public fields of your class and maps them to JSON keys automatically.

Critical Gotcha

JsonFileLoader<T>.JsonLoadFile() and JsonFileLoader<T>.JsonSaveFile() return void. You cannot check their return value. You cannot assign them to a bool. You cannot use them in an if condition. This is one of the most common mistakes in DayZ modding.

// WRONG — will not compile
bool success = JsonFileLoader<MyConfig>.JsonLoadFile(path, config);

// WRONG — will not compile
if (JsonFileLoader<MyConfig>.JsonLoadFile(path, config))
{
    // ...
}

// RIGHT — call and then check the object state
JsonFileLoader<MyConfig>.JsonLoadFile(path, config);
// Check if the data was actually populated
if (config.m_ServerName != "")
{
    // Data loaded successfully
}

Basic Load/Save

// Data class — public fields are serialized to/from JSON
class ServerSettings
{
    string ServerName = "My DayZ Server";
    int MaxPlayers = 60;
    float RestartInterval = 14400.0;
    bool PvPEnabled = true;
};

class SettingsManager
{
    private static const string SETTINGS_PATH = "$profile:MyMod/ServerSettings.json";
    protected ref ServerSettings m_Settings;

    void Load()
    {
        m_Settings = new ServerSettings();

        if (FileExist(SETTINGS_PATH))
        {
            JsonFileLoader<ServerSettings>.JsonLoadFile(SETTINGS_PATH, m_Settings);
        }
        else
        {
            // First run: save defaults
            Save();
        }
    }

    void Save()
    {
        JsonFileLoader<ServerSettings>.JsonSaveFile(SETTINGS_PATH, m_Settings);
    }
};

What Gets Serialized

JsonFileLoader serializes all public fields of the object. It does not serialize:

Private or protected fields
Methods
Static fields
Transient/runtime-only fields (there is no [NonSerialized] attribute --- use access modifiers)

The resulting JSON looks like:

json

{
    "ServerName": "My DayZ Server",
    "MaxPlayers": 60,
    "RestartInterval": 14400.0,
    "PvPEnabled": true
}

Supported Field Types

Type	JSON Representation
`int`	Number
`float`	Number
`bool`	`true` / `false`
`string`	String
`vector`	Array of 3 numbers
`array<T>`	JSON array
`map<string, T>`	JSON object (string keys only)
Nested class	Nested JSON object

Nested Objects

class SpawnPoint
{
    string Name;
    vector Position;
    float Radius;
};

class SpawnConfig
{
    ref array<ref SpawnPoint> SpawnPoints = new array<ref SpawnPoint>();
};

Produces:

json

{
    "SpawnPoints": [
        {
            "Name": "Coast",
            "Position": [13000, 0, 3500],
            "Radius": 100.0
        },
        {
            "Name": "Airfield",
            "Position": [4500, 0, 9500],
            "Radius": 50.0
        }
    ]
}

Manual JSON Writing (FPrintln)

Sometimes JsonFileLoader is not flexible enough: it cannot handle arrays of mixed types, custom formatting, or non-class data structures. In those cases, use raw file I/O.

Basic Pattern

void WriteCustomData(string path, array<string> lines)
{
    FileHandle file = OpenFile(path, FileMode.WRITE);
    if (!file) return;

    FPrintln(file, "{");
    FPrintln(file, "    \"entries\": [");

    for (int i = 0; i < lines.Count(); i++)
    {
        string comma = "";
        if (i < lines.Count() - 1) comma = ",";
        FPrintln(file, "        \"" + lines[i] + "\"" + comma);
    }

    FPrintln(file, "    ]");
    FPrintln(file, "}");

    CloseFile(file);
}

Reading Raw Files

void ReadCustomData(string path)
{
    FileHandle file = OpenFile(path, FileMode.READ);
    if (!file) return;

    string line;
    while (FGets(file, line) >= 0)
    {
        line = line.Trim();
        if (line == "") continue;
        // Process line...
    }

    CloseFile(file);
}

Wann verwenden Manual I/O

Writing log files (append mode)
Writing CSV or plain-text exports
Custom JSON formatting that JsonFileLoader cannot produce
Parsing non-JSON file formats (e.g., DayZ's .map or .xml files)

For standard config files, prefer JsonFileLoader. It is faster to implement, less error-prone, and automatically handles nested objects.

The $profile Path

DayZ provides the $profile: path prefix, which resolves to the server's profile directory (typically the folder containing DayZServer_x64.exe, or the profile path specified with -profiles=).

// These resolve to the profile directory:
"$profile:MyMod/config.json"       // → C:/DayZServer/MyMod/config.json
"$profile:MyMod/Players/data.json" // → C:/DayZServer/MyMod/Players/data.json

Always Use $profile

Never use absolute paths. Never use relative paths. Always use $profile: for any file your mod creates or reads at runtime:

// BAD: Absolute path — breaks on any other machine
const string CONFIG_PATH = "C:/DayZServer/MyMod/config.json";

// BAD: Relative path — depends on working directory, which varies
const string CONFIG_PATH = "MyMod/config.json";

// GOOD: $profile resolves correctly everywhere
const string CONFIG_PATH = "$profile:MyMod/config.json";

Conventional Directory Structure

Most mods follow this convention:

$profile:
  └── YourModName/
      ├── Config.json          (main server config)
      ├── Permissions.json     (admin permissions)
      ├── Logs/
      │   └── 2025-01-15.log   (daily log files)
      └── Players/
          ├── 76561198xxxxx.json
          └── 76561198yyyyy.json

Directory Creation

Before writing a file, you must ensure its parent directory exists. DayZ does not auto-create directories.

MakeDirectory

void EnsureDirectories()
{
    string baseDir = "$profile:MyMod";
    if (!FileExist(baseDir))
    {
        MakeDirectory(baseDir);
    }

    string playersDir = baseDir + "/Players";
    if (!FileExist(playersDir))
    {
        MakeDirectory(playersDir);
    }

    string logsDir = baseDir + "/Logs";
    if (!FileExist(logsDir))
    {
        MakeDirectory(logsDir);
    }
}

Important: MakeDirectory Is Not Recursive

MakeDirectory creates only the final directory in the path. If the parent does not exist, it fails silently. You must create each level:

// WRONG: Parent "MyMod" doesn't exist yet
MakeDirectory("$profile:MyMod/Data/Players");  // Fails silently

// RIGHT: Create each level
MakeDirectory("$profile:MyMod");
MakeDirectory("$profile:MyMod/Data");
MakeDirectory("$profile:MyMod/Data/Players");

MyMod Pattern: Konstanten for Paths

MyMod defines all paths as constants in a dedicated class:

class MyModConst
{
    static const string PROFILE_DIR    = "$profile:MyMod";
    static const string CONFIG_DIR     = "$profile:MyMod/Configs";
    static const string LOG_DIR        = "$profile:MyMod/Logs";
    static const string PLAYERS_DIR    = "$profile:MyMod/Players";
    static const string PERMISSIONS_FILE = "$profile:MyMod/Permissions.json";
};

This avoids path string duplication across the codebase and makes it easy to find every file your mod touches.

Config Data Classes

A well-designed config data class provides default values, version tracking, and clear documentation of each field.

Basic Pattern

class MyModConfig
{
    // Version tracking for migrations
    int ConfigVersion = 3;

    // Gameplay settings with sensible defaults
    bool EnableFeatureX = true;
    int MaxEntities = 50;
    float SpawnRadius = 500.0;
    string WelcomeMessage = "Welcome to the server!";

    // Complex settings
    ref array<string> AllowedWeapons = new array<string>();
    ref map<string, float> ZoneRadii = new map<string, float>();

    void MyModConfig()
    {
        // Initialize collections with defaults
        AllowedWeapons.Insert("AK74");
        AllowedWeapons.Insert("M4A1");

        ZoneRadii.Set("safe_zone", 100.0);
        ZoneRadii.Set("pvp_zone", 500.0);
    }
};

MyMod ConfigBase Pattern

MyMod uses a reflective config system where each config class declares its fields as descriptors. This allows the admin panel to auto-generate UI for any config without hardcoded field names:

// Conceptual pattern (simplified from MyMod):
class MyConfigBase
{
    // Each config declares its version
    int ConfigVersion;
    string ModId;

    // Subclasses override to declare their fields
    void Init(string modId)
    {
        ModId = modId;
    }

    // Reflection: get all configurable fields
    array<ref MyModConfigField> GetFields();

    // Dynamic get/set by field name (for admin panel sync)
    string GetFieldValue(string fieldName);
    void SetFieldValue(string fieldName, string value);

    // Hooks for custom logic on load/save
    void OnAfterLoad() {}
    void OnBeforeSave() {}
};

VPP ConfigurablePlugin Pattern

VPP merges config management directly into the plugin lifecycle:

// VPP pattern (simplified):
class VPPESPConfig
{
    bool EnableESP = true;
    float MaxDistance = 1000.0;
    int RefreshRate = 5;
};

class VPPESPPlugin : ConfigurablePlugin
{
    ref VPPESPConfig m_ESPConfig;

    override void OnInit()
    {
        m_ESPConfig = new VPPESPConfig();
        // ConfigurablePlugin.LoadConfig() handles the JSON load
        super.OnInit();
    }
};

Config Versioning and Migration

As your mod evolves, config structures change. You add fields, remove fields, rename fields, change defaults. Without versioning, users with old config files will silently get wrong values or crash.

The Version Field

Every config class should have an integer version field:

class MyModConfig
{
    int ConfigVersion = 5;  // Increment when the structure changes
    // ...
};

Migration on Load

When loading a config, compare the on-disk version with the current code version. If they differ, run migrations:

void LoadConfig()
{
    MyModConfig config = new MyModConfig();  // Has current defaults

    if (FileExist(CONFIG_PATH))
    {
        JsonFileLoader<MyModConfig>.JsonLoadFile(CONFIG_PATH, config);

        if (config.ConfigVersion < CURRENT_VERSION)
        {
            MigrateConfig(config);
            config.ConfigVersion = CURRENT_VERSION;
            SaveConfig(config);  // Re-save with updated version
        }
    }
    else
    {
        SaveConfig(config);  // First run: write defaults
    }

    m_Config = config;
}

Migration Functions

static const int CURRENT_VERSION = 5;

void MigrateConfig(MyModConfig config)
{
    // Run each migration step sequentially
    if (config.ConfigVersion < 2)
    {
        // v1 → v2: "SpawnDelay" was renamed to "RespawnInterval"
        // Old field is lost on load; set new default
        config.RespawnInterval = 300.0;
    }

    if (config.ConfigVersion < 3)
    {
        // v2 → v3: Added "EnableNotifications" field
        config.EnableNotifications = true;
    }

    if (config.ConfigVersion < 4)
    {
        // v3 → v4: "MaxZombies" default changed from 100 to 200
        if (config.MaxZombies == 100)
        {
            config.MaxZombies = 200;  // Only update if user hadn't changed it
        }
    }

    if (config.ConfigVersion < 5)
    {
        // v4 → v5: "DifficultyMode" changed from int to string
        // config.DifficultyMode = "Normal"; // Set new default
    }

    MyLog.Info("Config", "Migrated config from v"
        + config.ConfigVersion.ToString() + " to v" + CURRENT_VERSION.ToString());
}

Expansion's Migration Example

Expansion is known for aggressive config evolution. Some Expansion configs have gone through 17+ versions. Their pattern:

Each version bump has a dedicated migration function
Migrations run in order (1 to 2, then 2 to 3, then 3 to 4, etc.)
Each migration only changes what is necessary for that version step
The final version number is written to disk after all migrations complete

This is the gold standard for config versioning in DayZ mods.

Auto-Save Timers

For configs that change at runtime (admin edits, player data accumulation), implement an auto-save timer to prevent data loss on crashes.

Timer-Based Auto-Save

class MyDataManager
{
    protected const float AUTOSAVE_INTERVAL = 300.0;  // 5 minutes
    protected float m_AutosaveTimer;
    protected bool m_Dirty;  // Has data changed since last save?

    void MarkDirty()
    {
        m_Dirty = true;
    }

    void OnUpdate(float dt)
    {
        m_AutosaveTimer += dt;
        if (m_AutosaveTimer >= AUTOSAVE_INTERVAL)
        {
            m_AutosaveTimer = 0;

            if (m_Dirty)
            {
                Save();
                m_Dirty = false;
            }
        }
    }

    void OnMissionFinish()
    {
        // Always save on shutdown, even if timer hasn't fired
        if (m_Dirty)
        {
            Save();
            m_Dirty = false;
        }
    }
};

Dirty Flag Optimization

Only write to disk when data has actually changed. File I/O is expensive. If nothing changed, skip the save:

void UpdateSetting(string key, string value)
{
    if (m_Settings.Get(key) == value) return;  // No change, no save

    m_Settings.Set(key, value);
    MarkDirty();
}

Save on Critical Events

In addition to timed saves, save immediately after critical operations:

void BanPlayer(string uid, string reason)
{
    m_BanList.Insert(uid);
    Save();  // Immediate save — bans must survive crashes
}

Häufige Fehler

1. Treating JsonLoadFile as if It Returns a Value

// WRONG — does not compile
if (JsonFileLoader<MyConfig>.JsonLoadFile(path, config)) { ... }

JsonLoadFile returns void. Call it, then check the object's state.

2. Not Checking FileExist Before Loading

// WRONG — crashes or produces empty object with no diagnostic
JsonFileLoader<MyConfig>.JsonLoadFile("$profile:MyMod/Config.json", config);

// RIGHT — check first, create defaults if missing
if (!FileExist("$profile:MyMod/Config.json"))
{
    SaveDefaults();
    return;
}
JsonFileLoader<MyConfig>.JsonLoadFile("$profile:MyMod/Config.json", config);

3. Forgetting to Create Directories

JsonSaveFile fails silently if the directory does not exist. Always ensure directories before saving.

4. Public Fields You Did Not Intend to Serialize

Every public field on a config class ends up in the JSON. If you have runtime-only fields, make them protected or private:

class MyConfig
{
    // These go to JSON:
    int MaxPlayers = 60;
    string ServerName = "My Server";

    // This does NOT go to JSON (protected):
    protected bool m_Loaded;
    protected float m_LastSaveTime;
};

5. Backslash and Quote Characters in JSON Values

Enforce Script's CParser has trouble with \\ and \" in string literals. Avoid storing file paths with backslashes in configs. Use forward slashes:

// BAD — backslashes may break parsing
string LogPath = "C:\\DayZ\\Logs\\server.log";

// GOOD — forward slashes work everywhere
string LogPath = "$profile:MyMod/Logs/server.log";

Best Practices

Use $profile: for all file paths. Never hardcode absolute paths.
Create directories before writing files. Check with FileExist(), create with MakeDirectory(), one level at a time.
Always provide default values in your config class constructor or field initializers. This ensures first-run configs are sensible.
Version your configs from day one. Adding a ConfigVersion field costs nothing and saves hours of debugging later.
Separate config data classes from manager classes. The data class is a dumb container; the manager handles load/save/sync logic.
Use auto-save with a dirty flag. Do not write to disk every time a value changes --- batch writes on a timer.
Save on mission finish. The auto-save timer is a safety net, not the primary save. Always save during OnMissionFinish().
Define path constants in one place. A MyModConst class with all paths prevents string duplication and makes path changes trivial.
Log load/save operations. When debugging config issues, a log line saying "Loaded config v3 from $profile:MyMod/Config.json" is invaluable.
Test with a deleted config file. Your mod should handle first-run gracefully: create directories, write defaults, log what it did.

<< Zurück: RPC Patterns | Startseite | Next: Permission Systems >>

Chapter 7.4: Config Persistence ​

Einführung ​

Inhaltsverzeichnis ​

JsonFileLoader Pattern ​

Critical Gotcha ​

Basic Load/Save ​

What Gets Serialized ​

Supported Field Types ​

Nested Objects ​

Manual JSON Writing (FPrintln) ​

Basic Pattern ​

Reading Raw Files ​

Wann verwenden Manual I/O ​

The $profile Path ​

Always Use $profile ​

Conventional Directory Structure ​

Directory Creation ​

MakeDirectory ​

Important: MakeDirectory Is Not Recursive ​

MyMod Pattern: Konstanten for Paths ​

Config Data Classes ​

Basic Pattern ​

MyMod ConfigBase Pattern ​

VPP ConfigurablePlugin Pattern ​

Config Versioning and Migration ​

The Version Field ​

Migration on Load ​

Migration Functions ​

Expansion's Migration Example ​

Auto-Save Timers ​

Timer-Based Auto-Save ​

Dirty Flag Optimization ​

Save on Critical Events ​

Häufige Fehler ​

1. Treating JsonLoadFile as if It Returns a Value ​

2. Not Checking FileExist Before Loading ​

3. Forgetting to Create Directories ​

4. Public Fields You Did Not Intend to Serialize ​

5. Backslash and Quote Characters in JSON Values ​

Best Practices ​

Chapter 7.4: Config Persistence

Einführung

Inhaltsverzeichnis

JsonFileLoader Pattern

Critical Gotcha

Basic Load/Save

What Gets Serialized

Supported Field Types

Nested Objects

Manual JSON Writing (FPrintln)

Basic Pattern

Reading Raw Files

Wann verwenden Manual I/O

The $profile Path

Always Use $profile

Conventional Directory Structure

Directory Creation

MakeDirectory

Important: MakeDirectory Is Not Recursive

MyMod Pattern: Konstanten for Paths

Config Data Classes

Basic Pattern

MyMod ConfigBase Pattern

VPP ConfigurablePlugin Pattern

Config Versioning and Migration

The Version Field

Migration on Load

Migration Functions

Expansion's Migration Example

Auto-Save Timers

Timer-Based Auto-Save

Dirty Flag Optimization

Save on Critical Events

Häufige Fehler

1. Treating JsonLoadFile as if It Returns a Value

2. Not Checking FileExist Before Loading

3. Forgetting to Create Directories

4. Public Fields You Did Not Intend to Serialize

5. Backslash and Quote Characters in JSON Values

Best Practices