Difference between revisions of "Manuals:Installation manual"
m |
m |
||
| Line 3: | Line 3: | ||
This manual guides you through installing the VectorMEP module and workspace on Vectorworks® software. | This manual guides you through installing the VectorMEP module and workspace on Vectorworks® software. | ||
| − | == | + | == Accessing the user library folder == |
| + | You will need to acces your user library folder for uninstalling VectorMEP, or when manually installing VectorMEP when our installers don't have the proper permissions. | ||
| − | === Installation using the third party interface === | + | You can use the Vectorworks interface to find this folder: |
| + | |||
| + | == Installing VectorMEP == | ||
| + | |||
| + | === From VectorMEP 2021 and beyond === | ||
| + | |||
| + | ==== Installation using the third party interface ==== | ||
VectorMEP can be installed directly from Vectorworks '''if available'''. If for any reason our third party installer is '''not available''' within Vectorworks please refer to our secondary installation instructions using the download from our website. | VectorMEP can be installed directly from Vectorworks '''if available'''. If for any reason our third party installer is '''not available''' within Vectorworks please refer to our secondary installation instructions using the download from our website. | ||
| Line 12: | Line 19: | ||
</div> | </div> | ||
<br clear=all> | <br clear=all> | ||
| − | === Installation using the plug-in manager === | + | ==== Installation using the plug-in manager ==== |
Download any 2021 package from our [http://./../page/Downloads downloads] page. | Download any 2021 package from our [http://./../page/Downloads downloads] page. | ||
# Open Vectorworks. | # Open Vectorworks. | ||
| Line 21: | Line 28: | ||
# Modify the workspace to include all VectorMEP tools and menu commands. | # Modify the workspace to include all VectorMEP tools and menu commands. | ||
| − | === Installing the VectorMEP workspace === | + | ==== Installing the VectorMEP workspace ==== |
<div style="float:left"> | <div style="float:left"> | ||
[[File:Install Partner Products.png|thumb|Activate the "Install Partner Products" menu]] | [[File:Install Partner Products.png|thumb|Activate the "Install Partner Products" menu]] | ||
| Line 30: | Line 37: | ||
<br clear=all> | <br clear=all> | ||
| − | == Up to VectorMEP 2020 == | + | === Up to VectorMEP 2020 === |
| − | === Migration === | + | ==== Migration ==== |
Migration of the toolsets from older versions will not work. It is advised to remove any existing VectorMEP menu's and tools and to re-add them using the installer script. | Migration of the toolsets from older versions will not work. It is advised to remove any existing VectorMEP menu's and tools and to re-add them using the installer script. | ||
| − | === Manual installation === | + | ==== Manual installation ==== |
The described workflow can be used for a new installation or an upgrade of a previous installed VectorMEP module. | The described workflow can be used for a new installation or an upgrade of a previous installed VectorMEP module. | ||
| Line 51: | Line 58: | ||
The described folders/files to copy can be found in the "InstallMeUsingThePluginManager.zip" file found in the download folder. | The described folders/files to copy can be found in the "InstallMeUsingThePluginManager.zip" file found in the download folder. | ||
| − | ==== Uninstalling the VectorMEP module ==== | + | ===== Uninstalling the VectorMEP module ===== |
* Windows: Remove "VectorMEP.vwr", "VectorMEP.vlb" In: USER_LIB/Plug-ins/ | * Windows: Remove "VectorMEP.vwr", "VectorMEP.vlb" In: USER_LIB/Plug-ins/ | ||
| Line 57: | Line 64: | ||
* Mac: Remove "VectorMEP.vwlibrary" In: USER_LIB/Plug-ins/ | * Mac: Remove "VectorMEP.vwlibrary" In: USER_LIB/Plug-ins/ | ||
| − | ==== Installing the VectorMEP module ==== | + | ===== Installing the VectorMEP module ===== |
* Windows: Copy "VectorMEP.vwr", "VectorMEP.vlb" Into: USER_LIB/Plug-ins/ | * Windows: Copy "VectorMEP.vwr", "VectorMEP.vlb" Into: USER_LIB/Plug-ins/ | ||
| Line 63: | Line 70: | ||
* Mac: Copy "VectorMEP.vwlibrary" Into: USER_LIB/Plug-ins/ | * Mac: Copy "VectorMEP.vwlibrary" Into: USER_LIB/Plug-ins/ | ||
| − | ==== Installing the VectorMEP library ==== | + | ===== Installing the VectorMEP library ===== |
Copy the folder "VectorMEP" | Copy the folder "VectorMEP" | ||
| Line 70: | Line 77: | ||
Note that the folders "Plug-ins", "Library" and "Defaults" are localised based on your local Vectorworks language thus might differ. | Note that the folders "Plug-ins", "Library" and "Defaults" are localised based on your local Vectorworks language thus might differ. | ||
| − | === Automatic installation === | + | ==== Automatic installation ==== |
If you are upgrading from a previous VectorMEP installation on Windows it is important to manually uninstall the plug-in prior to installing the update. | If you are upgrading from a previous VectorMEP installation on Windows it is important to manually uninstall the plug-in prior to installing the update. | ||
Uninstalling the plug-in is described under the Manual (un)installation chapter. | Uninstalling the plug-in is described under the Manual (un)installation chapter. | ||
| − | ==== Installing VectorMEP ==== | + | ===== Installing VectorMEP ===== |
# Open Vectorworks. | # Open Vectorworks. | ||
| Line 91: | Line 98: | ||
You will need to manually copy over the custom content you created for them to become available again. | You will need to manually copy over the custom content you created for them to become available again. | ||
| − | === Installing the VectorMEP workspace === | + | ==== Installing the VectorMEP workspace ==== |
We have provided an automated script to modify the active workspace to include all VectorMEP tools and menu commands. This script requires VectorMEP to be installed. | We have provided an automated script to modify the active workspace to include all VectorMEP tools and menu commands. This script requires VectorMEP to be installed. | ||
Revision as of 01:33, 21 February 2021
This manual guides you through installing the VectorMEP module and workspace on Vectorworks® software.
Accessing the user library folder
You will need to acces your user library folder for uninstalling VectorMEP, or when manually installing VectorMEP when our installers don't have the proper permissions.
You can use the Vectorworks interface to find this folder:
Installing VectorMEP
From VectorMEP 2021 and beyond
Installation using the third party interface
VectorMEP can be installed directly from Vectorworks if available. If for any reason our third party installer is not available within Vectorworks please refer to our secondary installation instructions using the download from our website.
Installation using the plug-in manager
Download any 2021 package from our downloads page.
- Open Vectorworks.
- Select Tools > Plug-ins > Plug-in Manager. The Plug-in Manager dialog box opens.
- Select the Third-party Plug-ins pane.
- Click the Install button and select the zip you just downloaded.
- Restart Vectorworks.
- Modify the workspace to include all VectorMEP tools and menu commands.
Installing the VectorMEP workspace
Up to VectorMEP 2020
Migration
Migration of the toolsets from older versions will not work. It is advised to remove any existing VectorMEP menu's and tools and to re-add them using the installer script.
Manual installation
The described workflow can be used for a new installation or an upgrade of a previous installed VectorMEP module.
The VectorMEP module and library need to be installed in the user’s library folder.
The user’s library folder exists in a platform-specific location:
- Windows: C:\Users\//Username//\AppData\Roaming\Nemetschek\Vectorworks\2019\
- Mac: /Users///Username///Library/Application Support/Vectorworks/2019/
The last number describes the Vectorworks version, for 2018, 2019... We will continue to call this folder USER_LIB
More info about the location of this folder can be found in the Vectorworks help under the section "Scripted Plug-ins".
The described folders/files to copy can be found in the "InstallMeUsingThePluginManager.zip" file found in the download folder.
Uninstalling the VectorMEP module
- Windows: Remove "VectorMEP.vwr", "VectorMEP.vlb" In: USER_LIB/Plug-ins/
- Mac: Remove "VectorMEP.vwlibrary" In: USER_LIB/Plug-ins/
Installing the VectorMEP module
- Windows: Copy "VectorMEP.vwr", "VectorMEP.vlb" Into: USER_LIB/Plug-ins/
- Mac: Copy "VectorMEP.vwlibrary" Into: USER_LIB/Plug-ins/
Installing the VectorMEP library
Copy the folder "VectorMEP"
Into: USER_LIB/Library/Defaults/
Note that the folders "Plug-ins", "Library" and "Defaults" are localised based on your local Vectorworks language thus might differ.
Automatic installation
If you are upgrading from a previous VectorMEP installation on Windows it is important to manually uninstall the plug-in prior to installing the update.
Uninstalling the plug-in is described under the Manual (un)installation chapter.
Installing VectorMEP
- Open Vectorworks.
- Select Tools > Plug-ins > Plug-in Manager. The Plug-in Manager dialog box opens.
- Select the Third-party Plug-ins pane.
- Click the Install button and select the "InstallMeUsingThePluginManager.zip" file in
- the VectorMEP download folder.
- Restart Vectorworks.
- Modify the workspace to include all VectorMEP tools and menu commands.
If the installer failed you will need to install VectorMEP manually.
In case of an upgrade where changes were made to the VectorMEP library, the installer will back-up the old VectorMEP library with the current date as file name suffix.
You will need to manually copy over the custom content you created for them to become available again.
Installing the VectorMEP workspace
We have provided an automated script to modify the active workspace to include all VectorMEP tools and menu commands. This script requires VectorMEP to be installed.
If Vectorworks presents an error --that the new workspace can't be loaded-- it's an issue with access permissions. Make sure the original workspace file/folder has full access and is not read-only.
1. Open Vectorworks.
2. Select Tools > Third-Party > VectorMEP > Generate VectorMEP Basic/Premium workspace.
This command is available in any workspace, active on Vectorworks launch. If you manually switch workspace before running this command it will not be visible. In this case you need to restart for it to appear.