Introduction

This document will help you to integrate your content with the VIVEPORT platform.

The usage of VIVEPORT SDK must include the following packages:

  1. VIVEPORT SDK
  2. VIVEPORT Desktop (For Windows) / VIVE Focus (For Android)
  3. ViveportSwitch Tool (For Windows Arcade development)

Before you publish your content to VIVEPORT, you can use the following features in your content if you integrate the VIVEPORT SDK into your content:

  1. Top Level
  2. DRM (Digitial Rights Management)
  3. Session Token
  4. User Profile
  5. IAP (In-App Purchase)
  6. DLC (Downloadable Content)
  7. Stats & Achievements
  8. Leaderboards

How Does the Client-Side SDK Work?

  1. Users need to log in VIVEPORT Desktop by using their HTC Account (the account has owned this content) before launching the content. Please see below Fig.1 and Fig.2.

Fig1: Find the VIVEPORT icon on your desktop.

_images/ViveportClient_Icon.png

Fig2: Log in your account or developer account owns the content.

_images/ViveportClient.png
  1. With the VIVEPORT SDK, the launched content can send a request to the VIVEPORT cloud services via VIVEPORT Desktop or Viveport App to check the user’s profile and licenses.
  2. The VIVEPORT cloud services return the user’s profile and licenses to client-side SDK for processing or verifying.
  3. The launched content may interact with the user through the user’s profile in VIVEPORT, or just check whether the user owns the content.

VIVEPORT ID and VIVEPORT Key

The VIVEPORT SDK uses VIVEPORT ID and VIVEPORT Key to communicate with the VIVEPORT platform.

Please see the screenshot below, VIVEPORT ID and VIVEPORT Key is on the VIVEPORT Listing page.

_images/AppID.png
  1. Before content can be published to VIVEPORT, the content must have a unique VIVEPORT ID and VIVEPORT Key.
  2. The VIVEPORT ID and VIVEPORT Key can be requested from the VIVEPORT developer portal at https://developer.viveport.com/console.
  3. The VIVEPORT ID and VIVEPORT Key must be included in the authentication script before attempting to publish the content on VIVEPORT.

System Requirements

  • Software Requirements
    • Unity 5.x for Windows (32/64-bit)
    • Unreal Engine 4.x for Windows (64-bit, Visual Studio 2013)
    • VIVEPORT Desktop - You can download whole Vive Software since it includes VIVEPORT Desktop.
    • VIVEPORT M - You can download whole Vive App from your Android.
  • Runtime Environment
    • For Windows, standalone applications for Windows 7/8/10 (32/64-bit) are supported.
    • For Android, standalone app from Android version 4.1 with Gyroscope (minimum) to Android version 6 or later with 4G RAM and 1440p resolution (high standard) are supported.

SDK Usage Outline

Before publishing your content to VIVEPORT, you can (and should) check if the DRM license generated from VIVEPORT cloud services is valid, and then test whether other SDK functions work. The steps below outline the process of integrating the VIVEPORT SDK.

For Unity user:

  1. Create or import your content into Unity
  2. Download and install the VIVEPORT SDK
  3. Integrate the VIVEPORT SDK into your content in Unity

For Unreal user:

  1. Create or import your content into Unreal
  2. Download and install the VIVEPORT SDK
  3. Integrate the VIVEPORT SDK into your content in Unreal

For C# user:

  1. Create an empty C# project in your visual studio 2015
  2. Copy settings into your project
  3. Reload your project and rebuild

Note

VIVEPORT SDK supports VIVEPORT, VIVEPORT Arcade and VIVEPORT M. For the features supported on each platform, please refer to the feature support matrix.

Support

If you would like to provide feedback or need further assistance with the VIVEPORT SDK, please go to the community in viveport.com.