|
1 |
| -# SpatialOS Unreal GDK Example Project |
| 1 | +# SpatialOS GDK for Unreal Example Project |
2 | 2 |
|
3 | 3 | <img src="https://user-images.githubusercontent.com/2433131/58086122-f28af200-7bb5-11e9-9b96-b13b747130d0.png" height="70%" width="70%">
|
4 | 4 |
|
5 | 5 | - **LICENSE:** Use of the contents of this repository is subject to the [license](LICENSE.md)
|
6 | 6 |
|
7 |
| -This project is an example shooter game which uses the [SpatialOS GDK for Unreal](https://github.com/spatialos/unrealGDK). |
| 7 | +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). |
8 | 8 |
|
9 |
| -The 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). |
| 9 | +> 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. |
| 10 | +
|
| 11 | +This is the repository for the Example Project, an example shooter game that uses the GDK. |
| 12 | + |
| 13 | +In addition to the Example Project, the GDK also contains: |
| 14 | + |
| 15 | +* [The SpatialOS Unreal Engine fork](https://github.com/improbableio/UnrealEngine) |
| 16 | + |
| 17 | + 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. |
| 18 | +* [The GDK plugin](https://github.com/spatialos/UnrealGDK) |
| 19 | + |
| 20 | +## About the Example Project |
| 21 | +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. |
10 | 22 |
|
11 | 23 | For setup instructions, follow the [Example Project guide](https://docs.improbable.io/unreal/latest/content/get-started/example-project/exampleproject-intro) in the GDK for Unreal documentation.
|
12 | 24 |
|
@@ -39,16 +51,6 @@ This repository contains a set of helper scripts to get you started.
|
39 | 51 |
|
40 | 52 | We have released the GDK for Unreal this early in development because we want your feedback. Please come and talk to us about the software and the documentation via: [Discord](https://discordapp.com/channels/311273633307951114/339471548647866368) - [Forums](https://forums.improbable.io/) - [GitHub issues in this repository](https://github.com/spatialos/UnrealGDK/issues).
|
41 | 53 |
|
42 |
| -#### Where to get the GDK and related projects |
43 |
| - |
44 |
| -The GDK and related projects are available on GitHub. |
45 |
| - |
46 |
| -- [GDK: github.com/spatialos/UnrealGDK](https://github.com/spatialos/UnrealGDK) |
47 |
| -- [The SpatialOS Unreal Engine](https://github.com/improbableio/UnrealEngine/tree/4.20-SpatialOSUnrealGDK) |
48 |
| - **NOTE:** This link may give you a 404. See the [Unreal GDK documentation](https://docs.improbable.io/unreal/alpha/content/get-started/build-unreal-fork) for more information. |
49 |
| -- [Third-Person Shooter](https://github.com/spatialos/UnrealGDKThirdPersonShooter) (Not actively developed) |
50 |
| -- [The Test Suite](https://github.com/spatialos/UnrealGDKTestSuite) |
51 |
| - |
52 | 54 | #### Public contributors
|
53 | 55 |
|
54 | 56 | We are not currently accepting public contributions. However, we are accepting [issues](https://github.com/spatialos/UnrealGDK/issues) and we do want your feedback.
|
|
0 commit comments