https://github.com/philipbelesky/grasshopperbootstrap
A slightly opinionated starter template for Grasshopper plugin development with a variety of development aids.
https://github.com/philipbelesky/grasshopperbootstrap
grasshopper grasshopper-plugin grasshopper3d rhinoceros rhinocommon visual-studio
Last synced: 8 months ago
JSON representation
A slightly opinionated starter template for Grasshopper plugin development with a variety of development aids.
- Host: GitHub
- URL: https://github.com/philipbelesky/grasshopperbootstrap
- Owner: philipbelesky
- Created: 2020-08-07T00:13:13.000Z (about 5 years ago)
- Default Branch: develop
- Last Pushed: 2023-01-31T02:44:56.000Z (over 2 years ago)
- Last Synced: 2025-01-12T22:34:10.337Z (9 months ago)
- Topics: grasshopper, grasshopper-plugin, grasshopper3d, rhinoceros, rhinocommon, visual-studio
- Language: C#
- Homepage:
- Size: 2.57 MB
- Stars: 31
- Watchers: 4
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Grasshopper Bootstrap
[](https://github.com/philipbelesky/GrasshopperBootstrap/actions/workflows/dotnet-grasshopper.yml)
[](https://github.com/philipbelesky/GrasshopperBootstrap/actions/workflows/dotnet-tests.yml)
[](https://codeclimate.com/github/philipbelesky/GrasshopperBootstrap/maintainability)
[](https://www.codacy.com/manual/philipbelesky/GrasshopperBootstrap?utm_source=github.com&utm_medium=referral&utm_content=philipbelesky/GrasshopperBootstrap&utm_campaign=Badge_Grade)
[](https://opensource.org/licenses/MIT)
A slightly opinionated starter template for Grasshopper plugin development. Comes with a variety of templates and tools to help development. Most are unnecessary for most projects. However, most are easier to remove from a project than to add in.
Many of these features assume you are working on Github, using Visual Studio 2017/2019, and developing for Rhinoceros 6+ or higher.
### Features
- [X] Grasshopper/RhinoCommon bundled using their NuGet packages
- *Ensures reference paths are maintained across local environments and can be controlled independently of the installed applications.*
- [X] Setup release builds to produce a single `gha` that includes all other dependent `dlls`
- *ILRepack is used over ILMerge or Fody for better macOS compatibility. Refer to [this repo](https://github.com/ravibpatel/ILRepack.Lib.MSBuild.Task) for its documentation.*
- *The sample code is setup to bundle Newtonsoft.Json as an example. Be sure to remove this and its reference in `ILRepack.targets` when starting your project!*
- [X] Cross-compatibility between macOS and Windows versions of Visual Studio
- *`GrasshopperBootstrap.csproj` defines split build paths so that each OS will start its own version of Rhinoceros*
- [X] Continuous Integration using GitHub Actions
- *See the steps in `.github/workflows/dotnet-grasshopper.xml`; currently the action will build the application and then upload the gha file from the Release build as an artefact. Build or linting failures will trigger a fail.*
- *See the steps in `.github/workflows/dotnet-tests.xml`; currently the action will run the tests defined in GrasshopperBootstrap.Tests. Note that these tests can't depend on Rhinocommon.*
- [X] Unit-testing framework (sort of)
- *The `GrasshopperBootstrap.RhinoTests` project is setup to run its tests within a headless version of Rhinoceros 7 so that all of Rhinocommon is accessible. Note that this project needs to be run as `x64` (under the `Test` menu in Visual Studio).*
- *The `GrasshopperBoostrap.Tests` project is setup to run its tests without Rhinocommon access. This is mostly useful for doing CI testing (e.g. the GitHub action described above).
- *That same project has a Grasshopper definition that uses [PancakeContract](https://www.food4rhino.com/app/pancakecontract) to show how to run unit tests within Grasshopper.*
- [X] A shared class for all component files to inherit
- *Allows for shared functionality and/or easy implementation of error reporting*
- [X] Affordances (via a shared `GHBComponent` class) for easily outputting debug and profiling information
- *When using DEBUG builds, all components have a `Debug` output paramater designed to be connected to a Panel component*
- *Basic profiling information can be logged to this output with `LogTiming(msg)` as can general information with `LogGeneral(msg)`*
- [X] Affordances (via a shared `GHBAsyncComponent` class) for easily creating Asychronous components
- *See [this repository](https://github.com/specklesystems/GrasshopperAsyncComponent/tree/main) and [this blogpost](https://speckle.systems/blog/async-gh/)*
- (The implementation used here is a near-direct copy, including the example `AsyncWorkerExample`)
- [X] Linting using FxCop, StyleCop, an `.editorconfig` with a (relatively?) sane set of defaults
- [X] GitHub Pages setup for documentation
- *See the `docs` folder and the README there*
- [X] Icons Illustrator template with some of the original Grasshopper icons provided as references
- *See the `assets` folder*
- [X] A bundled template for an "About" component that reports current/latest version and links to documentation
- *See `AboutComponent.cs` and `GrasshopperBootstrapInfo.cs`*
- [X] 3DM files setup to be stored using [Git Large File Storage](https://git-lfs.github.com)
- [X] Setup to optionally debug using the previous versions (v6) of Rhinoceros
- *Use the Debug (v6) build configuration if this is desirable. You may want to check the file paths in the `csproj` file match your local paths.*
- [X] Code analysis with Codacy and Code Climate
- *These are not setup per-se; I've just added badges to this README. To use these in your projects you will need to [add](https://github.com/marketplace/codacy) [each](https://github.com/marketplace/code-climate) app via the [GitHub Marketplace](https://github.com/marketplace/code-climate)*
- [X] Message added below components showing current version when running in DEBUG
- *This is to easily identify the currently-loaded plugin version and as a safe guard against publishing development builds*
### Roadmap (PRs welcome!)
- [ ] Real Unit testing via NodeInCode?
- [ ] Performance tests using BenchmarkDotNet?
- [ ] Error reporting using Sentry
- [ ] Scripts for easily generating Yak releases
- [ ] Automate Yak releases via GitHub actions?
### Setup
This should all work out of the box. See features notes for optional setup steps.
Comments in the code with `GrasshopperBootstrapTODO:` highlight crucial changes to make when setting up your own plugin.
The default 'spiral' component from the McNeel sample plugin is included for reference and to demonstrate some features.
### Acknowledgements
Thanks to Dimitrie Stefanescu for the [async method developed in this repo](https://github.com/specklesystems/GrasshopperAsyncComponent/tree/main).
Thanks to Tom Makin for the unit testing code [developed in this repo](https://github.com/tmakin/RhinoCommonUnitTesting).
Thanks to Andrew Heumann, Matthew Nelson, and Will Pearson for their recommendations.