Multijugador serverless

Sincroniza el estado de la escena entre jugadores.

Decentraland ejecuta las escenas localmente en el navegador de un jugador. Por defecto, los jugadores pueden verse entre sí e interactuar directamente, pero cada jugador interactúa con el entorno de forma independiente. Los cambios en el entorno no se comparten entre jugadores por defecto.

Ver el mismo contenido en el mismo estado es extremadamente importante para que los jugadores interactúen de maneras más significativas.

Hay tres maneras de sincronizar el estado de la escena, para que todos los jugadores vean lo mismo:

• Marcar una entidad como sincronizada: La opción más fácil. Ver Entidad marcada como sincronizada

• Enviar mensajes explícitos con MessageBus: Enviar y escuchar manualmente mensajes específicos. Ver Enviar mensajes explícitos con MessageBus

• Usar un servidor: Ver servidores de terceros. Esta opción es más complicada de configurar, pero es recomendable si los jugadores tienen incentivos para explotar tu escena.

Las dos primeras opciones se cubren en este documento. Son más simples, ya que no requieren servidor. La desventaja es que dependes más de las velocidades de conexión de los jugadores, y el estado de la escena no se persiste cuando todos los jugadores abandonan la escena.

Marcar una entidad como sincronizada

En el Creator Hub, marca una entidad como sincronizada añadiendo un Multiplayer component a la misma. Incluye una casilla de verificación para cada uno de los otros componentes en la entidad, lo que te permite seleccionar cuáles actualizar.

Para marcar una entidad como sincronizada vía código, usa la syncEntity función:

import { syncEntity } from '@dcl/sdk/network'

const doorEntity = engine.addEntity()

syncEntity(doorEntity, [Transform.componentId, Animator.componentId], 1)

La syncEntity función toma las siguientes entradas:

• entityId: Una referencia a la entidad que se debe sincronizar

• componentIds: Una lista de los componentes que necesitan ser sincronizados desde esa entidad. Esto es un arreglo que puede contener tantos elementos como sea necesario. Todos los valores deben ser componentId propiedades.

• entityEnumId: (opcional) Un id único que se usa de forma consistente por todos los jugadores, ver Acerca del enum id.

No todas las entidades o componentes necesitan ser sincronizados. Elementos estáticos como un árbol que permanece en el mismo lugar no requieren sincronización. En las entidades que sí sincronices, solo los componentes que cambian con el tiempo deben ser sincronizados. Por ejemplo, si un cubo cambia de color al hacer clic, solo deberías sincronizar el componente Material, no el MeshRenderer ni el Transform, ya que esos nunca cambiarán.

💡 Consejo: Si los datos que quieres compartir no existen como un componente, define un custom component que contenga esos datos.

Acerca del enum id

La entityEnumId de una entidad debe ser único. No está relacionado con el entityId local asignado en engine.addEntity(), ese se genera automáticamente y puede variar entre jugadores que ejecutan la misma escena. El entityEnumId de una entidad debe definirse explícitamente en el código y ser único.

Establecer explícitamente este ID es importante para evitar inconsistencias si una condición de carrera hace que una parte de la escena se cargue antes que otra. Quizá para el jugador A la puerta en la escena sea la entidad 512, pero para el jugador B esa misma puerta sea la entidad 513. En ese caso, si el jugador A abre la puerta, el jugador B en su lugar ve todo el edificio moverse.

💡 Consejo: Crea un enum en tu escena, para mantener referencias claras a cada id sincronizable en tu escena.

import { syncEntity } from '@dcl/sdk/network'

enum EntityEnumId {
	DOOR = 1,
	DRAW_BRIDGE = 2,
	ELEVATOR = 3,
}

syncEntity(
	doorEntity,
	[Transform.componentId, Animator.componentId],
	EntityEnumId.DOOR
)

Aquí el enum EntityEnumId se usa para etiquetar entidades con un identificador único, asegurando que cada cliente reconozca la entidad modificada, independientemente del orden de creación.

📔 Nota: Evita usar números que sean mayores que 8001 si tu escena también incluye Smart Items. Los ítems que son creados por el Creator Hub con un Multiplayer component usarán IDs asignados automáticamente a partir de 8001. Cualquier ID inferior a 8001 es seguro para asignar a tus entidades sincronizadas.

Entidades creadas por un jugador

Si una entidad se crea como resultado de una interacción del jugador, y esta entidad debe sincronizarse con otros jugadores, la entidad no necesita un entityEnumId. Puedes usar syncEntity() pasando solo la entidad y la lista de componentes. Un valor único para entityEnumId se asigna automáticamente tras bambalinas.

Todas las entidades instanciadas en la iniciación de la escena necesitan tener un ID asignado manualmente. Eso es para asegurar que todos los jugadores usen el mismo ID en cada una. Cuando un solo jugador está a cargo de instanciar una entidad, los IDs explícitos no son necesarios. Los demás jugadores reciben actualizaciones sobre esta nueva entidad con un ID ya asignado, por lo que no hay riesgo de desajustes de ID.

