Skip to content
KS-Progressbar

KS-Progressbar

Installation

  1. Unzip the delivered archive into your resources/ folder, under the name ks-progressbar.
  2. Import the provided install.sql file into your database.
  3. Add ensure ks-progressbar to your server.cfg, after oxmysql and qb-core.
  4. Restart your server.

Configuration

Config.DefaultPosition = "bottom"
Config.CancelOnMove = true
Config.CancelOnDamage = true

Disable CancelOnMove for actions compatible with movement (like walking while carrying an item) — cancellation remains available per action via the canMove parameter.

Starting a progress action

From any script:

exports['ks-progressbar']:Start({
  label = "Réparation en cours...",
  duration = 8000,
  icon = "fa-solid fa-wrench",
  canMove = false,
}, function(completed)
  if completed then
    -- réparation terminée normalement
  end
end)

The callback receives true if the progress finished normally, false if it was cancelled before completion.

Common issues

The bar stays stuck on screen after a disconnect. Check that you’re on the latest version — KS-Progressbar automatically clears any active progress on the onResourceStop event; an older conflicting script can prevent that cleanup.

Two progress bars show up at the same time. Use the queue option (queue = true in the parameters) instead of two simultaneous Start calls — without it, the second call interrupts the first by default.

Something not covered here? Join our Discord.