danieloneill / twitchoverlay Goto Github PK

View Code? Open in Web Editor NEW

35.0 3.0 4.0 1.7 MB

A Twitch chat overlay for streamers to follow their stream chat while gaming.

License: GNU General Public License v3.0

QML 49.19% C++ 23.91% JavaScript 23.38% PHP 1.97% Batchfile 0.22% QMake 0.79% Qt Script 0.52%

qt qbs twitch chat desktop desktop-widget qml cpp

twitchoverlay's Introduction

TwitchOverlay

A Twitch chat overlay for streamers to follow their stream chat while gaming.

Build Requirements

This section (and the Instructions section following) are only necessary for those wishing to build TwitchOverlay from source code. If you just want to use it, skip to Configuring.

This application is developed using Qt in C++, QML, and Javascript. The buildsystem is QBS.

The most convenient way to build TwitchOverlay is in Qt Creator itself, which is free to download, as is the open source edition of Qt.

Build instructions

Assuming you have your Qt Creator build environment properly configured, open TwitchOverlay.qbs in Qt Creator and click Build.

Configuring

Running the application may present a console for log messages depending on your build type and platform, but the actual program should tuck away politely in your system tray as a icon.

For Windows this system tray is in the bottom right of the taskbar, typically. It may be put into a clutter drawer, requiring you to click an arrow to unhide them.

For Xorg platforms that depends on your desktop. Ubuntu, for example, will place it in the top right, near the status indicators:

Right clicking the icon should present you with a menu:

From here you can position the chat frame as you please by clicking Reposition and dragging the corners until your heart is content with the cozy burrow in which the frame is nestled.

Clicking the chat window while in Reposition mode will save the position.

The Configuration menu option will open a configuration window to specify a few required parameters:

Link Twitch will link TwitchOverlay to your account. Simply click the button and follow the prompts.
Channel is the Twitch chat you wish to monitor. This is typically simply the Twitch username of the streamer. (Note: the capitalization matters. Even if their username appears in chat with different capitalization, this must be set to the actual username. This can be found in the browser Address Bar when on their channel.)
Backdrop is the path to an image file to use as the chat backdrop. If blank, the widget will be entirely translucent besides the text itself.
Notification Sound is the path to an audio clip to play to signify chat activity. If blank, no sound will be played.
Opacity will modify the overlay opacity.
Scale scales the chat up or down between 1% and 400%
Fade delay allows you to specify how long messages appear, in seconds, before they fade out.
Show timestamps shows or hides timestamps in the chat message headers.
Show avatars shows or hides avatars in chat message headers.

It may be worth noting that the Preview in the configuration section is displayed at 66% scale. Pay this in mind with respect to the Scale slider setting.

Usage

Any games you play which use a true Fullscreen mode will display over this overlay. Overwatch, for example, offers a "Borderless Windowed" mode which will play nice with this overlay.

twitchoverlay's People

Contributors

Stargazers

Watchers

Forkers

cdante100 gorthezar qt-qml neozest

twitchoverlay's Issues

Emoticon support

Although it's a bit of a nightmare, it should be possible to implement since other systems seem to do with relatively elegantly.

For now, TwitchOverlay doesn't even recognise emoticon tags much less have a means of looking them up.

Can you add it to the Arch User Repository?

I'm to dumb to install it with qt creator.
And I could manage it better if it would be in the aur like every other program on my system.

More streaming platform support

It would be awesome adding more streaming platforms to this e.g. Youtube, Facebook,... and it would be even better to support multiple at the same time so for example Twitch and Youtube comments are mixed with a logo at the front or maybe different colored backgrounds. Similar to what restream.io does for windows.

Sound notification on message received

Play a little ding or something when there's a chat message

Chat sometimes stops scrolling after repositioning/resizing on Win10

The chat box contents overflow below the visible area on Windows 10 if the chat window is repositioned to be smaller. A restart seems to remedy the issue, which is why the reposition is suspected to be the culprit.

TwitchOverlay.qbs missing

Your Readme says we should open TwitchOverlay.qbs but it appears to not be inside this repository?

Can't link my account

When I click "Link Twitch" the window just appears blank, I have no option to link my account, thus cannot connect to the chat.

 hadet@endurance  ~/Downloads/TwitchOverlay-Linux64-1.2  ./TwitchOverlay 
qml: Image is 0x0 scaled to 0x0
Done positioning, resetting window flags!
No WebView plug-in found!
qml: Image is 0x0 scaled to 0x0
qml: Refresh result: 
qrc:/qml/twitch.js:60: SyntaxError: JSON.parse: Parse error

Replace Authkey with an easier to use OAuth account linking system

Rather than requiring users to get their own OAuth2 token on that Twitch Token Generator site, it would be nice to just use Twitch's own "Link account" button (as Streamlabs OBS does) to simply login to their Twitch account and approve TwitchOverlay to access chat on their behalf.

Twitch chat colours for respective users

Though this will likely involve migrating from the qml-sockets+IRC method of connecting to Twitch chat, it would be nice for the colours assigned to chatters on the Twitch stream to carry over onto the overlay.

Superficial research suggests this can be accomplished using the WebSocket backend with tags.

Overlay sometimes takes focus resulting in a Black Screen glitch on Windows 10

Although unconfirmed on other platforms, it seems the Overlay will sometimes have focus. Although it isn't explicitly requesting it, it's possible some anti-focus flags aren't being set correctly, or the desktop is implicitly giving TwitchOverlay focus.

The result is the overlay otherwise working normally but on a plain black background.

Clicking anywhere on the screen, Alt+Tab, or some other way of selecting a focus application seems to work around the issue and resumes normal operation.

Not Authenticating

Twitch Key Authentication not working.

Improve customization options

Make things like message fadeout, text size, avatars, timestamps, and such configurable.

An option to alter opacity, or add a background behind the text of some opacity/colour might be a nice touch too.

Reconfiguring Authkey, Channel, or Username currently requires a restart to take effect.

As stated, TwitchOverlay must be restarted before it will honour new Twitch chat settings.

How can I install it with qt creator and where is it located?

Maybe I'm to dumb,but I never used qt creator,so how can I install it?
I opened the TwitchOverlay.qbs in qt creator and clicked on build>Build Project "TwitchOverlay",but I don't know if it's even installed and where I can find it.

No WebView plug-in found!

an error i got and havent managed to open the program

idk how to fix it

Embedded Browser Not Displaying

I built your program using QtCreator, and as far as I can tell, after some adjustments to my compositor and setting an exception for this application, it works. However, what I imagine is meant to be an embedded browser window when I click "Link Twitch Account", does not work. All I get is a white screen. Do you know why this is? I can try to fix this on my own, but am not really sure where to start. I'd really like to use your program, because twitch overlays for Linux are surprisingly hard to find. Either way, thanks for writing this. If I manage to get it working on my own, I'll mention what I changed.