Map

Details

Below, you will find detailed configuration for markers.

Configuration file

config/map.lua
return {
    ---@type boolean
    isEnabled = true,

    -- Default map, used from `available` definition.
    ---@type string
    default = 'normal',

    ---@type AvailableMap[]
    available = {
        {
            id = 'normal',
            name = 'Normal',
            icon = 'fas fa-map',
            minZoom = 2,
            maxZoom = 6,
            url = 'https://maps.static.foo/fd_dark_atlas/{z}/{x}/{y}.png',
        },
        {
            id = 'normal-light',
            name = 'Normal - Light',
            icon = 'fas fa-map-location-dot',
            minZoom = 2,
            maxZoom = 6,
            url = 'https://maps.static.foo/fd_atlas/{z}/{x}/{y}.png',
        },
        {
            id = 'satellite',
            name = 'Satellite',
            icon = 'fas fa-satellite-dish',
            minZoom = 2,
            maxZoom = 6,
            url = 'https://maps.static.foo/fd_satellite/{z}/{x}/{y}.png',
        },
    }
}

Detailed types information

isEnabledboolean
Is dispatch map enabled.
defaultstring
Must match one of the items in available array.

Available maps

Payload

---@class AvailableMap
---@field id string
---@field name string
---@field icon string
---@field minZoom number
---@field maxZoom number
---@field url string

Detailed types information

idstring
Map ID. Must be unique
namestring
Name which is shown in dispatch.
iconstring
Icon which is shown in dispatch.
minZoomnumber
Minimum zoom.
maxZoomnumber
Maximum zoom.
urlstring
URL for the map.

Want a custom map?