Skip to content
This repository has been archived by the owner on Aug 28, 2021. It is now read-only.

Develop SpeckleRhino

Jump to bottom
Luis E. Fraguada edited this page Mar 16, 2018 · 1 revision

Code

SpeckleRhino is composed of several projects which are either part of the source or are part of of an external repository and are pulled in as submodules.

  • SpeckleCore (submodule) - .NET base client for the speckle api
  • SpeckleRhinoConverter - Functions to convert Rhino objects to Speckle objects and vice versa.
  • SpeckleGrasshopper - Speckle Grasshopper components.
  • SpeckleAccountManager - Account manager for Speckle Grasshopper components.
  • SpeckleRhinoPlugin - Speckle clients for Rhino 5 and Rhino 6.
  • SpeckleRhinoView (submodule) - The HTML/JS/CSS UI for SpeckleRhino, developed with the Vue.js framework.

Development Tools

SpeckleRhino has been developed on Windows 10. SpeckleRhino has been developed with the following tools:

  • Visual Studio 2017
  • Node.js (optionally, one could use the Node.js Tools for Visual Studio) Please install both of these prior to developing SpeckleRhino.

Building and Running SpeckleRhino

  1. Clone the SpeckleRhino repository
  2. Pull in the submodules with git submodule update --init
  3. Navigate to the SpeckleView directory and run npm install from a console. This will install all dependencies for the SpeckleView project.
  4. Run npm run dev to build the UI and start a local server.
  5. In a browser, navigate to http://localhost:9090. You should see the SpeckleView UI
  6. From the root directory, open the SpeckleRhino.sln in Visual Studio 2017. At this point, Visual Studio should attempt to restore any dependencies via NuGet.
  7. Build the debug version, alternatively, you can start a debugging session. Depending on which SpeckleRhino project you have as your 'start-up' project, starting a debugging session will either open Rhino 5 or Rhino 6.
  8. If this is the first time you build SpeckleRhino, install the Rhino plugin by going to Tools -> Options -> Plugins -> Install. Navigate to the SpeckleRhino solution directory where you will find a Debug folder with all of the compiled libraries (including the Grasshopper assembly). Choose the SpeckleWinR5.rhp or SpeckleWinR6.rhp depending on which version of Rhino you are working with.
  9. Find the SpeckleRhino panel from the panel dropdown.
Clone this wiki locally