Docs Menu
Docs Home
/ /
Kit de desarrollo de software .NET

Inicio rápido para Unity - SDK .NET

Esta página contiene información sobre cómo instalar e integrar Realm en su proyecto de Unity.

  • Unidad 2020.3.12f1 (LTS)

Nota

El SDK de Realm.NET puede ser compatible con otras versiones de Unity, pero 2020.3.12f1 (LTS) Es la versión que el equipo de Realm utiliza para pruebas y desarrollo. Recomendamos usar esta versión para garantizar que su proyecto funcione con Realm y que los pasos de instalación coincidan con los siguientes, ya que la interfaz de usuario de Unity suele cambiar entre versiones.

Realm ofrece varias maneras de instalar el SDK de Realm.NET para usarlo con Unity. Los desarrolladores de Unity con experiencia pueden encontrar intuitiva la instalación manual de Realm con un archivo tar. Sin embargo, recomendamos instalar el SDK de Realm.NET mediante npm, ya que este notifica las actualizaciones de versión a través del gestor de paquetes de Unity.

1

Antes de poder descargar y usar Realm en su proyecto de Unity, debe agregar NPM como registro con ámbito. Al agregar NPM como registro con ámbito, Unity se configura para comunicarse con NPM, lo que le permite instalar paquetes como Realm.

Abra el administrador de paquetes de Unity haciendo clic en el icono Window Pestaña en la parte superior del menú de Unity. Haga clic en Package Manager en Window dropdown. Luego, haga clic en el icono del engranaje en la esquina derecha. Seleccione la opción Advanced Project Settings en el menú desplegable.

Selecciona "Configuración Avanzada del Proyecto"

Rellena el formulario de registro específico con los detalles a continuación y haz clic en el botón guardar.

name = NPM
URL = https://registry.npmjs.org
Scope(s) = io.realm.unity
Descargue la última versión del SDK .NET
2

Ahora que Unity puede instalar el SDK de Realm.NET desde NPM, debe agregar Realm como dependencia en el archivo de manifiesto de su proyecto. Abra el archivo "Packages/manifest.json" en Visual Studio u otro editor de texto. En la parte inferior del objeto de la dependencia, agregue el campo "io.realm.unity" y su valor, el número de versión de Realm.NET que desea usar entre comillas.

"io.realm.unity": "<version-number>"

Recuerda reemplazar el <version-number> anterior con el número de versión. Puedes encontrar la última versión en el repositorio de GitHub realm-dotnet. Tu archivo de manifiesto completo debería ser similar a lo siguiente:

{
"dependencies": {
...
"io.realm.unity": "10.21.0"
},
"scopedRegistries": [
{
"name": "NPM",
"url": "https://registry.npmjs.org/",
"scopes": [
"io.realm.unity"
]
}
]
}

Cuando guarda este archivo, Unity descarga la versión especificada del paquete Realm .NET SDK del registro NPM.

3

Para verificar que el paquete Realm se haya descargado de NPM, abra el administrador de paquetes de Unity haciendo clic en la pestaña Window en la parte superior del menú Unity. Haga clic en Package Manager en el menú desplegable Window. Debería ver Realm en la pestaña "Packages: In Project".

Unity Realm instalado

Si ves un icono de marca de verificación verde junto al número de versión del paquete Realm, significa que tu paquete está actualizado. Sin embargo, si ves el icono de flecha hacia arriba, significa que hay una nueva versión del paquete disponible. Al hacer clic, te da la opción de actualizar a la versión más reciente.

1

Antes de comenzar a usar Realm dentro de tu proyecto de Unity, debes descargar el SDK de Realm .NET.

Vaya a la página de versiones del repositorio realm-dotnet y desplácese hasta la versión que desea usar en su proyecto. Si no está seguro de qué versión usar, puede usar la etiquetada como "última versión" en la fila izquierda.

Encuentre la última versión del SDK .NET

Desplázate hasta <version-number> el menú desplegable"Activos" de la versión y haz clic en el enlace etiquetado como"io.realm.unity-<versión-número>.tgz" para descargar el SDK.

Descargue la última versión del SDK .NET
2

Mueva el archivo comprimido del SDK de Realm .NET descargado dentro de su proyecto. Puede hacerlo arrastrando y soltando el archivo en la carpeta de su proyecto. Copiar el archivo comprimido a la carpeta de su proyecto y enviarlo al control de versiones garantiza que otros desarrolladores que trabajen en el proyecto puedan clonar el repositorio y compilar sin tener que descargar manualmente la dependencia de Realm.

A continuación, debes cargar el archivo tar en tu proyecto utilizando el administrador de paquetes de Unity.

Para abrir el administrador de paquetes, haga clic en la pestaña Window en la parte superior del menú de Unity. Haga clic en Package Manager en Window dropdown. Una vez abierto el modelo del administrador de paquetes, haga clic en el icono + en la esquina superior izquierda del modelo. Seleccione la opción Add package from tarball....

Agregar paquete desde el archivo tarball de Unity UI

Seleccione su archivo "io.realm.unity-bundled-.tgz" para comenzar<version-number> a importar su proyecto.

Cree un script de C# o use uno que ya haya creado. Abra ese script en Visual Studio u otro editor de texto y agregue la siguiente línea para importar su paquete de Realm:

using Realms;

Al desarrollar con el SDK de Realm.NET, los métodos de la API son los mismos independientemente de si se usa Unity u otra plataforma. Sin embargo, dado que Unity tiene algunas restricciones de scripting, se deben tener en cuenta las siguientes consideraciones adicionales al desarrollar el proyecto:

Unity realiza la eliminación de código administrada, descartando el código no utilizado de una compilación para reducir el tamaño binario. Esto puede generar problemas al deserializar BSON en clases de C#. En plataformas que usan IL2CPP, como iOS, la eliminación de código administrada está habilitada por defecto. Al trabajar con BSON, use el atributo [Preserve] para evitar la eliminación de código administrada en propiedades de tipo que solo se rellenan con el serializador. Dado que estas propiedades usan reflexión, Unity no puede inferir estáticamente que se usa el establecedor de propiedades. Esto significa que, a menos que aplique,[Preserve] attribute Unity eliminará esas propiedades. Para ver ejemplos de cuándo puede realizar la deserialización de BSON, consulte la documentación "Consultar MongoDB" y "Llamar a una función".

No se puede acceder al SDK de Realm.NET desde los eventos AppDomain.DomainUnload ni Application.quitting. Esto significa que no se pueden escribir datos en un Realm mientras la aplicación del reproductor se está cerrando. Si necesita almacenar datos justo antes de que la aplicación cierre, considere usar el evento Application.wantsToQuit.

Nota

Problema conocido al desarrollar con Unity en Windows

En Windows, si usas Sincronización de dispositivos, tu proyecto podría bloquearse al ejecutar varias instancias, ya que varios procesos intentan acceder al mismo dominio sincronizado. Si usas un dominio local, puedes ejecutar varias instancias de tu proyecto sin bloquearse.

La comunidad de Realm ha creado muchos proyectos que demuestran el uso del SDK .NET de Realm. ¡Consulta los ejemplos a continuación que demuestran el uso del SDK .NET de Realm con Unity!

Nota

El equipo de documentación de MongoDB no mantiene directamente estos ejemplos.

Volver

Kit de desarrollo de software .NET

En esta página