Skip to content

ovniroto/stream-bot

Repository files navigation

StreamBot

GitHub Issues GitHub Tag GitHub Commits GitHub License

StreamBot v0.3.3 (WIP) is an essential bot for your streams. You can create your own static or dynamic commands, activate or deactivate commands, and much more, all from a streamer panel where you can control everything.

Warning

Please keep in mind that StreamBot is not ready yet and is still under active development. Full backward compatibility is not guaranteed before reaching an stable version.

Features

  • 🥳 Stream Panel
  • 😎 Twitch.tv support
  • 💿 Spotify Commands
  • 🤖 GPT AI Command
  • 🔊 TTS overlay
  • 🤩 Custom commands
  • 👽 Toggle commands
  • ⌛️ Command cooldown
  • ... and much more!

Default Commands

  • 🤖 AI - !ai
  • 🔊 TTS - !tts
  • 🎲 Roll the dice - !rtd
  • 🥠 Fortune cookie - !fortune
  • 🎱 8 Ball - !8ball
  • 💿 Spotify - !spoty

Soon™

  • Kick.com support
  • Custom timed events
  • Stream Game Overlay

Resources

Local Installation

1. Download last release

First download the latest released version and unzip folder

2. Rename .env.example file

Rename the .env.example file to .env and fill information

3. Create Twitch oauth token (Optional)

  • Login with your main account or bot account on Twitch
  • Enter to twitchtokengenerator.com
  • Select Bot Chat Token
  • Authorize Twitch Token Generator in your account
  • Copy Access Token and paste in the .env file (TWITCH_ACCESS_TOKEN)

Example:

TWITCH_ACCESS_TOKEN="your-token-here"

4. Create OpenAI API Key (Optional)

Note

The !ai command uses your OpenAI API Key to generate the responses. This entails an economic expense that you must control for yourself. We recommend creating a usage limit on your OpenAI account to avoid unwanted spending and automatically blocking responses from being generated when you reach that limit. You can also use the !aimod command to turn the command on or off. You can keep the command disabled if you don't want to use this feature. You can change the generation model to a less expensive one with the !aimod command or from the bot panel.

  • Create new account or login on OpenAI
  • Go to your API Keys and create new secret key
  • Copy Secret Key and paste in the .env file (OPENAI_API_KEY)

5. Create Spotify API Keys (Optional)

Note

Spotify limits player actions for users who pay for Spotify Premium. If you don't pay for Spotify Premium, you won't be able to use actions like skip to the next or previous song, pause or resume music, etc.

Example:

SPOTIFY_CLIENT_ID="your-client-here"
SPOTIFY_CLIENT_SECRET="your-secret-here"

6. Run StreamBot_Start.bat

Bot Updates

If you want to check if there are new bot updates, you just have to run the file StreamBot_Update.bat.

Troubleshooting

MissingEnvVarsError

error: Uncaught MissingEnvVarsError: The following variables were defined in the example file but are not present in the environment:
  TWITCH_USERNAME, TWITCH_PASSWORD, TWITCH_CHANNEL, OPENAI_API_KEY, DEBUG, ENVIRONMENT

Make sure to add them to your env file.

[...]

You may not have renamed the file .env.example to .env.

Login authentication failed

Twitch credentials are incorrect. Check the data you have put in the .env file.

Contributors

All issue reports, feature requests, pull requests and github stars are welcomed and much appreciated.