Documentation
  • Discord Server
  • About Us
  • Free Resources
    • Death Screen
      • PS-Dispatch Integration
    • Battlepass
      • Guides
      • Commands
        • Player Commands
        • Admin Commands
      • API
        • Server
    • Garages
      • Guides
        • Creating Interior
        • Creating Garage
        • How to find entity sets (customizations) for interior
  • Paid Resources
    • Elevator Creator V2
      • Installation
      • Accessible code
    • Radar System V2
      • Installation
      • Accessible code
    • Hotels Creator
      • Accessible code
    • Vehicle Shop Creator
      • Accessible code
    • Stocks Market
      • Accessible code
      • [DEV] - Usable Functions
    • Discord Voice Attendance
      • Installation
    • Deathmatch System
      • Installation
        • esx_ambulancejob
        • qb-ambulancejob
        • wasabi_ambulance
        • qbx_medical
        • codem-inventory
        • core_inventory
      • Accessible code
    • Object Creator
      • Dependencies
      • Accessible code
    • Cocaine Labs
      • Dependencies
      • Accessible code
    • Ownable Crafting Tables
      • Dependencies
      • Accessible code
      • Common Problems
    • Evidence System
      • Dependencies
      • Accessible code
      • Installation
      • API
    • Marketplace V2
      • Accessible code
      • Installation
      • Migration from V1
    • EMS Dispatch
      • Sending Dispatch
      • Accessing the Menu
      • Config File
    • Weed Planting
      • Accessible code
      • How to add new strain?
      • How to install
    • Advanced DarkNet System
      • Config
    • Advanced Taxi Job
      • Accessible code
      • Changelog
    • Advanced Gang Creator
      • Accessible code
      • Installation
        • QB Core
        • QBOX Core
      • API
      • FAQ
    • Advanced Private Cameras
      • ESX
        • Items
      • QBCore
        • Items
      • Accessible code
    • Advanced Elevator Creator
      • Accessible code
    • Advanced Ownable Rent Creator
      • SQL
      • ESX
      • QBCore
      • Config File
    • Advanced Job Creator
      • Installation
        • QB CORE
      • Accessible code
    • Advanced Ownable Shops
      • Installation
      • Accessible code
      • SQL
    • Advanced Ped Creator
      • SQL
      • Config File
    • Advanced Promocode Creator
      • Accessible code
      • SQL File
      • Common problems
    • Advanced Safe Zone Creator
      • Config File
    • Turf Wars
      • Ox Inventory
      • Accessible code
      • API
    • Advanced Gas Station Creator
      • Accessible code
    • Advanced Advertisements System
      • SQL File
      • Accessible code
    • Player Manager
      • Installation
      • Accessible code
    • Mechanic Job
      • Installation
      • Accessible code
      • SQL
    • Advanced Radar System
      • Accessible code
      • SQL
    • Crypto Mining
      • Installation
      • Accessible code
      • Items
      • SQL
    • Racing System
      • Accessible code
    • Car Theft
      • Accessible code
    • Advanced Solar Panels
      • Accessible Code
      • SQL
      • ESX
        • Items
      • QBCore
        • Items
    • Pilot Job
      • Accessible Code
      • ESX
        • SQL
      • QBCore
        • Metadata
        • qb-smallresources
      • QBOX
        • Metadata
    • Advanced Ownable Banks
      • Accessible Code
    • Post Office
      • Accessible Code
      • ESX
        • SQL
      • QBCore
        • SQL
      • Exports
    • Weather Sync
      • API
    • Billing System
      • Accessible code
      • SQL
      • Common problems
Powered by GitBook
On this page
  • Adding items as reward
  • Example (items as rewards)
  • Adding vehicles as reward
  • Example (vehicles as rewards)
  • Adding items to battle pass shop
  • Example (items in battle pass shop)
  • Adding vehicles in battle pass shop
  • Example (vehicles in battle pass shop)
  1. Free Resources
  2. Battlepass

Guides

Adding items as reward

This is valid for both free and premium battle pass

Item options: table

  • name: string

    • Name of item

  • label: string

    • Label of item

  • img?: string

    • If no image is provided, the item image will automatically be based on the item name. Alternatively, you can specify a custom image

  • requirements: table

    • tier: number

      • Required tier to collect item

    • xp: number

      • Required XP to collect item

  • amount: number

    • Amount of item that will be received

  • metadata?: table

    • Optionally, you can add metadata to the item here if needed

Example (items as rewards)

