Table of Contents

• About
• Installation
• Example
• Documentation

About

discord.js-fivem allows you to intergrate your FiveM server's data with Discord.js, allowing you to monitor your server's players, availability and ping.

Installation

With npm:

$ npm install discord.js-fivem

With yarn:

$ yarn add discord.js-fivem

Example

In the file containing client.login:

const { Client } = require('discord.js-fivem');
const { Intents } = require('discord.js');

const client = new Client({
  intents: [
    Intents.FLAGS.GUILDS,
    Intents.FLAGS.GUILD_MESSAGES,
  ]
})

client.on('ready', async () => {
  // fetch your server. the server data will automatically refetch after 2 minutes
  const server = await client.servers.fetch('734okr', {
    cache: true, // whether to cache this server
    force: false, // whether to fetch from fivem even if it's in cache
    update: 120000, // the amount of time (in ms) before updating this server
  })

  // do something with this information
  const guild = client.guilds.resolve('1234')
  const channel = guild.channels.resolve('5678')
  channel.send(`There are currently ${server.players.cache.size} players in the server!`)
})

client.login('your-token-here')

Documentation

You can view the documentation here.