Crate tui_vfx_recipes 

TUI VFX Recipes

JSON recipe loading, parsing, and validation for the tui-vfx ecosystem.

This crate provides:

• JSON schema definitions for visual effect recipes
• Recipe parsing and validation
• Template inheritance and resolution
• Recipe registry for managing collections of recipes
• Preview and animation management
• Ratatui buffer integration via Grid adapter

Quick Start

use tui_vfx_recipes::prelude::*;

// Load a recipe
let recipe = load(Path::new("recipes/my_effect.json"), Path::new("."))?;

// Create a preview manager
let mut manager = PreviewManager::new();
let item = preview_from_recipe_config(recipe.config());
manager.add(item, Instant::now());

// Render in your loop
manager.tick(now);
manager.render(frame_area, &mut buffer, now);

Features

• async - Enable async recipe loading with tokio

Note

This crate is under active development. Some imports may need adjustment as the tui-vfx library stabilizes.

Re-exports

pub use inspector::InspectorContext;

pub use recipe::Recipe;

pub use recipe::RecipeError;

pub use recipe::load;

pub use recipe::parse;

pub use registry::cls_recipe_registry::RecipeRegistry;

pub use state::AnimationPhase;

Modules

compat

Compatibility module for converting between ratatui types and tui-vfx types.

inspector

interactions

Interaction state types for the recipe system.

manager

prelude

Prelude

preview

Preview module for animation playback.

recipe

recipe_schema

V2 recipe schema and parser with template inheritance support.

recipes

registry

rendering

state

theme

traits

types

Macros

inspect

Macro for calling inspector methods when an inspector is present.