Configuration Reference

Full breakdown of all configuration fields available in 5M_Migrationtool/config.lua.

Core Settings

Lua

Config = {}

--- Which phone you are migrating FROM (pick ONE)
Config.SourcePhone = 'lb-phone'

--- Framework used for player identifiers: 'qbx' | 'qb' | 'esx' | 'auto'
Config.Framework = 'auto'

--- Dataset flags: toggle individual apps
Config.Migrate = {
    phones = true,
    contacts = true,
    gallery = true,
    notes = true,
    messages = true,
    calls = true,
    mail = true,
    maps = true,
    yellowpages = true,
    twitter = true,
    instagram = true,
    darkchat = true,
    recordings = true,
}

Safety Flags

Setting	Default	Description
`Config.DryRun`	`false`	If `true`, scans tables and logs counts without writing any rows. Always test with `true` first!
`Config.BlockPlayerJoins`	`true`	Rejects joining players while migration is running.
`Config.KickOnlinePlayers`	`true`	Drops all online players before beginning migration.
`Config.BatchSize`	`200`	Number of rows processed per SQL batch.
`Config.ForceRerun`	`false`	Bypasses the one-shot completion lock in the database.
`Config.SkipExistingProfiles`	`true`	Prevents overwriting already created 5M Phone profiles.

Live Console Commands

The tool registers server console commands for manual control:

5m_migrate_status: Check current running state, lock status, and completion history.
5m_migrate_run: Trigger a manual rerun directly from the server console.