Skip to content

General configuration

All visual customization and content is managed in config/config.js. This file exposes two objects: videoConfig (background video) and config (everything else).

TIP

The file is fully commented. This page summarizes the options and their effect.

Background video — videoConfig

js
const videoConfig = {
    useMp4: true, // true = local MP4, false = YouTube embed
    mp4Path: "/config/background_video/videoplayback.mp4",
    youtubeEmbedUrl: "https://www.youtube.com/embed/VIDEO_ID?autoplay=1&mute=1&loop=1&...",
};
OptionDescription
useMp4true for a local MP4 video, false for a YouTube embed
mp4PathPath to the MP4 (if useMp4: true)
youtubeEmbedUrlYouTube embed URL (if useMp4: false)

WARNING

For YouTube, use an /embed/ URL. Keep the autoplay=1&mute=1&loop=1 parameters for silent autoplay.

Debug mode

js
debug: true,

Enables detailed logs in the NUI console (F8 in-game): config loading, Discord cache, music player, section rendering… Set to false in production to reduce noise.

Server-side debug (Discord request) is configured separately in config/discord.lua (Debug = true).

js
server_logo: "/config/server_logo/logo_josk.png",
logo_bouncing: false, // true = floating animation, false = static
OptionDescription
server_logoPath to the logo shown top-right
logo_bouncingtrue for a vertical floating animation

Theme color

js
themeColor: "rgba(138, 180, 248, 0.9)", // blue

The primary color of the interface (accents, highlights). Accepts any CSS value: hex (#8ab4f8), rgb(), rgba().

Examples:

  • Blue: rgba(138, 180, 248, 0.9)
  • Pink: rgba(248, 138, 180, 0.9)

Fonts

js
theme_fonts_title: "Outfit", // titles and headers
theme_fonts_texte: "Outfit", // body text

Values must be valid Google Fonts names (fonts are loaded automatically).

js
social: {
    discord: "https://discord.gg/xxxxxx",
    tiktok: "https://www.tiktok.com/@yourserver",
    twitter: "https://x.com/yourserver",
    instagram: "https://www.instagram.com/yourserver",
},

Each link feeds the matching icon shown bottom-right. Leave an empty string for a network you don't use.

What's next

The other blocks of config.js (music, sections, rules, gallery, team, updates, news) are detailed on their own pages: