Skip to content

Repository files navigation

OSL : Overlay Spectator Live

GitHub Release Github last released date Github last commit date

GitHub OSL stars Total downloads Issues

MIT Licensed Wiki

Language .Net-10.0 Framework Application server Application overlay

lib lib

League of Legends Api League of Legends Api Riot api cdragon

OSL is an free open-source project that provides tools and libraries for working with League of Legends game data and building real-time overlays. The data recovery software and the overlay software are separate and can be deployed on multiple computer.

Features

Is a short list of features, read documentation for more information and tips.

Available

  • Champion Select overlay and customization
  • Fearless overlay
  • End Game overlay
  • Manage team information (name, tag, coach, logo, player name, player picture)
  • Display BO, Patch, Phase, Vs information (text)

In Development

  • New Champion Select overlays
  • Fearless view customization
  • End Game view customization
  • New End Game overlays
    • Display more stats for one player (Runes, items, stats)
  • Add In Game overlays
  • Add Runes overlays

Repository

Source code:

GitHub: https://github.com/Sky-CSC/OSL/

Latest Release

Download the latest stable version:

Latest Release: https://github.com/Sky-CSC/OSL/releases/latest

OSL Server

The OSL Server is responsible for collecting League of Legends data and distributing it to connected clients in real time. It acts as the central component of the platform, exposing game information through WebSockets for overlays and other applications.

Home OSL Server Home


OSL Overlay

The OSL Overlay is a web-based application that displays live game information received from the OSL Server. It provides a collection of customizable overlays.

Home OSL Server Home

Champ Select OSL Server Champ Select

Fearless OSL Server Fearless OSL Server Fearless OSL Server Fearless

End Game OSL Server End Game

Documentation

Applications, riot api and installation documentation. Link documentation

Getting Started

Installation

  • Download Latest Release
  • Run OSL-Server.exe, a web page opens automatically when the application is launched
  • Run OSL-Overlay.exe, a web page opens automatically when the application is launched

The two applications do not need to be on the same computer to work. You just need to change the IP address and/or port in the dedicated web interface (OSL-Overlay -> OSL-Server Config).

OBS

  • Go to OBS web pages of OSL-Overlay
  • Copy url on OBS application

Caution

Use only http links, not https. OSB does not support https links.

OBS

Thanks to these projets and community

Needlework.Net (A .NET helper development tool for the LCU and Game Client!)

hasagi-types (This repo hosts the auto-generated swagger.json and TypeScript types for the LCU API)

LeagueBroadcast (League of Legends Spectate Overlay Tools)

league-prod-toolkit (Toolkit for League Productions with overlays for champion select, ingame events, end of game stats, and more)

league-observer-tool (An addition to the league-prod-toolkit for the observer PC)

lol-pick-ban-ui (Web-Based UI to display the league of legends champ select in esports tournaments)

lol-spectator-overlay-client (A client that produces an overlay similar to that of the one used in the broadcasts of LoL Esports during 2015-2017)

overlay (Customizable UI for League of Legends champion select spectating)

LiveEventsDocumentation (Minimalist documentation of live events)

License

Distributed under the MIT License. See LICENSE for more information.

Legal disclaimer

OSL isn't endorsed by Riot Games and doesn't reflect the views or opinions of Riot Games or anyone officially involved in producing or managing Riot Games properties. Riot Games, and all associated properties are trademarks or registered trademarks of Riot Games, Inc.

OSL was created under Riot Games' "Legal Jibber Jabber" policy using assets owned by Riot Games. Riot Games does not endorse or sponsor this project.