AWS gamelift documentation change
Summary
Updated documentation to consistently use 'Amazon GameLift Servers' branding, updated URLs, and clarified SDK references. Changed terminology from generic 'Amazon GameLift' to specific 'Amazon GameLift Servers' throughout the guide.
Security assessment
Changes focus on branding consistency and documentation structure updates rather than addressing security vulnerabilities or introducing security features. No evidence of security-related fixes or new security guidance in the diff.
Diff
diff --git a/gamelift/latest/developerguide/integration-engines-setup-unreal.md index 10c221736..b70deb2d6 100644 --- a/gamelift/latest/developerguide/integration-engines-setup-unreal.md +++ b/gamelift/latest/developerguide/integration-engines-setup-unreal.md @@ -3 +3 @@ -[Documentation](/index.html)[Amazon GameLift](/gamelift/index.html)[Developer Guide](gamelift-intro.html) +[Documentation](/index.html)[Amazon GameLift](/gamelift/index.html)[Hosting Guide](gamelift-intro.html) @@ -7 +7 @@ PrerequisitesBuild Unreal Engine from sourceConfigure your project for the serve -# Integrate Amazon GameLift into an Unreal Engine project +# Integrate Amazon GameLift Servers into an Unreal Engine project @@ -9 +9 @@ PrerequisitesBuild Unreal Engine from sourceConfigure your project for the serve -This topic explains how to set up the **Amazon GameLift C++ server SDK for Unreal Engine** and integrate it into your game projects. +This topic explains how to set up the **Amazon GameLift Servers C++ server SDK for Unreal Engine** and integrate it into your game projects. @@ -13 +13 @@ This topic explains how to set up the **Amazon GameLift C++ server SDK for Unrea -Get a jump start on deploying your game server to Amazon GameLift for hosting. With the Amazon GameLift standalone plugin for Unreal Engine, you can integrate your game code, deploy simple but complete hosting solutions, and test your game components in action. See [Amazon GameLift plugin for Unreal Engine](./unreal-plugin.html). +Get a jump start on deploying your game server to Amazon GameLift Servers for hosting. With the Amazon GameLift Servers standalone plugin for Unreal Engine, you can integrate your game code, deploy simple but complete hosting solutions, and test your game components in action. See [Amazon GameLift Servers plugin for Unreal Engine](./unreal-plugin.html). @@ -17 +17 @@ Additional resources: - * [Server SDK for Unreal download site](https://aws.amazon.com/gamelift/getting-started/) + * [Server SDK for Unreal download site](https://aws.amazon.com/gamelift/servers/getting-started/) @@ -19 +19 @@ Additional resources: - * [Amazon GameLift server SDK 5.x for Unreal Engine -- Actions](./integration-server-sdk5-unreal-actions.html) + * [C++ (Unreal) server SDK 5.x for Amazon GameLift Servers -- Actions](./integration-server-sdk5-unreal-actions.html) @@ -21 +21 @@ Additional resources: - * [Get Amazon GameLift development tools](./gamelift-supported.html) + * [Get Amazon GameLift Servers development tools](./gamelift-supported.html) @@ -63 +63 @@ If you haven't already done so, follow the instructions at [Accessing Unreal Eng - 2. Get the Unreal Engine version that's supported by the Amazon GameLift plugin. See [For game servers](./gamelift-supported.html#gamelift-supported-servers) for Unreal version support. + 2. Get the Unreal Engine version that's supported by the Amazon GameLift Servers plugin. See [For game servers](./gamelift-supported.html#gamelift-supported-servers) for Unreal version support. @@ -88 +88 @@ Once the build is complete, you are ready to open the Unreal Development Editor -Follow these steps to get the Amazon GameLift server SDK for Unreal Engine ready for your game server projects. +Follow these steps to get the server SDK for Amazon GameLift Servers for Unreal Engine ready for your game server projects. @@ -102 +102 @@ This action starts your new source-built instance of Unreal Editor. For more inf - * Choose an existing Unreal project that you want to integrate with Amazon GameLift. + * Choose an existing Unreal project that you want to integrate with Amazon GameLift Servers. @@ -104 +104 @@ This action starts your new source-built instance of Unreal Editor. For more inf - * Create a new project. To experiment with the Amazon GameLift server SDK, try using Unreal engine's **Third Person** template. For more information about this template, see [Third Person template](https://docs.unrealengine.com/5.1/en-US/third-person-template-in-unreal-engine/) on the Unreal Engine documentation website. + * Create a new project. To experiment with the server SDK for Amazon GameLift Servers, try using Unreal engine's **Third Person** template. For more information about this template, see [Third Person template](https://docs.unrealengine.com/5.1/en-US/third-person-template-in-unreal-engine/) on the Unreal Engine documentation website. @@ -144 +144 @@ For example: `GameLiftUnrealApp.Target.cs`. -Your project is now configured to use the Amazon GameLift server SDK. +Your project is now configured to use the server SDK for Amazon GameLift Servers. @@ -150 +150 @@ The next task is to build the C++ server SDK libraries for Unreal so that you ca - 1. Download the [Amazon GameLift C++ server SDK for Unreal](https://aws.amazon.com/gamelift/getting-started/). + 1. Download the [Amazon GameLift Servers C++ server SDK for Unreal](https://aws.amazon.com/gamelift/servers/getting-started/). @@ -164 +164 @@ For more information, read the OpenSSL [Notes for Windows platforms](https://git -The version of OpenSSL that you use to build the Amazon GameLift server SDK should match the version of OpenSSL used by Unreal to package your game server. You can find version information in the Unreal installation directory `...Engine\Source\ThirdParty\OpenSSL`. +The version of OpenSSL that you use to build the server SDK for Amazon GameLift Servers should match the version of OpenSSL used by Unreal to package your game server. You can find version information in the Unreal installation directory `...Engine\Source\ThirdParty\OpenSSL`. @@ -173 +173 @@ Linux -For a quick and easy automated build for Amazon Linux compatible binaries and OpenSSL and OpenCrypto dependencies, see the [ Building the Amazon GameLift Server SDK for Unreal Engine 5 on Amazon Linux](https://github.com/aws/amazon-gamelift-toolkit/tree/main/building-gamelift-server-sdk-for-unreal-engine-and-amazon-linux). +For a quick and easy automated build for Amazon Linux compatible binaries and OpenSSL and OpenCrypto dependencies, see the [ Building the server SDK for Amazon GameLift Servers for Unreal Engine 5 on Amazon Linux](https://github.com/aws/amazon-gamelift-toolkit/tree/main/building-gamelift-server-sdk-for-unreal-engine-and-amazon-linux). @@ -223 +223 @@ Cross Compile from Windows to Linux - 1. Follow the steps in [ Building the Amazon GameLift Server SDK for Unreal Engine 5 on Amazon Linux](https://github.com/aws/amazon-gamelift-toolkit/tree/main/building-gamelift-server-sdk-for-unreal-engine-and-amazon-linux) to download a Linux build of the C++ Server SDK `libaws-cpp-sdk-gamelift-server.so`. The download bundle also includes the files `libcrypto.so-.1.1` and `libssl.so.1.1` that will be used in later steps after you package the Unreal Project. + 1. Follow the steps in [ Building the server SDK for Amazon GameLift Servers for Unreal Engine 5 on Amazon Linux](https://github.com/aws/amazon-gamelift-toolkit/tree/main/building-gamelift-server-sdk-for-unreal-engine-and-amazon-linux) to download a Linux build of the C++ Server SDK `libaws-cpp-sdk-gamelift-server.so`. The download bundle also includes the files `libcrypto.so-.1.1` and `libssl.so.1.1` that will be used in later steps after you package the Unreal Project. @@ -225 +225 @@ Cross Compile from Windows to Linux - 2. Copy the file `libaws-cpp-sdk-gamelift-server.so` to the `amazon-gamelift-plugin-unreal/GameLiftPlugin/Source/GameliftServer/ThirdParty/GameLiftServerSDK/Linux/x86_64-unknown-linux-gnu/` folder inside the Amazon GameLift Unreal plugin foleder in your project. + 2. Copy the file `libaws-cpp-sdk-gamelift-server.so` to the `amazon-gamelift-plugin-unreal/GameLiftPlugin/Source/GameliftServer/ThirdParty/GameLiftServerSDK/Linux/x86_64-unknown-linux-gnu/` folder inside the Amazon GameLift Servers Unreal plugin foleder in your project. @@ -232 +232 @@ For more detailed instructions on how to build the C++ SDK, refer to the README. -Use the following procedure to import the Amazon GameLift server SDK into your example project. +Use the following procedure to import the server SDK for Amazon GameLift Servers into your example project. @@ -234 +234 @@ Use the following procedure to import the Amazon GameLift server SDK into your e -###### Import the Amazon GameLift server SDK +###### Import the server SDK for Amazon GameLift Servers @@ -244 +244 @@ This will allow the Unreal project to see the server SDK. - 4. Add the Amazon GameLift server SDK to the game's `.uproject` file. + 4. Add the server SDK for Amazon GameLift Servers to the game's `.uproject` file. @@ -257 +257 @@ In the example, the app is called `GameLiftUnrealApp`, so the file will be `Game - 6. Make sure the game's ModuleRules takes a dependency on the server SDK. Open the `.Build.cs` file and add the Amazon GameLiftServerSDK dependency. This file is found under ``Your-application-name`/Source/`/Your-application-name/``. + 6. Make sure the game's ModuleRules takes a dependency on the server SDK. Open the `.Build.cs` file and add the Amazon GameLift ServersServerSDK dependency. This file is found under ``Your-application-name`/Source/`/Your-application-name/``. @@ -277 +277 @@ For example, the tutorial filepath is `../GameLiftUnrealApp/Source/GameLiftUnrea -The server SDK should now be working for your application. Continue with the next section to integrate Amazon GameLift functionality into your game. +The server SDK should now be working for your application. Continue with the next section to integrate Amazon GameLift Servers functionality into your game. @@ -279 +279 @@ The server SDK should now be working for your application. Continue with the nex -## Add Amazon GameLift server code to your Unreal project +## Add Amazon GameLift Servers server code to your Unreal project @@ -281 +281 @@ The server SDK should now be working for your application. Continue with the nex -You've configured and set up your Unreal Engine environment, and you can now integrate a game server with Amazon GameLift. The code presented in this topic makes required calls to the Amazon GameLift service. It also implements a set of callback functions that respond to requests from the Amazon GameLift service. For more information on each function and what the code does, see [Initialize the server process](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-initialize). For more information on the SDK actions and datatypes uised in this code, see [Amazon GameLift server SDK 5.x for Unreal Engine -- Actions](./integration-server-sdk5-unreal-actions.html). +You've configured and set up your Unreal Engine environment, and you can now integrate a game server with Amazon GameLift Servers. The code presented in this topic makes required calls to the Amazon GameLift Servers service. It also implements a set of callback functions that respond to requests from the Amazon GameLift Servers service. For more information on each function and what the code does, see [Initialize the server process](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-initialize). For more information on the SDK actions and data types uised in this code, see [C++ (Unreal) server SDK 5.x for Amazon GameLift Servers -- Actions](./integration-server-sdk5-unreal-actions.html). @@ -283 +283 @@ You've configured and set up your Unreal Engine environment, and you can now int -To initialize a game server with Amazon GameLift, use the following procedure. +To initialize a game server with Amazon GameLift Servers, use the following procedure. @@ -287 +287 @@ To initialize a game server with Amazon GameLift, use the following procedure. -The Amazon GameLift-specific code provided in the following section depends on the use of a `WITH_GAMELIFT` preprocessor flag. This flag is true only when both of these conditions are met: +The Amazon GameLift Servers-specific code provided in the following section depends on the use of a `WITH_GAMELIFT` preprocessor flag. This flag is true only when both of these conditions are met: @@ -291 +291 @@ The Amazon GameLift-specific code provided in the following section depends on t - * The game project recognizese the Amazon GameLift server SDK binaries. + * The game project recognizese the server SDK for Amazon GameLift Servers binaries. @@ -296 +296 @@ The Amazon GameLift-specific code provided in the following section depends on t -This ensures that only Unreal server builds invoke Amazon GameLift's backend API. It also lets you to write code that will execute properly for all the different Unreal targets your game might produce. +This ensures that only Unreal server builds invoke Amazon GameLift Servers's backend API. It also lets you to write code that will execute properly for all the different Unreal targets your game might produce. @@ -298 +298 @@ This ensures that only Unreal server builds invoke Amazon GameLift's backend API -###### Integrate a game server with Amazon GameLift +###### Integrate a game server with Amazon GameLift Servers @@ -335 +335 @@ This ensures that only Unreal server builds invoke Amazon GameLift's backend API -This sample shows how to add all of the required elements for integration with Amazon GameLift, as described in [Add Amazon GameLift to your game server](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html). This includes: +This sample shows how to add all of the required elements for integration with Amazon GameLift Servers, as described in [Add Amazon GameLift Servers to your game server](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html). This includes: @@ -337 +337 @@ This sample shows how to add all of the required elements for integration with A - * Initializing an Amazon GameLift API client. + * Initializing an Amazon GameLift Servers API client. @@ -339 +339 @@ This sample shows how to add all of the required elements for integration with A - * Implementing callback functions to respond to requests from the Amazon GameLift service, including `OnStartGameSession`, `OnProcessTerminate`, and `onHealthCheck`. + * Implementing callback functions to respond to requests from the Amazon GameLift Servers service, including `OnStartGameSession`, `OnProcessTerminate`, and `onHealthCheck`. @@ -341 +341 @@ This sample shows how to add all of the required elements for integration with A - * Calling ProcessReady() with a designated port to notify the Amazon GameLiftservice when ready to host game sessions. + * Calling ProcessReady() with a designated port to notify the Amazon GameLift Serversservice when ready to host game sessions. @@ -374 +374 @@ This sample shows how to add all of the required elements for integration with A - //Define the server parameters for a GameLift Anywhere fleet. These are not needed for a GameLift managed EC2 fleet. + //Define the server parameters for an Amazon GameLift Servers Anywhere fleet. These are not needed for an Amazon GameLift Servers managed EC2 fleet. @@ -402 +402 @@ This sample shows how to add all of the required elements for integration with A - //The Host/compute-name of the GameLift Anywhere instance. + //The Host/compute-name of the Amazon GameLift Servers Anywhere instance. @@ -438,3 +438,3 @@ This sample shows how to add all of the required elements for integration with A - //InitSDK establishes a local connection with GameLift's agent to enable further communication. - //Use InitSDK(serverParameters) for a GameLift Anywhere fleet. - //Use InitSDK() for a GameLift managed EC2 fleet. + //InitSDK establishes a local connection with the Amazon GameLift Servers Agent to enable further communication. + //Use InitSDK(serverParameters) for an Amazon GameLift Servers Anywhere fleet. + //Use InitSDK() for Amazon GameLift Servers managed EC2 fleet. @@ -444 +444 @@ This sample shows how to add all of the required elements for integration with A - //GameLift sends a game session activation request to the game server + //Amazon GameLift Servers sends a game session activation request to the game server @@ -459 +459 @@ This sample shows how to add all of the required elements for integration with A - //GameLift invokes this callback before shutting down the instance hosting this game server. + //Amazon GameLift Servers invokes this callback before shutting down the instance hosting this game server. @@ -462 +462 @@ This sample shows how to add all of the required elements for integration with A - //server SDK call ProcessEnding() to tell GameLift it is shutting down. + //server SDK call ProcessEnding() to tell Amazon GameLift Servers it is shutting down. @@ -472 +472 @@ This sample shows how to add all of the required elements for integration with A - //GameLift invokes this callback approximately every 60 seconds. + //Amazon GameLift Servers invokes this callback approximately every 60 seconds. @@ -475 +475 @@ This sample shows how to add all of the required elements for integration with A - //The game server must respond within 60 seconds, or GameLift records 'false'. + //The game server must respond within 60 seconds, or Amazon GameLift Servers records 'false'. @@ -489,2 +489,2 @@ This sample shows how to add all of the required elements for integration with A - //Here, the game server tells GameLift where to find game session log files. - //At the end of a game session, GameLift uploads everything in the specified + //Here, the game server tells Amazon GameLift Servers where to find game session log files. + //At the end of a game session, Amazon GameLift Servers uploads everything in the specified @@ -496 +496 @@ This sample shows how to add all of the required elements for integration with A - //The game server calls ProcessReady() to tell GameLift it's ready to host game sessions. + //The game server calls ProcessReady() to tell Amazon GameLift Servers it's ready to host game sessions. @@ -515 +515 @@ You don't need to rebuild the solution. Instead, build just the project under th -When creating an Amazon GameLift fleet with your server build, we recommend that you pass in the actual server executable as the runtime configuration launch path. For example, in your game build folder, you might have a `GameLiftFPS.exe` file at the root and another at `\GameLiftFPS\Binaries\Win64\GameLiftFPSServer.exe`. When creating a fleet, we recommend you use `C:\GameLiftFPS\Binaries\Win64\GameLiftFPSServer.exe` as the launch path of the runtime configuration. +When creating an Amazon GameLift Servers fleet with your server build, we recommend that you pass in the actual server executable as the runtime configuration launch path. For example, in your game build folder, you might have a `GameLiftFPS.exe` file at the root and another at `\GameLiftFPS\Binaries\Win64\GameLiftFPSServer.exe`. When creating a fleet, we recommend you use `C:\GameLiftFPS\Binaries\Win64\GameLiftFPSServer.exe` as the launch path of the runtime configuration. @@ -517 +517 @@ When creating an Amazon GameLift fleet with your server build, we recommend that - 10. Make sure to open the necessary UDP ports on the Amazon GameLift fleet, so that the game server can communicate with game clients. By default, Unreal Engine uses port `7777`. For more information, see [UpdateFleetPortSettings](https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetPortSettings.html) in the Amazon GameLift service API reference guide. + 10. Make sure to open the necessary UDP ports on the Amazon GameLift Servers fleet, so that the game server can communicate with game clients. By default, Unreal Engine uses port `7777`. For more information, see [UpdateFleetPortSettings](https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetPortSettings.html) in the service API reference guide for Amazon GameLift Servers. @@ -519 +519 @@ When creating an Amazon GameLift fleet with your server build, we recommend that - 11. On Windows: Create an ``install.bat`` file for your game build. This install script runs whenever the game build is deployed to a Amazon GameLift fleet. Here's an example `install.bat` file: + 11. On Windows: Create an ``install.bat`` file for your game build. This install script runs whenever the game build is deployed to a Amazon GameLift Servers fleet. Here's an example `install.bat` file: @@ -533 +533 @@ The file path to the `<>PrereqSetup_x64.exe` file is `Engine\Extras\Redist\en-us - 12. Now you can package and upload your game build to Amazon GameLift. + 12. Now you can package and upload your game build to Amazon GameLift Servers. @@ -552 +552 @@ Package your dependencies along with your game server executable in the root of -You've configured and set up your Unreal Engine environment, and you can now start integrating Amazon GameLift into your game. +You've configured and set up your Unreal Engine environment, and you can now start integrating Amazon GameLift Servers into your game. @@ -554 +554 @@ You've configured and set up your Unreal Engine environment, and you can now sta -For more information about adding Amazon GameLift to your game, see the following: +For more information about adding Amazon GameLift Servers to your game, see the following: @@ -556 +556 @@ For more information about adding Amazon GameLift to your game, see the followin - * [Add Amazon GameLift to your game server](./gamelift-sdk-server-api.html) + * [Add Amazon GameLift Servers to your game server](./gamelift-sdk-server-api.html) @@ -558 +558 @@ For more information about adding Amazon GameLift to your game, see the followin - * [Amazon GameLift server SDK 5.x for Unreal Engine -- Actions](./integration-server-sdk5-unreal-actions.html) + * [C++ (Unreal) server SDK 5.x for Amazon GameLift Servers -- Actions](./integration-server-sdk5-unreal-actions.html) @@ -563 +563 @@ For more information about adding Amazon GameLift to your game, see the followin -For instructions about testing your game, see [Set up local testing with Amazon GameLift Anywhere](./integration-testing.html) . +For instructions about testing your game, see [Set up local testing with Amazon GameLift Servers Anywhere](./integration-testing.html) . @@ -571 +571 @@ To use the Amazon Web Services Documentation, Javascript must be enabled. Please -O3DE: Add Amazon GameLift to your game +O3DE: Add Amazon GameLift Servers to your game