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 = "Welcome to My Script Hub",
    },

    FileSettings = {
        ConfigFolder = "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
    The Title that will be shown in the header text for the loading process
  • Subtitle : string NOT REQUIRED
    The subtitle that will be shown once the loading process is finished while the header becomes the player's display.
    This is also known as the Welcome text.
    Defaults to the Title.
  • Logo : number NOT REQUIRED
    Replaces the loading circle with the given image.
  • IconAnimation : function NOT REQUIRED
    If you are using a custom Icon, the animation will not play. Add your own animation to play within the function.
    Passed Parameters:
    • Instance : GuiObject
      The Instance of the actual Loading Icon that you have changed.

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.

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.

FileSettings : table
Table for configuration settings.

  • RootFolder : string NOT REQUIRED
    An additional folder that acts as a root for the entirety of the file system for your script. Allows for neater file trees for one giant hub with multiple games.
  • ConfigFolder : string
    The folder where your users' configurations will be kept for access.
  • ThemesInRoot : boolean NOT REQUIRED
    Whether user-themes are stored in the root or Config Folder. Useful if you have alot of scripts in the root and users do not want to constantly remake their themes. RootFolder cannot be nil if this is true.

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.