installations

📋 Documentation d'Installation - GW Gang System

Table des matières

1. Prérequis

2. Installation

3. Configuration

4. Dépendances

5. Configuration du Framework

6. Configuration Discord

7. Configuration des Administrateurs

8. Configuration des Zones

9. Personnalisation

10. Dépannage

---

Prérequis

Système

• FiveM Server avec la version cerulean ou supérieure

Frameworks supportés

Le script supporte les frameworks suivants :

• ESX (Legacy)

• QBCore / QB

• OX (Overextended)

• QBox

• VRP2

• Standalone (sans framework)

Dépendances obligatoires

Les ressources suivantes doivent être installées et démarrées AVANT ce script :

1. ox_lib (obligatoire)

   • Lien : https://github.com/overextended/ox_lib

   • Version minimale : dernière version stable

   • Installation : Suivre les instructions du dépôt GitHub

2. PolyZone (obligatoire)

   • Lien : https://github.com/mkafrin/PolyZone

   • Installation : Télécharger et placer dans le dossier resources

   • Nécessaire pour le système de zones et territoires

3. pmp_st_sweet (obligatoire)

   • Lien : https://www.gta5-mods.com/player/female-ped-sweet-pimpmyped-fivem

   • Installation : Télécharger et placer dans le dossier resources

   • Utilisé pour certains PNJ du script

Dépendances optionnelles

• ox_inventory : Pour l'intégration de l'inventaire (recherche de joueurs)

• ox_target : Pour les interactions avec ox_target (optionnel, peut utiliser la touche E)

---

Installation

Étape 1 : Téléchargement

1. Téléchargez le script gw-gang

2. Placez-le dans votre dossier resources

3. Renommez le dossier si nécessaire (ex: [scripts-gw-shop]/gw-gang)

Étape 2 : Installation des dépendances

Assurez-vous que toutes les dépendances sont installées :

# Structure recommandée
resources/
├── ox_lib/
├── PolyZone/
├── pmp_st_sweet/
└── [scripts-gw-shop]/
    └── gw-gang/

Étape 3 : Configuration du server.cfg

Ajoutez les ressources dans l'ordre suivant dans votre server.cfg :

# Dépendances (à démarrer en premier)
ensure ox_lib
ensure PolyZone
ensure pmp_st_sweet

# Script principal
ensure gw-gang

⚠️ IMPORTANT : L'ordre de démarrage est crucial. Les dépendances doivent être démarrées AVANT le script principal.

Étape 4 : Redémarrage du serveur

1. Redémarrez votre serveur FiveM

2. Vérifiez les logs pour confirmer que toutes les ressources se chargent correctement

3. Vérifiez qu'il n'y a pas d'erreurs dans la console

---

Configuration

Fichier principal : config.lua

Le fichier config.lua contient toutes les configurations du script. Ouvrez-le et configurez selon vos besoins.

Configuration minimale requise

1. Framework

Config.Framework = 'esx' -- Changez selon votre framework

Options disponibles : 'esx', 'qbcore', 'qb', 'ox', 'qbox', 'vrp2', 'standalone'

2. Mode Debug

Config.Debug = true -- Mettez à false en production

3. Permissions de création de gang

Config.AllowEveryoneCreateGang = false -- true = tout le monde peut créer, false = whitelist uniquement

---

Configuration du Framework

ESX

Si vous utilisez ESX, assurez-vous que :

• ESX est installé et fonctionnel

• Le script es_extended est démarré

• La configuration est définie sur Config.Framework = 'esx'

QBCore / QB

Si vous utilisez QBCore :

• QBCore est installé et fonctionnel

• Le script qb-core est démarré

• La configuration est définie sur Config.Framework = 'qbcore' ou 'qb'

OX Framework

Si vous utilisez OX :

• OX est installé et fonctionnel

• La configuration est définie sur Config.Framework = 'ox'

VRP2

Si vous utilisez VRP2 :

• VRP2 est installé et fonctionnel

• La configuration est définie sur Config.Framework = 'vrp2'

Standalone (Sans framework)

Si vous n'utilisez pas de framework :

• La configuration est définie sur Config.Framework = 'standalone'

• Certaines fonctionnalités peuvent être limitées

---

Configuration Discord

Fichier : discord.lua

Le fichier discord.lua contient la configuration des webhooks Discord pour les logs.

Configuration des webhooks

Ouvrez discord.lua et configurez les webhooks pour chaque événement :

