RCVolus / league-prod-toolkit

Toolkit for League Productions with overlays for champion select, ingame events, end of game stats, and more

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Features

Production Features

  • Manage and dynamically update lower thirds for casters
  • Track matchups and scores to automatically generate overlays for ingame, talks and breaks
  • Apply consistent theming across all generated overlays
  • Twitch integration to create predictions and show state in stream (requires a Twitch-App)

League Features

Pregame

  • Lobby information with all players and op.gg links
  • Custom Champ Select overlay (Implementation of lol-pick-ban-ui)
  • Recording and Replay of Champselect
  • Rune overview (to kill time during spectator delay, game needs to be live)

Ingame

A lot of these features are impacted by the removal of the LiveEvents API and the introduction of Vanguard. Level ups, item purchases, the killfeed and inhibitor timers should still work.

  • Custom Scoreboard
  • Leader boards for Gold and Level + XP
  • Animations for level ups and item purchases
  • Animations for events (Baron | Dragons | Herald)
  • Custom killfeed
  • Power-Play timer for Baron and Elder Dragon
  • Inhibitor timers

Postgame

Screens showing postgame stats

  • Overview
  • Pick order
  • Item builds
  • Damage graphs
  • Gold graph

Valorant Features

Status 13.03.2023: VALORANT features are currently not maintained. While we focus on League, we will not actively support Valorant Features of the toolkit.

Pregame

  • Custom Agent select overlay
  • Loading screen overlay

Postgame

  • Stats for the winning team
  • MVP screen

Requirements & Limitations

  • Champion Select / ingame overlays require our Observer Tool to send game data
  • Some features require a Riot API Key
  • Some features do not work on Tournament Realm

Installation & Docs

Troubleshooting & Help

Some common issues are listed in the Wiki.

If your problem is not listed in the Wiki, please check if there are any open issues. If not, open a new issue and include any error messages you see and steps to reproduce the problem.

About Prod Toolkit

Architecture/Sample setup

This shows the prod toolkit running on a dedicated server, with observer PCs sending data and overlays integrated into OBS/vMix with a browser source.

Example Setup

Legend:

  • Magenta - Clients running the observer tool
  • Blue - The prod-toolkit
  • Green - An external API that is being connected to
  • Grey - Prod-toolkit interfaces

Developing

The developer documentation can be found in the wiki.

Legal Disclaimer

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

About

Toolkit for League Productions with overlays for champion select, ingame events, end of game stats, and more

License:MIT License


Languages

Language:TypeScript 71.2%Language:HTML 11.7%Language:Pug 8.7%Language:CSS 3.5%Language:JavaScript 3.3%Language:Dockerfile 0.7%Language:Batchfile 0.6%Language:Shell 0.2%