Skip to content

Show Twitch emote streaks on an overlay, and let chatters show specific emotes too.

License

Notifications You must be signed in to change notification settings

smisken-tools/Emote-Overlay

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

61 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Overview:

This project is an overlay that shows emote streaks on the bottom left of the page. (Page dimensions are 1280px x 720px)
It can also show emotes randomly on screen if a chatter does !showemote (emote_name)
This overlay can be used in streaming software like OBS
The emotes are taken from Twitch, FFZ, BTTV, and 7TV.

This project took direct inspiration from pajlada's pajbot, although I believe my version is easier to setup and use.


Live Version:

You can put this URL into your streaming software and use it!
Please scroll further down to see all the settings that you can tweak.


Examples:

Emote Combo:

Emote Combo

Show Emote:

Show Emote


Usage & Available Parameters/Settings:

To use these parameters, add them after the url with this format: "&(parameter)=(value)" For example, if I wanted to add the "minStreak" and the "showEmoteSizeMultiplier" parameter, my new URL would be "https://api.roaringiron.com/emoteoverlay?channel=forsen&minStreak=10&showEmoteSizeMultiplier=3"

REQUIRED PARAMETERS:

  • channel=(channel name)

OPTIONAL PARAMETERS:

  • minStreak=(number)
    • Minimum emote streak needed to show up in overlay
    • Defaults to 5 - Minimum value allowed is 3
  • showEmoteEnabled=(1 for enabled, 0 for disabled)
    • Enable or disable the show emote module
    • Defaults to 1 (enabled)
  • streakEnabled=(1 for enabled, 0 for disabled)
    • Enable or disable the emote streak module
    • Defaults to 1 (enabled)
  • showEmoteSizeMultiplier=(multipler)
    • Changes the size of the show emotes by the number provided
    • Defaults to 2
  • showEmoteCooldown=(seconds)
    • Cooldown in seconds between usage of !showemote command
    • Defaults to 5
  • emoteStreakText=(text (without quotes))
    • Sets the ending text for the emote streak
    • For no text, add an empty emoteStreakText= to the end of the URL
    • Defaults to Streak!
  • emoteLocation=(1 for bottom left, 2 for top left, 3 for top right, 4 for bottom right)
    • Sets the emoteStreak position
    • Defaults to 1

Development

I welcome all developers to open a pull request or ticket with any new features or changes you'd like to see!

About

Show Twitch emote streaks on an overlay, and let chatters show specific emotes too.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 94.0%
  • HTML 4.3%
  • CSS 1.7%