Eve library

ISIS V2 Engine Export Bundles

Guide

Revision 1

On this page

WS06-007 adds first-class engine export bundle support for Unreal, Unity, and Godot with manifest metadata.

Implemented Scope#

  • Added deterministic engine bundle generation utilities in @isis/3d-generation:
    • createEngineExportBundles(source, options?)
    • validateEngineExportBundles(bundles, requiredEngines?)
  • Added typed bundle manifests containing:
    • source mesh descriptor
    • material workflow + texture slot coverage
    • per-file manifest entries including README/package scaffold metadata, metadata manifests, and engine config file paths
  • Added API/registry/client contract support for engineBundles under 3D package outputs.
  • Added workflow schema support for declaring 3D engine_bundles contracts for Unreal/Unity/Godot output artifacts.
  • Extended output contract lint derivation to include engine bundle artifacts in required output contracts.

Bundle Targets#

  • unreal with required config file: Config/DefaultEngine.ini
  • unity with required config file: ProjectSettings/ProjectSettings.asset
  • godot with required config file: project.godot

Manifest Metadata#

Each engine bundle includes manifest metadata with:

  • manifestVersion
  • generatedAt
  • engine
  • sourceWorkflowId (when available)
  • sourceMesh descriptor (format, upAxis, unitScaleMeters)
  • materialWorkflows
  • textureSlots
  • files (path, role, optional source URL/mime/size)

Package Scaffold#

Each engine bundle manifest now requires these deterministic package scaffold entries:

  • README.md
  • package.json
  • metadata/manifest.json
  • engine-specific config file path

Integrity validation also enforces:

  • unique bundle file paths
  • archive MIME type alignment with archive format
  • archive URL alignment with emitted bundle filename
  • deterministic filename suffixes of the form _{engine}.{archiveExtension}