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 an open-source Luau UI library for Roblox script hubs. It gives you a fully-featured window system, a set of interactive elements, multiple built-in themes, a config/flag system for persisting state, and a key system for access control — everything a modern script hub UI needs, packaged as a single loadstring call.
WindUI is currently in Beta. This project is still under active development. Bugs, issues, and unstable features may occur. Report any problems you encounter on GitHub or in the Discord server.

​
Key features

Window system

A draggable, resizable window with a configurable topbar, tab panels, section groups, and an optional open/close button.

Built-in themes

Dark, Light, Rose, Plant, Indigo, Sky, Violet, Amber, and more. Themes are swappable at runtime with WindUI:SetTheme().

Rich UI elements

Toggle, Button, Slider, Input, Dropdown, Colorpicker, Keybind — all with optional descriptions, icons, and locked states.

Config & flag system

Attach a Flag string to any element and use the built-in config manager to save and load values between sessions.

Key system

Gate your hub behind a static key, a key list, or an external API validator. Supports HWID-bound saved keys.

Notifications & popups

Toast notifications with icon, duration, and close controls. Modal popup dialogs with configurable action buttons.

​
Links

​
Credits

WindUI ships with support for several icon libraries via the Footagesus/Icons package: