> For the complete documentation index, see [llms.txt](https://sbscripts.gitbook.io/sb-scripts/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://sbscripts.gitbook.io/sb-scripts/sb-compass.md).

# SB Compass

SB Compass is a standalone compass and location HUD for FiveM. It has no framework dependency and only needs oxmysql. Players set it up in an in-game menu, and their settings are saved to the database.

* Degree strip, or a simple bar showing the zone, directions and street
* Location card with the street name, shown always, in a vehicle, or on foot
* Heading from the camera or from movement
* Per-player settings saved by licence, opened with `/sbcompass`
* The HUD only appears once the player is fully spawned and in control
* Every save is validated on the server and rate limited

See the Installation, Menu Options, Configuration and Exports pages for details.
