Studio plugins

Create Luau editor extensions and manage them in Studio.

A Studio plugin is a folder of Luau source with a plugin.toml manifest. Plugins extend the editor with commands, ribbon buttons, panels, viewport tools, importers, exporters, and property editors.

Create a pluginCopy link

In an open Studio project, select Plugins → New plugin, enter a name, and select Create plugin. Studio creates the plugin folder and starts it. The generated plugin adds a panel and a button on the Plugins tab.

The generated folder contains plugin.toml, src/init.luau, a first test under tests/, and editor types under types/studio/. In the Plugins manager, select the plugin and choose Open folder. Open src/init.luau in a text editor to change the plugin's behavior.

PermissionsCopy link

The manifest declares the plugin's API version and permissions. Document access defaults to none and can be read or write. Script access and file access default to false. Asset access defaults to none and can be read or write.

Studio requests approval for project plugins per project and personal plugins once. A manifest with an unknown permission or unsupported newer API version is rejected with an error. Correct the manifest or use a Studio version that supports the declared API before enabling the plugin.

Reload behaviorCopy link

Saving a plugin source file reloads the plugin in Studio. Registrations are removed when the plugin unloads. A compile error or startup failure keeps the last working version running and reports the error in Output under the plugin's name. Correct the reported source and save again to load the updated version.

Development toolsCopy link

On the Plugins tab, select Plugins to open the manager. Select a plugin and choose Validate to inspect manifest and source problems, then correct the reported file and select Reload. Runtime errors appear in Output under the plugin's name.

Plugin development describes command-line validation, headless tests, and refreshing editor types.