node-fivem-api v1.0.1

fivem-node-api

Get FiveM server informations in NodeJS.

Install

npm i fivem-node-api

How to use

Get players

const FiveM = require("fivem-node-api");

const srv = new FiveM("127.0.0.1:30120", {
  debug: true,
})
  .then(async (server) => {
    let players = await server.getPlayers();
    console.log(players);
  })
  .catch((err) => {
    console.log(err);
  });

// or

const srv = new FiveM("127.0.0.1:30120", {
  timeout: 5000,
});

async function someFunction() {
  const players = await srv.getPlayers();
  console.log(players);
}

someFunction();

Get resources

const FiveM = require("fivem-node-api");

const srv = new FiveM("127.0.0.1:30120", {
  timeout: 5000,
})
  .then(async (server) => {
    let players = await server.getPlayers();
    console.log(players);
  })
  .catch((err) => {
    console.log(err);
  });

// or

const srv = new FiveM("127.0.0.1:30120", {
  timeout: 5000,
});

async function someFunction() {
  const resources = await srv.getResources();
  console.log(resources);
}

someFunction();

Implemented functions

Players

• getPlayers (array)
• getPlayersCount (number)
• getMaxPlayers (number)

Server informations

• getResources (array)
• getTags (array)
• getGame (string)
• getLocation (string)
• getBuild (string)
• getLicenseKey (string)
• hasEnhancedHostSupport (bool)
• isOnesyncEnabled (bool)
• isScriptHookAllowed (bool)
• getServerData (object)
• isServerActive (bool)