BlossomiShymae.GrrrLCU 0.11.1

GrrrLCU

GrrrLCU is a wrapper for the LCU API which is unofficially provided by Riot Games.

This library is currently compatible with .NET 8 and higher for Windows.

Contributors

<a href="https://github.com/BlossomiShymae/GrrrLCU/graphs/contributors"> <img src="https://contrib.rocks/image?repo=BlossomiShymae/GrrrLCU" /> </a>

Usage

Sample application

A demonstration of GrrrLCU with more code examples can be found here.

To run the demo:

dotnet run --project BlossomiShymae.GrrrLCU.Demo

Requesting the LCU

General request

var response = await Connector.SendAsync(HttpMethod.Get, "/lol-summoner/v1/current-summoner");

var me = await response.Content.ReadFromJsonAsync<Summoner>();

GET request

var me = await Connector.GetFromJsonAsync<Summoner>("/lol-summoner/v1/current-summoner");

POST request with body

var response = await Connector.SendAsync(HttpMethod.Post, "/player-notifications/v1/notifications", new JsonContent(playerNotificationResource));

var resource = await response.Content.ReadFromJsonAsync<PlayerNotificationResource>();

Utilities

var processInfo = Connector.GetProcessInfo();
var riotAuthentication = new RiotAuthentication(processInfo.RemotingAuthToken);

WebSockets

This library uses the Websocket.Client wrapper, which comes with built-in reconnection and error handling.

Create a client:

var client = Connector.CreateLcuWebsocketClient();

Listen to events, disconnections, or reconnection messages:

using System; // Include to avoid compiler errors CS1503, CS1660
              // You may or may not need this

client.EventReceived.Subscribe(msg =>
{
    Console.WriteLine(msg?.Data?.Uri);
});
client.DisconnectionHappened.Subscribe(msg => 
{
    if (msg.Exception != null) throw msg.Exception;
});
client.ReconnectionHappened.Subscribe(msg =>
{
    Console.WriteLine(msg.Type);
});

Use it:

// This starts the client in a background thread. You will need an event loop
// to listen to messages.
await client.Start();

// Subscribe to every event that the League Client sends.
var message = new EventMessage(RequestType.Subscribe, EventMessage.Kinds.OnJsonApiEvent);
client.Send(message);

// We will need an event loop for the background thread to process.
// You may close at any time with Ctrl+C or similar chord.
while(true) await Task.Delay(TimeSpan.FromSeconds(1));