DiscordWebhooks.Config = {
    -- Gestion des gangs
    gang_created = "VOTRE_WEBHOOK_URL_ICI",
    gang_deleted = "VOTRE_WEBHOOK_URL_ICI",
    gang_name_changed = "VOTRE_WEBHOOK_URL_ICI",
    
    -- Gestion des membres
    member_invited = "VOTRE_WEBHOOK_URL_ICI",
    member_joined = "VOTRE_WEBHOOK_URL_ICI",
    member_kicked = "VOTRE_WEBHOOK_URL_ICI",
    
    -- Missions
    dead_drop_started = "VOTRE_WEBHOOK_URL_ICI",
    gofast_started = "VOTRE_WEBHOOK_URL_ICI",
    vehicle_theft_started = "VOTRE_WEBHOOK_URL_ICI",
    
    -- ... et tous les autres webhooks
}

Création d'un webhook Discord

1. Allez dans les paramètres de votre serveur Discord

2. Cliquez sur "Intégrations" → "Webhooks"

3. Cliquez sur "Nouveau webhook"

4. Copiez l'URL du webhook

5. Collez l'URL dans le fichier discord.lua

Note : Si un webhook n'est pas configuré, le script utilisera un webhook par défaut.

---

Configuration des Administrateurs

Licenses autorisées

Pour autoriser des administrateurs à utiliser les commandes admin et le créateur de zones, vous devez ajouter leurs licenses dans config.lua.

1. Commandes Admin

Config.AdminCommands = {
    enabled = true,
    allowedLicenses = {
        "license:1234567890abcdef1234567890abcdef12345678",
        "license:abcdef1234567890abcdef1234567890abcdef12",
        -- Ajoutez les licenses de vos administrateurs ici
    },
}

2. Créateur de Zones

Config.ZoneCreator = {
    enabled = true,
    allowedLicenses = {
        "license:1234567890abcdef1234567890abcdef12345678",
        -- Ajoutez les licenses de vos administrateurs ici
    },
}

Obtenir la license d'un joueur

Pour obtenir la license d'un joueur :

• Utilisez la commande /license <id> si disponible sur votre serveur

• Ou consultez les logs de connexion du serveur

• Ou utilisez une ressource d'administration

Format de la license : license:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx (40 caractères hexadécimaux)

---

Configuration des Zones

Création de zones de territoire

Les zones de territoires peuvent être créées de deux manières :

Méthode 1 : Via le jeu (Recommandé)

1. Connectez-vous en tant qu'administrateur autorisé

2. Utilisez la commande /zonecreator

3. Suivez les instructions à l'écran :

   • Touche E : Placer un point

   • Touche R : Retirer le dernier point

   • Touche ESC : Ouvrir le menu de gestion

4. Sauvegardez la zone via le menu

Méthode 2 : Via le code

Les zones sont stockées dans le système de stockage du script. Consultez la documentation technique pour plus de détails.

Couleurs des zones

Vous pouvez personnaliser les couleurs par défaut des zones dans config.lua :

Config.DefaultZoneColors = {
    fill = {0, 100, 255},      -- Couleur de remplissage (RGB)
    border = {255, 255, 255},  -- Couleur de bordure (RGB)
    alpha = 0.3                 -- Transparence (0.0 à 1.0)
}

---

Personnalisation

Couleurs du menu

Les couleurs du menu peuvent être personnalisées dans config.lua :

Config.MenuColors = {
    primary = {
        rgb = {r = 200, g = 30, b = 30},
        rgba = {r = 200, g = 30, b = 30, a = 0.85},
        hex = "#c81e1e",
    },
    -- ... autres couleurs
}

Notifications

Le script supporte trois types de notifications :

Config.UseCustomNotifications = "gw"  -- Options: "gw", "ox", "native"

• "gw" : Notifications personnalisées GW (recommandé)

• "ox" : Notifications ox_lib

• "native" : Notifications natives FiveM

HUD de gang

Activez ou désactivez le HUD de gang :

Config.GangHud = {
    enabled = true,
    position = "top-left"  -- Options: "top-left", "top-right", "bottom-left", "bottom-right"
}

Système de présence dans les territoires

Configurez le gain de points par présence :

Config.TerritoryPresence = {
    enabled = true,
    intervalSeconds = 10*60,        -- Intervalle en secondes (10 minutes)
    pointsPerInterval = 1,          -- Points gagnés par intervalle
    pointName = "Point de présence",
    requireOwnTerritory = false,    -- true = uniquement dans son territoire
    notificationEnabled = true,
}

Boutique de gang

Configurez les items disponibles dans la boutique :

Config.Shop = {
    enabled = true,
    -- ... configuration des items
}

Coffres et garages

