Git Product home page Git Product logo

lcu-connector's Introduction

lcu-connector

Streamlined LCU integration for your app.

This connector automatically retrieves the credentials for the API that starts when the new League of Legends client is launched.

To find out more about how the new client works check out the Riot Games engineering blog

For the LCU API documentation check out Rift explorer

Download

lcu-connector is installable via:

  • GitHub git clone https://github.com/Pupix/lcu-connector.git
  • yarn: yarn add lcu-connector
  • npm: npm install lcu-connector

Usage example

const LCUConnector = require('lcu-connector');
const connector = new LCUConnector();

connector.on('connect', (data) => {
    console.log(data);
    //  {
    //    address: '127.0.0.1'
    //    port: 18633,
    //    username: 'riot',
    //    password: H9y4kOYVkmjWu_5mVIg1qQ,
    //    protocol: 'https'
    //  }
});

// Start listening for the LCU client
connector.start();

Available methods

constructor (executablePath)

Creates a new lcu-connector.

Parameters

  1. [executablePath] {string} A path to where the LeagueClient executable resides. If not passed it will be automatically figured out from the OS process list.

start()

Starts listening for the LCU client.

stop()

Stops the connector.

Events

connect

Fired when the connection to the LCU client is established

disconnect

Fired when the connection to the LCU client is closed

lcu-connector's People

Contributors

codesigndev avatar iczero avatar mitsuhakitsune avatar pupix avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.