SDK

SDK Events

fnlb is an event emitter. Import Events from fnlb and pass the enum to fnlb.on or fnlb.once. Names are stable strings such as ready and party:member:message. Party and friend chat arrive as a Message. ready arrives as a Bot. Other events arrive as { bot, ...fields }. Full party meta is not on the event. Call bot.party.meta.get() when you need the schema. See Bots and parties.

import FNLB, { Events } from 'fnlb';

const fnlb = new FNLB();

fnlb.on(Events.Ready, (bot) => {
  console.log(bot.id, bot.displayName);
});

fnlb.on(Events.PartyMemberMessage, async (message) => {
  if (message.content === '!ping') await message.reply('pong');
});

Lifecycle

Chat

message.bot is the bot that received it. message.author is { id, displayName }. message.reply(text) sends back on the same channel: party chat, or a whisper to the author.

Friends

Accept or decline a request with bot.acceptFriend and bot.declineFriend. See Chat and commands.

Party

Cosmetics and match

These fire when one field on a member changes. value is the new value and previousValue is the old one, when the client has it.

The full list, including payload shapes, is Events in the SDK reference. Chat payloads are Message. The ready payload is Bot.

A listener that acts

Register before start(). ready is the first safe place to touch that bot's party. Invites and friend requests include the sender so you can accept without listing pending friends first.

import FNLB, { Events } from 'fnlb';

const fnlb = new FNLB();

fnlb.on(Events.Ready, async (bot) => {
  console.log(bot.displayName, bot.party.id);
});

fnlb.on(Events.FriendRequest, async ({ bot, id }) => {
  await bot.acceptFriend(id);
});

fnlb.on(Events.PartyInvite, async ({ bot, sender }) => {
  console.log(sender.displayName, 'invited', bot.nickname);
});

fnlb.on(Events.PartyMemberOutfitUpdated, ({ member, value }) => {
  console.log(member.displayName, 'equipped', value);
});

await fnlb.start({
  token: 'FNLB_...',
  categories: ['your-category-id']
});

fnlb.once(Events.Ready, ...) runs for the first bot only. Use on when more than one bot will log in. PartyMemberJoined and PartyMemberUpdated carry a member summary: id, display name, leader, ready, and cosmetic ids. They do not include the meta schema. Read that with bot.party.meta.get() or member.meta.get(), documented in Bots and parties. Cosmetic events are the ones to use when you want to react to a change. Setting an outfit yourself with party.setOutfit also updates the member and can emit PartyMemberOutfitUpdated.

Reference