prp-nicotine

A lightweight but impactful addiction system for Qbox/QBCore/ESX. Manage stress, enjoy the buzz, but beware the withdrawal.

Features

• Addiction Mechanics: Regular usage builds dependence. Stopping causes withdrawal symptoms like screen shakes or periodic health loss (configurable).
• Visual Effects: Configurable screen effects (e.g., "DeadlineNeon") trigger on usage for a visual representation of the "buzz".
• Consumable System: Uses realistic item consumption (cans -> pouches).
• Stress Relief: Direct integration with `qbx_core` or `qb-core` stress systems.

Installation

1. Add items to your inventory (ox_inventory/data/items.lua):

   ['zyn_chill'] = {
       label = 'Zyn Chill',
       weight = 50,
       stack = true,
       close = true,
       description = 'A can of 15 nicotine pouches.'
   },
   ['zyn_pouch'] = {
       label = 'Nicotine Pouch',
       weight = 1,
       stack = true,
       close = true,
       description = 'A single pouch for a quick buzz.'
   },

2. Ensure dependencies in `server.cfg`:

   ensure qbx_core
   ensure ox_lib
   ensure ox_inventory
   ensure prp-nicotine

Configuration

All settings can be adjusted in config.lua.

Core Settings

Config = {}

-- Consumables
Config.PouchesPerCan   = 15      -- How many pouches you get from one can

-- Effects
Config.ScreenEffect    = 'DeadlineNeon'   -- Visual effect on use
Config.EffectDuration  = 10000            -- Duration in ms (10s)

-- Gameplay
Config.StressReduction = {
    min = 1,
    max = 5
}

Exports

You can check addiction levels via client-side exports:

local addiction = exports['prp-nicotine']:GetAddictionLevel()
if addiction > 50 then
    print("This guy needs a hit.")
end