> For the complete documentation index, see [llms.txt](https://bbstore.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://bbstore.gitbook.io/docs/resources/bb-gps/configuration.md).

# Configuration

```lua
Config = {}

Config.Framework = "auto" -- auto, qb, esx, qbx

-- Language setting
--[[
    English: en
    Turkish: tr
    You can add your own language by going to locales/locales.lua and adding a new language.
]]--
Config.DefaultLanguage = "en" -- Available options: "en", "tr"

--[[
    If this value is set to true, the GPS system will start refreshing via a callback. 
    In this case, the blip types on the map (icons) will function correctly. 
    That means the blip will automatically update to reflect whether the player is in a vehicle, on a boat, or in a helicopter. 
    It also accurately detects conditions like the player being 300 meters above ground, and displays the correct icon on the map accordingly.
]]--
Config.ServerSideUpdate = false


Config.UptimeTick = 1000 -- GPS uptime tick
Config.Item = "gps" -- Required item to use the GPS
Config.LeaveOnDeath = true -- If the player dies, they will leave the GPS
Config.Radius = 10000.0 -- Radius of the GPS

Config.Design = {
    fadeEffect = true,         -- Entrance/exit animations
    pulseEffect = true,        -- Pulse effect
    soundEffects = true,       -- Sound effects
    satelliteSimulation = true, -- Satellite connection simulation
    batterySimulation = true   -- Battery level simulation
}

Config.DefaultsBlips = { -- Default blips
    sprite = 1,
    scale = 0.8,
    color = 38
}

-- Only these jobs can use the satellite codes
Config.OnlyJobs = {
	Enabled = false,
	Jobs = {
		['police'] = true,
		['sheriff'] = true,
		['ambulance'] = true,
	}
}

-- Whitelist satellite codes
-- Only these codes can be used by the specified jobs
Config.WhitelistCodes = {
    ['911'] = {                -- Satellite code
        jobs = {'police', 'sheriff'}, -- This code can be used by these jobs
        name = "Safety Channel"      -- Code description
    },
    ['112'] = {
        jobs = {'ambulance'},
        name = "Emergency Health Channel"
    },
    ['PD123'] = {
        jobs = {'police'},
        name = "Police Department Special Channel"
    },
    ['SD456'] = {
        jobs = {'sheriff'},
        name = "Sheriff Department Special Channel"
    },
    ['EMS789'] = {
        jobs = {'ambulance'},
        name = "EMS Special Channel"
    }
}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://bbstore.gitbook.io/docs/resources/bb-gps/configuration.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
