NQ SCRIPT DOCUMENTATION

Documentation/Loading ScreenLoading Screen

Loading ScreenLoading Screen

Vollständig konfigurierbarer Loading Screen mit Live-EditorFully configurable loading screen with a live editor

Aktuelle Version
v1.1
Typ
FiveM Script
Status
Veröffentlicht

Der NQ Loading Screen ist eine clientseitige FiveM-Ressource (NUI-basiert) für den Ladebildschirm deines Servers. Aussehen und Inhalt werden nicht in einer Lua-Config bearbeitet, sondern als JSON-Konfiguration über den Builder erzeugt und mit der Ressource ausgeliefert.

Technischer Aufbau

  • fxmanifest.lua, client/, server/: minimaler Lua-Anteil, steuert ausschließlich Anzeige und Ausblendung des Ladebildschirms
  • ui/: statisches HTML/CSS/JS-Bundle, das im NUI-Loadscreen gerendert wird
  • data/published.json: die im Builder erzeugte Konfiguration (Layout, Module, Theme) -- steuert, was ui/ anzeigt

Anforderungen

  • Aktueller FiveM-Server-Build
  • Keine Abhängigkeit zu ESX, QBCore oder einem anderen Framework -- die Ressource läuft vollständig unabhängig davon
  • Kein zusätzliches Script oder Dependency notwendig

Installation

  • Entpacke die heruntergeladene ZIP-Datei in den resources-Ordner deines FiveM-Servers.
  • Trage in deiner server.cfg die Zeile ensure nq_loadingscreen ein.
  • Starte den Server bzw. die Ressource neu.

Module (Architektur)

Jedes Modul ist ein eigenständiger UI-Baustein mit fester Position (x/y/width/height in %), Z-Reihenfolge und optionalen Style-Overrides (Deckkraft, Schriftart, Rahmen), die zur Laufzeit aus published.json gelesen werden:

  • Status: Server-Status, Server-Puls (Spieleranzahl, Warteschlange, Laufzeit)
  • Inhalt: Neuigkeiten, Regeln, Social-Links, Tipps, Änderungsprotokoll, individuelle Box, individueller Text
  • Medien: Musik mit Cover-Art-Player, Galerie
  • Community: Team-Übersicht, Event-Banner

Deaktivierte Module werden beim Export nicht mit in die Konfiguration geschrieben und verursachen keinerlei Laufzeit-Overhead.

Performance

Der Ladebildschirm besteht ausschließlich aus statischen Assets (HTML/CSS/JS, Bilder/Medien) ohne Server-seitige Logik oder Tick-Loops -- er belastet die Serverperformance nicht messbar.

Aktualisierung

Öffne den Builder, bearbeite deinen Entwurf und lade die aktualisierte Ressource erneut herunter. Ersetze anschließend die alte Ressource im resources-Ordner durch die neue und starte den Server neu.

Support

Bei technischen Problemen erreichst du uns direkt über unseren Discord Support.

NQ Loading Screen is a client-side FiveM resource (NUI-based) for your server's loading screen. Its look and content aren't edited in a Lua config -- they're generated as a JSON configuration through the Builder and shipped together with the resource.

Technical structure

  • fxmanifest.lua, client/, server/: minimal Lua code, only controls showing and hiding the loading screen
  • ui/: static HTML/CSS/JS bundle rendered inside the NUI loadscreen
  • data/published.json: the configuration generated by the Builder (layout, modules, theme) -- controls what ui/ displays

Requirements

  • Current FiveM server build
  • No dependency on ESX, QBCore or any other framework -- the resource runs fully independently
  • No additional script or dependency required

Installation

  • Extract the downloaded ZIP file into your FiveM server's resources folder.
  • Add ensure nq_loadingscreen to your server.cfg.
  • Restart your server, or just the resource.

Modules (architecture)

Each module is a self-contained UI building block with a fixed position (x/y/width/height in %), z-order, and optional style overrides (opacity, font, border) read from published.json at runtime:

  • Status: Server Status, Server Pulse (player count, queue, uptime)
  • Content: News, Rules, Social Links, Tips, Changelog, Custom Box, Custom Text
  • Media: Music with cover-art player, Gallery
  • Community: Team overview, Event banner

Disabled modules are never written into the exported configuration and add zero runtime overhead.

Performance

The loading screen consists entirely of static assets (HTML/CSS/JS, images/media) with no server-side logic or tick loops -- it has no measurable impact on server performance.

Updating

Open the Builder, edit your draft, and download the updated resource again. Then replace the old resource in your resources folder with the new one and restart your server.

Support

For technical issues, reach us directly through our Discord support.