💾X Weather & Time

Your Full Weather Control UI

🌦️ X Weather & Time System Documentation

Welcome to the documentation for X_UTILITY Weather & Time System, a comprehensive solution for managing weather and time on your FiveM server. This script allows admins to create immersive environments with customizable weather cycles and advanced time controls.

---

🚀 Key Features

• Dynamic Weather System 🌧️☀️: Create customizable weather cycles with smooth transitions that enhance immersion.

• Advanced Time Controls ⏰: Freeze, speed adjust, sync with real-time, and enable blackout mode for ultimate environmental control.

• Beautiful Admin Interface 🎨: Intuitive UI with customizable animations, colors, and effects for weather and time management.

• Framework Ready 🛠️: Works seamlessly with ESX and QB-Core.

• Customizable Design 🎨: Adjust every aspect of the UI to match your server's unique style.

• Smooth Transitions 🔄: Weather and time changes happen gradually for a more natural experience.

• Admin Permissions 👮‍♂️: Role-based access control for server staff.

• Notification System 📢: Visual alerts with customizable icons and colors.

---

📦 What's Included

• Comprehensive Documentation 📚: Step-by-step guides for easy setup.

• Pre-configured Templates 📄: Multiple UI themes and weather presets included.

• Priority Support 🛡️: Direct assistance from developers via Tebex for smooth implementation.

---

🛠️ Installation

Step 1: Download the Resource

1. Visit the FiveWorld Shop and download the X_UTILITY Weather & Time System resource.

2. Extract the downloaded file to your server's resources folder.

Step 2: Add to Server Configuration

Add the following line to your server.cfg file to ensure the resource starts automatically:ensure X_UTILITY_WeatherAndTime

Step 3: Customize the UI (Optional)

The UI appearance can be customized in configuration/config.js. Here’s an example of how to customize the theme colors:JavaScriptCopy

const GlassConfig = {
    ui: {
        theme: {
            primary: 'rgba(255, 140, 0, 1.0)',
            secondary: 'rgba(255, 165, 0, 0.8)',
            accent: 'rgba(255, 100, 0, 1.0)'
        }
    }
};

---

📖 Configuration

Main Configuration

All weather and time settings are stored in configuration/config.json:

• Weather Types: List of available weather types.

• Default Weather: The weather type the server starts with.

• Default Time: The time the server starts with (in HH:MM format).

• Time Speed Multiplier: Controls how fast time passes (1.0 = normal speed).

• Blackout Enabled: Whether blackout mode is enabled by default.

• Freeze Time: Whether time is frozen by default.

• Real Time Sync: Whether the server time syncs with real-world time.

UI Configuration

The UI appearance can be customized in configuration/config.js:

• Colors and Theme: Customize the primary, secondary, and accent colors.

• Blur Effects: Adjust the blur strength for different UI elements.

• Fonts and Text Styles: Change font families, sizes, and weights.

• Animations and Effects: Enable or disable shine and glow effects.

Permissions

Configure admin access in configuration/config.lua:luaCopy

Config.AdminGroups = {
    ['admin'] = true,
    ['superadmin'] = true,
    ['mod'] = true
}

---

📌 Commands

• /weatherui - Open the weather and time UI.

• /weather [type] - Change current weather.

• /time [hour] [minute] - Set specific time.

• /blackout - Toggle blackout mode.

• /dynamicweather - Toggle dynamic weather system.

• /freezetime - Freeze/unfreeze time.

• /realtime - Sync with real-world time.

---

⚠️ Troubleshooting

• Weather Not Changing: Ensure the weather command is being used correctly and that the weather type is valid.

• Time Not Syncing: Check that the realtime command is used and that the server time is not frozen.

• UI Not Displaying: Verify that the resource is properly installed and that there are no errors in the server console.