Camille.LolGame 3.0.0-nightly-2021-07-15-6c4b797b48

This is a prerelease version of Camille.LolGame.
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package Camille.LolGame --version 3.0.0-nightly-2021-07-15-6c4b797b48
NuGet\Install-Package Camille.LolGame -Version 3.0.0-nightly-2021-07-15-6c4b797b48
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Camille.LolGame" Version="3.0.0-nightly-2021-07-15-6c4b797b48" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Camille.LolGame --version 3.0.0-nightly-2021-07-15-6c4b797b48
#r "nuget: Camille.LolGame, 3.0.0-nightly-2021-07-15-6c4b797b48"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Camille.LolGame as a Cake Addin
#addin nuget:?package=Camille.LolGame&version=3.0.0-nightly-2021-07-15-6c4b797b48&prerelease

// Install Camille.LolGame as a Cake Tool
#tool nuget:?package=Camille.LolGame&version=3.0.0-nightly-2021-07-15-6c4b797b48&prerelease

Camille

Github Actions NuGet Stable NuGet Pre Release API Reference

C# Library for the Riot Games API

Camille's goals are speed, reliability, and maintainability. Camille handles rate limits and large requests with ease. Data classes are automatically generated from the Riot API Reference (Swagger).

Features

  • Fast, asynchronous, thread-safe.
  • Automatically retries failed requests.
  • Automatic up-to-date nightlies, reflecting Riot API changes within 24 hours.
  • Multi-targeted: .NET Standard 1.1+, .NET Framework 4.5+, .NET Core 2.0, .NET Standard 2.1+, .NET Core 3.0+.
  • Highly-configurable.
  • Riot API LOL-V4, TFT, LOR support.
  • C# 8 nullable support.

Installation

Install via NuGet (MingweiSamuel.Camille).

Usage

All API interactions are done using a RiotApi instance. RiotApi.NewInstance takes either just an API key (for default settings) or a IRiotApiConfig instance (for custom settings).

var riotApi = RiotApi.NewInstance("RGAPI-12345678-abcd-1234-abcd-123456abcdef");
// OR
var riotApi = RiotApi.NewInstance(
    new RiotApiConfig.Builder("RGAPI-12345678-abcd-1234-abcd-123456abcdef")
    {
        MaxConcurrentRequests = 200,
        Retries = 10,
        // ...
    }.Build()
);

You can find all configuration options here.

API methods are divided up into respective endpoints, corresponding to the left bar of the API reference.

Example

// Get summoners by name synchronously. (using async is faster).
var summoners = new[]
{
    riotApi.SummonerV4().GetBySummonerName(Region.NA, "jAnna kendrick"),
    riotApi.SummonerV4().GetBySummonerName(Region.NA, "lug nuts k")
};

foreach (var summoner in summoners)
{
    Console.WriteLine($"{summoner.Name}'s Top 10 Champs:");

    var masteries =
        riotApi.ChampionMasteryV4().GetAllChampionMasteries(Region.NA, summoner.Id);

    for (var i = 0; i < 10; i++)
    {
        var mastery = masteries[i];
        // Get champion for this mastery.
        var champ = (Champion) mastery.ChampionId;
        // print i, champ id, champ mastery points, and champ level
        Console.WriteLine("{0,3}) {1,-16} {2,10:N0} ({3})", i + 1, champ.Name(),
            mastery.ChampionPoints, mastery.ChampionLevel);
    }
    Console.WriteLine();
}

Output (2019-02-06):

Janna Kendrick's Top 10 Champs:
  1) Ekko              1,280,476 (7)
  2) Master Yi            89,871 (7)
  3) Jinx                 59,238 (6)
  4) Yasuo                58,625 (7)
  5) Poppy                52,140 (7)
  6) Maokai               46,567 (6)
  7) Ezreal               44,604 (6)
  8) Lulu                 42,794 (6)
  9) Kennen               42,500 (7)
 10) Zilean               41,710 (6)

LugnutsK's Top 10 Champs:
  1) Zyra                548,939 (7)
  2) Soraka               73,675 (6)
  3) Morgana              59,828 (5)
  4) Sona                 50,001 (6)
  5) Nami                 44,775 (6)
  6) Brand                42,108 (5)
  7) Janna                41,923 (5)
  8) Taric                37,916 (6)
  9) Ekko                 35,837 (5)
 10) Poppy                31,457 (5)

This example takes advantage of C#'s async/await tasks to fetch 10 matches all at once.

var summonerNameQuery = "lugnutsk";

// Get summoners data (blocking).
var summonerData = await riotApi.SummonerV4().GetBySummonerNameAsync(Region.NA, summonerNameQuery);
if (null == summonerData)
{
   // If a summoner is not found, the response will be null.
   Console.WriteLine($"Summoner '{summonerNameQuery}' not found.");
   return;
}

Console.WriteLine($"Match history for {summonerData.Name}:");

