Documentation

Wiki

Guides pour installer, configurer et administrer votre serveur.

Installation

Comment faire une installation propre ?

Dernière mise à jour, 24 juin 2026 · Par Surge Studio

Ce guide décrit la procédure complète pour déployer la Base Surge sur votre machine ou hébergeur, depuis la réception du dossier jusqu'au premier démarrage fonctionnel.

Ce que vous recevez à l'achat

Lors de l'achat de la base, vous recevez la totalité du dossier ressources de la Base Surge, à l'exception des éléments protégés par notre système de sécurité :

  • API de sécurité (SurgeShield) : licence liée à votre serveur, vérifiée au démarrage.
  • Obfuscation Lua : double couche : Luraph + couche secondaire propriétaire Surge Studio sur les scripts sensibles.

Ces protections garantissent l'intégrité de la base et empêchent la redistribution non autorisée. Vous disposez néanmoins de l'ensemble des ressources nécessaires au fonctionnement complet du serveur.

Le fichier SQL surge.sql est fourni directement dans le dossier ressources. Le pack de contribution stream est livré séparément (voir section dédiée plus bas).

Étape 1 : Copier les ressources

  1. Décompressez l'archive reçue (dossier resources ou équivalent).
  2. Copiez l'intégralité du contenu dans le dossier resources de votre serveur FiveM (chemin habituel : FXServer/server-data/resources/ ou via txAdmin).
  3. Vérifiez que la structure contient bien les dossiers [core], [gameplay], [outils], surge_core et SurgeShield.
  4. Ne modifiez pas les noms de dossiers entre crochets ([core], etc.) : ils sont requis par le server.cfg.
Arborescence du dossier resources : [core], [gameplay], [outils], surge_core et SurgeShield
Exemple d'arborescence correcte dans votre dossier resources

Étape 2 : Obtenir et configurer votre clé de licence

Pour démarrer le serveur, une clé de sécurité personnelle est obligatoire. Elle est liée à votre achat et à votre instance serveur.

  1. Rejoignez le Discord Surge Studio.
  2. Ouvrez votre ticket d'achat (ou créez-en un si nécessaire).
  3. Exécutez la commande /mykey dans ce ticket.
  4. Vous recevrez une clé au format : XXXXX-XXXXX-XXXXX-XXXXX-XXXXX.
  5. Ouvrez votre fichier server.cfg et ajoutez la ligne suivante (en remplaçant par votre clé) :
set lk_license "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX"
Sans cette ligne, le serveur refusera de démarrer les ressources protégées. Conservez votre clé confidentielle et ne la partagez pas publiquement.

Étape 3 : Configurer la base de données

La base utilise MySQL/MariaDB via oxmysql. Le fichier surge.sql fourni avec le dossier ressources contient toutes les tables nécessaires.

Option A : XAMPP (recommandé pour débuter en local)

  1. Téléchargez et installez XAMPP (inclut Apache, MySQL et phpMyAdmin).
  2. Lancez le panneau XAMPP et démarrez le module MySQL.
  3. Ouvrez phpMyAdmin (http://localhost/phpmyadmin).
  4. Créez une nouvelle base de données (ex. surge, interclassement utf8mb4_general_ci).
  5. Sélectionnez la base, onglet Importer, choisissez surge.sql, puis validez.
  6. Configurez la connexion dans votre server.cfg ou fichier de config oxmysql :
set mysql_connection_string "mysql://root@localhost/surge?charset=utf8mb4"

Option B : MariaDB (production / hébergeur)

  1. Téléchargez MariaDB Server ou utilisez celui fourni par votre hébergeur.
  2. Créez une base et un utilisateur dédié (évitez root en production).
  3. Importez surge.sql via la ligne de commande ou un client graphique comme HeidiSQL :
mysql -u utilisateur -p nom_de_la_base < surge.sql

Adaptez ensuite la chaîne de connexion dans votre configuration :

set mysql_connection_string "mysql://utilisateur:motdepasse@localhost:3306/nom_de_la_base?charset=utf8mb4"

Étape 4 : Pack de contribution stream

En complément du dossier ressources principal, un pack de contribution contenant un dossier stream vous est fourni en dehors de l'archive ressources.

  1. Placez le contenu du pack dans un dossier stream à la racine de votre dossier resources (ou intégrez-le selon la structure indiquée dans votre livraison).
  2. Assurez-vous que les assets streamés sont bien référencés par vos ressources (fxmanifest avec section files / data_file si applicable).
Avertissement : contenu leak : la majorité des éléments de ce pack de contribution proviennent de sources non officielles (leaks). En l'utilisant, vous restez entièrement responsable en cas de sanction de la part de CFX / Rockstar ou de tout autre organisme concernant l'utilisation de contenus leakés. Surge Studio ne peut être tenu responsable de l'usage que vous faites de ce pack sur votre serveur.

Étape 5 : Premier démarrage

  1. Vérifiez que lk_license et mysql_connection_string sont bien dans le server.cfg.
  2. démarrez le serveur via txAdmin ou votre méthode habituelle.
  3. Contrôlez la console : aucune erreur critique sur SurgeShield, oxmysql et surge_core.
  4. Connectez-vous en jeu et testez les menus (F10 staff, /gestion).

Étape 6 : Grade fondateur

Une fois connecté en jeu, le propriétaire du serveur doit s'attribuer le grade fondateur pour débloquer l'accès complet à la configuration (/gestion, permissions staff, etc.).

  1. Repérez votre ID Unique en jeu (affiché dans le menu personnel ou en haut du menu F10).
  2. Ouvrez la console serveur (txAdmin, console live FXServer ou terminal du serveur).
  3. Exécutez la commande ci-dessous en remplaçant ID_UNIQUE par votre identifiant :
setgroup ID_UNIQUE fondateur
Sans cette étape, vous resterez au grade user et ne pourrez pas configurer correctement votre serveur via /gestion ni gérer les permissions staff.
Console serveur au démarrage : SurgeShield chargé, Surge Base statut valide
Démarrage serveur sans erreur de licence ni de base de données
Besoin d'aide ? Ouvrez un ticket sur le Discord Surge Studio avec vos logs console et une capture de votre server.cfg (masquez les mots de passe).