Skip to content

wielorzeczownik/stream-guestbook-widget

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

267 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Stream Guestbook Widget

Build Latest Release License: MIT
TypeScript widget.io compatible StreamElements Twitch YouTube Kick

Stream Guestbook Widget demo – guestbook overlay animation in StreamElements

πŸ‡¬πŸ‡§ English | πŸ‡΅πŸ‡± Polski

A free StreamElements widget for Twitch, YouTube, and Kick – viewers sign a virtual guestbook via chat command or Channel Points. Tracks visit counts and leaderboards.

How it works

Viewers type a chat command or redeem a Channel Points reward on Twitch to sign the guestbook. A book overlay flips open on screen. Every signature is remembered across streams – viewers can check how many times they've signed and compete for the top visitor leaderboard.

Features

  • Sign via chat command or Channel Points (Twitch only)
  • Cross-platform – Twitch, YouTube and Kick
  • Visit counter – viewers check their sign count with !visits
  • Top visitors leaderboard – post rankings to chat with !top
  • Fully customizable chat responses with {name}, {count}, {target} placeholders
  • Mod tools – reset individual users or wipe all data
  • Appearance – cover color, page color, stamp color, custom textures for each
  • Flip animation – three speed options, configurable display duration

Installation

Download the latest release from GitHub Releases:

File For
guestbook-widgetio.zip widget.io – import directly
guestbook.zip StreamElements custom widget – manual import
  1. Download guestbook-widgetio.zip.
  2. In widget.io , click Import and select the zip.
  3. Configure and save.

StreamElements custom widget

  1. Download guestbook.zip and extract it.
  2. Go to My Overlays β†’ New Overlay β†’ Add Widget β†’ Custom Widget.
  3. Click Open Editor and fill in each tab with the matching file from the zip:
    • HTML β†’ HTML.html
    • CSS β†’ CSS.css
    • JS β†’ SCRIPT.js
    • Fields β†’ FIELDS.json
  4. Click Done, configure the widget fields, and save.

Setup

Twitch: Channel Points

  1. Create a Channel Points reward named exactly Sign Guestbook (or whatever you set in the widget fields).
  2. In the widget settings, enable Enable Channel Points reward.
  3. Disable Enable sign command on Twitch if you don't want the chat command alongside it.

Twitch: chat command

Enable Enable sign command on Twitch in the widget settings. Viewers use !sign (or your custom command name) in chat.

YouTube / Kick

Chat command is enabled by default for non-Twitch platforms. No extra setup needed.

StreamElements JWT token

The widget needs a JWT token to post messages to chat.

  1. Go to StreamElements Dashboard.
  2. Click Copy next to your channel's JWT token.
  3. Paste it into the StreamElements JWT token field in the widget settings.

Commands

Command Who can use What it does
!sign Everyone Signs the guestbook
!visits Everyone Shows how many times the user has signed
!visits @user Mods Shows visit count for another user
!top Everyone Posts top visitors to chat
!reset Mods Resets a user's guestbook entry

All command names are configurable in the widget settings.

Building from source

Requirements: Node.js 24+.

git clone https://github.com/wielorzeczownik/stream-guestbook-widget.git
cd stream-guestbook-widget
npm install
npm run build

The built widget files land in widget/compiled/. The StreamElements-ready zip is in widget/dist/. For widget.io, the export zip is in widget/export/.

Credits

The book flip animation is adapted from a CodePen by Nayara Alves – original pen.

About

A stream overlay widget where viewers sign the guestbook via chat command or Channel Points redemption. Works with Twitch, YouTube, and Kick via StreamElements

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

1 star

Watchers

0 watching

Forks

Contributors