Yarrosco is a pirate parrot that likes repeating your chats. He will read from Twitch, Matrix and other sources, in such a way that you can easily put it as an overlay in OBS inside your stream.
The name is an acronym for:
Yet Another Rust Rewrite of an On-Screen Chat Overlay.
This software is under heavy development and it's difficult to get running. Functionality is very limited: it only covers strictly one use case.
Connects to Matrix and Twitch. However, only connecting with exactly one of each has been tested. Any other combination wasn't tested and may or may not work.
Outputs to OBS via Browser. OBS Browser plugin is not tested with Yarrosco. The only tested method is having a local web server running, run Firefox ESR to the page, and capture the window within OBS.
- 99% Rust with some minor HTML + Typescript.
- Async and Threaded using Tokio. (Caveat: still pending refactor, some operations might block)
- Twitch support:
- Emotes.
- Badges.
- Resiliency against IRC disconnection.
- Matrix support:
- History retrieval.
- Database storage prevents losing history of chats when restarting Yarrosco.
- Small HTML Application provided to display messages in OBS.
- Configurable logging verbosity (error, warn, info, debug).
- Ofuscable secrets (passwords, oauth tokens, etc) - useful to stream while developing Yarrosco without leaking private information.
For an overview of the folders and how the code is organized, please see README_contents.md
Installing from binary is not supported and we don't provide builds. Yarrosco must be built from sources in order to work for your computer.
For building Yarrosco you'll need a working Rust (stable) toolchain and optionally a Typescript compiler. We provide in our repository the Typescript files compiled to Javascript, so as long as you don't plan to change the JS code you don't need a Typescript compiler.
Refer to README_setup.md for the complete instructions.
Licensed under Apache License v2.
NOTE: Only the files present in this folder are licensed under Apache License v2. The dependencies of the different programs have their own licenses. The resulting binaries may or may not be licensable as Apache License v2.
All images from /data/logos-third-party are exempted from the Apache License v2.
This folder contains official logotypes from the different providers and those are covered by trademark and copyright.
For more information, see data/logos-third-party/README_licenses.md