gaeVG / tsv

📒 Installation

🏒 Préparation de l'environnement (Windows)

Logiciels requis

1. Télécharger git
2. Télécharger MongoDB
3. Télécharger NodeJS

🎛️ Paramétrage de git

Ajouter les informations de connexion au dépot

git config user.name "NAME"
git config user.mail [e-mail]

🔃 Récupération du projet

Création des nouveaux dossiers

mkdir MonServeur

Cloner depuis le dossier racine

git clone https://git.cenne.xyz/fivem/base.git ./

📒 Installation de l'artefact

Créer le dossier server

mkdir server
cd server

⤵️ Téléchargement de l'artefact

Décompresser le fichier téléchargé dans le dossier server

Invoke-WebRequest -Uri "https://runtime.fivem.net/artifacts/fivem/build_server_windows/master/5878-a5c270439ddb3bbb1fc4e7d02cb5593be84a9b89/server.7z" -OutFile "server.7z"

🧰 Préparation du noyau

cd data\resources\tsv\src
npm i
npm i -g yarn
# Pour compiler la ressource sur le serveur de production :
yarn build
# Pour développper et compiler automatiquement la ressource :
yarn watch

Configuration du noyau

📘 Créer le fichier d'environnement .env à la racine de la ressource et renseigner les informations correspondantes

EXECUTION_MODE="development"|"test"|"safemode"|"production"
SECRET_KEY=string
IDENTIFIER_TYPE=string
DEBUG_MODULES=Array<string>
DB_HOST=string
DB_PORT=number
DB_NAME=string
DB_USER=string
DB_PASSWORD=string

🎇 Premier lancement

Lancer le serveur depuis le dossier racine

./server/FXServer.exe +set txDataPath ./server/txData/ +set serverProfile dev

✂️ Configuration du serveur

Les instructions suivantes sont à compléter sur txAdmin dans le champ Aditionnals Argument dans la configuration du serveur :

+exec permissions.cfg +set sv_licenseKey LICENSE_FIVEM +set steam_webApiKey "STEAM_API"
+set sv_maxclients 128 +set sv_hostname "Mon super serveur"
+set sv_master="" +set svgui_disable true sets locale "FR-FR"

🖥️ Developpement

⚙️ Gestion des threads

import _t from "@config/i18n";
import { tsp } from '@client';

tsv.threads.createThread({
    name: "exempleTick",
    timer: 1000,
    callback: () => {
        const player = new Player();
        tsv.log.debug({
            namespace: "Exemple",
            container: "Function",
            location: "exempleTick()",
            message: _t('exemple.tick.message', { playerName: player.Name })
        });

        return player.serverId === 0 false : true;
    }
});

🎉 Gestion des évènements

Enregistrement :

// Server

tsv.events.listen({
    name: 'exempleEvent',
    module: 'exemple',
    handler: (data) => {
        tsv.log.debug({
            ...log,
            message: _t('exemple.event.message', { data: data })
        });
    }
)}

// Server <-> Client
tsv.events.listen({
    name: 'exempleEvent',
    module: 'exemple',
    onNet: true,
    handler: (data) => {
        tsv.log.debug({
            ...log,
            message: _t('exemple.event.message', { data: data })
        });
    }
)}

Déclenchement :

// Local
tsv.event.trigger({ name: "exempleEvent" });

// Server <-> Client
tsv.event.trigger({ name: "exempleEvent", onNet: true });

// Callback
tsv.event.trigger({
  name: "exempleEvent",
  onNet: true,
  data: [data],
  callback: (result: any) => {
    tsv.log.debug({
      ...log,
      message: _t("exemple.event.message", { result: result }),
    });
  },
});

💡 Liens utilies

FiveM

1. Game référence (FiveM Documentation)
2. FiveM Natives References
3. FiveM Wiki User
4. Weapons Models (GTANet)
5. Vehicles Models (GTANet)
6. GTA Dumps (Github)
7. Online Interiors and locations
8. Animations List
9. Grand Theft Data

Outils

3D

1. Code Walker
2. OpenIV
3. Props vizualizer
4. YMAP &YBN Mover
5. GTA Handling
6. Recherche de props par hash (Pleb Master)
7. Cloth Tool
8. GIMS Evo

Développement

1. Lua Beautifer