Skip to main content

Creating Your World

Set up the Unity Editor

  • As per the Getting Started section for installing the latest supported Unity editor version and acquiring the Basis framework.
  • Open Unity Hub and add an existing project, choose the extracted/cloned Basis project folder.
  • Once the Unity Project has loaded, you can now load your World files:
  • Either,
    • Find Assets in the Project hierarchy, inside Assets right-click any empty space and select Show in Explorer.
    • Copy in your World files [Mesh/Materials/Textures, etc.].
  • or
    • Import a .unity package containing your files, from the Assets menu, Import Package > Custom Package.
  • Bring back the Unity window and allow the import process to finish.

Minimum Requirements for a functional Basis Scene

  • Import your world meshes or create a new 3D object, such as a Plane or Cube. Ensure a Collider is present.
  • Create a gameObject, give it a suitable name, and on the Inspector click Add Component and find/select the Basis Scene component.

image

image

  • At this point you can create another gameObject, name it Spawn, and then place it somewhere in the world that you would like players to spawn into the world at, or simply use the same gameObject that was created for the Basis Scene component.

image

  • Either way, make sure you place the gameObject of your spawn position of choice into the Spawn Point field and then it will use the transform of that gameObject.

image

Build the AssetBundle

  • On the Basis Scene Component, press the Create Scene Bee File button.

image

  • The results will be opened automatically as shown below.

image

Test the scene

warning

Select the BasisFramework .prefab asset in the Project files, Do not instantiate this prefab into the current Scene! The Basis SDK does this automatically!

  • Once the AssetBundle has been created, you can load this via the BasisFramework prefab found at Packages > Basis SDK > Prefabs > Boot.

image

  • You can place the location of the new AssetBundle under the Remote BEE File Location field, along with the Unlock Password provided in the dontuploadmepassword.txt file generated in the /AssetBundles/ directory, then enable Use Scene Provided Here.

image

  • Load the Initialization scene from Packages > Basis SDK > Scenes, and then hit Play.

image

  • Enter a Username and press "Connect", localhost may be used if a Server has been started on the local machine.

  • You should then load in at the spawn location of your world or the connecting Server.