Stormancer.Server.Plugins.GameSession 6.2.1.24-pre

This is a prerelease version of Stormancer.Server.Plugins.GameSession.

There is a newer version of this package available.
See the version list below for details.

dotnet add package Stormancer.Server.Plugins.GameSession --version 6.2.1.24-pre

NuGet\Install-Package Stormancer.Server.Plugins.GameSession -Version 6.2.1.24-pre

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="Stormancer.Server.Plugins.GameSession" Version="6.2.1.24-pre" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="Stormancer.Server.Plugins.GameSession" Version="6.2.1.24-pre" />
                    

                            Directory.Packages.props

<PackageReference Include="Stormancer.Server.Plugins.GameSession" />
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add Stormancer.Server.Plugins.GameSession --version 6.2.1.24-pre

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Stormancer.Server.Plugins.GameSession, 6.2.1.24-pre"

#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.

#:package Stormancer.Server.Plugins.GameSession@6.2.1.24-pre

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=Stormancer.Server.Plugins.GameSession&version=6.2.1.24-pre&prerelease
                    

                            Install as a Cake Addin

#tool nuget:?package=Stormancer.Server.Plugins.GameSession&version=6.2.1.24-pre&prerelease
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

This plugin adds support for P2P & client-server game sessions to a Stormancer application. It supports:

P2P and Client/Server game sessions
Electing an host in P2P game sessions
Managing game servers (requires adding ServerPools.hpp to the game server)
Game session startup/shutdown events
Game session results aggregation and processing in P2P (allows comparing game results from all peers) and Client/server (only the server sends game results)
Public or access restricted game sessions.

Setting up game servers

The gamesession system supports starting game servers to run the game session.

Development game servers

The development game server pool enables gamesessions to wait for the connection of a non authenticated gameserver to host the game session. This enables starting the game server manually from a developer computer, in the debugger or on the cmd prompt.The clients and game server uses the normal P2P connectivity system, supporting NAT traversal. This avoids the need of any configuration on the developer network.

ctx.HostStarting += (IHost host) =>
{
    [...]

    //Declares a development server pool named dev.
    host.ConfigureServerPools(c => c.DevPool("dev"));

    //Declares a gamesession type using the pool configured above.
    host.ConfigureGameSession("gamesession-server", c => c
        .UseGameServer(c => c
            .PoolId("dev")
            )
        .CustomizeScene(scene=>scene.AddSocket())
    );

    [...]
}

Hosting game servers on local docker

The docker server pool enables game servers to be run as docker container on Stormancer cluster. Containers are automatically started on the node running the less game instances. Other policies could be put in place if necessary.

ctx.HostStarting += (IHost host) =>
{
    [...]

    //Declares a docker server pool named docker, that uses the image 'game-server-image:latest'
    host.ConfigureServerPools(c => c.DockerPool("docker", b => b.Image("game-server-image:latest")));

    //Declares a gamesession type using the pool configured above.
    host.ConfigureGameSession("gamesession-server", c => c
        .UseGameServer(c => c
            .PoolId("docker")
            )
        .CustomizeScene(scene=>scene.AddSocket())
    );

    [...]
}

Other tasks are required to host game servers on docker:

Grid configuration

For the game servers to connect to the Stormancer cluster from inside docker containers, the grid nodes must not be bound to localhost. They must publish public, or at least LAN IP addresses. To do that, in the node configuration file, set both publicIp and loadbalancedIp to an interface accessible by docker containers, for instance:

