Skip to content

Latest commit

 

History

History
78 lines (53 loc) · 2.48 KB

README.md

File metadata and controls

78 lines (53 loc) · 2.48 KB
Raw

Welcome to twitch-bot

License: MIT Twitter: athanoquest

Twitch Chat bot with custom commands, TTS, sounds, rewards, API integrations and more!

✨ See it in action on Twitch

Welcome to our Twitch Bot!

This bot is intended for self-hosting streamers. Its adaptation for other channels is not covered in this project.

For Twitch API help, visit https://dev.twitch.tv/docs/.

This bot assumes users have programming experience. Please keep in mind that this project may not meet the needs of all users, but it does offer the ability to create a customized Twitch Bot.

We used Twitch's example at https://dev.twitch.tv/docs/irc/example-bot as a starting point. Thanks, Twitch!

Features

  • Twitch chat overlay
    • Supports Twitch emotes and badges, 7TV emotes, BTTV emotes and modifiers, and FFZ emotes and modifiers
    • Customisable formatting, colours, and animations
  • Custom commands
  • Text-to-speech with custom voices from streamelements and TikTok
  • Sound effects
  • Spotify integration with song requests
  • Spotify song overlay
  • Twitch channel point rewards integration
  • Interval commands (e.g. periodic messages)
  • Twitch task overlay
  • Discord webhook integration for announcing stream start
  • OBS websocket integration
  • Probably more!

Setup

View SETUP instructions

Configuration

View CONFIGURATION instructions

Start the bot

Client for Chat, Tasks and Spotify overlays:

cd client
npm start

Server:

cd server
npm start

Troubleshooting

Primarily, watch the console output for errors to troubleshoot issues.

For tokens that are saved in tokens.json (Twitch and Spotify), if you change your scope and there are already access_token and refresh_token present in the file, you should remove these token values. Once you have your new access code the program will retrieve a new access_token and refresh_token.

Contributing

Contributions, issues and feature requests are welcome!
Feel free to check the issues page.

License

This project is MIT licensed.