ds-streetwalkers

# 🚗💋 DS streetwalkers AKA Hooker System

- A comprehensive FiveM hooker/prostitute interaction system with vehicle-based encounters

## ✨ Features

- 🚙 **Vehicle-Based Interactions** - Pick up hookers while driving

- 💰 **Payment System** - Integrated money handling with multiple frameworks

- 🎭 **Customizable Menu** - Support for qb-menu, ox_lib, or custom menu

- 🚫 **Vehicle Restrictions** - Configurable blacklisted vehicles and vehicle classes

- 🏃 **Secluded Area System** - Requires finding private locations for services

- ⏱️ **Timer System** - Time limits for finding secluded areas

- 💬 **Localization Support** - Fully customizable text strings

- 🎮 **Multiple Services** - Different service types with individual pricing

- 🚗 **Vehicle Class Filtering** - Prevents inappropriate vehicle usage

## 🎯 Framework Support

This resource supports **auto-detection** and manual configuration for the following frameworks:

| Framework | Status | Auto-Detect |

|-----------|--------|-------------|

| 🟢 **QBCore** | ✅ Supported | Yes |

| 🟡 **QBox** | ✅ Supported | Yes |

| 🔵 **ESX** | ✅ Supported | Yes |

| 🟣 **ND-Core** | ✅ Supported | Yes |

| ⚪ **Standalone** | ✅ Supported | Yes (fallback) |

> **Note:** The resource will automatically detect which framework is running. You can also manually set `Config.Framework` if needed.

## 📦 Requirements

- 🎮 **FiveM Server** with game build 2060 or higher

### Optional (for menu types)

- 📋 **qb-menu** (if using `Config.MenuType = "qb-menu"`)

- 📚 **ox_lib** (if using `Config.MenuType = "ox_lib"`)

## 🔧 Installation

1. 📥 **Download** the resource

```

# Place the ds-hookers folder in your server's resources directory

```

2. 📝 **Add to server.cfg**

```

ensure ds-hookers

```

3. ⚙️ **Configure** `config.lua` (see [Configuration] section)

4. 🔄 **Restart** your server or start the resource

```

restart ds-hookers

```

## ⚙️ Configuration

- 🎨 Menu Type

```

Config.MenuType = "qb-menu" -- Options: "custom" | "qb-menu" | "ox_lib"

```

### 💰 Payment Settings

```

Config.PaymentEnabled = true

Config.Framework = "qbcore" -- "esx", "qbcore", "qbox", "ndcore" or "standalone"

Config.Prices = {

SERVICE_BLOWJOB = 50,

SERVICE_SEX = 100

}

```

### 📏 Interaction Settings

```

Config.MaxDistance = 7.5 -- Max distance to pick up hookers

Config.MaxServices = 3 -- Max services before hooker leaves

Config.MaxVehicleSpeed = 0.1 -- Max speed to interact (m/s)

```

### 🚫 Vehicle Restrictions

```

-- Vehicle classes that can't be used

Config.BlackListedVehicleClasses = {

[8] = true, -- Motorcycles

[13] = true, -- Cycles

[14] = true, -- Boats

-- ... etc

}

-- Specific vehicles that can't be used

Config.BlackListedVehicles = {

[`infernus`] = true,

[`voltic`] = true,

-- ... etc

}

```

### 👥 Hooker Ped Models

```

Config.HookerPedModels = {

[`s_f_y_hooker_01`] = true,

[`s_f_y_hooker_02`] = true,

[`s_f_y_hooker_03`] = true

}

```

### 🌐 Localization

```

Config.Localization = {

InviteHooker = "Press ~INPUT_VEH_HORN~ or honk your horn...",

FindSecludedArea = "Go somewhere more secluded.",

-- ... etc

}

```

## 🎮 Usage

- 👤 For Players

1. 🚗 **Get in a vehicle** (driver seat)

2. 🛑 **Stop near a hooker** (within configured distance)

3. 📯 **Honk your horn** to invite the hooker into your vehicle

4. 🗺️ **Find a secluded area** (away from other NPCs)

5. 🛑 **Stop the vehicle** and wait for the menu to appear

6. 📋 **Select a service** from the menu

7. 💰 **Pay** for the service (if enabled)

8. ⏱️ **Wait** for the service to complete

### ⚠️ Important Notes

- ❌ The front passenger seat must be empty

- ❌ Some vehicle types are restricted (motorcycles, boats, etc.)

- ⏱️ You have 2 minutes to find a secluded area

- 🔒 The hooker will leave if you take too long or leave the vehicle

## 🔍 Troubleshooting

- ❌ Hookers not spawning?

- Check that hooker ped models exist in your server

- Verify `Config.HookerPedModels` includes valid ped hashes

### 💰 Payment not working?

- Verify your framework is detected (check server console)

- Ensure `Config.Framework` matches your framework

- Check that payment is enabled: `Config.PaymentEnabled = true`

### 📋 Menu not appearing?

- Verify the menu resource (qb-menu/ox_lib) is running

- Check `Config.MenuType` matches your menu system

- Try switching to `"custom"` menu type for testing

### 🚗 Can't pick up hookers?

- Ensure front passenger seat is empty

- Check vehicle is not in blacklist

- Verify vehicle class is allowed

- Make sure you're close enough (check `Config.MaxDistance`)