Scene Metadata

Learn how to set up a scene and configure its metadata.

A scene is a Decentraland project that is spatially delimited and mapped to one or several parcels. If a scene is deployed to the Decentraland Genesis City map, players can experience it by visiting the scene's coordinates. If a scene is deployed to a World, players can visit it via URL.

See Files in a scene for a list of what files are used in a scene project.

Metadata

To edit a scene's metadata in the Scene Editor in Creator Hub, open a scene and click the pencil icon.

This opens up the scene menu, where you can configure multiple properties.

Alternatively, you can directly edit the scene.json file, where all of these values are stored.

📔 Note: Do not add custom fields to the scene.json file that are not mentioned in this page, as it could cause issues loading your scene.

Scene title, description, and image

It's very important to give your scene a title, a description, and a thumbnail image to attract players and help them know what to expect.

Players will see these displayed on a modal when they select the parcels of your scene on the map. They will also see these in a confirmation screen when being teleported there by another scene. Setting up compelling data here can significantly help drive traffic to your scene.

When players navigate the world and enter your scene, they are able to read the scene title from under the minimap.

Add this data via the scene menu in the Scene Editor.

The thumbnail should be a .png image of a recommended size of 228x160 pixels. The minimum supported size is 196x143 pixels. The image may be stretched if the width-to-height proportions don't match 228x160.

The image on navmapThumbnail should be a path to an image file in the project folder. It can also be a URL link to an image hosted elsewhere.

📔 Note: If you host an image elsewhere, make sure this is in a site that has permissive CORS policies for displaying content on other sites.

In case you want other developers to be able to reach out to you, you can also add contact information to your scene.

Age Rating

The Age Rating field is used to classify the content of your scene based on its appropriateness for different age groups. It helps in filtering content for players. The following options are available:

🟢 T for Teens (13+): This is the minimum age requirement as specified in Decentraland's Terms of Use. Opt for this category if your scene is limited to moderate violence, suggestive or horror-themed content, simulated gambling, and mild language.
🟡 A for Adults (18+): Choose this category if your scene features any of the following: intense offensive language, graphic violence, explicit sexual content and/or nudity, real money gambling, or substances like alcohol, tobacco, and drugs.

When editing the Age Rating via the scene.json, rating is a single-letter code, write either T for teens, or A for adults.

 "scene": {
    "rating": "T"
  }

Restricted Content

There is a third category for scenes: 🔴 R for Restricted. This rating is manually applied by Content Moderators to scenes that violate Decentraland's Content Policy. Violations may include, but are not limited to:

Suspicious content or spam
Abusive or hateful content
Sexual or degrading content
Child abuse
Harassment or bullying
Promotion of terrorism/violence
IP/Copyright infringement

Scenes with this rating won't load and no one will be able to interact with them. If your scene falls into this category, you should review and update it to comply with the Content Policy.

Feature Toggles

There are certain features that can be disabled in specific scenes so that players can't use these abusively. Configure these on the Settings tab of the scene settings.

Currently, only the following feature is handled like this:

Voice Chat: Refers to players using their microphones to have conversations over voice chat with other nearby players.
Disable Portable Experiences: This setting will set the behavior for any portable experience of a player while standing inside your scene. This includes not only portable experiences but also smart wearables. With this setting, you can chose to either keep them all enabled (default), disable them, or hide their UI. This is useful for scenes where portable experiences might give an unfair advantage to some players, for example using a jetpack in a parkour challenge. It's also recommended to prevent these in scenes where blockchain transactions take place, and where a malicious portable experience could potentially impersonate the scene´s UI.

On the scene.json file, these toggles are managed under featureToggles. The corresponding features are enabled by default, unless specified as disabled in the scene.json file.

"featureToggles": {
    "voiceChat": "disabled",
    "portableExperiences": "enabled" | "disabled" | "hideUi"
},

If a featureToggles property doesn't exist in your scene.json file, create it at root level in the json tree.

Spawn location

