FreeScriptQBoxQBCoreESX
keep-progressbar
by swkeep · version 2025.09.25 · updated 3 days ago
No reviews yet
- Downloads
- 0
- Reviews
- 0
- Size
- 254 KB
- Code check
- Clean
- Licence
- GPL-3.0
- Released
- Nov 2026
A flexible, progress bar system for FiveM
keep-progressbar
A flexible, progress bar system for FiveM.
Supports animations, props, stages/minigames, cancel/death monitoring, networked props with blacklist protection, and more.
Features
Clone or download this repository into your FiveM
1.1. QBCore
If using QBCore, move/delete the
1.2. ESX
If using ESX, move/delete the
1.3 ox_lib
To integrate progress bars made for ox\_lib:
UsageBasic Usage
Multi-stage progress
📦 Examples
I’ve provided a bunch of examples for different features in
**
Key, Type, Description
Prop, PropTwo, Props:
Field, Type, Description
Or simply using an array
Animation:
Field, Type, Description
Single animation
Array of animations
```lua
animations = {
{
animDict = "anim@heists@humane_labs@emp@hack_door",
anim = "hack_intro",
flags = 1,
duration = 2500,
blendIn = 3.0,
blendOut = 3.0,
},
{
animDict = "anim@heists@humane_labs@emp@hack_door",
anim = "hack_loop",
flags = 1,
duration = 3000,
blendIn = 3.0,
blendOut = 3.0,
},
{
animDict = "anim@heists@humane_labs@emp@hack_door",
anim = "hack_outro",
flags = 1,
duration = 2000,
…
A flexible, progress bar system for FiveM.
Supports animations, props, stages/minigames, cancel/death monitoring, networked props with blacklist protection, and more.
Features
- Multi-stage progress with optional skill-check / minigame support
- Animation helper with synchronized scenes and entity attachments
- Automatic cleanup server and client side
- Prop support: multiple props per action
- Customizable cancel button
- Animation hooks
- Themes
Clone or download this repository into your FiveM
resources folder.1.1. QBCore
If using QBCore, move/delete the
progressbar resource from your [standalone] and place keep-progressbar in [standalone]
resources/[standalone]/keep-progressbar1.2. ESX
If using ESX, move/delete the
esx_progressbar resource from your [core] and place keep-progressbar in [core]
resources/[core]/keep-progressbar1.3 ox_lib
To integrate progress bars made for ox\_lib:
- First open:
ox_lib/resource/interface/progress.lua
- Make a backup of the file.
- Delete all contents, then replace them with:
function lib.progressBar(data)
return exports['keep-progressbar']:ox_lib_progressBar(data)
end
function lib.progressCircle(data)
return exports['keep-progressbar']:ox_lib_progressBar(data)
end
function lib.cancelProgress()
exports['keep-progressbar']:ox_lib_cancelProgress()
end
function lib.progressActive()
exports['keep-progressbar']:ox_lib_progressActive()
end
- Ensure it's loading before ox_lib and it's placed at
[standalont].
resources/[standalone]/keep-progressbar ensure keep-progressbar
ensure ox_libUsageBasic Usage
exports['keep-progressbar']:Start({
duration = 5000,
label = "Loading Crate",
icon = "fa-solid fa-box",
canCancel = true,
useWhileDead = false,
controlDisables = {
disableMovement = true,
disableCombat = true,
},
animation = {
animDict = "anim@heists@box_crate@load",
anim = "load_box",
duration = 5000,
lockX = true,
lockY = false,
lockZ = true,
},
prop = {
model = "prop_crate_01a",
bone = 28422,
coords = vec3(0.0, 0.0, 0.0),
rotation = vec3(0.0, 0.0, 0.0),
}
}, function(cancelled)
if not cancelled then
print("✅ completed")
else
print("❌ Cancelled.")
end
end)Multi-stage progress
exports['keep-progressbar']:Start({
label = "Opening Crate",
icon = "fa-solid fa-box-open",
animation = {
task = "WORLD_HUMAN_CLIPBOARD"
},
canCancel = true,
controlDisables = { disableMovement = true, disableCombat = true },
stages = {
{ message = "Breaking lock...", duration = 3000 },
{ message = "Opening door...", duration = 2000 },
},
props = {
{
model = "prop_ld_case_01",
bone = 57005,
coords = vec3(0, 0, 0),
rotation = vec3(0, 0, 0),
},
}
}, function(cancel, result)
if not cancel then
print("✅ Crate opened!")
else
print("❌ Aborted opening crate.")
end
end)📦 Examples
I’ve provided a bunch of examples for different features in
lua/examples.lua**
Start**OptionsKey, Type, Description
duration, number(ms), Total duration if no stages are usedlabel, string, Title of progress windowicon, string, Icon (FontAwesome)useWhileDead, boolean, Allow while deadcanCancel, boolean, Whether player can progress cancel or notcontrolDisables, table, e.g. { disableMovement=true, disableCarMovement=true, disableMouse=false, disableCombat=true }theme, string, Optional theme nameposition, string, UI position (e.g. center-top)offset, vec3, Progress bar offsetprop, table, Single prop attached during progresspropTwo, table, Single prop attached during progressprops, table[], Array of propsanimation, table, Single animationanimations, table[], Array of animationsstages, table[], Array of stagesProp, PropTwo, Props:
Field, Type, Description
model, string, Model namebone, number, Bone indexcoords, vector3, Offset coordinatesrotation, vector3, Rotation
prop = {
model = "prop_police_phone",
bone = 28422,
coords = vector3(0.00, 0.0, 0.0),
rotation = vector3(0.0, 0.0, 0.0),
},
propTwo = {
model = "prop_police_phone",
bone = 28422,
coords = vector3(0.00, 0.0, 0.0),
rotation = vector3(0.0, 0.0, 0.0),
},Or simply using an array
props = {
{
model = "prop_police_phone",
bone = 28422,
coords = vector3(0.00, 0.0, 0.0),
rotation = vector3(0.0, 0.0, 0.0),
}
}Animation:
Field, Type, Description
animDict, string, Animation dictionaryanim, string, Animation nameflags, number, Animation flagsduration, number, Duration in msblendIn, number, Blend-in speedblendOut, number, Blend-out speedonStart, func, Called at startonTick, func, Called during, with frame timeonFinish, func, Called afterSingle animation
animation = {
animDict = "anim@heists@humane_labs@emp@hack_door",
anim = "hack_loop",
},Array of animations
```lua
animations = {
{
animDict = "anim@heists@humane_labs@emp@hack_door",
anim = "hack_intro",
flags = 1,
duration = 2500,
blendIn = 3.0,
blendOut = 3.0,
},
{
animDict = "anim@heists@humane_labs@emp@hack_door",
anim = "hack_loop",
flags = 1,
duration = 3000,
blendIn = 3.0,
blendOut = 3.0,
},
{
animDict = "anim@heists@humane_labs@emp@hack_door",
anim = "hack_outro",
flags = 1,
duration = 2000,
…