Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ocsoares/twitch-mention-notifier
A Twitch Mention Notifier web extension, when you are mentioned in chat
https://github.com/ocsoares/twitch-mention-notifier
extension mention message notifier twitch twitch-extensions web-extension
Last synced: 30 days ago
JSON representation
A Twitch Mention Notifier web extension, when you are mentioned in chat
- Host: GitHub
- URL: https://github.com/ocsoares/twitch-mention-notifier
- Owner: ocsoares
- License: mit
- Created: 2023-04-25T19:54:03.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-12-28T15:33:53.000Z (about 1 month ago)
- Last Synced: 2024-12-28T16:18:07.899Z (about 1 month ago)
- Topics: extension, mention, message, notifier, twitch, twitch-extensions, web-extension
- Language: TypeScript
- Homepage:
- Size: 238 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Twitch Mention Notifier
> A web extension to notify users when they are mentioned in Twitch chats.
Twitch Mention Notifier is a web extension that allows users to receive notifications when they are mentioned in Twitch chats. The extension continuously monitors the chats in which the user is active and displays a notification whenever a mention is detected.
# Content
- [Features ✨](#features-)
- [Screenshots 📸](#screenshots-)
- [Installation 🚀](#installation-)
- [Usage 💡](#usage-)
- [Contributing 🤝](#contributing-)
- [License 📄](#license-)
## Features ✨
- Receive notifications when you are mentioned in Twitch chats 🔔
- Notifies when you are mentioned with "@" and also without, so both "@JohnDoe" and "JohnDoe", for example, will activate notifications 💬
- The matching is **case-insensitive**, meaning that it **will work** regardless of whether the mention is in uppercase or lowercase, so "@johndoe" or "JoHNdOe" will work ⌨️
- Click on the notification to open the mentioned chat in a new browser tab 📢
- 20-second cooldown between each new notification, to prevent spam 🕒
## Screenshots 📸
## Installation 🚀
### 🌐 Chromium (Google Chrome, Edge, or Brave)
1. Download the extension in ZIP format [here](https://github.com/ocsoares/Twitch-Mention-Notifier/releases/latest) on the [Releases Page](https://github.com/ocsoares/Twitch-Mention-Notifier/releases).
2. Extract the ZIP file to a local directory.
3. In your browser, go to `chrome://extensions` in the address bar.
4. Enable "Developer mode" in the top right corner of the page.
5. Click on the "Load unpacked" button and select the folder where you extracted the ZIP file.
6. The Twitch Mention Notifier extension will be loaded and activated.
⚠️ **IMPORTANT**: The extension will **not work** if activated on chrome://extensions due to browser-specific policies. It should be enabled/disabled when on any **website**. Avoid configuring this extension while in **browser settings** or similar areas.
## Usage 💡
1. Click on the extension popup.
2. Enter, respectively, the twitch channel name from which the chat will be read, your twitch username, and optionally, abbreviations or variations of your twitch username.
3. When you are mentioned in the Twitch chat, a notification will be displayed on your computer.
4. Click on the notification to open the mentioned chat in a new browser tab.
## Contributing 🤝
Contributions are welcome! To contribute to the project, follow these steps:
1. Fork the repository. 🍴
2. Create a new branch with your feature or bug fix: `git checkout -b my-feature`.
3. Start your changes by running the `build:watch` and `webpack:watch` scripts from the package.json.
4. Commit your changes: `git commit -m 'Added a new feature'`.
5. Push to the branch: `git push origin my-feature`.
6. Open a pull request on GitHub.
## License 📄
[](https://github.com/ocsoares/Twitch-Mention-Notifier/blob/master/LICENSE)
MIT © ocsoares