-
Put the
ncore_warpdrive_loadingfolder intoresources/[ncore](create the[ncore]folder if you do not have one yet). -
Stop or remove any other loading-screen resource. Only one resource can declare a loading screen.
-
Add this line near the top of
server.cfg, before your other resources:server.cfgensure ncore_warpdrive_loading -
Put your music in
assets/audio/and list it undermusic.tracksinconfig.js. Put your logo inassets/img/if you want one. The manifest already packs .mp3 and .ogg music, .png, .jpg, .svg and .webp images and .webm, .mp4, .mkv, .m4v and .ogv videos. -
Set your server name, colors, links, rules, news and tips in
config.js, then restart the server.
The background is the 3D warp tunnel, so no video is needed. To use a video or images instead, put them in assets/video/ or assets/img/, list them in config.js and set video.enabled or image.enabled to true. The tunnel then turns off behind them, or stays as a light overlay with scene.withMedia: 'overlay'.
Optional convars#
Put them above ensure ncore_warpdrive_loading. README.md lists all of them with their defaults under Convars.
setr wdl:rulesGate 1
setr wdl:rulesVersion 1
setr wdl:newsUrl "https://example.com/news.json"Preview before you upload#
Double-click demo.html to see your screen in your desktop browser with every feature playing, straight from the folder. It reads your config.js, so you can check colors, brand texts, staff and music before restarting the server. News and tips in the demo are samples. The options and hotkeys are in README.md under Browser demo. Players never download the demo files.
Notes#
- Nothing else is required. QBox, QBCore and ESX are detected and only used for the player's character name. The screen can close before the character is loaded, so the FiveM name is shown most of the time.
- Do not rename the
ncore_warpdrive_loadingfolder. - Players without 3D graphics support (WebGL 2) automatically get the 2D background.
- The rules gate is a prompt held by the client script. The server saves the answer and drops players who decline, but it does not block anyone who has not accepted.
- Acceptances are written to
data/rules_accepted.json. Clear them withwdl_rules_reset allin the server console.
