Configuration

This page contains all information you need to configure gfg_deliveries, if you have any questions feel free to reach out to us on our discord.

Config

Config = {
    language = "en",                                         
    debug = false,                                                                            
    utcOffset = 4,                                           
    framework = "esx"                                        
}

language

Language sets which Locale to use, you can find available locales in [gfg_webhook/locale/], we will add more as they become available but feel free to add your own.

language = "en",

debug

Debug should only used in a development environment

Determines whether to send debug print statements to the client and server when using the script.

debug = false

utcOffset

Determines your timezone offset from UTC (e.x: EST would be 4 (without daylight savings)).

utcOffset = 4,

Config.Defaults

defaultWebhook

If you need assistance creating a webhook, please see our page linked below.

pageCreating a webhook

Determines the default channel webhook to send messages to if omitted.

defaultWebhook = "https://discord.com/api/webhooks/1119435357268746331/YZtP41bUM1hjr3v5LnMJn-7q4VkZHAjcSED2_5d-de5e3hF-dX_OiXiaSXo6zS7rCAxL",

defaultUsername

Determines the default username to use if omitted.

defaultUsername = "GFG",

defaultAvatar

Determines the default profile picture if omitted.

defaultAvatar = "https://i.imgur.com/Y4nltZW.png",

defaultTitle

Determines the default title of the embed if omitted.

defaultTitle = "Saucy Title",

defaultThumbnail

Determines the default thumbnail of embed if omitted.

defaultThumbnail = "https://i.imgur.com/Y4nltZW.png",

defaultColor

Color is provided in "Decimal" format. Converting a HEX or RGB color to decimal is easy with a site like (https://convertingcolors.com/hex-color-EEEEEE.html?search=HEX(EEEEEE))

Determines the default color of the embed if omitted.

defaultColor = 15658734,

defaultMention

You must include the "@" and can contain multiple. (e.x "@here @staff @mod")

Determines the default mention if mention is only set to "true".

defaultMention = "@everyone",

Example Config

Config = {
    language = "en",
    debug = true,
    utcOffset = 4,
}

Config.Defaults = {
    defaultWebhook = "https://discord.com/api/webhooks/1119435357268746331/YZtP41bUM1hjr3v5LnMJn-7q4VkZHAjcSED2_5d-de5e3hF-dX_OiXiaSXo6zS7rCAxL",
    defaultUsername = "GFG",
    defaultAvatar = "https://i.imgur.com/Y4nltZW.png",
    defaultTitle = "Saucy Title",
    defaultThumbnail = "https://i.imgur.com/Y4nltZW.png",
    defaultColor = 15658734,
    defaultMention = "@everyone",
}