Create Plugins

Develop custom nodes using the power of Python.

First Look

Designer Window is the fastest way to go from “I need a special node” → “I can use it in my scene”.

You write (or generate) a small Python class (a Block), press CREATE BLOCK, and it shows up in the Custom Blocks list.

circle-info

If you like starting from a working template, open Coding Reference and copy the sample block.

Quick Start

Follow these steps once, then come back and explore the details.

  1. Open Designer Window.

  2. Keep the default script, or paste your own or prompt your way with AI agent.

  3. Make sure the script ends with add_block(...).

  4. Press CREATE BLOCK.

  5. Find your block in the Custom Blocks list and drag-drop it into a scene.

circle-check

Code Editor

The big editor area is the source of truth for your block.

Your script must include (minimum):

  • from studio.custom_block import *

  • A class that inherits from Block

  • A matching op_code

  • A final add_block(MyBlock.op_code, MyBlock) line

circle-exclamation

AI Assistant

At the bottom of Designer Window you can:

  • Write a prompt (example: “Write a block that converts a BGR image to grayscale”)

    • Be descriptive for the best results.

    • As of now, custom blocks assistant is free to use.

  • Choose a model from the dropdown

  • Press Submit to generate code into the editor

This is meant to get you started quickly. You’re always in control—review and edit the code before you press CREATE BLOCK.

circle-info

AI agent remembers your previous prompts, you can ask for improvements or changes.

circle-exclamation

Updating an Existing Block

When you press CREATE BLOCK again:

  • The file is overwritten.

  • The Custom Blocks list entry is refreshed.

  • Studio attempts a best-effort safe replace in open scenes (it tries to preserve connections).

circle-info

If you renamed sockets, Studio may reconnect by index as a fallback. That’s why stable socket names matter.

chevron-rightAdvanced: What CREATE BLOCK actually doeshashtag
  • Studio finds the first class inheriting from Block and uses its class name as the block name.

  • Your script is saved as <BlockName>.py under the Marketplace custom blocks folder.

  • Studio imports custom_blocks.<BlockName> and instantiates it once to validate it.

  • If everything looks good, the block becomes available in the Custom Blocks list.

circle-info

File location: .../AugeLab Studio/marketplace/custom_blocks/<BlockName>.py

circle-exclamation

Reloading Blocks into Designer Window

To edit an existing block, right-click its name in the Custom Blocks list and choose Load into Designer Window.

circle-exclamation
Load Existing Block
circle-info

“Reload” updates the Custom Blocks list (adds new files / removes deleted files). It does not hot-update nodes already placed in scenes.

Refresh Block List

Last updated

Was this helpful?