Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Footagesus/WindUI/llms.txt

Use this file to discover all available pages before exploring further.

WindUI is currently in Beta. Features and APIs may change between releases.
The fastest way to use WindUI is a single loadstring call at the top of your script. This fetches and executes the compiled bundle from GitHub directly.
local WindUI = loadstring(game:HttpGet("https://raw.githubusercontent.com/Footagesus/WindUI/main/dist/main.lua"))()
After this line, WindUI is ready to use. No additional setup is required.

Roblox Studio

If you are developing or testing in Roblox Studio, the loadstring/HttpGet approach is not available. Use the require-from-ReplicatedStorage workflow instead.
1

Clone or download the repository

Clone Footagesus/WindUI or download it as a ZIP and open the project in your editor.
2

Sync the source into ReplicatedStorage

Place the WindUI module folder inside ReplicatedStorage so that ReplicatedStorage:WaitForChild("WindUI") resolves to the module root containing Init.
3

Require the module

Use the following snippet in a LocalScript. This is the same pattern used in main.client.lua — it falls back to ReplicatedStorage automatically when running in Studio:
local cloneref = (cloneref or clonereference or function(instance)
    return instance
end)

local ReplicatedStorage = cloneref(game:GetService("ReplicatedStorage"))
local RunService = cloneref(game:GetService("RunService"))

local WindUI

if RunService:IsStudio() then
    WindUI = require(ReplicatedStorage:WaitForChild("WindUI"):WaitForChild("Init"))
else
    WindUI = loadstring(game:HttpGet("https://raw.githubusercontent.com/Footagesus/WindUI/main/dist/main.lua"))()
end
The pattern above is taken directly from main.client.lua in the WindUI repository. It keeps a single script that works in both Studio and live exploit environments without changes.