GameService.Sdk.Core 1.0.8

GameService SDK for Unity & .NET

This SDK provides a clean, strongly-typed client for connecting to the GameService backend. It is designed to be compatible with Unity 2021.3+ and standard .NET applications.

Compatibility

• Target Framework: .NET Standard 2.1
• Dependencies:
  • Microsoft.AspNetCore.SignalR.Client
  • protobuf-net
  • Newtonsoft.Json (Optional, internal use mostly)

Installation in Unity

1. NuGet Packages: You need the DLLs for the dependencies. The easiest way is to use NuGetForUnity.
2. Install Packages:
   • Microsoft.AspNetCore.SignalR.Client
   • protobuf-net
   • System.Text.Json (If not present in newer Unity versions)
3. Copy SDK: Copy the source files from GameService.Sdk.Core, GameService.Sdk.Auth, etc., into your Unity Assets/Scripts/Sdk folder.

Usage

1. Authentication

// Initialize Auth Client
var auth = new AuthClient("http://localhost:5525");

// Login (Guest or Email)
var result = await auth.GuestLoginAsync();
if (result.Success) {
    Debug.Log($"Logged in! Token: {result.Session.AccessToken}");
}

2. Connect to Game Hub

// Connect using the session from auth
var gameClient = await result.Session.ConnectToGameAsync();

// Listen for events
gameClient.OnPlayerJoined += async (player) => {
    Debug.Log($"{player.UserName} joined seat {player.SeatIndex}");
};

3. Play a Game (e.g., Ludo)

// Create or Join
var ludo = await LudoClientFactory.CreateOnlineGameAsync(gameClient);

// Handle Game State
ludo.OnStateUpdated += (state) => {
    Debug.Log($"Current Player: {state.CurrentPlayer}");
};

// Actions
if (ludo.IsMyTurn) {
    await ludo.RollDiceAsync();
}

Architecture

• Transport: SignalR (WebSockets)
• Serialization: Protobuf (Binary) for game actions, JSON for metadata.
• Thread Safety: Use WithSynchronizationContext(true) when building the client in Unity to ensure callbacks run on the main thread.

Get Started with Unity

The Core SDK handles SignalR connections and real-time communication.

Key Classes

• GameClient: Main connection to GameService Hub
• GameSession: Authentication session with token management
• ConnectionState: Connection status tracking

Basic Connection

using GameService.Sdk.Core;

public class GameManager : MonoBehaviour
{
    private GameClient gameClient;
    
    private async void Start()
    {
        // Connect with access token
        gameClient = await GameClient.Create("https://your-server.com")
            .WithAccessToken(accessToken)
            .WithSynchronizationContext(true) // Unity main thread
            .ConnectAsync();
            
        // Listen for connection events
        gameClient.OnConnectionStateChanged += OnConnectionChanged;
        gameClient.OnLatencyUpdate += OnLatencyUpdate;
    }
    
    private async void OnConnectionChanged(ConnectionState state)
    {
        Debug.Log($"Connection: {state}");
    }
    
    private async void OnLatencyUpdate(int ms)
    {
        Debug.Log($"Latency: {ms}ms");
    }
    
    private async void OnDestroy()
    {
        if (gameClient != null)
            await gameClient.DisposeAsync();
    }
}

Room Management

// Create a new game room
var createResult = await gameClient.CreateRoomAsync("StandardLudo");
if (createResult.Success)
{
    Debug.Log($"Room created: {createResult.RoomId}");
    Debug.Log($"Short code: {createResult.ShortCode}");
}

// Join existing room
var joinResult = await gameClient.JoinRoomAsync("ABCDE"); // Short code or Room ID
if (joinResult.Success)
{
    Debug.Log($"Joined as seat {joinResult.SeatIndex}");
}

// Create or join a room (matchmaking)
// Searches for existing rooms sorted by player count, joins if available, otherwise creates a new room
var matchResult = await gameClient.CreateOrJoinRoomAsync("StandardLudo");
if (matchResult.Success)
{
    Debug.Log($"Joined as seat {matchResult.SeatIndex}");
}

// Leave room
await gameClient.LeaveRoomAsync();

Game Events

// Player events
gameClient.OnPlayerJoined += async (player) => 
{
    Debug.Log($"{player.UserName} joined seat {player.SeatIndex}");
};

gameClient.OnPlayerLeft += async (player) => 
{
    Debug.Log($"{player.UserName} left the game");
};

// Game state updates
gameClient.OnGameState += async (state) => 
{
    Debug.Log($"Game state updated: {state.PlayerCount} players");
};

// Chat messages
gameClient.OnChatMessage += async (message) => 
{
    Debug.Log($"{message.UserName}: {message.Message}");
};