Skip to content

vnxcnt/maltairl

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

113 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

StreamElements Overlay Suite for IRL & Roleplay Streaming

This repository contains a modular set of StreamElements Widgets and Overlay Extensions designed for immersive livestreaming experiences, especially IRL and GTA-style roleplay. The system is built using HTML, CSS, and JavaScript, and utilizes StreamElements counters, fieldData inputs, and SE_API for full control — without requiring OAuth.

Overlay Preview


🔧 Features Overview

🎛️ Control & Debug Panel

  • Categorized counter viewer (Overlay, Inventory, Misc)
  • Toggle & increment buttons for each counter
  • Realtime log panel via onEventReceived

📱 Smartphone HUD (GTA-style)

  • iPhone-style interface with dynamic backgrounds
  • Live weather display (OpenWeatherMap API)
  • Synchronized system clock
  • Modes: hidden, minimized, fullscreen (controlled via Phone counter)
  • Latest follower, sub, donation stats
  • Platform-independent chat notifications (Twitch, YouTube)
  • GPS icon toggled by Map counter
  • Bluetooth icon toggled by Watch counter
  • Animated popups and timer bars for alerts
  • Bottom dock with customizable app icons

⌚ Apple Watch Mini-Widget

  • Embedded black display in Apple Watch mockup
  • Live metrics: speed, heading, altitude (via RTIRL JSON)
  • Visibility toggled via Watch counter

🗺️ GTA-Style Mini-Map Widget

  • Leaflet map styled with Mapbox (custom or fallback)
  • White GTA-style dot marker
  • Follows location via RTIRL API
  • Health/Stamina/Armor bars beneath map
  • Slide-in/out animation, toggled via Map counter

📍 Location Widget

  • Reverse geocoded location name (Mapbox)
  • Font: Dancing Script, animated fade
  • Visibility also tied to Map counter

🌐 Event Feed (Moblin Style)

  • Vertical event log (follow, sub, cheer, etc.)
  • Color-coded by event type
  • Transparent and mobile-optimized

💬 Chat Panel

  • Twitch & YouTube messages combined
  • Full Twitch emote rendering
  • Platform icon + name + message
  • Mods highlighted distinctly
  • Commands (starting with !) are ignored

🧠 Tech Notes

  • onWidgetLoad initializes all states from SE_API
  • onEventReceived handles real-time updates
  • All counters controlled without OAuth (via StreamElements counters only)
  • Optimized for use as OBS browser sources

📁 Directory Structure

/images/     → HUD icons, overlays, backgrounds (hosted via GitHub CDN)
/widgets/    → Widget modules (phone, map, chat, etc.)

🚀 Deployment Steps

  1. Create or edit an overlay at streamelements.com
  2. Add a Custom Widget to your overlay
  3. Paste your HTML, CSS & JS in their respective tabs
  4. Optionally define fieldData values for API tokens, settings, etc.
  5. Save and position the widget in your OBS scene

📌 Counters Used

Phone, PhoneBackground, Watch, Map, Scoreboard, Inventory,
Stars, Equipment, Cola, Wasserflasche, Rucksack, Bilal,
Boxhandschuhe, iPhone, Team1, Team2

💡 Use Cases

  • GTA-style IRL HUD for walking streams
  • Twitch/YouTube hybrid overlays for mobile streamers
  • Inventory toggles & map visibility during RP
  • Minimal control dashboard to change stream state without chat spam

🧑‍🔧 Installation Streamelements

  1. First of all, create 2 stream elements overlays, we need one for the main content and another for the Moblin source. If you use the standard moblin overlays or even another tool for recording, you can ignore this step.
  2. Insert the individual sources as separate widgets within the overlay. Make sure that for widgets where *.json elements are present, API keys from Openweather or RTIRL.com may be necessary.
  3. Create the various counters in Streamelements itself. A list of the standard counters can be seen above. If you use the inventory, you can of course also add your own items. please note that the items must be created both in the inventory and in the notifications.
  4. If you have decided to use the Moblin overlay, please note that it must be configured in the same width as the widget, i.e. usually 1920x1080p.
  5. Go out into the world and show what you can do. <3

📬 Contact

Author: @vnxcnt Feel free to open issues or fork to extend.


📝 License

MIT — use freely, contribute openly.

About

Stream elements overlay in GTA style with viewer interactions via stream elements counter that trigger actions in the overlay. Designed for twitch.tv/maltairl, twitch.tv/nycrox and twitch.tv/TmmyT

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors