Compass ā Directional HUD with Blip & 3D World Support
This resource provides a modular, customizable compass system for FiveM, designed to enhance navigation and player awareness. Features include:
Blip rendering on the compass ā show icons dynamically along the direction bar
3D world blips ā display floating markers in the 3D world tied to coordinates or entities
Fully export-driven, easy to integrate into any system
Lightweight, clean, and optimized for performance
The compass can show cardinal directions, dynamically update blips in real time, and supports visibility distance settings. Ideal for roleplay, tactical missions, or any gameplay needing spatial awareness.
Note on Blip Usage
GTA natives do not provide access to blip names, so you must manually add blips to the compass using the Compass:AddBlip export.
This gives you full control over how they appear and what name they display.
(You can just create a blip creator export function, this way it will automatically register)
All exports and control options are documented below.
Links
Basic Compass Controls
| Export | Description | Parameters | Returns |
|---|---|---|---|
Compass:SetEnableBySystem |
Toggles compass system | _state: boolean |
- |
Compass:SetState |
Shows/hides compass for player | _state: boolean |
- |
Compass:IsEnabled |
Checks if compass is visible | - | boolean |
Compass:SetDirectionsEnabled |
Toggles direction labels | _state: boolean |
- |
Compass:SetLineGap |
Sets gap between compass markers | _gap: number |
- |
Blip Management
| Export | Description | Parameters | Returns |
|---|---|---|---|
Compass:SetBlipsEnabled |
Toggles blips on compass | _state: boolean |
- |
Compass:SetBlipsVisibilityDistance |
Sets blip render distance | _distance: number |
- |
Compass:AddBlip |
Adds new compass blip | _blip: number, name: string |
Blip entity |
Compass:RemoveBlip |
Removes compass blip | _blip: number |
Success boolean |
3D Blips
| Export | Description | Parameters | Returns |
|---|---|---|---|
Compass:DimensionalBlips:EnableBySystem |
Toggles 3D blip system | _state: boolean |
- |
Compass:DimensionalBlips:SetState |
Shows/hides 3D blips | _state: boolean |
- |
Compass:DimensionalBlips:SetDistanceToShow |
Sets 3D blip render distance | _distance: number |
- |
| Code is accessible | Open-source available also |
| Subscription-based | No |
| Lines (approximately) | ~1000 |
| Requirements | - |
| Support | Not required |