/vfx-editor

An all-in-one tool for creating visual effects on Roblox.

Primary LanguageLuauMIT LicenseMIT

VFX Editor

An all-in-one tool for creating visual effects on Roblox.

License CI

Features

This plugin replaces and revamps the functionality of features that previously required multiple plugins to achieve. It includes:

  • A custom number sequence editor, supporting a wide range of easing styles and full Bezier curve support.
  • A color sequence editor
  • A texture storage system, which simulates a custom file system for textures, with full flipbook support.
  • Comprehensive support for every relevant property, allowing you to replace multiple plugins and the default Roblox properties window with a single, all-encompassing tool.
  • Full support for undo/redo on almost every action.
  • Full theme support, with both a default light and dark theme.
  • A lightweight mode, offering a stripped-down version of the plugin that includes only the most essential features, designed to mimic the original properties window for a minimal learning curve.

Getting Started

To get started, you can either get the plugin on the Roblox Marketplace here for automatic updates, build the plugin yourself or grab it from GitHub releases.

Installing via GitHub releases

  1. Click the latest release under "Releases"
  2. Download the "build.rbxm" file
  3. Open your Plugins folder (if you are not sure where this is, open Studio, navigate to the Plugins tab and click the "Plugins Folder" button)
  4. Drag "build.rbxm" into this folder and restart Studio

Building

Prerequisites

To build the plugin, you will need Aftman, a toolchain manager.

Instructions

Important

This project currently suffers from the thread 'main' has overflowed its stack issue caused by full-moon.

You can fix this by running ulimit -s 16384 before running the build command on Linux, or by increasing the Darklua executable stack size on Windows. You can do this by installing Visual Studio and opening the Developer Command Prompt for VS and running editbin /STACK:16777216 "C:\Users\<your user>\.aftman\tool-storage\seaofvoices\darklua\0.13.1\darklua.exe". While this is by no means a solution, overhauling the project to fix this (hopefully) temporary issue is not a priority at the moment.

If you need help with this, feel free to ping me in the Roblox OSS Discord server.

To build the plugin, clone the repository and run the following commands:

aftman install
lune run build

Then place the build.rbxm file in your Roblox plugins folder and restart Roblox Studio.

Wiki

For more information on how to use the plugin, please refer to the wiki

Contributing

Contributions are always welcomed. Code should follow Stylua and Selene formatting conventions. To contribute, fork this repository, make your changes, and create a pull request. Please make sure to test your changes before creating a pull request.

In order to run the stories to test your code, place a .luau file with the following code in your plugins folder:

plugin.Name = "plugin"

and make sure that Plugin Debugging is enabled in the Studio settings. This will then allow the components to find a plugin when needed. Flipbook is recommended as the storybook plugin.

This plugin is by no means perfect. If you find any bugs or have any suggestions, please create an issue.

Changelog

For a full list of changes, please refer to the changelog.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.