Guide: Plugin installation

These instructions should work generally work and it shouldn’t matter to much which version of Cura you are using. You will find instructions for the most recent Cura version on top of this page.


Contents

There are different ways of installing the plugin and also instructions for older versions:


Ultimaker’s marketplace

  • Open Cura and open the marketplace by the button in the upper right corner
Ultimaker Cura: Application head
  • Within the marketplace choose the plugin you want to install. Among with my plugins there are also many others including materials, which are worth to check and install!
Ultimaker Cura’s marketplace: many choices for plugins
  • Plugins which are marked in the lower right corner by a check.
  • Click on the icon of the plugin you want to install.
Plugin page: Blender Integration
  • Wait until the installation is done..
  • After installation you will be notified on the bottom of the window to quit Cura and restart it. Just do so to complete the installation!
Ultimaker Cura’s marketplace: Finish plugin installation

Plugin package

During development of plugins, plugin packages are often shared to the Cura community for testing. These files have normally the ending *.curapackage (Cura >= 3.3) or *.curaplugin for Cura < 3.3). They include details about the distributor and the application data, too.

During these instructions I will use the FreeCAD plugin as an example.

  • Download the plugin as you wish. Make sure that the package fits to your version of Cura. In my case the Cura packages include the version in the filename.
FreeCAD plugin: Artifacts from an automated build

The following table will tell you which Cura version fits to which API/SDK version and how the suffix is called in the filename.

Cura versionAPI/SDK versionFilename suffix
4.0.0SDK 6.0.0
sdk-600
(curapackage)
3.6API 5api-5
(curapackage)
2.7API 4api-4 (curaplugin)
  • As soon as you are sure that you downloaded the right package, just drag and drop the Cura package into Cura’s window.
  • You should get an notification, that the plugin is going to be installed upon the next start of Cura.
  • Close Cura and start it again. After that you should be able to find the plugin in the marketplace. If the plugin was broken before, you might want to double-check there, whether the plugins is not disabled.

Running from source

  • Pre-requirements: Github Desktop (https://desktop.github.com/) or any other git client
  • Go to the plugins website and look for the URL, so you can clone the repository. In Github you might find a button, so you can open GitHub Desktop and clone the repository directly.
  • In case you are going for the method to use GitHub Desktop together with Chrome, you might get asked whether you really want to use GitHub Desktop. Just confirm the dialog to continue.
  • Within GitHub desktop choose the plugin directory within your Cura configuration directory. Same applies for other git clients. If you clone the repository to somewhere else Cura won’t find it.
  • Now you can switch between branches, create your own one and start developing on your own new feature!

Instructions for Cura 3.x and older

How to install via plugin browser (Cura >= 3.3)

  • (NEEDS TO BE ADDED)

How to install via plugin browser (for Cura < 3.3)

  • Open Cura and open the plugin browser from the menu: (since 2.7)
  • Look for your plugins name, for example “SolidWorks Integration”, and click on the “Install” button.

NOTE: This is how it should look like when the plugin has been correctly installed.

  • Restart Cura
  • Open a part file, assembly and/or drawing file of your choice. You should be able to find both file types being supported in the open file dialog:
  • (optional) If you can’t open any SolidWorks file, then you probably don’t have SolidWorks installed. To be sure that the plugin is really installed, there is another double check you can make:

How to install using a plugin file

This instruction applies for Cura <= 3.2 where files with the extension *.curaplugin or *.umplugin are used.

  • Download the plugin from the website
  • Open Cura and open the plugins overview by clicking on “Installed plugins… the menu.
  • Click on the “Install new plugin” button and choose the plugin package file, you downloaded before.
  • After doing that, a window should appear, which confirms a successful installation and you will need to restart Cura.
  • Well done! You can enjoy using your plugin!