Postal Map: config files

These files stay readable in every build (escrow too), so you can change them. Shown as shipped in version 1.0.1.

config.lua

Config = {}

-- Command that opens the settings panel (admins only).
Config.SettingsCommand = 'mapsettings'

-- Who may open the panel. A player is an admin if ANY of these match, checked
-- in this order. Most servers need no changes: framework admins are found
-- automatically.
Config.Admin = {
    -- 1. Exact players, by identifier (license:, discord:, fivem:, steam:...).
    identifiers = {
        -- 'license:abc123...',
        -- 'discord:123456789012345678',
    },

    -- 2. ACE permission from server.cfg, works on every framework:
    --      add_ace group.admin lumo.postalmap.admin allow
    ace = 'lumo.postalmap.admin',
    -- Also accept the 'command' ace, which admin groups usually already have
    -- (add_ace group.admin command allow). false = only the ace above.
    commandAce = true,

    -- 3. Framework ranks, detected automatically from whichever is running.
    --    false = turn framework detection off and use 1 and 2 only.
    framework = true,
    qbcore = { 'god', 'admin' },              -- qb-core / qbx_core permission names
    esx = { 'superadmin', 'admin' },          -- es_extended groups
}

-- Per-player day/night override: /minimap day | night | auto
Config.PlayerCommand = 'minimap'

-- true = print loading, admin and download details to the server/F8 consoles.
-- /minimapdebug (F8) always prints the current map state.
Config.Debug = false

-- How often (seconds) the game clock is read to switch between day and night.
Config.ClockCheckSeconds = 10

-- How far the pause map zooms in. The map tiles are sharp up to about 12;
-- higher values zoom further but the map turns blurry. Game default is 22.3.
Config.MaxMapZoom = 12.0

-- Cayo Perico. The artwork is in stream/cayo/day/lumo_cayo.ytd and
-- stream/cayo/night/lumo_cayo_n.ytd (texture 'lumo_cayo' in both). Edit those in
-- OpenIV or CodeWalker; nothing else needs changing.
Config.Cayo = {
    -- Loading the island into the world when a player gets close, in metres
    -- from its centre. The mainland is over 4000 m away, so it is never affected.
    enter = 2500.0,   -- load the island inside this distance
    leave = 3000.0,   -- unload it again past this distance
    land = 1500.0,    -- on foot closer than this, hold still until the ground is there
}

-- Radar shape and zoom, for servers WITHOUT a HUD that manages the radar.
-- While a HUD from Config.HudResources runs, both are left to the HUD.
Config.Radar = {
    shape = 'hud',    -- 'hud' (leave it alone), 'square' or 'circle'
    zoom = 0,         -- 0 = leave it alone, or 100-1400 to hold that radar zoom
}

-- HUDs that set the radar zoom and shape themselves. Add yours if it is missing.
Config.HudResources = {
    'lumo-ui', 'qb-hud', 'ps-hud', 'jg-hud', '0r-hud-v3', 'codem-hud',
    'izzy-hudv3', 'mHud', 'esx_hud', 'tgiann-hud', 'nui_hud',
}

-- Starting values for the settings panel. Once an admin saves the panel, the
-- saved values are used instead; "Reset to defaults" goes back to these.
Config.Defaults = {
    map = 'standard',        -- 'standard', 'postals', 'streets' or 'all' (postals + streets)
    cycle = 'auto',          -- 'auto' follows the game clock, or 'day' / 'night'
    dayStart = 6,            -- hour (0-23) the day map comes back
    nightStart = 20,         -- hour (0-23) the night map starts
    playerToggle = true,     -- players may use /minimap day|night|auto for themselves
    cayo = true,             -- Cayo Perico on the radar and pause map
    cayoWorld = true,        -- load the island (buildings, ground, roads) when players get close
    radarBacking = true,     -- solid round radar: no game world showing through it
    radarBackingSquare = true, -- solid square radar
}