Stormancer.Server.Plugins.GameSession 6.2.1.9-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 prerelease version of this package available.
See the version list below for details. 
dotnet add package Stormancer.Server.Plugins.GameSession --version 6.2.1.9-pre                

                    
                

            
NuGet\Install-Package Stormancer.Server.Plugins.GameSession -Version 6.2.1.9-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.9-pre" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Stormancer.Server.Plugins.GameSession --version 6.2.1.9-pre                

                    
                

            
#r "nuget: Stormancer.Server.Plugins.GameSession, 6.2.1.9-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. 
// Install Stormancer.Server.Plugins.GameSession as a Cake Addin
#addin nuget:?package=Stormancer.Server.Plugins.GameSession&version=6.2.1.9-pre&prerelease

// Install Stormancer.Server.Plugins.GameSession as a Cake Tool
#tool nuget:?package=Stormancer.Server.Plugins.GameSession&version=6.2.1.9-pre&prerelease

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. 
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.1.81-pre 8 9/26/2024
6.2.1.80-pre 133 8/28/2024
6.2.1.76-pre 108 8/9/2024
6.2.1.75-pre 113 8/9/2024
6.2.1.74-pre 92 8/9/2024
6.2.1.73-pre 86 8/9/2024
6.2.1.72-pre 89 8/2/2024
6.2.1.71-pre 265 6/10/2024
6.2.1.70-pre 157 4/17/2024
6.2.1.69-pre 103 4/17/2024
6.2.1.65-pre 118 4/16/2024
6.2.1.63-pre 174 4/2/2024
6.2.1.61-pre 161 3/11/2024
6.2.1.59-pre 111 1/17/2024
6.2.1.58-pre 123 1/12/2024
6.2.1.57-pre 222 12/11/2023
6.2.1.56-pre 122 12/7/2023
6.2.1.55-pre 153 12/1/2023
6.2.1.53-pre 179 11/22/2023
6.2.1.52-pre 145 11/20/2023
6.2.1.51-pre 84 11/15/2023
6.2.1.50-pre 108 11/14/2023
6.2.1.49-pre 108 11/14/2023
6.2.1.48-pre 115 11/14/2023
6.2.1.47-pre 108 11/14/2023
6.2.1.46-pre 108 11/13/2023
6.2.1.45-pre 103 11/13/2023
6.2.1.44-pre 91 11/13/2023
6.2.1.43-pre 100 11/12/2023
6.2.1.42-pre 126 11/12/2023
6.2.1.41-pre 106 11/12/2023
6.2.1.40-pre 113 11/12/2023
6.2.1.39-pre 108 11/12/2023
6.2.1.38-pre 97 11/12/2023
6.2.1.37-pre 108 11/12/2023
6.2.1.36-pre 119 11/12/2023
6.2.1.35-pre 127 11/11/2023
6.2.1.33-pre 116 11/8/2023
6.2.1.31-pre 90 11/7/2023
6.2.1.30-pre 112 11/7/2023
6.2.1.28-pre 148 10/27/2023
6.2.1.27-pre 132 10/27/2023
6.2.1.26-pre 119 10/27/2023
6.2.1.25-pre 109 10/27/2023
6.2.1.24-pre 161 10/27/2023
6.2.1.23-pre 121 10/25/2023
6.2.1.22-pre 111 10/23/2023
6.2.1.21-pre 103 10/20/2023
6.2.1.20-pre 103 10/20/2023
6.2.1.19-pre 140 10/20/2023
6.2.1.18-pre 101 10/20/2023
6.2.1.17-pre 105 10/20/2023
6.2.1.15-pre 97 10/19/2023
6.2.1.14-pre 130 10/19/2023
6.2.1.13-pre 146 10/13/2023
6.2.1.12-pre 102 10/13/2023
6.2.1.10-pre 129 10/12/2023
6.2.1.9-pre 114 10/12/2023
6.2.1.7-pre 115 10/11/2023
6.2.1.6-pre 97 10/11/2023
6.2.1.4-pre 119 10/11/2023
6.2.1.3-pre 109 10/11/2023
6.2.1.2-pre 142 10/10/2023
6.2.1.1-pre 114 10/5/2023
6.2.1-pre 181 10/4/2023
6.2.0.14-pre 119 10/2/2023
6.2.0.13-pre 111 9/29/2023
6.2.0.12-pre 112 9/28/2023
6.2.0.11-pre 209 9/12/2023
6.2.0.10-pre 132 9/8/2023
6.2.0.9-pre 124 9/7/2023
6.2.0.8-pre 122 9/1/2023
6.2.0.7-pre 75 8/31/2023
6.2.0.6-pre 124 8/29/2023
6.2.0.5-pre 219 8/18/2023
6.2.0.4-pre 171 8/18/2023
6.2.0.3-pre 145 8/17/2023
6.2.0.2-pre 128 8/17/2023
6.2.0-pre 144 8/9/2023
6.1.2.35-pre 128 8/4/2023
6.1.2.34-pre 162 8/3/2023
6.1.2.33-pre 198 8/1/2023
6.1.2.32-pre 139 8/1/2023
6.1.2.31-pre 255 6/29/2023
6.1.2.30-pre 167 6/29/2023
6.1.2.29-pre 347 6/15/2023
6.1.2.28-pre 131 6/15/2023
6.1.2.27-pre 130 6/15/2023
6.1.2.26-pre 122 6/15/2023
6.1.2.25-pre 134 6/15/2023
6.1.2.24-pre 145 6/15/2023
6.1.2.23-pre 141 6/15/2023
6.1.2.22-pre 130 6/15/2023
6.1.2.21-pre 124 6/15/2023
6.1.2.20-pre 119 6/15/2023
6.1.2.19-pre 125 6/15/2023
6.1.2.18-pre 186 6/6/2023
6.1.2.17-pre 147 6/6/2023
6.1.2.15-pre 187 5/30/2023
6.1.2.14-pre 236 5/24/2023
6.1.2.13-pre 198 5/18/2023
6.1.2.12-pre 115 5/18/2023
6.1.2.11-pre 118 5/18/2023
6.1.2.10-pre 159 5/17/2023
6.1.2.8-pre 134 5/15/2023
6.1.2.7-pre 146 5/12/2023
6.1.2.6-pre 132 5/11/2023
6.1.2.5-pre 123 5/11/2023
6.1.2.4-pre 145 5/11/2023
6.1.2.3-pre 124 5/11/2023
6.1.2.2-pre 128 5/11/2023
6.1.2.1-pre 226 5/9/2023
6.1.2-pre 127 5/9/2023
6.1.1.15 322 5/9/2023
6.1.1.15-pre 124 5/5/2023
6.1.1.14-pre 102 5/5/2023
6.1.1.13-pre 114 4/30/2023
6.1.1.12-pre 153 4/30/2023
6.1.1.11-pre 118 4/27/2023
6.1.1.10-pre 151 4/24/2023
6.1.1.9-pre 156 4/21/2023
6.1.1.8-pre 123 4/21/2023
6.1.1.7-pre 163 4/21/2023
6.1.1.6-pre 136 4/21/2023
6.1.1.3-pre 157 4/13/2023
6.1.1.2-pre 124 4/13/2023
6.1.1.1-pre 139 4/13/2023
6.1.0.20-pre 168 4/11/2023
6.1.0.19-pre 131 4/7/2023
6.1.0.18-pre 138 4/6/2023
6.1.0.17 442 4/4/2023
6.1.0.17-pre 157 3/31/2023
6.1.0.16-pre 125 3/31/2023
6.1.0.15-pre 131 3/30/2023
6.1.0.13-pre 130 3/30/2023
6.1.0.12-pre 140 3/29/2023
6.1.0.11-pre 135 3/29/2023
6.1.0.10-pre 146 3/29/2023
6.1.0.9-pre 144 3/29/2023
6.1.0.8-pre 149 3/29/2023
6.1.0.7-pre 143 3/29/2023
6.1.0.6-pre 123 3/29/2023
6.1.0.5-pre 128 3/28/2023
6.1.0.4-pre 134 3/28/2023
6.1.0.3-pre 143 3/21/2023
6.1.0.2-pre 157 3/21/2023
6.1.0.1-pre 167 3/19/2023
6.1.0-pre 142 3/19/2023
6.0.3.6-pre 332 12/8/2022
6.0.3.5-pre 137 12/8/2022
6.0.3.4-pre 114 12/7/2022
6.0.3.3-pre 120 12/7/2022
6.0.3.2-pre 158 12/7/2022
6.0.3.1-pre 139 12/7/2022
6.0.3-pre 128 12/6/2022
6.0.2 414 10/28/2022
6.0.1.1 918 10/26/2022
6.0.1.1-pre 156 10/26/2022
6.0.0.3-pre 151 10/3/2022
6.0.0.2 1,406 9/28/2022
6.0.0.2-pre 337 9/12/2022
5.5.0.11-pre 366 8/2/2022
5.5.0.10-pre 166 7/27/2022
5.5.0.9-pre 370 7/1/2022
5.5.0.8-pre 240 6/9/2022
5.5.0.3-pre 159 5/24/2022
5.4.0.60-pre 429 4/12/2022
5.4.0.59-pre 201 4/12/2022
5.4.0.58-pre 215 3/31/2022
5.4.0.57-pre 177 3/31/2022
5.4.0.56-pre 171 3/24/2022
5.4.0.55-pre 181 3/23/2022
5.4.0.53-pre 184 3/22/2022
5.4.0.51-pre 290 3/15/2022
5.4.0.26-pre 173 3/14/2022
5.4.0.25-pre 180 3/14/2022
5.4.0.23-pre 191 3/8/2022
5.4.0.22-pre 175 3/1/2022
5.4.0.7-pre 268 2/28/2022
5.3.0.104-pre 173 3/17/2022
5.3.0.103-pre 176 3/17/2022
5.3.0 2,684 1/21/2022
5.3.0-pre 414 1/14/2022
5.2.0 1,415 12/15/2021
5.2.0-pre 317 10/26/2021
5.1.0.1 827 10/14/2021
5.0.1.2 1,244 5/23/2021
5.0.1.2-pre 652 5/12/2021
5.0.1-pre 298 5/3/2021
4.0.7 1,033 4/29/2021
4.0.6 461 4/19/2021
4.0.5 509 3/22/2021
4.0.4.1 750 3/20/2021
4.0.4 1,152 3/1/2021
4.0.3.2 482 12/18/2020
4.0.3.2-pre 367 12/17/2020
4.0.3.1-pre 313 12/17/2020
4.0.3-pre 336 12/17/2020
4.0.1.1 863 12/9/2020
4.0.0.1 1,143 12/4/2020
3.3.4 494 12/9/2020
3.3.3.2 503 12/8/2020
3.3.3.2-pre 337 12/8/2020
3.3.2.2 1,141 10/20/2020
3.3.2.2-pre 464 10/13/2020
3.3.2.1-pre 378 9/29/2020
3.3.2-pre 857 8/11/2020
3.3.1.1-pre 402 8/11/2020
3.3.1-pre 326 8/11/2020
3.3.0-pre 377 7/1/2020
3.2.3-pre 347 6/30/2020
3.2.2-pre 350 6/23/2020
3.2.1-pre 399 6/22/2020
3.2.0-pre 472 6/16/2020
3.1.3-pre 393 6/15/2020
3.1.2-pre 407 6/9/2020
3.0.2 542 6/15/2020
3.0.2-pre 432 6/5/2020
3.0.1 1,348 5/27/2020
3.0.1-pre 709 3/30/2020
3.0.0-pre 955 3/29/2020
2.0.0.3 594 2/20/2020
2.0.0.3-pre 803 2/22/2020
2.0.0.2 592 2/19/2020
2.0.0.1 1,137 2/19/2020
2.0.0 821 2/13/2020
1.2.1-alpha.2 317 2/19/2020
1.2.1-alpha.1 325 1/27/2020
1.1.1 950 1/21/2020
1.1.1-alpha.1 326 2/19/2020
1.0.0.3 1,124 1/4/2020
1.0.0.2 652 1/4/2020
1.0.0.1 1,104 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.

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.