FivePRS Addons

Official optional resources for FivePRS. Each one is a standalone FiveM resource; use the ones you want.

Addon	What it does
fiveprs_loadscreen	A FivePRS loading screen with tips, music and a welcome back card
fiveprs_presence	Shows each player's FivePRS activity in their Discord status
fiveprs_notes	A Notes app for the FivePRS terminal, and an example terminal app

Installation

1. Install FivePRS first.
2. Download fiveprs_addons.zip from the latest release.
3. Extract it into your server's resources/ folder. It contains a [fiveprs_addons] folder with every addon inside.
4. Add the addons you want to server.cfg, after ensure fiveprs:

ensure fiveprs
ensure fiveprs_loadscreen
ensure fiveprs_presence
ensure fiveprs_notes

To start every addon at once, use the folder instead:

ensure fiveprs
ensure [fiveprs_addons]

fiveprs_loadscreen

fiveprs_loadscreen is a FivePRS-branded loading screen: load progress, rotating tips and a welcome back card with the player's agency and rank. Add ensure fiveprs_loadscreen to server.cfg to use it, and set your server name and tips in its config.js. Leave it out if your server already has a loading screen.

For background music, put .mp3 or .ogg files in the addon's music/ folder and list them under music.tracks in config.js, along with volume and shuffle. Direct links to audio files also work. No music ships with FivePRS, so only use tracks you have the rights to. Players can mute it from the button in the top-right corner, and the choice is remembered.

fiveprs_presence

fiveprs_presence shows each player's FivePRS activity in their Discord status, such as 1-ADAM-12 · Responding to Shoplifting, 1-ADAM-12 · Available in Mission Row or Civilian in Vinewood. It refreshes every RefreshSeconds (10 by default) and reads its state from the fiveprs resource.

Settings are in its config.lua:

Setting	Description
AppId	Discord application ID. Defaults to the official FivePRS application, which shows the FivePRS name and images. Set your own to brand it for your server, or leave it empty to show the text under FiveM's own presence without images or buttons.
LargeImage	Asset key and hover text for the large image.
DepartmentImages	Asset key and hover text for the small image shown while on duty, per department.
CivilianImage	Asset key and hover text for the small image shown off duty. Set it to nil to show none.
Text	Status text for onCall, onDuty and offDuty.
Statuses	Display names for unit statuses.
Buttons	Up to two buttons, each { label = 'Join Discord', url = 'https://discord.gg/...' }.

Text can use {name}, {department}, {agency}, {callsign}, {rank}, {status}, {territory}, {call}, {callId} and {location}. Duty and call values are only available while on duty.

To use your own application, create one in the Discord Developer Portal, copy its application ID into AppId, and upload images under Rich Presence > Art Assets using the asset keys in config.lua (fiveprs_logo, police, ems, fire and civilian by default).

fiveprs_notes

fiveprs_notes adds a Notes app to the FivePRS terminal: a personal notepad for plates, names and anything else worth remembering. Notes are saved on the player's own PC, and the app shows a dot on the home screen while there are notes. Ctrl+S saves.

It is also the reference example of a terminal app made from a resource: client.lua registers the app with exports.fiveprs:registerApp and handles its actions in fiveprs:appAction, and html/ is the app page, which uses the FivePRS app SDK. Copy it as a starting point for your own apps.