Stormancer.Server.Plugins.GameSession 6.2.1.24-pre

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher.
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
                    


                    

                
#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

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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

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.
Stormancer.Server.Plugins.GameFinder

Provides Gamefinder features to a Stormancer server application.
Stormancer.Server.Plugins.GameHistory

Game history system for Stormancer server applications.
Stormancer.Server.Plugins.Spectate

Provides game data streaming APIs for replay or realtime spectate.
Stormancer.Server.Plugins.Replication

Provides server services required for object replication.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
6.2.2.2-pre 176 8/27/2025
6.2.2.1-pre 221 5/9/2025
6.2.2-pre 115 4/25/2025
6.2.1.93-pre 96 7/30/2025
6.2.1.92-pre 144 6/4/2025
6.2.1.91-pre 142 6/4/2025
6.2.1.90-pre 145 6/3/2025
6.2.1.89-pre 138 6/3/2025
6.2.1.88-pre 137 6/3/2025
6.2.1.87-pre 139 6/3/2025
6.2.1.86 210 3/3/2025
6.2.1.86-pre 206 3/3/2025
6.2.1.85 195 2/28/2025
6.2.1.85-pre 150 12/20/2024
6.2.1.84-pre 135 10/25/2024
6.2.1.83-pre 112 10/15/2024
6.2.1.82-pre 248 9/30/2024
6.2.1.81-pre 247 9/26/2024
6.2.1.80-pre 231 8/28/2024
6.2.1.76-pre 137 8/9/2024
6.2.1.75-pre 144 8/9/2024
6.2.1.74-pre 122 8/9/2024
6.2.1.73-pre 125 8/9/2024
6.2.1.72-pre 132 8/2/2024
6.2.1.71-pre 340 6/10/2024
6.2.1.70-pre 221 4/17/2024
6.2.1.69-pre 131 4/17/2024
6.2.1.65-pre 158 4/16/2024
6.2.1.63-pre 229 4/2/2024
6.2.1.61-pre 235 3/11/2024
6.2.1.59-pre 138 1/17/2024
6.2.1.58-pre 157 1/12/2024
6.2.1.57-pre 272 12/11/2023
6.2.1.56-pre 154 12/7/2023
6.2.1.55-pre 220 12/1/2023
6.2.1.53-pre 225 11/22/2023
6.2.1.52-pre 252 11/20/2023
6.2.1.51-pre 109 11/15/2023
6.2.1.50-pre 137 11/14/2023
6.2.1.49-pre 135 11/14/2023
6.2.1.48-pre 144 11/14/2023
6.2.1.47-pre 132 11/14/2023
6.2.1.46-pre 138 11/13/2023
6.2.1.45-pre 126 11/13/2023
6.2.1.44-pre 125 11/13/2023
6.2.1.43-pre 131 11/12/2023
6.2.1.42-pre 152 11/12/2023
6.2.1.41-pre 135 11/12/2023
6.2.1.40-pre 145 11/12/2023
6.2.1.39-pre 133 11/12/2023
6.2.1.38-pre 124 11/12/2023
6.2.1.37-pre 134 11/12/2023
6.2.1.36-pre 157 11/12/2023
6.2.1.35-pre 169 11/11/2023
6.2.1.33-pre 161 11/8/2023
6.2.1.31-pre 115 11/7/2023
6.2.1.30-pre 141 11/7/2023
6.2.1.28-pre 190 10/27/2023
6.2.1.27-pre 169 10/27/2023
6.2.1.26-pre 147 10/27/2023
6.2.1.25-pre 139 10/27/2023
6.2.1.24-pre 220 10/27/2023
6.2.1.23-pre 200 10/25/2023
6.2.1.22-pre 139 10/23/2023
6.2.1.21-pre 139 10/20/2023
6.2.1.20-pre 138 10/20/2023
6.2.1.19-pre 206 10/20/2023
6.2.1.18-pre 130 10/20/2023
6.2.1.17-pre 139 10/20/2023
6.2.1.15-pre 129 10/19/2023
6.2.1.14-pre 191 10/19/2023
6.2.1.13-pre 195 10/13/2023
6.2.1.12-pre 133 10/13/2023
6.2.1.10-pre 173 10/12/2023
6.2.1.9-pre 147 10/12/2023
6.2.1.7-pre 151 10/11/2023
6.2.1.6-pre 132 10/11/2023
6.2.1.4-pre 152 10/11/2023
6.2.1.3-pre 147 10/11/2023
6.2.1.2-pre 188 10/10/2023
6.2.1.1-pre 162 10/5/2023
6.2.1-pre 250 10/4/2023
6.2.0.14-pre 152 10/2/2023
6.2.0.13-pre 163 9/29/2023
6.2.0.12-pre 145 9/28/2023
6.2.0.11-pre 244 9/12/2023
6.2.0.10-pre 188 9/8/2023
6.2.0.9-pre 172 9/7/2023
6.2.0.8-pre 167 9/1/2023
6.2.0.7-pre 126 8/31/2023
6.2.0.6-pre 186 8/29/2023
6.2.0.5-pre 305 8/18/2023
6.2.0.4-pre 220 8/18/2023
6.2.0.3-pre 208 8/17/2023
6.2.0.2-pre 178 8/17/2023
6.2.0-pre 196 8/9/2023
6.1.2.35-pre 183 8/4/2023
6.1.2.34-pre 218 8/3/2023
6.1.2.33-pre 259 8/1/2023
6.1.2.32-pre 190 8/1/2023
6.1.2.31-pre 327 6/29/2023
6.1.2.30-pre 231 6/29/2023
6.1.2.29-pre 426 6/15/2023
6.1.2.28-pre 192 6/15/2023
6.1.2.27-pre 189 6/15/2023
6.1.2.26-pre 187 6/15/2023
6.1.2.25-pre 193 6/15/2023
6.1.2.24-pre 210 6/15/2023
6.1.2.23-pre 204 6/15/2023
6.1.2.22-pre 195 6/15/2023
6.1.2.21-pre 185 6/15/2023
6.1.2.20-pre 182 6/15/2023
6.1.2.19-pre 203 6/15/2023
6.1.2.18-pre 299 6/6/2023
6.1.2.17-pre 213 6/6/2023
6.1.2.15-pre 252 5/30/2023
6.1.2.14-pre 315 5/24/2023
6.1.2.13-pre 263 5/18/2023
6.1.2.12-pre 180 5/18/2023
6.1.2.11-pre 183 5/18/2023
6.1.2.10-pre 225 5/17/2023
6.1.2.8-pre 213 5/15/2023
6.1.2.7-pre 232 5/12/2023
6.1.2.6-pre 209 5/11/2023
6.1.2.5-pre 189 5/11/2023
6.1.2.4-pre 210 5/11/2023
6.1.2.3-pre 193 5/11/2023
6.1.2.2-pre 210 5/11/2023
6.1.2.1-pre 307 5/9/2023
6.1.2-pre 191 5/9/2023
6.1.1.15 415 5/9/2023
6.1.1.15-pre 198 5/5/2023
6.1.1.14-pre 174 5/5/2023
6.1.1.13-pre 177 4/30/2023
6.1.1.12-pre 215 4/30/2023
6.1.1.11-pre 181 4/27/2023
6.1.1.10-pre 216 4/24/2023
6.1.1.9-pre 227 4/21/2023
6.1.1.8-pre 187 4/21/2023
6.1.1.7-pre 225 4/21/2023
6.1.1.6-pre 204 4/21/2023
6.1.1.3-pre 223 4/13/2023
6.1.1.2-pre 195 4/13/2023
6.1.1.1-pre 203 4/13/2023
6.1.0.20-pre 234 4/11/2023
6.1.0.19-pre 194 4/7/2023
6.1.0.18-pre 208 4/6/2023
6.1.0.17 535 4/4/2023
6.1.0.17-pre 220 3/31/2023
6.1.0.16-pre 191 3/31/2023
6.1.0.15-pre 197 3/30/2023
6.1.0.13-pre 199 3/30/2023
6.1.0.12-pre 209 3/29/2023
6.1.0.11-pre 203 3/29/2023
6.1.0.10-pre 223 3/29/2023
6.1.0.9-pre 208 3/29/2023
6.1.0.8-pre 218 3/29/2023
6.1.0.7-pre 208 3/29/2023
6.1.0.6-pre 191 3/29/2023
6.1.0.5-pre 201 3/28/2023
6.1.0.4-pre 199 3/28/2023
6.1.0.3-pre 211 3/21/2023
6.1.0.2-pre 222 3/21/2023
6.1.0.1-pre 233 3/19/2023
6.1.0-pre 211 3/19/2023
6.0.3.6-pre 429 12/8/2022
6.0.3.5-pre 205 12/8/2022
6.0.3.4-pre 184 12/7/2022
6.0.3.3-pre 187 12/7/2022
6.0.3.2-pre 231 12/7/2022
6.0.3.1-pre 206 12/7/2022
6.0.3-pre 199 12/6/2022
6.0.2 488 10/28/2022
6.0.1.1 1,020 10/26/2022
6.0.1.1-pre 229 10/26/2022
6.0.0.3-pre 229 10/3/2022
6.0.0.2 1,510 9/28/2022
6.0.0.2-pre 421 9/12/2022
5.5.0.11-pre 492 8/2/2022
5.5.0.10-pre 244 7/27/2022
5.5.0.9-pre 452 7/1/2022
5.5.0.8-pre 319 6/9/2022
5.5.0.3-pre 244 5/24/2022
5.4.0.60-pre 545 4/12/2022
5.4.0.59-pre 287 4/12/2022
5.4.0.58-pre 301 3/31/2022
5.4.0.57-pre 261 3/31/2022
5.4.0.56-pre 263 3/24/2022
5.4.0.55-pre 264 3/23/2022
5.4.0.53-pre 270 3/22/2022
5.4.0.51-pre 379 3/15/2022
5.4.0.26-pre 257 3/14/2022
5.4.0.25-pre 266 3/14/2022
5.4.0.23-pre 276 3/8/2022
5.4.0.22-pre 264 3/1/2022
5.4.0.7-pre 358 2/28/2022
5.3.0.104-pre 257 3/17/2022
5.3.0.103-pre 259 3/17/2022
5.3.0 2,799 1/21/2022
5.3.0-pre 517 1/14/2022
5.2.0 1,547 12/15/2021
5.2.0-pre 405 10/26/2021
5.1.0.1 953 10/14/2021
5.0.1.2 1,346 5/23/2021
5.0.1.2-pre 803 5/12/2021
5.0.1-pre 389 5/3/2021
4.0.7 1,135 4/29/2021
4.0.6 562 4/19/2021
4.0.5 606 3/22/2021
4.0.4.1 846 3/20/2021
4.0.4 1,263 3/1/2021
4.0.3.2 588 12/18/2020
4.0.3.2-pre 469 12/17/2020
4.0.3.1-pre 422 12/17/2020
4.0.3-pre 451 12/17/2020
4.0.1.1 992 12/9/2020
4.0.0.1 1,254 12/4/2020
3.3.4 606 12/9/2020
3.3.3.2 613 12/8/2020
3.3.3.2-pre 442 12/8/2020
3.3.2.2 1,266 10/20/2020
3.3.2.2-pre 569 10/13/2020
3.3.2.1-pre 480 9/29/2020
3.3.2-pre 983 8/11/2020
3.3.1.1-pre 509 8/11/2020
3.3.1-pre 432 8/11/2020
3.3.0-pre 488 7/1/2020
3.2.3-pre 458 6/30/2020
3.2.2-pre 457 6/23/2020
3.2.1-pre 502 6/22/2020
3.2.0-pre 577 6/16/2020
3.1.3-pre 499 6/15/2020
3.1.2-pre 518 6/9/2020
3.0.2 659 6/15/2020
3.0.2-pre 539 6/5/2020
3.0.1 1,478 5/27/2020
3.0.1-pre 849 3/30/2020
3.0.0-pre 1,124 3/29/2020
2.0.0.3 718 2/20/2020
2.0.0.3-pre 941 2/22/2020
2.0.0.2 707 2/19/2020
2.0.0.1 1,269 2/19/2020
2.0.0 939 2/13/2020
1.2.1-alpha.2 431 2/19/2020
1.2.1-alpha.1 438 1/27/2020
1.1.1 1,063 1/21/2020
1.1.1-alpha.1 435 2/19/2020
1.0.0.3 1,238 1/4/2020
1.0.0.2 771 1/4/2020
1.0.0.1 1,220 1/4/2020

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.