A simple overlay for displaying your Tetra League, Quick Play, 40L, Blitz and much more stats in OBS using a Browser Source. You can choose to display your stats as a static image or a live view that updates every 30 seconds.
If you find this overlay useful, please consider giving it a ⭐ to show your support, or share it with others who might enjoy it. Thank you for using it!
For screenshots and examples look at the examples section at the bottom.
To use the overlay, simply use one of the following URLs:
- Live View:
https://tetrio.founntain.dev/tetraleague/<username>
- Live View:
https://tetrio.founntain.dev/zenith/<username>/
- Live View:
https://tetrio.founntain.dev/sprint/<username>/web - Static Image:
https://tetrio.founntain.dev/sprint/<username>
- Live View:
https://tetrio.founntain.dev/blitz/<username>/web - Static Image:
https://tetrio.founntain.dev/blitz/<username>
- Live View:
https://tetrio.founntain.dev/zenith/splits/<username>/web - Static Image:
https://tetrio.founntain.dev/zenith/splits/<username>
for more info check the splits section.
For OBS, it is recommended to use the live view URL. To set it up:
- Create a new Browser Source in OBS.
- Paste the live view URL into the Browser Source settings, replacing
<username>with your tetr.io username (make sure to remove the<and>), the same goes for<mode>. - Make sure the width and height is correct check below what sizes are best for each overlay:
- Tetra League: 800 x 350
- Quick Play: 900 x 350
- 40 Lines: 700 x 225
- Blitz: 700 x 225
- Speedrun splits: 1500 x 200
Note
The data is cached and refreshes every 30 seconds. For 40 Lines and Blitz the default cache is used which is 5 minutes.
You can put any parameters at the end of the url. The order does not matter, however spelling is!
backgroundColor: Adjusts the background color (useful if you don’t want a transparent background). Default is00FFFFFF.textColor: Changes the text color and the color of the progress bar. Default isFFFFFF.displayUsername: This only works for 40L, Blitz and Quick Play if set tofalseit will hide the username.modes: See Slide section.
Example:
https://tetrio.founntain.dev/tetraleague/founntain/web?backgroundColor=FF0000&textColor=00FF00
Ever wanted to know how fast you clear floors without hitting hyperspeed, or not able to hit hyperspeed ever, to see the splits in general? We have you covered. With the splits overlay, you can compare your times with your gold splits from this week.
The splits overlay uses your last 100 games from the current week; all games past that aren't counted. We chose this limit because we don't want to make excessive API calls, and the last 100 games is enough to compare your performance this week. If you haven't played this week yet, we use your career best splits for display.
With the expert parameter you can show the splits for expert or normal, default value is false
Caution
The splits overlay is still very early and pretty complex. If something does not work as intended, or is not working at all, please let me know so I can look into it!
The splits overlay is not supported in slide mode, because it is quite large. Maybe in the future.
If you prefer not to use the hosted version, you have a few alternatives:
- Clone the repository, build, and run the project locally, then access it via
localhost. - Pull the Docker image and run it with Docker, accessing it via
localhostand the assigned port.
Contributions are welcome! Feel free to open issues, request features, provide feedback, report bugs, or even contribute code. If you're unsure about anything, let's discuss it. Thanks for your support!
- osk: for creating tetr.io and providing an amazing, well-structured API.
- Veggie_Dog: motivating to make this project a reality, testing and feedback
- PixelAtc: providing feedback, ideas and spreading the word
- ZaptorZap: for giving feedback and some incredible ideas
added for all examples a simple transparent dark background so those are readable for light github users aswell Parameter used
backgroundColor=AA000000
