Documentation
Installation guide — please follow each step carefully and exactly as described to ensure the script works correctly on your server. Skipping or modifying steps may cause the system to not function properly, so follow it step by step.
Quasar Waypoint is a client-only resource. There is no server script, no dependencies and no database — it runs on any framework, or on none at all.
Requirement | Status | Notes |
|---|---|---|
Framework | Not required | Works on ESX, QBCore, QBox or standalone |
Database |
Player settings are stored locally on each client |
Dependencies | None | No |
Node.js 18+ | Optional | Only needed to rebuild the interface |
No textures are streamed either: the icon is drawn from HTML, and the 3D marker uses the game's own shapes.
After purchasing Quasar Waypoint, the resource is automatically linked to your CFX Portal account.
Sign in to the CFX Portal using the same account used during checkout, then open Granted Assets and locate Waypoint in your asset library. Download the latest version and extract the archive.
After extracting the download, you should have the following folder:
qs-waypointNever rename the resource folder. It must remain qs-waypoint, otherwise the resource and its user interface will fail to load correctly.
Move the qs-waypoint folder into your server's resources directory. Although the resource can be placed anywhere inside the folder, keeping Quasar resources organized inside their own directory is recommended.
A typical installation looks like this:
resources/
└── [quasar]/
└── qs-waypoint/Then add it to your server.cfg:
ensure qs-waypointThere is no loading order to respect — the resource has no dependencies, so it can be started anywhere in your config.
No SQL import is required. Quasar Waypoint creates no tables and stores nothing on the server.
Every player's state — their profiles, active profile, units and on/off toggle — is saved locally on their own client, so settings persist between sessions per player, without any database.
Two files are editable, both outside escrow:
File | What it holds |
|---|---|
| All settings and the default style |
| Every text in the creator |
The values worth setting first:
Config.Command = "waypoint" -- command word, empty string = no command
Config.Keybind = "" -- default key, empty = each player picks their own
Config.OnlyInVehicles = false -- true only draws the waypoint while driving
Config.MaxProfiles = 10 -- styles a player can save
Config.DefaultUnits = "km" -- "km" or "miles"
Config.PerformanceMode = false -- lightweight presetConfig.DefaultStyle defines the starting point for a new profile and what Reset restores. Everything in it can be changed by each player on their own, so it only needs to be a sensible default, not a final decision.
After completing the installation, restart your FiveM server.
Join your server, set a waypoint on the map, and check that the icon, the distance label and the route arrows appear.
Then open the creator:
/waypointIf the style creator opens, Quasar Waypoint has been installed correctly and your players can start building their own profiles.
The interface ships already compiled in
web/build/. Node.js is only needed if you plan to modify the frontend.