Configurez les coffres et garages :

Config.Stash = {
    enabled = true,
    -- ... configuration
}

Config.Garage = {
    enabled = true,
    -- ... configuration
}

Missions

Toutes les missions sont configurables dans config.lua :

• Dead Drop

• GoFast

• Vol de véhicules

• Livraison de drogue

• Assassinat

• Braquages (Bijouterie, Fleeca, Supérettes, ATM, Armurerie, Conteneurs)

Système de quêtes

Activez et configurez les quêtes :

Config.Quests = {
    enabled = true,
    showAllQuests = true,  -- Afficher toutes les quêtes ou sélection aléatoire
    questList = {
        -- ... liste des quêtes
    },
}

---

Commandes disponibles

Commandes joueur

• /gangmenu : Ouvrir le menu principal du gang

• /gang : Alias pour /gangmenu

Commandes administrateur

• /gangadmin : Menu d'administration des gangs

• /zonecreator : Activer/désactiver le mode création de zones

• /cancreate <id> : Ajouter un joueur à la whitelist de création de gang

---

Dépannage

Problèmes courants

1. Le script ne se charge pas

Solution :

• Vérifiez que toutes les dépendances sont installées et démarrées

• Vérifiez l'ordre de démarrage dans server.cfg

• Consultez les logs du serveur pour les erreurs

2. Erreur "ox_lib not found"

Solution :

• Installez ox_lib depuis : https://github.com/overextended/ox_lib

• Assurez-vous qu'il est démarré avant gw-gang

3. Erreur "PolyZone not found"

Solution :

• Installez PolyZone depuis : https://github.com/mkafrin/PolyZone

• Assurez-vous qu'il est démarré avant gw-gang

4. Les zones ne s'affichent pas

Solution :

• Vérifiez que le fichier stream/glife_map_overlay.gfx est présent

• Vérifiez que le stream est activé dans fxmanifest.lua

• Redémarrez le serveur

5. Les commandes admin ne fonctionnent pas

Solution :

• Vérifiez que votre license est dans Config.AdminCommands.allowedLicenses

• Vérifiez que Config.AdminCommands.enabled = true

• Vérifiez le format de la license (doit commencer par "license:")

6. Le framework n'est pas détecté

Solution :

• Vérifiez que Config.Framework correspond à votre framework

• Vérifiez que votre framework est démarré et fonctionnel

• Consultez les logs pour les erreurs de chargement du framework

7. Les webhooks Discord ne fonctionnent pas

Solution :

• Vérifiez que les URLs des webhooks sont correctes

• Vérifiez que les webhooks Discord sont actifs

• Testez les URLs dans un navigateur

Logs et débogage

Activez le mode debug pour plus d'informations :

Config.Debug = true

Les logs apparaîtront dans la console du serveur et vous aideront à identifier les problèmes.

Support

Pour obtenir de l'aide :

1. Consultez les logs du serveur

2. Activez le mode debug

3. Vérifiez la documentation technique

4. Contactez le support si nécessaire

---

Notes importantes

Performance

• Le script est optimisé pour les serveurs avec de nombreux joueurs

• Les zones sont chargées de manière asynchrone

• Le système de présence utilise des intervalles pour éviter la surcharge

Sécurité

• Les commandes admin sont protégées par système de licenses

• Les données sont validées côté serveur

• Les webhooks Discord permettent de surveiller les activités

Mises à jour

• Sauvegardez toujours votre config.lua avant de mettre à jour

• Consultez les notes de version pour les changements

• Testez les mises à jour sur un serveur de test avant la production

---

Structure des fichiers

gw-gang/
├── client/              # Scripts côté client
│   ├── core/           # Scripts core
│   ├── frameworks/     # Intégrations frameworks
│   ├── modules/        # Modules fonctionnels
│   └── utils/          # Utilitaires
├── server/             # Scripts côté serveur
│   ├── core/           # Scripts core
│   ├── frameworks/     # Intégrations frameworks
│   ├── modules/        # Modules fonctionnels
│   └── utils/          # Utilitaires
├── html/               # Interface utilisateur (NUI)
├── mission/            # Scripts de missions
├── stream/             # Fichiers de stream (zones)
├── config.lua          # Configuration principale
├── discord.lua         # Configuration Discord
└── fxmanifest.lua      # Manifest FiveM

---

Conclusion

Une fois toutes les étapes suivies, votre script GW Gang System devrait être opérationnel. N'hésitez pas à personnaliser la configuration selon vos besoins et à consulter les autres fichiers de documentation pour plus de détails sur les fonctionnalités spécifiques.