AWS gamelift documentation change
Summary
Updated documentation to consistently use 'Amazon GameLift Servers' branding instead of 'Amazon GameLift', including service references, SDK names, URLs, and code comments. Adjusted section headers and procedural text to reflect product naming specificity.
Security assessment
Changes are purely branding/naming updates from 'Amazon GameLift' to 'Amazon GameLift Servers' without introducing new security features or addressing vulnerabilities. Existing security-related content (e.g., authentication tokens) remains unchanged except for service name alignment.
Diff
diff --git a/gamelift/latest/developerguide/integration-engines-unity-using.md index 0d99de6f8..0347b8795 100644 --- a/gamelift/latest/developerguide/integration-engines-unity-using.md +++ b/gamelift/latest/developerguide/integration-engines-unity-using.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 @@ PrerequisitesInstall the pluginSet up an Anywhere fleet for testingAdd server co -# Integrate Amazon GameLift into a Unity project +# Integrate Amazon GameLift Servers into a Unity project @@ -9 +9 @@ PrerequisitesInstall the pluginSet up an Anywhere fleet for testingAdd server co -This topic explains how to set up the Amazon GameLift **C# Server SDK plugin for Unity** and integrate it into your game projects. +This topic explains how to set up the Amazon GameLift Servers **C# Server SDK plugin for Unity** and integrate it into your game projects. @@ -11 +11 @@ This topic explains how to set up the Amazon GameLift **C# Server SDK plugin for -Get a jump start on deploying your game server to Amazon GameLift for hosting. With the Amazon GameLift standalone plugin for Unity, you can integrate your game code, deploy simple but complete hosting solutions, and test your game components in action. See [Amazon GameLift plugin for Unity (server SDK 5.x)](./unity-plug-in.html) +Get a jump start on deploying your game server to Amazon GameLift Servers for hosting. With the Amazon GameLift Servers standalone plugin for Unity, 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 Unity (server SDK 5.x)](./unity-plug-in.html) @@ -15 +15 @@ Additional resources: - * [Amazon GameLift server SDK download site](https://aws.amazon.com/gamelift/getting-started/) + * [Server SDK for Amazon GameLift Servers download site](https://aws.amazon.com/gamelift/servers/getting-started/) @@ -17 +17 @@ Additional resources: - * [Amazon GameLift server SDK 5.x for C# and Unity -- Actions](./integration-server-sdk5-csharp-actions.html) + * [C# server SDK 5.x for Amazon GameLift Servers -- Actions](./integration-server-sdk5-csharp-actions.html) @@ -19 +19 @@ Additional resources: - * [Get Amazon GameLift development tools](./gamelift-supported.html) + * [Get Amazon GameLift Servers development tools](./gamelift-supported.html) @@ -26 +26 @@ Additional resources: -To use the Amazon GameLift C# server SDK plugin for Unity, you need the following components: +To use the Amazon GameLift Servers C# server SDK plugin for Unity, you need the following components: @@ -28 +28 @@ To use the Amazon GameLift C# server SDK plugin for Unity, you need the followin - * A development environment and Unity Editor version that the plugin supports (see [Get Amazon GameLift development tools](./gamelift-supported.html)). For information on Unity versions, see [System requirements for Unity](https://docs.unity3d.com/2023.1/Documentation/Manual/system-requirements.html) in the Unity documentation. + * A development environment and Unity Editor version that the plugin supports (see [Get Amazon GameLift Servers development tools](./gamelift-supported.html)). For information on Unity versions, see [System requirements for Unity](https://docs.unity3d.com/2023.1/Documentation/Manual/system-requirements.html) in the Unity documentation. @@ -30 +30 @@ To use the Amazon GameLift C# server SDK plugin for Unity, you need the followin - * The Amazon GameLift server SDK plugin for Unity package. This package includes the server SDK 5+ for C#. You can download the latest version from this site: [Getting Started with Amazon GameLift](https://aws.amazon.com/gamelift/getting-started/). Check the readme in each server SDK download package for Unity version support. + * the server SDK for Amazon GameLift Servers plugin for Unity package. This package includes the server SDK 5+ for C#. You can download the latest version from this site: [Getting Started with Amazon GameLift Servers](https://aws.amazon.com/gamelift/servers/getting-started/). Check the readme in each server SDK download package for Unity version support. @@ -39 +39 @@ To use the Amazon GameLift C# server SDK plugin for Unity, you need the followin -If you don't have UnityNuGet set up for your game project, use the following steps to install the tool using the Unity package manager. Alternatively, you can use the NuGet CLI to manually download the DLLs. For more information, see the Amazon GameLift C# server SDK for Unity `README`. +If you don't have UnityNuGet set up for your game project, use the following steps to install the tool using the Unity package manager. Alternatively, you can use the NuGet CLI to manually download the DLLs. For more information, see the Amazon GameLift Servers C# server SDK for Unity `README`. @@ -64 +64 @@ After setting up UnityNuGet, check for `Assembly Version Validation` errors show -Use the following procedure to install the Amazon GameLift C# server SDK plugin for Unity and configure log4net logging. +Use the following procedure to install the Amazon GameLift Servers C# server SDK plugin for Unity and configure log4net logging. @@ -72 +72 @@ Use the following procedure to install the Amazon GameLift C# server SDK plugin - 3. In **Select packages on disk** , locate the Amazon GameLift C# Server SDK plugin for Unity download files, and choose the Amazon GameLift Server SDK `.tgz` file. Choose **Open** to install the plugin. + 3. In **Select packages on disk** , locate the Amazon GameLift Servers C# Server SDK plugin for Unity download files, and choose the server SDK for Amazon GameLift Servers `.tgz` file. Choose **Open** to install the plugin. @@ -77 +77 @@ Use the following procedure to install the Amazon GameLift C# server SDK plugin -The Amazon GameLift server SDK uses the log4net framework to output log messages. It is configured to output messages to the terminal of a server build by default, but Unity requires configuration to add file logging support. You can add this support to your project by importing the provided sample inside the Amazon GameLift Server SDK package. Use the following procedure to add the sample and configure log4net: +the server SDK for Amazon GameLift Servers uses the log4net framework to output log messages. It is configured to output messages to the terminal of a server build by default, but Unity requires configuration to add file logging support. You can add this support to your project by importing the provided sample inside the server SDK for Amazon GameLift Servers package. Use the following procedure to add the sample and configure log4net: @@ -83 +83 @@ The Amazon GameLift server SDK uses the log4net framework to output log messages - 2. From the dropdown menu, select **Packages: In Project** , and then select **Amazon GameLift Server SDK** from the list of packages. This opens the package details. + 2. From the dropdown menu, select **Packages: In Project** , and then select **Amazon GameLift Servers Server SDK** from the list of packages. This opens the package details. @@ -98 +98 @@ For more detailed instructions and testing guidance, see the `README` located in -## Set up an Amazon GameLift Anywhere fleet for testing +## Set up an Amazon GameLift Servers Anywhere fleet for testing @@ -100 +100 @@ For more detailed instructions and testing guidance, see the `README` located in -You can set up your development workstation as an Amazon GameLift Anywhere hosting fleet to iteratively test your Amazon GameLift integration. With this setup, you can start game server processes on your workstation, send player join or matchmaking requests to Amazon GameLift to start game sessions, and connect clients to the new game sessions. With your own workstation set up as a hosting server, you can monitor all aspects of your game integration with Amazon GameLift. +You can set up your development workstation as an Amazon GameLift Servers Anywhere hosting fleet to iteratively test your Amazon GameLift Servers integration. With this setup, you can start game server processes on your workstation, send player join or matchmaking requests to Amazon GameLift Servers to start game sessions, and connect clients to the new game sessions. With your own workstation set up as a hosting server, you can monitor all aspects of your game integration with Amazon GameLift Servers. @@ -102 +102 @@ You can set up your development workstation as an Amazon GameLift Anywhere hosti -For instructions on setting up your workstation, see [Set up local testing with Amazon GameLift Anywhere](./integration-testing.html) to complete the following steps: +For instructions on setting up your workstation, see [Set up local testing with Amazon GameLift Servers Anywhere](./integration-testing.html) to complete the following steps: @@ -106 +106 @@ For instructions on setting up your workstation, see [Set up local testing with - 2. Create an Amazon GameLift Anywhere fleet with your new custom location. If successful, this request returns a fleet ID. Make a note of this value, as you'll need it later. + 2. Create an Amazon GameLift Servers Anywhere fleet with your new custom location. If successful, this request returns a fleet ID. Make a note of this value, as you'll need it later. @@ -110 +110 @@ For instructions on setting up your workstation, see [Set up local testing with - 4. Generate an authentication token for your workstation compute. This short-lived authentication includes the token and an expiration date. Your game server uses it to authenticate communication with the Amazon GameLift service. Store the authentication on your workstation compute so that your running game server processes can access it. + 4. Generate an authentication token for your workstation compute. This short-lived authentication includes the token and an expiration date. Your game server uses it to authenticate communication with the Amazon GameLift Servers service. Store the authentication on your workstation compute so that your running game server processes can access it. @@ -115 +115 @@ For instructions on setting up your workstation, see [Set up local testing with -## Add Amazon GameLift server code to your Unity project +## Add Amazon GameLift Servers server code to your Unity project @@ -117 +117 @@ For instructions on setting up your workstation, see [Set up local testing with -Your game server communicates with the Amazon GameLift service to receive instructions and report ongoing status. To accomplish this, you add game server code that uses the Amazon GameLift server SDK. +Your game server communicates with the Amazon GameLift Servers service to receive instructions and report ongoing status. To accomplish this, you add game server code that uses the Amazon GameLift Servers server SDK. @@ -119 +119 @@ Your game server communicates with the Amazon GameLift service to receive instru -The provided code example illustrates the basic required integration elements. It uses a `MonoBehavior` to illustrate a simple game server initialization with Amazon GameLift. The example assumes that the game server runs on an Amazon GameLift Anywhere fleet for testing. It includes code to: +The provided code example illustrates the basic required integration elements. It uses a `MonoBehavior` to illustrate a simple game server initialization with Amazon GameLift Servers. The example assumes that the game server runs on an Amazon GameLift Servers Anywhere fleet for testing. It includes code to: @@ -121 +121 @@ The provided code example illustrates the basic required integration elements. I - * Initialize an Amazon GameLift API client. The sample uses the version of `InitSDK()` with server parameters for your Anywhere fleet and compute. Use the WebSocket URL, fleet ID, compute name (host ID), and authentication token, as defined in the previous topic Set up an Amazon GameLift Anywhere fleet for testing. + * Initialize an Amazon GameLift Servers API client. The sample uses the version of `InitSDK()` with server parameters for your Anywhere fleet and compute. Use the WebSocket URL, fleet ID, compute name (host ID), and authentication token, as defined in the previous topic Set up an Amazon GameLift Servers Anywhere fleet for testing. @@ -123 +123 @@ The provided code example illustrates the basic required integration elements. I - * Implement callback functions to respond to requests from the Amazon GameLift service, including `OnStartGameSession`, `OnProcessTerminate`, and `onHealthCheck`. + * Implement callback functions to respond to requests from the Amazon GameLift Servers service, including `OnStartGameSession`, `OnProcessTerminate`, and `onHealthCheck`. @@ -125 +125 @@ The provided code example illustrates the basic required integration elements. I - * Call ProcessReady() with a designated port to notify the Amazon GameLift service when the process is ready to host game sessions. + * Call ProcessReady() with a designated port to notify the Amazon GameLift Servers service when the process is ready to host game sessions. @@ -130 +130 @@ The provided code example illustrates the basic required integration elements. I -The code presented in this topic establishes communication with the Amazon GameLift service and . It also implements a set of callback functions that respond to requests from the . 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 used in this code, read [Amazon GameLift server SDK 5.x for C# and Unity -- Actions](./integration-server-sdk5-csharp-actions.html). +The code presented in this topic establishes communication with the Amazon GameLift Servers service and . It also implements a set of callback functions that respond to requests from the . 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 used in this code, read [C# server SDK 5.x for Amazon GameLift Servers -- Actions](./integration-server-sdk5-csharp-actions.html). @@ -132 +132 @@ The code presented in this topic establishes communication with the Amazon GameL -This sample shows how to add all the required elements , as described in [Add Amazon GameLift to your game server](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html). It includes: +This sample shows how to add all the required elements , as described in [Add Amazon GameLift Servers to your game server](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html). It includes: @@ -134 +134 @@ This sample shows how to add all the required elements , as described in [Add Am -For more information on adding Amazon GameLift functionality, see these topics: +For more information on adding Amazon GameLift Servers functionality, see these topics: @@ -136 +136 @@ For more information on adding Amazon GameLift functionality, see these topics: - * [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) @@ -138 +138 @@ For more information on adding Amazon GameLift functionality, see these topics: - * [Amazon GameLift server SDK 5.x for C# and Unity -- Actions](./integration-server-sdk5-csharp-actions.html) + * [C# server SDK 5.x for Amazon GameLift Servers -- Actions](./integration-server-sdk5-csharp-actions.html) @@ -151 +151 @@ For more information on adding Amazon GameLift functionality, see these topics: - //that is running on an Amazon GameLift Anywhere fleet. + //that is running on an Amazon GameLift Servers Anywhere fleet. @@ -172,2 +172,2 @@ For more information on adding Amazon GameLift functionality, see these topics: - //Server parameters are required for a GameLift Anywhere fleet. - //They are not required for a GameLift managed EC2 fleet. + //Server parameters are required for an Amazon GameLift Servers Anywhere fleet. + //They are not required for an Amazon GameLift Servers managed EC2 fleet. @@ -181 +181 @@ For more information on adding Amazon GameLift functionality, see these topics: - //InitSDK establishes a local connection with an Amazon GameLift agent + //InitSDK establishes a local connection with an Amazon GameLift Servers agent @@ -190 +190 @@ For more information on adding Amazon GameLift functionality, see these topics: - //GameLift sends a game session activation request to the game server + //Amazon GameLift Servers sends a game session activation request to the game server @@ -198 +198 @@ For more information on adding Amazon GameLift functionality, see these topics: - //GameLift sends a request when a game session is updated (such as for + //Amazon GameLift Servers sends a request when a game session is updated (such as for @@ -205 +205 @@ For more information on adding Amazon GameLift functionality, see these topics: - //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. @@ -208 +208 @@ For more information on adding Amazon GameLift functionality, see these topics: - //server SDK call ProcessEnding() to tell GameLift it is shutting down. + //server SDK call ProcessEnding() to tell Amazon GameLift Servers it is shutting down. @@ -213 +213 @@ For more information on adding Amazon GameLift functionality, see these topics: - //GameLift invokes this callback approximately every 60 seconds. + //Amazon GameLift Servers invokes this callback approximately every 60 seconds. @@ -216 +216 @@ For more information on adding Amazon GameLift functionality, see these topics: - //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'. @@ -225,2 +225,2 @@ For more information on adding Amazon GameLift functionality, see these topics: - //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 @@ -231 +231 @@ For more information on adding Amazon GameLift functionality, see these topics: - //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. @@ -251 +251 @@ For more information on adding Amazon GameLift functionality, see these topics: - //These actions notify Amazon GameLift that the process is terminating and frees the API client from memory. + //These actions notify Amazon GameLift Servers that the process is terminating and frees the API client from memory. @@ -270 +270 @@ Use the following resources to test your game server and expand the functionalit - * Set up your development machine as an Amazon GameLift Anywhere fleet and use it for local testing. See [Test your custom server integration](https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-testing.html). + * Set up your development machine as an Amazon GameLift Servers Anywhere fleet and use it for local testing. See [Test your custom server integration](https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-testing.html). @@ -272 +272 @@ Use the following resources to test your game server and expand the functionalit - * Build your game server and upload the build to Amazon GameLift. See [Upload a custom server build to Amazon GameLift](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html). + * Build your game server and upload the build to Amazon GameLift Servers. See [Upload a custom server build to Amazon GameLift Servers](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html). @@ -274 +274 @@ Use the following resources to test your game server and expand the functionalit - * Deploy your game server build to an Amazon GameLift managed EC2 fleet. See [Create a new Amazon GameLift fleet](https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating.html). + * Deploy your game server build to an Amazon GameLift Servers managed EC2 fleet. See [Create a new Amazon GameLift Servers fleet](https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating.html).