The Spawn Settings in the Settings tab define where players spawn when they access your scene directly, either by directly typing in the coordinates into the browser or teleporting.

Your scene might have objects that can block players from moving if they spawn on top of them, like trees or stairs. Your scene might also have elevated terrain. To prevent players from spawning in locations where they can't move, you can set multiple spawn positions in specific locations.

The position consists of coordinates inside the scene. These numbers refer to a position within the parcel, similar to what you'd use in the scene's code in a Transform component to position an entity.

📔 Note: All spawn points must be within the parcels that make up the scene. You can't spawn a player outside the space of these parcels.

Check the Random Offset box to randomly offset spawning players around the spawn point. This prevents all players from appearing overlapping each other when they spawn, which looks especially bad in crowded scenes. The Max Offset value is the maximum possible distance from the original spawn point, in both the X and Z axes.

Set the Camera Target to control the direction players face when they enter your scene. This gives you better control over their first impression and can help steer them towards a specific direction. By default this points at {x: 8, y:1, z:8}, which is the center of the scene for single-parcel scenes, or the center of the bottom-left parcel for larger scenes.

Click Add Spawn Point to list as many spawn points as you want. Players will randomly appear in one of those.

Spawn points in JSON

Spawn points can also be configured via the scene.json file, on the spawnPoints field.

  "spawnPoints": [
    {
      "name": "spawn1",
      "position": {
        "x": 5,
        "y": 1,
        "z": 4
      }
    }
  ],

A single scene can have multiple spawn points. This is especially useful in large scenes. To have many spawn points, simply list them as an array.

  "spawnPoints": [
    {
      "name": "spawn1",
      "position": {
        "x": 5,
        "y": 1,
        "z": 4
      }
	},
	{
      "name": "spawn2",
      "position": {
        "x": 3,
        "y": 1,
        "z": 1
      }
    }
  ],

When there are multiple spawn points, the one closest to the coordinates indicated by the player is selected.

If a spawn point is marked as default, it will always be used, regardless of whether it's the closest. If multiple spawn points are marked as default, the closest one is selected.

  "spawnPoints": [
    {
      "name": "spawn1",
      "default": true,
      "position": {
        "x": 5,
        "y": 1,
        "z": 4
      }
	},
	{
      "name": "not-used",
      "position": {
        "x": 3,
        "y": 1,
        "z": 1
      }
    }
  ],

Spawn regions

You can set a whole region in the scene to act as a spawn point. By specifying an array of two numbers for any dimension of the position, players will appear in a random location within that range. This helps prevent entering players from overlapping.

  "spawnPoints": [
    {
      "name": "region",
      "position": {
        "x": [1,5],
        "y": [1,1],
        "z": [2,4]
      }
    }
  ],

In the example above, players may appear anywhere in the square whose corners are on 1,1,2 and 5,1,4.

A scene can also have multiple spawn regions, just like it can have multiple spawn points.

  "spawnPoints": [
    {
      "name": "region1",
      "position": {
        "x": [1,5],
        "y": [1,1],
        "z": [2,4]
      }
    },
      {
      "name": "region2",
      "position": {
        "x": [1,5],
        "y": [1,1],
        "z": [6,8]
      }
    }
  ],

Rotation

You can also specify the rotation of players when they spawn, so that they're facing in a specific direction.

Simply add a cameraTarget field to the spawn point data. The value of cameraTarget should reference a location in space, with x, y and z coordinates relative to the scene, just like the position field.

  "spawnPoints": [
    {
      "name": "spawn1",
      "position": {
        "x": 5,
        "y": 1,
        "z": 4
      },
      "cameraTarget": {
        "x": 10,
        "y": 1,
        "z": 4
      }
    }
  ],

This example spawns a player at 5, 1, 4 facing East toward 10, 1, 4. If the spawn position is a range, the player's rotation will always match the indicated target. If there are multiple spawn points, each can have its own separate target.

Required Permissions

The requiredPermissions property manages various controlled features that could be used in an abusive way and damage a player's experience.

