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

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

Provides Party related 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.5-pre 136 10/10/2025
6.2.2.2-pre 215 8/27/2025
6.2.2.1-pre 343 5/9/2025
6.2.2-pre 142 4/25/2025
6.2.1.93-pre 121 7/30/2025
6.2.1.92-pre 172 6/4/2025
6.2.1.91-pre 172 6/4/2025
6.2.1.90-pre 174 6/3/2025
6.2.1.89-pre 166 6/3/2025
6.2.1.88-pre 166 6/3/2025
6.2.1.87-pre 166 6/3/2025
6.2.1.86 274 3/3/2025
6.2.1.86-pre 304 3/3/2025
6.2.1.85 311 2/28/2025
6.2.1.85-pre 189 12/20/2024
6.2.1.84-pre 191 10/25/2024
6.2.1.83-pre 134 10/15/2024
6.2.1.82-pre 372 9/30/2024
6.2.1.81-pre 388 9/26/2024
6.2.1.80-pre 333 8/28/2024
6.2.1.76-pre 165 8/9/2024
6.2.1.75-pre 168 8/9/2024
6.2.1.74-pre 152 8/9/2024
6.2.1.73-pre 152 8/9/2024
6.2.1.72-pre 185 8/2/2024
6.2.1.71-pre 555 6/10/2024
6.2.1.70-pre 320 4/17/2024
6.2.1.69-pre 168 4/17/2024
6.2.1.65-pre 211 4/16/2024
6.2.1.63-pre 327 4/2/2024
6.2.1.61-pre 355 3/11/2024
6.2.1.59-pre 174 1/17/2024
6.2.1.58-pre 183 1/12/2024
6.2.1.57-pre 359 12/11/2023
6.2.1.56-pre 179 12/7/2023
6.2.1.55-pre 282 12/1/2023
6.2.1.53-pre 285 11/22/2023
6.2.1.52-pre 357 11/20/2023
6.2.1.51-pre 135 11/15/2023
6.2.1.50-pre 163 11/14/2023
6.2.1.49-pre 164 11/14/2023
6.2.1.48-pre 169 11/14/2023
6.2.1.47-pre 147 11/14/2023
6.2.1.46-pre 165 11/13/2023
6.2.1.45-pre 151 11/13/2023
6.2.1.44-pre 151 11/13/2023
6.2.1.43-pre 156 11/12/2023
6.2.1.42-pre 178 11/12/2023
6.2.1.41-pre 160 11/12/2023
6.2.1.40-pre 171 11/12/2023
6.2.1.39-pre 162 11/12/2023
6.2.1.38-pre 149 11/12/2023
6.2.1.37-pre 158 11/12/2023
6.2.1.36-pre 206 11/12/2023
6.2.1.35-pre 217 11/11/2023
6.2.1.33-pre 196 11/8/2023
6.2.1.31-pre 141 11/7/2023
6.2.1.30-pre 168 11/7/2023
6.2.1.28-pre 239 10/27/2023
6.2.1.27-pre 204 10/27/2023
6.2.1.26-pre 173 10/27/2023
6.2.1.25-pre 163 10/27/2023
6.2.1.24-pre 285 10/27/2023
6.2.1.23-pre 266 10/25/2023
6.2.1.22-pre 164 10/23/2023
6.2.1.21-pre 165 10/20/2023
6.2.1.20-pre 162 10/20/2023
6.2.1.19-pre 273 10/20/2023
6.2.1.18-pre 165 10/20/2023
6.2.1.17-pre 166 10/20/2023
6.2.1.15-pre 158 10/19/2023
6.2.1.14-pre 246 10/19/2023
6.2.1.13-pre 247 10/13/2023
6.2.1.12-pre 159 10/13/2023
6.2.1.10-pre 217 10/12/2023
6.2.1.9-pre 176 10/12/2023
6.2.1.7-pre 179 10/11/2023
6.2.1.6-pre 156 10/11/2023
6.2.1.4-pre 178 10/11/2023
6.2.1.3-pre 171 10/11/2023
6.2.1.2-pre 230 10/10/2023
6.2.1.1-pre 218 10/5/2023
6.2.1-pre 348 10/4/2023
6.2.0.14-pre 166 10/2/2023
6.2.0.13-pre 203 9/29/2023
6.2.0.12-pre 171 9/28/2023
6.2.0.11-pre 340 9/12/2023
6.2.0.10-pre 214 9/8/2023
6.2.0.9-pre 197 9/7/2023
6.2.0.8-pre 195 9/1/2023
6.2.0.7-pre 154 8/31/2023
6.2.0.6-pre 222 8/29/2023
6.2.0.5-pre 420 8/18/2023
6.2.0.4-pre 269 8/18/2023
6.2.0.3-pre 244 8/17/2023
6.2.0.2-pre 205 8/17/2023
6.2.0-pre 222 8/9/2023
6.1.2.35-pre 209 8/4/2023
6.1.2.34-pre 266 8/3/2023
6.1.2.33-pre 313 8/1/2023
6.1.2.32-pre 216 8/1/2023
6.1.2.31-pre 420 6/29/2023
6.1.2.30-pre 256 6/29/2023
6.1.2.29-pre 590 6/15/2023
6.1.2.28-pre 224 6/15/2023
6.1.2.27-pre 212 6/15/2023
6.1.2.26-pre 224 6/15/2023
6.1.2.25-pre 213 6/15/2023
6.1.2.24-pre 241 6/15/2023
6.1.2.23-pre 226 6/15/2023
6.1.2.22-pre 216 6/15/2023
6.1.2.21-pre 226 6/15/2023
6.1.2.20-pre 203 6/15/2023
6.1.2.19-pre 246 6/15/2023
6.1.2.18-pre 411 6/6/2023
6.1.2.17-pre 261 6/6/2023
6.1.2.15-pre 290 5/30/2023
6.1.2.14-pre 436 5/24/2023
6.1.2.13-pre 325 5/18/2023
6.1.2.12-pre 207 5/18/2023
6.1.2.11-pre 217 5/18/2023
6.1.2.10-pre 272 5/17/2023
6.1.2.8-pre 258 5/15/2023
6.1.2.7-pre 290 5/12/2023
6.1.2.6-pre 246 5/11/2023
6.1.2.5-pre 223 5/11/2023
6.1.2.4-pre 245 5/11/2023
6.1.2.3-pre 226 5/11/2023
6.1.2.2-pre 256 5/11/2023
6.1.2.1-pre 416 5/9/2023
6.1.2-pre 231 5/9/2023
6.1.1.15 478 5/9/2023
6.1.1.15-pre 233 5/5/2023
6.1.1.14-pre 207 5/5/2023
6.1.1.13-pre 200 4/30/2023
6.1.1.12-pre 256 4/30/2023
6.1.1.11-pre 207 4/27/2023
6.1.1.10-pre 261 4/24/2023
6.1.1.9-pre 266 4/21/2023
6.1.1.8-pre 212 4/21/2023
6.1.1.7-pre 251 4/21/2023
6.1.1.6-pre 250 4/21/2023
6.1.1.3-pre 270 4/13/2023
6.1.1.2-pre 228 4/13/2023
6.1.1.1-pre 238 4/13/2023
6.1.0.20-pre 278 4/11/2023
6.1.0.19-pre 228 4/7/2023
6.1.0.18-pre 238 4/6/2023
6.1.0.17 616 4/4/2023
6.1.0.17-pre 270 3/31/2023
6.1.0.16-pre 218 3/31/2023
6.1.0.15-pre 232 3/30/2023
6.1.0.13-pre 224 3/30/2023
6.1.0.12-pre 256 3/29/2023
6.1.0.11-pre 238 3/29/2023
6.1.0.10-pre 257 3/29/2023
6.1.0.9-pre 242 3/29/2023
6.1.0.8-pre 253 3/29/2023
6.1.0.7-pre 243 3/29/2023
6.1.0.6-pre 226 3/29/2023
6.1.0.5-pre 236 3/28/2023
6.1.0.4-pre 234 3/28/2023
6.1.0.3-pre 234 3/21/2023
6.1.0.2-pre 257 3/21/2023
6.1.0.1-pre 278 3/19/2023
6.1.0-pre 248 3/19/2023
6.0.3.6-pre 647 12/8/2022
6.0.3.5-pre 231 12/8/2022
6.0.3.4-pre 219 12/7/2022
6.0.3.3-pre 212 12/7/2022
6.0.3.2-pre 279 12/7/2022
6.0.3.1-pre 261 12/7/2022
6.0.3-pre 245 12/6/2022
6.0.2 523 10/28/2022
6.0.1.1 1,120 10/26/2022
6.0.1.1-pre 266 10/26/2022
6.0.0.3-pre 265 10/3/2022
6.0.0.2 1,649 9/28/2022
6.0.0.2-pre 569 9/12/2022
5.5.0.11-pre 655 8/2/2022
5.5.0.10-pre 282 7/27/2022
5.5.0.9-pre 616 7/1/2022
5.5.0.8-pre 393 6/9/2022
5.5.0.3-pre 282 5/24/2022
5.4.0.60-pre 731 4/12/2022
5.4.0.59-pre 329 4/12/2022
5.4.0.58-pre 353 3/31/2022
5.4.0.57-pre 299 3/31/2022
5.4.0.56-pre 305 3/24/2022
5.4.0.55-pre 318 3/23/2022
5.4.0.53-pre 327 3/22/2022
5.4.0.51-pre 485 3/15/2022
5.4.0.26-pre 298 3/14/2022
5.4.0.25-pre 294 3/14/2022
5.4.0.23-pre 318 3/8/2022
5.4.0.22-pre 304 3/1/2022
5.4.0.7-pre 462 2/28/2022
5.3.0.104-pre 286 3/17/2022
5.3.0.103-pre 302 3/17/2022
5.3.0 2,995 1/21/2022
5.3.0-pre 731 1/14/2022
5.2.0 1,722 12/15/2021
5.2.0-pre 506 10/26/2021
5.1.0.1 1,097 10/14/2021
5.0.1.2 1,494 5/23/2021
5.0.1.2-pre 1,060 5/12/2021
5.0.1-pre 466 5/3/2021
4.0.7 1,242 4/29/2021
4.0.6 611 4/19/2021
4.0.5 639 3/22/2021
4.0.4.1 948 3/20/2021
4.0.4 1,459 3/1/2021
4.0.3.2 631 12/18/2020
4.0.3.2-pre 523 12/17/2020
4.0.3.1-pre 465 12/17/2020
4.0.3-pre 500 12/17/2020
4.0.1.1 1,137 12/9/2020
4.0.0.1 1,379 12/4/2020
3.3.4 650 12/9/2020
3.3.3.2 666 12/8/2020
3.3.3.2-pre 484 12/8/2020
3.3.2.2 1,365 10/20/2020
3.3.2.2-pre 665 10/13/2020
3.3.2.1-pre 566 9/29/2020
3.3.2-pre 1,243 8/11/2020
3.3.1.1-pre 551 8/11/2020
3.3.1-pre 473 8/11/2020
3.3.0-pre 530 7/1/2020
3.2.3-pre 503 6/30/2020
3.2.2-pre 498 6/23/2020
3.2.1-pre 547 6/22/2020
3.2.0-pre 652 6/16/2020
3.1.3-pre 543 6/15/2020
3.1.2-pre 574 6/9/2020
3.0.2 693 6/15/2020
3.0.2-pre 582 6/5/2020
3.0.1 1,580 5/27/2020
3.0.1-pre 1,008 3/30/2020
3.0.0-pre 1,364 3/29/2020
2.0.0.3 761 2/20/2020
2.0.0.3-pre 1,112 2/22/2020
2.0.0.2 753 2/19/2020
2.0.0.1 1,360 2/19/2020
2.0.0 1,017 2/13/2020
1.2.1-alpha.2 451 2/19/2020
1.2.1-alpha.1 460 1/27/2020
1.1.1 1,144 1/21/2020
1.1.1-alpha.1 455 2/19/2020
1.0.0.3 1,332 1/4/2020
1.0.0.2 816 1/4/2020
1.0.0.1 1,307 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.