move Netspeak Unreal SDK into Agones Unreal SDK #1739
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,23 +1,24 @@ | ||
| { | ||
| "CanContainContent": false, | ||
| "Category": "Agones", | ||
| "CreatedBy": "", | ||
| "CreatedByURL": "", | ||
| "Description": "Agones SDK for Unreal, wrapping the Agones REST API.", | ||
| "DocsURL": "https://agones.dev/site/docs/guides/client-sdks/rest/", | ||
| "FileVersion": 3, | ||
| "FriendlyName": "Agones", | ||
| "Installed": false, | ||
| "IsBetaVersion": false, | ||
| "IsExperimentalVersion": false, | ||
| "MarketplaceURL": "", | ||
| "Modules": [ | ||
| { | ||
| "LoadingPhase": "PreLoadingScreen", | ||
| "Name": "Agones", | ||
| "Type": "Runtime" | ||
| } | ||
| ], | ||
| "SupportURL": "https://github.com/googleforgames/agones", | ||
| "Version": 2, | ||
| "VersionName": "2.0.0" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,49 +1,125 @@ | ||
| # Agones Unreal SDK | ||
|
|
||
| Agones is a multilayer dedicated game server scaling and orchestration platform that can run anywhere Kubernetes can run. | ||
|
|
||
| This is a SDK inspired by the REST API to the Agones sidecars that allows engineers to talk to the sidecar from either C++ or Blueprints. | ||
|
|
||
| ## Getting Started | ||
|
|
||
| The Agones Unreal SDK can either be used from C++ or from Blueprints. | ||
|
|
||
| ### Getting the Code | ||
|
|
||
| Easiest way to get this code is to clone the repository and drop the entire plugin folder into your own `Plugins` folder. This runs the plugin as a Project plugin rather than an engine plugin. | ||
|
|
||
| We could however turn this into a marketplace plugin that can be retrived from the marketplace directly into the UE4 editor. | ||
|
|
||
| ### Health Calls | ||
| #### Using C++ | ||
| - Add Plugin (in your own `.uplugin` file) | ||
| ``` | ||
| "Plugins": [ | ||
| { | ||
| "Enabled": true, | ||
| "Name": "Agones" | ||
| } | ||
| ], | ||
| ``` | ||
| - Add Plugin (in your own `*.Build.cs`) | ||
| ``` | ||
| PublicDependencyModuleNames.AddRange( | ||
| new[] | ||
| { | ||
| "Agones", | ||
| }); | ||
| ``` | ||
| - Add component in header | ||
| ```c++ | ||
| #include "AgonesComponent.h" | ||
|
|
||
| UPROPERTY(EditAnywhere, BlueprintReadWrite) | ||
| UAgonesComponent* AgonesSDK; | ||
| ``` | ||
| - Initialize component in GameMode | ||
| ```c++ | ||
| #include "AgonesComponent.h" | ||
| #include "Classes.h" | ||
|
|
||
| ATestGameMode::ATestGameMode() | ||
| { | ||
| AgonesSDK = CreateDefaultSubobject<UAgonesComponent>(TEXT("AgonesSDK")); | ||
| } | ||
| ``` | ||
|
|
||
| - Use the Agones component to call PlayerReady | ||
| ```c++ | ||
| void APlatformGameSession::PostLogin(APlayerController* NewPlayer) | ||
| { | ||
| // Empty brances are for callbacks on success and errror. | ||
| AgonesSDK->PlayerConnect("netspeak-player", {}, {}); | ||
| } | ||
| ``` | ||
|
|
||
| #### Using Blueprints | ||
| - Add Component to your Blueprint GameMode | ||
|  | ||
| - This will automatically call `/health` every 10 seconds and once `/gameserver` calls are succesful it will call `/ready`. | ||
|
|
||
| - Accessing other functionality of Agones can be done via adding a node in Blueprints. | ||
|  | ||
|
|
||
|
|
||
| ## SDK Functionality | ||
|
|
||
| Additional methods have been added for ease of use (both of which are enabled by default): | ||
|
|
||
| - Connect | ||
| - will call `/gameserver` till a succesful response is returned and then call `/ready`. | ||
| - disabled by setting `bDisableAutoConnect` to `true`. | ||
| - An event is broadcast with the `GameServer` data once the `/gameserver` call succeeds. | ||
| - Health | ||
| - calls `/health` endpoint on supplied rate | ||
| - enabled by default with 10 second rate | ||
| - disabled by default by setting `HealthRateSeconds` to `0`. | ||
|
|
||
| Both of the above are automatically kicked off in the `BeginPlay` of the component. | ||
|
|
||
| This Agones SDK wraps the REST API and supports the following actions: | ||
|
|
||
| Stable | ||
| - Lifecycle | ||
| - Ready | ||
| - Health | ||
| - Reserve | ||
| - Allocate | ||
| - Shutdown | ||
| - Configuration | ||
| - GameServer | ||
| - Metadata | ||
| - SetAnnotation | ||
| - SetLabel | ||
|
|
||
| Alpha | ||
| - Player Tracking | ||
| - GetConnectedPlayers | ||
| - GetPlayerCapacity | ||
| - GetPlayerCount | ||
| - IsPlayerConnected | ||
| - PlayerConnect | ||
| - PlayerDisconnect | ||
| - SetPlayerCapacity | ||
|
|
||
| Unimplemented | ||
| - WatchGameServer | ||
|
|
||
| Current the only missing functionality is the `WatchGameServer` functionality. We welcome collaborators to help implement this, if people need it before we get around to implementing it ourselves. | ||
|
|
||
| ## Unreal Hooks | ||
|
|
||
| Within the Unreal [GameMode](https://docs.unrealengine.com/en-US/API/Runtime/Engine/GameFramework/AGameMode/index.html) and [GameSession](https://docs.unrealengine.com/en-US/API/Runtime/Engine/GameFramework/AGameSession/index.html) exist a number of useful existing | ||
| funtions that can be used to fit in with making calls out to Agones. | ||
|
|
||
| A few examples are: | ||
| - `RegisterServer` to call `SetLabel`, `SetPlayerCapacity` | ||
| - `PostLogin` to call `PlayerConnect` | ||
| - `NotifyLogout` to call `PlayerDisconnect` | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,43 +1,27 @@ | ||
| using UnrealBuildTool; | ||
|
There was a problem hiding this comment. All files will need to have the Google LLC Apache licence at the top please, before we can accept them. |
||
|
|
||
| public class Agones : ModuleRules | ||
| { | ||
| public Agones(ReadOnlyTargetRules target) : base(target) | ||
| { | ||
| PCHUsage = PCHUsageMode.UseExplicitOrSharedPCHs; | ||
| PublicIncludePaths.AddRange(new string[] {}); | ||
| PrivateIncludePaths.AddRange(new string[] {}); | ||
| PublicDependencyModuleNames.AddRange(new[] | ||
| { | ||
| "Core", | ||
| "Http", | ||
| "Json", | ||
| "JsonUtilities" | ||
| }); | ||
| PrivateDependencyModuleNames.AddRange( | ||
| new[] | ||
| { | ||
| "CoreUObject", | ||
| "Engine", | ||
| "Slate", | ||
| "SlateCore" | ||
| }); | ||
| DynamicallyLoadedModuleNames.AddRange(new string[]{ }); | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These user docs should really live in: https://agones.dev/site/docs/guides/client-sdks/unreal/
There is a guide on how to document upcoming features so that they can be hidden until the next release here:
https://agones.dev/site/docs/contribute/#documentation-for-upcoming-features