bSDD Revit plugin

This is a community build tool. It is not an official buildingSMART International initiative.

• Introduction
• Open bSDD toolkit projects
• Features
• Building
• Installation
• Usage

Introduction

This project is part of the Open bSDD toolkit, an opensource development of a series of consistent bSDD plugins sharing a common bSDD web UI.

This project is initiated by Dutch contractors VolkerWessels and Heijmans. By starting this opensource development we believe we can help the industry structuring data. Proper usage of the buildingSMART Data Dictionary helps in getting consistent information in objects. Good information is the basis for further automation. The idea of our development is that we inspire our industry to include bSDD in their processes and softwareproducts natively.

Open bSDD toolkit projects

• Web UI https://github.com/buildingsmart-community/bSDD-filter-UI
• Revit Plugin https://github.com/buildingsmart-community/bSDD-Revit-plugin
• Sketchup bSDD plugin https://github.com/DigiBase-VolkerWessels/SketchUp-bsDD-plugin
• Trimble Connect bSDD plugin (Not available yet)

Features

Validate model against bSDD

• Revit types
• (Revit instances) TODO
• (Revit families) TODO
• validate against multiple dictionaries
• (validate against class restrictions) TODO
• (validate against nested class restrictions) TODO
• (validate against property restrictions) TODO
• (apply IDS filter before linking to the model) TODO

Apply bSDD classes on Revit elements

• search in main dictionary
• select possible related classifications
• automatic generation of persistent shared parameter GUIDs
• (select unrelated classes from filter dictionaries)
• (add bSDD materials) TODO

Export IFC, according to bSDD documentation

• consistent mapping of bSDD properties
• consistent application of an unlimited number of IfcClassifications
• leverages the built-in Revit IFC exporter, with a postprocessing step for improving Ifcclassificationreference location URL
• (add property URL) TODO

Building

Quick Start

The easiest way to build the entire project including the installer is to use the provided build scripts:

PowerShell (recommended):

.\build.ps1

Batch file:

build.bat

Build in Debug mode:

.\build.ps1 -Configuration Debug

Build installer only (if projects are already built):

.\build.ps1 -BuildInstallerOnly

Prerequisites

• Visual Studio 2019 or later with .NET Framework 4.8 development tools
• .NET SDK (for dotnet commands)
• MSBuild (included with Visual Studio)
• Inno Setup 6 (for building the installer)

  winget install --id=JRSoftware.InnoSetup --exact --silent

Manual Build Steps

If you prefer to build manually or need more control:

1. Restore NuGet packages:

   dotnet restore BsddRevitPlugin.sln

2. Build all projects:

   # ASRR Core libraries
   msbuild lib\asrr\lib-asrr-core\ASRR.Core.csproj /p:Configuration=Release /p:Platform=AnyCPU /restore
   msbuild lib\asrr\lib-asrr-core\ASRR.Core.csproj /p:Configuration=Release /p:Platform=x64
   
   msbuild lib\asrr\lib-asrr-revit-core\ASRR.Revit.Core.csproj /p:Configuration=Release /p:Platform=AnyCPU /restore
   msbuild lib\asrr\lib-asrr-revit-core\ASRR.Revit.Core.csproj /p:Configuration=Release /p:Platform=x64
   
   # Plugin projects
   msbuild BsddRevitPlugin.Resources\BsddRevitPlugin.Resources.csproj /p:Configuration=Release
   msbuild BsddRevitPlugin.Logic\BsddRevitPlugin.Logic.csproj /p:Configuration=Release /p:Platform=x64
   msbuild BsddRevitPlugin.2023\BsddRevitPlugin.2023.csproj /p:Configuration=Release /p:Platform=x64
   msbuild BsddRevitPlugin.2024\BsddRevitPlugin.2024.csproj /p:Configuration=Release /p:Platform=x64

3. Build the installer:

   & "$env:LOCALAPPDATA\Programs\Inno Setup 6\ISCC.exe" "BsddRevitPlugin.Installer\Installer.iss"

The installer will be created at: BsddRevitPlugin.Installer\Output\bSDD-Revit-plugin-setup.exe

For more details about the installer, see BsddRevitPlugin.Installer/README.md.

Installation

1. Go to the Releases page
2. Find the release you want to install, the latest is at the top (Mind the "Pre-release" tags, those versions are not meant for production use!)
3. Expand the Assets section, and download the installer (.exe) file.
4. When running the installer it first asks you if you want to install for:
   • just you (plugin is installed in "C:\Users%USERNAME%\AppData\Roaming\Autodesk\Revit\Addins")
   • all users, needing admin privilages to install (plugin is installed in (C:\ProgramData\Autodesk\Revit\Addins)
5. Select installation language
6. Select Revit versions to install for (2023 and 2024 currently)
7. Accept MIT license
8. Select start menu folder to get a shortcut to the uninstaller.

Usage

Go to the wiki page

Development setup

Prerequisites

• Make sure you are on MS Windows
• Github Desktop installed (or just git)
• Visual Studio installed (or VS code or another editor/IDE)

Clone repo from Github desktop

• File → Clone repository... → URL → https://github.com/buildingsmart-community/bSDD-Revit-plugin.git
• Repository → Open in PowerShell

Update submodules from PowerShell

• git submodule init
• git submodule foreach --recursive git checkout dev

Setup the project in Visual Studio

• File → Open → Project/Solution... → BsddRevitPlugin.sln
• Switch platform from "Any CPU" to x64 (because we use CefSharp)
• Choose a preferred Revit project as startup project (right-click BsddRevitPlugin.2023/2024 in solution explorer → Set as Startup Project)
• Make Revit start om debug (right-click BsddRevitPlugin.2023/2024 in solution explorer → Properties → Debug → Start external program: C:\Program Files\Autodesk\Revit 2024\Revit.exe)
• run debug...