SDK

Category config

overrideCategoryConfig on start() replaces category settings for that run. The same keys are accepted as the optional overrides argument on addCategories, addBots, and setBots.

overrideCategoryConfig?: {
  all?: Partial<ICategoryConfig>;
  categories?: Record<string, Partial<ICategoryConfig>>;
  bots?: Record<string, Partial<ICategoryConfig>>;
}

Only set the keys you want to override. Unspecified keys keep the config pulled from FNLB, and defaults fill any gaps after that. Merge order (later wins): pulled config, then all, then categories[categoryId], then bots[botId]. Types and enums come from @fnlb-project/shared/types: ICategoryConfig, CategoryConfigPartyPrivacy, CategoryConfigStatusType, and the trigger types below. The start() option itself is StartConfig.overrideCategoryConfig. CategoryConfigPartyPrivacy is numeric: 0 public, 1 private. That is the dashboard enum. Live party privacy after the bot is in a lobby uses PartyPrivacy on bot.party.setPrivacy, documented in Bots and parties. One sets the saved config. The other patches the party the bot is in right now.

import FNLB from 'fnlb';
import { CategoryConfigPartyPrivacy, CategoryConfigStatusType } from '@fnlb-project/shared/types';

const fnlb = new FNLB();

await fnlb.start({
  token: 'FNLB_...',
  categories: ['category-id'],
  overrideCategoryConfig: {
    all: {
      acceptFriendRequests: false,
      privacy: CategoryConfigPartyPrivacy.Private,
      statusType: CategoryConfigStatusType.Online,
      statusText: ['Lobby bot']
    },
    bots: {
      'bot-id': {
        startOutfit: [{ id: 'CID_028_Athena_Commando_F' }]
      }
    }
  }
});

The same object can be passed as the second argument to addCategories, addBots, or setBots after start(). Those methods are covered on the Node.js SDK page. Overrides stored that way are removed when removeCategories or removeBots drops the id, or when setCategories or setBots replaces the list without that id.

General

User management

User entries are { id?: string; name?: string }.

Limits and behavior

Triggers

Each trigger has a name, optional flags, and an actions tree. Actions can run commands, call functions, or use control-flow statements.

• Event fires on a CategoryConfigTriggerEventType, such as a party member joining.
• Custom command fires when a custom command string is used.
• Scheduled fires on a cron-style interval.

Command restrictions

Values are command name arrays.

Cosmetics

Outfit, backpack, pickaxe, shoes, and sidekick slots use { id?: string; variants?: number[] }[]. Banner and banner color slots use { id?: string }[]. Emote slots (joinEmote, memberJoinEmote) accept emotes, emojis, or jam tracks. Backpack slots accept backpacks or pet carriers.

Changing a cosmetic on a bot that is already in a party is party.setOutfit and the other member methods, not these lists. See Bots and parties.

Related