FreePass = {
        [1] = { -- Rewards for the 1st week of the month.
            { name = 'water', label = 'Water', img = 'panties', requirements = { tier = 0, xp = 150 }, amount = 10, metadata = { description = 'This is metadata' } },
        },
        [2] = { -- Rewards for the 2nd week of the month.
            { name = 'water', label = 'Water', requirements = { tier = 0, xp = 150 }, amount = 10, metadata = { description = 'This is metadata' } },
        },
        [3] = { -- Rewards for the 3rd week of the month.
            { name = 'water', label = 'Water', requirements = { tier = 0, xp = 150 }, amount = 10, metadata = { description = 'This is metadata' } },
        },
        [4] = { -- Rewards for the 4th week of the month.
            { name = 'water', label = 'Water', requirements = { tier = 0, xp = 150 }, amount = 10, metadata = { description = 'This is metadata' } },
        },
    }

Adding vehicles as reward

This is valid for both free and premium battle pass

Vehicle options: table

  • name: string

    • Name of vehicle (spawn code)

  • label: string

    • Label of vehicle

  • img: string

    • URL of image, otherwise it will look for image in web/img folder

  • requirements: table

    • tier: number

      • Required tier to collect item

    • xp: number

      • Required XP to collect item

  • vehicle: table

    • type: string

      • car, boat, helicopter, whatever you need

    • stored: string or boolean

      • Usually for stored status is 1 or true

    • garage: string

      • garage where vehicle will be stored

    • properties: table

      • here you can pre-configure properties that vehicle will have (colour, tyre smoke, engine etc)

Example (vehicles as rewards)

FreePass = {
    [1] = { -- week
        {
            name = 'zentorno',
            label = 'Zentorno',
            img = 'https://docs.fivem.net/vehicles/zentorno.webp',
            requirements = { tier = 5, xp = 150 },
            vehicle = { type = 'car', stored = 1, garage = 'SanAndreasAvenue', properties = { color1 = 0, color2 = 27, neonEnabled = { 1, 2, 3, 4 } } }
        },
    }
}

Adding items to battle pass shop

Item options: table

  • name: string

    • Name of item

  • label: string

    • Label of item

  • img?: string

    • If no image is provided, the item image will automatically be based on the item name. Alternatively, you can specify a custom image

  • currency: string

    • Item that will be currency for that item/vehicle

  • price: number

    • Price for item/vehicle

  • amount: number

    • Amount of item that will be received

  • metadata?: table

    • Optionally, you can add metadata to the item here if needed

Example (items in battle pass shop)

BattleShop = {
    [1] = { -- Items available in the shop during the 1st week of the month.
        { name = 'water', label = 'Water', price = 50, currency = 'money', amount = 10, metadata = { description = 'This is metadata' } },
    },
    [2] = { -- Items available in the shop during the 2nd week of the month.
        { name = 'water', label = 'Water', price = 50, currency = 'money', amount = 10, metadata = { description = 'This is metadata' } },
    },
    [3] = { -- Items available in the shop during the 3rd week of the month.
        { name = 'water', label = 'Water', price = 50, currency = 'money', amount = 10, metadata = { description = 'This is metadata' } },
    },
    [4] = { -- Items available in the shop during the 4th week of the month.
        { name = 'water', label = 'Water', price = 50, currency = 'money', amount = 10, metadata = { description = 'This is metadata' } },
    },
},

Adding vehicles in battle pass shop

Vehicle options: table

  • name: string

    • Name of vehicle (spawn code)

  • label: string

    • Label of vehicle

  • img: string

    • URL of image, otherwise it will look for image in web/img folder

  • currency: string

    • Item that will be currency for that item/vehicle

  • price: number

    • Price for item/vehicle

  • vehicle: table

    • type: string

      • car, boat, helicopter, whatever you need

    • stored: string or boolean

      • Usually for stored status is 1 or true

    • garage: string

      • garage where vehicle will be stored

    • properties: table

      • here you can pre-configure properties that vehicle will have (colour, tyre smoke, engine etc)

Example (vehicles in battle pass shop)

BattleShop = {
    [1] = { -- Items available in the shop during the 1st week of the month.
        {
            name = 'zentorno',
            label = 'Zentorno',
            img = 'https://docs.fivem.net/vehicles/zentorno.webp',
            price = 50, 
            currency = 'money',
            vehicle = { type = 'car', stored = 1, garage = 'SanAndreasAvenue', properties = { color1 = 0, color2 = 27, neonEnabled = { 1, 2, 3, 4 } }}
        },

    },
},
PreviousBattlepassNextCommands

Last updated 9 months ago