Skip to main content

Creating The Window

Creation Snippet​

local Window = Starlight:CreateWindow({
    Name = "MyScript",
    Subtitle = "v1.0",
    Icon = 123456789,

    LoadingSettings = {
        Title = "My Script Hub",
        Subtitle = "by You",
    },

    ConfigurationSettings = {
        FolderName = "MyScript"
    },
})

This is just a snippet, not all parameters are included.

Parameters​

Name : string
The name of the window.

Subtitle : string
The Subtitle of the window.

Icon : number
The Icon that shows at the top-left corner of the window.

LoadingEnabled : boolean NOT REQUIRED
Whether the loading screen is enabled. Disable to use your own loading screen or not have one.
Also, it is going to be redesigned soon as the current one was taken from Luna and the design does not fit here.

LoadingSettings : table
Table for loading Settings.

  • Title : string
    Title to be shown in the loading screen.
  • Subtitle : string
    Subtitle to be shown in the loading screen.
  • Icon : number NOT REQUIRED
    Replaces the loading circle with the given rbxassetid.

BuildWarnings : boolean NOT REQUIRED
Whether build warnings will be shown if the Interface Model fetched does not match the model the script was intended for. No idea why you'd turn this off, maybe if you're using a fork.

InterfaceAdvertisingPrompts : boolean NOT REQUIRED
Whether Starlight will show random notifications on well, Starlight. Disable if you don't like advertising I guess.

NotifyOnCallbackError : boolean NOT REQUIRED
Whether Starlight will show you notifications when there are callback errors, explaining what went wrong, instead of simply printing in the console. Defaulted to true.

ConfigurationSettings : table
Table for configuration settings.

  • RootFolder : string NOT REQUIRED
    An additional folder that acts as a root for your config folder. Useful if you have multiple scripts under the same hub (eg. Different Games).
  • FolderName : string
    The folder where your users' configurations will be kept for access.

DefaultSize : UDim2 NOT REQUIRED
Sets a custom size for the window. Will break columns if too skinny.
Generally not recommended to set, but useful if your script has very few features/is very compact.

tip

To Access Elements/Windows/Tabs' Instances (Like the actual GUI Object in Roblox), you can Do Object.Instance.
This Returns the Actual GUI Object.