Git Product home page Git Product logo

go-twitch-conduits's Introduction

go-twitch-conduits

Library to interact with Twitch chat messages using conduits in Go.
Since the IRC will become more limited soon, this library is designed be a replacement ingest for chatbots and the likes.

Packages

  • helix: Package to subscribe to chat messages through conduits using the Twitch Helix API
  • webhook: Logic for webhook conduits, implementing the helix.Transport interface (TODO)
  • websocket: Logic for websocket conduits, implementing the helix.Transport interface
  • oauth: Oauth flow to let users give permission for the bot to join their channel (TODO)

Usage

go get github.com/broadeditz/go-twitch-conduits

Generally speaking, there are 3 things you need to get started:

  1. A Twitch application with the user:read:chat, user:bot scopes for your bot user. And either the channel:bot scope, or moderator status for the channels you're trying to join.
  2. An OAuth app token for the application, following the Client credential grant flow.
  3. The twitch user ID of the bot user

There are quick start examples in the example directory.

v0.0.1 features

  • Subscribe to a chat (or more)
  • Websocket conduits
  • Transport interface for conduits & helix client
  • Small example of how to use the library

Future roadmap

  • Joining/leaving/deleting/updating an existing conduit
  • Webhook conduits
  • Oauth flow to let users give permission for the bot to join their channel
  • Unit tests
  • Single optional wrapper combining helix & transport into a simple to use package
  • Send messages to chat
  • v1.0.0: refactor helix to be more user-friendly

go-twitch-conduits's People

Contributors

broadeditz avatar

Stargazers

 avatar

Watchers

marcel avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.