{"id":"josephh310/forge-vfx","name":"forge-vfx","scope":"josephh310","platform":"roblox","description":"A fork of the VFX Forge emit module that can slow down, speed up and freeze every effect while it plays.","version":"1.0.1","latest":"1.0.1","versions":["1.0.0","1.0.1"],"license":"SEE LICENSE IN LICENSE","licenseRating":"caution","licenseCaveats":["Copyleft – any distributed derivative must be licensed under the same VFX‑DL‑1.1 terms","Use is limited to runtime code inside Roblox Experiences; plugins or other tools are prohibited","License text must be retained with every distribution of the module or derivative work","Violation terminates the granted rights and requires immediate cessation of use","Custom license terms, automatically reviewed — read the packaged LICENSE file before shipping this in a game."],"licenseVerified":false,"dependencies":{},"integrity":"100f5d80de8750443f19bc7794ee03fa9d09b9b66ff6c8c4809845718d614630","likes":0,"downloads":0,"install":"forest install josephh310/forge-vfx","url":"https://forest.dev/p/roblox/josephh310/forge-vfx","files":"https://api.forest.dev/ai/package/roblox/josephh310/forge-vfx/files","readme":"![Banner](/forge-banner.png)\n\n<div align=\"center\">\n  <a href=\"https://docs.zilibobi.dev/vfx-forge\"><img alt=\"View Documentation\" src=\"https://img.shields.io/badge/Documentation-View?style=for-the-badge&label=View&color=c4a7e7\"></a>\n  <a href=\"https://discord.gg/Qme9KPN3pF\"><img alt=\"Join Discord\" src=\"https://img.shields.io/discord/1401872327162986626?logo=discord&style=for-the-badge&color=c4a7e7&logoColor=ffffff&label=Join%20Discord\"></a>\n</div>\n\n# Emit Module\n\nThis is a fork of the emit module provided by the <a href=\"https://devforum.roblox.com/t/3867553\">VFX Forge</a> Roblox plugin, made from [zilibobi/forge-vfx](https://github.com/zilibobi/forge-vfx) after 2.4.0. It adds a playback rate, so every effect can be slowed down, sped up or frozen while it plays.\n\n```luau\nvfx.setRate(2) -- every effect, including ones already playing, runs twice as fast\nvfx.setRate(0) -- every effect freezes where it is\nvfx.track(workspace.Map) -- enabled emitters, beams, trails and sounds the engine runs by itself follow the rate too\n```\n\nThe rate covers delays, durations, tweens, flipbooks, particles, beams, trails, sounds, camera shakes and debris. Particles can't run faster than a TimeScale of 1, so an emitter authored at a TimeScale of 0.25 can be sped up to 4x. Debris keeps its path at any rate by scaling its velocity and the gravity on it.\n\n## License\nThe emit module is licensed under a custom source-available copyleft license which **<mark>only allows usage within Roblox games</mark>**. This fork is under the same license.\n\n## Installation\n\n#### Wally (Luau)\n\n```sh\nForgeVFX = \"josephh310/forge-vfx@1.0.1\"\n```\n\n## Usage\n\nThe module needs to be initialized before emitting any effects.\nAfter that it is also exposed inside `shared.vfx`.\n\n```luau\nlocal ReplicatedStorage = game:GetService(\"ReplicatedStorage\")\n\nlocal vfx = require(ReplicatedStorage.ForgeVFX)\n\nvfx.init()\nvfx.emit(workspace.Effect)\n```\n","readmeTruncated":false}