OpenKatana · Create animation kit:
OpenKatana_create_animation_kit creates an editable starter kit for a Blender animation, giving you a practical foundation to customize rather than requiring you to build a scene from scratch. The supplied example uses original, generic geometry with no private assets: a rounded housing, a curved cable, a small control, and an animated dot-grid display. It also provides a scene setup with materials, lighting, motion blur, and camera movement with target tracking. The display is driven by frame numbers, helping its imagery follow the animation timeline. The scene template can also record evaluated camera samples for later motion analysis. This node is best understood as a preparation tool for an animation workflow, not as a finished-video generator: you can edit the generated scene and configuration before running the Blender rendering and review stages.
OpenKatana · Create animation kit Input Parameters:
project_id
A required STRING identifying the OpenKatana project for the tool call. Use the identifier of the project in which you intend to prepare the animation kit, so the operation is associated with the correct project context. The supplied integration test uses fixture as an example project identifier, but this is not a required value or a default. The provided node source does not show project creation, identifier validation rules, available identifier options, or a default value. Minimum and maximum values are not specified for this string input.
arguments
A required STRING carrying the tool arguments, expressed as a JSON object in text form. This is where you supply animation-kit settings rather than adding extra sockets to the node. The provided context demonstrates the tool accepting directory and frames, and the underlying kit-creation function also exposes width, height, and fps. For example, {"directory":"animation-kit","width":640,"height":360,"fps":30,"frames":60} describes a small starter animation. Width and height determine the configured image dimensions; fps sets the playback rate; frames sets the total frame count; and directory specifies the kit directory. The underlying creation function defaults to width 640, height 360, fps 30, and frames 60, but these are tool-level defaults, not defaults shown for the node’s STRING socket. No default for the arguments string or directory, and no numeric validation ranges, are provided in the supplied source. The template numbers frames from zero through frames minus one, so 60 frames at 30 fps represents two seconds of animation.
after
An optional STRING accepted by the node interface. In the supplied execution method, this value is received but is not read, merged into the tool arguments, or passed to the invocation. Consequently, the available source does not establish any effect on the generated kit or any tool-side dependency behavior. You can leave it unconnected unless another part of your workflow explicitly requires this socket. The execution method defaults to None when it is omitted; no string default, allowed options, or minimum and maximum values are specified.
OpenKatana · Create animation kit Output Parameters:
result_json
A STRING containing the node’s serialized response from the OpenKatana tool call. This is the response you inspect to understand the outcome of the kit-creation operation, rather than an image, video, or Blender scene socket. Any returned file locations or status information must be interpreted from the actual response; the supplied context does not show a complete response example or establish its exact JSON keys. Keep this distinction in mind when connecting later steps: creating the kit prepares animation resources, while rendering, assembling clips, and analyzing motion are separate operations.
OpenKatana · Create animation kit Usage Tips:
- Start with an explicit configuration such as
{"directory":"animation-kit","width":640,"height":360,"fps":30,"frames":60}. These dimensions and timing match the underlying creation function’s defaults and provide a modest starting point for later render tests. - For an initial smoke test, reduce
framesto 6, as demonstrated in the supplied integration test. A shorter timeline can make subsequent Blender testing quicker; it does not provide enough duration to judge a full camera move. - Plan duration using frame count divided by fps. For example, 120 frames at 30 fps gives four seconds. When editing the generated configuration, keep the camera schedule and display content consistent with the chosen timeline.
- Customize the generated materials and geometry before committing to a full render. The supplied template reads body and accent colors from its configuration and constructs a generic example scene intended for editing.
- Run the scene in a disposable Blender scene or save your existing work first. The template begins by selecting and deleting all objects in the current scene.
- Treat display preparation as part of the workflow. The Blender template reads
display/receipt.jsonand referencesdisplay/atlas.png; verify that these resources are available before running it, and use the separatebuild_display_atlastool when preparing replacement display content. - Use a compatible Blender environment with the OpenKatana helpers available. The template imports both
bpyandopenkatana.blender_helpers, so it is not an ordinary standalone Python script. - Review rendered movement visually even when using automated checks. OpenKatana describes its camera and optical-flow analysis as candidate QA that still requires visual review.
OpenKatana · Create animation kit Common Errors and Solutions:
unexpected inputs: …
- Explanation: This is the explicit error format in the node wrapper when execution receives fields that are not declared inputs. Settings such as width or frames are not separate inputs on this node.
- Solution: Supply only
project_id,arguments, and optionallyafterthrough the node interface. Put supported kit settings inside the JSON text inarguments.
Invalid JSON in arguments — exact message depends on the argument parser
- Explanation: Malformed JSON can prevent argument processing before kit creation begins. Common causes include single-quoted property names, trailing commas, or incomplete text. The supplied source does not include the parser’s exact error message.
- Solution: Use a complete JSON object with double-quoted property names and string values, such as
{"directory":"animation-kit","frames":60}.
Unsupported tool argument — exact message is not provided
- Explanation: The integration test confirms that the tool rejects a call containing an unexpected argument. A setting used by another animation tool is not automatically accepted by this tool.
- Solution: Remove unrelated or misspelled settings. Begin with the demonstrated
directoryandframesarguments, and consult the installed tool signature before adding other options.
ModuleNotFoundError: No module named 'bpy'
- Explanation: This is a possible downstream error when running the generated scene with ordinary Python rather than Blender’s Python environment. It concerns execution of the generated template, not necessarily kit creation.
- Solution: Run the scene through Blender or the installed Blender bridge instead of launching it with a standard Python interpreter.
ModuleNotFoundError: No module named 'openkatana'
- Explanation: The generated scene imports OpenKatana’s Blender helpers. A Blender environment that cannot find that package cannot construct the example scene.
- Solution: Use the configured OpenKatana Blender environment, or correct the package installation and Python search path used by Blender.
FileNotFoundError for config.json or display/receipt.json
- Explanation: The generated template reads these files relative to its own location. Running a copied script without its accompanying kit resources can therefore fail.
- Solution: Keep the kit’s folder structure intact, check that the named files exist, and prepare the display resources before executing the scene.
Blender render-engine or motion-blur property error — exact message depends on Blender
- Explanation: The template tries
BLENDER_EEVEEand falls back toBLENDER_EEVEE_NEXTon aTypeError, but it also assigns motion-blur properties directly. Differences between Blender versions may still cause errors during scene execution. - Solution: Use the Blender version supported by your installed OpenKatana bridge. If you maintain a customized environment, check the failing render setting against that Blender version’s API before modifying the editable template.
