README.md
Speckle | Sharp (Legacy)
Speckle is the first AEC data hub that connects with your favorite AEC tools. Speckle exists to overcome the challenges of working in a fragmented industry where communication, creative workflows, and the exchange of data are often hindered by siloed software and processes. It is here to make the industry better.
.NET SDK, tooling, schema and Connectors
[!WARNING] This is our legacy .NET repo! Check out our active .NET repos here:
speckle-sharp-connectors
: our .NET next generation connectors and desktop UIspeckle-sharp-sdk
: our .NET SDK, Tests, and Objects
Repo structure
This monorepo is the home to our Speckle 2.0 .NET projects:
Core
: the canonical SDK for Speckle. It supports multiple data transports, and advanced decomposition API for design data, and offers a dynamic base for object definition.Objects
: the Objects Kit is our default interoperability kit. Read more about kits and their role in the Speckle ecosystem here.Converters
: conversion routines for each of the connectors mentioned below
- Speckle Connectors
ConnectorAutocadCivil
: for Autodesk AutoCAD and Civil3D 2021+ConnectorDynamo
: for Autodesk DynamoConnectorGrasshopper
: for McNeel GrasshopperConnectorRevit
: for Autodesk Revit 2019+ConnectorRhino
: for McNeel Rhino 6+
DesktopUI2
: reusable UI for all connectors (except visual programming)
Other repos
Make sure to also check and ⭐️ these other Speckle repositories:
speckle-server
: Server and Web packagesspecklepy
: Python SDK 🐍speckle-excel
: Excel connectorspeckle-unity
: Unity 3D connectorspeckle-blender
: Blender connectorspeckle-unreal
: Unreal Engine Connectorspeckle-qgis
: QGIS connectodspeckle-powerbi
: PowerBi connector- and more connectors & tooling!
Developing and Debugging
Clone this monorepo; each section has its own readme, so then just follow those instructions.
Issues or questions? We encourage everyone interested to debug / hack / contribute / give feedback to this project.
A note on Accounts: The connectors themselves don't have features to manage your Speckle accounts; this functionality is delegated to the Speckle Manager desktop app. You can install it from here.
Contributing
Please make sure you read the contribution guidelines for an overview of the best practices we try to follow.
Security
For any security vulnerabilities or concerns, please contact us directly at security[at]speckle.systems.
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.