Skip to content

muxable/rtirl-obs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

RealtimeIRL Overlays

Overlays you can use on your stream! Add the URL as a Browser Source in OBS.

A note on the map watermarks: it's tempting to crop them out with OBS, however most mapping providers require displaying attribution, even when used in non-interactive video. Verify you are meeting the relevant attribution requirements for your mapping provider. Muxable does not provide legal support if you are contacted regarding an attribution violation.

Generic Mapbox

This style is the fastest to get started with. If you're looking for just an OBS map overlay, use this one! Please review the Mapbox attribution requirements.

https://overlays.rtirl.com/generic.html?key=<YOUR_PULL_KEY>

Optional URL parameters

  • &zoom=13 to tweak the zoom level.
  • &lang=en to set the language of the map. See this list for acceptable values, note that not all labels can be translated.
  • &fullscreen=1 to make the map fill the entire screen.

Custom Mapbox Styles

If you have a Mapbox Studio style id, use this overlay. The style id looks like adoucett/cjf5k84bp0p7t2rmiwvwikhyn. Be sure to set your Mapbox access token in the url as well. Please review the Mapbox attribution requirements.

https://overlays.rtirl.com/mapbox.html?key=<YOUR_PULL_KEY>&access_token=<YOUR_MAPBOX_ACCESS_TOKEN>&style=<MAPBOX_STYLE_ID>

Optional URL parameters

  • &zoom=13 to tweak the zoom level.
  • &lang=en to set the language of the map. See this list for acceptable values, note that not all labels can be translated.
  • &fullscreen=1 to make the map fill the entire screen.

Custom Google Maps or Snazzy Maps Styles

If you have a Google Maps style json, convert it to Base64 and URL encode it.

Then use the following link as your obs overlay source. Make sure to copy the entire thing, and be sure to set your Google Maps API key in the url as well.

https://overlays.rtirl.com/googlemaps.html?key=<YOUR_PULL_KEY>&api_key=<YOUR_GOOGLE_MAPS_API_KEY>&style=<BASE64