Browse docs
UI integrations
Choose each interface separately in sky_base/config/config.lua. Notifications and keyboard prompts use the included Sky interface by default. Progress bars require a supported progress resource. These settings are managed in the Base file, not through /jobconfig.
Quick setup
For example, to use Ox for all three interfaces, change these fields inside your existing Config = { ... } table:
notification = "ox_lib",
helpnotify = "ox_lib",
progressbar = "ox",
Start the selected providers before Sky Base, then restart Sky Base and the resources that use it. Configuration values are case-sensitive. The resource name and the selection value can differ, as with ox_lib progress above.
| Interface | Setting | Shipped value | Selection |
|---|---|---|---|
| Notifications | Config.notification | "default" | Built-in Sky notifications, "auto", or a provider from the table. |
| Keyboard prompts / TextUI | Config.helpnotify | "default" | Built-in Sky prompts, "auto", or a provider from the table. |
| Progress bars | Config.progressbar | "auto" | A supported external provider or an implemented custom integration. |
"auto" selects an available provider once at startup; it does not switch providers while playing. If several providers are installed, choose one explicitly to retain the intended appearance. A provider that depends on Sky Base should also be selected explicitly. Notifications and prompts fall back to the included Sky interface when automatic detection finds nothing. Progress has no built-in fallback.
Supported providers
The cells below are the exact values to use for each setting. A dash means that this release does not include that interface for the listed provider. These integrations are included with Sky Base 1.41.0; external resources must be installed separately.
| Provider resource | notification | helpnotify | progressbar |
|---|---|---|---|
17mov_Hud | 17mov_Hud | 17mov_Hud | 17mov_Hud |
aty_ui | aty_ui | aty_ui | — |
aty_uikitv2 | aty_uikitv2 | — | aty_uikitv2 |
brutal_notify | brutal_notify | — | — |
brutal_textui | — | brutal_textui | — |
codem-notification | codem-notification | — | — |
codem-supreme-hud | — | codem-supreme-hud | codem-supreme-hud |
codem-supreme-notification | codem-supreme-notification | — | — |
codem-textui | — | codem-textui | — |
core_notify | core_notify | — | — |
cp_notify | cp_notify | — | — |
cs_hud | cs_hud | — | — |
drugs_creator | — | — | jaksam |
es_extended | esx | esx | — |
esx_notify | esx_notify | — | — |
esx_progressbar | — | — | esx |
esx_textui | — | esx_textui | — |
frkn-uikit | frkn-uikit | — | frkn-uikit |
hex_1_hud | hex_1_hud | hex_1_hud | — |
hex_2_hud | hex_2_hud | hex_2_hud | hex |
hex_4_hud | hex_4_hud | hex_4_hud | hex |
hex_final_hud | hex_final_hud | hex_final_hud | hex |
hex_finalhud_v2 | hex_finalhud_v2 | hex_finalhud_v2 | hex |
hex_future_hud | hex_future_hud | hex_future_hud | hex |
hex_genesis_hud | hex_genesis_hud | hex_genesis_hud | hex |
hex_hud_prem | hex_hud_prem | hex_hud_prem | hex |
jg-textui | — | jg-textui | — |
jobs_creator | — | — | jaksam |
lation_ui | lation_ui | lation_ui | — |
msk_core | msk_core | msk_core | msk_core |
mythic_notify | mythic_notify | — | — |
mythic_progbar | — | — | mythic |
okokNotify | okokNotify | — | — |
okokTextUI | — | okokTextUI | — |
ox_lib | ox_lib | ox_lib | ox |
prims_hud | prims_hud | prims_hud | — |
prism_uipack | prism_uipack | — | prism_uipack |
progressbar | — | — | qb |
qb-core | qb | qb | — |
qbx_core | qbox | qbox | — |
qs-interface | qs-interface | — | — |
qs-textui | — | qs-textui | — |
risk-notify | risk-notify | risk-notify | risk-notify |
robberies_creator | — | — | jaksam |
rtx_notify | rtx_notify | — | — |
RxNotify | RxNotify | — | — |
sky_hud | sky_hud | sky_hud | — |
sky_notify | sky_notify | — | — |
Venice-Notification | Venice-Notification | — | — |
vms_notifyv2 | vms_notifyv2 | — | — |
wasabi_notify | wasabi_notify | — | — |
wasabi_uikit | wasabi_uikit | wasabi_uikit | wasabi |
zenit_hud | zenit_hud | zenit_hud | — |
ESX help uses the framework TextUI hook; the standard ESX setup needs esx_textui. Automatic selection detects esx_textui directly. Qbox help uses ox_lib. The spelling prims_hud is intentional and differs from prism_uipack.
Notification support does not imply TextUI or progress support. For example, CP Notify supplies notifications, while CodeM Supreme HUD supplies prompts and progress; its notifications use the separate CodeM Supreme Notification resource. The table lists normal TextUI prompts, not every provider-specific 3D display feature.
Progress options
The seven newly supported progress choices are codem-supreme-hud, aty_uikitv2, 17mov_Hud, risk-notify, prism_uipack, frkn-uikit and msk_core. Available animations, props, disabled controls and cancellation vary by provider. ATY UI Kit v2 and FRKN do not provide a programmatic cancellation export through these integrations; use a provider with that capability if your workflow needs it.
Custom interfaces and updates
For a custom interface, implement the matching public template before selecting "custom":
- Notifications:
sky_base/config/integration/notification/custom.lua. - Interaction prompts:
sky_base/config/integration/helpnotify/custom.lua. - Progress:
sky_base/config/integration/progress/custom.lua.
Existing custom notification and single-action help code from config/functions.lua belongs in the corresponding new adapter. Multi-action help remains in config/functions.lua. Custom templates require implementation and are not automatically selected.
When upgrading, merge your intended provider selections and install the complete matching integration files and manifest. Follow the Base changelog for the release-specific file list and full update instructions.