Skip to main content

Installation

FR Hub has no external dependencies. It works from the first ensure with any framework or in standalone mode.

1. Download​

Download the .zip from the resources panel
(a free fiverank.gg account is required).

The extracted archive has this structure:

fr_hub/
├── fxmanifest.lua
├── config.lua          ← only file you should edit
├── README.md
├── client/
│   ├── hide_native_hud.lua
│   ├── main.lua
│   ├── menu.lua
│   ├── vehicle.lua
│   └── bridges/
│       ├── init.lua
│       ├── esx.lua
│       ├── qbcore.lua
│       ├── qbox.lua
│       ├── standalone.lua
│       └── fuel.lua
├── html/
│   ├── index.html
│   ├── app.js
│   ├── style.css
│   └── assets/
│       └── logo.svg
└── stream/
    ├── minimap.gfx
    ├── minimap.ytd
    └── circlemap.ytd

2. Place the resource on your server​

Extract and copy the folder into your resources directory:

resources/[fiverank]/fr_hub/
Folder name

The folder name must be exactly fr_hub (with an underscore).
If the zip extracts as fr_hub-main or similar, rename it.

3. Add the line to server.cfg​

ensure fr_hub

Place it after your framework (ESX / QBCore / etc.) so the bridge correctly detects which one to use:

# Example with ESX
ensure es_extended
ensure fr_hub

# Example with QBCore
ensure qb-core
ensure fr_hub

# Standalone mode (no framework)
ensure fr_hub

4. Restart the server​

refresh
ensure fr_hub

Or do a full server restart. On startup you will see in the console:

[fr_hub] v1.5.4 — FiveRank HUD ready. Framework: ESX

If that message appears, the installation is correct.

Quick verification​

  1. Join the server and wait for the HUD to load (1–2 seconds).
  2. Check that you can see the stat rings on screen.
  3. Get in a vehicle → the floating speedometer should appear.
  4. Type /hub in chat → the settings panel should open.

Uninstall​

Remove the ensure fr_hub line from server.cfg and restart. It leaves no trace in any database because it uses FiveM KVP (the keys are removed when the resource no longer registers them).

Next step​

→ Configuration