LANCommander/LANCommander.SDK
2025-02-28 14:02:37 -06:00
..
Enums Add server scripts to execute on game start/stop, refactor how play sessions are recorded 2025-02-23 15:39:06 -06:00
Exceptions Validate API version when doing requests 2024-05-13 18:41:00 -05:00
Extensions Add missing extension 2025-02-04 21:37:07 -06:00
Helpers Add server scripts to execute on game start/stop, refactor how play sessions are recorded 2025-02-23 15:39:06 -06:00
Models Only show actions from installed games 2025-02-28 14:02:27 -06:00
PowerShell Refactor redistributable installation 2025-01-30 23:57:12 -06:00
Services Fix games not starting 2025-02-28 14:02:37 -06:00
Client.cs Add progress for redistributable installing 2025-01-31 00:34:37 -06: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
FileTransferMonitor.cs Fixed redist installation 2025-02-04 02:34:31 -06:00
icon.png Add NuGet info for SDK 2024-09-29 23:31:59 -05:00
LANCommander.SDK.csproj Fix script execution 2025-02-20 21:35:33 -06:00
ProcessExecutionContext.cs Fix server starting/stopping, fix server autostart preventing app from starting, fix status update on external close of server 2025-02-25 22:05:23 -06: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 Avoid exception on 500 responses 2024-11-07 20:41:10 -06: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.