https://github.com/michaeljolley/number-one

A container based Twitch chat bot that provides chat commands, overlays, video interaction and more.
https://github.com/michaeljolley/number-one

bot faunadb opentok twitch webrtc

Last synced: 27 days ago
JSON representation

A container based Twitch chat bot that provides chat commands, overlays, video interaction and more.

• Host: GitHub
• URL: https://github.com/michaeljolley/number-one
• Owner: michaeljolley
• License: mit
• Created: 2020-07-29T22:57:12.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2021-06-10T20:37:24.000Z (over 3 years ago)
• Last Synced: 2024-08-08T17:14:49.584Z (4 months ago)
• Topics: bot, faunadb, opentok, twitch, webrtc
• Language: TypeScript
• Homepage:
• Size: 4.69 MB
• Stars: 32
• Watchers: 9
• Forks: 13
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-twitch-dev - builders-club/number-one - Container based Twitch chat bot that provides chat commands, overlays, video interaction and more. (Libraries / JavaScript (Node.js))

README

        

# number-one

![CI](https://github.com/builders-club/number-one/workflows/CI/badge.svg?branch=main) 

[![All Contributors](https://img.shields.io/badge/all_contributors-16-orange.svg?style=flat-square)](#contributors-)

Number One is a [Twitch](https://twitch.tv) chat bot that provides the following features:

- Responds to commands in the chatroom (i.e. !help)

- Provides overlays that can be added to the stream to provide context, information, etc

- An admin panel to control various commands and features of the bot

- Stores all events of a stream in a FaunaDb for later analysis

## Environment Variables

| Variable              | Description                                      |

| --------------------- | ------------------------------------------------ |

| HOST                  | Url the application is running at                |

| PORT                  | Port the application is running under            |

| TWITCH_CHANNEL_ID     | Twitch's unique identifier for the channel       |

| TWITCH_CLIENT_ID      | Twitch's API Client ID                           |

| TWITCH_CLIENT_SECRET  | Twitch's API Client Secret                       |

| TWITCH_CHANNEL        | Twitch channel to connect to                     |

| TWITCH_BOT_USERNAME   | Twitch bot login                                 |

| TWITCH_BOT_AUTH_TOKEN | OAuth token for the Twitch account used as a bot |

| FAUNADB_SECRET        | Fauna Secret Key                                 |

| STREAM_ELEMENTS_JWT   | Stream Elements token to integrate donations     |

## Contributors

Want to contribute? Check out our [Code of Conduct](CODE_OF_CONDUCT.md) and [Contributing](CONTRIBUTING.md) docs. This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    
Mikolaj Marciniak
💻

    
Michael Jolley
💻 🤔 📖

    
Salma @whitep4nth3r
🤔

    
Chris Jones
🤔

    
Flyken
🤔

    
Anthony Conrad (parithon)
🤔 💻 📖

    
Jim
🤔

  

  

    
Steve Elliott
🤔 💻

    
Mike Holloway
🐛 💻 🤔

    
Mary Jo
🐛 🤔 💻

    
jwalter
📖 💻 ⚠️ 🤔 🐛

    
Bobby Johnson
🐛 💻 🔧

    
Wayne Taylor
🤔 📖

    
Marko V
⚠️

  

  

    
Radu Antal 
🤔

    
Raushan 
🤔

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!