Agones SDK with Unreal Engine Example #2241

WilSimpson · 2021-08-27T06:27:05Z

What type of PR is this?

Uncomment only one /kind <> line, press enter to put that in a new line, and remove leading whitespace from that line:

/kind breaking
/kind bug
/kind cleanup
/kind documentation

/kind feature

/kind hotfix

What this PR does / Why we need it:
There have been requests for a full Unreal Engine example. This example bundles a complete Unreal Engine 2.26.2 - Third Person Shooter example game. Shows how to include Agones on only server builds and not offline lobbies. Shows how to use Agones in C++ and in blueprints. Ready to build, package and deploy.

Which issue(s) this PR fixes:

Closes #2217

Special notes for your reviewer:
This is incomplete and posted for early review and further discussion. Here is what is currently done and plan to be work on:

Documentation
Implement Agones in C++
Implement Agones in Blueprints
Test for implementation bugs
Test for server/client bugs with packaging
Test if all necessary content is included
Test documentation for accuracy from fresh pull

Some decisions further decisions:

Do we include generated source code from Unreal? (~1.3 GB of space saved by not including)
Do we include compiled binaries? (Unknown space currently)

Any other requests for features in the example?

… to connect to.

google-oss-robot · 2021-08-27T06:27:23Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: WilSimpson
To complete the pull request process, please assign dzlier-gcp after the PR has been reviewed.
You can assign the PR to them by writing /assign @dzlier-gcp in a comment when ready.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

agones-bot · 2021-08-27T06:55:01Z

Build Succeeded 👏

Build Id: 023f7d2a-269d-417f-a889-bd4b208e271c

The following development artifacts have been built, and will exist for the next 30 days:

image: gcr.io/agones-images/agones-controller:1.17.0-f4cc4d0
image: gcr.io/agones-images/agones-ping:1.17.0-f4cc4d0
Linux C++ SDK (build): agonessdk-1.17.0-f4cc4d0-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.17.0-f4cc4d0.zip

A preview of the website (the last 30 builds are retained):

https://f4cc4d0-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/2241/head:pr_2241 && git checkout pr_2241
helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.17.0-f4cc4d0

Ludea · 2021-09-01T12:41:48Z

FirstPersonExampleMap is missing

WilSimpson · 2021-09-01T14:26:10Z

I renamed them to EntryLevel and ServerLevel to hopefully improve clarity of what each level is used for. I noticed I did not set this in the settings, so I have done so now. Thanks!

agones-bot · 2021-09-01T14:54:59Z

Build Failed 😱

Build Id: 3166a29c-e17e-4e39-8ba8-72f11de2eeaf

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

examples/unrealengine/README.md

google-cla · 2021-09-02T16:01:19Z

We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for all the commit author(s) or Co-authors. If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google.
In order to pass this check, please resolve this problem and then comment @googlebot I fixed it.. If the bot doesn't comment, it means it doesn't think anything has changed.

ℹ️ Googlers: Go here for more info.

agones-bot · 2021-09-02T16:28:14Z

Build Succeeded 👏

Build Id: d63dcd48-6fec-4a27-8bee-be82a165eae8

The following development artifacts have been built, and will exist for the next 30 days:

image: gcr.io/agones-images/agones-controller:1.17.0-0f393ac
image: gcr.io/agones-images/agones-ping:1.17.0-0f393ac
Linux C++ SDK (build): agonessdk-1.17.0-0f393ac-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.17.0-0f393ac.zip

A preview of the website (the last 30 builds are retained):

https://0f393ac-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/2241/head:pr_2241 && git checkout pr_2241
helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.17.0-0f393ac

markmandel · 2021-09-02T16:43:12Z

Just came to say that I applaud this effort, even if I have no idea what is going on 😄

agones-bot · 2021-09-02T16:50:26Z

Build Succeeded 👏

Build Id: 663ed227-dae1-432d-94e9-16db86a64d00

The following development artifacts have been built, and will exist for the next 30 days:

image: gcr.io/agones-images/agones-controller:1.17.0-87c0f7b
image: gcr.io/agones-images/agones-ping:1.17.0-87c0f7b
Linux C++ SDK (build): agonessdk-1.17.0-87c0f7b-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.17.0-87c0f7b.zip

A preview of the website (the last 30 builds are retained):

https://87c0f7b-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/2241/head:pr_2241 && git checkout pr_2241
helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.17.0-87c0f7b

agones-bot · 2021-09-02T16:56:30Z

Build Succeeded 👏

Build Id: c50b8858-cef1-4e0c-a911-43277d0982e4

The following development artifacts have been built, and will exist for the next 30 days:

image: gcr.io/agones-images/agones-controller:1.17.0-f4cc4d0
image: gcr.io/agones-images/agones-ping:1.17.0-f4cc4d0
Linux C++ SDK (build): agonessdk-1.17.0-f4cc4d0-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.17.0-f4cc4d0.zip

A preview of the website (the last 30 builds are retained):

https://f4cc4d0-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/2241/head:pr_2241 && git checkout pr_2241
helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.17.0-f4cc4d0

agones-bot · 2021-09-02T17:12:37Z

Build Succeeded 👏

Build Id: 6fdaeb99-1ac8-4427-a9e1-e3500b4476f0

The following development artifacts have been built, and will exist for the next 30 days:

image: gcr.io/agones-images/agones-controller:1.18.0-917eca3
image: gcr.io/agones-images/agones-ping:1.18.0-917eca3
Linux C++ SDK (build): agonessdk-1.18.0-917eca3-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.18.0-917eca3.zip

A preview of the website (the last 30 builds are retained):

https://917eca3-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/2241/head:pr_2241 && git checkout pr_2241
helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.18.0-917eca3

Ludea · 2021-09-08T07:18:44Z

