Flake Addiction

Overview

Flake Addiction adds a persistent, server-authoritative drug addiction layer to your FiveM server. Every drug is registered with its own immunity timer, addiction chance, withdrawal strength, and overdose threshold. As players consume drugs, their immunity decays in real time — and once immunity expires, withdrawal effects kick in until medication is used or enough time passes.

All addiction state is stored in MySQL and synced back to clients on connection, meaning addiction persists across reconnects and server restarts. An in-game creator panel (/addictioncreator) lets admins configure every aspect of each drug without touching a single file.

Features

• •Dynamic Drug Registration — Register any number of drugs via the creator panel or config.json with full schema control.
• •Immunity System — Each drug tracks remaining immunity time per player. Immunity decays continuously server-side.
• •Addiction Timers — Configurable addiction duration per drug. Players become addicted once immunity depletes past the threshold.
• •Withdrawal Effects — Screen effects, movement penalties, and camera shake fire automatically during withdrawal state.
• •Medication System — Register medication items that reduce or clear addiction for specific drugs.
• •Admin Creator Panel — Full in-game UI (/addictioncreator) to create, edit, and remove drug definitions.
• •Persistent Storage — Addiction state saved to MySQL — survives server restarts and player reconnects.
• •Real-Time Config Sync — Config changes broadcast live to all connected clients via server events.
• •Overdose Handling — Configurable overdose at high drug strength — applies severe effects or kills the player.

Requirements

Installation

Step 1 — Ensure the Resource

Place flake_addiction in your resources directory and add it to server.cfg after your framework and inventory:

ensure flake_addiction

Step 2 — Import the SQL

Run the provided flake_addiction.sql file against your database:

CREATE TABLE IF NOT EXISTS `flake_addiction` (
  `identifier`     VARCHAR(60)  NOT NULL,
  `drug`           VARCHAR(50)  NOT NULL,
  `remaining_time` INT          NOT NULL DEFAULT 0,
  PRIMARY KEY (`identifier`, `drug`)
);

Step 3 — Add Items to Your Inventory

Add each drug and medication as a usable item in your inventory resource. The script registers usable callbacks automatically on startup — you only need the item definitions to exist. If you are using Windy City Drugs, a pre-built ox.txt item list is included in the resource root.

• •OX Inventory — import items from windy city drugs ox.txt or add your own to ox_inventory/data/items.lua.
• •ESX Inventory — add items to your es_extended items table and restart the resource.

Step 4 — Configure

Edit config.lua for core settings (UI colour, admin groups, translations) and optionally edit config.json to pre-populate drug definitions before first launch.

Step 5 — First-Run Setup

On first launch the creator will prompt you to apply a preset or start from scratch. See the Addiction Creator section for details.

File Structure

flake_addiction/
├── client/
│   ├── main.lua  -- Effects, animations, immunity loop
│   └── creator.lua  -- Admin creator panel client logic
├── server/
│   └── main.lua  -- DB reads/writes, sync, item registration
├── config.lua  -- Core settings, admin groups, translations
├── config.json  -- Drug definitions (edited via creator)
├── flake_addiction.sql  -- Database schema
├── fxmanifest.lua  -- Resource manifest
└── windy city drugs ox.txt  -- Optional: OX item definitions

Configuration

config.lua contains server-level settings. Drug definitions live in config.json and are managed through the in-game creator panel.

Core Settings

Drug Schema

Each drug entry in config.json follows this schema. The creator generates valid JSON automatically — edit manually only if needed:

{
  "label": "Cocaine",
  "animation": "sniff",
  "drugStrength": 75,
  "healthEffects": {
    "healthBoost": 10,
    "armorBoost": 0
  },
  "addiction": {
    "chance": 0.65,
    "time": 3600
  },
  "effect": {
    "duration": 300,
    "screenFX": "DrugsMichaelAliensFight",
    "speedMultiplier": 1.3,
    "cameraShakeIntensity": 0.4
  }
}

Medication Schema

Medication items are registered under Config.Medication in config.lua:

Config.Medication = {
  {
    item       = "methadone",
    treatsDrug = "heroin",
    restores   = 1800,   -- seconds of immunity restored on use
    clears     = false,  -- set true to fully clear addiction
  },
  {
    item       = "rehab_pill",
    treatsDrug = "cocaine",
    restores   = 0,
    clears     = true,
  },
}

Usage & Effects

When a player uses a registered drug item, the script runs through the following pipeline:

1. 1Item Used — The ESX usable callback fires and the server validates the player has the item.
2. 2Animation Plays — The client plays the appropriate use animation (pill swallow, smoke inhale, syringe inject, or sniff).
3. 3Effects Applied — Screen FX, speed multiplier, and camera shake activate for the configured duration.
4. 4Health / Armor — If healthEffects are configured, the boost is applied immediately after the animation.
5. 5Addiction Roll — The server rolls addiction.chance. On success, immunity time is credited to the player's row in flake_addiction.
6. 6Immunity Tracked — Immunity decays continuously. When remaining_time hits 0, the player enters withdrawal.
7. 7Overdose Check — If drugStrength accumulates to 100 within the effect window, overdose effects fire.

Animations

Overdose

If a player's accumulated drugStrength reaches 100 within a single effect window, the overdose sequence triggers:

• •Severe screen effects and maximum camera shake are applied.
• •Movement is slowed to a crawl.
• •Health drains at an accelerated rate.
• •If health reaches zero before a medication item is used, the player dies.

Withdrawal Effects

Once remaining_time reaches zero for an addicted player, withdrawal begins automatically. The following effects are applied on a recurring server tick until immunity is restored:

• •Periodic screen blur and desaturation effects.
• •Randomised camera shaking at low intensity.
• •Slow, gradual health drain (configurable per drug).
• •Reduced movement speed.

Withdrawal ends as soon as the player uses the drug again (restoring immunity) or uses an appropriate medication item.

Items

Flake Addiction does not ship with a fixed item list — drug items are whatever you register in Config.UsableDrugs and the creator panel. If your server uses Windy City Drugs, a ready-made OX Inventory item definition file is included:

Addiction Creator

The in-game creator panel is the primary interface for managing drug definitions. All changes are written to config.json and broadcast live to connected clients — no restart required.

Opening the Panel

Type /addictioncreator in chat. Access is restricted to groups defined in Config.AdminGroups.

First-Run Setup

On first launch (when config.json is empty) the panel prompts you to choose between two options:

• •Apply Preset — loads the bundled Windy City Drugs preset with pre-configured values for common drug items. Good starting point for most servers.
• •Decline / Start Blank — opens an empty creator so you can build your drug list from scratch.

Panel Features

• •Create a new drug with full schema fields via guided form inputs.
• •Edit any existing drug — changes save instantly to config.json and sync to clients.
• •Delete a drug — removes it from config.json and clears it from active client configs.
• •Preview animation type and screen FX name before saving.

Reset Installation

To trigger the first-run preset prompt again (e.g. to switch from a blank setup to the preset), use:

/resetaddictioninstall

This clears the config.json and reopens the preset selection prompt on next /addictioncreator launch.

Database

The resource uses a single table — flake_addiction — to persist immunity state per player per drug. Each row represents one active addiction relationship.

Rows are inserted on first drug use and updated on each subsequent use. When remaining_time reaches 0 the server applies withdrawal events to that client. Rows are not deleted automatically — they remain as historical records unless you run /clearaddiction [identifier].

Events

All events are prefixed with flake_addiction: and can be listened to for custom integrations.

Client Events

Server Events

Commands

Troubleshooting