🧩Code Examples

Here are a couple of examples for using the module and possible API responses

GetServer Info

JavaScript

server-info.js

const erlc = require("erlc-api");
const { EmbedBuilder } = require("discord.js");

const getServerFunc = async () => {
  const serverId = ""; // Your Server-API Key
  const server = await erlc.getServer(serverId).catch(console.log);
  return server;
};

setTimeout(async () => {
  const server = await getServerFunc();
  console.log(server); // Debug API Response, you can remove this.
  
  await interaction.reply({
    embeds: [
      new EmbedBuilder()
        .setColor("Random")
        .setTitle(`${server.Name}`) // Your ERLC Server Name
        .setURL(`${server.VanityURL}`) // This auto-generates URL to quickly join your users
        .setFields([
          { name: "Current Players", value: `${server.CurrentPlayers}`, inline: true },
          { name: "Max Players", value: `${server.MaxPlayers}`, inline: true },
          { name: "Join Code", value: `${server.JoinKey}`, inline: true },
          { name: "Team Balance", value: `${server.TeamBalance}`, inline: true }, // True or false, depends on your server config
          { name: "Owner Username", value: `${server.OwnerUsername}`, inline: true },
          { name: "Co-Owners Usernames", value: `${server.CoOwnerUsernames}`, inline: true },
          { name: "Verify Method", value: `${server.AccVerifiedReq}`, inline: true },
        ]),
    ],
  });
}, 5000); // You can adjust this; this part of code is for debugging purposes

getServerFunc(); // Execute the function

GetPlayers Info

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

const getPlayersFunc = async () => {
  const serverId = ""; // The server ApiKey you wish to target. You can get this api key in your (Server Settings)
  const server = await erlc.getPlayers(serverId).catch(console.log); // Gets the server, logs any errors
  console.log(server); // Logs the server object
  //  Expected Response:
  // [
  // 	{
  // 		"Permission": "Server Owner" Or Member, Moderator,
  // 		"Player": "Player-Username and ID" ,
  // 		"Team": "Civilian" Or Fire, Police, Sherift
  // 	}
  // ]
};
getPlayersFunc();

GetModCalls Info

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

const getModCalls= async () => {
  const serverId = ""; // The server ApiKey you wish to target. You can get this api key in your (Server Settings)
  const server = await erlc.getModcallLogs(serverId).catch(console.log); // Gets the server, logs any errors
  console.log(server); // Logs the server object
  //  Expected Response:
  // {
  //  Caller: ErlcPlayer;
  //   Moderator?: ErlcPlayer; // If call is unanswered property is undefined
  //   Timestamp: number;
  //  }
};
getModCalls()

GetVehicles Info

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

const getVehicles= async () => {
  const serverId = ""; // The server ApiKey you wish to target. You can get this api key in your (Server Settings)
  const server = await erlc.getVehicles(serverId).catch(console.log); // Gets the server, logs any errors
  console.log(server); // Logs the server object
  //  Expected Response:
  // {
  //   Name: Vehicle Name;
  //   Owner: ErlcPlayer;
  //   Texture: Your custom texture or default;
  //  }
};
getVehicles()