Studios
Buffshouse-3.jpg

Configuration

SoonBuffsQbox
PAGE 03 OF 06  ·  INSTALLATION → CONFIGURATION → EXAMPLESdocs.glitchstudios.dev
Browse docs

Everything is in config/main.lua. The file is open under escrow, and every player-facing string is in Config.Text, so you can translate it without touching code.

Config blocks#

Block What it controls
Config.Effects Every effect: label, icon, kind, default duration, toast lines and stamina changes.
Config.Toast How long toasts stay and how many show at once.
Config.Caffeine Coffee and energy drink items, stacking limits and crash length.
Config.Protein Default and maximum protein buff time.
Config.Hangover What counts as a heavy night and the screen tint.
Config.Cigarette Item names, stress relief, smell flag and chain smoking.
Config.Medical Range, item names, allowed jobs and the sedative knockout dose.
Config.Infection Roll chance, health drain and the floor.
Config.Tolerance Dose stacking, overdose level and drugs that never overdose.
Config.Steroids Item name, melee multiplier and damage multiplier.
Config.Shrooms Item name, screen effect and camera sway timing.
Config.Fatigue Points per level, stamina caps, rest checks and points per job action.
Config.Integrations Optional resources and events.
Config.Text Player-facing strings, read through Config.T(key, ...).

Effects#

Every key in Config.Effects is an effect name you can pass to the exports. The shipped effects are protein, caffeine, crash, hangover, lungs, adrenaline, infection, sedated, comedown, tolerance, steroids, shrooms, greenedout and fatigue.

Field Meaning
kind 'buff' goes to the Buff square, 'debuff' to the Debuff square.
label, icon Toast title and a Tabler icon class.
duration Default seconds. nil means the effect lasts until removed (infection, fatigue).
levels The toast shows LV n instead of a time (fatigue, sedated, tolerance).
up, down Toast lines for good and bad points. %cap% is replaced with the stamina cap and %knockout% with Config.Medical.sedative.knockoutAt.
fix, fixIcon The "what clears it" line and its icon.
stamina regen (extra share of max stamina back per second while not sprinting), drain (sprinting costs this much more), slow (recovery is this much slower), cap (most stamina you can have, as a share of max).
after Effect that starts when this one runs out.
perMinute Server-side per minute while active: stress added, thirst taken, or stressZero to hold stress at 0.
carry Kilograms added to the buff_carry state bag. It does not raise the inventory max weight.

Defaults#

Setting Default
Config.Toast.startMs / endMs / max 8000 / 4000 / 4
Config.Caffeine.items { coffee = 300, energy_drink = 360 } (seconds per drink)
Config.Caffeine.maxTime 900
Config.Caffeine.crashPerExtra / crashMax 60 / 360
Config.Caffeine.clearsFatigue true
Config.Caffeine.registerItems 'auto'
Config.Protein.default / maxTime 600 / 1200
Config.Hangover.heavyLevel 3
Config.Hangover.window / drinks / duration 3 * 3600 / 4 / 900
Config.Cigarette.item / lighter 'cigarette' / 'lighter'
Config.Cigarette.stressRelief { 3, 6 }
Config.Cigarette.smell { 'smoke', 300 }
Config.Cigarette.chainWindow / chainCount 20 * 60 / 3
Config.Cigarette.emote / smokeTime 'smoke' / 12000 ms
Config.Medical.range 2.5
Config.Medical.adrenaline { item = 'adrenaline', jobs = { ambulance = true }, blockFor = 900 }
Config.Medical.antibiotics { item = 'antibiotics', jobs = false } (anyone)
Config.Medical.sedative { item = 'sedative', jobs = { ambulance = true, police = true }, knockoutAt = 3 }
Config.Medical.reviveDelay 500 ms
Config.Medical.sedativeEvidence { 'confused', 300 } (false = off)
Config.Infection.untreatedFor / chance 300 / 0.08
Config.Infection.drainEvery / floor 15 / 120 (of 200)
Config.Infection.blurEvery { 40, 80 }
Config.Tolerance.window / weaker / minShare 2700 / 0.25 / 0.4
Config.Tolerance.comedownPerLevel / overdoseAt 60 / 3
Config.Tolerance.noOverdose { joint = true, thc_gummy = true }
Config.Tolerance.overdoseRagdoll 6000 ms
Config.Steroids { item = 'steroids', melee = 1.5, defence = 0.85, evidence = { 'sweat', 600 } }
Config.Shrooms.item 'mushrooms'
Config.Fatigue.perLevel / maxLevel 12 / 3
Config.Fatigue.caps { 0.85, 0.7, 0.55 }
Config.Fatigue.restPoint / restMaxSpeed / graceAfterWork 45 / 4.0 / 90
Config.Fatigue.jobs { trucker = 2, mining = 1, lumber = 1 }

Integrations#

Every entry in Config.Integrations is optional. Set a name to false or nil to turn that hook off.

Key Default What it needs
ambulance 'glitch-ambulancejob' A medical resource with server exports ReviveKeepInjuries(src) and GetInjuries(src) and client exports KillPlayer() and StartLastStand(). Without one, adrenaline uses reviveEvent and infection from untreated bleeding is off.
reviveEvent 'qbx_medical:client:playerRevived' Client event fired on the patient when no ambulance resource is running.
consumables 'glitch-smallresources' A resource with the server export AddThirst(src, amount) and the client export KnockOut(). Without it, steroids take thirst from the thirst metadata and a sedative knockout is a long ragdoll.
evidenceEvent 'evidence:client:SetStatus' A client event that takes (status, seconds) for forensic smell and sweat flags.
emoteMenu 'scully_emotemenu' An emote menu with playEmoteByCommand(name) and cancelEmote() for smoking.

A HUD can read the hud_buff and hud_debuff state bags (a GetGameTimer end time, or true for no end) to draw Buff and Debuff squares. A weight script can read buff_carry.