Installation en localhost

Utilisez ce guide si vous installez votre base FiveM sur votre PC pour des tests, du développement ou une préconfiguration avant une mise en ligne sur hébergeur.

Prérequis

• Un PC Windows
• Un serveur FiveM local avec txAdmin ou FXServer
• Votre clé Cfx.re
• Votre clé API KLMSTUDIO
• Les fichiers de votre base déjà récupérés
• Un dossier resources déjà préparé dans la bonne arborescence

Résultat attendu

À la fin de ce guide, vous devez avoir :

• un dossier serveur FiveM fonctionnel
• les artefacts installés
• le dossier resources copié dans le serveur
• une base SQL importée et reliée au serveur
• la clé API ajoutée
• le serveur créé sur le panel KLMSTUDIO
• la configuration principale faite dans le panel

Étapes d'installation

1. Créer le dossier du serveur

Créez un dossier dédié à votre serveur, par exemple :

C:\FiveM-Server\

Travaillez toujours dans un dossier propre pour éviter de mélanger les fichiers FiveM, les ressources de la base et d'anciens tests.

2. Installer les artefacts

Les artefacts sont les fichiers nécessaires au démarrage du serveur FiveM en local.

1. Ouvrez l'archive des artefacts Windows déjà téléchargée.
2. Décompressez les fichiers dans votre dossier serveur.
3. Vérifiez que les fichiers principaux du serveur sont bien présents à la racine.

Lien utile : Mettre à jour les artefacts

3. Copier resources

Copiez le dossier resources préparé dans votre dossier serveur.

Votre arborescence doit ressembler à ceci :

C:\FiveM-Server\
├── resources/
│   ├── [base]/
│   ├── [clothes]/
│   ├── [essential]/
│   ├── [system]/
│   ├── [vocal]/
│   └── [cfx lock]/
│       ├── [stream]/
│       └── [klmstudios]/
│           ├── core/
│           ├── discord/
│           ├── es_extended/
│           ├── imagecapture/
│           ├── ox_inventory/
│           ├── web/
│           └── web2/
├── server.cfg
└── ...

4. Créer la base SQL

Avant d'importer le SQL, créez votre base locale dans MySQL ou MariaDB.

Exemple de nom de base :

klmstudios

Préparez aussi les informations suivantes :

• nom de la base
• utilisateur MySQL
• mot de passe MySQL
• port MySQL

5. Importer le SQL

Avec HeidiSQL ou un équivalent :

1. Connectez-vous à votre base locale.
2. Importez le SQL principal fourni avec la base.
3. Importez ensuite le FIX SQL fourni avec la base.

6. Configurer server.cfg

Ajoutez ou vérifiez dans votre server.cfg :

• la clé Cfx.re
• les endpoints
• OneSync
• la connexion MySQL

Gardez seulement les lignes techniques dans ce fichier. Le nom du serveur, le listing, la locale, les tags et les slots se gèrent ensuite depuis le panel KLMSTUDIO.

Ajoutez votre clé Cfx.re :

sv_licenseKey "VOTRE_CLE"

Chaque serveur doit avoir sa propre clé.

Ajoutez ensuite les endpoints :

endpoint_add_tcp "0.0.0.0:30120"
endpoint_add_udp "0.0.0.0:30120"

Si vous ne changez pas votre port, laissez 30120.

OneSync doit être activé :

• avec txAdmin, activez-le dans Settings -> FXServer -> OneSync
• sans txAdmin, ajoutez cette ligne dans votre server.cfg

set onesync on

Exemple :

sv_licenseKey "VOTRE_CLE"
endpoint_add_tcp "0.0.0.0:30120"
endpoint_add_udp "0.0.0.0:30120"
set onesync on
set mysql_connection_string "mysql://UTILISATEUR:MOT_DE_PASSE@localhost:3306/NOM_BASE"
set mysql_slow_query_warning 5000

7. Ajouter la Key API

Ouvrez le fichier config.cfg et ajoutez votre clé API :

setr klmstudios_license_key "VOTRE_CLE_API"
# Cle du telephone, produit separe (facultatif si vous ne l'avez pas) :
# setr zsphone_license_key "VOTRE_CLE_TELEPHONE"

Remplacez uniquement la valeur entre guillemets.

Lien utile : Clé API

8. Créer le serveur dans le panel KLMSTUDIO

Une fois le serveur local prêt :

1. Connectez-vous à panel.klmstudios.fr avec Discord.
2. Cliquez sur Ajouter un serveur.
3. Associez la bonne licence.
4. Renseignez l'IP utilisée par votre serveur.
5. Configurez les logs Discord si besoin.

Pour les logs Discord :

1. Créez une application sur le Discord Developer Portal.
2. Ajoutez le bot zLogs sur votre serveur Discord.
3. Dans OAuth2, ajoutez ces URLs :

https://panel.klmstudios.fr/auth/discord/callback
https://panel.klmstudios.fr/auth/discord/logs/callback

Lien utile : Créer son panel de logs

9. Configurer le panel

Une fois le serveur créé dans le panel, configurez les réglages principaux :

1. Dans Général, définissez le nom du serveur, la locale, les slots et les tags.
2. Dans Couleurs & logo, ajoutez votre identité visuelle.
3. Dans Écran de connexion, ajoutez vos boutons Discord, Wiki et Guide.
4. Dans Menus & interfaces, choisissez le style global.
5. Dans Thème RageUI, réglez la bannière et les couleurs.
6. Dans Avancé, renseignez vos liens Discord et boutique.

Lien utile : Configuration via le Panel

10. Premier démarrage

Lancez ensuite votre serveur local et vérifiez :

1. qu'aucune erreur SQL ne s'affiche
2. que la clé API est bien reconnue
3. que les ressources démarrent correctement
4. que le serveur apparaît dans votre console sans erreur bloquante

11. Listing FiveM

Le listing FiveM n'est pas obligatoire en localhost. Gardez cette étape pour plus tard si votre objectif est d'abord de tester et configurer la base en local.

Si vous devez l'activer :

1. Prenez votre propre abonnement Element Club.
2. Ajoutez les lignes de listing dans server.cfg.
3. Renseignez ensuite le nom, le titre, la description, les tags et la locale dans le panel.
4. Reprenez la même configuration que l'étape Configurer le listing FiveM dans Installation sur un hébergeur.