Por ejemplo, en una escena de pelea de bolas de nieve, cada vez que un jugador lanza una bola de nieve, está instanciando una nueva entidad que se sincroniza con otros jugadores. La bola de nieve no necesita un entityEnumId único.

import { syncEntity } from '@dcl/sdk/network'

function onThrow() {
	const ball = engine.addEntity()
	Transform.create(ball, {})
	GLTFContainer.create(ball, { src: 'assets/snowBall.glb' })
	syncEntity(ball, [Transform.componentId, GLTFContainer.componentId])
}

Entidades con padre

El padre de una entidad normalmente se define vía la parent propiedad en el Transform componente. Sin embargo, esta propiedad apunta al id de entidad local del padre, que podría variar, ver Acerca del enum id. Para parentar entidades que necesitan ser sincronizadas, o que tienen hijos que necesitan ser sincronizados, usa la parentEntity() función en lugar de la Transform.

import { syncEntity, parentEntity } from '@dcl/sdk/network'

const parent = engine.addEntity()
Transform.create(parent, { position: somePosition })
syncEntity(parent, [])

const child: Entity = engine.addEntity()
syncEntity(child, [Transform.componentId])

parentEntity(child, parent)

Ten en cuenta que tanto el padre como el hijo se sincronizan con syncEntity, así que todos los jugadores tienen un entendimiento común de qué ids son usados por ambas entidades. Esto es necesario incluso si los componentes del padre pueden nunca necesitar cambiar. En este ejemplo, el syncEntity incluye un arreglo vacío de componentes, para evitar sincronizar componentes innecesarios.

📔 Nota: Si una entidad tiene como padre tanto el parentEntity() como también el parent propiedad en el Transform componente, la propiedad en el Transform componente se ignora.

Cuando las entidades tienen padre vía la parentEntity() función, también puedes hacer uso de las siguientes funciones auxiliares:

• removeParent(): Deshacer los efectos de parentEntity(). Requiere que pases solo la entidad hijo. El nuevo padre de la entidad se convierte en la entidad raíz de la escena. La entidad padre original no se elimina de la escena.

• getParent(): Devuelve la entidad padre de la entidad que pasaste.

• getChildren(): Devuelve la lista de hijos de la entidad que pasaste, como iterable.

• getFirstChild(): Devuelve el primer hijo en la lista para la entidad que pasaste.

import { syncEntity, parentEntity } from '@dcl/sdk/network'

const parent = engine.addEntity()
Transform.create(parent, { position: somePosition })
syncEntity(parent, [])

const child: Entity = engine.addEntity()
syncEntity(child, [Transform.componentId])

// establece parent como padre
parentEntity(child, parent)

// getParent
const getParentResult = getParent(child)
// devuelve parent

// getFirstChild
const getFirstChildResult = getFirstChild(parent)
// devuelve child

// getChildren
const getChildrenResult = Array.from(getChildren(parent))
// devuelve [child]

// elimina parent del child
removeParent(child)

Comprobar el estado de sincronización

Cuando un jugador acaba de cargar una escena, puede que aún no esté sincronizado con otros jugadores que lo rodean. Si el jugador empieza a alterar el estado del juego antes de estar sincronizado, esto podría causar problemas en tu juego. Recomendamos siempre comprobar que un jugador esté sincronizado antes de permitirle editar cualquier cosa de la escena.

Si un jugador sale de los parcels de la escena, también estará fuera de sincronización con la escena mientras esté fuera. Por lo tanto, es importante que los sistemas de la escena manejen ese escenario, ya que la escena sigue ejecutándose mientras el jugador está cerca. Una vez que el jugador vuelva a entrar, se actualiza automáticamente con cualquier cambio del estado de la escena.

Puedes comprobar si el estado de la escena está actualmente sincronizado para un jugador mediante la isStateSyncronized() función. Esta función devuelve un booleano, que es verdadero si el jugador ya está sincronizado con la escena.

import { isStateSyncronized } from '@dcl/sdk/network'

const isConnected = isStateSyncronized()

Podrías, por ejemplo, incluir esta comprobación en un sistema y bloquear cualquier interacción si esta función devuelve false.

import { isStateSyncronized } from '@dcl/sdk/network'

engine.addSystem(() => {
	if (isStateSyncronized() && !button.enabled) {
		console.log('Enable Start Game')
		button.enable()
	}

	if (!isStateSyncronized() && button.enabled) {
		console.log(`Disable Start Game.`)
		button.disable()
	}
})

Enviar mensajes explícitos con MessageBus

Iniciar un message bus

Crea un objeto message bus para manejar los métodos que se necesitan para enviar y recibir mensajes entre jugadores.

import { MessageBus } from '@dcl/sdk/message-bus'

const sceneMessageBus = new MessageBus()

Enviar mensajes

Usa el .emit comando del message bus para enviar un mensaje a todos los demás jugadores en la escena.

