Connector Unity

Introduction

This repo holds Speckle's Unity Connector + a sample project (Speckle playground). This connector is currently in an Alpha stage.

This connector is meant to be used by developers, it doesn't have an elaborated UI but it offers convenience methods to send and receive data. The connector uses our Speckle .NET SDK.

Checkout our dedicated Tutorials and Docs.

If you are enjoying using Speckle, don't forget to ⭐ our GitHub repositories, and join our community forum where you can post any questions, suggestions, and discuss exciting projects!

Notice

We support Unity 2020 and 2021 (newer versions likely work, but aren't currently part of our test pipeline).

Features:

• Receive Speckle Objects at Editor or Runtime
• Send Speckle Objects at Runtime (editor support in the works!)
• Material override/substitution
• Automatic receiving changes

Currently tested on Windows and MacOS. Experimental support for Android in the works.

Sample project

This repo holds a simple sample project (Speckle Playground). Simply download this repo or clone with git, and open in Unity 2020.3.

git clone https://github.com/specklesystems/speckle-unity.git

The sample project contains an example GUI (UnityUI) for fetching stream/branch data, and receiving/sending geometry to Speckle.

Installation

To install the connector into your own Unity project (rather than using the sample project), open the Package Manager (Windows -> Package Manager) and select Add Package from git URL. (requires git installed)

Paste in the following URL

https://github.com/specklesystems/speckle-unity.git?path=/Packages/systems.speckle.speckle-unity

Checkout our docs for getting started instructions

We encourage everyone interested to hack / contribute / debug / give feedback to this project.

Requirements

• Unity 2020.3+
• Have created an account on speckle.xyz (or your own server)
• Installed Speckle Manager (recommended, otherwise you'll need to implement your own authentication system in Unity)

Dependencies

All dependencies to Speckle Core have been included; compiled in the Asset folder until we figure out how to best reference Core.

Contributing

Please make sure you read the contribution guidelines for an overview of the best practices we try to follow.

License

Unless otherwise described, the code in this repository is licensed under the Apache-2.0 License. Please note that some modules, extensions or code herein might be otherwise licensed. This is indicated either in the root of the containing folder under a different license file, or in the respective file's header. If you have any questions, don't hesitate to get in touch with us via email.