Skip to content

Configuration Guide

All default visual themes and system settings for OnBoard are stored in src/Modules/Config.lua. You can modify this file directly to change how the framework looks and behaves game-wide, or pass overrides dynamically through the Theme manager at runtime.


Default Configuration Structure

The configuration file organizes properties into intuitive sub-tables based on UI styling, color schemes, overlays, highlights, guide arrows, and animations.

```luau local Config = { -- Top-level UI & ScreenGui configurations UI = { ScreenGuiName = "OnBoard_CoreGui", OverlayZIndex = 100,

    -- Typography
    Font = Font.fromEnum(Enum.Font.BuilderSans),
    TitleSize = 22,
    DescriptionSize = 16,
},

-- Theme colors
Colors = {
    Primary = Color3.fromRGB(30, 30, 35),
    Secondary = Color3.fromRGB(45, 45, 50),
    Text = Color3.fromRGB(255, 255, 255),
},

-- Fullscreen dim overlay settings
Overlay = {
    Color = Color3.fromRGB(0, 0, 0),
    Transparency = 0.5,
},

-- 2D UI target highlight options
Highlight = {
    Color = Color3.fromRGB(0, 170, 255),
    Thickness = 3,
    CornerRadius = UDim.new(0, 8),
    PulseSpeed = 1,
},

-- 3D World instance highlight options
WorldHighlight = {
    FillColor = Color3.fromRGB(0, 170, 255),
    FillTransparency = 0.75,
    OutlineColor = Color3.fromRGB(255, 255, 255),
    OutlineTransparency = 0,
},

-- 3D Directional guide arrow & beam options
Arrow = {
    Color = Color3.fromRGB(0, 170, 255),
    Size = UDim2.fromOffset(50, 50),
    BeamTexture = "rbxassetid://98078426234204",
    BeamWidth = 2,
},

-- Motion & tween animations
Tween = {
    Speed = 0.3,
    EasingStyle = Enum.EasingStyle.Quad,
    EasingDirection = Enum.EasingDirection.Out,
},

}

return Config