1. Set up

This tutorial is for developers located outside China, using hosting outside China

If you are located in China and using hosting inside China, see the [CN] Example Project quick-start tutorial.

Example Project quick-start: 1 - Set up

Build the project

To set up the Example Project, follow the steps for your operating system (either Windows or macOS).


To set up the Example Project for Windows:

  1. Open the project in Visual Studio:
    In File Explorer, from the root of the UnrealEngine directory, navigate to the Samples/UnrealGDKExampleProject/Game directory and double-click GDKShooter.sln.
  2. Build the project:
    In Visual Studio, in the Solution Explorer window, right-click on GDKShooter and select Build.
  3. When Visual Studio has finished building the project, set it as a startup project:
    Right-click on GDKShooter and select Set as StartUp Project.
  4. Open the project in the Unreal Editor:
    Press F5 on your keyboard or select Local Windows Debugger in the Visual Studio toolbar.

Image: The Visual Studio toolbar

Note: Ensure that your Visual Studio Solution Configuration is set to Development Editor.

TIP

When you run the Unreal Editor for the first time, you might see a Windows Defender Firewall message stating that it has blocked some features of runtime.exe. Select Allow access to continue and open the Unreal Editor.


To set up the Example Project for macOS:

  1. Open the project in XCode:
    In Finder, navigate to the UnrealEngine/Samples/UnrealGDKExampleProject/Game directory and double-click GDKShooter.xcworkspace.
  2. Select Play to build and open the project.

Note: Ensure that your XCode scheme is set to Development Editor.

TIP

When you run the Unreal Editor for the first time, you might see a warning message asking you if you want to accept incoming network connections. Select Allow to continue and open the Unreal Editor.


Image: The Example Project open in the Unreal Editor on Windows (the toolbar is different for macOS - see below)

The toolbar

When you open the project in the Unreal Editor, you can see there are additional options on the Unreal Editor toolbar and an additional Editor settings panel. You use the GDK toolbar and some Editor settings options in later steps of this guide.

Image: Unreal Editor toolbar with GDK for Unreal options on Windows

Note: On macOS there is no Cloud option in the toolbar, as you can’t start a cloud deployment from macOS.

Find out more about the UE fork's version of the Unreal Editor toolbar and settings panels:

  • Toolbar
  • SpatialOS Editor Settings panel
  • SpatialOS Runtime Settings panel


  • 2020-06-23 Page updated with editorial review: added MacOS, mobile, UI and deployment workflow changes.
    2019-05-23 Page added with editorial review.

    Updated about a year ago



    1. Set up


    Suggested Edits are limited on API Reference Pages

    You can only suggest edits to Markdown body content, but not to the API spec.