{"id":22870063,"url":"https://github.com/autodesk-platform-services/aps-design.automation-csharp-revit.local.debug.tool","last_synced_at":"2025-05-05T22:12:22.076Z","repository":{"id":80611544,"uuid":"564103310","full_name":"autodesk-platform-services/aps-design.automation-csharp-revit.local.debug.tool","owner":"autodesk-platform-services","description":"Design Automation for Revit - Plugin handler:DesignAutomationHandler is a Revit addin that allows users to run and debug their Design Automation for Revit application locally using desktop Revit.","archived":false,"fork":false,"pushed_at":"2025-04-14T14:03:27.000Z","size":1439,"stargazers_count":6,"open_issues_count":0,"forks_count":4,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-14T15:24:56.211Z","etag":null,"topics":["autodesk-designautomation","autodesk-revit","csharp"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/autodesk-platform-services.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-11-10T01:54:49.000Z","updated_at":"2025-04-14T14:03:32.000Z","dependencies_parsed_at":"2024-04-12T19:50:28.648Z","dependency_job_id":null,"html_url":"https://github.com/autodesk-platform-services/aps-design.automation-csharp-revit.local.debug.tool","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/autodesk-platform-services%2Faps-design.automation-csharp-revit.local.debug.tool","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/autodesk-platform-services%2Faps-design.automation-csharp-revit.local.debug.tool/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/autodesk-platform-services%2Faps-design.automation-csharp-revit.local.debug.tool/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/autodesk-platform-services%2Faps-design.automation-csharp-revit.local.debug.tool/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/autodesk-platform-services","download_url":"https://codeload.github.com/autodesk-platform-services/aps-design.automation-csharp-revit.local.debug.tool/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252584331,"owners_count":21771945,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["autodesk-designautomation","autodesk-revit","csharp"],"created_at":"2024-12-13T13:13:35.417Z","updated_at":"2025-05-05T22:12:22.070Z","avatar_url":"https://github.com/autodesk-platform-services.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Design Automation for Revit - Local debug tool \n\n![Platforms](https://img.shields.io/badge/Plugins-Windows-lightgray.svg)\n![.NET](https://img.shields.io/badge/.NET%20Framework-4.8-blue.svg)\n![.NET](https://img.shields.io/badge/.NET%20-8.0-blue.svg)\n\n[![Revit](https://img.shields.io/badge/Revit-2019|2020|2021|2022|2023|2024|2025|2026-lightblue.svg)](http://developer.autodesk.com/)\n\n# Description\n\nDesignAutomationHandler is a Revit addin that allows users to run and debug their Design Automation for Revit application locally using desktop Revit. \n\n# Demonstration\n\nSee [step-by-step video](https://www.youtube.com/watch?v=i0LJ9JOpKMQ)\n\n# Setup\n\n## Prerequisites\n\n1. **APS Account**: Learn how to create a APS Account, activate your subscription, and create an app at [this tutorial](http://aps.autodesk.com/tutorials/#/account/). \n2. **Visual Studio**: [2022 or newer](https://visualstudio.microsoft.com/)\n3. **.NET Framework** or **.NET Core** basic knowledge with C#\n4. **Revit**: required for compiling plugin changes\n\n## Compile and Load on Revit\n\n1. Build the solution `DesignAutomationHandler`, compiling DesignAutomationHandler for Revit 2019 (`DesignAutomationHandler2019`), Revit 2020 (`DesignAutomationHandler2020`), Revit 2021 (`DesignAutomationHandler2021`), Revit 2022 (`DesignAutomationHandler2022`), Revit 2023 (`DesignAutomationHandler2023`), Revit 2024 (`DesignAutomationHandler2024`), Revit 2025 (`DesignAutomationHandler2025`), and Revit 2026 (`DesignAutomationHandler2026`)\n\u003e Design Automation for Revit currently supports Revit 2019, 2020, 2021, 2022, 2023. 2024, 2025 and 2026.\n\n2. Copy/paste the `DesignAutomationHandler.addin` into the \"Addins\" folder `C:\\ProgramData\\Autodesk\\Revit\\Addins\\XXXX\\`, where `XXXX` is the Revit version (e.g. 2019, 2020, 2021, 2022, 2023, 2024, 2025, 2026) you intend to run.\n\n3. Copy/paste the `.addin` file of your Design Automation for Revit plugin into the same folder `C:\\ProgramData\\Autodesk\\Revit\\Addins\\XXXX\\`. \n\n\u003e DesignAutomationHandler doesn't support local testing/debugging of more than one addin at a time.\n\n\u003e Revit needs the `DesignAutomationBridge.dll` to be in the same folder as your addin's dlls.\n\n## Usage\n\nStarting Revit:\n\n- If your addin requires an input Revit model at startup, then open the file in Revit before running the addin or specify the file using a startup argument.\n\n\u003e If you have json parameter defined to run the `WorkItem` in Design Automation, you can save the json payload as a json file in the same folder as your input Revit file.\n\n\u003e For example: if `CountItParams` is the name of the parameter defined in the your Design Automation `Activity`, then you should create a file `CountItParams.json` with contents `{\"walls\": false,\"floors\": true,\"doors\": true,\"windows\": true}` and save it to the folder which contains your input Revit model.  \n\n- In the Revit ribbon, navigate to the `Add-Ins` tab, then click `External Tools`, and click the `DesignAutomationHandler` command. Your addin will by executed! A dialog will pop-up to report the execution result. If the execution was successful, the dialog will indicate where you can find the output(s). They go to the folder which contained your input files. \n\n- If your plugin doesn't require any input files, start Revit and run the `DesignAutomationHandler` command without any additional setup. If you have json parameter defined to run the `WorkItem` in Design Automation, a dialog will instruct you where to put your json file.  \n\n\u003e You can rerun the same addin without restarting Revit. \n\n\u003e To run different addin, repeat the setup steps above.\n\n\u003e Currently, the DesignAutomationHandler doesn't support multiple input files.  (This feature is supported by Design Automation on APS.)\n\n# Further Reading\n\nDocumentation:\n\n- [Design Automation v3](https://aps.autodesk.com/en/docs/design-automation/v3/developers_guide/overview/)\n\nDesktop APIs:\n\n- [My First Revit Plugin](https://knowledge.autodesk.com/support/revit-products/learn-explore/caas/simplecontent/content/my-first-revit-plug-overview.html)\n\nBlog articles:\n\n- [Learn APS tutorial for Revit](https://aps.autodesk.com/blog/introducing-design-automation-tutorial-autocad-inventor-revit-engines)\n- [Design Automation - Debug Revit plugin locally](https://aps.autodesk.com/blog/design-automation-debug-revit-plugin-locally)\n\n## License\n\nPlease see the [LICENSE](LICENSE) file for full details.\n\n## Written by\n\nLijuan Zhu and Ashwin Shivashankar\n\n## Maintained by\n\nDeveloper Advocacy and Support\u003cbr/\u003e\nAutodesk\u003cbr/\u003e\nhttp://aps.autodesk.com","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fautodesk-platform-services%2Faps-design.automation-csharp-revit.local.debug.tool","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fautodesk-platform-services%2Faps-design.automation-csharp-revit.local.debug.tool","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fautodesk-platform-services%2Faps-design.automation-csharp-revit.local.debug.tool/lists"}