README.md

This is a BitBar plugin (supporting both SwiftBar and xbar) that shows live Twitch streams of users you follow.

Installation

1. Install SwiftBar or xbar.
   • If you're unsure which to install, I recommend SwiftBar, as this plugin has been tested with it.
   • If you have Homebrew, you can also install with brew install --cask swiftbar or brew install --cask xbar.
2. Install Rust.
   • If you have Homebrew, you can also install with brew install rust.
3. Install the plugin:

   cargo install --git=https://github.com/fenhl/bitbar-twitch --branch=main

4. Create a symlink to ~/.cargo/bin/bitbar-twitch in your SwiftBar/xbar plugin folder. Call it something like bitbar-twitch.1m.o, where 1m is the rate at which the list of streams will be refreshed.
5. If you're using SwiftBar, the plugin should now appear in your menu bar. If it doesn't appear automatically, or if you're using xbar, refresh by opening a menu and pressing ⌘R.
6. Follow the instructions in the menu to log in with your Twitch account.

Notes

• Clicking “Watch” tries to open IINA by default. (If you have Homebrew, you can install it with brew install --cask iina.) By holding ⌥, you can open streams in your browser instead.

Configuration

The configuration file lives in a JSON file at $XDG_DATA_DIRS/bitbar/plugin-cache/twitch.json. It may contain the following entries, all optional:

• accessToken: A Twitch API key for the plugin. If this is missing, the plugin will display instructions for generating it.
• deferDeltas: An array of timespecs given as arrays of strings. For each timespec listed, the plugin will generate menu items to hide itself until the next datetime matching that timespec.

Additionally, the entries deferred, hiddenGames, hiddenStreams, and userId are managed automatically by the plugin.

Credits

This plugin is based on the original Twitch Follows plugin by SCdF, which uses a now-defunct Twitch API and is no longer maintained.