{"id":"zilibobi/forge-vfx","name":"forge-vfx","scope":"zilibobi","platform":"roblox","description":"The official emit module from the VFX Forge plugin used to emit visual effects in-game.","version":"2.4.0","latest":"2.4.0","versions":["1.5.0-beta","2.0.0-beta","2.0.0-beta.2","2.0.0-beta.3","2.0.0-beta.4","2.0.0-beta.5","2.1.0","2.2.0","2.2.1","2.2.2","2.3.0","2.4.0"],"license":"SEE LICENSE IN LICENSE","licenseRating":"caution","licenseCaveats":["Must use the same license for derivative works (copyleft)","Cannot use in plugins or tools outside of Roblox games","Must include license text with distributions","Commercial use is allowed only within specified contexts","Custom license terms, automatically reviewed — read the packaged LICENSE file before shipping this in a game."],"licenseVerified":false,"dependencies":{},"integrity":"a372b4ce33d5f9d3ef5e3f56fc14d7a820a6ae9e32a7e2fa716f8923c4fb6e39","likes":0,"downloads":7,"install":"forest install zilibobi/forge-vfx","url":"https://forest.dev/p/roblox/zilibobi/forge-vfx","files":"https://api.forest.dev/ai/package/roblox/zilibobi/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\nThe is the official repository for the emit module provided by the <a href=\"https://devforum.roblox.com/t/3867553\">VFX Forge</a> Roblox plugin.\n\n## License\nThe emit module is licensed under a custom source-available copyleft license which **<mark>only allows usage within Roblox games</mark>**. That said, feel free to contribute and report bugs.\n\n## Installation\n\n#### Wally (Luau)\n\n```sh\nForgeVFX = \"zilibobi/forge-vfx@2.4.0\"\n```\n\n#### npm (TypeScript)\n\n```sh\nnpm i @zilibobi/forge-vfx\n```\n\n#### Manual\n\nCheck the [releases page](https://github.com/zilibobi/forge-vfx/releases/latest) for prebuilt .rbxm files.\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}