Quick Start for Unity - .NET SDK

Add NPM as a Scoped Registry

Before you can download and use Realm within your Unity project, you must add NPM as a scoped registry. Adding NPM as a scoped registry configures Unity to communicate with NPM, allowing you to install packages, such as Realm.

Open the Unity package manager by clicking the Window tab on the top of the Unity menu. Click Package Manager from the Window dropdown. Then, click the gear icon on the right-hand corner. Select the Advanced Project Settings option from the dropdown.

Fill out the scoped registry form with the details below and click the save button.

name = NPM
URL = https://registry.npmjs.org
Scope(s) = io.realm.unity

Add Realm to the Project Manifest

Now that Unity can install the Realm .NET SDK from NPM, you need to add Realm as a dependency in your project's manifest file. Open "Packages/manifest.json" file in Visual Studio or another text editor. At the bottom of the dependency's object, add the field, "io.realm.unity" and its value, the Realm .NET version number you want to use in quotes.

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

Remember to replace the <version-number> above with the actual version number. You can find the latest release version at the realm-dotnet GitHub repo. Your full manifest file should look something like the following:

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

When you save this file, Unity downloads the specified version of the Realm .NET SDK package from the NPM registry.

Verify the Realm Dependency and Check for Updates

To verify that the Realm package has been downloaded from NPM, open your Unity package manager by clicking the Window tab on the top of the Unity menu. Click Package Manager from the Window dropdown. You should see Realm on the "Packages: In Project" tab.

If you see a green check icon next to the version number of the Realm package, that means your package is up-to-date. However, if you see the up arrow icon, a new version of the package is available. Clicking it gives you the option to upgrade to the latest release.

Download the Latest Realm .NET SDK Release

Before you begin using Realm within your Unity project, you must download the Realm .NET SDK.

Navigate to the realm-dotnet repository releases page, and scroll down to the release you want to use in your project. If you are unsure of which release to use, you can use the one labeled "latest release" on the left row.

Scroll down to the "Assets" dropdown of the release and click the link labeled "io.realm.unity-<version-number>.tgz" to download the SDK.

Add the Tarball to Your Projects Package Manager

Move your downloaded Realm .NET SDK tarball inside of your project. You can do this by dragging and dropping the file into your project's folder. Copying the tarball to your project folder and committing it to version control ensures other developers working on the project can just clone the repository and build without manually downloading the Realm dependency.

Next, you must load the tarball into your project using the Unity package manager.

To open the package manager, click the Window tab on the top of the Unity menu. Click Package Manager from the Window dropdown. Once the package manager model opens, click the + icon in the top left corner of the model. Select the Add package from tarball... option.

Select your "io.realm.unity-bundled-<version-number>.tgz" file to begin importing your project.