Studios
Buffshouse-3.jpg

Installation

SoonBuffsQbox
PAGE 02 OF 06  ·  OVERVIEW → INSTALLATION → CONFIGURATIONdocs.glitchstudios.dev
Browse docs

Requirements#

Framework qbx_core (Qbox). ESX and plain QBCore are not supported.
Resources ox_lib, ox_inventory
Server FiveM server artifact with OneSync enabled.
Database None. State is saved in the player's metadata. There is no SQL file.
Tested with qbx_core 1.24.0, ox_inventory 2.48.0 and ox_lib 3.40.0
Optional A medical resource, a consumables resource, a forensic status resource, an emote menu, a HUD and a weight script. Each is checked at run time and the matching feature is skipped when it is not running. See Integrations on the Configuration page.

Installation steps#

  1. Put the glitch-buffs folder in your resources folder. The folder name is case-sensitive and must stay glitch-buffs.

  2. Add the items from install/items.lua to ox_inventory/data/items.lua (inside the returned table), and put an image for each in ox_inventory/web/images/<item>.png. The item names must match config/main.lua.

  3. Add to server.cfg, after ox_lib, qbx_core and ox_inventory:

    ensure ox_lib
    ensure qbx_core
    ensure ox_inventory
    ensure glitch-buffs
    
  4. If you run a consumables script, add the hooks from the Examples page so coffee, energy drinks and alcohol reach this resource.

  5. Open config/main.lua and set the Config.Integrations names to the resources you run, or false to switch a hook off.

  6. Restart the server and use a coffee. /buff shows the toast again.

No ACE permissions are needed. The two commands are available to every player.

[!NOTE] The defaults in Config.Integrations name glitch-ambulancejob and glitch-smallresources. If you do not run them, change those two entries to your own resources or false. A name that is not running is skipped.

Items#

install/items.lua defines nine items: cigarette, lighter, steroids, mushrooms, adrenaline, antibiotics, sedative, coffee and energy_drink. No item images are included in the package.

Commands#

Command Who What
/buff Everyone Show the toast cards for your active buffs again
/debuff Everyone Show the toast cards for your active debuffs again

Updating#

Replace everything except config/main.lua, then compare your file with the new one for added keys. The config, install/, the README, the license and the changelog stay readable under escrow. Saved effects live in character metadata, so a resource restart keeps them.