AWS gamelift documentation change
Summary
Updated instructions for preparing game server builds with Amazon GameLift Servers SDK, including OpenSSL library requirements and version-specific guidance. Added details about file placement, Visual Studio redistributable, and structured steps for Windows/Linux environments.
Security assessment
The changes emphasize the importance of using correct OpenSSL versions to ensure secure communication with GameLift Servers. While incorrect OpenSSL usage could lead to connectivity/security issues, the documentation update is preventive guidance rather than addressing a disclosed vulnerability. No explicit security incident or CVE is mentioned.
Diff
diff --git a/gamelift/latest/developerguide/unreal-plugin-ec2.md b/gamelift/latest/developerguide/unreal-plugin-ec2.md index 509f98dd5..f06c11879 100644 --- a//gamelift/latest/developerguide/unreal-plugin-ec2.md +++ b//gamelift/latest/developerguide/unreal-plugin-ec2.md @@ -33 +33 @@ Choose the profile you want to use when following this workflow. The profile you -In this step, you make some updates to your client and server game code. Your hosted game server must be able to communicate with the Amazon GameLift Servers service to accept new game session requests and report status. You game client (through a backend service) must be able to request new game sessions and connect to them. +In this step, prepare your game server and game client builds to work with Amazon GameLift Servers C++ server SDK for Unreal. If you haven't yet integrated your game code and built game client and server executables, see [Plugin for Unreal: Integrate your game code](./unreal-plugin-integrate.html). Enter the paths to your game executables on your local workstation. @@ -35,7 +35 @@ In this step, you make some updates to your client and server game code. Your ho -If you haven't already set up a source-built version of the Unreal Editor, the plugin provides links to instructions and source code. - -If you integrated your game for use with an Anywhere fleet, you don't need to make any changes to your game code. You can also use the startup game map with EC2 deployments. - - * [Set up your game code (Anywhere)](./unreal-plugin-anywhere.html#unreal-plugin-anywhere-integrate) - - * [Package your game components](./unreal-plugin-integrate.html#unreal-plugin-anywhere-integrate-build) +This step in the workflow the plugin provides links to instructions and source code for setting up a source-built version of the Unreal Editor. You need to use the source-built version when building your client and server components. @@ -42,0 +37 @@ If you integrated your game for use with an Anywhere fleet, you don't need to ma +After building game server that's integrated with the server SDK, complete the following tasks to prepare it for uploading to Amazon GameLift Servers for hosting. @@ -43,0 +39 @@ If you integrated your game for use with an Anywhere fleet, you don't need to ma +In the `WindowsServer` folder, where the Unreal editor stores your server build files by default, make the following additions: @@ -44,0 +41 @@ If you integrated your game for use with an Anywhere fleet, you don't need to ma + 1. **Copy the server build install script into the root of the`WindowsServer` folder.** The install script is included in the plugin download. Look for the file `[project-name]/Plugins/Resources/CloudFormation/extra_server_resources/install.bat`. Amazon GameLift Servers uses this file to install the server build onto your hosting computes. @@ -46 +43 @@ If you integrated your game for use with an Anywhere fleet, you don't need to ma -After building your game server, complete the following tasks to prepare it for uploading to Amazon GameLift Servers for hosting. + 2. **Copy the`VC_redist.x64.exe` file into the root of the `WindowsServer` folder.** This file is included in your Visual Studio installation. It is commonly located at `C:/Program Files (x86)/Microsoft Visual Studio/2019/Professional/VC/Redist/MSVC/v142`. @@ -48 +45 @@ After building your game server, complete the following tasks to prepare it for -In the `WindowsServer` folder, where the Unreal editor packages your server build files by default, make the following additions: + 3. **Add the OpenSSL library files to your game server build.** @@ -50 +47 @@ In the `WindowsServer` folder, where the Unreal editor packages your server buil - 1. **Copy the server build install script into the root of the`WindowsServer` folder.** The install script is included in the plugin download. Look for the file `[project-name]/Plugins/Resources/CloudFormation/extra_server_resources/install.bat`. Amazon GameLift Servers uses this file to install the server build onto your hosting computes. +###### Note @@ -52 +49 @@ In the `WindowsServer` folder, where the Unreal editor packages your server buil - 2. **Copy the`VC_redist.x64.exe` file into the root of the `WindowsServer` folder.** This file is included in your Visual Studio installation. It is commonly located at `C:/Program Files (x86)/Microsoft Visual Studio/2019/Professional/VC/Redist/MSVC/v142`. +If your game server is integrated with server SDK version 5.3.x or later, you can skip this step. @@ -54 +51 @@ In the `WindowsServer` folder, where the Unreal editor packages your server buil - 3. **Add the OpenSSL library files to your game server build.** You **must** use the same OpenSSL version that your Unreal Engine 5 version uses. This is a critical step. If you include the wrong version, you might be able to deploy this build, but your game servers won't be able to report ready and host game sessions. +For game servers that are integrated with server SDK version 5.2 or earlier, you need to manually locate and copy the libraries. You **must** use the same OpenSSL version that your Unreal Engine 5 version uses. Game builds that are deployed with the wrong OpenSSL libraries won't be able to communicate with the Amazon GameLift Servers service. @@ -56 +53 @@ In the `WindowsServer` folder, where the Unreal editor packages your server buil - * Look for the OpenSSL libraries in your game engine source. The location varies depending on your development environment: + 1. Look for the OpenSSL libraries in your game engine source. The location varies depending on your development environment: @@ -70 +67 @@ On Linux: -When you locate the OpenSSL libraries, copy them to your game build package directory at `<YourGame>/Binaries/Win64`. + 2. Copy the OpenSSL libraries to your game build package directory at `<YourGame>/Binaries/Win64`. @@ -81 +78,7 @@ For more detailed instructions on preparing a game server built for Linux, see [ - 3. **Add the OpenSSL library files to your game server build.** You **must** use the same OpenSSL version that your Unreal Engine 5 version uses. This is a critical step. If you include the wrong version, you might be able to deploy this build, but your game servers won't be able to report ready and host game sessions. + 3. **Add the OpenSSL library files to your game server build.** + +###### Note + +If your game server is integrated with server SDK version 5.3.x or later, you can skip this step. + +For game servers that are integrated with server SDK version 5.2 or earlier, you need to manually locate and copy the libraries. You **must** use the same OpenSSL version that your Unreal Engine 5 version uses. Game builds that are deployed with the wrong OpenSSL libraries won't be able to communicate with the Amazon GameLift Servers service. @@ -83 +86 @@ For more detailed instructions on preparing a game server built for Linux, see [ - * Look for the OpenSSL libraries in your game engine source. The location varies depending on your development environment: + 1. Look for the OpenSSL libraries in your game engine source. The location varies depending on your development environment: @@ -97 +100 @@ On Linux: -When you locate the OpenSSL libraries, copy them to your game build package directory at `<YourGame>/Binaries/Linux`. + 2. When you locate the OpenSSL libraries, copy them to your game build package directory at `<YourGame>/Binaries/Linux`.