> For the complete documentation index, see [llms.txt](https://viper-development-1.gitbook.io/viperdocs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://viper-development-1.gitbook.io/viperdocs/viper-scripts/safe-zone/guide/how-to-use.md).

# How to Use

## Opening the Menu

By default, the Safe Zone menu is opened by running a chat command. This is set in your config:

```lua
Config.MenuCommand = 'vipersafezone'
```

You can change this to any command name you want. Just replace `'vipersafezone'` with whatever you'd like admins to type to open the menu.

![](https://4032277048-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fzx3z2UVEktN8GrWmmEUO%2Fuploads%2FOnzQSO24K21w8x5cXNSu%2FScreenshot%202026-09-12%20193531.png?alt=media\&token=b9cdda2c-e42c-40a9-961e-0fbf56fa8a79)

## Showing Blips on the Map

Safe zones can show up as blips on the map so players can see where they are.

```lua
Config.ShowBlips = true
```

Set this to `false` if you don't want safe zones showing up on the map at all.

When enabled, each zone's blip uses the settings below:

```lua
Config.Blip = {
    sprite = 487, -- Blip sprite ID
    color = 2, -- Blip color ID
    scale = 0.9, -- Blip scale
}
```

`sprite` controls which icon is used for the blip, `color` controls its color, and `scale` controls how big it appears on the map. You can browse available sprite and color IDs on a site like [docs.fivem.net](https://docs.fivem.net/docs/game-references/blips/).

![](https://4032277048-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fzx3z2UVEktN8GrWmmEUO%2Fuploads%2F4KXJiLhljXBfkGcg6qnF%2FScreenshot%202026-09-12%20210104.png?alt=media\&token=c9496cdd-435f-4a95-8214-cf60289555ef)

## Changing the Menu Theme

The menu's colors can be fully customized from the config, no need to touch any UI files.

```lua
Config.ThemeColor = '#6BD425'
```

```lua
Config.BackgroundColor = '#0C0E12EB'
```

`Config.ThemeColor` controls the main accent color of the menu, while `Config.BackgroundColor` controls the menu's background color.

You can pick any color you like and grab its hex code from a site like [htmlcolorcodes.com](https://htmlcolorcodes.com/color-picker/), then paste it into the config in place of the values above.

![](https://4032277048-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fzx3z2UVEktN8GrWmmEUO%2Fuploads%2FDD0JqwFfk1Hc9i7R8RnT%2FScreenshot%202026-09-12%20193531.png?alt=media\&token=465ba14d-2f0f-4fc2-bd18-714c452f6c0a)

![](https://4032277048-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fzx3z2UVEktN8GrWmmEUO%2Fuploads%2FFXCqnWVuz0XnPcZJpYG0%2FScreenshot%202026-09-12%20210642.png?alt=media\&token=af1aec0c-6563-4c00-8cc2-6363bfe0df15)

## Configuring the Banner

The banner shown when a player enters or leaves a safe zone can be positioned anywhere on screen:

```lua
Config.Banner = {
    position = 'top-center', -- 'top-left', 'top-center', 'top-right', 'middle-right', 'middle-left', 'bottom-right', 'bottom-center', 'bottom-left'
    offsetX = 24, -- offsetX / offsetY are the distance in pixels from the edge of the screen
    offsetY = 24,
}
```

`position` sets which corner (or edge) of the screen the banner appears in, and `offsetX`/`offsetY` control how far it sits from that edge, in pixels.

<figure><img src="https://4032277048-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fzx3z2UVEktN8GrWmmEUO%2Fuploads%2F8vbwgKhNLW8EJix1vSy5%2FScreenshot%202026-09-12%20193531.png?alt=media&amp;token=791df6eb-259a-4584-8c6e-f1477bd7ce2a" alt=""><figcaption></figcaption></figure>

## Configuring Toast Notifications

Toast notifications pop up on screen for things like placing a point, creating a zone, or being denied permission. You can control where they appear and how long they stay on screen:

```lua
-- The toast notifications (point placed, zone created, no permission, etc.)
Config.Toasts = {
    position = 'bottom-right', -- 'top-left', 'top-center', 'top-right', 'middle-right', 'middle-left', 'bottom-right', 'bottom-center', 'bottom-left'
    offsetX = 24,
    offsetY = 24,
    duration = 4000, -- How long each toast stays on screen, in milliseconds
}
```

`position` sets which corner (or edge) of the screen the toasts appear in, `offsetX`/`offsetY` nudge them away from the screen edge, and `duration` controls how long each one stays visible before disappearing.

![](https://4032277048-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fzx3z2UVEktN8GrWmmEUO%2Fuploads%2Fh2mkCfFrquHFAWZYEtu6%2FScreenshot%202026-09-12%20193531.png?alt=media\&token=77fe6df7-7a35-4b4a-844a-e38b86aa2540)