https://github.com/nextgenorg/twitch-bot-basic
https://github.com/nextgenorg/twitch-bot-basic
bot twitch-bot
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/nextgenorg/twitch-bot-basic
- Owner: NextGenOrg
- Created: 2020-03-22T22:28:16.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-04-19T00:50:38.000Z (about 5 years ago)
- Last Synced: 2025-12-13T06:47:05.233Z (7 months ago)
- Topics: bot, twitch-bot
- Language: JavaScript
- Homepage: https://nextgenteam.tech/
- Size: 18.6 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# Twitch Getting Started with Chatbots & IRC
## Chatbot Overview
Twitch offers an Internet Relay Chat (IRC) interface for chat functionality. Chatbots allow you to programmatically interact with a Twitch chat feed using IRC standards; the bot connects to the Twitch IRC network as a client to perform these actions.This guide presents an easy bot example to get you started.
### Building the Bot
We’ll build a simple chatbot that responds in chat when someone types `!dice`. (This is known as a chatbot command.) When triggered, it randomly generates a number between 1-6. We run the fully-functioning chatbot on this Glitch, as well as show you how to run locally on our [Developer Docs](https://dev.twitch.tv/docs/irc/).
### Get Environment Variables
To start, you’ll need three environment variables:
| Variable | Description |
|---------------- |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `BOT_USERNAME` | The account (username) that the chatbot uses to send chat messages. This can be your Twitch account. Alternately, many developers choose to create a second Twitch account for their bot, so it's clear from whom the messages originate. |
| `CHANNEL_NAME` | The Twitch channel name where you want to run the bot. Usually this is your main Twitch account. |
| `OAUTH_TOKEN` | The token to authenticate your chatbot with Twitch's servers. Generate this with [https://twitchapps.com/tmi/](https://twitchapps.com/tmi/) (a Twitch community-driven wrapper around the Twitch API), while logged in to your chatbot account. The token will be an alphanumeric string. |
### Running the bot
1. To start with this template, click the Remix button in the upper right.
2. Glitch automatically installs Node and Tmi.js for us.
3. Add the three environmental vars in our [`.env`](https://glitch.com/edit/#!/ng-twitch-bot?path=.env:1:0) file.
4. View the code in `bot.js`.
5. Your chatbot is ready to run! Glitch automatically deploys & runs each version. View the status button to ensure there are no errors.
6. Try the chatbot! Interact with your channel (twitch.tv/) by trying the `!dice` command.
**Note**: This bot connects to the IRC network as a client and isn't designed to respond over HTTP. If you click "Show Live" you will see a simple "Hello World"
## Next Steps
* For a thorough understanding of Twitch chatbots and IRC, read the [Chatbots & IRC Guide](https://dev.twitch.tv/docs/irc/guide/) and the rest of the Twitch IRC documentation.
* To authenticate your chatbot in a production setting, we recommend you [register your app](https://dev.twitch.tv/docs/authentication/#registration) (chatbot) and use the OAuth Authorization code flow. This enables you to authenticate programmatically. To learn more, read the [Apps & Authentication Guide](https://dev.twitch.tv/docs/authentication/).
Read [Chatbots & IRC documentation](https://dev.twitch.tv/docs/irc/guide/).
* Reach out to the [Twitch chatbot forum](https://discuss.dev.twitch.tv/c/chat) for help!