https://github.com/zspri/TwitchOverlay

A custom, minimal Twitch client and stream player made with Electron
https://github.com/zspri/TwitchOverlay

electron html irc javascript overlay streaming-video twitch twitch-irc twitch-overlay twitchirc

Last synced: 3 months ago
JSON representation

A custom, minimal Twitch client and stream player made with Electron

• Host: GitHub
• URL: https://github.com/zspri/TwitchOverlay
• Owner: zspri
• License: gpl-3.0
• Archived: true
• Created: 2018-08-17T22:57:20.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2021-03-30T04:09:43.000Z (almost 4 years ago)
• Last Synced: 2023-06-10T16:24:47.391Z (over 1 year ago)
• Topics: electron, html, irc, javascript, overlay, streaming-video, twitch, twitch-irc, twitch-overlay, twitchirc
• Language: JavaScript
• Homepage: https://overlay.twitchbot.io
• Size: 96.8 MB
• Stars: 6
• Watchers: 1
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# [TwitchOverlay](https://overlay.twitchbot.io)

[![](https://img.shields.io/github/release/devakira/twitchoverlay.svg?colorB=g&style=flat-square)](https://github.com/devakira/TwitchOverlay/releases/latest)

[![](https://img.shields.io/github/downloads/devakira/twitchoverlay/total.svg?colorB=blue&style=flat-square)](https://github.com/devakira/TwitchOverlay/releases/latest)

A custom, minimal Twitch client and stream player made with Electron.

![image](https://cdn.discordapp.com/attachments/376375897109954560/536553108747321354/unknown.png)

## Requirements

 - Windows (64-bit)

## Installing

Go to the [releases](https://github.com/devakira/TwitchOverlay/releases) page and download 'TwitchOverlay.exe' to use the production build.

### Development Build

#### Dev requirements

- Node 10 or above

- Electron 4

- electron-builder

```sh

git clone https://github.com/devakira/TwitchOverlay

cd TwitchOverlay

npm install

electron .

```

## Logging in

As of Sept. 17, 2013, Twitch now requires that you log into IRC using an OAuth token instead of your plaintext password or hash for additional security. To generate an oAuth token, go to https://twitchapps.com/tmi/, click `Connect with Twitch`, and copy the text in the box.

## Building

```sh

npm install

./node_modules/.bin/build --windows portable

```

This will generate an executable at `./dist/TwitchOverlay (version).exe`.