📔 Note: Permissions are only relevant in portable experiences and smart wearables. Normal scenes (both in parcels or in Worlds) are not affected by these permissions, and are free to use the corresponding functionality.

These features are blocked from use in the scene unless the permission is requested in the scene.json file.

"requiredPermissions": [
    "ALLOW_TO_MOVE_PLAYER_INSIDE_SCENE",
		"OPEN_EXTERNAL_LINK",
  ],

Currently, the following permissions are managed on smart wearables and portable experiences:

ALLOW_TO_MOVE_PLAYER_INSIDE_SCENE: Refers to moving a Player
ALLOW_TO_TRIGGER_AVATAR_EMOTE: Refers to Playing emotes on the player avatar
USE_WEB3_API: Refers to interacting with the player's browser wallets, to make transactions or sign messages.
USE_FETCH: Refers to sending http requests to 3rd party servers, using fetch or signedFetch
USE_WEBSOCKET: Refers to opening websocket connections with 3rd party servers
OPEN_EXTERNAL_LINK: Refers to prompting the player to open links to external sites

If a requiredPermissions property doesn't exist in your scene.json file, create it at root level in the json tree.

Scene parcels

When deploying a scene, the content is uploaded to the coordinates assigned in the scene configuration. A scene can include a single parcel, or a list of up to dozens of them.

Edit this on the second tab of the scene menu in the Scene Editor.

Use the dropdowns and click Apply Layout to change the dimensions of your scene. You can also click each individual parcel to toggle it off from your layout.

The default scene has its coordinates set to 0,0. You don't need to change this while developing a scene offline, unless you need to occupy multiple parcels. You will need to change this before deploying to coordinates where you have deploy permissions.

You can also change the scene coordinates on the scene.json file:

 "scene": {
    "parcels": [
      "54,-14"
    ],
    "base": "54,-14"
  }

The base field defines which parcel to consider the base parcel. If your scene has a single parcel, the base should be that parcel. If your scene has multiple parcels, the base should be the bottom-left (South-West) parcel. All entity positions are measured relative to the South-West corner of this parcel.

To display multiple parcels in the scene preview, list as many parcels as you intend to use. They don't need to be the exact parcels you'll deploy to, but they should all be adjacent and arranged in the same relative positions.

 "scene": {
    "parcels": [
      "54,-14",  "55,-14"
    ],
    "base": "54,-14"
  }

📔 Note: The largest scene size you can set is of 45 x 45 parcels.

Set parcels via the command line

You can set the parcels in your scene by running the npx update-parcels command in your scene folder. This is especially useful for large scenes, as you don't need to list every parcel involved.

Single parcel

Pass a single argument with the scene coords. This coordinate is also set as the base parcel.

npx update-parcels <parcel>

For example:

npx update-parcels 15,-26

Multiple parcels

Pass two arguments: the South-West and the North-East parcels. The South-West parcel is also set as the base parcel.

npx update-parcels <parcel> <parcel>

💡 Tip: The South-West parcel is always the one with the lowest numbers on both the X and Y coordinates.

For example:

npx update-parcels 15,-26 17,-24

This command generates a 3x3 scene, with its base parcel in 15,-26.

Customize Base Parcel

Pass three arguments: the South-West and the North-East parcels, and the parcel to use as a base parcel.

npx update-parcels <parcel> <parcel> <parcel>

📔 Note: The base parcel must be one of the parcels in the scene.

Non-square scenes

The above commands all generate rectangular-shaped scenes. Decentraland scenes can have L shapes or other configurations. You can generate a larger square with npx update-parcels and then manually remove excess parcels from the scene.json file.

📔 Note: The base parcel must be one of the parcels in the scene.

Skybox time of day

You can set a fixed time of day for your scene. All players will see the scene with this time of day, and the skybox will not follow the day/night cycle.

Open the scene settings and click on the Settings tab to find the Skybox section. Uncheck the Auto option and set the time of day you want.

You can also set the skybox time of day in your scene code. To do this, add the following section to your scene.json at root level:

 "skyboxConfig": {
    "fixedTime": 36000
  }

