Gabibou UI

A customizable Luau interface library with a black, gray and white default theme. Build a window, add controls, then customize its appearance when needed.

Documentation

Read the guide — install the library and build your menu with a short, practical walkthrough.

• Complete example to copy
• Buttons and controls
• Appearance and mobile
• API methods · Default options · Troubleshooting

The same English guide powers the hosted documentation. The docs/ folder and .gitbook.yaml files also support GitBook Sync; see the publishing guide. Repository configuration alone does not mean a GitBook site has been published.

Release candidate 1.5.0-rc.26 includes window:Appearance() for an appearance editor, searchable commands and named presets. Presets stay in memory by default; developers can provide storage to keep them after relaunch. See the changelog for fixes in this candidate.

Start with one line

In a client environment that supports loadstring and game:HttpGet, load the current source from GitHub:

local UI = loadstring(game:HttpGet('https://raw.githubusercontent.com/Gabibou455/GabibouUI/main/gabibou_ui.luau'))()

The main URL follows repository updates. To keep a project on a fixed version, replace main with a published release tag from the Releases page.

Create a window

local window = UI:CreateWindow('My project')
local tab = window:Tab('Home', 'home')
tab:Button('Hello', function()
    print('Hello!')
end)

The title-first API accepts simple arguments for common controls. Tables remain available for options and advanced configuration. For example, tab:Toggle('Effects', function(enabled) print(enabled) end) creates a toggle that starts off. See the live documentation for the quickstart, controls, and appearance options.

Roblox Studio

For a standard Roblox Studio client script, place the standalone source in a ModuleScript named GabibouUI under ReplicatedStorage, then load it with require:

local ReplicatedStorage = game:GetService('ReplicatedStorage')
local UI = require(ReplicatedStorage:WaitForChild('GabibouUI'))

Studio client scripts do not provide the remote loadstring(game:HttpGet(...)) pattern. See the Studio installation guide for setup details.

Documentation and examples

The live developer documentation covers controls, appearance, layouts, loading screens, values, and extension hooks. Repository references and examples:

Resource	Purpose
API guide	Installation, controls and public API
Customization	Layouts, animations and extension hooks
Icon IDs	Icon names and numeric IDs
Icon browser	Offline search, variants, PNG and SVG files
Demo	Interactive component and icon gallery
Quick start	Small Studio example
Loading example	Layouts, custom content and animation
Key and Discord example	Access screen and Discord copy button
Remote example	Remote loading with explicit errors
Publishing guide	Repository, version tags and releases

Download GabibouUI.zip from the GitHub Releases page, then open GabibouUI_Icons/index.html locally to use the icon browser. Its HTML is an offline tool; the GitHub file view does not run it.

Source layout

gabibou_ui.luau is the standalone library. The gabibou_ui folder contains its source modules and examples. After editing source modules, rebuild from the repository root with:

node gabibou_ui/build.cjs

Node.js is a build dependency; scripts that load the standalone library do not need it. PNG/SVG assets are optional at runtime because the native icon renderer does not download images.

License

MIT. See LICENSE. The library and its catalogue drawings are original to this project. The Discord mark is covered separately in THIRD_PARTY.md.