sky-csc / osl

Overlay Spectator Live (For League of Legends)

OSL : Overlay Spectator Live

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 :

• 4 view
• Team/Dragon/Baron/Elder frame
• Team name
• Number of victory/lose teams
• Frame for video/logo/player picture ...
• Items buy
• Dragon kill

End Game :

• 3 view
• Team name
• Team score
• Team win loose
• Général information : assists, barracks killed, champions killed, gold earned, largest critical strike, largest killing spree, largest multi kill, level, magic damage dealt player, magic damage dealt to champions, magic damage taken, minions killed, num deaths, physical damage dealt player, physical damage dealt to champions, physical damage taken, total damage dealt, total damage dealt to buildings, total damage dealt to champions, total damage dealt to objectives, total damage dealt to turrets, total damage self mitigated, total damage shielded on teammates, total damage taken, total heal, total heal on teammates, total time crowd control dealt, true damage dealt player, true damage dealt to champions, true damage taken, turrets killed, vision score, ward killed, ward placed
• 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

Link to OSL-Web installation (Read the index web page when OSL-Web is launched)

Link to OSL-Client installation

A summary of the process to be followed :

1. Download last release
2. Unzip release to desired install folder
3. Run OSL-Web.exe
4. Change the Web Riot Api key in the web interface configuration Riot Developer page (take your api key) Login and copy past your "Development API Key"
5. Get IP of your computer where OSL-Web.exe is running (windows+r, cmd, ipconfig, field IPv4) and copy this ip on ip field on OSL-CLient-vx.x.x/Configuration/server-socket.json
6. If you understand what you are doing, add this information in this file C:/Riot Games/League of Legends/Config/game.cfg

[General]
EnableReplayApi=1

[Spectator]
eSportsNeutralTimers=1

[LiveEvents]
Enable=1
Port=34243

7. If you understand what you are doing, create file C:/Riot Games/League of Legends/Config/LiveEvents.ini and copy on it

OnKill
OnKillDragon_Spectator
OnNeutralMinionKill
OnMinionKill
OnSummonRiftHerald
OnKillWorm_Spectator
OnTurretDie
OnMinionKill
OnChampionKill

6. If you don't understand what you are doing download game.cfg and replace the file on C:/Riot Games/League of Legends/Config/game.cfg
7. If you don't understand what you are doing download LiveEvents.ini and replace the file on C:/Riot Games/League of Legends/Config/LiveEvents.ini
8. Run OSL-Client.exe on the computer where the spectator game is running
9. 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
10. 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
11. 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
12. 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
13. Have fun

Roadmap

2.0.0 version are planned for April 2024 (end Q1 beginning Q2)

OSL-CDragon

• Refactoring code (planned for 2.0.0)
• Fix bugs, download and display errors (planned for 2.0.0)
• No other features planned yet

OSL-Client

• Refactoring code (planned for 2.0.0)
• No other features planned yet

OSL-Common

• Refactoring code (planned for 2.0.0)
• No other features planned yet

OSL-Docfx

• Write and enhanced documentation for 2.0.0

OSL-LcuApi

• Refactoring code (planned for 2.0.0)
• Cover all LcuApi request (not planned yet)

OSL-LiveEvents

• Refactoring code (planned for 2.0.0)
• No other features planned yet

OSL-ReplayApi

• Refactoring code (planned for 2.0.0)
• Cover all ReplayApi request (not planned yet)

OSL-Web

• Refactoring code (planned for 2.0.0)

• Enhanced web interface (planned for 2.0.0)

• CDragon

  • Manuel download patch and language (planned for 2.0.0)
  • Manual select patch and language (planned for 2.0.0)
  • Enhanced web interface (planned for 2.0.0)

• Champ Select

  • Enhanced customization web interface (planned for 2.0.0)
  • Display team logo (planned for 2.0.0)
  • Fix bugs, square, splash art not display (planned for 2.0.0)
  • Enhancing existing views (planned for 2.0.0)
  • Display stat winrate and pick champ (not planned yet)
  • New view (not planned yet)

• Config

  • Enhanced web interface (planned for 2.0.0)

• End Game

  • Enhanced customization web interface (planned for 2.0.0)
  • Display team logo on overlay (planned for 2.0.0)
  • Number of Voidgrubs killed (planned for 2.0.0)
  • Enhancing existing views (planned for 2.0.0)

• In Game

  • Read information in memory (not planned yet, wait Riot Vanguard information)
    • HP/Mana/Dragon/Gold/Dega in fight/Champion stacks/XP/Level ...
  • Enhanced customization web interface (planned for 2.0.0)
  • Enhancing existing views (planned for 2.0.0)
    • Voidgrubs
      • Timer (planned for 2.0.0)
      • Number killed per team (planned for 2.0.0)
      • Logo (planned for 2.0.0)
      • Add your own logo (not planned yet)
    • Herald
      • Change timer (planned for 2.0.0)
      • Change default logo (planned for 2.0.0)
      • Add your own logo (not planned yet)
    • Baron
      • Change default logo for each baron (planned for 2.0.0)
      • Add your own logo (not planned yet)
    • Dragon
      • For fire add ash (planned for 2.0.0)
      • Add your own logos (not planned yet)
    • Items
      • Update list and fix bugs (planned for 2.0.0)
    • Display team logo (planned for 2.0.0)
    • Win lose display (planned for 2.0.0)
  • Add multiple overlay types (planned for 2.0.0)

