mcpField
U
unreal-niagara

unreal-niagara

github.com/gamedev-skillsCreative & media5.4k5.8k installsUpdated 1d ago
Repository

About unreal-niagara

A skill for developers creating real-time effects in Unreal Engine 5.8 with Niagara. It covers the System, Emitter, and Module structure, plus runtime spawning and control, including User parameters and effect lifetime checks.

Key features

  1. 01Organize Niagara Systems, Emitters, and Modules
  2. 02Configure spawn, update, and render stages
  3. 03Expose User parameters for gameplay control
  4. 04Spawn effects at locations or on components
  5. 05Set parameters and activate or deactivate effects
  6. 06Check bounds and effect lifetime

Use cases

  1. 01Spawn impact or muzzle-flash effects
  2. 02Attach an effect to a weapon socket
  3. 03Control color and spawn rate from Blueprint or C++
  4. 04Troubleshoot effects that disappear or fail to stop

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/gamedev-skills/awesome-gamedev-agent-skills --skill unreal-niagara

After installing, type/unreal-niagarain Claude Code to confirm it loaded.

Details

From the project README

Unreal Niagara VFX

Build and control real-time visual effects in UE5 with Niagara: understand the System/Emitter/Module hierarchy, expose parameters you can drive from gameplay, and spawn effects at runtime. Targets UE 5.8. (Niagara replaces the legacy Cascade system.)

When to use

  • Use when creating a Niagara System (NS_) and Emitters (NE_), wiring modules in the spawn/update stages, exposing User parameters to gameplay, or spawning/driving an effect (impact, muzzle flash, fire, magic) from Blueprint or C++.
  • Use when the project has Niagara NS_/NE_ assets or references UNiagaraComponent.

When not to use: material/shader authoring (the look of a surface, not particles) is a separate topic; shader-programming covers cross-engine shader concepts. Audio for the effect → audio-design.

Core workflow

  1. Understand the hierarchy. A Niagara System (NS_) is the effect you place/spawn; it contains one or more Emitters (NE_, often emitter templates). Each emitter runs in stages: Emitter Spawn/Update, Particle Spawn/Update, optional Event Handler, and Render.
  2. Build behaviour from Modules, which execute top-to-bottom in each stage (Spawn Rate, Add Velocity, Gravity Force, Color over Life, etc.). Order matters — a later module reads the values earlier ones wrote.
  3. Know the parameter namespaces: System, Emitter, Particle, and User. Only User-namespace parameters are exposed to and settable from Blueprint/C++; the others are internal to the simulation.
  4. Spawn at runtime with UNiagaraFunctionLibrary::SpawnSystemAtLocation (world position) or SpawnSystemAttached (follows a component/socket), which return a UNiagaraComponent.
  5. Drive the effect by setting its User parameters on the returned component (color, spawn rate, a target position) and Activate/Deactivate it.
  6. Verify in the Niagara editor preview and in-level; check bounds (especially GPU emitters), and confirm the effect culls/destroys correctly.

Patterns

1. Spawn a one-shot effect at a world location (C++)
#include "NiagaraFunctionLibrary.h"
#include "NiagaraComponent.h"

// ImpactSystem is a UPROPERTY(EditAnywhere) TObjectPtr<UNiagaraSystem>.
void AProjectile::SpawnImpact(const FVector& Location, const FRotator& Rotation)
{
    UNiagaraComponent* FX = UNiagaraFunctionLibrary::SpawnSystemAtLocation(
        GetWorld(), ImpactSystem, Location, Rotation);
    // FX auto-destroys when finished for a one-shot (system marked non-looping).
}
2. Spawn attached to a socket (muzzle flash that follows the gun)
UNiagaraComponent* Muzzle = UNiagaraFunctionLibrary::SpawnSystemAttached(
    MuzzleSystem, WeaponMesh, FName("MuzzleSocket"),
    FVector::ZeroVector, FRotator::ZeroRotator,
    EAttachLocation::SnapToTarget, /*bAutoDestroy*/ true);
3. Drive an exposed User parameter at runtime
// Only User-namespace parameters can be set from gameplay. Names match the User parameter.
if (UNiagaraComponent* Fire = UNiagaraFunctionLibrary::SpawnSystemAttached(
        FireSystem, RootComponent, NAME_None, FVector::ZeroVector, FRotator::ZeroRotator,
        EAttachLocation::KeepRelativeOffset, /*bAutoDestroy*/ false))
{
    Fire->SetVariableFloat(FName("SpawnRate"), 250.f);                 // User.SpawnRate
    Fire->SetVariableLinearColor(FName("FireColor"), FLinearColor::Red);
}
4. Blueprint equivalent (node flow)
Spawn System at Location (System = NS_Impact, Location, Rotation)  -> returns Niagara Component
On the returned component:
  Set Niagara Variable (Float)  Name="SpawnRate"  Value=250
  Set Niagara Variable (LinearColor)  Name="FireColor"  Value=Red

Pitfalls

  • Trying to set a System/Emitter/Particle parameter from gameplay — it won't take. Expose it in the User namespace; only User parameters are settable via the component.
  • Using Cascade tutorials — Cascade is legacy/deprecated. Niagara is the current system; the emitter/module workflow differs.
  • Effect disappears or doesn't cull right — fixed/incorrect bounds, especially for GPU Compute emitters which need explicit Fixed Bounds. Set bounds on the emitter/system.
  • Looping effect never stops — spawned with bAutoDestroy = false and never Deactivate()d; manage the returned component's lifetime, or mark the system non-looping for one-shots.
  • GPU sim can't drive gameplay — GPU particle data isn't readily read back to the CPU; collision/events that gameplay must react to should use CPU emitters (or Niagara → gameplay via the data interface), not GPU.
  • Module order bugs — a Force/Velocity module placed before the one that initializes the value reads zero. Mind the top-to-bottom stack order.

References

  • Primary docs: "Overview of Niagara Effects" (https://dev.epicgames.com/documentation/en-us/unreal-engine/overview-of-niagara-effects-for-unreal-engine) and the UNiagaraFunctionLibrary / UNiagaraComponent API. Add the Niagara module to *.Build.cs for C++ access.

Related skills

  • shader-programming — material/shader concepts for particle materials.
  • unreal-cpp-gameplay — spawning effects from gameplay code and module setup.
  • unreal-blueprints — triggering effects from visual scripts.

Comments

Markdown supported