# @flavibot-public/shoukaku 中文文档

规范地址：https://npmcn.com/package/%40flavibot-public/shoukaku/

版本：5\.0\.48
npm 元数据更新时间：2026-10-08T01:26:40.656Z
中文译文更新时间：2026-11-14T21:58:46.349Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40flavibot-public/shoukaku
原文对照：https://npmcn.com/package/%40flavibot-public/shoukaku/?lang=original
项目主页：https://github.com/flavibot/Shoukaku#readme
源码仓库：https://github.com/flavibot/Shoukaku

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：406 kB，10 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=18\.0\.0
- 运行依赖：1 个
- 首次发布：2025-03-04T00:49:56.770Z
- 最新版本发布：2026-10-08T01:26:40.460Z
- 近 30 天下载量：23511（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：37（近 12 个月 10 个）

## 中文简介

围绕Lavalink的稳定和更新的包装

## 安装

```sh
npm install @flavibot-public/shoukaku
```

也可以使用：`pnpm add @flavibot-public/shoukaku`、`yarn add @flavibot-public/shoukaku`、`bun add @flavibot-public/shoukaku`

## README

## Sho口

> 围绕Lavalink的稳定和更新的包装

[![Discord](https://img.shields.io/discord/423116740810244097?style=flat-square)](https://discordapp.com/invite/FVqbtGu) [![npm](https://img.shields.io/npm/v/shoukaku?style=flat-square)](https://www.npmjs.com/package/shoukaku) ![Github Stars](https://img.shields.io/github/stars/Deivu/Shoukaku?style=flat-square) ![GitHub issues](https://img.shields.io/github/issues-raw/Deivu/Shoukaku?style=flat-square) ![NPM](https://img.shields.io/npm/l/shoukaku?style=flat-square)

![](https://azurlane.netojuu.com/images/thumb/d/dc/ShoukakuWeddingWithoutBG.png/767px-ShoukakuWeddingWithoutBG.png)

### 特征

-   稳定
    
-   更新
    
-   记录
    
-   可扩展
    
-   支持无害环境管理和通用JS
    
-   非常可爱(非常重要)
    

### 文档

> [https://guide.shoukaku.shipgirl.moe/ (原始内容存档于2018-09-29)](https://guide.shoukaku.shipgirl.moe/)

### 开始

> [https://guide.shoukaku.shipgirl.moe/guides/1-getting-started/ 页面存档备份,存于互联网档案馆](https://guide.shoukaku.shipgirl.moe/guides/1-getting-started/)

### 支持的图书馆

> [https://guide.shoukaku.shipgirl.moe/guides/5-connectors/ (中文(简体) )](https://guide.shoukaku.shipgirl.moe/guides/5-connectors/)

### 示例瓶

> [https://github.com/Deivu/ 孔古 (中文(简体) )](https://github.com/Deivu/Kongou)

### 配置选项

```js
// Parameters for main class init, Options is the Configuration Options
new Shoukaku(new Connectors.DiscordJS(client), Nodes, Options);
```

| 选项 | 类型 | 默认 | 说明 | 页:1 |
| --- | --- | --- | --- | --- |
| 恢复 | 布尔 | 虚假 | 如果您想要在连接到熔岩链断开时启用恢复 |  |
| 恢复超时 | 编号 | 30个 | 熔岩链接在断开前将玩家销毁 | 数秒 |
| 恢复图书馆 | 布尔 | 虚假 | 如果你想强迫恢复玩家,不管它是否被熔岩所还原 |  |
| 重新连接 | 编号 | 3个 | 在断开前尝试重接熔岩链的次数 |  |
| 重新连接Interval | 编号 | 页:1 | 再连接之间的超时 | 数秒 |
| 暂停时间 | 编号 | 页:1 | 等待休息熔岩链接请求的最大时间 | 数秒 |
| 在断开连接时移动 | 布尔 | 虚假 | 当节点断开时是否将玩家移动到不同的熔岩链接节点 |  |
| 用户代理 | 字符串 | (自动) | 更改用于熔岩链接请求的用户代理 | 未建议更改 |
| 结构 | 对象{ rest?, 玩家?} | {} | 自定义用于shoukaku的结构 |  |
| 语音连接时断 | 编号 | 15个 | 等待加入语音频道命令的最大时间 | 数秒 |
| 节点解析器 | 函数 | 函数 | 想要获得理想节点的自定义节点解析器 |  |

### 包装器

| 名称 | 链接 | 说明 |
| --- | --- | --- |
| 卡萨古莫 | [吉图布](https://github.com/Takiyo0/Kazagumo) | 用于 Shoukaku 的有内部队列系统的包装符 |

> 如果您想要在此添加一个包装, 请打开 pr

### 其他链接

-   [解析器](https://discord.gg/FVqbtGu)
    
-   [熔岩链接](https://github.com/lavalink-devs/Lavalink)
    

### 由@ichimakase (Saya) 制作的代码

> 船舶女孩项目

## 常见问题

### @flavibot-public/shoukaku 是什么？

围绕Lavalink的稳定和更新的包装

### 如何安装 @flavibot-public/shoukaku？

在项目目录运行 npm install @flavibot-public/shoukaku，或使用 pnpm add / yarn add / bun add。

### @flavibot-public/shoukaku 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @flavibot-public/shoukaku 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @flavibot-public/shoukaku 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=18\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @flavibot-public/shoukaku 可以商用吗？

@flavibot-public/shoukaku 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @flavibot-public/shoukaku 的下载量有多少？

根据 npm 官方下载统计，@flavibot-public/shoukaku 在 2026/10/15 – 2026/11/13 这 30 天内被下载 23,511 次，日均约 784 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @flavibot-public/shoukaku 还在维护吗？

最新版本 5\.0\.48 发布于 2026/10/08（1 个月前）；至今共发布 37 个版本，其中过去 12 个月发布了 10 个；首次发布于 2025/03/04。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。