# @0x0c/rcon 中文文档

规范地址：https://npmcn.com/package/%400x0c/rcon/

版本：1\.0\.0
npm 元数据更新时间：2024-07-30T06:09:02.247Z
中文译文更新时间：2026-11-06T15:14:05.757Z
软件包许可：ISC

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

原始 npm 页面：https://www.npmjs.com/package/%400x0c/rcon
原文对照：https://npmcn.com/package/%400x0c/rcon/?lang=original
项目主页：https://github.com/keyCat/node-rcon

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

- 包体积（解压后）：52 kB，21 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2024-07-30T06:09:01.495Z
- 最新版本发布：2024-07-30T06:09:01.761Z
- 近 30 天下载量：2936（2026-10-04 至 2026-11-02，npm 官方下载统计）
- 已发布版本数：1（近 12 个月 0 个）

## 中文简介

简单的队列为 RCON 客户端,支持多包响应.

## 安装

```sh
npm install @0x0c/rcon
```

也可以使用：`pnpm add @0x0c/rcon`、`yarn add @0x0c/rcon`、`bun add @0x0c/rcon`

## README

# 节点JS RCON 客户端

```bash
$ npm install @0x0c/rcon
```

一个零依赖性,完全类型的Node.js库,为与服务器交互提供客户端 支助 [RCON 协议](https://developer.valvesoftware.com/wiki/Source_RCON_Protocol)。 。 。 .

支持多包回放,超时并排出框.

## 快速启动

```ts
import {RconClient} from '@0x0c/rcon';

const rcon = new RconClient({
    host: '127.0.0.1',
    port: 27015,
    password: '<my-rcon-password>',
});

async function queryStatus() {
    const [status, stats] = await Promise.all([rcon.send('status'), rcon.send('stats')]);
    myCustomParserForStatusCommandResponse(status);
    parseAndStoreServerStats(stats);
    // close connection when it is not required anymore
    rcon.disconnect();
}

queryStatus();
```

## API 密码

### `new RconClient(options): RconClient`

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `options` | 对象 | 选项 |
| `options.host` | 字符串 | 服务器的IP地址或主机名 |
| `options.port` | 编号 | RCON 端口 |
| `options.password` | 字符串 | RCON 密码 |
| \[`options.timeout=5000`\[ . \] | 编号 | 可选的 以毫秒计的响应超时 。 默认 : `5000` |

### `RconClient.connect(): Promise<void>`

连接到服务器 。 此方法在发送第一个命令时会自动调用, 但是您可以手动调用它 如果您想检查之后的连接状态.

### `RconClient.connected: boolean`

显示客户端是否连接到服务器的属性 .

### `RconClient.send(command, options?): Promise<string>`

向服务器发送命令, 将回复作为字符串 .

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `command` | 字符串 | 要发送的命令 |
| \[`options`\[ . \] | 对象 | 可选的 选项 |
| \[`options.timeout`\[ . \] | 编号 | 可选的 设置此命令的超时与连接超时分开 。 默认: 等于连接超时 |
| \[`options.multipacket=true`\[ . \] | 布尔 | 可选的 使用帮助读取多包响应的"边界包"发送至少两个命令. 默认 : `true` |

### `RconClient.disconnect(): void`

关闭连接到服务器 。 连接在命令之间保持活性,所以您应该使用这种方法 为了腾出资源.

## 页:1

默认情况下,所有命令都会按预期发送 _多包反应_。 。 。 .

然而,这意味着,即使最小的答复也可能需要两倍的时间(大概)才能解决,因为有两个包是: 已队列: 命令本身的软件包, 以及“ 边界” 软件包( 帮助连接客户端的垃圾包) 了解当服务器完成对先前序列包的回复时.

您可以在发送时禁用此特性 :

```ts
const stats = await rcon.send('stats', {multipacket: false});
```

## 常见问题

### @0x0c/rcon 是什么？

简单的队列为 RCON 客户端,支持多包响应\.

### 如何安装 @0x0c/rcon？

在项目目录运行 npm install @0x0c/rcon，或使用 pnpm add / yarn add / bun add。

### @0x0c/rcon 支持 TypeScript 吗？

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

### @0x0c/rcon 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @0x0c/rcon 可以商用吗？

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

### @0x0c/rcon 的下载量有多少？

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

### @0x0c/rcon 还在维护吗？

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