LANCommander/LANCommander.SDK
2024-10-28 00:59:50 -05:00
..
Enums Fix download queueing 2024-10-24 19:18:00 -05:00
Exceptions Validate API version when doing requests 2024-05-13 18:41:00 -05:00
Extensions Import mods and expansions, but filter them out 2024-10-09 17:41:42 -05:00
Helpers Move SDK services to separate namespace 2024-10-04 23:39:07 -05:00
Models Allow uploading of archive files via CLI 2024-10-01 17:56:58 -05:00
PowerShell Avoid null reference when trying to gather return value 2024-09-27 17:59:47 -05:00
Services Package save entries with UTF-8 names 2024-10-28 00:59:50 -05:00
Client.cs Report correct error on registration 2024-10-24 19:44:20 -05:00
EventArgs.cs Rough but functional download queue 2024-01-20 21:02:41 -06:00
ExtractionResult.cs Relocate crucial installation logic to SDK 2023-11-09 19:40:38 -06:00
GameExecutionContext.cs More logging for SDK 2024-09-17 00:19:23 -05:00
icon.png Add NuGet info for SDK 2024-09-29 23:31:59 -05:00
LANCommander.SDK.csproj bumping Server csproj version to 1.0.3 2024-10-21 10:55:58 +00:00
README.md Add NuGet info for SDK 2024-09-29 23:31:59 -05:00
TrackableStream.cs Relocate crucial installation logic to SDK 2023-11-09 19:40:38 -06:00
VersionInterceptor.cs Fix version header check 2024-08-11 14:48:10 -05:00

LANCommander.SDK

The LANCommander SDK is a .NET 8 assembly designed to allow developers to implement their own client. Most of the core functionality of the official launcher is implemented directly in the SDK and currently supports functionality such as:

  • Authentication to a LANCommander server
  • Installation of games / redistributables
  • Launching of games and play session tracking
  • Media linking and downloading
  • Game save uploading and downloading, including packing and extraction
  • PowerShell script execution
  • Updating player's alias and custom fields
  • Submission of issues
  • Game lobby scanning

Basic Use

In order to do almost anything through the SDK, you must have an authenticated instance of the LANCommander.SDK.Client class. Here is an example of how to instantiate the class and authenticate to a server:

var client = new LANCommander.SDK.Client("http://localhost:1337", "C:\\Games");

await client.AuthenticateAsync("username", "password");

Once the client is authenticated, everything you need is available as a manager under the client. For example, to install a game by ID you might use the following:

await client.Games.InstallAsync("114f653d-ea91-484b-8fe9-8e9bb58bde81");

Documentation

For full documentation, review the official LANCommander documentation.