Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Useful Unreal links #1846

Merged
merged 7 commits into from
Oct 16, 2020
Merged

Useful Unreal links #1846

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b2b7b3f
useful unreal links
domgreen Oct 14, 2020
0fadaa5
correct markdown woopsie
domgreen Oct 14, 2020
0c208c1
Merge branch 'master' into unreal_docs
domgreen Oct 14, 2020
7251af7
Merge branch 'master' into unreal_docs
markmandel Oct 15, 2020
f149bf7
Update site/content/en/docs/Guides/Client SDKs/unreal.md
domgreen Oct 16, 2020
d579a7f
adding link to dedicated server
domgreen Oct 16, 2020
7506135
Merge branch 'master' into unreal_docs
markmandel Oct 16, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions site/content/en/docs/Guides/Client SDKs/unreal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,25 @@ Check the [Client SDK Documentation]({{< relref "_index.md" >}}) for more detail
Download the source from the [Releases Page](https://github.com/googleforgames/agones/releases)
or {{< ghlink href="sdks/unreal" >}}directly from GitHub{{< /ghlink >}}.

## Prerequisite Knowledge

[Unreal](https://www.unrealengine.com/) is a [game engine]((https://en.wikipedia.org/wiki/Game_engine)) that is used by anyone from hobbiests all the way thought to huge AAA Game Stuidos.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the test may be failing due to the extra set of parenthesis for the game engine link.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks will fix when I get back to the laptops 👍

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed, waiting for build to confirm

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if im reading the build error correctly but looks like the e2e tests are now the issue:

ERROR: build step 22 "e2e-runner" failed: step exited with non-zero status: 1

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That step has been a bit flaky. Is new - very odd.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sue on etiquette on resolving issues, normally let the reporter do it but I think this is fixed.


With this in mind there is a vast amount to learn to run a production game using Unreal, even before you get to learning how it integrates with Agones. If you want to kick the tires with a starter project you will probably be fine with one of the starter projects out of the box.

However as your Unreal/Agones project gets more advanced you will want to understand more about the engine itself and how it can be used to integrate with this project. There will be different ways of interacting wether in Play In Editor (PIE) or running as an actual dedicated game server packaged into a container.

A few helpful links for Unreal:

- [UE4 Documentation Site](https://docs.unrealengine.com/en-US/index.html)
- [UE4 Game Flow](https://docs.unrealengine.com/en-US/Gameplay/Framework/GameFlow/index.html)
- [UE4 Game Mode](https://docs.unrealengine.com/en-US/API/Runtime/Engine/GameFramework/AGameMode/index.html)
- useful for hooking up calls to Agones
- [UE4 Game Session](https://docs.unrealengine.com/en-US/API/Runtime/Engine/GameFramework/AGameSession/index.html)
- as above there are hooks in Game Session that can be used to call into Agones
- [UE4 Building & Packaging Games](https://docs.unrealengine.com/en-US/Engine/Deployment/BuildOperations/index.html)
- only building out Unreal game servers / clients, will also need to package into a container

## Getting Started

This is a SDK inspired by the REST API to the Agones sidecars that allows engineers to communicate with the sidecar from either C++ or Blueprints.
Expand Down