The number refers to the number of seconds since the start of the day, ranging from 0 (representing 00:00) to 86400 (representing 24:00). Any number higher than 86400 is also interpreted as midnight.

Here are some more examples of valid values:

0 seconds => 00:00
21600 seconds => 06:00
43200 seconds => 12:00
64800 seconds => 18:00
86400 seconds => 24:00

World configuration

When publishing to a Decentraland World, you can configure several World-specific settings in your scene.json file using the worldConfiguration object.

Basic World configuration

To publish to a World, you must specify the NAME or ENS domain in your scene.json:

{
	"worldConfiguration": {
		"name": "my-name.dcl.eth"
	}
}

The name specified can be either a Decentraland NAME or an ENS Domain and must be owned by the wallet signing the deployment (or by any wallet that has been given permission via Access Control Lists).

Communication service configuration

The fixedAdapter property indicates which Communication Service should be used by the scene. For the time being, only the offline:offline value is allowed. When set, the scene will have no Communication Service at all, and each user joining that world will always be alone. If not set, the Worlds content server will generate a proper value based on how it is configured.

{
	"worldConfiguration": {
		"name": "my-name.dcl.eth",
		"fixedAdapter": "offline:offline"
	}
}

Places listing configuration

All Worlds are automatically listed on the Places page unless you opt out. If you wish to opt-out from your Worlds being indexed in Places, you can add the following:

{
	"worldConfiguration": {
		"name": "my-name.dcl.eth",
		"placesConfig": {
			"optOut": true
		}
	}
}

Complete example

Here's a complete example with all World configuration options:

{
	"worldConfiguration": {
		"name": "my-name.dcl.eth",
		"fixedAdapter": "offline:offline",
		"placesConfig": {
			"optOut": true
		}
	}
}

See Publishing to Worlds for more information on deploying to Worlds.

Fetch metadata from scene code

Scene API Reference

You may need your scene's code to access fields from the scene metadata, such as the parcels the scene is deployed to, or the spawn point positions. This is especially useful for scenes that are meant to be replicated, or for code that is meant to be reused in other scenes. It's also very useful for libraries that need to know where the scene limits are.

To access this data, first import the getSceneInformation function:

import { getSceneInformation } from '~system/Runtime'

Then you can call the getSceneInformation() function, which returns a JSON object that includes most of the contents of the scene.json file. The example below shows how to access several of the more common fields from this function's response:

import { getSceneInformation } from '~system/Runtime'

executeTask(async () => {
  const sceneInfo = await getSceneInformation({})

  if (!sceneInfo) return
  console.log("SCENE INFO: ", sceneInfo)
})

📔 Note: getSceneInformation() needs to be run as an async function, since the response may delay a fraction of a second or more in returning data. Do not use the deprecated getSceneInfo() function.

The object returned by getSceneInformation() includes the following:

baseUrl: The base URL where the scene's content is hosted
content: An array with all the files of the scene, including their hash, that can be used together with the baseUrl to retrieve them.
metadataJson: The full contents of the scene's scene.json, as a string. You must parse this to obtain specific values.
urn: The unique urn for the scene as a whole.

The example below parses the contents from metadataJson to obtain values from properties in the scene.json file

import { getSceneInformation } from '~system/Runtime'

executeTask(async () => {
	const sceneInfo = await getSceneInformation({})

	if (!sceneInfo) return

	const sceneJson = JSON.parse(sceneInfo.metadataJson)
	const spawnPoints = sceneJson.spawnPoints
	const parcels = sceneJson.scene.parcels
	console.log({ parcels, spawnPoints })
})

PreviousScene Files NextSmart Wearables

Last updated 40 minutes ago

Metadata

Scene title, description, and image

Categories

Age Rating

Restricted Content

Feature Toggles

Spawn location

Spawn points in JSON

Required Permissions

Scene parcels

Set parcels via the command line

Skybox time of day

World configuration

Basic World configuration

Communication service configuration

Places listing configuration

Complete example

Fetch metadata from scene code