# @colyseus/monitor 中文文档

规范地址：https://npmcn.com/package/%40colyseus/monitor/

版本：0\.18\.7
npm 元数据更新时间：2026-10-22T14:37:44.158Z
中文译文更新时间：2026-11-10T11:29:00.791Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：4.5 MB，25 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>= 22\.x
- 运行依赖：2 个
- peer 依赖：@colyseus/core 0\.18\.x
- 首次发布：2018-04-17T03:17:21.134Z
- 最新版本发布：2026-10-22T11:29:50.422Z
- 近 30 天下载量：177857（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：121（近 12 个月 18 个）

## 中文简介

科利修斯网络监测小组

## 安装

```sh
npm install @colyseus/monitor
```

也可以使用：`pnpm add @colyseus/monitor`、`yarn add @colyseus/monitor`、`bun add @colyseus/monitor`

## README

# @colyseus/ 监视器

科利修斯网络监测小组.

您可以使用一个快捷的中间软件来启用监视器路由上的认证, 例如 `express-basic-middleware`数字 :

```typescript
import * as basicAuth from "express-basic-auth";

const basicAuthMiddleware = basicAuth({
    // list of users and passwords
    users: {
        "admin": "admin",
    },
    // sends WWW-Authenticate header, which will prompt the user to fill
    // credentials in
    challenge: true
});

app.use("/colyseus", basicAuthMiddleware, monitor());
```

## 设置自定义房间列表列

```typescript
app.use("/colyseus", basicAuthMiddleware, monitor({
  columns: [
    'roomId',
    'name',
    'clients',
    { metadata: "spectators" }, // display 'spectators' from metadata
    'locked',
    'elapsedTime'
  ]
}));
```

如果未说明,默认房间列表栏为: `['roomId', 'name', 'clients', 'maxClients', 'locked', 'elapsedTime']`。 。 。 .

## 发展

安装依赖关系并启动 dev-server :

```
npm install
npm start
```

访问用户界面 [http://localhost:2567/colyseus (英语)](http://localhost:2567/colyseus)。 。 。 .

## 环境变量

-   (可选) `GAME_SERVER_URL`: 用于colyseus 监视器的URL(例如: `server.game.com`),默认为当前 URL (`${window.location.protocol}//${window.location.host}${window.location.pathname}`(中文(简体) )

## 许可证

麻省理工学院

## 常见问题

### @colyseus/monitor 是什么？

科利修斯网络监测小组

### 如何安装 @colyseus/monitor？

在项目目录运行 npm install @colyseus/monitor，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@colyseus/core（0\.18\.x）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @colyseus/monitor 支持 TypeScript 吗？

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

### @colyseus/monitor 支持 ESM 还是 CommonJS？

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

### @colyseus/monitor 需要什么版本的 Node\.js？

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

### @colyseus/monitor 可以商用吗？

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

### @colyseus/monitor 的下载量有多少？

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

### @colyseus/monitor 还在维护吗？

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