Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Seldszar/Gumbo
Swollen companion keeping you updated on your Twitch experience
https://github.com/Seldszar/Gumbo
browser-extension twitch
Last synced: 3 months ago
JSON representation
Swollen companion keeping you updated on your Twitch experience
- Host: GitHub
- URL: https://github.com/Seldszar/Gumbo
- Owner: Seldszar
- License: mit
- Created: 2022-02-28T12:48:27.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-22T23:31:09.000Z (6 months ago)
- Last Synced: 2024-06-28T06:34:44.567Z (5 months ago)
- Topics: browser-extension, twitch
- Language: TypeScript
- Homepage:
- Size: 1.13 MB
- Stars: 159
- Watchers: 3
- Forks: 7
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# 
Gumbo
> Swollen companion keeping you updated on your Twitch experience
Gumbo is a spiritual successor to Twitch Now, allowing you to access your Twitch experience outside the main ecosystem.
From its user interface, you can check your followed channels and track live streams, as well as discover the popular streams and categories of the moment, all with the ability to customize your experience through a multitude of preferences at your disposal.
This extension also informs you when a channel goes online or changes category, with the possibility to choose the notifications you want.
## Install
[link-chrome]: https://chrome.google.com/webstore/detail/gumbo-twitch-companion/aalmjfpohaedoddkobnibokclgeefamn 'Version published on Chrome Web Store'
[link-firefox]: https://addons.mozilla.org/firefox/addon/gumbo-twitch-companion 'Version published on Mozilla Add-ons'
[
][link-chrome] [
][link-chrome] also compatible with [
][link-chrome] [
][link-chrome]
[
][link-firefox] [
][link-firefox]
## Build
1. Create (or use) a [Twitch Application](https://dev.twitch.tv/console/apps).
2. Create a `.env` file in the root of your project with the above Twitch Application's Client ID:
```
TWITCH_CLIENT_ID=tk0nbw3xavxi9eeor93rpsg6ppxtyd
```
3. Install the dependencies (`yarn install`) and build for the desired platform:
- `yarn build:chrome` if you want to build for Google Chrome
- `yarn build:firefox` if you want to build for Mozilla Firefox
## Contributing
### Donating
Gumbo is a free extension that does not collect or sell personal user data.
Donations, although optional but greatly appreciated, help support my work and encourage me to offer the best quality products possible.
If you'd like to help my initiative, please consider contributing using [PayPal](https://go.seldszar.fr/paypal) or [Coinbase](https://go.seldszar.fr/coinbase).
### Translating
You can help translate Gumbo by [registering on Weblate](https://hosted.weblate.org/accounts/register), and join the [translation project](https://hosted.weblate.org/projects/gumbo).
## Frequently Asked Questions
### Why does it break randomly?
Gumbo can break randomly due to a bug coming from Chromium, which can put the extension in a state of limbo.
This is a known issue, which is unfortunately in the hands of the Chromium team.
- https://bugs.chromium.org/p/chromium/issues/detail?id=1271154
### Are sound notifications supported?
Not officially, Manifest V3 doesn't provide the ability to play audio from a service worker.
Workarounds exist, but aren't worth the trouble.
- https://bugs.chromium.org/p/chromium/issues/detail?id=1131236
## License
Copyright (c) 2022-present Alexandre Breteau
This software is released under the terms of the MIT License.
See the [LICENSE](LICENSE) file for further information.