ZPROJECT

Configuration

Par
Sören
v1.0.0Voir la ressource →

La configuration client se répartit entre config.json, les fichiers commands/<commande>/config.json et les fonctions Lua prévues pour vos intégrations.

Configuration générale

config.json > TOKEN

Jeton du bot créé dans le portail développeur Discord.

  • Type : string
  • Valeur initiale : jeton fourni dans le fichier, à remplacer par celui de votre application
  • Rôle : connecte zBot à Discord
json
"TOKEN": "VOTRE_TOKEN_DISCORD"

config.json > LOCALE

Définit la langue utilisée par le bot et les messages FiveM.

  • Type : string
  • Valeur par défaut : "fr"
  • Valeurs incluses : "fr" ou "en"
json
"LOCALE": "fr"

Le code doit correspondre au nom d’un fichier présent dans locales/.

config.json > COLOR

Définit la couleur principale des réponses intégrées Discord.

  • Type : string
  • Valeur par défaut : "#FF3837"
  • Format : couleur hexadécimale
json
"COLOR": "#FF3837"

config.json > ACTIVITY

Définit le texte d’activité affiché sur le profil du bot.

  • Type : string
  • Valeur par défaut : ".gg/zproject"
json
"ACTIVITY": ".gg/zproject"

config.json > ACTIVITY_TYPE

Définit le type d’activité Discord associé au texte précédent.

  • Type : string
  • Valeur par défaut : "PLAYING"
  • Rôle : choisit la catégorie de présence comprise par la version de Discord.js fournie
json
"ACTIVITY_TYPE": "PLAYING"

config.json > STATUS

Définit l’état de présence du bot.

  • Type : string
  • Valeur par défaut : "online"
  • Valeurs prévues : "online", "idle", "dnd" ou "invisible"
json
"STATUS": "online"

config.json > CLIP_DURATION

Définit la durée des clips réalisés par zScreenshot.

  • Type : number
  • Valeur par défaut : 10
  • Unité : secondes
json
"CLIP_DURATION": 10

Utilisez un nombre supérieur à 0.

Liste blanche globale

config.json > WHITELIST.active

Active le réglage de liste blanche globale défini dans la configuration.

  • Type : boolean
  • Valeur par défaut : true

config.json > WHITELIST.requiredRoles

Contient les identifiants de rôles Discord associés à cette liste.

  • Type : array<string>
  • Valeur par défaut : []
  • Format : identifiants numériques de rôles Discord
json
"WHITELIST": {
  "active": true,
  "requiredRoles": [
    "123456789012345678"
  ]
}

Webhooks médias

config.json > WEBHOOKS.screenshots

URL du webhook utilisé par zScreenshot pour envoyer les captures d’écran.

  • Type : string
  • Valeur initiale : URL présente dans le fichier, à remplacer
  • Commande concernée : /screen

config.json > WEBHOOKS.videos

URL du webhook utilisé par zScreenshot pour envoyer les clips.

  • Type : string
  • Valeur initiale : URL présente dans le fichier, à remplacer
  • Commande concernée : /clip
json
"WEBHOOKS": {
  "screenshots": "https://discord.com/api/webhooks/ID/JETON",
  "videos": "https://discord.com/api/webhooks/ID/JETON"
}

Configuration des commandes Discord

Chaque commande possède son propre fichier sous commands/<commande>/config.json. Les chemins exacts sont rappelés dans la section « Commandes et raccourcis ».

commands/<commande>/config.json > isAvailable

Publie ou masque la commande lors du prochain démarrage.

  • Type : boolean
  • Valeur par défaut : true dans les 30 fichiers fournis
json
"isAvailable": true

commands/<commande>/config.json > description

Définit la description visible dans l’interface de commande Discord.

  • Type : string
  • Valeur par défaut : description anglaise fournie pour chaque commande

Modifiez ce texte sans changer la structure JSON.

commands/<commande>/config.json > options.<option>.name

Définit le nom affiché pour un paramètre de commande.

  • Type : string
  • Valeur par défaut : dépend de la commande
  • Noms fournis : target, reason, duration, car, content, command, hour, minutes ou origin

commands/<commande>/config.json > options.<option>.description

Définit l’aide affichée par Discord pour le paramètre concerné.

  • Type : string
  • Valeur par défaut : description anglaise fournie dans le fichier de la commande

commands/<commande>/config.json > requiredRoles

Limite une commande aux membres possédant au moins l’un des rôles Discord configurés.

  • Type : array<string>
  • Valeur par défaut : [] lorsqu’il est présent
  • Comportement avec [] : aucune restriction de rôle propre à la commande
json
"requiredRoles": [
  "123456789012345678",
  "987654321098765432"
]

Ce champ est fourni pour les commandes d’administration des joueurs, de communication, de serveur et de sanction. Les fichiers commands/ensure/config.json, commands/help/config.json, commands/restart/config.json, commands/start/config.json et commands/stop/config.json ne le déclarent pas par défaut.

commands/<commande>/config.json > isContext

Active le menu contextuel utilisateur Discord pour les commandes compatibles.

  • Type : boolean
  • Valeur par défaut true : commands/clearall/config.json, commands/crash/config.json, commands/freeze/config.json, commands/info/config.json, commands/revive/config.json et commands/unfreeze/config.json
  • Valeur par défaut false : commands/boom/config.json, commands/clear/config.json, commands/clip/config.json, commands/dv/config.json, commands/heal/config.json, commands/kill/config.json, commands/refuel/config.json, commands/repair/config.json et commands/screen/config.json
  • Autres commandes : champ absent par défaut

Après toute modification d’une commande, redémarrez zBot pour republier les commandes d’application.

Fonctions personnalisables côté client

Les fonctions suivantes se trouvent dans script/client/functions.lua.

ShowMessage(content, author)

Affiche un message privé dans l’interface NUI.

  • content : string, texte à afficher
  • author : table contenant name et icon
  • Comportement par défaut : envoie le message à l’interface compilée

ShowAnnouncement(content, author)

Affiche une annonce globale dans l’interface NUI.

  • content : string, texte à afficher
  • author : table contenant name et icon
  • Comportement par défaut : envoie l’annonce à l’interface compilée

SendNotif(content)

Affiche une notification native GTA/FiveM.

  • content : string
  • Valeur retournée : aucune

Vous pouvez remplacer son contenu par l’appel à votre système de notifications.

Refuel(vehicle)

Point d’intégration pour votre système de carburant.

  • vehicle : handle de véhicule FiveM
  • Valeur retournée : aucune
lua
_ENV.Refuel = function(vehicle)
    -- Appelez ici votre système de carburant.
end

Repair(vehicle)

Point d’intégration pour votre système de véhicule ou de réparation.

  • vehicle : handle de véhicule FiveM
  • Valeur retournée : aucune
lua
_ENV.Repair = function(vehicle)
    -- Appelez ici votre système de réparation.
end

Fonctions personnalisables côté serveur

Les fonctions suivantes se trouvent dans script/server/functions.lua.

Revive(source)

Point d’intégration pour votre script médical.

  • source : number, identifiant serveur du joueur
  • Valeur retournée : aucune
lua
_ENV.Revive = function(source)
    -- Appelez ici votre système de réanimation.
end

Heal(source)

Point d’intégration pour votre script de santé.

  • source : number, identifiant serveur du joueur
  • Valeur retournée : aucune
lua
_ENV.Heal = function(source)
    -- Appelez ici votre système de soin.
end
← PrécédentBase de donnéesSuivant →Utilisation