fivem-api's Introduction

FiveM-Api

Small package in order to interact with FiveM API

How-to install :

npm i fivem-api

How-to use : Here is an example to display the number of players online on a server.

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

fivem.getServerInfo("185.223.30.29:30120").then((server)  =>  console.log(server.players.length))

fivem.getServerInfo(ipServer:port)

(default port is 30120)

It returns a Promise with this object as parameter:

{
    "players": [{
        "endpoint"; string,
        "id": int, // The server ID og the player
        "identifiers": array, // Identifiers of the player
        "name": string, // Username's player
        "ping": int, // Le ping
    }],
    "infos": {
        "enhancedHostSupport": boolean,
        "icon": string, // Icon of the server (Base64)
        "resources": array, // All started resources
        "server": string, // FXServer's version (string format)
        "vars": { // Some convars defined in server.cfg
            "sv_enhancedHostSupport": boolean,
            "sv_lan": boolean,
            "sv_licenseKeyToken": string,
            "sv_maxClients": int,
            "sv_scriptHookAllowed": boolean,
            "sv_hostname": string,
        },
        "version": int, // FXServer's version (numeric format)
    }
}

If you want to contribute to this project, please submit your proposal on the github

Recommend Projects