AWS gamelift documentation change
Summary
Updated documentation structure, simplified installation instructions (removed UnityNuGet setup steps), added Next Steps section, and changed resource references to GitHub
Security assessment
Changes focus on workflow simplification and documentation reorganization. The removed UnityNuGet configuration steps (including disabling Assembly Version Validation) could theoretically impact security, but the diff shows this was part of deprecated instructions rather than addressing an active vulnerability. No explicit security advisories or vulnerability mitigations are added.
Diff
diff --git a/gamelift/latest/developerguide/integration-engines-unity-using.md b/gamelift/latest/developerguide/integration-engines-unity-using.md index f0fd45ac1..143ed58f1 100644 --- a//gamelift/latest/developerguide/integration-engines-unity-using.md +++ b//gamelift/latest/developerguide/integration-engines-unity-using.md @@ -5 +5 @@ -PrerequisitesInstall the pluginSet up an Anywhere fleet for testingAdd server code to your projectAdditional resources +Install the server SDKSet up an Anywhere fleet for testingAdd server code to your projectNext steps @@ -9 +9 @@ PrerequisitesInstall the pluginSet up an Anywhere fleet for testingAdd server co -This topic explains how to set up the Amazon GameLift Servers **C# Server SDK plugin for Unity** and integrate it into your game projects. +Learn how to integrate the Amazon GameLift Servers SDK for Unity into your game projects to access the full server SDK feature set. @@ -11 +11 @@ This topic explains how to set up the Amazon GameLift Servers **C# Server SDK pl -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) +###### Tip @@ -13 +13 @@ Get a jump start on deploying your game server to Amazon GameLift Servers for ho -Additional resources: +For faster deployment, try the Amazon GameLift Servers standalone plugin for Unity. It provides guided UI workflows to quickly deploy your game server with minimal setup, so you can try out your game components in action. See [Amazon GameLift Servers plugin for Unity (server SDK 5.x)](./unity-plug-in.html). @@ -15 +15 @@ Additional resources: - * [Server SDK for Amazon GameLift Servers download site](https://aws.amazon.com/gamelift/servers/getting-started/) +Additional resources: @@ -24,50 +24 @@ Additional resources: -## Prerequisites - -To use the Amazon GameLift Servers C# server SDK plugin for Unity, you need the following components: - - * 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. - - * 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. - - * The third party scoped registry UnityNuGet. This tool manages third-party DLLs. For more information, see the [UnityNuGet](https://github.com/xoofx/UnityNuGet) Github repository. - - - - -### Set up UnityNuGet - -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`. - -###### To integrate UnityNuGet into your game project - - 1. With your project open in the Unity Editor, go to the main menu and select **Edit** , **Project Settings**. From the options, choose the **Package Manager** section and open the **Scoped Registries** group. - - 2. Choose the **+** button and enter the following values for the UnityNuGet scoped registry: - - Name: Unity NuGet - URL: https://unitynuget-registry.openupm.com - Scope(s): org.nuget - - 3. For Unity 2021 version users: - -After setting up UnityNuGet, check for `Assembly Version Validation` errors showing in the Unity console. These errors occur if binding redirects for strongly named assemblies in the NuGet packages are not resolving correctly to paths within your Unity project. To resolve this issue, configure Unity's assembly version validation: - - 1. In the Unity Editor, go to the main menu and select **Edit** , **Project Settings** , and open the **Player** section. - - 2. Deselect the **Assembly Version Validation** option. - - - - -## Install the plugin - -Use the following procedure to install the Amazon GameLift Servers C# server SDK plugin for Unity and configure log4net logging. - -###### To install the plugin - - 1. With your project open in the Unity Editor, go to the main menu and select **Window** , **Package Manager**. - - 2. Choose the **+** button to add a new package. Choose the option **Add package from tarball**. - - 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. - +## Install the server SDK for Unity @@ -75,22 +26 @@ Use the following procedure to install the Amazon GameLift Servers C# server SDK - - -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: - -###### To configure log4net for file output - - 1. With your project open in the Unity Editor, go to the main menu and select **Window** , **Package Manager**. - - 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. - - 3. In the package details, select the Samples group option and press **Import**. - - 4. The `log4net.config` file and accompanying `LoggingConfiguration.cs` script automatically executes the configuration, which is now set up in the project's `Assets/Samples` folder. - -###### Note - -If you need to move your `log4net.config` file to a different folder in the project, then you must also update the config file's filepath in the script `LoggingConfiguration.cs` with the new path. For more information, see the [log4net manual on configuring log4net](https://logging.apache.org/log4net/release/manual/configuration.html). - - - - -For more detailed instructions and testing guidance, see the `README` located in the plugin download. +Get the open-source Amazon GameLift Servers for Unity from [GitHub](https://github.com/amazon-gamelift/amazon-gamelift-plugin-unity). The repository's readme files contain prerequisites and installation instructions. @@ -130,11 +60 @@ The provided code example illustrates the basic required integration elements. I -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). - -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: - -For more information on adding Amazon GameLift Servers functionality, see these topics: - - * [Add Amazon GameLift Servers to your game server](./gamelift-sdk-server-api.html) - - * [C# server SDK 5.x for Amazon GameLift Servers -- Actions](./integration-server-sdk5-csharp-actions.html) - - +The sample code provided establishes communication with 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 used in this code, read [C# server SDK 5.x for Amazon GameLift Servers -- Actions](./integration-server-sdk5-csharp-actions.html). @@ -141,0 +62 @@ For more information on adding Amazon GameLift Servers functionality, see these +The sample code shows how to add the required functionality, as described in [Add Amazon GameLift Servers to your game server](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html). For more information on server SDK actions, see the [C# server SDK 5.x for Amazon GameLift Servers -- Actions](./integration-server-sdk5-csharp-actions.html). @@ -266 +187,3 @@ For more information on adding Amazon GameLift Servers functionality, see these -## Additional resources +## Next steps + +Now that you've prepared a game server build with the minimum required functionality for hosting with Amazon GameLift Servers, consider these potential next steps: @@ -268 +191,13 @@ For more information on adding Amazon GameLift Servers functionality, see these -Use the following resources to test your game server and expand the functionality: + * Deploy your integrated game server for and testing and development. With an Anywhere fleet, you can set up your local machine as a hosting resource and use it to test your game server and game client connections. For cloud-based hosting, deploy your game server to a managed EC2 or managed container fleet. See these topics for guidance: + + * [Set up for iterative development with Amazon GameLift Servers Anywhere](./integration-dev-iteration.html) + + * [Amazon GameLift Servers Anywhere fleets](./fleets-intro-anywhere.html) + + * [Amazon GameLift Servers managed EC2 fleets](./fleets-intro-managed.html) + + * [Amazon GameLift Servers managed container fleets](./fleets-intro-containers.html) + + * Customize your game server integration by adding optional features. For example, you might want to add player sessions with unique player IDs, set up matchmaking backfill, or manage game server access to your other AWS resources (such as a database or content storage service). See these topics for guidance: + + * [Add Amazon GameLift Servers to your game server](./gamelift-sdk-server-api.html) @@ -270 +205 @@ Use the following resources to test your game server and expand the functionalit - * 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). + * [C++ (Unreal) server SDK 5.x for Amazon GameLift Servers -- Actions](./integration-server-sdk5-unreal-actions.html) @@ -272 +207 @@ Use the following resources to test your game server and expand the functionalit - * 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). + * Customize your game client component to request game sessions, receive connection information, and connect directly to a game server to play a game. See these topics for guidance: @@ -274 +209 @@ Use the following resources to test your game server and expand the functionalit - * 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). + * [Integrate your game client withAmazon GameLift Servers](./gamelift-sdk-client.html)