Aller au contenu

Installation

Dix minutes, dont la majeure partie consiste à attendre que le serveur démarre. Il n’y a aucun fichier SQL à importer et aucun second programme à exécuter — les tables se créent d’elles-mêmes au premier démarrage de la ressource.

Chaque étape ci-dessous se termine par comment savoir si cela a fonctionné, pour ne jamais passer à la suite avec un doute.


Ce dont vous avez besoinPourquoi
oxmysql, en cours d’exécutionTout ce que le téléphone retient réside dans votre base de données
ESX, QBCore, QBox ou fmLibDétecté automatiquement ; pas besoin de préciser lequel
Un serveur FiveM des deux dernières annéesLa partie web du téléphone utilise le Node intégré du serveur

Rien d’autre. Pas de npm, pas d’étape de compilation, pas de serveur web.


Déposez mic_phone dans vos resources — un dossier entre crochets est ce qu’il y a de plus propre :

resources/[mic]/mic_phone/

Gardez le nom de dossier mic_phone. Rien ne casse si vous le renommez, mais l’adresse web du téléphone est construite à partir du nom du dossier, donc tout ce qui est documenté à son sujet changerait également.


Dans server.cfg, en dessous d’oxmysql et en dessous de votre framework :

ensure oxmysql
ensure es_extended # or qb-core / qbx_core
ensure mic_phone

Cela a fonctionné lorsque la console indique, au démarrage :

[mic_phone] web: door B listening on http://0.0.0.0:30125 · door A at /mic_phone/web/ on the game port

Si vous voyez une ligne rouge concernant un framework à la place, démarrez mic_phone après votre framework — c’est presque toujours la cause.


Le premier démarrage lit sql/schema.sql et crée tout ce qui manque. Vous verrez défiler une série de lignes CREATE TABLE IF NOT EXISTS mic_phone_…. C’est tout.

Cela a fonctionné lorsque ces lignes apparaissent une seule fois et plus jamais lors des démarrages ultérieurs.


Par défaut, le téléphone nécessite un item d’inventaire nommé phone :

-- shared/config.lua
Config.Open = {
RequireItem = true,
Item = 'phone',
...
}

La plupart des configurations ESX et QB possèdent déjà cet item. Utilisateurs d’ox_inventory : ajoutez-le à votre liste d’items s’il n’y est pas. Vous voulez simplement l’essayer ? Définissez RequireItem = false et ignorez totalement cette étape.

Cela a fonctionné lorsque vous vous connectez, portez l’item, et que F1 ouvre le téléphone. /phone fait de même, et T le déplie en tablette lorsqu’il est ouvert.


Copiez le fichier d’exemple et remplissez ce que vous souhaitez :

shared/server_config.example.lua → shared/server_config.lua

Ce fichier est chargé uniquement comme script serveur, donc rien de son contenu ne parvient à un joueur. Deux éléments y résident :

Photos, vidéos et notes vocales. Indiquez un token média Fivemanage dans ServerConfig.Media.Token (ou la convar FIVEMANAGE_MEDIA_API_KEY) et le téléphone téléverse les fichiers lui-même, en ne stockant que le lien obtenu. Un webhook Discord sert de solution de secours.

Si aucun des deux n’est défini, FallbackToDataUrl conserve le fichier au sein de votre base de données. C’est parfait pour un test mais très lourd en production — quelques secondes de voix représentent des dizaines de kilo-octets sur chaque ligne concernée. Définissez un token, ou désactivez cette option pour que les téléversements échouent explicitement.

Webhooks Discord. Une URL par type d’événement, ou Default pour tout intercepter. Celui qui mérite d’être configuré même si vous ignorez le reste est Server : c’est le seul qui vous informe sur le serveur plutôt que sur un joueur — changement d’adresse, certificat non renouvelé.


Le téléphone fonctionne. Tout ce qui suit est optionnel.


Les joueurs peuvent consulter le téléphone de leur personnage sur leur propre appareil. C’est déjà activé : Paramètres › Appareils liés sur le téléphone en jeu affiche un code QR, ils le scannent et saisissent en jeu les six chiffres affichés. Cet appareil agit alors en tant que ce personnage.

