The Two Windows#
Starter Pack has two interfaces, and it helps to know which is which from the start.
Window | Opened with | What it is for |
|---|---|---|
The picker |
| What players see: choose a character, browse the packs, claim one. |
The creator |
|
Documentation
Using Starter Pack: the player picker, building packs in the in-game creator, money, ID cards, starter vehicles, world peds, weekly and lifetime cooldowns, languages and every config option.
Starter Pack has two interfaces, and it helps to know which is which from the start.
Window | Opened with | What it is for |
|---|---|---|
The picker |
| What players see: choose a character, browse the packs, claim one. |
The creator |
|
Admins only: build the packs, theme the interface and place the world peds, with a live preview of what players will see. |
Everything you build in the creator is saved to the database on its own, a moment after each change, and sent to every connected player straight away. There is no save button and nothing to restart.
The picker opens full screen on two portraits — Female and Male — with how many packs each side offers. Each side has its own set of packs, so you can give women and men different starts. The choice only decides which set is shown; it is not compared with the character's sex.
The packs stand side by side as cards with a photo, a name and an accent colour. Hovering a card turns it over to list what is inside — every item with its quantity and tier, every vehicle with its colour. The featured pack carries a MOST POPULAR ribbon.
The claim button must be held, not clicked, so nobody picks a pack by accident. The server checks the cooldown and the player's free space, records the claim, then hands everything over. A notification confirms the items and another the vehicle; anything that could not be delivered is listed by name.
ESC closes the picker at any time without claiming. If no pack has been built for a side yet, that side says so instead of showing an empty row.
Every route goes through the same check on the server. With a lifetime cooldown, a player who has already claimed is refused with a notification before the picker opens.
Route | Set in | Notes |
|---|---|---|
Command |
|
|
Keybind |
| No key by default, but Open Starter Pack is always listed in Settings → Key Bindings → FiveM for players to bind themselves. Set a key name such as |
Item |
| Using the item opens the picker; it is removed only after a successful claim. See Installation. |
World peds |
| NPCs you place in the creator. Talking to one opens the picker. |
Your scripts | Exports and events | See Commands and Exports. |
Leave a command or item name empty ('') to switch that route off — for example, to hand out the starter pack only through an NPC at the airport.
/starteradmin opens the Starterpack Creator. It has three columns:
Column | What is there |
|---|---|
Left | The Female / Male switch, that side's pack list, and General Settings for everything server-wide. |
Centre | The editor for whatever is selected on the left. |
Right | A live preview of the card exactly as players will see it. |
The header shows Saving… and then Saved automatically. If the database is unreachable a banner says your edits will not be stored until it is back. Reset to defaults (click twice to confirm) empties the whole configuration — every pack on both sides, the theme, the logo and the peds.
Action | What it does |
|---|---|
Add Pack | Creates an empty pack. Up to four packs per side. |
Duplicate | Copies a pack with all its items and vehicles, right below the original. |
Set as featured | Gives the pack the MOST POPULAR ribbon. One per side; press it again to unfeature. |
Drag | Reorders the packs; players see them in this order. Dropping an item from the editor onto another pack moves it there. |
Delete | Click twice to confirm. Past claims of that pack stay in the claim history. |
Field | What it does |
|---|---|
Visible / Hidden | A hidden pack disappears from the picker and the server refuses to hand it out, but it is kept for later. |
Display Name | The card's title, up to 17 characters — POLICE, MEDIC, GANG… |
Accent Color | The card's border, claim button, glow and item highlights. |
Background Image | Paste an image URL. CROP zooms and positions it inside the card frame; RESET goes back to the bundled photo. |
Items and vehicles share one list, in the order the card shows them — drag the grip on a row to reorder. A pack holds up to twelve items and eight vehicles.
Add Item searches every item your inventory knows, by label or spawn name, with its icon. The item's name, description and icon are read from your inventory, so the card always matches what lands in the player's pockets. Each row then has three settings:
Setting | What it does |
|---|---|
Tag | The category shown on the card: WEAPON, AMMO, ARMOR, RADIO, TOOL, PHONE, MAP, ID, MONEY, DRUGS, FOOD or MISC. Only |
Tier | Common (grey), Standard (blue) or Rare (gold) — the colour the item is highlighted in. |
Quantity | How many are given. For a MONEY row, the amount paid. |
Add Vehicle searches your framework's vehicle list by name or spawn code. A model that is not on the list — an addon car, or any car on ESX without a vehicles table — is added by typing its exact spawn code. Each vehicle gets a colour, or Random to give every player who claims a different one from a curated palette.
Setting | What it does |
|---|---|
Theme Color | Colours the whole picker and creator — borders, glow, the claim button, the active tab. Seven presets (Quasar Cyan, Violet, Pink, Crimson, Amber, Emerald, Teal) or any colour from the picker. |
Server Logo | Replaces the Quasar mark in the top-right corner of the picker. A square PNG of at least 256×256 works best; leave it empty for the default. |
Sound Effects | Soft ticks when hovering cards, items and the character select. Off keeps the interface silent. |
World Peds | Up to three NPCs in the world that open the picker. See below. |
A ped is an NPC standing somewhere in your map — at the airport, the job centre, the spawn — that players walk up to for their starter pack. Peds are frozen, invincible and ignore everything around them, and they are respawned for every player as soon as you change them.
Field | What to enter |
|---|---|
Ped Model | Any GTA or addon ped model, such as |
Animation / Scenario | A scenario starting with |
Position | Set with PLACE — never typed. |
Press PLACE and the panel steps aside. A translucent copy of the ped follows the centre of your screen, its feet snapping to the ground:
Key | Does |
|---|---|
Mouse | Aim where the ped should stand, up to 50 metres away. You can still walk. |
| Turn the ped. |
| Raise or lower it — onto a counter, a podium or a balcony. |
Left click | Confirm the position and return to the panel. |
| Cancel. |
How players interact with a ped — a target eye, a qs-textui prompt or a floating [E] Open Starter Pack — depends on Config.Interaction and what you have installed. See Integrations.
To give money, add an item to the pack and set its Tag to MONEY. Its quantity becomes the amount, and the item itself is not handed over — picking your cash item simply gives the row the right icon. Money tags are paid according to Config.Money:
Config.Money = {
MONEY = { account = 'cash', itemId = 'cash', metadata = false },
DIRTY_MONEY = { account = 'black_money', itemId = 'markedbills', metadata = true },
BANK = { account = 'bank', itemId = '', metadata = false },
CRYPTO = { account = 'crypto', itemId = '', metadata = false },
}Field | Meaning |
|---|---|
| Tried first: the framework account to pay into. |
| The fallback when there is no account, or the account refused — money as an inventory item. |
|
|
The creator's tag list offers MONEY. DIRTY_MONEY, BANK and CRYPTO are understood by the server as well and are used by the preset packs.
Items listed in Config.IdentityItems are stamped with the claiming character's identity — citizen id, first and last name, date of birth, sex and nationality — in the same shape qb-idcard uses, so item-info and ID scripts read them without changes.
Config.IdentityItems = {
id_card = { kind = 'identity' }, -- full citizen card
driver_license = { kind = 'license', type = 'Driver License' }, -- adds a licence type
weaponlicense = { kind = 'license', type = 'Weapon License' },
lawyerpass = { kind = 'license', type = 'Lawyer Pass' },
}On an inventory without item metadata (classic ESX), the item is given as a plain item.
A vehicle in a pack is written straight into your framework's owned-vehicles table — player_vehicles on QBCore and Qbox, owned_vehicles on ESX — with a unique plate, full fuel and health, the chosen colour, and parked in a garage. The player collects it from their garage like any car they bought.
Config.Vehicles = {
DefaultGarage = {
qb = { car = 'pillboxgarage', air = 'higginsheli', sea = 'lsymc' },
qbx = { car = 'pillboxgarage', air = 'higginsheli', sea = 'lsymc' },
esx = { car = 'SanAndreasAvenue', air = 'SanAndreasAvenue', sea = 'SanAndreasAvenue' },
},
DefaultState = 1, -- 1 = ready in the garage | 0 = must be stored first
GiveKeys = false, -- true only if your keys script does not key owned cars itself
PlatePrefix = '', -- up to 4 characters; the rest is random
ImageUrl = 'https://docs.fivem.net/vehicles/{model}.webp',
ImageOverrides = {
-- ['mycustomcar'] = 'https://i.imgur.com/abc123.png',
},
}Option | What it does |
|---|---|
| Where the car is parked, per framework. On QBCore and Qbox, boats go to |
|
|
| Hands the keys over on claim through the first keys script found. |
| Plates are eight characters, checked against the vehicle table so they never repeat. |
| The vehicle pictures in the picker and creator. |
Config.Cooldown decides how often a pack can be claimed. It applies to the whole picker: one claim of any pack starts it.
Mode | What players get |
|---|---|
| One claim, ever. Afterwards the picker does not open and a notification says the starter pack is a one-time reward. The default. |
| One claim every seven days. The picker still opens; after a claim, or when trying too soon, a countdown shows the days, hours, minutes and seconds left. |
| The same, every thirty days. |
Config.CooldownScope decides who the cooldown belongs to:
Scope | Meaning |
|---|---|
| Each character claims on its own — the citizen id on QBCore and Qbox, the character identifier on ESX with multicharacter. The default. |
| One claim for the whole Rockstar licence, however many characters it has. Stops players farming packs with new characters. |
Testing a pack?
/starterclearwipes your own claim so you can claim again. See Commands and Exports.
Set Config.Locale in config/main.lua. Both windows and every message follow it, and Arabic turns the layout right-to-left.
Codes |
|---|
|
The handful of messages sent from the server — not admin, already claimed, items granted, vehicle delivered, the ped's prompt — live in locales/<code>.json and can be reworded there. A missing file falls back to English.
All in config/main.lua. Framework, inventory, target and text UI are detected for you and are not in this list.
Option | Default | What it does |
|---|---|---|
|
| The language. |
|
| Detailed console output: what was delivered, which garage, why an item was missing. |
|
| The name in the interface header and the title of notifications. |
|
| How peds are used: |
|
| Which notification system shows messages. |
|
| How long a notification stays, in milliseconds. |
|
|
|
|
|
|
|
|
|
| Four tags | How each money tag is paid. |
| Four items | Items stamped with the player's identity. |
| — |
|
| — |
|
| — | Garages, state, keys, plates and pictures for starter vehicles. |