Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jackmcguire1/go-twitch-ext
A library to help with the development of an EBS for Twitch Extensions
https://github.com/jackmcguire1/go-twitch-ext
Last synced: 26 days ago
JSON representation
A library to help with the development of an EBS for Twitch Extensions
- Host: GitHub
- URL: https://github.com/jackmcguire1/go-twitch-ext
- Owner: jackmcguire1
- License: mit
- Archived: true
- Created: 2019-01-17T17:53:24.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-04-23T16:47:54.000Z (over 2 years ago)
- Last Synced: 2024-08-03T13:01:50.105Z (4 months ago)
- Language: Go
- Homepage: https://godoc.org/github.com/jackmcguire1/go-twitch-ext
- Size: 23.4 KB
- Stars: 11
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-twitch-dev - jackmcguire1/go-twitch-ext - Library to help with the development of an EBS for Twitch Extensions. (Libraries / Golang)
README
# go-twitch-ext
[git]: https://git-scm.com/
[golang]: https://golang.org/
[releases]: https://github.com/jackmcguire1/go-twitch-ext/releases/
[modules]: https://github.com/golang/go/wiki/Modules
[discord]: https://discord.gg/8NXaEyV
[MIT]: https://opensource.org/licenses/MIT
[](https://godoc.org/github.com/jackmcguire1/go-twitch-ext)
[](hhttps://travis-ci.org/jackmcguire1/go-twitch-ext)
[](https://goreportcard.com/report/github.com/jackmcguire1/go-twitch-ext)
[](https://codecov.io/gh/jackmcguire1/go-twitch-ext)
[](releases)
> A library to help with the development of an EBS for a [Twitch Extension](https://dev.twitch.tv/docs/extensions "twitch Extension")
> For any help please consult FAQ section
## Supported Endpoints & Features
**Features:**
> Twitch JWT
- [x] Twitch Claims structure supported
- [x] Sign Twitch claims into JWT Tokens
- [x] Verify Client/EBS Created Twitch JWT tokens into claims obj
**API Endpoint:**
>This package supports the following [Twitch Extension API endpoints](https://dev.twitch.tv/docs/extensions/reference/)
- [x] Get Live Channels with Extension Activated
- [x] Create Extension Secret
- [x] Get Extension Secret
- [x] Revoke Extension Secrets
- [x] Set Extension Required Configuration
- [x] Set Extension Configuration Segment
- [x] Get Extension Channel Configuration
- [x] Get Extension Configuration Segment
- [x] Send Extension PubSub Message
- [x] Send Extension Chat Message
## Installing
`go get github.com/jackmcguire1/go-twitch-ext`
## Example
```Go
package main
import (
"log"
"os"
twitch "github.com/jackmcguire1/go-twitch-ext"
)
var twitchPkg *twitch.Twitch
func init() {
twitchPkg = twitch.NewClient(
os.Getenv("OWNER_ID"),
os.Getenv("CLIENT_ID"),
os.Getenv("EXT_SECRET"),
os.Getenv("EXT_VERSION"),
os.Getenv("EXT_CONFIG_VER"),
)
}
func main() {
claims := twitchPkg.CreateClaims(
"35851594",
twitch.BroadcasterRole,
twitch.FormBroadcastSendPubSubPermissions(),
)
token, err := twitchPkg.JWTSign(claims)
if err != nil {
log.Fatal(err)
}
claims, err = twitchPkg.JWTVerify(token)
if err != nil {
log.Fatal(err)
}
log.Println(claims)
}
```
## Development
To develop `go-twitch-ext` or interact with its source code in any meaningful way, be
sure you have the following installed:
### Prerequisites
- [Git][git]
- [Go 1.12][golang]+
You will need to activate [Modules][modules] for your version of Go, generally
by invoking `go` with the support `GO111MODULE=on` environment variable set.
### Twitch Extension Configuration
From your [Twitch Extension Dashboard](https://dev.twitch.tv/dashboard/extensions) you can get the following:
- Client ID
- Base64 Secret
- Extension Version
- Extension (**Broadcaster**/**Developer**) Config Version - *OPTIONAL*
### Owner ID
To get the owner ID, you will need to first create a temporary access token via [https://twitchtokengenerator.com/](https://twitchtokengenerator.com/)
Next fetch your ownerID from a simple CURL command against the Twitch `/users` endpoint.
You'll also need the client ID from [https://twitchtokengenerator.com/](https://twitchtokengenerator.com/) as part of the query.
```bash
curl -H "Client-ID: " -H "Authorization: Bearer " -X GET "https://api.twitch.tv/helix/users?login="
```
your ownerID is the value of 'id'
```bash
{
"data": [{
"id": "35851594",
"login": "crazyjack12",
"display_name": "crazyjack12",
"type": "",
"broadcaster_type": "",
"description": "Do What Thou Wilt",
"profile_image_url": "https://static-cdn.jtvnw.net/jtv_user_pictures/ea0bf955-255a-4eca-ad80-460b88162910-profile_image-300x300.png",
"offline_image_url": "",
"view_count": 1702
}]
}
```
## Create your own extension!
Get started and create your extension [today!](https://dev.twitch.tv/extensions).
## FAQ & SUPPORT
For any questions or suggestions please join the 'go-twitch-ext' channel on [Discord][discord]!
## License
The source code for go-twitch-ext is released under the [MIT License][MIT].
## Donations
All donations are appreciated!
[](http://paypal.me/crazyjack12)