Documentation

1. 1
   Open the Fab Marketplace in Unreal Engine
2. 2
   Search for "SparkFXPreviewer"
3. 3
   Click Install to add it directly to your engine
4. 4
   Restart Unreal Engine if prompted
5. 5
   Access via Tools → SparkFX → SparkFX Previewer

If you want to test without Fab, download the binary package for your Unreal Engine version:

Extract the downloaded file to a temporary location, then Run Installer: open the extracted folder, run Install.bat, drag your .uproject file onto the installer window, and press Enter when prompted. The installer copies SparkFXPreviewer into your project's Plugins/ folder.

Launch: open your project in Unreal Editor — the plugin loads automatically, no compilation required. Access via Tools → SparkFX → SparkFX Previewer.

1. 1
   Copy the SparkFXPreviewer folder to YourProject/Plugins/SparkFXPreviewer/
2. 2
   Open your project in Unreal Editor
3. 3
   The plugin will load automatically

1. 1
   Open Unreal Editor
2. 2
   Navigate to Tools → SparkFX → SparkFX Previewer
3. 3
   The SparkFXPreviewer window should open

If the menu item doesn't appear, check Edit → Plugins to ensure the plugin is enabled, then restart the editor after enabling.

Preview Niagara effects directly in the editor viewport with full control over timing and attachment.

• Niagara System SupportPreview any Niagara system from your project
• Skeletal AttachmentAttach effects to specific bones
• Timeline ControlPrecise timing adjustment
• One-Shot & LoopingTest both effect types
• 3D Transform GizmoDrag the VFX spawn point in-viewport; syncs live and restores on preset load
• Live Parameter EditingTweak exposed parameters during playback, save as new or write back
• Duplicate & ReorderOne-click duplicate, reorder with up/down arrows
• Inline RenameDouble-click a track name; Enter commits, Escape cancels

• Sound Cues & WavesPreview any audio asset
• Timing SynchronizationAlign audio with VFX triggers
• Projectile Impact SoundsAttach a sound to play at the moment of impact
• VFX Track SoundsAdd a sound directly to any VFX track
• Configurable Fade-OutIndependent fade-out duration for VFX and audio

• Standalone TrackFires at a configured time offset, independent of other tracks
• Inline on VFX/ProjectileAttach a shake so it fires alongside the effect
• AnimNotify ExportExports alongside all other track types

• Chain Up to 5 SequencesOn a unified virtual timeline
• Timeline Boundary MarkersDashed lines show where each sequence begins/ends
• Reorderable SlotsMove sequences up/down in the list
• Animation Montage SupportFull playback, scrub, loop, and root motion support
• Notify ExportWorks for both Animation Sequences and Montages

• Up to 4 Mesh PropsAttached to the preview scene
• Per-Slot Socket AttachmentEach prop attaches independently to its own socket
• Independent AnimationEach mesh prop can play its own animation
• Transform ControlsLocation, rotation, and scale per prop with a dedicated gizmo

• SparkFX Panel ControlsPosition and rotation spinboxes live in the Inspector
• Viewport GizmoAppears whenever a skeletal mesh is loaded, stays in sync
• Preset PersistencePosition and rotation are saved to your preset

• Outliner → SparkFXSelecting a gizmo in the Outliner selects the matching panel row
• SparkFX → OutlinerClicking a row highlights the gizmo in the viewport/Outliner
• All Gizmo TypesVFX track, mesh slot, and main character gizmos

• Configurable Fire RateSet rounds per second
• Burst CountDefine shots per burst
• Muzzle FlashPreview muzzle VFX on each shot
• Impact VFXSee impact effects for every projectile
• Audio SyncTest sound timing with rapid fire

1. 1
   Click Add Projectile Track
2. 2
   Choose Projectile Type (Linear, Arc, or Ballistic)
3. 3
   Set Spawn and Target locations
4. 4
   Assign Muzzle Flash and Impact VFX
