BLN Studio Docs - RedM Scripts

Appearance

🎮 BLN Loading Screen ​

bln loading screen redm

📺 Preview ​

Video Preview

💰 Get it now ​

Download

Transform your RedM server's first impression with a stunning, interactive loading screen! this loading screen provides an immersive and professional experience for your players at no cost.

✨ Features ​

  • 🎵 Dual Content Modes - Support for both video and image slideshows with background music
  • 🎯 Interactive Elements - Clickable rules and staff information modals
  • 🎶 Audio Controls - Mute/unmute functionality with smooth audio integration
  • 🌈 Customizable Theming - Easily change colors and branding to match your server
  • 🔄 Smooth Transitions - Elegant animations and content rotation system
  • 📱 Responsive Design - Works perfectly on all screen sizes and resolutions
  • ⚡ Auto-Shutdown - Intelligent loading completion detection with customizable timing
  • 👥 Player Integration - Displays player count and connection information
  • 📊 Real-time Data - Live server information and player statistics

🛠️ Installation ​

  1. Download the resource files
  2. Extract the bln_loading folder to your server's resource directory
  3. Add ensure bln_loading to your server.cfg
  4. Configure the settings in ui/config.js to match your server
  5. Replace ui/logo.png with your server's logo
  6. Add your background media files to ui/sources/
  7. Restart your server and enjoy!

⚙️ Configuration ​

The loading screen has two configuration files: config.lua for server-side settings and ui/config.js for client-side UI settings.

config.lua ​

The config.lua file contains server-side settings for the loading screen.

lua
-- This is backend config file, ui config is in the `ui/config.js` file
Config = {}
Config.autoShutdown = true -- Auto shuts down the loading screen when loading is complete.
  • Config.autoShutdown:
    • true: The loading screen will shut down automatically after loading is complete.
    • false: You need to trigger the shutdown manually from another resource.

ui/config.js ​

All client-facing options can be customized in the ui/config.js file. This includes changing the content mode, theme colors, branding, rules, staff, and media sources.

javascript
window.LoadingScreenConfig = {
    previewType: "images",   // "images" or "video"
    primaryColor: "#d4af37", // Primary theme color
    logoURL: "./logo.png",
    displayPlayerCount: true, // Shows or hides the player count.
    displayPlayerName: true, // Shows or hides the player name.

    rules: {
        enable: true, // Shows or hides the rules button.
        title: "Server Rules",
        items: [
            {
                title: "General Conduct",
                description: "Be respectful to all players and staff members. No harassment, discrimination, or toxic behavior will be tolerated."
            },
            {
                title: "No Exploiting",
                description: "Using any bugs, glitches, or exploits to gain an unfair advantage is strictly prohibited and will result in a permanent ban."
            },
            {
                title: "Roleplay Standards",
                description: "Maintain high-quality roleplay at all times. Stay in character and avoid breaking immersion for other players."
            },
            {
                title: "Vehicle Rules",
                description: "No vehicle ramming, stealing without proper roleplay, or using vehicles unrealistically. Follow traffic laws when appropriate."
            },
            {
                title: "Communication",
                description: "Use appropriate channels for different types of communication. No spamming, advertising, or inappropriate content."
            }
        ]
    },

    staff: {
        enable: true, // Shows or hides the staff button.
        title: "Staff Team",
        members: [
            {
                name: "Galaxy",
                role: "Owner",
                description: "Server founder and main administrator. Contact for major issues or appeals."
            },
            {
                name: "AdminMike",
                role: "Head Administrator",
                description: "Oversees daily operations and handles complex situations. Available for rule clarifications."
            },
            {
                name: "ModSarah",
                role: "Moderator",
                description: "Handles player reports and maintains community standards. First point of contact for issues."
            },
            {
                name: "SupportTom",
                role: "Support Staff",
                description: "Assists new players and provides technical support. Great for getting started questions."
            }
        ]
    },

    video: {
        intervalTime: 4000, // 4 seconds between content changes
        volume: 0.1,        // Video volume (0.0 to 1.0)
        src: "./sources/video.webm",
        contents: [
            {
                title: "Welcome to Our Server",
                description: "Experience the ultimate gaming environment with custom features and active community support."
            },
            {
                title: "Amazing Features",
                description: "Discover unique gameplay mechanics, custom vehicles, and exclusive content created just for you."
            },
            {
                title: "Active Community",
                description: "Join thousands of players in our vibrant community. Make friends and create unforgettable memories."
            },
            {
                title: "Getting Started",
                description: "New to our server? Check out our beginner guides and helpful community to get you started."
            }
        ]
    },

    images: {
        intervalTime: 3000, // 3 seconds between image content changes
        bgMusic: "./sources/bg-audio.mp3",
        musicVolume: 0.1,   // Background music volume (0.0 to 1.0)
        sources: [
            {
                title: "ROBBERIES",
                description: "Plan your heists carefully - robberies are only permitted during nighttime hours and require a minimum posse of three outlaws. Safety in numbers, partner.",
                src: "./sources/image-1.jpg"
            },
            {
                title: "WELCOME TO THE FRONTIER",
                description: "Step into an immersive Wild West roleplay experience. From humble homesteader to notorious outlaw, forge your own path in our thriving community.",
                src: "./sources/image-2.png"
            },
            {
                title: "LAWMAN'S CODE",
                description: "Maintain order and civility in our frontier town. Respect your fellow players, avoid breaking character, and handle disputes through proper roleplay channels.",
                src: "./sources/image-3.jpg"
            },
            {
                title: "ESSENTIAL CONTROLS",
                description: "Master these vital controls to navigate the frontier - [F] to interact, [L-ALT] to open your inventory, [B] to open your satchel, and [K] to check your tasks.",
                src: "./sources/image-4.jpg"
            }
        ]
    }
};

Exports & Events ​

The loading screen can be shut down automatically or manually from another resource:

Automatic Shutdown ​

Set in your config.lua:

lua
Config.autoShutdown = true

With this setting, the loading screen will automatically shut down after loading is complete.

Manual/External Shutdown ​

Set in your config.lua:

lua
Config.autoShutdown = false

With this setting, you need to trigger the shutdown from another resource. The resource provides a simple export to do this:

lua
-- In your character selection or spawn script
exports['bln_loading']:manualShutdown()

Use this in client-side scripts to manually hide the loading screen if needed.

🤝 Support ​

Need help? Have questions? Join our Discord server for support and updates!

  • 💬 Discord: Join Here
  • 🎮 Live support and community help
  • 🔄 Regular updates and improvements
  • 📝 Documentation and tutorials
  • 🎯 Feature requests and feedback

📝 License ​

This resource is completely free for all RedM server owners. Feel free to use it on your server and customize it to your needs. Please don't remove the BLN Studio credits from the code.

Made with ❤️ by BLN Studio - Creating quality RedM resources since 2023