🛠️Config

TZMCBlimpPromoConfig = {}

--[[

    INSTALLATION

    You may have the blimp as a blacklisted vehicle. To change this, follow these steps:

    1: Navigate to [qb] > qb-smallresources > config.lua
    2: Navigate to "Config.BlacklistedVehs"
    3: From there, remove the [`blimp`] line 
    4: You're done. :) 

]]

-- JOB --

TZMCBlimpPromoConfig.PromoteLocations = {
    vector3(-1676.74, -1091.17, 71.19), -- Pier
    vector3(-1176.84, -881.48, 84.3), -- Burgershot
    vector3(-1146.59, -527.14, 117.59), -- Movie Studio
    vector3(-1187.35, 53.66, 118.25), -- Golf course
    vector3(-504.97, -242.43, 109.08), -- Townhall
    vector3(-360.33, -133.09, 105.81), -- Centre LS Customs
    vector3(198.61, 179.11, 166.57), -- Pacific Standard Bank
    vector3(838.15, 18.26, 160.47), -- Casino 
    vector3(1079.42, -606.02, 156.97), -- Mirror Park
    vector3(470.88, -1004.91, 102.27), -- Main LSPD
    vector3(206.92, -946.34, 92.48), -- Leigion Square
    vector3(-56.85, -1117.24, 73.79), -- PDM 
    vector3(-249.41, -1035.46, 94.01), -- Appartments 
    vector3(-80.66, -723.98, 134.53), -- Maze Bank Entrance
    vector3(23.31, -1460.54, 100.27), -- Franklins OG Home
    vector3(8.73, -1742.98, 85.27), -- Mega Mall
    vector3(-261.48, -1888.3, 107.74), -- Maze Bank Arena
}

TZMCBlimpPromoConfig.LocationRadius = 150.00
TZMCBlimpPromoConfig.TotalLocationPoints = 3 -- How many points does the player need to go to

TZMCBlimpPromoConfig.DropOffLocation = vector3(-1336.18, -3044.1, 13.94)

TZMCBlimpPromoConfig.MaxActivePlayers = 5 -- Maximum active players on this job, this is to prevent loads of blimps going about
TZMCBlimpPromoConfig.Cooldowns = {
    successCooldown = 300, -- How many seconds to wait before doing the job again when successful
    failCooldown = 600 -- How many seconds to wait before doing the job again when failed (Like destroying the vehicle)
}

TZMCBlimpPromoConfig.Reward = {
    paymentType = 'cash',
    paymentAmount = 1000
}

-- BLIP --

TZMCBlimpPromoConfig.BlipColor = 17 -- To change the color, please read the FiveM docs and just enter the colorID. https://docs.fivem.net/docs/game-references/blips/#blip-colors

-- PROGRESS BAR --

TZMCBlimpPromoConfig.ProgressBarTitle = 'INTEREST'
TZMCBlimpPromoConfig.IncrementRate = 0.08 -- This value controls how quickly the progress bar fills up when the user is inside the designated area (Example: 0.08 is around 20 seconds)
TZMCBlimpPromoConfig.DecrementRate = 0.08 -- This value controls how quickly the progress bar empties when the user is outside the designated area (Example: 0.08 is around 20 seconds)

-- VEHICLE --

TZMCBlimpPromoConfig.VehiclesSpawns = {
    { X = -1177.27, Y = -3349.08, Z = 13.23, H = 59.53},
    { X = -1315.65, Y = -3268.74, Z = 13.23, H = 59.53},
    { X = -1440.13, Y = -3195.35, Z = 13.23, H = 59.53},
}

TZMCBlimpPromoConfig.FuelResource = 'LegacyFuel' -- This is just to set the fuel to 100%
TZMCBlimpPromoConfig.AdvertURL = 'https://s10.gifyu.com/images/StDyT.gif' -- If you want the default blimp texture you can set this to null. The recommended aspect ratio for this is 2:1

-- NPC --

TZMCBlimpPromoConfig.StartJobNPC = { 
    model = 'a_m_m_paparazzi_01',
    x = -1040.28,
    y = -2873.93,
    z = 13.96,
    h = 145.67,
}

-- TARGET --

