> For the complete documentation index, see [llms.txt](https://abdelemporium-docs.gitbook.io/frostbytestudios/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://abdelemporium-docs.gitbook.io/frostbytestudios/u.h.e/fst-minimaps.md).

# FST Minimaps

## **Available Minimaps and Features**

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-type="rating" data-max="5"></th><th data-hidden data-card-cover data-type="image">Cover image</th></tr></thead><tbody><tr><td><mark style="color:$primary;">FrostB Minimap</mark></td><td><mark style="color:$danger;"><strong>Features</strong></mark><br><em>- POI Icons</em><br><em>- Routes Lines/Icons</em><br><em>- Zone Names</em><br><em>- Cayo Perico</em></td><td><a href="https://abdelemporium.tebex.io/package/7672849">Purchase Link</a></td><td>4</td><td><a href="https://236171655-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKmnIL2y55RCYyqD6c4xR%2Fuploads%2FNA26fDCUnY5cJrW7bHkv%2Ffrostb_minimap_thumb.jpg?alt=media&amp;token=455cfabb-7e4d-4821-bf66-7c26c61aa6c6">frostb_minimap_thumb.jpg</a></td></tr><tr><td><mark style="color:$primary;">Bundle Minimap</mark></td><td><mark style="color:$danger;"><strong>Features</strong></mark><br><strong>-</strong> <em>9 Different Themes</em><br><em>- Modern Zone Names</em><br><em>- Routes Lines/Icons</em><br><em>- Cayo Perico</em><br><em>- Enhanced Minimap V2</em><br><em>- Postals</em><br><em>- Street Names</em></td><td><a href="https://abdelemporium.tebex.io/package/7730160">Purchase Link</a></td><td>5</td><td><a href="https://236171655-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKmnIL2y55RCYyqD6c4xR%2Fuploads%2FOP6he837d5C6cITsrDtM%2Fbundle%20map%20thumbanel.jpg?alt=media&amp;token=74a31247-4bd0-48a1-b0a3-c05174a78245">bundle map thumbanel.jpg</a></td></tr><tr><td><mark style="color:$primary;">OLD Paper Minimap</mark></td><td><mark style="color:$danger;"><strong>Features</strong></mark><br><strong>-</strong> <em>POI Icons</em><br><em>- Routes Lines/Icons</em><br><em>- Cayo Perico</em><br><em>- Enhanced Minimap V2</em><br><em>- Map Key</em><br><em>- Compass</em><br><em>- Postals</em><br><em>- Street Names</em></td><td><a href="https://abdelemporium.tebex.io/package/7519660">Purchase Link</a></td><td>5</td><td><a href="https://236171655-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKmnIL2y55RCYyqD6c4xR%2Fuploads%2FGxV3ClpBAMryoclhQIrs%2Fsdsde.png?alt=media&amp;token=b795bbd2-09db-43ee-abb6-578d01d2e659">sdsde.png</a></td></tr><tr><td><mark style="color:$primary;">Burnout Minimap</mark></td><td><mark style="color:$danger;"><strong>Features</strong></mark><br><strong>-</strong> <em>Routes Lines/Icons</em><br><em>- Cayo Perico</em><br><em>- Enhanced Minimap V2</em><br><em>- Postals</em><br><em>- Street Names</em></td><td><a href="https://abdelemporium.tebex.io/package/7655078">Purchase Link</a></td><td>4</td><td><a href="https://236171655-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKmnIL2y55RCYyqD6c4xR%2Fuploads%2FXcSgts6MPfaOu7WJkI39%2Fimagsddsdsde.png?alt=media&amp;token=ef4f2686-846a-42b3-82f6-d76321148530">imagsddsdsde.png</a></td></tr><tr><td><mark style="color:$primary;">Western Minimap</mark></td><td><mark style="color:$danger;"><strong>Features</strong></mark><br><strong>-</strong> <em>POI Icons</em><br><em>- Zone Names</em><br><em>- Routes Lines/Icons</em><br><em>- Cayo Perico</em><br><em>- Enhanced Minimap V2</em><br><em>- Map Key</em><br><em>- Postals</em><br><em>- Street Names</em></td><td><a href="https://abdelemporium.tebex.io/package/fst-western-minimap">Purchase Link</a></td><td>5</td><td><a href="https://236171655-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKmnIL2y55RCYyqD6c4xR%2Fuploads%2Fp665qdUGMxKuAbtKjUQp%2Fwestern_minimap_thumb.jpg?alt=media&amp;token=0673a61e-3b53-43d4-8a24-a7f3705cf882">western_minimap_thumb.jpg</a></td></tr><tr><td><mark style="color:$primary;">Vintage Minimap Bundle</mark></td><td><em>- Zone Names</em><br><em>- Cayo Perico</em><br><em>- Enhanced Minimap V2</em><br><em>- Postals</em><br><em>- Street Names</em><br><strong>-</strong>  <em>6</em> Different Themes</td><td><a href="https://abdelemporium.tebex.io/package/7761029">Purchase Link</a></td><td>5</td><td><a href="https://236171655-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKmnIL2y55RCYyqD6c4xR%2Fuploads%2Fp8RD6BYiBvjOBeRiEscM%2Fbundle%20map%20thumbanel.jpg?alt=media&amp;token=1271821d-621d-49bd-9f2f-c1adb6ae3c2a">bundle map thumbanel.jpg</a></td></tr></tbody></table>

<table><thead><tr><th width="203.45458984375">Minimap Name</th><th data-type="checkbox">Enhanced Minimap V2</th><th data-type="checkbox">Cayo Perico</th><th width="154.9090576171875" data-type="checkbox">Configurable</th><th>Creator<select><option value="Fqa4L8hfpMf6" label="Pengu" color="blue"></option><option value="xr0WO41u6jcI" label="Cyberhead" color="blue"></option></select></th><th>Free/Paid<select><option value="R74sKabmYCnk" label="Free" color="blue"></option><option value="SyUxlOu9ywQw" label="Paid" color="blue"></option></select></th></tr></thead><tbody><tr><td>OLD Paper Minimap</td><td>true</td><td>true</td><td>true</td><td><span data-option="xr0WO41u6jcI">Cyberhead</span></td><td><span data-option="SyUxlOu9ywQw">Paid</span></td></tr><tr><td>Western Minimap</td><td>true</td><td>true</td><td>true</td><td><span data-option="xr0WO41u6jcI">Cyberhead</span></td><td><span data-option="SyUxlOu9ywQw">Paid</span></td></tr><tr><td>Burnout Minimap</td><td>true</td><td>true</td><td>true</td><td><span data-option="Fqa4L8hfpMf6">Pengu</span></td><td><span data-option="SyUxlOu9ywQw">Paid</span></td></tr><tr><td>Colored Minimap Bundle</td><td>true</td><td>true</td><td>true</td><td><span data-option="Fqa4L8hfpMf6">Pengu</span></td><td><span data-option="SyUxlOu9ywQw">Paid</span></td></tr><tr><td>FrostB Minimap</td><td>false</td><td>true</td><td>false</td><td><span data-option="Fqa4L8hfpMf6">Pengu</span></td><td><span data-option="R74sKabmYCnk">Free</span></td></tr><tr><td>Vintage Minimap Bundle</td><td>true</td><td>true</td><td>true</td><td><span data-option="Fqa4L8hfpMf6">Pengu</span></td><td><span data-option="SyUxlOu9ywQw">Paid</span></td></tr></tbody></table>

### Installation

{% stepper %}
{% step %}

### Install resource

Each minimap has its own drawer. Place it inside your server's resources folder and make sure the folder name is correct.\
**Example**: `fst_vintage_minimaps_drawer`\
Add the resource to your `server.cfg` if needed
{% endstep %}

{% step %}

### Install Assets

Each minimap has its own assets. Place them inside your server's resources folder and keep the correct folder names.

**Example**: `fst_vintage_minimaps_assets`

{% hint style="warning" %}
Note: Some minimaps have multiple asset folders. For example, the Vintage Minimap also has separate Cayo Perico assets: `fst_vintage_minimaps_cayo_assets`.

Make sure to install all required assets and keep their original folder names.
{% endhint %}
{% endstep %}

{% step %}

### Hud Colors

{% hint style="info" %}
(Optional) Install and start [`ox_lib`](https://github.com/overextended/ox_lib) before this resource if you want to use the `/mapcolors` command.
{% endhint %}
{% endstep %}

{% step %}

### Adjust your needs

Adjust `config.lua` to your liking and restart the resource.
{% endstep %}

{% step %}

### Postals

{% code expandable="true" %}

```lua
  -- Enable only one postal set. Textures are supplied by fst_minimap_postals_assets.
  postales_4 = { enabled = false, opacity = 100 },
  ocrp_postales = { enabled = false, opacity = 100 },
  oulsen_postales = { enabled = false, opacity = 100 },

  black_postales_4 = { enabled = false, opacity = 100 },
  black_ocrp_postales = { enabled = false, opacity = 100 },
  black_oulsen_postales = { enabled = false, opacity = 100 },
```

{% endcode %}

{% hint style="warning" %}
Enable only one postal set. Textures are supplied by [**fst\_minimap\_postals\_assets**](https://github.com/AbdeLhere/fst_minimap_postals_assets)\
so make sure to install the dependency first before enabling postals

<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-cover data-type="image">Cover image</th></tr></thead><tbody><tr><td>Postals Textures<br><a href="https://github.com/AbdeLhere/fst_minimap_postals_assets">Download</a></td><td><a href="https://236171655-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKmnIL2y55RCYyqD6c4xR%2Fuploads%2FIrz3U5rB5TU5qZLEsOL7%2Fpostal%20textures%20thumbanel%20free.jpg?alt=media&amp;token=17462489-2fc7-49e0-8c37-bc71598f678e">postal textures thumbanel free.jpg</a></td></tr></tbody></table>
{% endhint %}
{% endstep %}

{% step %}

### Street Names

{% code expandable="true" %}

```lua
  -- Enable only one street names set. Textures are supplied by fst_minimap_streetnames_assets.
  gray_street_names = { enabled = false, opacity = 100 },
  black_street_names = { enabled = false, opacity = 100 },
  white_street_names = { enabled = false, opacity = 100 },
```

{% endcode %}

{% hint style="warning" %}
Enable only one color set. Textures are supplied by [**fst\_minimap\_streetnames\_assets**](https://github.com/AbdeLhere/fst_minimap_streetnames_assets)\
so make sure to install the dependency first before enabling street names

<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-cover data-type="image">Cover image</th></tr></thead><tbody><tr><td>Street Names Textures<br><a href="https://github.com/AbdeLhere/fst_minimap_streetnames_assets">Download</a></td><td><a href="https://236171655-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKmnIL2y55RCYyqD6c4xR%2Fuploads%2FknZEt9ImzKzjYgmFjmCY%2Fstreet%20names%20textures%20thumbanel.jpg?alt=media&amp;token=d4a3e7c4-a7ed-425c-a0df-2b97d2eb235c">street names textures thumbanel.jpg</a></td></tr></tbody></table>
{% endhint %}
{% endstep %}

{% step %}

### Config Example

{% code expandable="true" %}

```lua
Config = {}
Config.debug = false
Config.enable_map_zoom_levels = true

Config.ZoomLevels = {
  { index = 0, zoomScale = 0.96,  zoomSpeed = 0.9, scrollSpeed = 0.08, tilesX = 0.0, tilesY = 0.0 },
  { index = 1, zoomScale = 1.6,   zoomSpeed = 0.9, scrollSpeed = 0.08, tilesX = 0.0, tilesY = 0.0 },
  { index = 2, zoomScale = 8.6,   zoomSpeed = 0.9, scrollSpeed = 0.08, tilesX = 0.0, tilesY = 0.0 },
  { index = 3, zoomScale = 12.3,  zoomSpeed = 0.9, scrollSpeed = 0.08, tilesX = 0.0, tilesY = 0.0 },
  { index = 4, zoomScale = 24.3,  zoomSpeed = 0.9, scrollSpeed = 0.08, tilesX = 0.0, tilesY = 0.0 },
  { index = 5, zoomScale = 55.0,  zoomSpeed = 0.0, scrollSpeed = 0.1,  tilesX = 2.0, tilesY = 1.0 },
  { index = 6, zoomScale = 450.0, zoomSpeed = 0.0, scrollSpeed = 0.1,  tilesX = 1.0, tilesY = 1.0 },
  { index = 7, zoomScale = 4.5,   zoomSpeed = 0.0, scrollSpeed = 0.0,  tilesX = 0.0, tilesY = 0.0 },
  { index = 8, zoomScale = 11.0,  zoomSpeed = 0.0, scrollSpeed = 0.0,  tilesX = 2.0, tilesY = 3.0 },
}

Config.Radar = {
  zoom = {
    enabled = true,        -- Enable automatic radar zoom
    on_vehicle = 1000,     -- Zoom level when in vehicle (default: 1000)
    on_foot = 1100,        -- Zoom level when on foot (default: 1100)
    check_interval = 1000, -- How often to check zoom in ms (default: 1000)
  },
  disable_blur = true,     -- Disable the blur effect when loading minimap (recommended: true)
}

Config.PauseMenu = {
  enable_color_picker = false, -- Allow players to change colors with a command
  command = "mapcolors",       -- Command to open color picker (/mapcolors)

  -- Default colors (RGB format: 0-255) - Burnout theme
  colors = {
    line = { enabled = true, red = 255, green = 114, blue = 24, alpha = 255 },     -- Burnt Orange (western leather)
    background = { enabled = true, red = 94, green = 28, blue = 8, alpha = 200 },  -- Dark Brown (saddle leather)
    pause_bg = { enabled = true, red = 94, green = 28, blue = 8, alpha = 200 },    -- Light Brown (desert sand)
    waypoint = { enabled = true, red = 255, green = 114, blue = 24, alpha = 255 }, -- Goldenrod (western gold)
  },
}

Config.overlays = {
  ------------------- ⚠️ Default Overlays ⚠️ -------------------
  -- Enable only one postal set. Textures are supplied by fst_minimap_postals_assets.
  postales_4 = { enabled = false, opacity = 100 },
  ocrp_postales = { enabled = false, opacity = 100 },
  oulsen_postales = { enabled = false, opacity = 100 },

  black_postales_4 = { enabled = false, opacity = 100 },
  black_ocrp_postales = { enabled = false, opacity = 100 },
  black_oulsen_postales = { enabled = false, opacity = 100 },

  -- Enable only one street names set. Textures are supplied by fst_minimap_streetnames_assets.
  gray_street_names = { enabled = false, opacity = 100 },
  black_street_names = { enabled = false, opacity = 100 },
  white_street_names = { enabled = false, opacity = 100 },
  ------------------- ⚠️ Default Overlays END ⚠️ -------------------

  vintageM_zone_names = { enabled = false, opacity = 100 },

  -- Opacity/alpha value (0-100, default: 100)
  Ashen_Crown = { enabled = false, opacity = 100 },
  Ashen_Crown_Cayo = { enabled = false, opacity = 100 },

  Botanical_Atlas = { enabled = false, opacity = 100 },
  Botanical_Atlas_Cayo = { enabled = false, opacity = 100 },

  Concrete_Atlas = { enabled = false, opacity = 100 },
  Concrete_Atlas_Cayo = { enabled = false, opacity = 100 },

  Ink_Archive = { enabled = false, opacity = 100 },
  Ink_Archive_Cayo = { enabled = false, opacity = 100 },

  Retro_Terracotta = { enabled = false, opacity = 100 },
  Retro_Terracotta_Cayo = { enabled = false, opacity = 100 },

  Vintage_Blue = { enabled = true, opacity = 100 },
  Vintage_Blue_Cayo = { enabled = false, opacity = 100 },
}

Config.load_order = {
  "Ashen_Crown",
  "Ashen_Crown_Cayo",
  "Botanical_Atlas",
  "Botanical_Atlas_Cayo",
  "Concrete_Atlas",
  "Concrete_Atlas_Cayo",
  "Ink_Archive",
  "Ink_Archive_Cayo",
  "Retro_Terracotta",
  "Retro_Terracotta_Cayo",
  "Vintage_Blue",
  "Vintage_Blue_Cayo",
  ------------------- ⚠️ Default Overlays ⚠️ -------------------
  "gray_street_names",
  "black_street_names",
  "white_street_names",
  -------------------
  "postales_4",
  "ocrp_postales",
  "oulsen_postales",
  -------------------
  "black_postales_4",
  "black_ocrp_postales",
  "black_oulsen_postales",
  ------------------- ⚠️ Default Overlays END ⚠️ -------------------
  "vintageM_zone_names"
}

```

{% endcode %}
{% endstep %}

{% step %}

### Custom Installation

{% tabs %}
{% tab title="Colored Minimap Bundle" %}
{% hint style="warning" %}
For **Cayo Perico** installation, an asset called `fst_colored_minimaps_cayo_assets` is included. You first need to install it, as it contains all Cayo Perico minimaps. This helps avoid having a large number of unnecessary textures on your server if your not using Cayo Perico.
{% endhint %}
{% endtab %}

{% tab title="Vintage Minimap Bundle" %}
{% hint style="warning" %}
For **Cayo Perico** installation, an asset called `fst_vintage_minimaps_cayo_assets` is included. You first need to install it, as it contains all Cayo Perico minimaps. This helps avoid having a large number of unnecessary textures on your server if your not using Cayo Perico.
{% endhint %}
{% endtab %}
{% endtabs %}
{% endstep %}
{% endstepper %}

### Using with Enhanced Minimap V2

{% hint style="warning" %}
If you own **fst\_enhanced\_minimap\_v2** and want to use one of this minimaps with it, follow this guide
{% endhint %}

{% stepper %}
{% step %}

### Set compatibility

To avoid conflicts with Enhanced Minimap V2, remove any old minimap drawers from your server.

For example, delete the old `fst_colored_minimaps_drawer` and keep only the required assets:

* `fst_colored_minimaps_assets`
* `fst_colored_minimaps_cayo_assets`

Make sure you keep the correct resources installed according to the new documentation.
{% endstep %}

{% step %}

### Ensure both resources

```cfg
ensure fst_enhanced_minimap_v2
ensure fst_colored_minimaps_assets
ensure fst_colored_minimaps_cayo_assets
```

{% endstep %}

{% step %}

### Restart your server.

{% hint style="info" %}
The Colored Minimap Bundle will only provide its textures and overlays while Enhanced Minimap handles all UI, radar, tablet, and player features.
{% endhint %}
{% endstep %}
{% endstepper %}

{% hint style="warning" %}
If you are not using Enhanced Minimap: Make sure to **install** `fst_colored_minimaps_drawer` \
The Colored Minimap Bundle will run independently with all features enabled.
{% endhint %}
