bot.timtinkers.online / streamplace-bot
A work-in-progress chat bot for Streamplace with chat overlay functionality
2
fork

Configure Feed

Select the types of activity you want to include in your feed.

TypeScript 94.3%
CSS 5.7%
50 1 0

Clone this repository

https://tangled.org/bot.timtinkers.online/streamplace-bot https://tangled.org/did:plc:xnpibbj2hcqlsodutcnirmxp/streamplace-bot
git@tangled.org:bot.timtinkers.online/streamplace-bot git@tangled.org:did:plc:xnpibbj2hcqlsodutcnirmxp/streamplace-bot

For self-hosted knots, clone URLs may differ based on your setup.

Download tar.gz
README.md

A Streamplace Bot#

A work-in-progress Streamplace chat bot written in Deno & TypeScript bringing you the commands and overlays you are used to from Twitch and elsewhere!

Features#

  • Atmospheric integrated commands that show your pronouns, Linkat board or Teal.fm status

  • !hug, !lurk, !unlurk

  • Custom commands via your PDS!

  • Custom shoutouts and auto-greets for users!

  • A pretty chat overlay for OBS with avatars, pronouns!

  • Bot thanks new followers & welcomes teleporters

  • I am self-hosting a local instance on bot.timtinkers.online, simply follow the bot on Bluesky and it will start working in your chat!

Advanced usage#

  • Set up custom commands in your PDS based on this lexicon. You can find examples here (work-in-progress)
  • Set up custom shoutouts in your PDS based on this lexicon. You can find my current shoutouts here
  • Navigate to your chat overlay at https://bot.timtinkers.online/chat?streamer=alice.bsky.social or http://localhost:8000/chat?streamer=alice.bsky.social if you are self-hosting
  • If you want to build your own overlay and still want to use enriched messages (that include avatars, pronouns, banners, PDS hosts), you can also subscribe to the websocket at wss://bot.timtinkers.online/api/websocket?streamer=alice.bsky.social or ws://localhost:8000/api/websocket?streamer=alice.bsky.social respectively

Setup for self-hosters#

  1. Install Deno, git clone the project and run deno install to install dependencies.
  2. Create .env file from .env.example and fill in your values (see below)
  3. Run deno task build once for the Fresh frontend, then run deno task start to start the bot. Alternatively run deno task dev to develop.

Environment Variables#

(necessary)

  • BOT_IDENTIFIER - handle or DID of the account you want to use as bot
  • BOT_PASSWORD - app password for the bot

(optional)

  • JETSTREAM_URL - URL of the Jetstream websocket
  • CDN_URL - URL of the image CDN for the overlay
  • FOLLOWER_MODE - set this to true if you want the bot to work for followers, i.e. for a dedicated bot account

Pfp by @liljalice.neocities.org