Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@kori_xyz/fivem-lookup

kori-lab19ISC0.0.3TypeScript support: included

Simple fivem consult server stats

fivem, fivem-status, fivem-api

readme

Collect information about a Fivem server 👀

NPM latest version Downloads

Install

Available for any computer running nodejs

yarn

yarn add @kori_xyz/fivem-lookup

npm

npm install @kori_xyz/fivem-lookup

Example

import FivemServer from "@kori_xyz/fivem-lookup";

const server = new FivemServer("131.196.198.220:30120");

// number of milliseconds it took to ping the server
console.log(await server.ping());

// information about the server
console.log(await server.info());

// an array of players on the server
console.log(await server.players());

License

This project is licensed under the Apache License 2.0 - see the LICENSE.md file for details.