If you would like an overview of the GDK please see the main readme.
The GDK documentation assumes you are familiar with SpatialOS concepts. For guidance see the SpatialOS website.
If you're new to the SpatialOS GDK for Unity, check out the docs under Getting started and Concepts, and then look at the Playground project included in the repo and get a feel for using the GDK with either GameObjects and MonoBehaviours or with the Unity ECS.
Once you are comfortable with the GDK and want to start a separate project, look at Configuring your project.
- SpatialOS concepts (on the SpatialOS docs site)
- SpatialOS glossary (on the SpatialOS docs site)
- Core Module and Feature Modules overview
- Snapshots
- Creating entity templates
- Setting up GameObjects for interaction with SpatialOS
- Reading and writing component data
- Sending and receiving events
- Sending and receiving commands
- World commands
- Retrieving your EntityId and accessing the worker
The GDK currently uses the 0.0.12-preview.13 version of the entities preview packages.
The GDK documentation assumes you are familiar with the Unity Entity Component System (ECS).
ECS documentation:
- This overview YouTube video from Brackeys.
- The more detailed documentation from Unity on the ECS GitHub repository.
GDK documentation:
- System update order
- Components and component updates
- Sending and receiving events
- Sending and receiving commands
- World commands
- Receiving updates from SpatialOS: Reactive components
- Custom replication systems
- Authority
- Entity checkout process
- The code generator
- Temporary components
- Logging
- Accessing information about the worker during runtime
This alpha release of the GDK Core is for evaluation and feedback purposes only, with limited documentation - see the guidance on Recommended use.
© 2018 Improbable