👩‍💻Getting Started with the SDK

Learn how to install the URT3D SDK in Unity using the Package Manager and verify your setup with working sample assets.

▶️ Watch the Video Guide: Step 4 – Import the URT3D SDK via Git URL

---

The URT3D SDK provides a complete runtime environment for loading, displaying, and interacting with .urta assets in Unity. It supports traits, scripting, and asset-level metadata — all accessible via code or Inspector.

This guide will walk you through installing the SDK in Unity and confirming that your setup works.

📘 Looking for detailed implementation docs? This page gives you a high-level overview, but you can always dive deeper in the official SDK documentation on GitHub: urt3d-sdk_unity › Documentation

---

🔹 Step 1: Install the SDK in Unity

The URT3D SDK is delivered via Git. Unity 2021.3+ is recommended.

1. Open your Unity project

2. Go to Window > Package Manager

3. Click the ➕ dropdown and choose “Add package from Git URL…”

4. Paste the following: https://github.com/URT3D/urt3d-sdk_unity.git

5. Click Add and wait for the package to import

Once installed, you’ll see URT3D folders in your Project and Packages directories.

🎬 Watch the Installation Process

🔹 What the SDK Includes

Based on the official SDK documentation, the SDK includes:

✔️ Core Classes

• Urt3d.Asset: The main runtime representation of a .urta asset

• Urt3d.Wrapper: MonoBehaviour that connects URT3D assets to GameObjects

• Urt3d.Actor: The visual GLB/GLTF model

• Urt3d.Metadata: Includes GUIDs, names, and type information

• Urt3d.Preview: Thumbnail preview for UI or asset browsers

✔️ Trait System

Traits are modular behaviors attached to assets. Built-in traits include:

• TraitPosition3d – Controls position in 3D space

• TraitRotation3d – Handles local or global rotation

• TraitScale3d – Controls uniform and non-uniform scale

• TraitAnimatable – Enables playback of animation clips

• TraitInteractable – Handles user input like clicks or hover

Access traits in code like this:

var position = asset.GetTrait<TraitPosition3d>();
position?.SetValue(new Vector3(0, 1, 0));

✔️ MiniScript Scripting Engine

Add dynamic behavior with embedded scripting:

• Trigger types: OnLoad, OnUpdate, OnCustomEvent

• Call functions on traits

• Communicate between assets via events

• Write in lightweight, human-readable syntax

Scripts are stored directly within .urta files and executed at runtime via the URT3D script engine.

---

🔹 Step 2: Verify the Installation

After installation, confirm the SDK is working:

1. Open the URT3D Settings Panel

2. Log in using your URT3D credentials

3. Click Generate App Key

4. Confirm the App Key is visible and saved

🎬 Watch this process in Step 5 – Launch Your First URT3D Asset

---

🔹 Step 3: Load a Sample Asset

To test if everything is wired up correctly:

1. Locate a sample .urta file in the SDK

2. Drag the .urta into your Unity Project tab

3. Drag the asset into the Hierarchy

4. Enter Play Mode and verify:

   • The model appears

   • Traits are listed in the Inspector

   • Scripts (if present) run on load

---

💬 Questions?

🗨️ Join our Discord creator community 📩 Email: [e-mail]