Code Monkey home page Code Monkey logo

speckle-unreal's Introduction

Speckle for Unreal Engine

Twitter Follow Community forum users website docs

Speckle makes integrating Unreal Engine with your 3D workflows even easier.
This plugin connects Unreal Engine to Speckle, allowing you to receive your versioned 3D data from Speckle inside Unreal Engine, enabling interoperable collaboration between Unreal and other Speckle connectors (Revit, Rhino, Blender, Sketchup, Unity, AutoCAD, and more!)

Speckle.for.Unreal.Engine.-.Getting.Started.mp4

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 officially support Unreal Engine 4.27, 5.0, 5.1, 5.2, 5.3

Features:

Supported Conversions:

Speckle Type Native Type
Objects.Geometry.Mesh Static Mesh Component /
Procedural Mesh Component
Objects.Geometry.PointCloud LiDAR Point Cloud
Objects.Other.Instance Actor with Transform
Objects.BuiltElements.View Camera
Speckle.Core.Models.Collection Empty Actor

Supported platforms: Windows, Linux, MacOS Other platforms may work, but currently untested.

Limitations:

  • Currently no support for sending Unreal geometry to Speckle.
  • Does not use the .NET or Python SDK, or the Speckle Kit based workflow, all code is in native C++/BP.
  • Does not use our shared Desktop UI 2, only a simple editor UI is currently provided.
  • Does not fetch accounts from Speckle Manager, you must generate a personal access token (auth token) to receive non-public streams.

How to install

Speckle for Unreal Engine can be installed through the Unreal Engine Marketplace.


Alternatively, developers may prefer to install manually.

  1. Git clone this repo (or download and extract the archive zip) into your project's Plugins directory (created as needed)
  2. Open/Restart your Unreal project. This will build the plugin for your environment.

See our docs for usage instructions.

If you encounter build issues, try building your project from VS/Rider directly. Look at the Saved\Logs\ files for error messages, and don't hesitate to reach out on our community forums for help!

For contributing to any of our code repositories, please make sure you read the contribution guidelines for an overview of the best practices we try to follow.

speckle-unreal's People

Contributors

alanrynne avatar bckuntz avatar cristi8 avatar didimitrie avatar gjedlicska avatar jimver04 avatar jr-morgan avatar markcichy avatar pablothedolphin avatar panmig avatar teocomi avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.