// Get 10 most recent matches (blocking).
// Queue ID 420 is RANKED_SOLO_5v5 (TODO)
var matchlist = await riotApi.MatchV4().GetMatchlistAsync(
   Region.NA, summonerData.AccountId, queue: new[] { 420 }, endIndex: 10);
// Get match results (done asynchronously -> not blocking -> fast).
var matchDataTasks = matchlist.Matches.Select(
       matchMetadata => riotApi.MatchV4().GetMatchAsync(Region.NA, matchMetadata.GameId)
   ).ToArray();
// Wait for all task requests to complete asynchronously.
var matchDatas = await Task.WhenAll(matchDataTasks);

for (var i = 0; i < matchDatas.Count(); i++)
{
   var matchData = matchDatas[i];
   // Get this summoner's participant ID info.
   var participantIdData = matchData.ParticipantIdentities
       .First(pi => summonerData.Id.Equals(pi.Player.SummonerId));
   // Find the corresponding participant.
   var participant = matchData.Participants
       .First(p => p.ParticipantId == participantIdData.ParticipantId);

   var win = participant.Stats.Win;
   var champ = (Champion) participant.ChampionId;
   var k = participant.Stats.Kills;
   var d = participant.Stats.Deaths;
   var a = participant.Stats.Assists;
   var kda = (k + a) / (float) d;

   // Print #, win/loss, champion.
   Console.WriteLine("{0,3}) {1,-4} ({2})", i + 1, win ? "Win" : "Loss", champ.Name());
   // Print champion, K/D/A
   Console.WriteLine("     K/D/A {0}/{1}/{2} ({3:0.00})", k, d, a, kda);
}

Output (2019-02-19):

Match history for LugnutsK:
  1) Win  (Zyra)
     K/D/A 2/3/11 (4.33)
  2) Win  (Zyra)
     K/D/A 5/1/13 (18.00)
  3) Loss (Zyra)
     K/D/A 2/5/1 (0.60)
  4) Win  (Sona)
     K/D/A 1/13/23 (1.85)
  5) Win  (Zyra)
     K/D/A 3/1/5 (8.00)
  6) Win  (Zyra)
     K/D/A 6/3/16 (7.33)
  7) Win  (Zyra)
     K/D/A 2/4/7 (2.25)
  8) Loss (Zyra)
     K/D/A 1/10/8 (0.90)
  9) Loss (Zyra)
     K/D/A 0/11/5 (0.45)
 10) Win  (Zyra)
     K/D/A 4/5/15 (3.80)

API Reference

Automatically generated API Reference

Source Code

Source code is located in the src/ directory, corresponding to the MingweiSamuel.Camille namespace.

RiotApi.cs is the main point of entry for interfacing with Camille, however this source file is only a partial class. The remainder of the class is automatically generated and not commited to the master branch, but is viewable as described below in the "Generated Classes" section.

Files in the src/util directory/MingweiSamuel.Camille.Util namespace are internal classes used for sending requests and handling rate limits.

Generated Classes

The majority of the code in Camille is automatically generated. The generated sources are not commited to the master branch, but are available in the gh-pages branch in the _gen/ directory.

GeneratedClasses.cs contains all endpoints, and therefore endpoint methods, as well as all the data transfer objects corresponding to the JSON returned by the Riot API.

Champion.cs is an enum for working with champion IDs.

RiotApiConfig.cs is the configuration builder code for creating RiotApi instnaces with custom settings.

The actual code for generating these classes is in the src/gen folder. The C#-generating code is in *.cs.dt files and is written in NodeJS, using doT.js templates.

