Decentraland Avatars are on the way! Sign up now to be the first in line, and get early access to Decentraland
X
Hello! Please choose your
desired language:
Dismiss

Files in a scene

After [creating a new scene(https://docs.decentraland.org/#create-your-first-scene) using the CLI, the scene folder will have a series of files with default content.

Default files in a local scene

Scenes include the following files:

  • src/game.ts: The entry point of the scene.
  • scene.json: The manifest that contains metadata for the scene.
  • package.json and package-lock.json: Specify the versions of all dependencies of the scene.
  • tsconfig.json: Typescript configuration file.
  • .dclignore: Lists what files in your project not to deploy to IPFS.

game.ts

This is the entry point to your scene’s code. You could fit your entire scene’s logic into this file, although for clarity in most cases we recommend spreading out your code over several other .ts files and importing them into game.ts.

In most cases, you’ll only need to edit this file to create your scene. It contains the code that generates an entity tree, which is what end users of your parcel will see.

Below is a basic example of a game.ts file:

// Create a component group to track entities with Transition components
let group = engine.getComponentGroup(Transform)

// Create a system
export class RotatorSystem {
  // The update() function runs on every frame.
  update() {
    // Cycle over the entities in the component group
    for (let entity of group.entities) {
      const transform = entity.getComponent(Transform)
      transform.rotation.y += 2
    }
  }
}

// Create an entity
const cube = new Entity()

// Add a cube shape to the entity
cube.addComponent(new BoxShape())

// Add a transform component to the entity
cube.addComponent(new Transform({
  position: new Vector3(5, 0, 5)
}))

// Add the entity to the engine
engine.addEntity(cube)

// Add the system to the engine
engine.addSystem(new RotatorSystem())

scene.json

The scene.json file is a JSON formatted manifest for a scene in the world. A scene can span a single or multiple LAND parcels. The scene.json manifest describes what objects exist in the scene, a list of any assets needed to render it.

contact information for the parcel owner, and security settings. For more information and an example of a scene.json file, please visit the Decentraland specification proposal.

All of this metadata is optional for previewing the scene locally, but part of it is needed for deploying. You can change this information manually at any time.

package.json

This file provides information to NPM that allows it to identify the project, as well as handle the project’s dependencies. Decentraland scenes need two packages:

  • decentraland-api: allows the scene to communicate with the world engine.
  • typescript: used to compile the file game.ts to javascript.

package-lock.json

This file lists the versions of all the other dependencies of the project. These versions are locked, meaning that the compiler will use literally the same minor release listed here.

You can change any package version manually by editing this file.

tsconfig.json

Directories containing a tsconfig.json file are root directories for TypeScript Projects. The tsconfig.json file specifies the root files and options required to compile your project from TypeScript into JavaScript.

You can use another tool or language instead of TypeScript, so long as your scripts are contained within a single Javascript file (scene.js). All provided type declarations are made in TypeScript, and other languages and transpilers are not officially supported.

Keep in mind that when you deploy your scene to Decentraland, any assets or external libraries that are needed to use your scene must be either packaged inside the scene folder or available via a remote server.

Anything that is meant to run in the user’s client must located inside the scene folder. You shouldn’t reference files or libraries that are installed elsewhere in your local machine, because they won’t not be available to the deployed scene.

We suggest using these folder names consistently for storing the different types of assets that your scene might need:

  • 3d models: /models
  • Videos: /videos
  • Sound files: /sounds
  • Image files for textures (except for glTF models): /materials
  • .ts definitions for components /src/components
  • .ts definitions for systems /src/systems

Note: Supporting files for glTF models, like their texture image files or .bin files, should always be placed in the same folder as the model’s .gltf or .glb file.

The dclignore file

All scenes include a .dclignore file, this file specifies what files in the scene folder to ignore when deploying a scene to Decentraland.

For example, you might like to keep the Blender files for the 3D models in your scene inside the scene folder, but you want to prevent those files from being deployed to Decentraland. In that case, you could add *.blend to .dclignore to ignore all files with that extension.

What to ignore Example Description
Specific files BACKUP.ts Ignores a specific file
Folders drafts/ Ignores entire contents of a folder and its subfolders
Extensions *.blend Ignores all files with a given extension
Name sections test* Ignores all files with names that match the query. In this case, that start with test