" %}
Documentation
{% endembed %}
## Creating Options
\`\`\`lua
local Options = Fluent.Options
\`\`\`
{% hint style="info" %}
Options are used by the library to save the elements to access them in the future
{% endhint %}
## Creating Notifications
\`\`\`lua
Fluent:Notify({
Title = "Notification",
Content = "This is a notification",
SubContent = "SubContent", -- Optional
Duration = 5 -- Set to nil to make the notification not disappear
})
\`\`\`
## Creating Dialogs
\`\`\`lua
Window:Dialog({
Title = "Title",
Content = "This is a dialog",
Buttons = {
{
Title = "Confirm",
Callback = function()
print("Confirmed the dialog.")
end
}, {
Title = "Cancel",
Callback = function()
print("Cancelled the dialog.")
end
}
}
})
\`\`\`
## Creating Tabs
-- Fluent provides Lucide Icons, they are optional
local Tabs = {
Main = Window:AddTab({ Title = "Main", Icon = "" }),
Settings = Window:AddTab({ Title = "Settings", Icon = "settings" })
}
### Tab (Settings) With Interface And Configs
\`\`\`lua
local SaveManager = loadstring(game:HttpGet("https://raw.githubusercontent.com/dawid-scripts/Fluent/master/Addons/SaveManager.lua"))()
local InterfaceManager = loadstring(game:HttpGet("https://raw.githubusercontent.com/dawid-scripts/Fluent/master/Addons/InterfaceManager.lua"))()
SaveManager:SetLibrary(Fluent)
InterfaceManager:SetLibrary(Fluent)
InterfaceManager:BuildInterfaceSection(Tabs.Settings)
SaveManager:BuildConfigSection(Tabs.Settings)
\`\`\`
### Selecting Main Tab
\`\`\`lua
Window:SelectTab(1)
\`\`\`
### Icons
{% embed url="" %}
## Creating Sections
\`\`\`lua
local Section = Tab:AddSection("Section Name")
\`\`\`
{% hint style="info" %}
Section can be used as a parent for any element instead of a tab
{% endhint %}
local Section = Tab:AddSection("Section Name")
Section:AddParagraph({
Title = "Paragraph"
})
## Creating Paragraphs
\`\`\`lua
Tab:AddParagraph({
Title = "Paragraph",
Content = "This is a paragraph.\\nSecond line!"
})
\`\`\`
## Creating Buttons
Tab:AddButton({
Title = "Button",
Description = "Very important button",
Callback = function()
print("Hello, world!")
end
})
## Creating Toggles
\`\`\`lua
local Toggle = Tab:AddToggle("MyToggle",
{
Title = "Toggle",
Description = "Toggle description",
Default = false
Callback = function(state)
if state then
print("Toggle On")
else
print("Toggle Off")
end
end
})
\`\`\`
### Event Handling
Toggle:OnChanged(function()
print("Toggle changed:", Options.MyToggle.Value)
end)
### Changing Value
\`\`\`lua
Toggle:SetValue(false)
\`\`\`
## Creating Sliders
{% code fullWidth="false" %}
\`\`\`lua
local Slider = Tab:AddSlider("Slider",
{
Title = "Slider",
Description = "This is a slider",
Default = 2,
Min = 0,
Max = 5,
Rounding = 1,
Callback = function(Value)
print("Slider was changed:", Value)
end
})
\`\`\`
{% endcode %}
### Event Handling
\`\`\`lua
Slider:OnChanged(function(Value)
print("Slider changed:", Value)
end)
\`\`\`
### Changing Value
\`\`\`lua
Slider:SetValue(3)
\`\`\`
## Creating Dropdowns
\`\`\`lua
local Dropdown = Tab:AddDropdown("Dropdown", {
Title = "Dropdown",
Description = "Dropdown description",
Values = {"one", "two", "three", "four", "five", "six", "seven", "eight", "nine", "ten", "eleven", "twelve", "thirteen", "fourteen"},
Multi = false,
Default = 1,
})
\`\`\`
### Multiple Dropdown
\`\`\`lua
local MultiDropdown = Tab:AddDropdown("MultiDropdown", {
Title = "Dropdown",
Description = "You can select multiple values.",
Values = {"one", "two", "three", "four", "five", "six", "seven", "eight", "nine", "ten", "eleven", "twelve", "thirteen", "fourteen"},
Multi = true,
Default = {"seven", "twelve"},
})
\`\`\`
### Event Handling
\`\`\`lua
Dropdown:OnChanged(function(Value)
print("Dropdown changed:", Value)
end)
\`\`\`
\`\`\`lua
MultiDropdown:OnChanged(function(Value)
local Values = {}
for Value, State in next, Value do
table.insert(Values, Value)
end
print("Mutlidropdown changed:", table.concat(Values, ", "))
end)
\`\`\`
### Changing Value
\`\`\`lua
Dropdown:SetValue("four")
\`\`\`
\`\`\`lua
MultiDropdown:SetValue({
three = true,
five = true,
seven = false
})
\`\`\`
## Creating Colorpickers
\`\`\`lua
local Colorpicker = Tab:AddColorpicker("Colorpicker", {
Title = "Colorpicker",
Description = "Description for colorpicker",
Default = Color3.fromRGB(96, 205, 255)
})
Colorpicker:OnChanged(function()
print("Colorpicker changed:", Colorpicker.Value)
end)
Colorpicker:SetValueRGB(Color3.fromRGB(0, 255, 140))
\`\`\`
### Transparency Colorpicker
\`\`\`lua
local TColorpicker = Tab:AddColorpicker("TransparencyColorpicker", {
Title = "Colorpicker",
Description = "but you can change the transparency.",
Transparency = 0,
Default = Color3.fromRGB(96, 205, 255)
})
\`\`\`
### Event Handling
\`\`\`lua
Colorpicker:OnChanged(function()
print("Colorpicker changed:", Colorpicker.Value)
end)
TColorpicker:OnChanged(function()
print(
"TColorpicker changed:", TColorpicker.Value,
"Transparency:", TColorpicker.Transparency
)
end)
\`\`\`
### Changing Value
\`\`\`lua
Colorpicker:SetValueRGB(Color3.fromRGB(0, 255, 140))
TColorpicker:SetValue({0, 100, 100}, 0.5) -- hsv, transparency
\`\`\`
## Creating Keybinds
local Keybind = Tab:AddKeybind("Keybind", {
Title = "Keybind",
Description = "Keybind Description",
Mode = "Toggle", -- Always, Toggle, Hold
Default = "LeftControl", -- String as the name of the keybind (MB1, MB2 for mouse buttons)
-- Occurs when the keybind is clicked, Value is \`true\`/\`false\`
Callback = function(Value)
print("Keybind clicked!", Value)
end,
-- Occurs when the keybind itself is changed, \`New\` is a KeyCode Enum OR a UserInputType Enum
ChangedCallback = function(New)
print("Keybind changed!", New)
end
})
### Event Handling
\`\`\`lua
-- OnClick is only fired when you press the keybind and the mode is Toggle
-- Otherwise, you will have to use Keybind:GetState()
Keybind:OnClick(function()
print("Keybind clicked:", Keybind:GetState())
end)
Keybind:OnChanged(function()
print("Keybind changed:", Keybind.Value)
end)
task.spawn(function()
while true do
wait(1)
-- example for checking if a keybind is being pressed
local state = Keybind:GetState()
if state then
print("Keybind is being held down")
end
if Fluent.Unloaded then break end
end
end)
\`\`\`
### Changing Value
\`\`\`lua
Keybind:SetValue("MB2", "Toggle") -- Sets keybind to MB2, mode to Hold
\`\`\`
## Creating Inputs
\`\`\`lua
local Input = Tab:AddInput("Input", {
Title = "Input",
Description = "Input Description",
Default = "Default",
Placeholder = "Placeholder",
Numeric = false, -- Only allows numbers
Finished = false, -- Only calls callback when you press enter
Callback = function(Value)
print("Input changed:", Value)
end
})
\`\`\`
### Event Handling
\`\`\`lua
Input:OnChanged(function()
print("Input updated:", Input.Value)
end)
\`\`\`
### Changing Value
\`\`\`lua
Input:SetValue("Text")
\`\`\`
### Toggle Gui Transparency
\`\`\`lua
Fluent:ToggleTransparency(false) and Fluent:ToggleTransparency(true)
\`\`\`
### Toggle Acrylic (Blur)
\`\`\`lua
Fluent:ToggleAcrylic(false) or Fluent:ToggleAcrylic(true)
\`\`\`
### Destroy Fluent
\`\`\`lua
Fluent:Destroy()
\`\`\`
\[^1\]: \[#creating-options\](#creating-options "mention")
---
# Unknown
\> For the complete documentation index, see \[llms.txt\](https://forgenet.gitbook.io/fluent-documentation/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://forgenet.gitbook.io/fluent-documentation/documentation/documentation.md).
# Documentation
{% hint style="info" %}
All types have a link to the documentation, for example: \[string\](https://www.lua.org/pil/2.4.html)
{% endhint %}
{% hint style="info" %}
Mandatory method argument is marked with "\\\*"
\*\*Example:\*\* Agrument\\\*: \[type\](https://www.lua.org/pil/2.html)
{% endhint %}
{% hint style="warning" %}
Missing info is marked with "\\\[?\]\[^1\]"
{% endhint %}
\[^1\]: Missing information
---
# Unknown
\> For the complete documentation index, see \[llms.txt\](https://forgenet.gitbook.io/fluent-documentation/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://forgenet.gitbook.io/fluent-documentation/documentation/documentation/fluent.md).
# Fluent
## Library
### Properties
| Property | Type | Description |
| --------------- | ------------------------------------------------------------------------------ | ------------------------------------- |
| Version | \[string\](https://www.lua.org/pil/2.4.html) | Contains the library version |
| OpenFrames | \[table\](https://www.lua.org/pil/2.5.html) | \\\[?\]\[^1\] |
| Options | \[table\](https://www.lua.org/pil/2.5.html) | Contains library options and elements |
| Themes | \[table\](https://www.lua.org/pil/2.5.html) | Contains library \[themes\](#themes) |
| Window | \[Window\](#creating-window) | Contains created window |
| WindowFrame | \[Frame\](https://create.roblox.com/docs/reference/engine/classes/Frame) | Contains window gui frame |
| Unloaded | \[boolean\](https://www.lua.org/pil/2.2.html) | Is fluent unloaded |
| Theme | \[string\](https://www.lua.org/pil/2.4.html) | Contains selected theme |
| DialogOpen | \[boolean\](https://www.lua.org/pil/2.2.html) | Is dialog open |
| UseAcrylic | \[boolean\](https://www.lua.org/pil/2.2.html) | Is acrylic enabled |
| Acrylic | \[boolean\](https://www.lua.org/pil/2.2.html) | \\\[?\]\[^1\] |
| Transparency | \[boolean\](https://www.lua.org/pil/2.2.html) | Is transparency enabled |
| MinimizeKeybind | \[KeyCode\](https://create.roblox.com/docs/reference/engine/enums/KeyCode) | Contains keybind to minimize window |
| MinimizeKey | \[KeyCode\](https://create.roblox.com/docs/reference/engine/enums/KeyCode) | \\\[?\]\[^1\] |
| GUI | \[ScreenGui\](https://create.roblox.com/docs/reference/engine/classes/ScreenGui) | Contains library ScreenGui |
### Methods
| Method | Arguments | Description |
|---|
| CreateWindow(Config) | Config: table | Creates window |
| SetTheme(Theme) | Theme\*: string | Sets the specified GUI theme |
| Destroy() | | Destroys window |
| ToggleAcrylic(State) | State: boolean | Toggles acrylic rendering |
| ToggleTransparency(State) | State: boolean | Toggles transparency rendering |
| Notify(Config) | Config: table | Creates notification |
\[^1\]: Missing information
---
# Unknown
\> For the complete documentation index, see \[llms.txt\](https://forgenet.gitbook.io/fluent-documentation/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://forgenet.gitbook.io/fluent-documentation/documentation/guide/interface-manager.md).
# Interface Manager
---
# Unknown
\> For the complete documentation index, see \[llms.txt\](https://forgenet.gitbook.io/fluent-documentation/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://forgenet.gitbook.io/fluent-documentation/documentation/examples.md).
# Examples
\`\`\`lua
local Fluent = loadstring(game:HttpGet("https://github.com/dawid-scripts/Fluent/releases/latest/download/main.lua"))()
local SaveManager = loadstring(game:HttpGet("https://raw.githubusercontent.com/dawid-scripts/Fluent/master/Addons/SaveManager.lua"))()
local InterfaceManager = loadstring(game:HttpGet("https://raw.githubusercontent.com/dawid-scripts/Fluent/master/Addons/InterfaceManager.lua"))()
local Window = Fluent:CreateWindow({
Title = "Fluent " .. Fluent.Version,
SubTitle = "by dawid",
TabWidth = 160,
Size = UDim2.fromOffset(580, 460),
Acrylic = true, -- The blur may be detectable, setting this to false disables blur entirely
Theme = "Dark",
MinimizeKey = Enum.KeyCode.LeftControl -- Used when theres no MinimizeKeybind
})
--Fluent provides Lucide Icons https://lucide.dev/icons/ for the tabs, icons are optional
local Tabs = {
Main = Window:AddTab({ Title = "Main", Icon = "" }),
Settings = Window:AddTab({ Title = "Settings", Icon = "settings" })
}
local Options = Fluent.Options
do
Fluent:Notify({
Title = "Notification",
Content = "This is a notification",
SubContent = "SubContent", -- Optional
Duration = 5 -- Set to nil to make the notification not disappear
})
Tabs.Main:AddParagraph({
Title = "Paragraph",
Content = "This is a paragraph.\\nSecond line!"
})
Tabs.Main:AddButton({
Title = "Button",
Description = "Very important button",
Callback = function()
Window:Dialog({
Title = "Title",
Content = "This is a dialog",
Buttons = {
{
Title = "Confirm",
Callback = function()
print("Confirmed the dialog.")
end
},
{
Title = "Cancel",
Callback = function()
print("Cancelled the dialog.")
end
}
}
})
end
})
local Toggle = Tabs.Main:AddToggle("MyToggle", {Title = "Toggle", Default = false })
Toggle:OnChanged(function()
print("Toggle changed:", Options.MyToggle.Value)
end)
Options.MyToggle:SetValue(false)
local Slider = Tabs.Main:AddSlider("Slider", {
Title = "Slider",
Description = "This is a slider",
Default = 2,
Min = 0,
Max = 5,
Rounding = 1,
Callback = function(Value)
print("Slider was changed:", Value)
end
})
Slider:OnChanged(function(Value)
print("Slider changed:", Value)
end)
Slider:SetValue(3)
local Dropdown = Tabs.Main:AddDropdown("Dropdown", {
Title = "Dropdown",
Values = {"one", "two", "three", "four", "five", "six", "seven", "eight", "nine", "ten", "eleven", "twelve", "thirteen", "fourteen"},
Multi = false,
Default = 1,
})
Dropdown:SetValue("four")
Dropdown:OnChanged(function(Value)
print("Dropdown changed:", Value)
end)
local MultiDropdown = Tabs.Main:AddDropdown("MultiDropdown", {
Title = "Dropdown",
Description = "You can select multiple values.",
Values = {"one", "two", "three", "four", "five", "six", "seven", "eight", "nine", "ten", "eleven", "twelve", "thirteen", "fourteen"},
Multi = true,
Default = {"seven", "twelve"},
})
MultiDropdown:SetValue({
three = true,
five = true,
seven = false
})
MultiDropdown:OnChanged(function(Value)
local Values = {}
for Value, State in next, Value do
table.insert(Values, Value)
end
print("Mutlidropdown changed:", table.concat(Values, ", "))
end)
local Colorpicker = Tabs.Main:AddColorpicker("Colorpicker", {
Title = "Colorpicker",
Default = Color3.fromRGB(96, 205, 255)
})
Colorpicker:OnChanged(function()
print("Colorpicker changed:", Colorpicker.Value)
end)
Colorpicker:SetValueRGB(Color3.fromRGB(0, 255, 140))
local TColorpicker = Tabs.Main:AddColorpicker("TransparencyColorpicker", {
Title = "Colorpicker",
Description = "but you can change the transparency.",
Transparency = 0,
Default = Color3.fromRGB(96, 205, 255)
})
TColorpicker:OnChanged(function()
print(
"TColorpicker changed:", TColorpicker.Value,
"Transparency:", TColorpicker.Transparency
)
end)
local Keybind = Tabs.Main:AddKeybind("Keybind", {
Title = "KeyBind",
Mode = "Toggle", -- Always, Toggle, Hold
Default = "LeftControl", -- String as the name of the keybind (MB1, MB2 for mouse buttons)
-- Occurs when the keybind is clicked, Value is \`true\`/\`false\`
Callback = function(Value)
print("Keybind clicked!", Value)
end,
-- Occurs when the keybind itself is changed, \`New\` is a KeyCode Enum OR a UserInputType Enum
ChangedCallback = function(New)
print("Keybind changed!", New)
end
})
-- OnClick is only fired when you press the keybind and the mode is Toggle
-- Otherwise, you will have to use Keybind:GetState()
Keybind:OnClick(function()
print("Keybind clicked:", Keybind:GetState())
end)
Keybind:OnChanged(function()
print("Keybind changed:", Keybind.Value)
end)
task.spawn(function()
while true do
wait(1)
-- example for checking if a keybind is being pressed
local state = Keybind:GetState()
if state then
print("Keybind is being held down")
end
if Fluent.Unloaded then break end
end
end)
Keybind:SetValue("MB2", "Toggle") -- Sets keybind to MB2, mode to Hold
local Input = Tabs.Main:AddInput("Input", {
Title = "Input",
Default = "Default",
Placeholder = "Placeholder",
Numeric = false, -- Only allows numbers
Finished = false, -- Only calls callback when you press enter
Callback = function(Value)
print("Input changed:", Value)
end
})
Input:OnChanged(function()
print("Input updated:", Input.Value)
end)
end
-- Addons:
-- SaveManager (Allows you to have a configuration system)
-- InterfaceManager (Allows you to have a interface managment system)
-- Hand the library over to our managers
SaveManager:SetLibrary(Fluent)
InterfaceManager:SetLibrary(Fluent)
-- Ignore keys that are used by ThemeManager.
-- (we dont want configs to save themes, do we?)
SaveManager:IgnoreThemeSettings()
-- You can add indexes of elements the save manager should ignore
SaveManager:SetIgnoreIndexes({})
-- use case for doing it this way:
-- a script hub could have themes in a global folder
-- and game configs in a separate folder per game
InterfaceManager:SetFolder("FluentScriptHub")
SaveManager:SetFolder("FluentScriptHub/specific-game")
InterfaceManager:BuildInterfaceSection(Tabs.Settings)
SaveManager:BuildConfigSection(Tabs.Settings)
Window:SelectTab(1)
Fluent:Notify({
Title = "Fluent",
Content = "The script has been loaded.",
Duration = 8
})
-- You can use the SaveManager:LoadAutoloadConfig() to load a config
-- which has been marked to be one that auto loads!
SaveManager:LoadAutoloadConfig()
\`\`\`
---
# Unknown
\> For the complete documentation index, see \[llms.txt\](https://forgenet.gitbook.io/fluent-documentation/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://forgenet.gitbook.io/fluent-documentation/documentation/guide/hints.md).
# Hints
## Disable coroutines when exiting Fluent window
{% hint style="info" %}
You can check if Fluent is unloaded and break coroutines loops
{% endhint %}
\`\`\`lua
function Test()
while task.wait() do
print("something")
if Fluent.Unloaded then break end
end
end
coroutine.resume(coroutine.create(Test))
\`\`\`
---
# Guide | Fluent GUI
For the complete documentation index, see [llms.txt](https://forgenet.gitbook.io/fluent-documentation/llms.txt)
. This page is also available as [Markdown](https://forgenet.gitbook.io/fluent-documentation/documentation/guide.md)
.
[](https://forgenet.gitbook.io/fluent-documentation/documentation#fluent)
Fluent
-------------------------------------------------------------------------------------
Information about using the gui library
[📄Fluent](https://forgenet.gitbook.io/fluent-documentation/documentation/guide/fluent)
[](https://forgenet.gitbook.io/fluent-documentation/documentation#save-manager)
Save Manager
-------------------------------------------------------------------------------------------------
Information about using the save manager
[📄Save Manager](https://forgenet.gitbook.io/fluent-documentation/documentation/guide/save-manager)
[](https://forgenet.gitbook.io/fluent-documentation/documentation#interface-manager)
Interface Manager
-----------------------------------------------------------------------------------------------------------
Information about using the interface manager
[📄Interface Manager](https://forgenet.gitbook.io/fluent-documentation/documentation/guide/interface-manager)
[PreviousQuick Start](https://forgenet.gitbook.io/fluent-documentation/quick-start)
[NextFluent](https://forgenet.gitbook.io/fluent-documentation/documentation/guide/fluent)
Last updated 2 years ago
---