A modern, modular Roblox UI framework built entirely with LocalScripts.
- Runtime extensibility
- Modular architecture
- Theme system
- Plugin and module support
- Config import/export
- Command palette
- State manager
- Input manager
- Context menus
- Notifications
- Safe callback handling
- Zero external dependencies
Place the main framework inside a single LocalScript in:
StarterPlayer
└── StarterPlayerScripts
└── NoComment
Access the framework from any other LocalScript:
local UI = shared.NoComment
while not UI or not UI.Ready do
task.wait()
UI = shared.NoComment
endCreate a new window. If a window with the same Id already exists, the existing instance is returned.
local win = UI.CreateWindow({
Id = "MainMenu",
Title = "Main Menu",
Size = UDim2.fromOffset(720, 480),
Position = UDim2.fromOffset(120, 100),
})win:Minimize()
win:Maximize()
win:Close()local tab = win:AddTab("Home")
local section = tab:AddSection("Main Section")local win = UI.Windows["Demo"]
local tab = win:AddTab("External Tab")
local section = tab:AddSection("Added Later")local targetTab
for _, tab in ipairs(win.Tabs) do
if tab.Title == "Home" then
targetTab = tab
break
end
end
if targetTab then
targetTab:AddSection("New Section")
endEvery control returns an API object.
control:Get()
control:Set(value)
control:Reset()
control.Changed:Connect(function(value)
print(value)
end)
control:Destroy()| Control | Method |
|---|---|
| Label | AddLabel() |
| Paragraph | AddParagraph() |
| Divider | AddDivider() |
| Button | AddButton() |
| Toggle | AddToggle() |
| Checkbox | AddCheckbox() |
| Slider | AddSlider() |
| Range Slider | AddRangeSlider() |
| Textbox | AddTextbox() |
| Dropdown | AddDropdown() |
| Radio | AddRadio() |
| Multi Select | AddMultiSelect() |
| Progress Bar | AddProgress() |
| Badge | AddBadge() |
| Color Picker | AddColorPicker() |
The following methods are currently aliases:
AddKeybind() -- Textbox
AddTreeView() -- Paragraph
AddImageButton() -- Button
AddTooltip() -- Paragraph
AddRichText() -- ParagraphUI.Notify({
Title = "Saved",
Text = "Your settings were saved.",
Duration = 4,
})Use a built-in theme:
UI.SetTheme("Dark")
UI.SetTheme("Light")Create a custom theme:
UI.SetTheme({
Accent = Color3.fromRGB(255, 80, 120),
Panel = Color3.fromRGB(24, 24, 30),
})Common theme fields:
Background
Panel
Panel2
Stroke
Text
MutedText
Accent
Accent2
Danger
Success
Warning
Listen for changes:
UI.Theme.Changed:Connect(function(theme)
print(theme)
end)Open:
UI.CommandPalette.Show()Close:
UI.CommandPalette.Hide()Default shortcut:
F1
The command palette can search windows, controls, theme actions, and config actions.
UI.CreateSettingsWindow()Includes theme switching and configuration import/export.
UI.Modal({
Title = "Confirm",
Text = "Are you sure?",
ConfirmText = "OK",
Callback = function()
print("Confirmed")
end,
})local UserInputService = game:GetService("UserInputService")
UI.ContextMenu({
{
Text = "Notify",
Callback = function()
UI.Notify({ Text = "Clicked." })
end,
},
{
Text = "Settings",
Callback = function()
UI.CreateSettingsWindow()
end,
},
}, UserInputService:GetMouseLocation())Register a module:
UI.RegisterModule("MathTools", {
Init = function(UI)
print("Loaded")
end,
Add = function(a, b)
return a + b
end,
})Retrieve it later:
local MathTools = UI.GetModule("MathTools")
print(MathTools.Add(2, 3))Table plugin:
UI.RegisterPlugin("ExamplePlugin", {
Init = function(UI)
UI.Notify({
Title = "Plugin",
Text = "Plugin loaded.",
})
end,
})Function plugin:
UI.RegisterPlugin("QuickPlugin", function(UI)
print("Plugin loaded")
end)UI.StateManager.Set("CoinsVisible", true)
local visible = UI.StateManager.Get("CoinsVisible", false)Export:
local json = UI.ConfigManager:Export()Import:
local ok = UI.ConfigManager:Import(json)Bind:
UI.InputManager.Bind("OpenMenu", Enum.KeyCode.RightShift, function()
local win = UI.Windows["MainMenu"]
if win then
win.Frame.Visible = not win.Frame.Visible
end
end)Unbind:
UI.InputManager.Unbind("OpenMenu")Built-in shortcuts:
| Key | Action |
|---|---|
| F1 | Open Command Palette |
| Escape | Close Command Palette |
local win = UI.WindowManager.GetWindow("MainMenu")
UI.WindowManager.CloseAll()Callbacks are automatically wrapped with xpcall(), preventing errors from stopping the framework.
section:AddButton({
Text = "Error Test",
Callback = function()
error("Test error")
end,
})local UI = shared.NoComment
while not UI or not UI.Ready do
task.wait()
UI = shared.NoComment
end
local win = UI.CreateWindow({
Id = "MyRuntimeMenu",
Title = "Runtime Menu",
})
local tab = win:AddTab("Main")
local section = tab:AddSection("Controls")
section:AddButton({
Text = "Hello",
Callback = function()
UI.Notify({
Title = "Hello",
Text = "Added from another LocalScript.",
})
end,
})Any LocalScript can safely create windows, tabs, sections, controls, plugins, and modules at runtime without modifying the original framework.