Skip to main content

Ressources GTA V

Nous rejoindre sur Discord


Installer la ressource

Pour récupérer la clé vous permettant d'utiliser l'api de Mail RP, rendez vous sur la page : Récupérer sa clé API

Voici deux méthodes pour installer la ressources sur votre serveur :

Avec git :

Rendez vous dans le dossier resources de votre serveur, et utiliser la commande suivante :

git clone https://github.com/Tvpirates/xelyos-fivem-resources.git [xelyos]

Un dossier va allors de créer sous le nom [xelyos], vérifiez bien que dans ce répertoire vous trouverez le répertoire mailrp.

Sans git :

Rendez vous sur le git : Last releases Git Xelyos Resources FiveM et télécharger le fichier .zip. Déplacez le fichier zip téléchargé dans votre répertoire resources, et faîtes extraire-ici, renommer le nouveau fichier installer en [xelyos]


Activer la ressource

Lier à l'API :

Pour lié votre serveur FiveM avec l'api de Mail RP, vous devez vous rendre dans le fichier resources/[xelyos]/mailrp/server.lua, au niveau de la ligne 6, remplacez apiToken par votre clé.

Activer la ressource :

Pour activer la ressource sur votre serveur, ajouter dans votre server.cfg les lignes suivantes :

# Xelyos solutions
ensure mailrp

Si vous utilisez déjà des ressources Xelyos, vous n'avez qu'à ajouter la ligne à la suite des autres.


Utiliser la ressource

La fonction callback :

function requestAction(statusCode, resultData)
  -- Action qui suit la requête
end

Lorsque vous allez faire appel à l'API, un résultat est envoyé en fonction de la requête que vous utilisez. Pour exploiter cette réponse, vous devrez utilisez une fonction callback, dans cette fonction écrivez les actions qui devront suivre la requête. Vous pouvez renommer la fonction callback comme vous le voulez.

Variable Définition
statusCode (obligatoire) Résultat du status de la requête (200 : réussite | 403 : échec)
resultData (obligatoire) Données retournées au format JSON

Appelez le code depuis un fichier serveur :

Pour utiliser l'api depuis un fichier serveur, vous devez utiliser la structure suivante :

function requestAction(statusCode, ResultData)
  ...
end

TriggerEvent('xelyos:MailRP', function(mailRP)
    mailRP:methode(requestAction)
end)

Vous trouverez la liste des méthodes ci-dessous !

Appelez le code depuis un fichier client :

Pour utiliser l'api depuis un fichier serveur, vous devez utiliser la structure suivante :

function requestAction(statusCode, ResultData)
  ...
end

TriggerServerEvent('xelyos:MailRP', function(mailRP)
    mailRP:methode(requestAction)
end)

Vous trouverez la liste des méthodes ci-dessous !


Liste des méthodes

getServer()

Utilité : Récupérer les informations sur son serveur

Doc API : Gestion du serveur - Informations générales

Appel :

mailRP:getServer(callBack)
Variable Définition
Aucune Aucune variable mise à part la fonction permettant d'exploiter les résultats n'est nécessaire

findSubdomains()

Utilisé : Récupérer la liste des sous domaines de votre serveur

Doc API : Gestion des sous domaines - Liste des sous domaines

Appel :

mailRP:findSubdomains(callBack)
Variable Définition
Aucune Aucune variable mise à part la fonction permettant d'exploiter les résultats n'est nécessaire