Installation

Complete step-by-step guide to installing the Finals Web Panel bridge on your FiveM server.

1. Prerequisites

Before installing the bridge resource, ensure your FiveM server meets the following requirements:

RequirementSupported VersionsNotes
FXServer Artifact7290 or newerRecommended Cerulean build.
ox_libLatest ReleaseCore utility dependency for safe data handling and exports.
FrameworkQBCore, Qbox, ESX (Legacy/v1), ox_coreAuto-detected on startup via built-in adapters.
Network OutboundHTTPS / WSSZero open ports required. All communication is initiated outbound by your server to our secure cloud API.
Live SpectatingBuilt-InNo external capture resources required. Direct 720p 30 FPS video stream with 0.00ms server overhead.

[!NOTE] No Firewall / Port Forwarding Needed: Unlike legacy RCON panels, the Finals Web Panel does not require opening custom ports on your VPS/dedicated server. The bridge maintains an outbound secure connection to our cloud backend.


2. Download and Place the Resource

  1. Obtain the finals_webpanel resource folder from your Project Finals client dashboard or Discord purchase confirmation.
  2. Place the folder into your server's resources directory (recommended: resources/[finals]/finals_webpanel).

3. Configure Your Bridge Token

Open your server.cfg file and add the following lines at the bottom (or above your resource start order):

Config
# ==========================================
# Finals Web Panel Configuration
# ==========================================
setr finals_webpanel_token "br_YOUR_SERVER_TOKEN_HERE"

[!IMPORTANT] Replace br_YOUR_SERVER_TOKEN_HERE with the Bridge Token generated when adding your server in the Finals Web Panel dashboard. Never share this token publicly.


4. Optional Configuration Overrides

You can optionally configure the following ConVars in your server.cfg to override auto-detection:

ConVarOptions / DefaultDescription
finals_webpanel_frameworkqbcore / qbox / autoForce a specific framework adapter if running a hybrid setup.
finals_webpanel_tokenbr_xxxYour server bridge authentication secret.

5. Start Order in server.cfg

Ensure the resource is started after your core framework and utilities:

Config
# 1. Base dependencies
ensure ox_lib

# 2. Framework (e.g. QBCore or Qbox or ESX)
ensure qb-core

# 3. Finals Web Panel Bridge
ensure finals_webpanel

[!TIP] You do not need to install screencapture or screenshot-basic. Live Spectate is handled entirely by finals_webpanel natively.

When the bridge successfully authenticates, you will see the following output in your server console:

Plain text
[finals_webpanel] Initializing Project Finals Bridge v2.8.0...
[finals_webpanel] Framework detected: QBCore (auto-detect)
[finals_webpanel] Authenticated successfully with Project Finals Cloud.
[finals_webpanel] Live synchronization active.

Your server in the Web Panel will instantly change status to ONLINE (Green), and live player data will begin streaming.


6. Live Player Spectating (Zero Server Overhead)

The Finals Web Panel features a high-performance Live Spectate Engine. GTA V gameplay is streamed directly to authorized staff in the Web Panel with smooth 30 FPS video and zero server lag.

Key Highlights:

  • 0.00ms FXServer Tick Overhead: Zero screenshots captured via FXServer, zero DirectX pipeline stalls for the player, and zero CPU usage on the game server.
  • Zero Server Bandwidth: Real-time 720p 30 FPS video travels directly from the player's screen to the web panel. Video data never touches your server or backend API.
  • No External Resources Required: You do not need screencapture or screenshot-basic. Everything is built directly into finals_webpanel.
  • Instant Start & Stop: Start viewing any online player instantly by clicking Spectate in the Web Panel.