Unity Cloud Collaboration

About Unity Cloud Collaboration

Unity Cloud Collaboration provides a comprehensive framework for implementing collaboration features within Unity projects. With this service, development teams can:

  • Create and manage annotations to provide feedback on specific targets in a project
  • Organize discussions in conversation threads with structured replies
  • Attach files to annotations for richer context
  • Add emoji reactions to annotations for quick responses
  • Manage thread subscriptions for proper notification delivery

This real-time collaboration framework helps teams work together more efficiently, whether they're co-located or distributed around the world.

Installation

To install the Unity Cloud Collaboration package:

  1. In your Unity Project, open the Package Manager window (Window > Package Manager)
  2. Click the "+" button and select "Add package by name"
  3. Enter com.unity.cloud.collaboration and click "Add"

For detailed installation instructions, see the Installation page.

Getting started

The Collaboration SDK is designed to be easy to integrate into your Unity projects. To get started:

  1. Ensure you meet all prerequisites for using the SDK
  2. Follow the installation instructions to add the package to your project
  3. Follow the Get started with Collaboration SDK guide to implement your first collaboration features
  4. Learn about the Annotation Management basic concepts and Jira Management basic concepts that form the foundation of the collaboration system
  5. To navigate this documentation, look up the Table of content

Key features

Annotations

Annotations are the primary way users communicate in the collaboration system:

  • Create annotations attached to specific targets in your project
  • Search for annotations based on various criteria
  • Update annotation content and metadata
  • Resolve annotations when they've been addressed
  • Delete annotations when they're no longer needed

For details on working with annotations, see the use cases section starting with Create an annotation.

Threads

Threads organize annotations into structured conversations:

  • Group related annotations together in coherent discussions
  • Add replies to continue conversations
  • Track the status of entire discussion threads
  • Subscribe to threads to receive notifications about updates

Learn more about thread management in the use cases section, starting with Subscribe a user to a thread.

Attachments

Attachments enhance annotations by providing additional context:

  • Add files to annotations for richer context
  • Attach screenshots or any other type of files to visually highlight issues or ideas
  • Manage the attachment lifecycle with update and delete operations
  • Handle file uploads and downloads efficiently
  • Other types of attachments are also supported

See the attachments' use cases section, beginning with Create an attachment to an annotation.

Reactions

Reactions provide lightweight response options:

  • Add emoji reactions to annotations
  • Show agreement or other emotions without creating full replies
  • Remove reactions when they're no longer relevant

Review the reactions use cases, including Create a reaction on an annotation.

Jira Management

Jira Management enables integration with Jira for advanced project tracking and issue management:

  • Configure and manage Jira Server and Project connections
  • Link Unity projects to Jira projects for seamless collaboration
  • Search, create, and manage Jira issues directly from Unity
  • Link and unlink Jira issues to Unity annotations
  • Search for Jira users and projects
  • Check user permissions and Jira credentials
  • Retrieve Jira issue types and details
  • Ensure secure and permission-based access to Jira resources

Explore Jira Management use cases, starting with Basic concepts and the Jira Management use cases.

Documentation structure

This documentation is organized as follows:

Support and feedback

For issues, questions, or feedback regarding the Unity Cloud Collaboration SDK:

Additional resources