• Runes

  • Enhanced customization web interface (planned for 2.0.0)
  • Enhancing existing views (planned for 2.0.0)
  • Add multiple overlay types (not planned yet)

OSL-WebApiRiot

• Refactoring code (planned for 2.0.0)
• Cover all WebApiRiot request (not planned yet)

Thanks to these projets and community

Floh22

LeagueBroadcast (League of Legends Spectate Overlay Tools )

Riot Community Volunteers

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)

Litzuck

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)

Piorrro33

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

SkinSpotlights

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.

osl's Issues

bug api ingame

adjustment suggestion

synchronize the tags of post game teams with the endgame one, so you don't need to edit them on two separate pages, but do it on one page, or in the end game, change acronyms for the team logo and separate the victory/defeat of the teams so you can customize better, for example in my layout I can't move just the abbreviation to the space I made in the layout without moving the victory or defeat

already in the picks and bans, for the next update or I don't know the adjustment of the layouts to put the choice and banning of the teams the little arrow changing sides with support for the score of how many victories/defeats there are during the course of the championship, below there is a model drawn of how would it look with the adjustments, if possible add the spells after the end of the choices and banishments

I was forgetting, the whole system has a bug when changing fonts, I tried to change different forms of fonts and not one of them works. "/..assets/css/font/fonts <//> /..assets/css/font/fontLOL"

Riot Launcher Path not found

Complete all the steps of the "OSL-Web", start the league of legends client, and then start the "OSL-Client" and now I get this error, where is the problem coming from?

NO IMAGES

Good afternoon, you are not showing me the images of the champion selection, is there any step that can be done about it? thank you so much

possible adjustment in picks and bans?

if possible could you put these adjustments in the picks and bans in view 3, and also the arrow indicating each team that is banning or choosing?

adjust the ban to put it like this, I can put it in the champion selection, but not in the bans.

and the championship logo in the middle of the picks and bans.
and the removal of the bar where the players' nicknames are,
with custom color function.

Erro Runes, end game info.

Bug - images of picks and bans, e ingame

and < not only the images of picks and bans, the runes are also not being pulled, they are not even pulling a champion, it is as if they were not in the lobby with the message waiting for initiation.

Hello, the error is still on the streets as I said, there is only one but before it worked fine but now the other ingame api is buggy, which shows team scores the drakes for each team made is not displaying after this bug fix that occurred later of the patch update, and it's not showing the drake elder and nashor powerplayers either, I don't know how but it's interfering with the ingame api, the ingame api I use is the one from LeagueBroadcast > https://github.com/floh22/ LeagueBroadcast

LcuApi Request error

LiveEvents.ini

Hi, I wanted to re-write the LiveEvents.ini, but I dont have it in my file. So I wanted to download it trough you link but then 404 error comes. Can you help me?

IN GAME

Help, not found in game

would it be possible to put her matchups view of the day?

the loading screen before starting the games, which you can edit like the picks and bans you already have, only with the logos and the team's championship score?

above there is an example of a view of matchups / game break

Can you help with this here?

How can I do this in my layout, put half of the champion's art in black and white and leave the rest in color?
Is there any way around here, with this type of filter?

forecast for implementation of yam customizable layout?

times drakes, herald, nashor, golds team, turrets, and the team layout?

When I open OSL-Client.exe , it keeps showing error

bug in the pt-br language, br viewer post patch update

picks and bans without image only appears in the pattern again also without pulling the post game data due to the br viewer post patch update.

can someone help me configure an api?

I have this error in the api in the ex of the OSL-client, since the OSL-WEB runs completely without errors, could someone help me solve this?, I already configured and reconfigured everything 3 times and I cannot run it anymore.

Would it be possible to have something like this layout?

Would it be possible to have something like this layout?

only with these adjustments here that I made in photoshop?
with custom colors in the teams add the camp logo in the middle on top of the patch and the timer will only be there in the middle of the bans in circular?

bug champion select, runes and post game, champions without image

bug champion select, runes and post game, champions without image

hm... not working

Getting Started
there is mistypo I think

3. Run OSL-Client on the computer
4. Run OSL-Client on the computer

I run server and client on same pc and I did edit appsettings.json file to http://0.0.0.0:4141
I run OSL-Server.exe, OSL-Client.exe in same pc and when I test to run with league client
made custom game and and it read lobby but once I start the OSL-Client.exe cmd closed

can you help me with this adjustment in picks and bans?

I tried to put it but it doesn't take this adjustment in the css in the view3 settings, I couldn't put it can you help me or make these adjustments, and do you have any prediction of when the next update comes out?

bug champion select

bug champion select, runes and post game, champions without image

Question about design

Hi, I want to ask if there is some way to change the look of the "LCK" style pick ban? We have speciffic art style for league and it doesnt match.