How do I add a plugin to my configurator?

Some of the features you need in your configurator aren’t included in K3 by default: automatically arranging models in a row, calculating model sections, and markers in the 3D scene. That’s what plugins are for.

What a plugin does

A plugin is added to your configurator once. After that, it provides new building blocks— mostly dynamic 3D models. These appear in your model collection alongside Box, Extrusion, and dimension chain and are treated exactly the same way: You create them, place them into the scene using Regeln, and assign their properties in the

Loading...

dialog. Berechnungen also work there as usual.

So you don’t have to write any code to use a plugin.

Slots: Placing Models into a Plugin

Many plugin models don’t work on their own, but rather with your models. To do this, they provide slots—named locations where you can place models.

To place a model in a slot, you need to redirect the model action:

• Open the rule that displays the model.
• Click the pencil icon in the header of the model column.
• Under Slot Assignment, select the desired slot.

After that, the rule no longer draws the model into the scene itself—the plugin handles that. The Gruppierung positions it relative to itself, the Positionierung aligns it in a row, and the Boolesche Operation intersects with it.

Two Ways to Integrate a Plugin

Plugins end up in the Plugins tab in two ways—the list shows which method was used after each name:

Indicator	Origin
Store	Imported from the K3 Plugin Store—ready to use, maintained, no technical details
Custom	Added by you—a plugin developed by you or your implementation partner

Here’s how to access it in both cases:

• Open your configurator’s editor.
• Click
  Loading...
  in the sidebar.
• Switch to the Plugins tab.

Integrating a plugin from the Store

This is the standard procedure. You don’t need a URL or any technical details:

• Click on
  Loading...
  .
• In the Plugin Store dialog, you’ll see the available plugins. Click on
  Loading...
  for the one you want.
• The plugin appears in your list, marked with Store. Its models are immediately available in the editor’s model catalog.

If a Store plugin has its own settings, you can access them via the pencil icon next to the plugin. If it doesn’t have any, the dialog will let you know.

Your Own Plugins That Haven’t Been Published Yet

If you’ve developed plugins yourself that haven’t been published in the Store yet, you’ll find them in the same dialog under My Plugins.

Add Your Own Plugin Directly

You’ll need to use this method if you’ve developed a plugin yourself or had one developed for you and it’s not yet available through the Store. Your developer will then make the plugin available at a web address and tell you what to enter in the fields.

• Click
  Loading...
  .
• Fill out the dialog:
  • Title and Description: Choose any text so you can recognize the plugin in the list. Both are required.
  • URL: the address where your developer hosts the plugin, e.g., https://myplugin.org/plugin1/assets/remoteEntry.js.
  • Name and Module: two technical identifiers provided by your developer (typically k3-plugin and Plugin).
• Click on
  Loading...
  . The page will reload, after which the plugin’s modules will be available.

The plugin appears in the list, marked as Custom. You can use the pencil icon to change the details at any time.

During Development: Custom Test Address

While a plugin is being developed, it usually runs on the developer’s computer and not at the entered URL. There are two additional fields in the dialog for this purpose:

• Enable Use Dev.
• Under Development URL, enter the address of the development version, e.g., http://localhost:5002/remoteEntry.js.

info

These two fields are only visible if Developer Mode is enabled in your Profil Developer Mode is enabled.

Important: The development address applies only to your own user account. Your colleagues and, of course, your customers will continue to see the version at the normal URL. This allows you to work on a plugin while the configurator remains live.

Removing a Plugin

There is a trash can icon next to each plugin in the list. The dynamic models you created with the plugin remain in the configurator but are no longer displayed.

What plugins are available?

You can find the available plugins and instructions for setting them up in Plugin-Übersicht.

Custom plugins

If you need something that isn’t covered by a plugin, you or your implementation partner can write one yourself and add it directly. Instructions on how to build a plugin are provided in Entwickler-Dokumentation.