Bounce Docs
  • Overview
    • ๐Ÿ‘‹Welcome to Bounce
  • Product Guides
    • ๐Ÿท๏ธLink - Authentic Phygitals
      • ๐Ÿ”ขLink Tag variants
    • ๐ŸŒFlex - Fan Experiences
      • ๐Ÿ”ŒSupported Platform
    • ๐Ÿ”ŽTrack - Metaverse Analytics
  • ๐Ÿ› ๏ธIntegration Guides
    • ๐Ÿ‘‹Integration Overview
    • ๐Ÿ“ฑWeb Portal
      • โน๏ธExperience Blocks
    • ๐Ÿ”—APIs & SDKs
      • Web notifications & forwarding
      • REST API
        • โ„น๏ธAPI Overview
        • ๐Ÿท๏ธLink API
        • ๐ŸŒFlex API
        • ๐ŸคPartner API
      • Bounce SDK
        • ๐ŸŒJavaScript (Web & RN)
        • ๐Ÿ‘พUnity (iOS & Android)
        • ๐Ÿค–Roblox
    • ๐Ÿ“ƒOn-chain Interface
    • ๐Ÿ›’E-commerce plugins
    • ๐Ÿค–Platform-specific guides
  • Partner Info
    • ๐ŸงพPlans & Pricing
    • ๐Ÿ“Brand Guidelines
    • โ”Help & Support
Powered by GitBook
On this page
  • Overview
  • Installation & Setup
  • Installation
  • Configuration
  • Usage & Components
  • Bounce Controller Configuration
  • Bounce Controller Event Handlers
  • Bounce Controller API

Was this helpful?

  1. Integration Guides
  2. APIs & SDKs
  3. Bounce SDK

Unity (iOS & Android)

Bring phygital experiences and collectibles directly into your game

PreviousJavaScript (Web & RN)NextRoblox

Last updated 1 year ago

Was this helpful?

Unity SDK extended platform support

The Bounce Unity SDK is currently designed for mobile platforms only.

A future update will support desktop environments, using our upcoming Universal Handover technology that simplifies phygital claims from mobile to desktop and console games.

For early access to new Unity SDK features, please contact us at support@letsbounce.gg

Overview

The Bounce Unity SDK enables easy integration with Bounce Link & Flex, powering in-game phygital content & experiences and hype-driving sharable achievements.

Bring more users and revenue into your game with connected collectibles, and drive IP and title awareness with one-tap exclusive sharable moments!

With the Bounce SDK you can:

  • Create Amiibo-like collectible-linked exclusive DLCs, wearables and avatars.

  • Unlock sharable achievements and moments with one-of-a-kind, customized stickers and emotes.

  • Offer cross-platform digital collectibles available between games, SNS and metaverse platforms.

Installation & Setup

The Bounce Unity SDK is currently only available to approved partners, to gain access to the package please contact support@letsbounce.gg

Installation

The Bounce Unity SDK is available as a downloadable Unity package or for installation via the Unity package manager.

Using the package manager is the preferred method of installation as updates are delivered automatically.

Once installed, the Bounce SDK components for Link & Flex will be available in the Unity editor.

The package includes:

  • SDK scripts - Components for easy setup of the Link & Flex SDKs.

  • script example - Reference implementations for using phygital collectibles and sharable assets.

  • scene examples - A basic playable scene with an end-to-end demo of Link & Flex implementation.

External dependencies

Both EDM4U and all external dependencies should be installed automatically. If you run any issues or installation error, please make sure your platform runtime (XCode for iOS and Android Studio for Android) is up-to-date and correctly configured for Unity builds.

If issues persist, please contact us at support@letsbounce.gg

Configuration

Mobile deep-links

In order to use your Unity mobile app or game with Bounce's Secure Forwarding and phygital link, please be sure to correctly configure a deep link for your project.

It is preferred to set up a verified Universal Link on iOS and App Link on Android, which allow Bounce to detect if the app is installed during launch, and fall back to a rich web experience that prompts for a download and previews the assets

To set up deep links for your project please refer to the following guides:

The Bounce SDK relies on the /bounce route path to manage phygital claims and activations, please avoid using it in other parts of your game and code.

Usage & Components

To use the Bounce SDK in a Unity project, add the Bounce Controller script to a new GameObject in your launch scene.

Bounce Controller Configuration

Project auto-configuration

Most of the configuration of the Bounce SDK happens on the Bounce platform, as phygital assets, connected experiences, and branding assets may change and update through the lifetime of your game.

Each Bounce project, including Link tag batches and Flex connections, is associated with an API key, and the SDK automatically pulls the latest configuration when an app is loaded at runtime.

Future versions of the SDK will offer better support for testing both Link and Flex features in-editor.

General settings

Property
Description

Keep alive between scenes

Please note that for this to work, the GameObject must be top-level in the scene, and all other attached GameObjects will persist between scenes as well.

It is recommended to initialize the Bounce SDK on a separate, top-level game object.

Project API key

Your project's API key available on the Bounce admin dashboard.

As mentioned previously, this API key tells the SDK which project is connected to your app, and will automatically configure Link tag validation, Flex connections and styling & branding for the Web Portal.

Bounce Link settings

Property
Description

URL scheme

This is the URL scheme configured for iOS and Android deeplinks.

Auto-validate tags

Automatically validate the authenticity and ownership of any tapped tag. If enabled, this data will be available to the tap event callback.

Listen for taps (Android only)

Always listen for Link Tag taps while the app is running, and not only when called by the API. This property has no effect on iOS

Allow offline taps

Allow offline validation of tags using an "authenticity only" method.

This allows games to verify that a phygital asset is authentic even without an internet connection.

Ownership verification is not available in offline mode.

Bounce Flex settings

Property
Description

Preload Web Portal

Preload the Bounce Web Portal in a background hidden component, to prevent long loading times and when experience or asset claim is activated.

Auto-claim assets

Automatically claim an asset and generate an activation token or link when a Flex asset is created.

Event handlers

Event
Description

On Link Tag Tapped

The event is triggered when an NFC tag is tapped and confirmed as an authentic Link Tag phygital collectible. If Auto-validate Tags is enabled on the controller, this event will only fire once a ownership validation request is completed.

On Flex Asset Claimed

This event is triggered when a Flex asset is claimed by the current user in the game, allowing you to highlight the claim with an in-game notification. Once a Flex asset is claimed, its connected experience could immediately be activated, either directly or via the Web Portal.

Bounce Controller Event Handlers

Bounce Unity SDK event handler documentation is coming soon

Bounce Controller API

Bounce Unity SDK Controller API documentation is coming soon

The Bounce Unity SDK depends on some platform-specific external pacakges for iOS and Android to manage communication with NFC readers on mobile devices. We use UPM (Unity Package Manager) to automatically bundle and install (External Dependency Manager for Unity).

Toggle this option if your game spans multiple scenes. It'll call Unity's hook to keep the GameObject the SDK is attached to active between scene changes.

๐Ÿ› ๏ธ
๐Ÿ”—
๐Ÿ‘พ
Follow the instructions on Unity's docs on how to install a package from a git URL
EDM4U
Deep linking on iOS
Deep linking on Android
DontDestroyOnLoad
Bounce SDK Controller