Player Zero
  • Welcome
  • Integrations
    • Unity Integration
      • Deeplinking
      • Player Zero Lobby
      • 🎮 QuickStart Sample
    • Direct API Integration
Powered by GitBook
On this page
  • 📦 Importing the Sample
  • 🗺️ Running the Sample Scene
  • 🛠️ Assigning Your Avatar ID
Export as PDF
  1. Integrations
  2. Unity Integration

🎮 QuickStart Sample

PreviousPlayer Zero LobbyNextDirect API Integration

Last updated 13 days ago

The QuickStart Sample is included with the Player Zero Unity SDK to demonstrate how to use the SDK to load Ready Player Me avatars onto existing player prefabs in both First Person and Third Person setups.

This guide will help you:

  • Import the sample from Unity Package Manager

  • Open and run the sample scene

  • Customize the avatar by editing the Sample Avatar Loader component


📦 Importing the Sample

  1. Open your Unity project.

  2. In the Unity Editor toolbar, go to: Window > Package Manager

  3. Locate the Player Zero SDK package.

  4. Click the arrow to expand the package details.

  5. Scroll to the bottom and click Import into Project under QuickStart sample.

After import, you'll find the sample under:

Assets/Samples/Player Zero SDK/<version>/QuickStart/

🗺️ Running the Sample Scene

Once imported:

  1. Navigate to: Assets/Samples/Player Zero SDK/<version>/QuickStart/

  2. Open the appropriate sample scene:

    • FirstPerson/PlayerZeroFP.unity

    • ThirdPerson/PlayerZeroTP.unity

  3. Press Play in the Unity Editor.

You’ll see a player character with a Ready Player Me avatar loaded via our SDK.


🛠️ Assigning Your Avatar ID

To load your own avatar:

  1. Select the PlayerZeroAvatar GameObject in the scene hierarchy.

    • This may be named something like PlayerZeroAvatarFP , PlayerZeroAvatarTP

  2. In the Inspector, locate the Sample Avatar Loader component.

  3. Set the Avatar ID field to your personal or test avatar ID.

  4. Press Play again. The scene will load the avatar linked to the ID you provided.

✅ Tip: You can obtain an avatar ID by creating one via the Player Zero Avatar Creator or API.

Player Zero Third Person Character