Skip to content

1. Installation

Dominik edited this page Jan 22, 2024 · 18 revisions

Installation

Prerequisites

  • Node.js 20.10 (Download)
  • at least 3GB of additional free disk space
  • Riot API Key (for runes and postgame features)
  • Most features need a client with the respective Observer Tool installed

Install Prod-Toolkit

  1. Download the latest release (prod-toolkit.zip) from github
  2. Extract the folder to the directory you want to run the tool from
  3. run install.bat
  4. Enter the configuration values in the script, navigate with arrow keys (these values can all be changed later):
  • set your API Key
  • select your server
  • enable or disable authentication (enabling authentication is recommended if the toolkit is exposed to the internet)
  • select your desired toolkit modules, either getting all modules for a game or selecting specific modules
  1. run start.bat (or run npm start)
  2. wait for the DataDragon download to complete (wait until you see config saved)
  3. restart the toolkit by closing the window and relaunching start.bat
  • If authentication is enabled, the console will display the key needed for logging into the dashboard

The dashboard should now available at http://localhost:3003/

  1. head to the theming page and apply the default theme

Observer Tool

Most ingame features need an observer tool running on an observer PC to query local game APIs. You can download and install the observer tools here:

LiveEvents API

Some League ingame features need the LiveEvents API configured on the PC running the observer tool. Please refer to the observer tool readme for instructions.

Clone this wiki locally