5. 5
   Enable Rapid Fire if testing burst patterns
6. 6
   Press Play to visualize trajectories

• All Track ConfigurationsVFX, Sound, Projectile, and Camera Shake tracks
• Timing DataExact trigger times for each track
• Asset ReferencesLinks to Niagara systems, sounds, etc.
• Attachment SettingsBone attachments and socket data
• Projectile SettingsTrajectory type, spawn/target locations
• Gizmo Positions3D spawn point positions and names for each VFX gizmo
• Additional Mesh SlotsMesh, socket, animation, and transform data for up to 4 props
• Main Actor TransformPreview character position and rotation
• Multi-Sequence SetupAll animation slots and order, with backward compatibility

1. 1
   Set up your tracks and timing as desired
2. 2
   Click Save Preset
3. 3
   Enter a descriptive name (e.g., "SwordSlash_v2_FastTiming")
4. 4
   The preset saves to your project

1. 1
   Click Load Preset
2. 2
   Select your saved preset from the list
3. 3
   All tracks and settings are restored instantly

• Use Descriptive NamesInclude weapon/character name, version, and key attributes
• Save at MilestonesCreate presets during iteration to preserve working states
• Version Your PresetsAppend v1, v2, etc.
• Share with TeamPresets can be checked into version control
• Compare ApproachesLoad different presets to quickly compare timing

Playback speed multiplies the time delta for all systems:

• Animation PlaybackSkeletal mesh plays faster or slower
• VFX SystemsNiagara particles update at adjusted speed (via CustomTimeDilation)
• ProjectilesTrajectory timing scales proportionally
• SoundAudio plays at normal speed (timing preserved, not pitch-shifted)

• Doesn't Change AnimationOriginal animation asset is never modified
• Real-Time SyncAll active VFX and projectiles adjust immediately
• Persists Across SessionsSpeed setting remains after Stop/Play
• Works During ScrubbingSpeed affects scrub rate on timeline

• VFX TracksExported as PlayNiagaraEffect notifies
• Sound TracksExported as PlaySound notifies
• Timing PreservedExact trigger times maintained
• Attachment SettingsBone/socket attachments preserved

1. 1
   Set up your VFX and Sound tracks with desired timing
2. 2
   Select the target Animation Asset
3. 3
   Click Export to Anim Notifies
4. 4
   Notifies are created on the animation with your timing

Export as Notifies works for both Animation Sequences and Animation Montages. For Montages, notifies are written at the montage level (not inside individual slots) — this is standard UE montage behavior.

Exported AnimNotifies may require additional project-side setup:

• Notify ClassesEnsure your project has the necessary notify classes
• Niagara AccessVerify Niagara systems are accessible from the animation
• Sound AssetsCheck that sound assets are properly configured

Projectile types (Linear, Arc, Ballistic) provide visual approximation only. Designed for: ✅ timing iteration, ✅ trajectory feel, ✅ impact readability. Not intended to match: ❌ runtime gameplay logic, ❌ physics accuracy.

Projectiles do not track targets that move mid-flight — the target position is captured at fire time.

Camera shake preview provides timing reference only. The preview may differ from runtime behavior due to different camera configurations, player camera vs. editor camera, and runtime camera modifiers. Use it for timing alignment, not exact visual matching.

Inline camera shake on VFX and Projectile tracks does not expose Play Space control — use a dedicated Camera Shake track for Play Space (Camera Local / World / User Defined) control.

The SparkFX Position spinboxes (Inspector panel) and the Location field in UE's native Details panel show different numbers for the same gizmo. This is correct and expected — they measure different things: SparkFX Position is the offset relative to the preview character's world position; Details panel Location is the gizmo actor's absolute world position in the level.

Example: if your character is at world X=257 and you set SparkFX Position X to 242, the gizmo sits at world X=499 — and the Details panel shows 499. Both values are correct, and both fields stay fully synced in both directions. This is not a bug.

