Advanced Topics#

Warning

In napari 0.6.0 we have made some changes to napari’s default behaviour when validating legacy “npe1” plugins. You may see a warning when starting napari if you have legacy “npe1” plugins installed. You can learn more about this change in the Changes to the plugin engine in 0.6.0 document.

Some plugin developers may find more in-depth, technical information helpful. This section describes topics, such as:

  • specifications for napari’s plugin ecosystem using the plugin engine npe2.

  • migration to npe2 from the deprecated napari plugin engine v1.

npe2: napari plugin engine v2#

npe2 manifest reference

A reference for the npe2 manifest file, which is used to define the plugin and its contributions.

Manifest Reference
npe2 contributions reference

A technical specification for how plugins can contribute additional functionality and features to napari.

Contributions Reference

Deprecated: napari plugin engine v1#

Important

New plugins should use the npe2 standard. We encourage first generation plugin authors to migrate their plugin to the npe2 standard.

Napari plugin engine v1 reference

These documents provide background on the first generation plugin system which is now deprecated.

First generation plugins (Deprecated)
Migration guide to npe2

Have a plugin written for the first generation plugin system? This guide will help you migrate to the npe2 plugin system.

Migration to npe2