TZMCBlimpPromoConfig.StartJobTarget = {
    label = "Start Promo",
    icon = "fa-solid fa-bullhorn"
}

TZMCBlimpPromoConfig.DeliverVehicleTarget = {
    label = "Return Vehicle",
    icon = "fa-solid fa-helicopter"
}

-- NOTIFICATION -- 

TZMCBlimpPromoConfig.UseQBNotify = true
TZMCBlimpPromoConfig.NotificationEvent = "" -- If you're using your own notification system, enter the event here. If you leave this blank and set QBNotify to false this will use the FiveM chat to notify the player. The parameters are (text, status) Status can be either 'success' or 'error'.

TZMCBlimpPromoConfig.SuccessTitle = 'Success'
TZMCBlimpPromoConfig.ErrorTitle = 'Error'

TZMCBlimpPromoConfig.VehicleDestroyed = {
    title = "JOB FAILED",
    subtext = "The vehicle was destroyed"
}

TZMCBlimpPromoConfig.MissionComplete = {
    title = "JOB COMPLETE",
    subtext = "You have earned a reward"
}

TZMCBlimpPromoConfig.AllLocationsCompleted = "All promotions complete, head to the drop off point to return the vehicle."

--[[

    DISCORD

    Webhook URL: The Discord webhook url you would like to send the message to. These are separted incase you want to send messages in different channels. You can find more information here: https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks
    enabled: Enable this notification
    username: The Discord webhook username
    avatarUrl: The image URL of the Discord avatar
    showImage: Show an embed image
    embedColor: The colour of the embed message
    title: The embed title
    description: The embed description

    jobStarted: When a player starts the job
    checkpointComplete: When a player completes a checkpoint
    completedJob: When a player completes the job
    failed: When a player fails the job

    Paramaters

    Player Name: ${playerName}
    Character First Name: ${characterFirstName}
    Character Last Name: ${characterLastName}
    Character Citizen ID: ${characterCitizenID}
    X Coordinate: ${XCoord}
    Y Coordinate: ${YCoord}

]]

TZMCBlimpPromoConfig.DiscordNotification = {
    jobStarted = {
        enabled = true,
        webhookUrl = "https://discord.com/api/webhooks/XXXXXXXXXXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXX",
        username = "Blimp Promotion",
        avatarUrl = "https://cdn.betterttv.net/emote/5f3d535fafb6965d6e7c1c64/3x.webp",
        showImage = 'https://s10.gifyu.com/images/StDyT.gif',
        embedColor = 0xff8a00,
        title = "${characterFirstName} ${characterLastName} Started A Blimp Job",
        description = ""
    },
    checkpointComplete = {
        enabled = true,
        webhookUrl = "https://discord.com/api/webhooks/XXXXXXXXXXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXX",
        username = "Blimp Promotion",
        avatarUrl = "https://cdn.betterttv.net/emote/5f3d535fafb6965d6e7c1c64/3x.webp",
        showImage = 'https://s10.gifyu.com/images/StDyT.gif',
        embedColor = 0xff8a00,
        title = "${characterFirstName} ${characterLastName} Completed A Location",
        description = ""
    },
    completedJob = {
        enabled = true,
        webhookUrl = "https://discord.com/api/webhooks/XXXXXXXXXXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXX",
        username = "Blimp Promotion",
        avatarUrl = "https://cdn.betterttv.net/emote/5f3d535fafb6965d6e7c1c64/3x.webp",
        showImage = 'https://s10.gifyu.com/images/StDyT.gif',
        embedColor = 0xff8a00,
        title = "${characterFirstName} ${characterLastName} Completed All Locations",
        description = ""
    },
    failed = {
        enabled = true,
        webhookUrl = "https://discord.com/api/webhooks/XXXXXXXXXXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXX",
        username = "Blimp Promotion",
        avatarUrl = "https://cdn.betterttv.net/emote/5f3d535fafb6965d6e7c1c64/3x.webp",
        showImage = 'https://media.tenor.com/4kv_-VHCwLIAAAAM/rip-bozo-unlive2774.gif',
        embedColor = 0xff8a00,
        title = "${characterFirstName} ${characterLastName} Failed.",
        description = ""
    }
}

Last updated