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:

• ⇒ creating an account at our public server
• ⇒ deploying an instance in 1 click

Resources

• for help, feature requests or just to hang with other speckle enthusiasts, check out our community forum!
• our tutorials portal is full of resources to get you started using Speckle
• reference on almost any end-user and developer functionality

Repo structure

This is the beginning of the Speckle SketchUp Connector. It is still in very early development and is not ready for general use. This repo is split into three parts:

1. Speckle Connector extension

Includes the ruby source files to run extension on SketchUp environment. SketchUp Extensions are composed of a .rb file as entry and folder that .rb file refers to. In our case entry file is speckle_connector_3.rb that responsible to register Speckle Connector extension to SketchUp and also it shows address to where extension will start to read extension. Source folder is speckle_connector_3.

2. User Interface

Includes the Vue frontend lives in the ui folder.

3. SketchUp Sqlite3 extension submodule

Includes source codes of base SQLite3 C/C++ library and ruby compiler files to be able to run SQLite3 functionality on SketchUp in the same ruby module like SpeckleConnector::Sqlite3::Database. By this way we use extensions as native part of the source ruby code.

After building sqlite3.sln file, compiled sqlite3.so (for Windows) and sqlite3.bundle (for OSX) dynamic library files are created by solution to place them into source code into speckle_connector_3/src/ext. Building this project should be only happen when SketchUp starts to support newer Ruby versions (currently it is 2.7).

Contribution Guide

Before start to contribute, it is better to understand how align with other contributors. It will make easier job of reviewer when you submit an issue or PR. If it is your first repo to contribute Speckle environment make sure that you read Contribution Guideline.

Additionally as mentioned on Repo Structure, this repo includes a submodule. Contributions on this source files should be done on the sketchup-sqlite by creating issues and PRs on it. If it is your first time works with submodules, please read git docs briefly to get some insight about it.

Development

The following instructions are for development in Windows (not WSL) using Visual Studio Code. If you would like to contribute instructions for other development environments, feel free to submit a PR.

Environment Setup

Ruby can be installed on Windows using the installer here. Install it with the DevKit and complete the full installation as per instructions.

This should have also have set up the package installer gem and interactive ruby irb. Double check that everything has been installed correctly.

ruby -v
gem -v
irb -v

Let's also install our first gem bundler which is a package manager that will help us with development.

gem install bundler

Editor Setup

Clone this repo and run:

bundler install

This will install all the necessary packages for the connector.

Next, install the Sketchup Ruby Debugger. You can find installation instructions here. This will involve downloading the dll and copying it into the SketchUp installation directory:

C:\Program Files\SketchUp\SketchUp 20XX\

You can now open up the repo in VS Code or you can use JetBrains' tools RubyMine and Webstorm.

If you will use VS Code, make sure you've installed the Ruby extension for VS Code.

以上为 README 的开头部分。其余内容请阅读原文。 查看完整 README ↗