Product Compatible and additional computed target framework versions.
.NET net5.0 is compatible.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.1 is compatible.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 is compatible. 
.NET Standard netstandard2.1 is compatible. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
3.0.0-nightly-2024-03-25-7d... 38 3/25/2024
3.0.0-nightly-2024-03-24-7d... 47 3/24/2024
3.0.0-nightly-2024-03-13-9d... 50 3/13/2024
3.0.0-nightly-2024-03-08-85... 50 3/8/2024
3.0.0-nightly-2024-03-05-85... 56 3/5/2024
3.0.0-nightly-2024-02-17-85... 49 2/17/2024
3.0.0-nightly-2024-02-07-85... 69 2/7/2024
3.0.0-nightly-2024-01-20-de... 68 1/20/2024
3.0.0-nightly-2024-01-15-de... 56 1/15/2024
3.0.0-nightly-2024-01-04-95... 87 1/4/2024
3.0.0-nightly-2024-01-04-67... 61 1/4/2024
3.0.0-nightly-2023-12-06-6d... 105 12/6/2023
3.0.0-nightly-2023-11-28-6d... 69 11/28/2023
3.0.0-nightly-2023-11-24-6d... 66 11/24/2023
3.0.0-nightly-2023-11-21-6d... 68 11/21/2023
3.0.0-nightly-2023-11-16-6d... 55 11/16/2023
3.0.0-nightly-2023-11-15-6d... 52 11/15/2023
3.0.0-nightly-2023-11-11-6d... 52 11/11/2023
3.0.0-nightly-2023-10-18-6d... 66 10/18/2023
3.0.0-nightly-2023-10-17-0d... 61 10/17/2023
3.0.0-nightly-2023-10-11-9f... 75 10/11/2023
3.0.0-nightly-2023-09-23-9f... 73 9/23/2023
3.0.0-nightly-2023-09-12-9f... 73 9/12/2023
3.0.0-nightly-2023-09-05-9f... 77 9/5/2023
3.0.0-nightly-2023-08-27-1f... 88 8/27/2023
3.0.0-nightly-2022-10-18-9e... 146 10/18/2022
3.0.0-nightly-2022-09-22-9e... 116 9/22/2022
3.0.0-nightly-2022-09-06-9e... 98 9/6/2022
3.0.0-nightly-2022-09-01-9e... 93 9/1/2022
3.0.0-nightly-2022-08-16-9e... 111 8/16/2022
3.0.0-nightly-2022-08-04-9e... 115 8/4/2022
3.0.0-nightly-2022-07-20-9e... 113 7/20/2022
3.0.0-nightly-2022-06-30-9e... 129 6/30/2022
3.0.0-nightly-2022-06-25-9e... 121 6/25/2022
3.0.0-nightly-2022-06-22-a6... 118 6/22/2022
3.0.0-nightly-2022-06-20-a6... 112 6/20/2022
3.0.0-nightly-2022-05-26-9f... 115 5/26/2022
3.0.0-nightly-2022-05-20-9f... 118 5/20/2022
3.0.0-nightly-2022-04-12-9f... 127 4/12/2022
3.0.0-nightly-2022-03-03-9f... 120 3/3/2022
3.0.0-nightly-2022-02-11-9c... 120 2/11/2022
3.0.0-nightly-2022-01-19-e2... 133 1/19/2022
3.0.0-nightly-2021-12-30-6d... 133 12/30/2021
3.0.0-nightly-2021-11-20-c5... 474 11/20/2021
3.0.0-nightly-2021-11-20-93... 507 11/20/2021
3.0.0-nightly-2021-11-11-93... 153 11/11/2021
3.0.0-nightly-2021-10-24-93... 188 10/24/2021
3.0.0-nightly-2021-10-24-5b... 252 10/24/2021
3.0.0-nightly-2021-10-13-2d... 143 10/13/2021
3.0.0-nightly-2021-10-10-47... 237 10/10/2021
3.0.0-nightly-2021-10-02-52... 175 10/2/2021
3.0.0-nightly-2021-09-10-6f... 185 9/10/2021
3.0.0-nightly-2021-09-04-6f... 136 9/4/2021
3.0.0-nightly-2021-08-25-6f... 157 8/25/2021
3.0.0-nightly-2021-07-24-14... 249 7/24/2021
3.0.0-nightly-2021-07-23-14... 170 7/23/2021
3.0.0-nightly-2021-07-15-6c... 146 7/15/2021
3.0.0-nightly-2021-07-03-6c... 292 7/3/2021
3.0.0-nightly-2021-06-26-6c... 176 6/26/2021
3.0.0-nightly-2021-06-05-6c... 206 6/5/2021
3.0.0-nightly-2021-05-21-7b... 166 5/21/2021
3.0.0-nightly-2021-05-20-7b... 185 5/20/2021
3.0.0-nightly-2021-05-14-09... 156 5/14/2021
3.0.0-nightly-2021-05-10-09... 171 5/10/2021
3.0.0-nightly-2021-05-02-ec... 219 5/2/2021
3.0.0-nightly-2021-04-30-ec... 153 4/30/2021
3.0.0-nightly-2021-04-22-ec... 170 4/22/2021
3.0.0-nightly-2021-04-17-ec... 213 4/17/2021
3.0.0-nightly-2021-04-14-ec... 153 4/14/2021
3.0.0-nightly-2021-04-03-ec... 225 4/3/2021
3.0.0-nightly-2021-01-17-ec... 173 1/17/2021
3.0.0-nightly-2021-01-14-94... 219 1/14/2021
3.0.0-nightly-2021-01-09-fb... 223 1/9/2021
3.0.0-nightly-2020-12-12-fb... 191 12/12/2020
3.0.0-nightly-2020-11-12-83... 248 11/12/2020
3.0.0-nightly-2020-11-06-70... 309 11/6/2020
3.0.0-nightly-2020-11-01-70... 294 11/1/2020
3.0.0-nightly-2020-10-08-de... 347 10/8/2020
3.0.0-nightly-2020-10-03-de... 242 10/3/2020
3.0.0-nightly-2020-10-02-de... 270 10/2/2020
3.0.0-nightly-2020-09-19-de... 252 9/19/2020
3.0.0-nightly-2020-09-16-de... 330 9/16/2020
3.0.0-nightly-2020-09-15-de... 319 9/15/2020
3.0.0-nightly-2020-09-02-2a... 332 9/2/2020
3.0.0-nightly-2020-09-01-ce... 297 9/1/2020