Unreal Studio Collab Viewer Template

Describes how to get started doing collaborative VR and desktop design reviews with the Collab Viewer Template.

Windows
MacOS
Linux

The Collab Viewer Template joins multiple people together in a shared experience of the same 3D content. It's intended to make it easier and quicker for your team to review and communicate about designs in realtime, so that you can identify problems and iterate on the content more efficiently.

Every participant in a Collab Viewer session can use a computer set up with a standard mouse and keyboard, or with a VR headset and motion controllers. The Template offers a variety of built-in tools for interacting with the scene content at runtime. Every participant can move objects around, change objects to a see-through X-Ray material, play animations that "explode" content into different spatial arrangements, and more. Everyone sees an avatar of each other person in the session, and can use a laser pointer tool to point out features of the environment:

The Collab Viewer Template handles most of the difficult problems inherent in multi-viewer experiences, including setting up connections and replicating presence information between multiple computers. Use it as a starting point for your design review experiences, so that you can spend less time setting up networking and more time thinking about your designs. And, while it's most useful for evaluating and communicating your designs in a team environment, it offers enough interaction and navigation controls to be a good a starting point even for single-person experiences around your 3D content.

All of the interaction and navigation controls are provided by Blueprint classes in the Project, so you can customize them, learn from them, or even copy them into your own Projects. For more about working with Blueprint, see Blueprint Visual Scripting.

The pages in this section describe everything you need to know to get started with the Collab Viewer Template, and to use it for your own content.

Workflow

The typical usage pattern for the Collab Viewer Template is:

  1. Create a new Project from the Template, or bring the Template content into your own existing Project.

  2. Set up the Project with the content you want to share with others.
    This typically involves the same kinds of data import and look development tasks that you would do in any Unreal Engine Project. For details on specific considerations that you'll need to keep in mind when setting up your content, such as collisions and navigation meshes, see Adding Your Own Content to the Collab Viewer.

  3. Use the tools built in to the Unreal Editor to package your Project to an executable file.

  4. Share that file with the people who need to be part of the collaborative review.

  5. One person launches the packaged Unreal Engine application and starts it up in server mode.

  6. Each other person who wants to be part of the same viewing session launches their copy of the application on a separate computer and joins the server session.

For a detailed tutorial that walks you through the steps above using the default content in the Template, see the Quick Start.

Getting Started

How-To Guides

Reference

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback