Skip to content

Requirements

Supported baseline

  • OverAnim plugin version: 0.1.0 Beta
  • Documentation validation environment: Unreal Engine 5.8
  • Target: a Skeletal Mesh and its Skeleton

Compatibility

These procedures were tested with UE 5.8. Validate other engine versions and project-specific Skeletal Mesh settings separately.

Required assets

To verify your first asset, you need:

  • Target Skeleton
  • A matching Preview Mesh
  • An optional Preview Animation

Preview state is Editor-only. Validate requires a Preview Mesh to run the complete contract validation.

Runtime application requirements

Apply OverAnim succeeds only when:

  1. Over Anim Component can resolve a valid Skeletal Mesh.
  2. The Deformer Asset Target Skeleton matches the target Mesh Skeleton.
  3. Asset contract validation completes without errors.
  4. No other UOverAnimComponent owns the same Skeletal Mesh.

When Target Mesh is empty, the Component first uses the Character's GetMesh(). If unavailable, it searches the Owner for a valid Skeletal Mesh Component. Explicitly set Target Mesh on Actors with multiple Skeletal Meshes.

Documentation site requirements

Python and PowerShell are required to edit or serve the documentation locally.

The sources are in the OverAnimDocs repository. Clone the repository and run these scripts from its root:

  • install-docs.ps1: installs pinned dependencies from requirements.txt
  • serve-docs.ps1: starts the local development server
  • build-docs.ps1: performs a strict static-site build

The build output is created in site/; no offline documentation is generated inside the plugin. The published site is available at OverAnim Documentation.