README.md
ConnectorNavisworks
Introduction
This repo holds the Speckle Navisworks Connector. We'd really appreciate any feedback, comments, suggestions, etc ✨
Documentation
Comprehensive developer and user documentation can be found in our:
📚 Speckle Docs website
Developing & Debugging
Requirements
- Navisworks 2020 - 2024
- Visual Studio 2019 or above (or similar IDE)
- A Speckle account (you can make one at https://speckle.xyz/)
Getting Started
Accounts
To use Speckle, you'll need a Speckle account. This can be in our XYZ server, in a local server or anywhere else. You can log in to your account:
- from Manager, available at https://speckle.systems/download/
- or, if using our latest release, you can also log in directly from the Navisworks Connector.
Debugging
In your IDE, select the version of the Navisworks project you want to debug:
Ensure the right Executable set in you Debug Launch profile:
And then you can click debug. The post build actions will copy all necessary files, so next you just need to launch the connector:
By default the Connector installs for the active user in the AppData roaming folder. You can change this by editing the ConnectorNavisworks.csproj in the PostBuildEvent.
It builds a .bundle form of plugin and uses the package.xml to install it in the Navisworks plugins folder, this maps the versions supported by Speckle Connector for Navisworks.
Conversions
All the conversion routines are in the converter project:
You might need to debug the Converter project instead of the Connector one if your IDE doesn't reach the breakpoints correctly.
Contributing
Please make sure you read the contribution guidelines for an overview of the best