examples/unrealengine/server.Dockerfile

+RUN apt-get update \
+    && apt-get upgrade -y
+
+RUN adduser server


Use useradd instead of adduser, it avoid some interactive message

Ludea · 2021-09-08T07:19:29Z

examples/unrealengine/gameserver.yaml

+kind: GameServer
+metadata:
+  generateName: "unrealexample-"
+spec:


template key is missing

roberthbailey · 2021-09-10T00:47:40Z

Based on "This is incomplete and posted for early review and further discussion" from the initial comment I've changed this to a draft pull request. Please move it back to active when it is complete. Thanks!

Ludea · 2021-09-10T05:18:38Z

examples/unrealengine/server.Dockerfile

+
+RUN apt-get update \
+    && apt-get upgrade -y
+


You have to install xdg-user-dirs

Ludea · 2021-09-10T05:19:32Z

examples/unrealengine/server.Dockerfile

+
+EXPOSE 7777/udp
+
+ENTRYPOINT ["/home/server/server/AgonesExampleServer.sh"]


Use CMD instead

markmandel · 2021-11-08T21:35:37Z

It's been a long time since this was worked on - should we close it for now and revisit at a later date?

markmandel · 2021-11-15T22:31:19Z

So it's been 7 days since I suggested we close this, and it doesn't seem like we've had any objections.

So I'm going to close this. Please open a new PR if you want to revisit 😄 we would love to have this example.

WilSimpson added 12 commits August 26, 2021 21:57

Ignoring unecessary and compiled data

778f933

Generated the Shooter Example game on version 2.26.2 of Unreal Engine

01a4f53

Added server target

f170feb

Added client target

76a768e

Started documentation

dd80a49

Removed follow along

b6766fa

Added example configurations for deployment

7ab7c6e

Added plugin

73b66ac

Setup EntryLevel and ServerLevel. Set EntryLevel to except IP address…

6c932f4

… to connect to.

Added content folder

6facf2a

Added Agones SDK implementations

2ba77ee

Added example for blueprintable SDK

f4cc4d0

google-oss-robot added the size/XXL label Aug 27, 2021

google-cla bot added the cla: yes label Aug 27, 2021

google-oss-robot requested review from cyriltovena and roberthbailey August 27, 2021 06:27

WilSimpson changed the title ~~Dev unrealexample~~ Agones SDK with Unreal Engine Example Aug 27, 2021

Ludea reviewed Sep 1, 2021

View reviewed changes

examples/unrealengine/README.md Show resolved Hide resolved

google-cla bot added cla: no cla: yes and removed cla: yes cla: no labels Sep 2, 2021

WilSimpson added 2 commits September 2, 2021 11:21

Updated default map to EntryLevel

eb2cd2d

Updated prerequisites to mention a requirement to build from source.

87c0f7b

Merge branch 'main' into dev-unrealexample

917eca3

Ludea reviewed Sep 8, 2021

View reviewed changes

roberthbailey marked this pull request as draft September 10, 2021 00:47

google-oss-robot added the do-not-merge/work-in-progress label Sep 10, 2021

Ludea reviewed Sep 10, 2021

View reviewed changes

roberthbailey added the feature-freeze-do-not-merge Only eligible to be merged once we are out of feature freeze (next full release) label Oct 5, 2021

roberthbailey removed the feature-freeze-do-not-merge Only eligible to be merged once we are out of feature freeze (next full release) label Oct 12, 2021

markmandel added the stale Pending closure unless there is a strong objection. label Nov 8, 2021

markmandel closed this Nov 15, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Agones SDK with Unreal Engine Example #2241

Agones SDK with Unreal Engine Example #2241

WilSimpson commented Aug 27, 2021 •

edited

Loading

google-oss-robot commented Aug 27, 2021

agones-bot commented Aug 27, 2021

Ludea commented Sep 1, 2021

WilSimpson commented Sep 1, 2021 •

edited

Loading

agones-bot commented Sep 1, 2021

google-cla bot commented Sep 2, 2021

agones-bot commented Sep 2, 2021

markmandel commented Sep 2, 2021

agones-bot commented Sep 2, 2021

agones-bot commented Sep 2, 2021

agones-bot commented Sep 2, 2021

Ludea Sep 8, 2021

Ludea Sep 8, 2021

roberthbailey commented Sep 10, 2021

Ludea Sep 10, 2021

Ludea Sep 10, 2021

markmandel commented Nov 8, 2021

markmandel commented Nov 15, 2021


		EXPOSE 7777/udp

		ENTRYPOINT ["/home/server/server/AgonesExampleServer.sh"]

Agones SDK with Unreal Engine Example #2241

Agones SDK with Unreal Engine Example #2241

Conversation

WilSimpson commented Aug 27, 2021 • edited Loading

google-oss-robot commented Aug 27, 2021

agones-bot commented Aug 27, 2021

Ludea commented Sep 1, 2021

WilSimpson commented Sep 1, 2021 • edited Loading

agones-bot commented Sep 1, 2021

google-cla bot commented Sep 2, 2021

agones-bot commented Sep 2, 2021

markmandel commented Sep 2, 2021

agones-bot commented Sep 2, 2021

agones-bot commented Sep 2, 2021

agones-bot commented Sep 2, 2021

Ludea Sep 8, 2021

Choose a reason for hiding this comment

Ludea Sep 8, 2021

Choose a reason for hiding this comment

roberthbailey commented Sep 10, 2021

Ludea Sep 10, 2021

Choose a reason for hiding this comment

Ludea Sep 10, 2021

Choose a reason for hiding this comment

markmandel commented Nov 8, 2021

markmandel commented Nov 15, 2021

WilSimpson commented Aug 27, 2021 •

edited

Loading

WilSimpson commented Sep 1, 2021 •

edited

Loading