Flake Shops

Overview

Flake Shops is a fully dynamic shop resource that lets server owners and admins create, edit, and delete shops entirely from within the game — no config file editing required. Every shop is stored in MySQL and pushed to all connected clients in real time, meaning changes take effect immediately without a resource restart.

The script detects your framework automatically and bridges item purchases through ESX or QB-Core. It supports multi-currency transactions (cash, bank, or black-money), optional pickup mechanics that spawn a ped and a timed blip, shop NPCs, and full map blip support. Analytics tables record visits, purchases, popular items, and daily revenue for server-side reporting.

Features

• •Dual Framework Support — Auto-detects ESX or QB-Core with no manual configuration.
• •In-Game Creator — Use /shopscreator to open a full create/edit/delete admin UI without touching any files.
• •Database Driven — All shop data is persisted in MySQL and broadcast to clients on demand.
• •Multi-Currency — Charge purchases in cash, bank, or black-money on a per-shop or per-item basis.
• •Pickup System — Optional delivery mechanic — items are collected from a timed blip location instead of handed directly.
• •Shop Peds — Attach an NPC ped to any shop for immersive storefront presentation.
• •Map Blips — Each shop can display a labelled blip on the map for easy navigation.
• •Analytics — Optional tables track visits, purchases, popular items, and daily revenue.
• •Discord Logging — Purchase and admin events are forwarded to a configurable Discord webhook.
• •Custom UI — Fully styled HTML/CSS shop interface with item previews and quantity selectors.

Requirements

Installation

Step 1 — Ensure the Resource

Place the flake_shops folder in your resources directory and add the following line to server.cfg:

ensure flake_shops

Step 2 — Import the Core SQL

Run the following SQL in your database to create the main shops table:

CREATE TABLE IF NOT EXISTS `shops` (
  `id`          INT            NOT NULL AUTO_INCREMENT,
  `shop_name`   VARCHAR(100)   NOT NULL,
  `shop_data`   LONGTEXT       NOT NULL,
  `created_at`  TIMESTAMP      DEFAULT CURRENT_TIMESTAMP,
  `updated_at`  TIMESTAMP      DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
  PRIMARY KEY (`id`)
);

Step 3 — Import Analytics Tables (Optional)

These tables are optional but enable the analytics dashboard. Import them only if you intend to use the reporting features:

CREATE TABLE IF NOT EXISTS `shop_visits` (
  `id`        INT       NOT NULL AUTO_INCREMENT,
  `shop_id`   INT       NOT NULL,
  `identifier` VARCHAR(60),
  `visited_at` TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
  PRIMARY KEY (`id`)
);

CREATE TABLE IF NOT EXISTS `shop_purchases` (
  `id`          INT         NOT NULL AUTO_INCREMENT,
  `shop_id`     INT         NOT NULL,
  `identifier`  VARCHAR(60),
  `item`        VARCHAR(80),
  `quantity`    INT         DEFAULT 1,
  `price`       INT         DEFAULT 0,
  `purchased_at` TIMESTAMP  DEFAULT CURRENT_TIMESTAMP,
  PRIMARY KEY (`id`)
);

CREATE TABLE IF NOT EXISTS `shop_popular_items` (
  `item`        VARCHAR(80) NOT NULL,
  `total_sold`  INT         DEFAULT 0,
  PRIMARY KEY (`item`)
);

CREATE TABLE IF NOT EXISTS `shop_daily_revenue` (
  `date`     DATE NOT NULL,
  `revenue`  INT  DEFAULT 0,
  PRIMARY KEY (`date`)
);

Step 4 — Edit the Config

Open config/config.lua and adjust debug mode, UI colour, admin groups, draw distance, inventory image URLs, currency, and pickup settings to match your server. See the Configuration section for all available keys.

File Structure

flake_shops/
├── client/
│   ├── main.lua  -- Shop UI, blips, peds, pickup flow
│   └── creator.lua  -- In-game creator panel client logic
├── server/
│   ├── main.lua  -- Purchases, DB reads/writes, Discord logs
│   └── analytics.lua  -- Visit & revenue tracking
├── config/
│   └── config.lua  -- All tunables (escrow-ignored)
├── html/
│   ├── index.html  -- Shop UI entry point
│   ├── style.css  -- UI styles
│   └── script.js  -- UI logic and NUI messaging
└── fxmanifest.lua  -- Resource manifest

Configuration

All settings live in config/config.lua. This file is escrow-ignored and safe to edit freely.

Core Settings

Currency Config

Each shop and each item can specify a payment method. The supported values are:

• •cash — deducted from the player's on-hand cash balance.
• •bank — deducted from the player's bank account.
• •black_money — deducted from the player's dirty money balance (ESX) or marked money (QB).

Pickup Config

Pickup System

When Config.UsePickupis enabled on a shop, purchased items are not delivered to the player's inventory immediately. Instead, they trigger a timed delivery event:

1. 1Purchase Confirmed — The server validates payment and triggers the pickup flow instead of awarding items directly.
2. 2Random Location Chosen — A random coordinate within Config.PickupRadius of the shop origin is selected server-side.
3. 3Blip Spawned — The client receives the location and spawns a temporary blip on the player's map (PickupBlipSprite / PickupBlipColor).
4. 4Timer Starts — The player has Config.PickupWaitTime seconds to reach the location before the pickup expires.
5. 5Ped Spawns — On arrival, a ped (Config.PickupPedModel) spawns at the exact coordinate holding the order.
6. 6Items Collected — The player interacts with the ped via ox_lib TextUI. On confirm, items are added to inventory and the ped and blip are cleaned up.

Admin Panel

Flake Shops ships with a full in-game admin creator so shops can be built and managed without editing any files. Access is gated by the groups listed in Config.AdminGroups.

Opening the Creator

Type /shopscreator in chat. The UI opens as an overlay on the current camera position. From here you can:

• •Create a new shop — set name, location, ped model, blip, currency, items, and pickup toggle.
• •Edit an existing shop — modify any property and save back to the database instantly.
• •Delete a shop — removes the record from MySQL and de-spawns all associated peds and blips for every connected client.

Admin Commands

Events

The following events are used internally and can be listened to for custom integrations. All events are prefixed with flake_shops:.

Client Events

Server Events

Commands

Troubleshooting