From 708d5891016ee50d0fab948bbaa568cdf601ddbe Mon Sep 17 00:00:00 2001 From: Anne Edwards Date: Thu, 8 Aug 2019 14:33:59 +0100 Subject: [PATCH 1/3] Clarify elements of the GDK --- README.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 4bc7934acc..cfacf752d5 100644 --- a/README.md +++ b/README.md @@ -2,17 +2,18 @@ ![](SpatialGDK/Documentation/spatialos-gdkforunreal-header.png) -The SpatialOS Game Development Kit (GDK) for Unreal is an Unreal Engine plugin which gives you the features of [SpatialOS](https://spatialos.improbable.io/docs/reference/latest), within the familiar workflows and APIs of Unreal Engine. For more information, please see the GDK's [documentation website](https://docs.improbable.io/unreal/latest). - -If you’re an Unreal game developer and you’re ready to try out the GDK, follow the [Get started guide](https://docs.improbable.io/unreal/latest/content/get-started/introduction). +The SpatialOS Game Development Kit (GDK) for Unreal is an Unreal Engine fork and plugin with associated projects. It gives you the features of [SpatialOS](https://spatialos.improbable.io/docs/reference/latest), within the familiar workflows and APIs of Unreal Engine. For more information, please see the GDK's [documentation website](https://docs.improbable.io/unreal/latest). > The SpatialOS GDK for Unreal is in alpha. It is ready to use for development of single-server games, but not recommended for public releases. We are committed to rapid development of the GDK to provide a performant release - for information on this, see our [development roadmap](https://github.com/spatialos/UnrealGDK/projects/1) and [Unreal features support](https://docs.improbable.io/unreal/latest/unreal-features-support) pages, and contact us via our forums, or on Discord. -## Where to get the GDK and related projects -The GDK and its related projects are available on GitHub. -* [GDK: github.com/spatialos/UnrealGDK](https://github.com/spatialos/UnrealGDK) +This is the repository for the GDK plugin, which includes the Starter template (a blank starter project). + +In addition to the plugin, the GDK also contains: + * [The SpatialOS Unreal Engine fork](https://github.com/improbableio/UnrealEngine) -* [The Example Project](https://github.com/spatialos/UnrealGDKExampleProject) +* [The Example Project](https://github.com/spatialos/UnrealGDKExampleProject) + +If you’re an Unreal game developer and you’re ready to try out the GDK, follow the [Get started guide](https://docs.improbable.io/unreal/latest/content/get-started/introduction). ## Unreal Engine changes In order to transform Unreal from a single server engine to a distributed model, we have made a number of small changes to the UE4 code. We will attempt to consolidate and remove (or submit as PR to Epic) as many of these changes as possible. You can see the changes in our forked [Unreal Engine repo](https://github.com/improbableio/UnrealEngine). From b3a06bbdcfca09a7dc77d9cec4d974e83171051b Mon Sep 17 00:00:00 2001 From: anne-edwards <32169118+anne-edwards@users.noreply.github.com> Date: Fri, 9 Aug 2019 10:13:17 +0100 Subject: [PATCH 2/3] Apply suggestions from code review Co-Authored-By: Laura <36853437+ElleEss@users.noreply.github.com> --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index cfacf752d5..77f2d251c2 100644 --- a/README.md +++ b/README.md @@ -6,17 +6,17 @@ The SpatialOS Game Development Kit (GDK) for Unreal is an Unreal Engine fork and > The SpatialOS GDK for Unreal is in alpha. It is ready to use for development of single-server games, but not recommended for public releases. We are committed to rapid development of the GDK to provide a performant release - for information on this, see our [development roadmap](https://github.com/spatialos/UnrealGDK/projects/1) and [Unreal features support](https://docs.improbable.io/unreal/latest/unreal-features-support) pages, and contact us via our forums, or on Discord. -This is the repository for the GDK plugin, which includes the Starter template (a blank starter project). +This is the repository for the GDK plugin, which includes the Starter Template (a blank starter project). -In addition to the plugin, the GDK also contains: +In addition to the plugin, the GDK also includes: * [The SpatialOS Unreal Engine fork](https://github.com/improbableio/UnrealEngine) * [The Example Project](https://github.com/spatialos/UnrealGDKExampleProject) If you’re an Unreal game developer and you’re ready to try out the GDK, follow the [Get started guide](https://docs.improbable.io/unreal/latest/content/get-started/introduction). -## Unreal Engine changes -In order to transform Unreal from a single server engine to a distributed model, we have made a number of small changes to the UE4 code. We will attempt to consolidate and remove (or submit as PR to Epic) as many of these changes as possible. You can see the changes in our forked [Unreal Engine repo](https://github.com/improbableio/UnrealEngine). +## SpatialOS Unreal Engine fork changes +In order to transform Unreal from a single-server engine to a distributed model, we made a number of small changes to Unreal Engine code. We are attempting to consolidate and remove (or submit as PR to Epic) as many of these changes as possible. You can see the changes in the [SpatialOS Unreal Engine fork repository](https://github.com/improbableio/UnrealEngine). > In order to get access to this fork, you need to link your GitHub account to a verified Epic Games account, and to have agreed to Epic's license. You will not be able to use the GDK for Unreal without doing this first. To do this, see the [Unreal documentation](https://www.unrealengine.com/en-US/ue4-on-github). From ea90365586a17a18d431c17ab719c213c3ab72e4 Mon Sep 17 00:00:00 2001 From: Anne Edwards Date: Fri, 9 Aug 2019 10:14:50 +0100 Subject: [PATCH 3/3] Updates from review --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index cfacf752d5..aa23e4ffdd 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,8 @@ This is the repository for the GDK plugin, which includes the Starter template ( In addition to the plugin, the GDK also contains: * [The SpatialOS Unreal Engine fork](https://github.com/improbableio/UnrealEngine) + + You must be a member of the [Epic Games organization](https://github.com/EpicGames) on GitHub to access this. If you aren't, the link returns a 404 error. * [The Example Project](https://github.com/spatialos/UnrealGDKExampleProject) If you’re an Unreal game developer and you’re ready to try out the GDK, follow the [Get started guide](https://docs.improbable.io/unreal/latest/content/get-started/introduction).