Dogukan Karatas
95 lines
6.7 KiB
Markdown
95 lines
6.7 KiB
Markdown
<h1 align="center">
|
|
<img src="https://user-images.githubusercontent.com/2679513/131189167-18ea5fe1-c578-47f6-9785-3748178e4312.png" width="150px"/><br/>
|
|
Speckle | Blender
|
|
</h1>
|
|
<h3 align="center">
|
|
Connector for Blender
|
|
</h3>
|
|
<p align="center"><b>Speckle</b> is the data infrastructure for the AEC industry.</p><br/>
|
|
|
|
<p align="center"><a href="https://twitter.com/SpeckleSystems"><img src="https://img.shields.io/twitter/follow/SpeckleSystems?style=social" alt="Twitter Follow"></a> <a href="https://speckle.community"><img src="https://img.shields.io/discourse/users?server=https%3A%2F%2Fspeckle.community&style=flat-square&logo=discourse&logoColor=white" alt="Community forum users"></a> <a href="https://speckle.systems"><img src="https://img.shields.io/badge/https://-speckle.systems-royalblue?style=flat-square" alt="website"></a> <a href="https://speckle.guide/dev/"><img src="https://img.shields.io/badge/docs-speckle.guide-orange?style=flat-square&logo=read-the-docs&logoColor=white" alt="docs"></a></p>
|
|
<p align="center"><a href="https://github.com/specklesystems/speckle-blender/"><img src="https://circleci.com/gh/specklesystems/speckle-blender.svg?style=svg&circle-token=76eabd350ea243575cbb258b746ed3f471f7ac29" alt="Speckle-Next"></a> </p>
|
|
|
|
# About Speckle
|
|
|
|
What is Speckle? Check our 
|
|
|
|
### Features
|
|
|
|
- **Object-based:** say goodbye to files! Speckle is the first object based platform for the AEC industry
|
|
- **Version control:** Speckle is the Git & Hub for geometry and BIM data
|
|
- **Collaboration:** share your designs collaborate with others
|
|
- **3D Viewer:** see your CAD and BIM models online, share and embed them anywhere
|
|
- **Interoperability:** get your CAD and BIM models into other software without exporting or importing
|
|
- **Real time:** get real time updates and notifications and changes
|
|
- **GraphQL API:** get what you need anywhere you want it
|
|
- **Webhooks:** the base for a automation and next-gen pipelines
|
|
- **Built for developers:** we are building Speckle with developers in mind and got tools for every stack
|
|
- **Built for the AEC industry:** Speckle connectors are plugins for the most common software used in the industry such as Revit, Rhino, Grasshopper, AutoCAD, Civil 3D, Excel, Unreal Engine, Unity, QGIS, Blender and more!
|
|
|
|
### Try Speckle now!
|
|
|
|
Give Speckle a try in no time by:
|
|
|
|
- [](https://speckle.xyz) ⇒ creating an account at our public server
|
|
- [](https://marketplace.digitalocean.com/apps/speckle-server?refcode=947a2b5d7dc1) ⇒ deploying an instance in 1 click
|
|
|
|
### Resources
|
|
|
|
- [](https://speckle.community) for help, feature requests or just to hang with other speckle enthusiasts, check out our community forum!
|
|
- [](https://speckle.systems) our tutorials portal is full of resources to get you started using Speckle
|
|
- [](https://speckle.guide/user/blender.html) reference on almost any end-user and developer functionality
|
|
|
|
|
|
# Blender Connector
|
|
|
|
The Speckle UI can be found in the 3d viewport toolbar (N), under the Speckle tab.
|
|
|
|
|
|
## Installation
|
|
We officially support Blender 4.2 and newer, on Windows.
|
|
|
|
## Usage
|
|
Once enabled in `Preferences -> Addons`,
|
|
The Speckle connector UI can be found in the 3d viewport toolbar (N), under the `Speckle` tab.
|
|
|
|
- Available user accounts are automatically detected and made available.
|
|
- Select the account from the dropdown list in the `Accounts` panel. This will populate the `Projects` list with available projects for the selected user account.
|
|
- Select a model and version from the dropdown menus.
|
|
- Click on `Load` to download and convert the objects from the selected model version. The objects will be linked into a Blender Collection.
|
|
- Click on `Open Model in Web` to view the model in your web browser.
|
|
|
|
## Supported Elements
|
|
|
|
The Blender Connector is still a work in progress and, as such, data sent from the Blender connector is a highly lossy exchange. Our connectors are ever evolving to facilitate more and more Speckle usecases. We welcome feedback, requests, edge cases, and contributions!
|
|
|
|
|
|
## Dependency Installation and Compatibility with Other Blender Addons
|
|
|
|
Upon first launch of the addon, the Speckle connector installs its SpecklePy dependencies in `%appdata%/Speckle/connector_installations` on Windows.
|
|
|
|
This is done through our [`installer.py`](https://github.com/specklesystems/speckle-blender/blob/main/bpy_speckle/installer.py). Through pip, we install the correct version of each dependency for your blender python version, host OS, and system architecture.
|
|
As such, an internet connection is required for first launch of the connector.
|
|
|
|
Other blender addons may require dependencies that conflict with specklepy. In these cases, one or both addons may fail to load.
|
|
If you suspect you're seeing a conflict, Please uninstall other third party addons one at a time to identify which addon is conflicting.
|
|
|
|
If you find an addon that conflicts, please try using a different version of that addon (newer or older).
|
|
|
|
If you can't find a version of an addon that works, please let us know on [our forums](https://speckle.community/) the name of the addon, the versions you've tried, the version of the Speckle connector you've tried, and your OS (win/mac/linux).
|
|
|
|
## Contributing
|
|
|
|
Please make sure you read the [contribution guidelines](.github/CONTRIBUTING.md) for an overview of the best practices we try to follow.
|
|
|
|
## Community
|
|
|
|
The Speckle Community hangs out on [the forum](https://discourse.speckle.works), do join and introduce yourself & feel free to ask us questions!
|
|
|
|
## 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](mailto:hello@speckle.systems).
|
|
|
|
## Notes
|
|
Thanks to [Tom Svilans](http://tomsvilans.com) ([Github](https://github.com/tsvilans)) for the original v1 contribution!
|