[{"data":1,"prerenderedAt":1240},["ShallowReactive",2],{"/docs/base/ui-integrations":3,"/docs/base/ui-integrations-surround":1226,"/docs/base/ui-integrations-implemented-suggestions":1239},{"id":4,"title":5,"body":6,"description":1215,"extension":1216,"head":1217,"implementedSuggestions":1217,"meta":1218,"navigation":1219,"path":1221,"schemaOrg":1217,"seo":1222,"sitemap":1223,"stem":1224,"__hash__":1225},"docs/1.docs/base/3.ui-integrations.md","UI integrations",{"type":7,"value":8,"toc":1209},"minimark",[9,22,27,34,102,108,192,197,201,208,1109,1126,1129,1133,1153,1157,1164,1186,1196,1205],[10,11,12,13,17,18,21],"p",{},"Choose each interface separately in ",[14,15,16],"code",{},"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 ",[14,19,20],{},"/jobconfig",".",[23,24,26],"h2",{"id":25},"quick-setup","Quick setup",[10,28,29,30,33],{},"For example, to use Ox for all three interfaces, change these fields inside your existing ",[14,31,32],{},"Config = { ... }"," table:",[35,36,41],"pre",{"className":37,"code":38,"filename":16,"language":39,"meta":40,"style":40},"language-lua shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","notification = \"ox_lib\",\nhelpnotify = \"ox_lib\",\nprogressbar = \"ox\",\n","lua","",[14,42,43,69,85],{"__ignoreMap":40},[44,45,48,52,56,59,63,66],"span",{"class":46,"line":47},"line",1,[44,49,51],{"class":50},"sTEyZ","notification ",[44,53,55],{"class":54},"sMK4o","=",[44,57,58],{"class":54}," \"",[44,60,62],{"class":61},"sfazB","ox_lib",[44,64,65],{"class":54},"\"",[44,67,68],{"class":50},",\n",[44,70,72,75,77,79,81,83],{"class":46,"line":71},2,[44,73,74],{"class":50},"helpnotify ",[44,76,55],{"class":54},[44,78,58],{"class":54},[44,80,62],{"class":61},[44,82,65],{"class":54},[44,84,68],{"class":50},[44,86,88,91,93,95,98,100],{"class":46,"line":87},3,[44,89,90],{"class":50},"progressbar ",[44,92,55],{"class":54},[44,94,58],{"class":54},[44,96,97],{"class":61},"ox",[44,99,65],{"class":54},[44,101,68],{"class":50},[10,103,104,105,107],{},"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 ",[14,106,62],{}," progress above.",[109,110,111,130],"table",{},[112,113,114],"thead",{},[115,116,117,121,124,127],"tr",{},[118,119,120],"th",{},"Interface",[118,122,123],{},"Setting",[118,125,126],{},"Shipped value",[118,128,129],{},"Selection",[131,132,133,156,175],"tbody",{},[115,134,135,139,144,149],{},[136,137,138],"td",{},"Notifications",[136,140,141],{},[14,142,143],{},"Config.notification",[136,145,146],{},[14,147,148],{},"\"default\"",[136,150,151,152,155],{},"Built-in Sky notifications, ",[14,153,154],{},"\"auto\"",", or a provider from the table.",[115,157,158,161,166,170],{},[136,159,160],{},"Keyboard prompts / TextUI",[136,162,163],{},[14,164,165],{},"Config.helpnotify",[136,167,168],{},[14,169,148],{},[136,171,172,173,155],{},"Built-in Sky prompts, ",[14,174,154],{},[115,176,177,180,185,189],{},[136,178,179],{},"Progress bars",[136,181,182],{},[14,183,184],{},"Config.progressbar",[136,186,187],{},[14,188,154],{},[136,190,191],{},"A supported external provider or an implemented custom integration.",[10,193,194,196],{},[14,195,154],{}," 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.",[23,198,200],{"id":199},"supported-providers","Supported providers",[10,202,203,204,207],{},"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 ",[14,205,206],{},"1.41.0","; external resources must be installed separately.",[109,209,210,232],{},[112,211,212],{},[115,213,214,217,222,227],{},[118,215,216],{},"Provider resource",[118,218,219],{},[14,220,221],{},"notification",[118,223,224],{},[14,225,226],{},"helpnotify",[118,228,229],{},[14,230,231],{},"progressbar",[131,233,234,253,271,288,303,318,333,350,365,380,395,410,425,441,459,474,489,504,521,538,558,577,596,615,634,653,672,687,702,719,738,753,769,784,799,817,834,851,866,883,901,916,931,950,965,980,995,1012,1027,1042,1057,1072,1092],{},[115,235,236,241,245,249],{},[136,237,238],{},[14,239,240],{},"17mov_Hud",[136,242,243],{},[14,244,240],{},[136,246,247],{},[14,248,240],{},[136,250,251],{},[14,252,240],{},[115,254,255,260,264,268],{},[136,256,257],{},[14,258,259],{},"aty_ui",[136,261,262],{},[14,263,259],{},[136,265,266],{},[14,267,259],{},[136,269,270],{},"—",[115,272,273,278,282,284],{},[136,274,275],{},[14,276,277],{},"aty_uikitv2",[136,279,280],{},[14,281,277],{},[136,283,270],{},[136,285,286],{},[14,287,277],{},[115,289,290,295,299,301],{},[136,291,292],{},[14,293,294],{},"brutal_notify",[136,296,297],{},[14,298,294],{},[136,300,270],{},[136,302,270],{},[115,304,305,310,312,316],{},[136,306,307],{},[14,308,309],{},"brutal_textui",[136,311,270],{},[136,313,314],{},[14,315,309],{},[136,317,270],{},[115,319,320,325,329,331],{},[136,321,322],{},[14,323,324],{},"codem-notification",[136,326,327],{},[14,328,324],{},[136,330,270],{},[136,332,270],{},[115,334,335,340,342,346],{},[136,336,337],{},[14,338,339],{},"codem-supreme-hud",[136,341,270],{},[136,343,344],{},[14,345,339],{},[136,347,348],{},[14,349,339],{},[115,351,352,357,361,363],{},[136,353,354],{},[14,355,356],{},"codem-supreme-notification",[136,358,359],{},[14,360,356],{},[136,362,270],{},[136,364,270],{},[115,366,367,372,374,378],{},[136,368,369],{},[14,370,371],{},"codem-textui",[136,373,270],{},[136,375,376],{},[14,377,371],{},[136,379,270],{},[115,381,382,387,391,393],{},[136,383,384],{},[14,385,386],{},"core_notify",[136,388,389],{},[14,390,386],{},[136,392,270],{},[136,394,270],{},[115,396,397,402,406,408],{},[136,398,399],{},[14,400,401],{},"cp_notify",[136,403,404],{},[14,405,401],{},[136,407,270],{},[136,409,270],{},[115,411,412,417,421,423],{},[136,413,414],{},[14,415,416],{},"cs_hud",[136,418,419],{},[14,420,416],{},[136,422,270],{},[136,424,270],{},[115,426,427,432,434,436],{},[136,428,429],{},[14,430,431],{},"drugs_creator",[136,433,270],{},[136,435,270],{},[136,437,438],{},[14,439,440],{},"jaksam",[115,442,443,448,453,457],{},[136,444,445],{},[14,446,447],{},"es_extended",[136,449,450],{},[14,451,452],{},"esx",[136,454,455],{},[14,456,452],{},[136,458,270],{},[115,460,461,466,470,472],{},[136,462,463],{},[14,464,465],{},"esx_notify",[136,467,468],{},[14,469,465],{},[136,471,270],{},[136,473,270],{},[115,475,476,481,483,485],{},[136,477,478],{},[14,479,480],{},"esx_progressbar",[136,482,270],{},[136,484,270],{},[136,486,487],{},[14,488,452],{},[115,490,491,496,498,502],{},[136,492,493],{},[14,494,495],{},"esx_textui",[136,497,270],{},[136,499,500],{},[14,501,495],{},[136,503,270],{},[115,505,506,511,515,517],{},[136,507,508],{},[14,509,510],{},"frkn-uikit",[136,512,513],{},[14,514,510],{},[136,516,270],{},[136,518,519],{},[14,520,510],{},[115,522,523,528,532,536],{},[136,524,525],{},[14,526,527],{},"hex_1_hud",[136,529,530],{},[14,531,527],{},[136,533,534],{},[14,535,527],{},[136,537,270],{},[115,539,540,545,549,553],{},[136,541,542],{},[14,543,544],{},"hex_2_hud",[136,546,547],{},[14,548,544],{},[136,550,551],{},[14,552,544],{},[136,554,555],{},[14,556,557],{},"hex",[115,559,560,565,569,573],{},[136,561,562],{},[14,563,564],{},"hex_4_hud",[136,566,567],{},[14,568,564],{},[136,570,571],{},[14,572,564],{},[136,574,575],{},[14,576,557],{},[115,578,579,584,588,592],{},[136,580,581],{},[14,582,583],{},"hex_final_hud",[136,585,586],{},[14,587,583],{},[136,589,590],{},[14,591,583],{},[136,593,594],{},[14,595,557],{},[115,597,598,603,607,611],{},[136,599,600],{},[14,601,602],{},"hex_finalhud_v2",[136,604,605],{},[14,606,602],{},[136,608,609],{},[14,610,602],{},[136,612,613],{},[14,614,557],{},[115,616,617,622,626,630],{},[136,618,619],{},[14,620,621],{},"hex_future_hud",[136,623,624],{},[14,625,621],{},[136,627,628],{},[14,629,621],{},[136,631,632],{},[14,633,557],{},[115,635,636,641,645,649],{},[136,637,638],{},[14,639,640],{},"hex_genesis_hud",[136,642,643],{},[14,644,640],{},[136,646,647],{},[14,648,640],{},[136,650,651],{},[14,652,557],{},[115,654,655,660,664,668],{},[136,656,657],{},[14,658,659],{},"hex_hud_prem",[136,661,662],{},[14,663,659],{},[136,665,666],{},[14,667,659],{},[136,669,670],{},[14,671,557],{},[115,673,674,679,681,685],{},[136,675,676],{},[14,677,678],{},"jg-textui",[136,680,270],{},[136,682,683],{},[14,684,678],{},[136,686,270],{},[115,688,689,694,696,698],{},[136,690,691],{},[14,692,693],{},"jobs_creator",[136,695,270],{},[136,697,270],{},[136,699,700],{},[14,701,440],{},[115,703,704,709,713,717],{},[136,705,706],{},[14,707,708],{},"lation_ui",[136,710,711],{},[14,712,708],{},[136,714,715],{},[14,716,708],{},[136,718,270],{},[115,720,721,726,730,734],{},[136,722,723],{},[14,724,725],{},"msk_core",[136,727,728],{},[14,729,725],{},[136,731,732],{},[14,733,725],{},[136,735,736],{},[14,737,725],{},[115,739,740,745,749,751],{},[136,741,742],{},[14,743,744],{},"mythic_notify",[136,746,747],{},[14,748,744],{},[136,750,270],{},[136,752,270],{},[115,754,755,760,762,764],{},[136,756,757],{},[14,758,759],{},"mythic_progbar",[136,761,270],{},[136,763,270],{},[136,765,766],{},[14,767,768],{},"mythic",[115,770,771,776,780,782],{},[136,772,773],{},[14,774,775],{},"okokNotify",[136,777,778],{},[14,779,775],{},[136,781,270],{},[136,783,270],{},[115,785,786,791,793,797],{},[136,787,788],{},[14,789,790],{},"okokTextUI",[136,792,270],{},[136,794,795],{},[14,796,790],{},[136,798,270],{},[115,800,801,805,809,813],{},[136,802,803],{},[14,804,62],{},[136,806,807],{},[14,808,62],{},[136,810,811],{},[14,812,62],{},[136,814,815],{},[14,816,97],{},[115,818,819,824,828,832],{},[136,820,821],{},[14,822,823],{},"prims_hud",[136,825,826],{},[14,827,823],{},[136,829,830],{},[14,831,823],{},[136,833,270],{},[115,835,836,841,845,847],{},[136,837,838],{},[14,839,840],{},"prism_uipack",[136,842,843],{},[14,844,840],{},[136,846,270],{},[136,848,849],{},[14,850,840],{},[115,852,853,857,859,861],{},[136,854,855],{},[14,856,231],{},[136,858,270],{},[136,860,270],{},[136,862,863],{},[14,864,865],{},"qb",[115,867,868,873,877,881],{},[136,869,870],{},[14,871,872],{},"qb-core",[136,874,875],{},[14,876,865],{},[136,878,879],{},[14,880,865],{},[136,882,270],{},[115,884,885,890,895,899],{},[136,886,887],{},[14,888,889],{},"qbx_core",[136,891,892],{},[14,893,894],{},"qbox",[136,896,897],{},[14,898,894],{},[136,900,270],{},[115,902,903,908,912,914],{},[136,904,905],{},[14,906,907],{},"qs-interface",[136,909,910],{},[14,911,907],{},[136,913,270],{},[136,915,270],{},[115,917,918,923,925,929],{},[136,919,920],{},[14,921,922],{},"qs-textui",[136,924,270],{},[136,926,927],{},[14,928,922],{},[136,930,270],{},[115,932,933,938,942,946],{},[136,934,935],{},[14,936,937],{},"risk-notify",[136,939,940],{},[14,941,937],{},[136,943,944],{},[14,945,937],{},[136,947,948],{},[14,949,937],{},[115,951,952,957,959,961],{},[136,953,954],{},[14,955,956],{},"robberies_creator",[136,958,270],{},[136,960,270],{},[136,962,963],{},[14,964,440],{},[115,966,967,972,976,978],{},[136,968,969],{},[14,970,971],{},"rtx_notify",[136,973,974],{},[14,975,971],{},[136,977,270],{},[136,979,270],{},[115,981,982,987,991,993],{},[136,983,984],{},[14,985,986],{},"RxNotify",[136,988,989],{},[14,990,986],{},[136,992,270],{},[136,994,270],{},[115,996,997,1002,1006,1010],{},[136,998,999],{},[14,1000,1001],{},"sky_hud",[136,1003,1004],{},[14,1005,1001],{},[136,1007,1008],{},[14,1009,1001],{},[136,1011,270],{},[115,1013,1014,1019,1023,1025],{},[136,1015,1016],{},[14,1017,1018],{},"sky_notify",[136,1020,1021],{},[14,1022,1018],{},[136,1024,270],{},[136,1026,270],{},[115,1028,1029,1034,1038,1040],{},[136,1030,1031],{},[14,1032,1033],{},"Venice-Notification",[136,1035,1036],{},[14,1037,1033],{},[136,1039,270],{},[136,1041,270],{},[115,1043,1044,1049,1053,1055],{},[136,1045,1046],{},[14,1047,1048],{},"vms_notifyv2",[136,1050,1051],{},[14,1052,1048],{},[136,1054,270],{},[136,1056,270],{},[115,1058,1059,1064,1068,1070],{},[136,1060,1061],{},[14,1062,1063],{},"wasabi_notify",[136,1065,1066],{},[14,1067,1063],{},[136,1069,270],{},[136,1071,270],{},[115,1073,1074,1079,1083,1087],{},[136,1075,1076],{},[14,1077,1078],{},"wasabi_uikit",[136,1080,1081],{},[14,1082,1078],{},[136,1084,1085],{},[14,1086,1078],{},[136,1088,1089],{},[14,1090,1091],{},"wasabi",[115,1093,1094,1099,1103,1107],{},[136,1095,1096],{},[14,1097,1098],{},"zenit_hud",[136,1100,1101],{},[14,1102,1098],{},[136,1104,1105],{},[14,1106,1098],{},[136,1108,270],{},[10,1110,1111,1112,1114,1115,1117,1118,1120,1121,1123,1124,21],{},"ESX help uses the framework TextUI hook; the standard ESX setup needs ",[14,1113,495],{},". Automatic selection detects ",[14,1116,495],{}," directly. Qbox help uses ",[14,1119,62],{},". The spelling ",[14,1122,823],{}," is intentional and differs from ",[14,1125,840],{},[10,1127,1128],{},"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.",[23,1130,1132],{"id":1131},"progress-options","Progress options",[10,1134,1135,1136,1138,1139,1138,1141,1138,1143,1138,1145,1138,1147,1149,1150,1152],{},"The seven newly supported progress choices are ",[14,1137,339],{},", ",[14,1140,277],{},[14,1142,240],{},[14,1144,937],{},[14,1146,840],{},[14,1148,510],{}," and ",[14,1151,725],{},". 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.",[23,1154,1156],{"id":1155},"custom-interfaces-and-updates","Custom interfaces and updates",[10,1158,1159,1160,1163],{},"For a custom interface, implement the matching public template before selecting ",[14,1161,1162],{},"\"custom\"",":",[1165,1166,1167,1174,1180],"ul",{},[1168,1169,1170,1171,21],"li",{},"Notifications: ",[14,1172,1173],{},"sky_base/config/integration/notification/custom.lua",[1168,1175,1176,1177,21],{},"Interaction prompts: ",[14,1178,1179],{},"sky_base/config/integration/helpnotify/custom.lua",[1168,1181,1182,1183,21],{},"Progress: ",[14,1184,1185],{},"sky_base/config/integration/progress/custom.lua",[10,1187,1188,1189,1192,1193,1195],{},"Existing custom notification and single-action help code from ",[14,1190,1191],{},"config/functions.lua"," belongs in the corresponding new adapter. Multi-action help remains in ",[14,1194,1191],{},". Custom templates require implementation and are not automatically selected.",[10,1197,1198,1199,1204],{},"When upgrading, merge your intended provider selections and install the complete matching integration files and manifest. Follow the ",[1200,1201,1203],"a",{"href":1202},"/docs/base/changelog","Base changelog"," for the release-specific file list and full update instructions.",[1206,1207,1208],"style",{},"html pre.shiki code .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}",{"title":40,"searchDepth":47,"depth":71,"links":1210},[1211,1212,1213,1214],{"id":25,"depth":71,"text":26},{"id":199,"depth":71,"text":200},{"id":1131,"depth":71,"text":1132},{"id":1155,"depth":71,"text":1156},"Choose notification, interaction-prompt and progress providers for Sky Base and the Sky resources that use them.","md",null,{},{"icon":1220},"i-lucide-panels-top-left","/docs/base/ui-integrations",{"title":5,"description":1215},{"loc":1221},"1.docs/base/3.ui-integrations","9g-QpHTFxvWQeIb1-b34mI-xvESVDY8uoQKtnK2Mli8",[1227,1233],{"title":1228,"path":1229,"stem":1230,"description":1231,"icon":1232,"children":-1},"Changelog","/docs/base/jobs-base/changelog","1.docs/base/2.jobs-base/9.changelog","Full change history for sky_jobs_base.","i-lucide-history",{"title":1234,"path":1235,"stem":1236,"description":1237,"icon":1238,"children":-1},"Customization","/docs/base/customization","1.docs/base/customization","The Sky Base library allows the customization of various aspects of the scripts. This documentation provides","i-lucide-puzzle",[],1789776129580]