# @antha/multiplayer-core 中文文档

规范地址：https://npmcn.com/package/%40antha/multiplayer-core/

版本：0\.28\.0
npm 元数据更新时间：2026-10-24T20:25:35.488Z
中文译文更新时间：2026-11-09T21:44:29.288Z
软件包许可：\(MIT OR CC0-1\.0\)

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

原始 npm 页面：https://www.npmjs.com/package/%40antha/multiplayer-core
原文对照：https://npmcn.com/package/%40antha/multiplayer-core/?lang=original
项目主页：https://github.com/electrovir/antha
源码仓库：https://github.com/electrovir/antha

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

- 包体积（解压后）：165 kB，34 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22
- 运行依赖：8 个
- peer 依赖：@antha/util ^0\.28\.0
- 首次发布：2026-06-21T02:10:51.635Z
- 最新版本发布：2026-10-24T20:25:35.258Z
- 近 30 天下载量：1714（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：51（近 12 个月 51 个）

## 中文简介

Antha 多人模式的核心功能.

## 安装

```sh
npm install @antha/multiplayer-core
```

也可以使用：`pnpm add @antha/multiplayer-core`、`yarn add @antha/multiplayer-core`、`bun add @antha/multiplayer-core`

## README

# @antha/多人-核心

该软件包提供会议室、信号、WebRTC和标识功能 [安莎游戏引擎](https://www.npmjs.com/package/@antha/engine)'对等多人功能. 直接用它来构建自定义的多人策略,或者使用其中一种策略包来进行现成的方法.

## 安装

```sh
npm i @antha/multiplayer-core
```

## 默认 STUN 服务器

默认情况下,多人连接会使用Cloudflare的公用STUN服务器(`stun.cloudflare.com:3478`),是一种第三方服务. 每个客户端都会向它发送请求,这暴露了客户端的公开IP地址给Cloudflare. 这帮助不同网络上的同龄人找到彼此的路径.

要改变这个, 设置 `stunServerUrls` 调用时 `initMultiplayer`数字 :

-   使用您的 STUN 服务器 : `stunServerUrls: ['stun.example.com:3478']`
-   完全不用 STUN 服务器 : `stunServerUrls: []`

选择 `stunServerUrls` (或设置为 `undefined`)使用 Cloudflare 默认值,导出为 `defaultStunServerUrls`。 。 。 .

## 使用量

```TypeScript
import {createMultiplayerApiClient, createMultiplayerId} from '@antha/multiplayer-core';

const roomId = createMultiplayerId.room();
const multiplayerApiClient = await createMultiplayerApiClient({
    backendOrigin: 'http://localhost:9348',
    portScanOptions: false,
});
```

## 常见问题

### @antha/multiplayer-core 是什么？

Antha 多人模式的核心功能\.

### 如何安装 @antha/multiplayer-core？

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

### @antha/multiplayer-core 支持 TypeScript 吗？

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

### @antha/multiplayer-core 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @antha/multiplayer-core 需要什么版本的 Node\.js？

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

### @antha/multiplayer-core 可以商用吗？

@antha/multiplayer-core 使用 \(MIT OR CC0-1\.0\) 许可。可在 MIT、CC0-1\.0 中任选其一遵守。选择 MIT 时，宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @antha/multiplayer-core 的下载量有多少？

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

### @antha/multiplayer-core 还在维护吗？

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