jeremytammik / visualstudiorevitaddinwizard Goto Github PK

View Code? Open in Web Editor NEW

204.0 204.0 71.0 459 KB

Visual Studio templates to generate C# and VB .NET Revit add-ins

Home Page: http://thebuildingcoder.typepad.com/blog/about-the-author.html#5.20

License: MIT License

C# 37.33% Batchfile 9.57% Visual Basic .NET 53.11%

visualstudiorevitaddinwizard's Introduction

Visual Studio Revit Add-in Templates

The Visual Studio Revit add-in wizards provide Visual Studio templates for generating C# and VB .NET Revit add-ins.

They enable the instantaneous and automatic generation, installation and debugging of a new Revit add-in skeleton with one single click.

Ample documentation is provided in The Building Coder topic group on Visual Studio Revit add-in templates.

Installation

Installation can be accomplished by cloning this repository and running the installer batch file install.bat as described in The Building Coder discussion of the Revit Add-In Wizards on GitHub and Installer.

install.bat [Visual Studio Year - 2022, 2019, 2017, 2015]

User Project Template Location

Ensure that the destination path specified in install.bat matches your user project template location. You can change the known location for user templates in Tools > Options > Projects and Solutions > Locations, cf., how to locate and organize project and item templates:

Alternatives

Several alternative Revit add-in templates have been published.

They are all more complex and full-fledged than this minimalistic one, taking advantage of .NET configuration functionality, providing support for multiple Revit releases, WPF, languages, build systems, installers, Autodesk AppStore support, etc.

Here are some of them:

Revit2017AddInTemplateSet by Andrey Bushman; for a full discussion of that and comparison of the two, please refer to the article on new Visual Studio templates for Revit add-ins
Revit2018AddInTemplateSet
Multi-Version Revit Add-In Template by Yaroslav Zhmayev
Revit WPF Template by Petr Mitev
Hellpie dotnet Revit add-in template by Diego Rossi
Multiversion Revit plugins explained by Alvaro Ortega @alvpickmans Pickmans of matterlab including a comprehensive multiversion-revit-plugin-sample
Manual approach to maintain a multi-version add-in in multiple projects in single SLN by Pablo Derendinger

Author

Jeremy Tammik, The 3D Web Coder and The Building Coder, ADN Open, Autodesk Inc.

License

This sample is licensed under the terms of the MIT License. Please see the LICENSE file for full details.

visualstudiorevitaddinwizard's People

Contributors

Stargazers

Watchers

visualstudiorevitaddinwizard's Issues

install.bat requires ZIP + Fails unless VS 2015

I would just specify in your readme, that zip needs to be added to path variable if not already done? Im on windows10 and I guess it wasnt there! I also needed to edit the bat file for visual studio 2017, it was set for 2015.

Other than that thanks!

Post-build steps fail for the Release target

If a project generated from a template is built for the Release target, the post-build step fails as it copies the .dll always from the bin\Debug path. I'll suggest a fix for this.

Cant compile template

CS5001 Program does not contain a static 'Main' method suitable for an entry point

Tried on Release, Debug, Debug 1

Install script alteration suggestion

In the install.bat file you're getting to the documents folder by building up the path using the username. Unfortunately this isn't always the case. Also the C drive is not necessarily where the user's home folder resides.

I suggest changing the 6th line from this:

set "D=C:\Users%USERNAME%\Documents\Visual Studio 2015\Templates\ProjectTemplates"
to this:
set "D=%userprofile%\Documents\Visual Studio 2015\Templates\ProjectTemplates"

That should at least help where the user's home folder isn't in the usual position (or named the same as the username).

What is a bit cumbersome though is if the Documents folder under that has been relocated. Unfortunately the only place this is available is in registry. Else you can get to it using vbscript / powershell.

Here's a way of using powershell inside of a BAT file:

set T="%TEMP%\docspath.tmp"
powershell -Command "[Environment]::GetFolderPath('MyDocuments') | Out-File '%T%' -Encoding ascii"
set /p DOCSPATH=< "%T%"
del "%T%"

Thereafter the line above can be changed to this instead:

set "D=%DOCSPATH%\Visual Studio 2015\Templates\ProjectTemplates"

Though it just feels way too complicated for my taste.

VisualStudio 2022 does not recognize template

Hey,
I used the current 9f3b0a0 template batch with parameter "2022" but the created Template wasn't recognized by Visual Studio 2022.

The simple solution: In file TemplateRevitCs.vstemplate change the first line to Version 3: <VSTemplate Type="Project" Version="3.0.0"