import { MessageBus } from '@dcl/sdk/message-bus'

const sceneMessageBus = new MessageBus()

const myEntity = engine.addEntity()
MeshRenderer.setBox(myEntity)
MeshCollider.setBox(myEntity)

pointerEventsSystem.onPointerDown(
	{
		entity: myEntity,
		opts: { button: InputAction.IA_PRIMARY, hoverText: 'Click' },
	},
	function () {
		sceneMessageBus.emit('box1Clicked', {})
	}
)

Cada mensaje puede contener una carga útil como segundo argumento. La carga útil es de tipo Object, y puede contener cualquier dato relevante que desees enviar.

import { MessageBus } from '@dcl/sdk/message-bus'

const sceneMessageBus = new MessageBus()

sceneMessageBus.emit('spawn', { position: { x: 10, y: 2, z: 10 } })

💡 Consejo: Si necesitas que un único mensaje incluya datos de más de una variable, crea un tipo personalizado para contener todos esos datos en un solo objeto.

Recibir mensajes

Para manejar mensajes de todos los demás jugadores en esa escena, usa .on. Al usar esta función, proporcionas una cadena de mensaje y defines una función a ejecutar. Cada vez que llega un mensaje con una cadena coincidente, la función dada se ejecuta una vez.

import { MessageBus } from '@dcl/sdk/message-bus'

const sceneMessageBus = new MessageBus()

type NewBoxPosition = {
	position: { x: number; y: number; z: number }
}

sceneMessageBus.on('spawn', (info: NewBoxPosition) => {
	const myEntity = engine.addEntity()
	Transform.create(myEntity, {
		position: { x: info.position.x, y: info.position.y, z: info.position.z },
	})
	MeshRenderer.setBox(myEntity)
	MeshCollider.setBox(myEntity)
})

📔 Nota: Los mensajes que son enviados por un jugador también son recibidos por ese mismo jugador. El .on método no puede distinguir entre un mensaje que fue emitido por ese mismo jugador y un mensaje emitido por otros jugadores.

Ejemplo completo de MessageBus

Este ejemplo usa un message bus para enviar un nuevo mensaje cada vez que se hace clic en el cubo principal, generando un nuevo cubo en una posición aleatoria. El mensaje incluye la posición del nuevo cubo, para que todos los jugadores vean esos nuevos cubos en las mismas posiciones.

import { MessageBus } from '@dcl/sdk/message-bus'

/// --- Crear message bus ---
const sceneMessageBus = new MessageBus()

// Fábrica de cubos
function createCube(x: number, y: number, z: number): Entity {
	const meshEntity = engine.addEntity()
	Transform.create(meshEntity, { position: { x, y, z } })
	MeshRenderer.setBox(meshEntity)
	MeshCollider.setBox(meshEntity)

	// Cuando se hace clic en un cubo, enviar mensaje para generar otro
	pointerEventsSystem.onPointerDown(
		{
			entity: myEntity,
			opts: { button: InputAction.IA_PRIMARY, hoverText: 'Press E to spawn' },
		},
		function () {
			sceneMessageBus.emit('spawn', {
				position: {
					x: 1 + Math.random() * 8,
					y: Math.random() * 8,
					z: 1 + Math.random() * 8,
				},
			})
		}
	)

	return meshEntity
}

// Init
createCube(8, 1, 8)

// definir tipo de datos
type NewBoxPosition = {
	position: { x: number; y: number; z: number }
}

// al recibir mensaje de spawn, crear nuevo cubo
sceneMessageBus.on('spawn', (info: NewBoxPosition) => {
	createCube(info.position.x, info.position.y, info.position.z)
})

Probar una escena multijugador localmente

Si lanzas una vista previa de la escena y la abres en dos (o más) ventanas diferentes del Explorer, cada ventana abierta se interpretará como un jugador separado, y un servidor de comunicaciones simulado mantendrá a estos jugadores sincronizados.

Interactúa con la escena en una ventana, luego cambia a la otra para ver que los efectos de esa interacción también son visibles allí.

Usando el Creator Hub, haz clic en el botón Preview una segunda vez, y eso abre una segunda ventana del Explorer de Decentraland. Debes conectar en ambas ventanas con direcciones diferentes. Las mismas sesiones permanecerán abiertas mientras la escena se recarga.

Como alternativa, puedes abrir una segunda ventana del Explorer de Decentraland escribiendo lo siguiente en la URL del navegador:

decentraland://realm=http://127.0.0.1:8000&local-scene=true&debug=true&open-deeplink-in-new-instance=true

Escenas para un solo jugador

Si tu escena está desplegada en un Decentraland World, puedes convertirla en una escena para un solo jugador. Los jugadores no se verán entre sí, no podrán chatear ni ver los efectos de las acciones de los demás.

Para hacer esto, configura el scene.json archivo para establecer el fixedAdapter en offline:offline. La escena no tendrá ningún Communication Service y cada usuario que se una a ese world siempre estará solo.

Ejemplo:

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