@kozjar/twitch-emoticons

twitch-emoticons

Get a Twitch channel's Twitch emotes, BTTV emotes, and FFZ emotes!

About this fork's 2.3.0+

You must now use a Twitch user ID instead of the username to fetch user's emotes.
You can use this page to quickly grab it.

FFZ still supports names, but usage of the ID is recommended.

Note about Twitch emotes

We've seen twitchemotes.com's API returning "channel not found" at multiple occasions (as of early May 2021).
A fallback system to a static json for the global emotes is in place, but if their service is down or not working you will not be able to fetch the list of emotes from a specific channel.
If you have an alternative API or some quick code to get them from Twitch directly, feel free to share in Issue #8.

BetterTTV and FrankerFaceZ are still working fine.

Install

npm install @mkody/twitch-emoticons
# or
yarn add @mkody/twitch-emoticons

Example

const { EmoteFetcher, EmoteParser } = require('@mkody/twitch-emoticons');

const fetcher = new EmoteFetcher();
const parser = new EmoteParser(fetcher, {
    type: 'markdown',
    match: /:(.+?):/g
});

fetcher.fetchTwitchEmotes(null).then(() => {
    const kappa = fetcher.emotes.get('Kappa').toLink();
    console.log(kappa);
    // https://static-cdn.jtvnw.net/emoticons/v1/25/1.0

    const text = 'Hello :CoolCat:!';
    const parsed = parser.parse(text);
    console.log(parsed);
    // Hello ![CoolCat](https://static-cdn.jtvnw.net/emoticons/v1/58127/1.0 "CoolCat")!
});

Links

• Github
• Documentation
• Changelog

This library uses the following:

• Twitch Emotes API
• BetterTTV API
• FrankerFaceZ API