{
    "constants": {
        "host-ip" : "xxx.xxx.xxx.xxx"
        "publicIp": "{host-ip}",
        "loadBalancedIp": "{host-ip}",
        [...]

Stormancer needs to associate local ports to the game server. To specify the range of ports to use, a delegated transport entry must be added to the grid nodes configuration:

[...]

"endpoints": {
    //udp transport
    "udp1": {
        "type": "raknet",
        "port": "{udpPort}",
        "maxConnections": 100,
        "publicEndpoint": "{publicIp}:{udpPort}"
    },
    
    [...]
    
    //delegated transport, allows specifying a pool of ports.
    "public1": {
        "type": "delegated",
        "publicEndpoint": "{publicIp}",
        "ports": {
        "min": 42000,
        "max": 44000

        }

    }
},
[...]

The node firewall must be opened for UDP in the range specified (42000-44000 in the example).

Secrets

Docker servers authentify with the grid using an encrypted token using the aes-gcm algorithm. The encryption key is stored in a cluster secret store that must be created manually. The path to the key is specified in the application' configuration in the gameServer dataProtection policy:

{
    [...]

    "dataProtection":{
	    "gameServer":{
		    "provider":"aes-gcm",
		    "key":"my-account/my-secret-store/gameServer",
		    "createKeyIfNotExists":true
	    }
        [...]
    }
}

The secrets store must be created prior to application start. If the CLI plugin Stormancer.Management.CLI is installed, it can be created using the following command:

> dotnet tool run stormancer manage secrets-store create --cluster test --account my-account --id my-secret-store

Analytics

The plugin produces the following analytics:

Product	Compatible and additional computed target framework versions.
.NET	net6.0 is compatible. 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. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed.

Product

.NET

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net6.0
- Docker.DotNet (>= 3.125.12)
- MsgPack.Cli (>= 1.0.1)
- Stormancer.Abstractions.Server (>= 9.3.0)
- Stormancer.Server.Plugins.Api (>= 3.0.0.2-pre)
- Stormancer.Server.Plugins.DataProtection (>= 2.0.1.4-pre)
- Stormancer.Server.Plugins.Management (>= 3.1.0-pre)
- Stormancer.Server.Plugins.Models (>= 4.0.0.1-pre)
- Stormancer.Server.Plugins.Users (>= 9.0.0.34-pre)
- Stormancer.Server.Plugins.WebApi (>= 3.1.0-pre)
- System.Interactive.Async (>= 5.0.0)
- System.Linq.Async (>= 6.0.1)

NuGet packages (9)

Showing the top 5 NuGet packages that depend on Stormancer.Server.Plugins.GameSession:

Package	Downloads
Stormancer.Server.Plugins.Party Provides Party related features to a Stormancer server application.	67.4K
Stormancer.Server.Plugins.GameFinder Provides Gamefinder features to a Stormancer server application.	65.6K
Stormancer.Server.Plugins.GameHistory Game history system for Stormancer server applications.	14.7K
Stormancer.Server.Plugins.Spectate Provides game data streaming APIs for replay or realtime spectate.	8.8K
Stormancer.Server.Plugins.Replication Provides server services required for object replication.	7.9K

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last Updated
6.3.2.6-pre	34	4/24/2026
6.3.2.5-pre	39	4/23/2026
6.3.2.4-pre	101	4/8/2026
6.3.2.3-pre	109	3/29/2026
6.3.2.2-pre	94	3/28/2026
6.3.2.1-pre	145	3/15/2026
6.3.2-pre	150	3/11/2026
6.3.1-pre	117	1/20/2026
6.3.0-pre	191	12/5/2025
6.2.2.5-pre	238	10/10/2025
6.2.2.2-pre	249	8/27/2025
6.2.1.95-pre	95	1/18/2026
6.2.1.94-pre	104	1/5/2026
6.2.1.93-pre	159	7/30/2025
6.2.1.92-pre	203	6/4/2025
6.2.1.91-pre	203	6/4/2025
6.2.1.90-pre	207	6/3/2025
6.2.1.89-pre	199	6/3/2025
6.2.1.86	326	3/3/2025
6.2.1.24-pre	311	10/27/2023

Added
*****
- Added support for crash reports in game server agent.
- Exclude agents for 30s when they failed to create a server
- Kill agents if they fail twice in succession, indicating they are faulty.
- Added `IGameSessionEventHandler.OnGameSessionShutdown` event fired during scene shutdown.
- Added `IGameSessionEventHandler.OnGameSessionReset` event fired when the gamesession is reset by the host.
- Added `IGameSessionEventHandler.ShouldCompleteGame` event fired to decide if the gamesession should evaluate the results posted with PostResult and complete the game.
- Added property `CreatedOn` on `IGamesessionService` to get the UTC date the gamesession was created.
- Added Session to context of `IGameSessionEventHandler.OnGameSessionCompleted`.
- Added support for regions.
- Added PostingGameResults event fired whenever a client sends results to the game session.
- Added Admin API to get events and live state about a gamesession.
- Added Admin API to retrive the server logs of a gamesession.

Changed
*******
- Removed a retry when creating a game session.
- Declared game servers as service clients to disable client related features, for instance version checking.
- Compatibility with Player models 4.0.0

Fixed
*****
- Fixed infinite loop in the analytics worker loop.
- Fixed an wrong null check on closing servers that could lead to a NullRef exception when updating the game server auditing record.
- When trying to start a game server, timeout if it takes more than 5s to do a docker start on an agent.
- Fixed false positives error logs.
- Resetting a game session force the gamesession to be completed if it wasn't already, exactly as if all players add left it. This guarantees that if only the host sent results, they would be processed on reset, triggering (for instance) a PSN Activity completion.
- Made the plugin compatible with Users 9.0.0
- Do not try getting the client in PostResults if it is not in the list of clients.
- Fixed host couldn't be found in gamesessions if specified in the game session config because SessionId was compared with the user id.
- Don't shutdown the game session if there is no player but pending reservations.