Skip to content

Latest commit

 

History

History
226 lines (146 loc) · 8.74 KB

README.md

File metadata and controls

226 lines (146 loc) · 8.74 KB
Raw

SuperScoreboard

SuperScoreboard is a League of Legends overlay to track cooldowns. (Proof of concept.)

Our overlay is superimposed onto the in-game scoreboard, hence the name.

What's "super" about it is how easy and intuitive it is to use:
It codifies(?) common practices, like double clicking an enemy summ to signal that it was used.
Also, it uses familiar UI patterns, like holding a button to reset or toggle its state (e.g. holding the Mute Player button to mute/unmute someone).

In-game screenshot
Notice Warwick's Ghost. It reads -157, meaning there are 157 seconds left until it is up.

Tray icon
Tray icon.

Design

How it should work:

  • Pressing tab (maybe only when the game is running and is fullscreen):

    • Display a semi-transparent SuperScoreboard overlay in the center of the screen, covering the in-game scoreboard.

  • Double clicking a summ:

    • Sets (or resets) its timer.
    • Also results in pinging it in-game.

  • Long pressing a summ:

    • Unsets its cooldown.
    • Shows a loading indicator, similar to the "Mute Player Comms" effect.

  • Right clicking a participnt:

    • Change its position (swapping positions).

  • Double clicking the app's icon

    • It should copy Flash timers to the clipboard or type it in team chat.

Goals:

  • Simplistic, no-nonsense.

  • Takes runes and items into account.

    • If any opponent has the Inspiration rune, try to fetch all minor runes (from external APIs).
    • If that fails, just fallback to assuming that if a player has Inspiration tree, they also have Cosmic Insight ("Insp = Cosmic").

  • Takes delay into account (the player is not going to instantly record the usage of a summ, so we should that it was used a few seconds earlier, say 5 secs).

  • Reflects the ordering of participants on the ingame scoreboard.

    • Preferably, it automatically reflects the ingame scoreboard order.
    • Otherwise, we can always let the user manually reorder SuperScoreboard's participants using a context menu (e.g. "Move to TOP").

  • Should be lighter than existing solutions.
    (Use something like C#/WPF or Java/Swing, no Chromium bullshit. I just needed something that works on my hunk of metal :/)

Non-goals:

  • Automatically tracking summs (e.g. if we "see" them being used, using some AI/CV/sound recognition bullshit or even process memory reading... Too complex. Too hacky/scripty.).

  • Reading "Team Chat" and trusting teammates' pings.
    (AFAIK, you can't access in-game chat using client APIs (LCU or LiveClientData), but you can still use AI/OCR. Again, fuck AI bullshit.)
    (And, yes, I am aware that you can access chat using unofficial libraries/SDKs, like Overwolf)

Getting Started

Tested with:

  • Windows 10.
    (Anything newer than Windows XP should work.)
  • OpenJDK 15 x64 and OpenJDK 17 x64.

Just download the portable binary runnable jar from Releases.

Run the overlay and League (in whatever order) and it should just work.

Also, the game must run in Borderless mode.

Uses

External dependencies:

Expected Questions

What cooldowns can we track?

For now, only summs, but ult and item cooldowns are no different.
Item CDs are easy to implement.
However, ult CDs are more complex because they rely on multiple variables:

  • Using Ultimate Hunter and having some stacks.
  • Using Transcendence. It gives +5 AH at lvl 5 and again at lvl 8. (while we get and may use our ult at lvl 6)
  • Having Axiom Arc and getting some takedowns while the ult is on CD.
  • Staff of Flowing Water's passive.
    • For example, Sona R normally is 133 seconds, but becomes 112 secs after shileding someone and gaining +20 AH from Staff.
  • Some R cds get refreshed partially when some conditions are met:
    • Katarina on takedowns.
    • Sona after maxing her passive.
    • Ezreal after hitting anything with his Q.

How is it different from others?

  • All of them display their overlays next to the scoreboard (juxtaposed), while ours is superimposed onto the scoreboard.

  • If the player want to track the summ and ping it, they have to click in two different places. Our project (or at least its goal) allows you to click only in once place.

  • Most of the open source projects either require a Riot API key, disregard runes, or simply assume that "insp = cosmic". Our project does not. It just works.

Existing projects

Closed source:

  • Overwolf-based: Mobalytics, Porofessor, U.GG, etc.

  • Others: OP.GG.

Open source:

  • SummonerTracker Overlay (https://github.com/CodeIsJustLikeMagic/SummonerTrackerOverlay)

    • "An Overlay intended for Tracking Summoner Spells and sharing them with teammates."
    • Written in Python, uses PyQt5 and MQTT (to share info between teammates).
    • Features
      • 🟪 The summoner spell buttons will assume that the spell has been used 7 seconds ago.
      • 🟩 Only uses Client features (no dependency on external Riot APIs).
      • 🟩 Tracks ult CD based on its initial cooldown + AH from dragons (Cloud) + AH from items.
      • 🟨 "The overlay is not visible if you play in fullscreen mode."
      • 🟪 "reload" will update the positions of the Champions in the Setter Window according to the in game scoreboard.
      • 🟨 It assumes that Insp = Cosmic Insight.

  • Pocket DoinB (https://github.com/daiy29/DoinB)

    • Written in Python, uses Tkinter and RiotWatcher, and depends on Riot APIs (Summoner and Spectator).

  • LoLSSTracker (https://github.com/cody-k/LoLSSTracker)

    • "A non-overlay League of Legends summoner spell tracker built in C#."
    • Written in C#, uses WinForms, and depends on Riot APIs.

Name

  • Superimposed Scoreboard

    • Other overlays are "juxtaposed". Ours is "superimposed" onto the ingame scoreboard.

  • Super Scoreboard Short version of the previous name.

  • Omnistone Superset Not only the scoreboard, it may also include Seer Stone (minimap) and Beeper (QuinnAD mentioned it).

ChatGPT gets it: ChatGPT's response

The name "SuperScoreboard" appears to be clever because it plays with the idea of superimposing an overlay onto an existing in-game scoreboard. It combines "super" and "scoreboard" to suggest that this overlay is somehow better, more advanced, or enhanced compared to the original scoreboard. The use of "super" is a way of making the overlay seem more impressive than it actually is, creating a sense of excitement and superiority.

In essence, it's a playful and somewhat ironic name that makes the overlay sound more significant than its actual function of being an addition or enhancement to the existing scoreboard. It's a clever way to make the overlay stand out and capture attention, even if it's just a graphical addition to the game interface.

Definitions

Terms

  • Participant: A player in a game, identified by their summoner name.

  • Principal Participant: The current user, the current player, the active player (as LiveClientData calls them).

  • League Client (CEF-based).

  • Game Client (DirectX9-based).

  • Riot Client.

Symbols (colored squares)

GitHub-supported emoji.

  • 🟩 Green: Good.
  • 🟥 Red: Bad.
  • 🟨 Yellow: Warning or "sus".
  • 🟪 Purple: Just something worth noting.

Disclaimer

This is a free, fan-made project.

It has not been verified/approved by Riot, and it may violate the game's terms of service. Use at your own risk. (Maybe check Riot Games's Legal page.)

SuperScoreboard is not endorsed, certified or otherwise approved in any way by Riot Games, Inc. or any of its affiliates.

License

WTFPL