Writing custom importers

This is a short introduction how to write custom importers for articy:draft X

Writing importers

An easy way to write an importer is to start with our "Loca Imports/Export" plugin.

To get started use the DevKit Tools to create your own copy of our plugin with an own "Company name" Namespace.

Create Mdk Plugin Menu
Create Loca Import Export

Within the Project you will now find the folder "Imports" containing the four files required for an importer. Let's focus on the "VoiceOverImporter"

  1. VoiceOverImporter.cs: The main importer class to implement. This plugin has some fair amount of code in its ImporterBase.cs file/base class.

  2. VoiceOverArgs.cs: The class describing parameters of the import and conting attributes to define their appearence in the UI.

  3. VoiceOverDescriptor.cs: The class that describes the import and how it is shown in the import wizard.

  4. VoiceOverSettingsHandler.cs: The class that that handles UI/configuration interaction.


When the project is loaded the plugin needs to register an instance of its descriptor class, using a call to RegisterImporter.

Looking in the "Excel" folder gives you a god starting point for using ClosedXML one of our 3rd party libaries to easily create and work with excel sheets.