Backward scrubbing (dragging the timeline backward) does not retrigger one-shot effects. This prevents effect spam during iteration and matches expected timeline behavior — use Play to trigger effects normally.

• Cleanup GuaranteeAll audio is centrally tracked and cleaned up on Stop/Escape, Reset, Clear, track removal, preset load, and window close
• Keyboard Shortcuts Require FocusSpace, Escape, Arrows, Home/End need the SparkFXPreviewer window focused
• Reset Before ReplayAfter a non-looping animation ends, Play again may need a Reset first

Q: Why don't newly exported Anim Notifies appear immediately?
A: When exporting while the animation is already open, the Animation Editor may need a refresh. The notifies are saved correctly — close and reopen the animation to see them.

Q: Why doesn't the projectile hit exactly where I expect?
A: Projectile preview is for visual iteration, not physics simulation. Runtime behavior depends on your game's projectile system.

Q: Does this work in packaged games?
A: No. SparkFXPreviewer is editor-only by design — it has no runtime component and is not included in packaged builds.

These limitations exist because SparkFXPreviewer is designed to:

1. 1
   Show what exists — not simulate or invent data
2. 2
   Be deterministic — same input produces same output
3. 3
   Stay editor-safe — no impact on runtime behavior
4. 4
   Enable fast iteration — focus on timing and visual context

What's New in v2.0.2 — a packaging and compliance release, no feature or behavior changes.

• Fixed Binary Distribution ZIPsPackages now include Source/, Config/, Docs/, Resources/, README.md, and Install.bat
• Copyright HeadersUpdated to SparkFXLab across all source files

• Main Actor Transform ControlsReposition and rotate the preview character with synced gizmo and preset persistence
• Outliner ↔ SparkFX Selection SyncFor VFX, mesh slot, and main character gizmos
• Multi-Animation Sequence, up to 5Reorderable slots, timeline boundary markers
• Animation Montage SupportFull playback, scrub, loop, root motion, preset, and notify export
• Additional Mesh SlotsUp to 4 props, each with socket, animation, and transform controls
• Inline Track Rename, Duplicate & ReorderRename, duplicate, and reorder tracks in place
• 3D Transform GizmoVFX spawn points, mesh prop offsets, and main character
• Live Niagara Parameter EditingTweak parameters during playback
• Camera Shake TrackFull AnimNotify export support
• Complete UI Redesign (V2)Two-panel layout, live inspector, per-row color-coded timeline

Also included: tooltips across all 46 inspector fields, collapsible Animation/Tracks sections, a dedicated Add Track toolbar row, and dozens of smaller polish fixes since v1.8.0.

• ✅
  VFX Track SystemWith Niagara support
• ✅
  Projectile PreviewLinear, Arc, Ballistic
• ✅
  Rapid Fire Testing ModeBurst and automatic fire patterns
• ✅
  Sound Preview SystemSynced audio playback
• ✅
  Camera Shake PreviewStandalone or inline
• ✅
  Preset Save/Load SystemRepeatable, shareable setups
• ✅
  Export to Anim NotifiesDirect production hand-off
• ✅
  Debug Visualization ToolsTiming and trajectory overlays
• ✅
  3D Transform GizmoVFX spawn points, mesh slots, main character
• ✅
  Live Niagara Parameter EditingTweak during playback
• ✅
  Multi-Sequence & MontageUp to 5 sequences, full Montage support
• ✅
  Additional Mesh SlotsUp to 4 props
• ✅
  Main Actor Transform ControlsViewport gizmo and preset persistence
• ✅
  Outliner ↔ SparkFX SyncBoth directions
• ✅
  Duplicate & Reorder TracksVFX and Projectile tracks
• ✅
  Inline Track RenameDouble-click to rename

Binary Distribution — distributed as pre-compiled binaries: no source compilation required, faster installation, requires exact engine version match.

Plugin Dependencies — requires Niagara (for VFX preview) and core engine modules, typically enabled by default. No third-party plugin dependencies.