All pages
Powered by GitBook
1 of 5

Loading...

Loading...

Loading...

Loading...

Loading...

Getting setup with ODK development

Quick-start guide on how to download the ODK and start developing!

Access the Dashboard download page and click "Install the Launcher".

  1. The ODK Launcher should open and start downloading the ODK.

  2. When the download is complete, the template selection window should open with the option to load an existing project or create a new project from the ODK template:

    ODK Templates View
  3. If this is your first time developing for the ODK, we recommend you use the "ODK Boneyard Template" as the starting template. Click on the template to create a project from it

  4. Give your project a name, and click "Create New Project". The template will download and open automatically.

  5. Once open, you're able to use Play-in-Editor to test and develop your experiences!

Creating an online world

It only takes a quick few steps to create a deployment from your project content that others can join.

  1. Click the "Upload Content" button within the editor dashboard

  2. Give your world a description, and ensure that the Boneyard map is selected. Then click the "Upload" button

  3. Your project will then be cooked, packaged and uploaded to the Otherside dashboard. In future uploads, this process will be quicker as not all content will need to be recooked. Once complete, click the "View upload in dashboard" button

  • That will take you to the ODK dashboard, which will display your world's uploads. You can then click "Launch World" to create a deployment from your uploaded content, and share that with others to join

  • The ODK Boneyard Template

    Quick Start Guide

    Welcome to the Otherside Development Kit!

    If this is your first time here, we recommend setting up an example project from one of our templates and experimenting with what's possible.

    Otherwise take a look at the plugin and templates that are provided with the Otherside Development Kit

    It is HIGHLY recommended you read Msquared's documentation to familiarise yourself with some core concepts within the World Builder that the ODK builds on: https://docs.msquared.io/ The sections that are partcularily important are

    • Morpheus networking

    Difference from native Unreal
    Actor pooling

    FAQ

    1. How do I get access to the ODK?

    Please reach out to your representative at Yuga who can organise your onboarding, as part of this process you need to supply all emails that will need access to the ODK tooling.

    Once you have been given access please follow the quick start guide which can be found here: https://docs.otherside.xyz/odk-documentation/documentation/quick-start-guide/getting-setup-with-odk-development

    1. When setting up a new project I get this error "Error getting space required: Error: Expected string at Index 6"

    Please log in with Otherside and NOT Msquared as shown in I am unable to Login to the ODK Launcher

    1. I am unable to Login to the ODK Launcher

    Please ensure that you are logging in with the email that you have sent to your Yuga contact to get whitelisted. If this step has been completed please ensure that you are logging in via Otherside and not Msquared on the Launcher. There is also a known issue where it may take two attempts to login. If you are still facing problems then please reach out to your Yuga representative.

    1. I am unable to enter admin mode within the engine.

    Please review the

    For any role that you want to have access to the Inspector (historically just Director) add the Capabilities.Morpheus.InspectorEnabled capability to the GrantedCapabilities field within your data table for those roles.

    1. When I open the Launcher it get stuck on the spinner

    First you want to confirm that you have the latest launcher installed which you can download from the dashboard, then if that doesnt resolve it please follow the guide for clearing credentials here:

    1. I am unable to sign in via the Editor

    Please follow the guide here:

    If you continue to encounter sign-in failure, please collect your unreal logs and share them in your ODK support channel.

    1. I am unable to open the web overlay within my experience/or my account details are incorrect on privy on the overlay/ or I am getting errors when opening the overlay.

    With the move to using Privy the way you access deployments has changed, if you go in via the Otherside Dashboard you won't go through the Privy auth process, so when access deployments please append the following link with your WorldID and ProjectID. Please note you don't need the [] on either project ID or world ID

    We've noticed on rare occasion the web browser can fail to process the content URL that it's attempting to display. We're continually working to resolve these types of errors. If you do encounter this error, please toggle the web browser to resolve (pressing Tab). If the error persists, please raise it within your ODK support channel.

    Technical Overview

    High-level 101

    The Otherside Development Kit (or ODK) is a platform built for the Yuga community to build and share experiences within the Otherside community.

    The ODK is built on top of MSquared's World Builder platform. World Builder documentation is available here. The World Builder is built on top of a Blueprint only version of Epic's Unreal Engine, and is architected to allow quick iteration on content, while also providing unparalleled player number and quick and easy travel between worlds.

    It's highly recommend that if you intend to develop for the ODK that you familiarize yourself with the basics of the World Builder platform. In particular, sections that are useful to read are:

    • Morpheus networking

    • Difference from native Unreal

    The ODK also provides a host of Otherside related content built on top of the World Builder. The majority of the functionality is provided within , which is located within the engine plugins of your ODK Unreal installation

    Please peruse the provided content, and use the as means to explore what's available within the ODK.

    breaking changes
    https://docs.otherside.xyz/odk-documentation/documentation/quick-start-guide/faq/guide-on-clearing-credentials
    https://docs.otherside.xyz/odk-documentation/documentation/quick-start-guide/faq/guide-on-clearing-credentials
    Actor pooling
    ODK plugin
    Template Projects
    ODK Plugin Content

    Guide on Clearing Credentials

    If you are having problems signing in within the Unreal Editor then please follow this guide to try and resolve the issue.

    Step 1

    Ensure you are using the custom sign -in method in Editor > Sign-In Settings as shown below, this should be set too: https://o7e.dev/

    Step 2

    Clear the sign in credentials by going Tools > Clear Credentials

    After doing this step you can try to relogin with the editor, if this still fails then redo Step 2 and proceed to Step 3.

    Step 3

    Clear your web session by deleting the webcache folders from project/Saved Folder

    After doing this Restart the Unreal Editor if the issue persists please move ontpo Step 4

    Step 4

    Close the Unreal editor and open Windows Credentials Manager

    Step 5

    Select WIndows Credentials

    Step 6

    Delete any credentials starting with Improbable, M2 or Morpheus

    Reopen the Unreal Editor and you should be prompted to re sign in, which should resolve your issue