np_docs

Getting started ​

Every np_* resource installs the same way. The resource pages list what is specific to each one.

Requirements ​

  • A recent FiveM server artifact. The resources use state bags, GlobalState and Lua 5.4.
  • Node 18+, needed once to build each resource's NUI.
  • Optional framework, voice and inventory resources, depending on the resource. See its Installation page.

Install a resource ​

  1. Copy the resource into your resources/ folder. Keep the folder name (np_hud, np_phone, …), because the NUI callbacks use https://<resource>/… and depend on that name.
  2. Build the NUI:
    sh
    cd resources/np_hud/web
npm ci
npm run build
    This creates web/dist, which fxmanifest.lua loads as the ui_page. Without it, the resource starts with a blank UI. Resources without a web/ folder skip this step: np_helicam ships its NUI as plain files in html/, with nothing to build, and np_mdt ships its NUI prebuilt in nui/shell/.
  3. Ensure it after its dependencies in server.cfg. Framework and voice detection runs once, when the resource starts:
    cfg
    ensure oxmysql         # if the resource needs a database
ensure qbx_core        # or qb-core / es_extended
ensure pma-voice       # or saltychat / yaca-voice
ensure np_hud
ensure np_phone
ensure np_menu
ensure np_mdt          # MDT connection, see /mdt/installation
  4. Configure shared/config.lua and put any secrets in server.cfg (see Common concepts).

Ship the built NUI

If you deploy with git or a CI pipeline, either commit web/dist to your server's copy or run the build as a deploy step. The resource repos ignore web/dist.

Where to go next ​

np_hudv0.1.0

Nimbus UI HUD: status tiles, vehicle, minimap frame, notifications, prompts, progress bars and theming.

np_phonev0.1.0

iOS-styled roleplay phone with 25+ apps: calls, messages, wallet, garage, groups, Chirp, camera and more.

Not yet tested on a live server
np_menuv0.1.0

Menu system: list and grid menus, radial wheel, world-anchored context menus, dialogs, server actions and built-in admin, quick and shop menus.

Not yet tested on a live server
np_helicamv2.0.0

AIRSURV-style police helicopter camera: FLIR, ANPR + BOLO, PNT markers, mission log, live feed for ground units and a synced searchlight.

MDTnp_mdt v0.3.0

Mobile Dispatch Terminal: a hosted Discord bot and web board for roleplay agencies, with the np_mdt resource for the game server.

np_mdt not yet tested on a live server

np_* FiveM resources