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.

1. Prérequis

Avant de commencer l'installation, assurez-vous d'avoir :

• 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
• Un framework compatible (ESX ou QBCore)

2. Télécharger zSleep

La première étape consiste à récupérer les fichiers du script :

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

3. Configurer la Base de Données

zSleep nécessite une configuration de base de données pour fonctionner correctement :

1. 1Ouvrez le fichier .sql situé dans le dossier zSleep
2. 2Connectez-vous à votre base de données MySQL (via un outil comme phpMyAdmin ou tout autre client SQL)
3. 3Importez le fichier .sql afin de créer les tables nécessaires au bon fonctionnement de zSleep

4. Configurer le Script

La configuration de zSleep se fait principalement via le fichier config.lua :

1. 1Accédez au fichier config.lua dans le dossier zSleep
2. 2Adaptez 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

Options de Configuration

Voici les différentes sections à configurer :

Paramètres Généraux

• Framework : Choisissez entre "esx" ou "qbcore" selon votre serveur
• Locale : Définissez la langue du script (par exemple "fr" pour français)
• LogoutEvent : Événement déclenché lors de la déconnexion d'un joueur (notamment utile pour les scripts multicharacter)

Section Carry (Transport)

• isEnabled : Active ou désactive la fonctionnalité de transport
• commandName : Nom de la commande pour porter un joueur
• targetEvent : Événement pour le système de ciblage (si applicable)
• key : Touche utilisée pour porter un joueur
• maxRadius : Distance maximale pour porter un joueur

Animations

Personnalisez les animations pour chaque action :

• sleeping : Animation de sommeil au sol
• gettingUp : Animation pour se lever
• sleepingInCar : Animation de sommeil dans un véhicule

Réglages des Peds

• alpha : Gère la transparence des Peds
• invincible : Détermine si les Peds sont invulnérables
• collision : Active ou désactive la collision des Peds

Notifications

La fonction SendNotification vous permet de personnaliser les notifications selon votre framework.

5. Démarrer le Script

Une fois la configuration terminée :

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

ensure zSleep

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

6. Vérifications et Tests

Après le démarrage du serveur :

1. 1Connectez-vous à votre serveur FiveM
2. 2Testez la commande /carry (ou celle que vous avez configurée)
3. 3Vérifiez les animations de sommeil, de réveil et les reconnexions après déconnexion
4. 4En cas d'erreurs, examinez la console du serveur pour identifier les problèmes

Support Technique

Si vous rencontrez des difficultés pendant l'installation :

• Consultez notre documentation en ligne
• Rejoignez notre serveur Discord pour obtenir de l'aide
• Ouvrez un ticket de support si nécessaire

Notre équipe est disponible pour vous aider avec l'installation et la configuration de zSleep.