Skip to content

Sky-CSC/OSL

Repository files navigation

OSL : Overlay Spectator Live

work-in-progress version

language .Net-6.0 framework platform

license

LoL1 LoL2 LoL3 LoL4 riot1 riot2

This project allows you to display an overlay with additional information for your League of Legends games

Applications use various APIs to collect information about the game, champions, players, .....

Features

Champ Select :

  • 4 view
  • Champ ban/select
  • Summoners names
  • Team name
  • Number of victory/lose teams
  • Timer ban/select/waiting
  • Summoners Spell

In Game :

With riot overlay :

  • 3 view
  • Team/Dragon/Baron frame
  • Team name
  • Number of victory/lose teams
  • Frame for video/logo/player picture ...

End Game :

  • 3 view
  • Team name
  • Team score
  • Team win loose
  • Damage to champion
  • Bans
  • KDA/Gold/Tower/Dragon/Elder Dragon/Herald/Baron
  • Gold Diff

Runes :

  • 7 view
  • Top
  • Jungle
  • Mid
  • Adc
  • Support
  • Adc and support
  • All

Documentation

Applications, riot api and installation documentation. Link documentation

Getting Started

Installation OSL-Client OSL-Web

  1. Download last release
  2. Unzip release to desired install folder
  3. Run OSL-Client on the computer where the spectator game is running
  4. Run OSL-Client on the computer you want (be careful, these two computers must be able to communicate, same network, or communicating network)
  5. Add http://ip:4141/champselect/view1 and/or http://ip:4141/champselect/view2 and/or http://ip:4141/champselect/view3 and/or http://ip:4141/champselect/view4 as a browser source in OBS in your ban pick scene
  6. Add http://ip:4141/ingame/view1 and/or http://ip:4141/ingame/view2 and/or http://ip:4141/ingame/view3 as a browser source in OBS in your in game scene
  7. Add http://ip:4141/endgame/view1 and/or http://ip:4141/endgame/view2 and/or http://ip:4141/endgame/view3 as a browser source in OBS in your in game scene
  8. Add http://ip:4141/runes/view1/top and http://ip:4141/runes/view1/jungle and http://ip:4141/runes/view1/mid and http://ip:4141/runes/view1/adc and http://ip:4141/runes/view1/supp and http://ip:4141/runes/view1/adcsupp and http://ip:4141/runes/view1/all as a browser source in OBS in your in game scene

Roadmap

Refactoring code :

  • (In progress !!)

In Game

  • Read in memory
  • Get game information (items, events ...)
  • Improved customization

Champ Select :

  • Improved customization

End Game

  • Improved customization

Runes

  • View 2
  • Improved customization

Thanks to these projets and community

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)

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.