1
0
mirror of https://github.com/chylex/Transparent-Twitch-Chat.git synced 2024-07-19 15:28:48 +02:00
Transparent-Twitch-Chat/README.md
2023-03-06 04:27:57 +01:00

51 lines
2.5 KiB
Markdown

# Transparent Twitch Chat
![](https://repo.chylex.com/transparent-twitch-chat.png?)
# Features
Transparent Twitch Chat is a user script that improves your PogChamp experience in the **Theater mode**.
* Chat width, location, and opacity are customizable
* Click the current chat width value to set a custom value
* Chat filters (comma-separated list of words, see [the guide](https://github.com/chylex/Transparent-Twitch-Chat/wiki/Chat-Filters))
* Toggle between default purple theme and gray theme
* Individual or all badges can be hidden for less clutter
* Options to hide the chat header, input box, pinned cheer, and the conversation panel
* (Firefox only) Chat scrollbar is hidden by default and only appears when you scroll
### Tips
* The *Smooth Text Shadow* option makes chat look nicer, but is also very CPU intensive
* If you want fullscreen with chat, enter **Theater mode** and press **F11** (Firefox/Chrome/Opera) or **Shift+Win+Enter** (Edge)
---
# How to Install
First, you need to install a *userscript manager* into your browser. If you don't already have one installed, I would recommend one of these:
* [Violentmonkey](https://violentmonkey.github.io/get-it/) (**Firefox 57+**, **Chrome**)
* [Tampermonkey](https://tampermonkey.net/) (**Edge**, **Opera**, **Safari**)
* [Greasemonkey 3](https://addons.mozilla.org/en-US/firefox/addon/greasemonkey/versions/?page=1#version-3.17) (**Firefox 56 or older**, make sure to prevent it from updating)
Then visit [TransparentTwitchChat.user.js](https://github.com/chylex/Transparent-Twitch-Chat/raw/master/dist/TransparentTwitchChat.user.js) to prompt the installation.
### Changing the Settings
In order to change settings, move your cursor over the chat and click the gear icon in the bottom right corner. You can then close the dialog by clicking on the icon again (or anywhere outside the dialog area).
![](https://repo.chylex.com/transparent-twitch-chat-settings.png?v=1)
### Release Notes
Visit the [Release notes](https://github.com/chylex/Transparent-Twitch-Chat/wiki/Release-Notes) page to see a list of changes across all updates.
### Issues & Feedback
[Open a new issue](https://github.com/chylex/Transparent-Twitch-Chat/issues) if you found a bug or have a suggestion for improvements and new features. When reporting a bug, please include the exact name and version of your browser, and a list of all addons and userscripts you have installed.
### Support Development
Please, consider supporting the development by donating via [PayPal](https://paypal.me/chylex) or [Patreon](https://www.patreon.com/chylex).