Skip to content

Latest commit

 

History

History
155 lines (105 loc) · 6.66 KB

README.md

File metadata and controls

155 lines (105 loc) · 6.66 KB
Raw

Contributors Forks Stargazers Issues MIT License

!!DEPRECATED!!

Due to the introduction of Vanguard, League Broadcast ingame will no longer function. There are plans for the future, however, for now, only champ select is function Join our Discord or visit our Website to stay informed about future updates.

League Broadcast

A central hub for League of Legends stream overlays to augment and elevate streams.

Currently includes support for champion select and ingame overlays, with post game support as a possible future feature.

League Broadcast uses Memory Reading to get information that the Riot API does not expose. This is not possible any more due to Vanguard Anti Cheat.

Community and Contact

Join our Discord

Visit our Website

This is the quickest way to reach us and to troubleshoot your issues.

Otherwise use the Github Issues page to report breaking issues. These are not help forums! Use the issue and feature request templates, issues without proper information will be removed.

Features

Ingame Features currently include:

  1. Level Up Indicators with support for item names
  2. Item Purchase Indicators
  3. Baron Timer & Power Play Pop Up
  4. Elder Timer & Power Play Pop Up
  5. Dynamic Gold Graph
  6. CS/EXP/Gold Player Tab
  7. Custom Scoreboard
  8. Inhibitor Timers
  9. Auto init UI on Game Start
  10. Custom Objective Timers

Includes a C# port of RCVolus ChampSelect tool!

Auto update included

Getting Started

To get a local copy up and running follow these steps.

Prerequisites

  • Windows 10 20H1 (May 2020 Update) Build 19041
  • Active Internet connection

Installation

  1. Download latest release
  2. Unzip release to desired install folder
  3. Add http://localhost:9001/frontend?backend=localhost as a browser source in OBS in your ingame scene
  4. Add http://localhost:9001/?backend=ws://localhost:9001/api as a browser source in OBS in your PickBan scene

Usage

  • Components of League Broadcast can be en-/disabled separately. Enable Pick/Ban or Ingame as you need.

  • On first run League Broadcast will download the latest DataDragon cache.

    • Champ Select data included to support a port of RCVolus Pick/Ban
    • Champ Select delay support added! No more waiting between champ select and ingame. Champ select is delayed by a configurable amount to reduce the wait

  • If League is not installed at the default location, add the folder which contains the "Riot Games" Folder or your "League of Legends" Install folder to Config/Component.json -> LeagueInstall. This is a comma separated list which determines where LB will look for League. This is needed for the LiveEvents and Replay API.

  • Because League Broadcast uses Memory Reading to gather information, it will not properly work without the correct memory offsets for each patch. Offsets will be updated in this repo, please feel free to reach out here if they have not. You should not have to do anything after a patch as offsets will be updated automatically when available, it can however take around 24 hours or longer!. You may also set your own offset repo location in configuration if/when this repo stops including updated offsets.

Switching from RCVolus PickBan Tools

If you have previously used RCVolus PickBan tool and wish to use the version included in LB, build your frontend scene. Where one would usually run

npm run start

to start PickBan, now run

npm run build

in the same location and move the files in build/ to LeagueBroadcastHub/frontend/pickban/

Make sure Champ Select is enabled

League Broadcast will now host PickBan automatically when started

Overlay Configuration

Config/Ingame.json contains the configuration for the ingame overlay. Change this to suit your needs.

Add any Fonts you wish to use to the comma separated list "GoogleFonts"

Change the images and videos in Frontend/ingame to swap out resources.

Roadmap

Current overhaul in progress. Earliest release - mid/late 2024.

License

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

This is a standalone project from Lars Eble. Riot Games does not endorse or sponsor this project.

This project's port of lol-pick-ban-ui and its author are in no way affiliated or partnered with Riot Community Volunteers.

Contact

Discord - discord.lolfar.site

Website - Website