DOC-1255 Clarify elements of the GDK in readme #43
Conversation
This file contains hidden or 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
improbable-prow-robot
added
jira/no-ticket
anne-edwards
changed the title
improbable-prow-robot
removed
the
jira/no-ticket
|
Corresponding JIRA ticket: https://improbableio.atlassian.net/browse/DOC-1255 |
ElleEss
reviewed
Aug 8, 2019
| @@ -1,12 +1,22 @@ | |||
| # SpatialOS Unreal GDK Example Project | |||
| # SpatialOS GDK for Unreal Example Project | |||
ElleEss
reviewed
Aug 8, 2019
|
|
||
| In addition to the Example Project, the GDK also contains: | ||
|
|
||
| * [The SpatialOS Unreal Engine fork](https://github.com/improbableio/UnrealEngine) |
There was a problem hiding this comment.
Worth mentioning you need to have a GitHub account associated with Unreal or you get a 404 as it trolls people all the time!
Suggested change
| * [The SpatialOS Unreal Engine fork](https://github.com/improbableio/UnrealEngine) | |
| * [The SpatialOS Unreal Engine fork](https://github.com/improbableio/UnrealEngine)</br> | |
| You must be a member of the [EpicGames organisation](https://github.com/EpicGames) on GitHub to follow this link. If you aren't, it returns a 404 error. |
ElleEss
approved these changes
Aug 8, 2019
README.md
Outdated
| * [The GDK plugin](https://github.com/spatialos/UnrealGDK) | ||
|
|
||
| ## About the Example Project | ||
| The Example Project contains gameplay and assets that are representative of a basic first-person shooter running on SpatialOS. If you want to make your own project from scratch, use the [Starter Template](https://docs.improbable.io/unreal/alpha/content/get-started/gdk-template). |
There was a problem hiding this comment.
Suggested change
| The Example Project contains gameplay and assets that are representative of a basic first-person shooter running on SpatialOS. If you want to make your own project from scratch, use the [Starter Template](https://docs.improbable.io/unreal/alpha/content/get-started/gdk-template). | |
| The Example Project contains gameplay and assets that are representative of a basic first-person shooter running on SpatialOS. If you want to make your own project from scratch, use the Starter Template by following the [Starter Template guide](https://docs.improbable.io/unreal/alpha/content/get-started/gdk-template) in the GDK for Unreal documentation. |
Otherwise it looks like it's a link to a repo to get it.
oblm
added a commit
that referenced
this pull request
Aug 15, 2019
* DOC-1255 Clarify elements of the GDK in readme (#43) * Clarify elements of the GDK * Remove duplicate and outdated info * Changes from review * Add two_worker_test for tutorial (#44) * Disable offloading by default (#45) Offloading workers AIWorker / CrashWorker should not start by default in example project. Disabling offloading should have this effect. * Add Calls to Parent BeginPlay in Character Classes (#46) In AGDKCharacter::BeginPlay a callback is registered on the UEquippedComponent::HoldableUpdated. This callback is used to attach the new AHoldable to the player's skeleton. Blueprint subclasses: BP_Base_Character, and BP_FPS_Character had overridden BeginPlay but not called the Parent function, so the callback was not attached. This meant that if a weapon was checked out after the character, it would not be attached, and would stay floating where it was spawned.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Updated the readme to clarify what the GDK is, and clarify what's in this repo vs. other repos.
Ollie confirmed that we can delete the references to the test suite and third-person shooter.