Installation

Requirements

• A FiveM server with OneSync enabled.
• An up-to-date FS-Lib, even when using another interaction backend. It supplies the startup version check.
• One interaction backend: FS-Lib (default), qb-target or ox_target.
• The supplied built resource, including its streamed models and NUI files.

No SQL database or external map service is required. The map is bundled. FS-Blackout is optional; LUX authorization is optional and disabled by default.

Install

1. Put the built FS-HighwaySigns folder in your server's resources folder. Its top level must contain fxmanifest.lua, config.lua, data, stream and nui.
2. Keep the resource name FS-HighwaySigns. Do not also start the old fs_us_signs resource: it uses the same model names.
3. Choose your interaction backend in the installed config.lua:

Config.Interaction = 'fs-lib' -- Or 'qb-target' or 'ox_target'

4. Start dependencies before HighwaySigns:

ensure FS-Lib
# If selected, ensure qb-target or ox_target here.
ensure FS-HighwaySigns

add_ace group.admin highwaysigns.admin allow

Your administrator must belong to the principal receiving that ACE. Granting an ACE to a group does not itself put a player in that group.

5. As an authorized administrator, use /signadmin, add a sign and save its placement. Walk to its ground cabinet to open the player controller.

Before making this available to players

The supplied operate, repair and physical sabotage settings are public by default. Review permissions rather than assuming only DOT can use them. Linking requires its own ACE by default.

Keep data/signs.json valid and writable. Missing or malformed placement data disables writes instead of silently replacing your signs.

Updating an existing server

Back up the installed config.lua and entire data folder before replacing a resource. Merge new configuration options into your settings and preserve the live placement JSON. Restart only when you are ready to load the update.

For source builds, root pnpm build packages src/ and the rebuilt ui/ into FS-HighwaySigns/. The current build replaces packaged config and source-provided placement JSON. Copy live changes back to the appropriate source files before building if you want them in that package. Do not assume an old output folder protects live settings.