StudioMacros

wip ui keyboard shortcuts plugin

RobloxStudioBeta_Pub2qggTtP.mp4

how to install

either download the plugin file from the latest release and copy it to your studio plugins folder, or build it from source with npm and rojo.

how to build from source

1. clone the repo and cd into the directory

git clone https://github.com/unrooot/studiomacros && cd studiomacros

2. install dependencies with npm (node.js required)

npm i

3. build the plugin with rojo

rojo build --plugin StudioMacros.rbxm

---

how to use

in Roblox Studio, go to File -> Advanced -> Customize Shortcuts and bind "StudioMacros Commands" to a key (e.g. Shift+Space), then select an instance and press the shortcut to open the command palette.

keyboard shortcuts

• Up and Down to navigate the command palette (or Ctrl+J and Ctrl+K on macOS)
• Enter to run the selected command
• Shift+Enter to run the selected command without closing the command palette
• Esc to close the command palette (or clear the search)
• Ctrl+D to toggle descriptions on the macros in the list
• Shift+Escape to release focus from the command palette
• Tab and Shift+Tab to cycle through custom result inputs (currently only implemented in the color picker)

custom results

macros that pick a value (change color, change font, change font style) render inline when you run them from the command palette. running one from its own shortcut instead opens it in a floating plugin window, so you can keep working while it's up — Esc closes the window rather than dropping you back into the command list.

a note on input:

roblox studio plugins currently do not have a good way of handling input and focus (see here) so the command palette only receives what you type while the viewport is focused. opening it activates the plugin to pull focus back into the viewport, which is what lets you select an instance in the explorer and start typing without clicking anything first. that also takes the mouse for as long as the palette is open, so clicking it no longer clears your selection.

if you still land in a state where the textbox looks focused but swallows everything you type, right click the viewport to move your camera (this doesn't deselect the current instance) before opening the command palette.

---

how to add new macros

you will need to build the plugin to add new macros. create a new file in any folder inside of src/StudioMacros/macros with the following structure:

return {
	Name = "Macro Name",
	Description = "A description of the macro",

	-- optional values, when provided the macro will use the custom results to
	-- select arguments which will be passed to the macro. see:
	-- ChangeBackgroundColor.luau or ChangeFont.luau for an example
	CustomResults = "Color" | "Font" | "FontStyle" | "Number",
	TargetProperty = "BackgroundColor3",

	-- required by CustomResults = "Number". you type the value into the
	-- palette's own input and the evaluated result is previewed above the
	-- results. see: ChangeAspectRatio.luau for an example
	NumberInput = {
		Caption = "ratio",
		Prompt = "type an aspect ratio (16:9, 1.5, x/y)...",

		-- optional names usable inside the typed expression
		GetVariables = function(instance) end,
		-- optional rewrite applied before the expression is parsed
		Sanitize = function(text) end,
		-- optional, reject otherwise-valid numbers
		Validate = function(value) end,
	},

	-- optional, called instead of opening the palette when a CustomResults
	-- macro is triggered from outside of it (a keybind, say). use it to open
	-- your own window; without it the palette opens docked in a widget
	OpenWindow = function(plugin)
		NumberInputWidget.get(plugin, config):Open()
	end;

	-- optional predicate function that should return true if the macro should
	-- work + be available for the given instance
	Predicate = function(instance)
		return instance:IsA("BasePart")
	end;

	-- optional, when true the macro runs once and receives a table of every
	-- selected instance that passed the predicate instead of running once per
	-- instance. see: WrapIntoContainer.luau for an example
	RunOnSelection = true,

	-- when CustomResults is set, the picked values are passed after `plugin`.
	-- "Color" passes a Color3 and an alpha in 0-1 (1 being opaque), so a color
	-- macro looks like: function(instance, plugin, color, alpha)
	Macro = function(instance)
		instance.Position = Vector3.zero
		instance.Size = Vector3.one

		-- optionally return an instance (or table of instances) that will be
		-- selected after the macro is run
		return instance
	end;
}

if your macro needs a package from nevermore, return a function that receives the loader's require and returns the macro table instead (see WrapXSizeToText.luau for an example):

return function(require)
	local TextServiceUtils = require("TextServiceUtils")

	return {
		Name = "Macro Name",
		-- ...
	}
end

creating groups

to create a group of macros, create a new folder inside of the macros folder, and create a file called GroupData.luau with the following structure:

return {
	Name = "Group Name";
	Icon = "rbxassetid://1234567";
}

if you're actively creating and testing new macros, you can run rojo build with the --watch flag to automatically rebuild the plugin when you save a file (this requires "Plugin Debugging Enabled" setting to be enabled in studio).