Adding a map to Mattercraft

Mattercraft comes with an Immersal VPS template for you to get started building environment based experiences quickly and easily.

Before adding your map into Mattercraft, you'll first need to scan a 3D environment. Click here to learn more about creating a map with the Immersal Mapper app.

Immersal VPS template

The best way to get started with creating immersive environment based content with Immersal VPS in Mattercraft is by using our ready made template. To start using the template:

Immersal VPS x Mattercraft starting template
  1. Create a new Mattercraft project
  2. Find the Immersal VPS section in the Project Templates modal
  3. Click on the Immersal Blank (with Splash) template and then on the Get Started button

The Immersal VPS template comes with everything you need to get started. It uses the Zappar World Tracker to initialize placement - you do not need to modify this setup unless you want to customize the initial UI.

Adding your Map

Once you have launched the Immersal VPS starter template, you will be able to see the relevant ImmersalAnchorGroup component in the project's Hierarchy. This is the component used to communicate with Immersal and load your 3D map into Mattercraft.

Please note that some ImmersalAnchorGroup options are only available on paid Immersal plans.

The video and step-by-step instructions below explain how you can import your map into Mattercraft:

Importing an Immersal VPS map into Mattercraft
  1. In your Immersal Developer Portal, copy your Developer Token / ID. This can be found in the Menu -> Accounts -> Show Token section
  2. Go back to Mattercraft and click on the ImmersalAnchorGroup component in the Hierarchy
  3. Paste the Developer Token / ID into the Developer ID node property
  4. Copy the Map ID from your Immersal Developer Portal maps list
  5. Go back to Mattercraft and past the Map ID into the Map ID node property
  6. You should see “Loading map preview” and the map should appear in your scene.
  7. There are a number of properties you can update on the ImmersalAnchorGroup based on your use case.

If your map does not appear, make sure that you were using "Manual" mode when scanning your map in the Immersal Mapper App and that the API Endpoint property value is set to https://api.immersal.com/.

Next Article: Building VPS experiences

zapcode branded_zapcode i