> For the complete documentation index, see [llms.txt](https://shaheerxansari.gitbook.io/hydroportdoc/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://shaheerxansari.gitbook.io/hydroportdoc/readme.md).

# README

**Fast Alembic fluid simulation import, playback, and cinematic rendering for Unreal Engine.**

HydroPort is a fluid-focused plugin for playing back baked, deforming Alembic polygon mesh caches (`.abc`) in Unreal Engine. It is built for artists bringing simulation results into real-time scenes and cinematic shots, not for running fluid simulation solvers within Unreal.

<figure><img src="https://3163553392-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWkKBDCamr3MmFrohl56q%2Fuploads%2FTr7dMAFB52kEzVnaTCg4%2FBreakdown_00000_00054.png?alt=media&amp;token=b85ad856-d294-47e6-ade3-275fe4eb5b35" alt=""><figcaption></figcaption></figure>

## Start here

{% stepper %}
{% step %}

## Install HydroPort

[Install HydroPort](/hydroportdoc/installation.md) for your supported engine version.
{% endstep %}

{% step %}

## Prepare your cache

[Prepare your cache](/hydroportdoc/cache-preparation.md): export **one deforming polygon mesh**, not transform-only or crowd data.
{% endstep %}

{% step %}

## Import your first fluid

[Import your first fluid](/hydroportdoc/quick-start.md), with all import options configured **before** pressing Import.
{% endstep %}

{% step %}

## Add a Fluid Cache track and render

[Add a Fluid Cache track](/hydroportdoc/sequencer.md) and [render through MRQ](/hydroportdoc/mrq-and-motion-blur.md).
{% endstep %}
{% endstepper %}

## What HydroPort is designed for

* Baked Alembic fluid mesh playback and shading
* Fluid meshes whose topology is triangulated
* Alembic velocity import (.v) for explicit deformation motion vectors
* Sequencer-driven cinematic evaluation and Movie Render Queue rendering
* On-demand frame decoding for large caches

## Compatibility

**Windows · Unreal Engine 5.7 and 5.8**, based on the developer's completed builds and tests. Verify the *packaged* plugin in a clean UE 5.8 project before claiming a fully validated release.

## Boundaries

HydroPort currently supports **single deforming Alembic polygon meshes**. It is not a general multi-object Alembic importer, a crowd/transform animation system, a real-time fluid simulator, or a guarantee of real-time arbitrary-frame scrubbing. See [Limitations](/hydroportdoc/limitations.md).