fivem-data-fetcher

Consultez cette documentation si vous souhaitez de l'aide.

Ce module npm permet de récupérer des informations sur les serveurs FiveM en utilisant leur code unique. Il utilise axios pour effectuer des requêtes HTTP à l'API des serveurs FiveM. Le module fournit des fonctions pour obtenir des données telles que le nombre de joueurs en ligne, le nombre maximal de joueurs, le nom d'hôte, les points de connexion et le nom du propriétaire du serveur.

En participant, vous vous engagez à respecter ce code. Veuillez signaler tout comportement inacceptable à [email protected].

Installation

Pour installer ce module npm, utilisez npm. La méthode préférée est d'ajouter ce module en tant que dépendance de développement dans votre application :

npm install fivem-data-fetcher

Support des plateformes

Ce module est conçu pour fonctionner avec Node.js, ce qui le rend compatible avec toutes les plateformes supportées par Node.js :

macOS : Fonctionne sur les versions récentes de macOS.

Windows : Fonctionne sur Windows 10 et versions ultérieures.

Linux : Fonctionne sur Ubuntu 20.04 et versions ultérieures, ainsi que sur d'autres distributions basées sur Debian.

Démarrage rapide

Pour tester les fonctions du module, vous pouvez utiliser le code suivant :

const { getOnlinePlayers, getMaxPlayers, getHostname, getConnectEndpoint, getOwnerName } = require('fivem-data-fetcher');

(async () => {
  const code = 'xxxxxx';

  try {
    const onlinePlayers = await getOnlinePlayers(code);
    const maxPlayers = await getMaxPlayers(code);
    const hostname = await getHostname(code);
    const connectEndpoints = await getConnectEndpoint(code);
    const ownerName = await getOwnerName(code);

    console.log(`Joueurs en ligne: ${onlinePlayers}`);
    console.log(`Joueurs max: ${maxPlayers}`);
    console.log(`Nom d'hôte: ${hostname}`);
    console.log(`Points de connexion: ${connectEndpoints}`);
    console.log(`Propriétaire: ${ownerName}`);
  } catch (error) {
    console.error(error.message);
  }
})();

Utilisation programmatique

Si vous avez besoin d'utiliser ce module dans un script Node.js, vous pouvez le faire comme suit :

const { getOnlinePlayers } = require('fivem-data-fetcher');
const code = 'xxxxxx';

(async () => {
  try {
    const onlinePlayers = await getOnlinePlayers(code);
    console.log(`Joueurs en ligne: ${onlinePlayers}`);
  } catch (error) {
    console.error(error.message);
  }
})();