solarlabyrinth/firebot-client-js
Watch
1
0
Fork
You've already forked firebot-client-js
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
A client library for the Firebot API https://www.npmjs.com/package/@solarlabyrinth/firebot-client
16 commits 1 branch 0 tags 44 KiB
  • TypeScript 100%
Find a file
Exact
Repository files (latest commit first)
Filename Latest commit message Latest commit date
SolarLabyrinth bd2592a4d5
 description
2025-09-02 13:14:06 -05:00
src replace vars 2025-09-02 13:12:12 -05:00
test replace vars 2025-09-02 13:12:12 -05:00
.gitignore first few endpoints 2025-09-01 13:48:00 -05:00
.npmignore add viewer info 2025-09-01 14:28:10 -05:00
bun.lock first few endpoints 2025-09-01 13:48:00 -05:00
LICENSE Initial commit 2025-09-01 11:46:00 -05:00
package.json description 2025-09-02 13:14:06 -05:00
README.md description 2025-09-02 13:14:06 -05:00
tsconfig.json fix 2025-09-01 14:29:19 -05:00

README.md

@solarlabyrinth/firebot-client

A client library for the Firebot API. Tested against Firebot v5.64.0

Installation

npm install @solarlabyrinth/firebot-client

yarn add @solarlabyrinth/firebot-client

bun add @solarlabyrinth/firebot-client

Usage

import { FirebotClient } from "@solarlabyrinth/firebot-client";

const firebot = new FirebotClient("http://localhost:7472");

await firebot.getStatus();

await firebot.getEffects();
await firebot.getEffect("firebot:obs-set-browser-source-url");
await firebot.getPresetEffectLists();

await firebot.getCustomVariable("test");
await firebot.setCustomVariable("test", "example", 1000);
await firebot.getCustomVariables();

await firebot.getReplaceVariables();

await firebot.getViewers();
await firebot.exportViewers();
await firebot.getViewer("1111111111");

const counterId = "94ca0cbd-1c30-4800-8c84-2d4ca8450587";
await firebot.getCounters();
await firebot.getCounter(counterId);
// Add 1 to the counter
await firebot.updateCounter(counterId, 1, true);
// Set the counter to 10.
await firebot.updateCounter(counterId, 10, false);

const timerId = "09ddcae0-94b0-11ef-a33b-371e00c340c1";
await firebot.getTimers();
await firebot.getTimer(timerId);
await firebot.enableTimer(timerId);
await firebot.disableTimer(timerId);
await firebot.toggleTimer(timerId);
await firebot.clearTimer(timerId);

const queueId = "28899a40-af91-11ef-a872-81b56b0d156a";
await firebot.getEffectQueues();
await firebot.getEffectQueue(queueId);
await firebot.pauseEffectQueue(queueId);
await firebot.resumeEffectQueue(queueId);
await firebot.toggleEffectQueue(queueId);
await firebot.clearEffectQueue(queueId);