Roblox Studio

Installing Obsidian in Roblox Studio

To install Obsidian in Roblox Studio, you can copy the Library.lua file into a modulescript and require it.

local Library = require(game:GetService("ReplicatedStorage"):WaitForChild("Obsidian"))

Setting up Icons

If you want lucide icon support, save the lucide icon registry as a modulescript and require it.

local Library = require(game:GetService("ReplicatedStorage"):WaitForChild("Obsidian"))
local Icons = require(game:GetService("ReplicatedStorage"):WaitForChild("Lucide"))
 
-- Set Library Icon Module
Library:SetIconModule(Icons)

Then, you should be good to go! You can start by checking out the Window section to create your first window, tab, groupbox and UI elements.

If you are too lazy to read the documentation, you can also check out the example script.

Addons

Due to Roblox Studio's limitations, only one addon is available for Roblox Studio at the moment. The ThemeManager addon is available to use (and it will not be able to save themes).

Installing ThemeManager

To install the ThemeManager addon, you can copy the addons/ThemeManager.lua file into a modulescript and require it.

local Obsidian = game:GetService("ReplicatedStorage"):WaitForChild("Obsidian")
 
local Library = require(Obsidian)
local ThemeManager = require(Obsidian:WaitForChild("ThemeManager"))

Types

The library comes with a type definition file for the lsp.

You can find the type definition file here.