Roar.js reference

npm install https://bots.roarnode.com/roar.js.tgz

import { Bot } from "https://bots.roarnode.com/roar.js";

import { Bot } from "roar.js";

const bot = new Bot({
  token: process.env.ROAR_TOKEN,       // the bot's token (this is the default)
  presence: { activity: "for /help", activityType: "watching" },
});

bot.on("ready", () => console.log(`Online as ${bot.user.username}`));
await bot.start();                      // resolves once the bot is ready

new Bot({ token });                                   // the official node, through roarnode.com
new Bot({ token, node: "mk3vancmfm" });               // a node by its id (through the relay)
new Bot({ token, node: "https://chat.example.com" }); // a node with its own address
new Bot({ token, node: "http://127.0.0.1:8080" });    // a node on this PC, for testing

bot.on("message", async (msg) => {
  if (msg.author.isBot) return;                  // ignore other bots
  if (msg.content.startsWith("!say ")) {
    await msg.channel.send(msg.content.slice(5));
  }
  if (msg.mentionsMe) await msg.react("👀");     // someone pinged the bot
});

await channel.send("Hello!");
await channel.send({
  content: "Today's weather",
  embed: { title: "Sunny", description: "22°C, light wind", color: "#ffb86b" },
  files: ["./forecast.png"],             // paths, or { name, data }
  silent: true,                          // no notification, like @silent
});

import { mention, channelMention, roleMention } from "roar.js";

await channel.send(`Hi ${msg.author}!`);                       // pings them
await channel.send(`Read ${channelMention(rulesId)} first, ${mention(userId)}`);

await i.reply({
  embed: {
    title: "Server stats",
    url: "https://roarnode.com",
    description: "How we're doing this week",
    color: "#5fd96a",                     // or a number like 0x5fd96a
    author: "Stats Bot",
    thumbnail: "https://example.com/logo.png",
    fields: [
      { name: "Members", value: "128", inline: true },
      { name: "Messages", value: "4,210", inline: true },
    ],
    image: "https://example.com/chart.png",
    footer: "Updated every hour",
    timestamp: new Date(),
  },
});

// The short way: a name, a description, a handler.
bot.command("ping", "Check the bot is awake", (i) => i.reply("Pong!"));

// With options.
bot.command({
  name: "remind",
  description: "Remind me later",
  options: [
    { name: "minutes", description: "In how many minutes", type: "integer", required: true },
    { name: "what", description: "What to remind you about", type: "string", required: true },
    { name: "where", description: "Which channel", type: "channel" },
  ],
}, async (i) => {
  await i.reply({ content: `OK, in ${i.options.minutes} min`, ephemeral: true });
});

const guild = bot.guild("Bot Lab");          // or msg.guild, i.guild, member.guild
const welcome = guild.channel("welcome");    // by name or id
const mods = guild.role("Moderator");

await welcome.send(`We're ${guild.memberCount} now!`);
await guild.addRole(userId, "Member");       // a role by name, id or Role

bot.on("reactionAdd", async (r) => {
  if (r.emoji === "⭐") {
    const msg = await r.fetchMessage();
    await bot.send(starboardId, `⭐ ${msg.author.displayName}: ${msg.content}`);
  }
});

bot.setActivity("for /help", "watching");     // "Watching for /help"
bot.setPresence({ status: "idle", customStatus: "Taking a nap" });

import { Webhook } from "roar.js";

const hook = new Webhook(process.env.ROAR_WEBHOOK_URL);
await hook.send({ content: "Deploy finished ✅", username: "CI", embed: { title: "v1.4.2", color: "#5fd96a" } });

import { RoarError } from "roar.js";

try {
  await member.kick();
} catch (e) {
  if (e instanceof RoarError && e.code === 50013) await msg.reply("I'm not allowed to kick them.");
  else throw e;
}