Archivos de escena

Archivos predeterminados creados en una escena nueva.

Después de crear una nueva escenaarrow-up-right, la carpeta de la escena tendrá una serie de archivos con contenido predeterminado.

Archivos predeterminados en una escena

Las escenas incluyen los siguientes archivos:

  • src/index.ts: El punto de entrada de la escena.

  • scene.json: El manifiesto que contiene metadatos de la escena.

  • package.json y package-lock.json: Especifica las versiones de todas las dependencias de la escena.

  • tsconfig.json: Archivo de configuración de TypeScript.

  • .dclignore: Enumera los archivos de tu proyecto que no se subirán cuando publiques tu escena.

  • main-composite: Archivo auto-generado que incluye todo lo que añadiste y configuraste visualmente en el Scene Editor en Creator Hub. No está pensado para ser legible por humanos.

index.ts

Este es el punto de entrada al código personalizado de tu escena. Podrías poner toda la lógica de tu escena en este archivo, aunque para mayor claridad en la mayoría de los casos recomendamos distribuir tu código en varios otros .ts archivos.

Si te basas únicamente en el Scene Editor y Smart Itemsarrow-up-right, no necesitarás modificar este archivo.

Si intentas escribir código personalizado, lo más probable es que solo necesites editar este y otros archivos .ts para crear tu escena. Contiene el código que genera los entities, componentsarrow-up-right y systemsarrow-up-right de tu escena.

Al ejecutar la escena, el contenido de tus .ts archivos se compila en un único minificado .js archivo, bin/scene.js.

circle-exclamation

scene.json

El scene.json file es un manifiesto con formato JSON para una escena en el mundo. Una escena puede abarcar uno o varios LAND parcels. El scene.json manifiesto describe qué objetos existen en la escena, una lista de cualquier asset necesario para renderizarla, información de contacto del propietario del parcel y configuraciones de seguridad.

La mayoría de los campos en el scene.json file pueden editarse directamente en la UI del Scene Editor. Ver Scene Settingsarrow-up-right.



Para más información ver scene metadataarrow-up-right.

Todos estos metadatos son opcionales para previsualizar la escena localmente, pero parte de ellos es necesaria para desplegarla. Puedes cambiar esta información manualmente en cualquier momento.

package.json

Este archivo proporciona información a NPM que le permite identificar el proyecto, así como manejar las dependencias del proyecto. Las escenas de Decentraland requieren un paquete principal:

  • @dcl/sdk: La dependencia fundamental del SDK de Decentraland, incluyendo definiciones y tipos para el engine, componentes, systems, etc.

  • @dcl/js-runtime: Una serie de declaraciones de tipos que hace que la integración de @dcl/sdk sea más fluida.

Tu escena puede incluir cualquier número de otros paquetes, por ejemplo para incluir librariesarrow-up-right que pueden ayudar a facilitar la escritura de código, o habilitar funcionalidades especiales.

package-lock.json

Este archivo lista las versiones de todas las demás dependencias del proyecto. Estas versiones están bloqueadas, lo que significa que el compilador usará literalmente la misma release menor que aquí figura.

Puedes cambiar cualquier versión de paquete manualmente editando este archivo.

tsconfig.json

Los directorios que contienen un tsconfig.json file son directorios raíz para Proyectos TypeScript. El tsconfig.json file especifica los archivos raíz y las opciones necesarias para compilar tu proyecto de TypeScript a JavaScript.

Al instalar cualquier librería adicional en tu escena, una entrada debería agregarse automáticamente a este archivo. Para instalar las utilidades de Decentraland no debería ser necesario hacer cambios manuales en este archivo.

Ubicaciones recomendadas de archivos

Ten en cuenta que cuando despliegas tu escena en Decentraland, cualquier asset o librería externa que se necesite para usar tu escena debe estar empaquetada dentro de la carpeta de la escena o disponible desde un servidor remoto.

Todo lo que esté destinado a ejecutarse en el cliente del jugador debe ubicarse dentro de la carpeta de la escena. No deberías referenciar archivos o librerías que estén instalados en otra parte de tu máquina local, porque no estarán disponibles para la escena desplegada.

Sugerimos usar estos nombres de carpetas de forma consistente para almacenar los diferentes tipos de assets que tu escena pueda necesitar:

  • Modelos 3D: assets/scene/models

  • Videos: assets/scene/videos

  • Archivos de sonido: assets/scene/sounds

  • Archivos de imagen para texturas (excepto para modelos glTF): assets/scene/materials

  • .ts definiciones para components /src/components

  • .ts definiciones para systems /src/systems

circle-exclamation
circle-exclamation

Al importar cualquier asset vía el Scene Editor, se añaden automáticamente dentro de la carpeta assets/scene . Al usar cualquiera de los assets predeterminados en los Asset Packs del Scene Editor, sus archivos se agregan a la carpeta assets/builder .

El archivo dclignore

Todas las escenas incluyen un .dclignore file, este archivo especifica qué archivos en la carpeta de la escena se deben ignorar al desplegar una escena en Decentraland.

Por ejemplo, puede que quieras mantener los archivos de Blender para los modelos 3D en tu escena dentro de la carpeta de la escena, pero quieras evitar que esos archivos se desplieguen en Decentraland. En ese caso, podrías añadir *.blend a .dclignore para ignorar todos los archivos con esa extensión.

Qué ignorar
Ejemplo
Descripción

Archivos específicos

BACKUP.ts

Ignora un archivo específico

Carpetas

drafts/

Ignora el contenido completo de una carpeta y sus subcarpetas

Extensiones

*.blend

Ignora todos los archivos con una extensión determinada

Secciones de nombre

test*

Ignora todos los archivos cuyos nombres coincidan con la consulta. En este caso, que empiecen con test

Última actualización