Bowerbird

Bowerbird accelerates C# tool and plug-in development by dynamically compiling C# source files.

Download the latest release - Bowerbird for Revit 2023 (v1.4.2).

Current Release - Bowerbird for Revit 2023

The current release of Bowerbird is a Beta for Revit 2023.

How Bowerbird works

When Bowerbird starts up it scans a directory for C# source files (with the extension .cs), and attempts to compile them into a single assembly.

For Revit the source files can be found at:

%localappdata%\Ara 3D\Bowerbird for Revit 2023\Scripts.

The assembly is then loaded into memory and scanned for public classes which implement the IBowerbirdCommand interface.

public interface IBowerbirdCommand
{
   string Name { get; }
   void Execute(object arg);
}

Each command is listed in the main interface of the application. Double clicking on the interface will launch it.

For Revit the "argument" passed to the Execute function will be an instance of UIApplication.

Editing and saving any file in the directory will trigger a recompilation of all files, and reloading of the commands.

Sample Command

 /// <summary>
 /// Displays the current active document in a window
 /// </summary>
 public class CurrentDocument : IBowerbirdCommand
 {
     public string Name => "Current Open Document";

     public void Execute(object arg)
     {
         var app = (UIApplication)arg;
         var doc = app.ActiveUIDocument?.Document;
         if (doc == null)
         {
             MessageBox.Show("No document open");
         }
         else
         {
             MessageBox.Show($"Open document: {doc.PathName}");
         }
     }
 }

Background and Motivation

Problem

There are several popular tools, particularly in the realm of 3D design software, which have an SDK with a C# API for developing plug-ins. Our current focus is Autodesk Revit.

Two main challenges with plug-in development are:

1. A lot of overhead and boilerplate for creating new tools
2. A slow development cycle of build, compile, copy, and restart host application.

Using separate languages for quick scripting and another for distributed plug-ins, fractures the community, creates a cognitive load for developers, and is a barrier for some developers.

Solution

By using a dynamic compilation library based on Roslyn one generic Bowerbird plug-in can host many other plug-ins which can be dynamically compiled and modified without restarting the host application. This means that we can quickly create new experiments, plug-ins, try out new ideas, or test hypotheses aboout our code.

Important: Builing the Source Code

This repository is intended to be used as a sub-module of the main Ara3D repository. If you want to build the code from source, clone that repository, and build the solution.

Issues and Feedback

We appreciate and welcome any feedback.

Please submit issues, suggestions, and questions via the issues tracker.

Inspiration

• pyRevit by Ehsan Iran-Nejad.
• Revit.ScriptCS by Sridhar Baldava