> 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/installation.md).

# Installation

### Requirements

* **oxmysql**. No framework is needed.

### Steps

1. Put `sb_compass` in your resources folder.
2. Make sure oxmysql starts before it:

```cfg
ensure oxmysql
ensure sb_compass
```

The `sb_compass_settings` table is created automatically on every start, so there's nothing to run by hand. `sql/install.sql` is only there for reference.

### Fonts

The UI uses Host Grotesk and Martian Mono. Copy the brand `.woff2` files into `html/fonts/`. Without them, the HUD falls back to Segoe UI and Consolas.