JSPM

@rbxts/vfx-forge

2.4.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 35
  • Score
    100M100P100Q77563F
  • License SEE LICENSE IN LICENSE

The official emit module from the VFX Forge plugin used to emit visual effects in-game.

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@rbxts/vfx-forge) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    Banner

    View Documentation Join Discord

    Emit Module

    The is the official repository for the emit module provided by the VFX Forge Roblox plugin.

    License

    The emit module is licensed under a custom source-available copyleft license which only allows usage within Roblox games. That said, feel free to contribute and report bugs.

    Installation

    Wally (Luau)

    ForgeVFX = "zilibobi/forge-vfx@2.4.0"

    npm (TypeScript)

    npm i @zilibobi/forge-vfx

    Manual

    Check the releases page for prebuilt .rbxm files.

    Usage

    The module needs to be initialized before emitting any effects. After that it is also exposed inside shared.vfx.

    local ReplicatedStorage = game:GetService("ReplicatedStorage")

local vfx = require(ReplicatedStorage.ForgeVFX)

vfx.init()
vfx.emit(workspace.Effect)