rce.js

A library for developers to easily create their own Rust Console Edition integrations such as discord bots using GPORTAL's API & WebSocket!

Documentation

For a more in-depth documentation, refer to GitBook! You can also join our support discord server

Installation

npm i b1nzeex/rce.js

Example Usage - TypeScript

import { RCEManager, LogLevel, RCEEvent } from "rce.js";

const rce = new RCEManager({
  authMethod: "manual", // Can set to "manual" or "file" - manual requires a "refreshToken" in the AuthOptions and must be updated everytime you restart your application, file handles auth through a txt file which stores your refresh token
  refreshToken: "", // Obtained via the G-PORTAL website, scroll to the bottom of this documentation for a guide on obtaining this
  logLevel: LogLevel.Info, // Uses "Info" by default if left blank
  servers: [
    {
      identifier: "server1", // A unique name for your server to be recognised by
      region: "US", // It's either EU or US
      serverId: 1487554, // You can find this in the URL on your server page
      refreshPlayers: 2, // This will fetch the playerlist every 2 minutes, good for displaying player count
    },
    {
      identifier: "server2",
      region: "EU",
      serverId: 1487367,
    }, // As we didn't specify a "refreshPlayers" value, the playerlist won't be fetched
  ], // An array of servers to listen to
});

await rce.init(); // This attempts to login to GPORTAL - this is required for everything else to function

rce.on(RCEEvent.PlayerKill, (data) => {
  console.log(
    `[${data.server.identifier}] ${data.killer.name} killed ${data.victim.name}`
  );

  // Send an in-game command to the Rust server by the unique identifier (kill-feed!)
  await rce.sendCommand(
    data.server.identifier,
    `say <color=red>${data.killer.name}</color> killed <color=red>${data.victim.name}</color>`
  );
});

Example Usage - JavaScript (ES5)

const { RCEManager, LogLevel, RCEEvent } = require("rce.js");

const rce = new RCEManager({
  authMethod: "file", // Can set to "manual" or "file" - manual requires a "refreshToken" in the AuthOptions and must be updated everytime you restart your application, file handles auth through a txt file which stores your refresh token
  file: "", // By default, it will create an "auth.txt" file if not specified, otherwise you can provide your own file path
  logLevel: LogLevel.Info, // Uses "Info" by default if left blank
  servers: [
    {
      identifier: "server1", // A unique name for your server to be recognised by
      region: "US", // It's either EU or US
      serverId: 1487554, // You can find this in the URL on your server page
      refreshPlayers: 2, // This will fetch the playerlist every 2 minutes, good for displaying player count
    },
    {
      identifier: "server2",
      region: "EU",
      serverId: 1487367,
    }, // As we didn't specify a "refreshPlayers" value, the playerlist won't be fetched
  ], // An array of servers to listen to
});

await rce.init(); // This attempts to login to GPORTAL - this is required for everything else to function

rce.on(RCEEvent.PlayerKill, (data) => {
  console.log(
    `[${data.server.identifier}] ${data.killer.name} killed ${data.victim.name}`
  );

  // Send an in-game command to the Rust server by the unique identifier (kill-feed!)
  await rce.sendCommand(
    data.server.identifier,
    `say <color=red>${data.killer.name}</color> killed <color=red>${data.victim.name}</color>`
  );
});

How To Obtain G-PORTAL Refresh Token

• Step 1. Navigate to G-PORTAL Website
• Step 2. Login to G-PORTAL
• Step 3. In your browser, press CTRL + SHIFT + I all together to open the Developer Tools (inspect)
• Step 4. Navigate to the Application tab
• Step 5. Navigate to Local Storage
• Step 6. Select gp-session
• Step 7. Right click on the refresh_token and select Copy Value
• Step 8. You're done! Now paste the refresh token into your code