luiz21goncalves/emotettv

💬 A Twitch (BTTV and FFZ) emotes and badges parser - built with tmi.js in mind

emoteTTV

• Works with Twitch, BTTV and FFZ emotes
• Dead simple API - works seamlessly with TMI.js
• Flexible results to fit every need

Demo

Checkout this Svelte demo app to see emoteTTV in action ⛹️

Installation

npm install emotettv
# or with yarn
yarn add emotettv

import { parseBadges, parseEmotes, ... } from 'emotettv';

Usage

🚨 Remember to always sanitize user messages! If your frontend library doesn't do that for you, I recommend using DOMPurify.

parseEmotes(...)

Returns the initial message as an array of words and emotes.

Parameters

• message string - Message string to parse
• emotes EmotePositions - List of emote positions, like tmi.js tags.emotes
• channelId string - Twitch ID of the channel the message is from

Returns: Promise<Word[]>

parseBadges(...)

Returns an object with the user badges

Parameters

• badgesData Badges - List of the user badges, like tmi.js tags.badges
• channelId string - Twitch ID of the channel the message is from

Returns: Promise<ParsedBadges>

Building

git clone https://github.com/doceazedo/emotettv.git
cd emotettv
npm install # or yarn
npm run build # or yarn build

License

The emoteTTV project is licensed under the GPLv3 License.