Skip to content

Structure & Setup

Custom nodes are located in the custom_nodes directory or the core nodes directory. For plugins, use custom_nodes. The directory structure is organized by Category, allowing you to group related nodes together.

  • Directorycustom_nodes/
    • DirectoryMyCategory/
      • DirectoryMyCustomNode/
        • init .py
        • MyCustomNode.js
        • MyCustomNode.py
        • runtime.json
      • DirectoryAnotherNode/
    • DirectoryAnotherCategory/
  • Folders: PascalCase or snake_case (consistent within category).
  • Files: Should match the node name (e.g., MyCustomNode.py).
  • Class Names: PascalCase (e.g., class MyCustomNode).

Every custom node consists of three key files:

  1. __init__.py: A marker file to make Python treat the directory as a package. It can be empty.
  2. runtime.json: (Optional) For defining isolated runtime environments.