https://github.com/skynewz/screm

Simple background service which answers a sound based on a Twitch chat command. Support whitelist
https://github.com/skynewz/screm

chat-bot chatbox twitch twitch-bot

Last synced: 26 days ago
JSON representation

Simple background service which answers a sound based on a Twitch chat command. Support whitelist

• Host: GitHub
• URL: https://github.com/skynewz/screm
• Owner: SkYNewZ
• License: gpl-3.0
• Created: 2021-07-10T21:42:46.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-07-10T22:00:47.000Z (over 3 years ago)
• Last Synced: 2024-11-06T07:38:55.490Z (3 months ago)
• Topics: chat-bot, chatbox, twitch, twitch-bot
• Language: Go
• Homepage:
• Size: 98.6 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# screm

Simple background service which answers a sound based on a Twitch chat command. Support whitelist Inspired

from https://github.com/bfroggio/screm without keyboard shortcuts, sound category and write messages.

## Usage

1. Create a `config.toml` file as outlined in the ["Config File" section](#config-file) below

1. Put any sound effects you want to use in `./sounds`. The file name will be the command the to trigger that sound

1. Launch `screm.exe` by double-clicking on it

1. Try this with `!ding` command in your Twitch chat

## Config File

`config.toml` should be in the same directory as the `screm.exe` binary. There are a few properties that can go in

your `config.toml` file. Properties listed below are optional unless otherwise noted. See `sample-config.toml` for an

example with fake configuration values.

- `twitch_username` (required): The username for your Twitch account/channel. Screm can't read your channel's chat

  messages without this.

- `twitch_authorized_users`: A space-separated list of Twitch usernames for users authorized to trigger sound effects on

  your stream from Twitch chat.