circle-info
The Partner Program is now open!
Learn how you can monetize your traffic.chevron-right
search
SupportBlogDiscord
githubEdit

Getting Started with Unity WebGL

This document provides a guide for creating a sample app in Unity, building the app for WebGL, and deploying the app to VIVERSE.

hashtag
Introduction

Anyone can publish their WebGL-compatible Unity project to VIVERSE in a few simple steps. In this guide, we'll walk through the process of creating an new Unity project, making sure it is compatible with WebGL, and publishing to VIVERSE using the VIVERSE CLIarrow-up-right.

circle-info

For this guide, we are using the VIVERSE CLI, but it is also possible to compress and upload your build file directly to the VIVERSE Studio.

While VIVERSE is a great place for multiplayer games with networked avatars — and we have a number of services that can help you implement these features — it is not required to implement networked avatars to publish to VIVERSE.

hashtag
Prerequisites

  • Unity Hub and Unity installed on your device.

  • Nodearrow-up-right and npmarrow-up-right installed on your device. Please use at least Node v22 - Only required if using the CLI, not VIVERSE Studio

circle-exclamation

In this tutorial, we will be using Unity v6.1, however any WebGL-compatible version of Unity should be supported.

hashtag
A. Configure Your Unity Project

1

hashtag
Create a Unity Project

2

hashtag
Install the Unity Plugin

Navigate to Window > Package Manager > Unity Registry and search for "WebGL Publisher". Add the module to your project.

3

hashtag
(Optional) Enable Decompression Fallback

Compression is supported on VIVERSE, however you can enable fallback if you are encountering errors or would like to have it included. Navigate to Edit > Project Settings > Player > Web Settings > Publishing Settings and check "Decompression Fallback".

hashtag
B. Build and Publish to VIVERSE

1

hashtag
Build your project

Navigate to Publish and select "WebGL Publish". In the pop-up, click "Build and Publish", selecting the desired folder for your build. When doing this for the first time, Unity will automatically publish to their web-servers for testing. For future builds, you can disable this behavior to just the builds without publishing.

2

hashtag
Install the VIVERSE CLI

In a terminal session, run npm install -g @viverse/cli to install the CLI globally. Make sure you are using at least node v22.

3

hashtag
Login to VIVERSE

In the terminal session, run viverse-cli auth login and enter your VIVERSE account email and password.

4

hashtag
Create VIVERSE App

In the terminal session, run viverse-cli app create . Once complete, copy the app ID to be used when publishing.

5

hashtag
Publish to VIVERSE

In the terminal session, run viverse-cli app publish {path/to/unity/webgl/build} --app-id {your app id from step 4} referencing folder containing the index.html of your Unity build.

6

hashtag
Test & Configure World Settings

Navigate to the preview url created for the world. You can also access the world and its settings in studio.viverse.com/contentarrow-up-right.

7

hashtag
Submit for Curation and Discovery

By default, worlds uploaded will only be accessible via preview urls. For placement and curation on our webpages, meaning your experience will be easier to share, please submit for review.

8

hashtag
Iterate, Learn, Explore!

In addition to the sample scenes, the rough flow of api usage can be reviewed at https://github.com/ViveDeveloperRelations/ViverseUnitySDK/blob/master/Unity_Viverse_SDK_Developer_Guide.mdarrow-up-right And overview of the current version of the sdk with additional hints and tips at https://github.com/ViveDeveloperRelations/ViverseUnitySDK?tab=readme-ov-file#viverse-unity-sdk-for-webglarrow-up-right

Last updated

Was this helpful?