En simple HTTP, cela leur donne déjà accès aux messages, e-mails, contacts, au garage, aux propriétés et au reste. Ce qu’un navigateur refuse de fournir à une page non sécurisée représente pourtant le meilleur :

HTTP simpleHTTPS
Messages, e-mails, garage, tout le resteouioui
Notifications avec l’application ferméenonoui
Appelsnonoui
Le microphone, pour les notes vocalesnonoui
L’installer en tant qu’app, avec son icônenonoui

Cette ressource peut obtenir et renouveler son propre certificat. Faites pointer un nom de domaine vers votre serveur, ouvrez deux ports et renseignez trois lignes :

-- shared/server_config.lua (server-only: this file is never sent to a client)
ServerConfig.Web = {
Url = 'https://phone.yourserver.com/',
Https = {
Enabled = true,
Names = { 'phone.yourserver.com' },
Contact = '[email protected]',
},
}
  1. Un nom de domaine. Sur un VPS, c’est un enregistrement A pointant vers son adresse IP. Pas de domaine ? duckdns.org vous en fournit un gratuitement en une minute.
  2. Port 80 et port 443 ouverts sur le pare-feu. Le port 80 n’est ouvert que pendant la demande du certificat, puis refermé dès que la validation est effectuée.

Cela a fonctionné lorsque la console indique :

https: asking for phone.yourserver.com
https: port 80 open for the challenge
https: challenge port closed
https: certificate in hand, good until 2027-01-31
https: listening on https://phone.yourserver.com/

Si le port 443 est déjà pris — certains routeurs le conservent pour leur propre page d’administration — diffusez sur un autre port : Port = 8443, redirigez le 8443 et écrivez Url = 'https://phone.yourserver.com:8443/'. Seul le challenge doit obligatoirement passer par le port 80 ; un certificat appartient à un nom de domaine, pas à un port, et tout fonctionne parfaitement.

docs/HTTPS.md détaille les autres cas de figure : derrière le proxy Cfx.re, derrière un reverse proxy que vous exploitez déjà, ou sur un hébergeur qui ne vous ouvre pas de ports.


phonehttps check — demande au serveur de test de l’autorité de certification s’il parvient à communiquer avec votre machine. Exécutez ceci en premier si aucun certificat n’arrive : cela permet de distinguer un souci sur votre pare-feu d’un problème sur cette ressource.

phonehttps — statut du certificat et date de son prochain renouvellement.

phoneduck — statut du nom de domaine, si ce serveur pointe son propre domaine DuckDNS vers lui-même, et date de sa dernière notification. phoneduck now transmet l’adresse qu’il a actuellement et affiche la réponse de DuckDNS, ce qui permet de s’apercevoir qu’un token est incorrect sans attendre que l’adresse IP ne change.

Ce que vous observezCe que c’est
Le téléphone ne s’ouvre pasAucun item phone, ou RequireItem est activé et le joueur n’en porte pas
Le QR pointe vers un endroit inaccessibleDéfinissez ServerConfig.Web.Url manuellement ; la détection automatique ne voit pas au-delà d’un routeur ayant déplacé le port
Aucun certificat, et le log met en cause le challengeLe port 80 n’atteint pas cette machine. Vérifiez la redirection de port puis le pare-feu, dans cet ordre
Les photos sont énormes / la BDD grossit vitePas de token média, et FallbackToDataUrl enregistre les fichiers dans la base de données
Les appels entre deux joueurs sont silencieuxLa voix est sur auto et n’a trouvé aucune ressource vocale ; indiquez la vôtre dans Config.Bridge.voice

  • shared/server_config.lua vous appartient. Ne le partagez jamais et ne le committez sur aucun dépôt public ; il contient votre token média et les URL de vos webhooks.
  • Faites pointer le webhook Server vers un salon que vous lisez. C’est lui qui avertit que la porte d’entrée du téléphone ne fonctionne plus, et c’est le seul avertissement que vous aurez avant qu’un joueur ne vienne vous le signaler.
  • Désactivez Config.Debug si vous l’aviez activé : il affiche chaque décision du bridge dans la console.
  • Sécurité mérite dix minutes si vous gérez une ville publique : les hypothèses que cette ressource fait sur les personnes qui s’y connectent, et les règles qu’elle applique pour qu’un client modifié ne puisse rien atteindre en dehors de son propre personnage.