Installation

Ce guide d'installation de zSleep s'adresse aux administrateurs de serveurs FiveM et détaille les étapes nécessaires pour installer et configurer le script selon vos besoins.

Prérequis

• Un serveur FiveM opérationnel.
• Accès à la base de données MySQL de votre serveur.
• Connaissances de base en configuration de scripts et édition de fichiers .lua.

Étape 1 : Télécharger zSleep

1. Obtenez le script zSleep via le lien fourni après votre achat.
2. Extrayez le fichier .zip téléchargé.
3. Copiez le dossier zSleep dans le répertoire resources de votre serveur FiveM.

   ⚠️ Assurez-vous qu'il démarre après oxmysql mais avant votre multicharacter (si applicable).

Étape 2 : Configurer la Base de Données

1. Ouvrez le fichier .sql situé dans le dossier zSleep.
2. Connectez-vous à votre base de données MySQL (via un outil comme phpMyAdmin ou tout autre client SQL).
3. Importez le fichier .sql afin de créer les tables nécessaires au bon fonctionnement de zSleep :
   • Important : Vérifiez que la base de données est bien liée à votre serveur dans le server.cfg.

Étape 3 : Configurer le Script

1. Accédez au fichier config.lua dans le dossier zSleep.
2. Adaptez la configuration selon vos besoins :

local Config <const> = {
    Framework = "esx", -- esx ou qbcore
    Locale = "fr",
    LogoutEvent = "",
    Carry = {
        isEnabled = true,
        commandName = "carry",
        targetEvent = "",
        key = "RCONTROL",
        maxRadius = 5
    },
    Animations = {
        ["sleeping"] = {
            dictionnary = "timetable@tracy@sleep@",
            animation = "idle_c"
        },
        ["gettingUp"] = {
            dictionnary = "get_up@sat_on_floor@to_stand",
            animation = "getup_0"
        },
        ["sleepingInCar"] = {
            dictionnary = "random@car_sleeping",
            animation = "sleeping_idle"
        }
    },
    Peds = {
        alpha = true,
        invincible = true,
        collision = false
    },
    SendNotification = function(message)
        local ESX = exports["es_extended"]:getSharedObject()
        ESX.ShowNotification(message)
    end
}

_ENV.Config = Config

3. Événement de déconnexion : Si un script multicharacter gère les changements de personnages sans déconnexion, configurez l'événement pour que zSleep le prenne en compte.

4. Personnalisation de la Section Carry : Ajustez cette section pour configurer la commande de transport, la touche associée, le target (le cas échéant) et le rayon selon vos préférences.

5. Modifications des Animations : Pour personnaliser les animations, remplacez les dictionnaires et noms d'animations dans la section Animations. Assurez-vous que les animations sont adaptées au contexte du script.

6. Réglages des Peds : Modifiez les paramètres de la section Peds pour ajuster la visibilité, l'invincibilité et la collision des Peds selon vos besoins, garantissant une meilleure interaction joueur-Ped.

7. Configuration de la Langue : Modifiez la valeur de Locale pour choisir la langue du script et proposer une expérience utilisateur personnalisée.

Étape 4 : Démarrer le Script

1. Ouvrez le fichier server.cfg de votre serveur FiveM.
2. Ajoutez la ligne suivante pour activer zSleep :

ensure zSleep

3. Redémarrez votre serveur pour appliquer les changements.

Étape 5 : Vérifications et Tests

1. Connectez-vous à votre serveur FiveM.
2. Testez la commande /carry (ou celle que vous avez configurée) pour valider le bon fonctionnement du script.
3. Vérifiez les animations de sommeil, de réveil et les reconnexions après déconnexion.
4. En cas d'erreurs ou de messages dans la console, examinez la configuration du fichier config.lua et les dépendances nécessaires.

Support

Pour toute question ou aide technique, rejoignez-nous sur notre serveur Discord. Notre équipe est disponible pour vous aider avec l'installation et la configuration de zSleep.

---

Ce guide vous permet de configurer et intégrer rapidement zSleep à votre serveur FiveM, offrant une expérience immersive de sommeil à vos joueurs.