> For the complete documentation index, see [llms.txt](https://ak-scripts.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ak-scripts.gitbook.io/docs/yi-lai/markdown/ti-huan-kuang-jia-mo-ren-zhi/bi-kan-shuo-ming.md).

# 必看说明

#### 💡 替换框架默认值前，请务必阅读

在替换框架自带的 **UI 模块**（`Notify`、`TextUI`、`Progress`、`Menu`、`Input`、`Dialog`、`Skillbar`、`Radial`）为 **`ak-lib` 版本** 时，请先确认以下事项，以确保兼容性与稳定性，**请务必认真阅读本页**！

### 🧭 你将获得

* 统一的 **`Liquid Glass`** 视觉风格
* 跨框架一致的**调用方式**与**参数**
* 更完整的**可配置项**（位置、时长、音效、样式、图标、国际化）

> ℹ️ **适用范围**：ESX、QBCore、QBX（基于 OX）、OX（原生）\
> 🧩 **建议做法**：仅替换你当前服务器的**主框架**对应章节，避免多套 UI 混用。

***

### 🧩 一、ak-lib 八大模块总览

<table><thead><tr><th width="137.79998779296875">模块</th><th width="197.800048828125">功能说明</th><th>框架默认函数 / 接口</th></tr></thead><tbody><tr><td>🔔 <strong>Notify</strong></td><td>屏幕弹出通知</td><td>ESX：<code>ESX.ShowNotification</code><br>QBCore：<code>QBCore.Functions.Notify</code><br>OX/QBX：<code>lib.notify</code></td></tr><tr><td>🔤 <strong>TextUI</strong></td><td>屏幕侧边提示文字</td><td>ESX：<code>ESX.TextUI</code><br>QBCore：<code>DrawText</code><br>QBX/OX：<code>lib.showTextUI</code></td></tr><tr><td>⚡ <strong>Progress</strong></td><td>进度条 / 任务加载条</td><td>ESX：<code>exports['esx_progressbar']</code><br>QBCore：<code>QBCore.Functions.Progressbar</code><br>OX：<code>lib.progressCircle</code></td></tr><tr><td>🧭 <strong>Menu</strong></td><td>菜单交互系统</td><td>ESX：<code>ESX.UI.Menu.Open</code><br>QBCore：<code>exports['qb-menu']:openMenu</code><br>OX：<code>lib.registerMenu</code></td></tr><tr><td>🧠 <strong>Input</strong></td><td>表单输入框</td><td>ESX：<code>ESX.UI.Menu.Open</code>（旧）<br>QBCore：<code>exports['qb-input']:ShowInput</code><br>OX：<code>lib.inputDialog</code></td></tr><tr><td>💬 <strong>Dialog</strong></td><td>对话框 / 确认提示</td><td>QBCore：<code>exports['qb-dialog']:ShowDialog</code><br>OX：<code>lib.alertDialog</code></td></tr><tr><td>🎯 <strong>Skillbar</strong></td><td>技能条小游戏</td><td>QBCore：<code>exports['qb-skillbar']:StartSkillbar</code><br>OX：<code>lib.skillCheck</code></td></tr><tr><td>🌀 <strong>Radial</strong></td><td>圆形快捷菜单</td><td>QBCore：<code>exports['qb-radialmenu']:OpenMenu</code><br>OX：<code>lib.registerRadial</code></td></tr></tbody></table>

📘 **提示：**\
所有模块的调用方式、样式与动画均可在 `ak-lib/config.lua` 中统一调整。\
无需改动框架文件本体。

***

### ⚙️ 二、替换前必须确认的事项

<table><thead><tr><th width="327.5999755859375">检查项</th><th>说明</th></tr></thead><tbody><tr><td>✅ <strong>确认框架版本</strong></td><td>ESX / QBCore / QBX / OX/Standalone</td></tr><tr><td>🧱 <strong>备份原文件</strong></td><td>替换前请备份文件。</td></tr><tr><td>🚀 <strong>加载顺序正确</strong></td><td>在 <code>server.cfg</code> 中 <code>ensure ak-lib</code> 放在其他脚本前。</td></tr><tr><td>🎨 <strong>调整参数在 config.lua 中进行</strong></td><td>不建议直接修改 HTML 或 CSS 文件。</td></tr><tr><td>🧩 <strong>跨框架服务器</strong></td><td>若同服存在多框架插件，请仅替换主框架对应部分。</td></tr></tbody></table>

***

### 🧭 三、选择对应框架

> 💡 请根据你服务器的主框架选择对应章节进行替换：

* 🧩 [<kbd>**QBCore**</kbd>](/docs/yi-lai/markdown/ti-huan-kuang-jia-mo-ren-zhi/qbcore.md)&#x20;
* 🧩 [<kbd>**ESX**</kbd>](/docs/yi-lai/markdown/ti-huan-kuang-jia-mo-ren-zhi/esx.md)&#x20;
* 🧩 [<kbd>**QBX**</kbd>](/docs/yi-lai/markdown/ti-huan-kuang-jia-mo-ren-zhi/qbx.md)&#x20;
* 🧩 [<kbd>**OX**</kbd>](/docs/yi-lai/markdown/ti-huan-kuang-jia-mo-ren-zhi/ox.md)&#x20;

📘 **说明：**\
**QBX** 框架部分继承 **OX** 接口结构，因此若你使用 **QBX**，部分请直接参考 **OX 教程**。

***

### 🧠 四、各模块替换建议

<table><thead><tr><th width="165.00006103515625">模块</th><th width="137.4000244140625">推荐操作</th><th>说明</th></tr></thead><tbody><tr><td>🔔 Notify</td><td>全替换</td><td>ak-lib 支持队列合并与静音选项，体验更优。</td></tr><tr><td>🔤 TextUI</td><td>全替换</td><td>ak-lib 支持图标、样式、永久显示与国际化。</td></tr><tr><td>⚡ Progress</td><td>全替换</td><td>若你已有自定义 ox_progress 或 qb-progress，可保留。</td></tr><tr><td>🧭 Menu</td><td>全替换</td><td>建议在交互复杂脚本中使用 ak-lib 菜单体验更好。</td></tr><tr><td>🧠 Input</td><td>全替换</td><td>ak-lib 支持多字段表单与 iOS26 风格输入框。</td></tr><tr><td>💬 Dialog</td><td>全替换</td><td>若需统一风格，可切换 ak-lib Dialog。</td></tr><tr><td>🎯 Skillbar</td><td>全替换</td><td>与 ox_lib 的 skillCheck 兼容，可自由选择。</td></tr><tr><td>🌀 Radial</td><td>全替换</td><td>ak-lib 支持队列模式、快捷键绑定与授权功能。</td></tr></tbody></table>

***

### 🧱 五、常见问题

<table><thead><tr><th width="279.5999755859375">问题</th><th>原因与解决</th></tr></thead><tbody><tr><td>⚠️ 没反应</td><td>检查 <code>ak-lib</code> 是否已加载；或脚本未正确导出。</td></tr><tr><td>🧩 事件重复</td><td>关闭原 UI 插件或改事件名防冲突。</td></tr><tr><td>🔇 没声音</td><td>检查 <code>Config.XXX.Sound = true</code>。</td></tr><tr><td>🧾 动画卡顿</td><td>检查是否有前端高帧动画冲突。</td></tr></tbody></table>

***

### 🛠️ 六、推荐启动顺序

```cfg
# ak-lib 优先加载
ensure ak-lib

# 你的主框架
# ensure es_extended
# ensure qb-core
# ensure qbx_core
# ensure ox_core

# 如使用 OX 生态
ensure ox_lib

# 你的业务脚本
ensure my-jobs
ensure my-shops

```

然后根据框架章节进行对应替换。

***

### 💬 七、最终建议

> 💡 **非技术服主：**\
> 按文档操作即可，无需理解代码逻辑。\
> 不要改框架结构，只替换指定函数。

> 🧑‍💻 **开发者：**\
> 可将 ak-lib 导出函数封装到自定义 bridge.lua，\
> 实现框架自动识别与兼容。

### 🛡 八、支持与免责

> ⚠️ **重要声明（请务必阅读）**
>
> * 若因**自行修改**、误删或改错框架文件导致功能异常，**我不提供支持**。
> * 请严格按照本说明文档替换**指定函数**，**不要**随意更改其他逻辑/目录结构。
> * 如需恢复原状，请使用你替换前的**备份文件**回滚。


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://ak-scripts.gitbook.io/docs/yi-lai/markdown/ti-huan-kuang-jia-mo-ren-zhi/bi-kan-shuo-ming.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
