# @gamecrate/cli 中文文档

规范地址：https://npmcn.com/package/%40gamecrate/cli/

版本：3\.13\.1
npm 元数据更新时间：2026-11-12T20:41:37.370Z
中文译文更新时间：2026-11-15T22:03:55.484Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：635 kB，73 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22
- 运行依赖：7 个
- 首次发布：2026-09-16T19:17:11.067Z
- 最新版本发布：2026-11-12T20:41:36.811Z
- 近 30 天下载量：3920（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：51（近 12 个月 51 个）

## 中文简介

在容器中运行一个嵌入式游戏, 由您的本地检出解决 Mods .

## 安装

```sh
npm install @gamecrate/cli
```

也可以使用：`pnpm add @gamecrate/cli`、`yarn add @gamecrate/cli`、`bun add @gamecrate/cli`

## README

# @ gamecrate/ cli (英语)

[![npm](https://img.shields.io/npm/v/%40gamecrate%2Fcli)](https://www.npmjs.com/package/@gamecrate/cli) [![npm downloads](https://img.shields.io/npm/dm/%40gamecrate%2Fcli)](https://www.npmjs.com/package/@gamecrate/cli) [![MIT license](https://img.shields.io/npm/l/%40gamecrate%2Fcli)](https://npmcn.com/package/LICENSE) [![Discord](https://img.shields.io/badge/Discord-Cryptiks_Mods-5865F2?logo=discord&logoColor=white)](https://discord.gg/tbcKN8e4mZ)

在 Docker 容器中运行一个嵌入游戏 。 描述一下你的档案,然后按名字发射 每个配置 获得自己的设置、日志和模式列表。 一旦设定了一个配置文件, 那就是整个命令 :

```sh
gamecrate run <profile>
```

## 在你开始之前

现在,这只适用于Linux。 它可能在WSL工作,但还没有经过测试. 你还需要 Docker跑来跑去 游戏的复制品.

`gamecrate doctor` 检查所有三个,报告每个问题一起.

## 设置您的第一个配置

```sh
npm install -g @gamecrate/cli
gamecrate init
```

`init` 为您要使用的游戏安装插件并写入 `~/.config/gamecrate/config.yml`。 。 。 . 它还提出建立一个地方性的 `.gamecrate.yml` 同样,对于一个持有您正在工作的 mod 的目录 继续.

全局文件持有一般配置和默认值,以及一个项目的 `.gamecrate.yml` 给 用于特定模式的特定配置和配置.

游戏的源头是你必须做出的唯一选择:

游戏安装在这里

将您的安装绑入容器 `/game`。图像提供了一些 外加周围的东西:虚拟显示、图形驱动器和系统库 引擎链接。 点 `gameFiles.host` 在安装目录中,运行时图像会处理 本身:

```yaml
plugins: ['@gamecrate/rimworld']
games:
  rimworld:
    gameFiles:
      host: ~/.steam/steam/steamapps/common/RimWorld
    profiles:
      dev:
        mods: [concordlib.concord, yourname.yourmod] # more info on this coming later
```

没有 `image` 块(运行时间),游戏背景拉 `ghcr.io/rimworks/gamecrate/runtime-base:1`这是 大约160 MB,所以这个路径不需要多吉加比特下载,也不需要自己注册. 蒸气 保持游戏本身的更新. 欢迎您创建自己的运行时图像 如果你需要添加更多, 或只想要你自己的东西.

或 游戏未在此安装, 或者您想要孤立的安装

您也可以根据游戏的运行时间图像构建包含整个游戏的图像. 运行 下面的命令和玩法为您构建一个命令 :

```sh
gamecrate steam login
gamecrate steam build --game rimworld
```

游戏就住在画面里 所以放下 `gameFiles.host` 设置 `source: image` 相反:

```yaml
plugins: ['@gamecrate/rimworld']
games:
  rimworld:
    gameFiles:
      source: image
    image:
      ref: rimworld:1.6
      acquire: pull
    profiles:
      dev:
        mods: [concordlib.concord, yourname.yourmod] # more info on this coming later
```

它用游戏自己的版本标记图像,并使用 `:latest`

`run` 仅在图像缺失时才拉出,所以一个本地装入的图像被单独放出. `gamecrate run dev --image <ref>` 对一次跑步也一样 却不碰它.

[配置](https://npmcn.com/package/%40gamecrate/cli/packages/cli/docs/configuration.md) 覆盖每把钥匙,和 [游戏图像](https://npmcn.com/package/%40gamecrate/cli/packages/cli/docs/images.md) 盖取所起.

### Mod id来自哪里

一个名字像 `concordlib.concord` 这是mod自己的包 id,读出它的表。 游戏板 建立它可以看到的每个模式的索引,然后在其中匹配每个名称 `mods` 反对它。 看起来 在四个地方:

| 来源 | 持有 |
| --- | --- |
| 这个 `Data` 安装中的目录 | 核心游戏及其官方 DLC |
| `workshopRoot` | 所有 Steam 为您下载的 |
| `scanRoots` | 自己的目录, 像一个退货文件夹 |
| 下载目录 | 任何东西 `gamecrate mods add` 帮你拉倒了 |

这里的配置没有列出最后三个名称,所以只有核心游戏才能解决. 加上你们 拥有:

```yaml
    workshopRoot: ~/.steam/steam/steamapps/workshop/content/294100
    scanRoots:
      - path: ~/projects/mods
        maxDepth: 2
```

`gamecrate mods <profile>` 列出一个配置文件所解析的内容,并列出它无法找到的东西的名称。 针头 a mod gamecrate 下载本身, 通过工作坊 id 或 git URL, 运行 `gamecrate mods add`。 。 。 . [模式来源](https://npmcn.com/package/%40gamecrate/cli/packages/cli/docs/mod-sources.md) 覆盖所有命名方式, 以及哪些副本 双打时获胜.

## 发射

```sh
gamecrate doctor              # every reason a launch could fail, reported together
gamecrate run dev --print-plan  # every path, mod and bind, without starting anything
gamecrate run dev
```

也可以运行脱离器,并有命令在容器脱出后管理:

```sh
gamecrate run dev --detach
gamecrate ps                  # what is running, and how long it has been up
gamecrate logs dev -f         # follow this run's log
gamecrate stop dev            # free the profile
```

将一个mod指向工作检出并首先编译:

```sh
gamecrate run dev --use yourname.yourmod=~/projects/yourmod --build
```

你可以用这个 `gamecrate help` 命令查找命令行工具本身的更多信息。 它还以子命令作为参数.

## 下一个去哪里

| 读这个 | 当你想 |
| --- | --- |
| [配置](https://npmcn.com/package/%40gamecrate/cli/docs/configuration.md) | 写入配置文件, 装入插件, 定义配置文件, 或设定每个存储器默认值 |
| [模式来源](https://npmcn.com/package/%40gamecrate/cli/docs/mod-sources.md) | 将一个 mod 插入目录、 git 寄存器或工作坊项目 gamecrate 下载, 并了解哪个副本获胜 |
| [运行](https://npmcn.com/package/%40gamecrate/cli/docs/running.md) | 启动、在背景中运行、读取结果、关闭窗口、清理 |
| [游戏图像](https://npmcn.com/package/%40gamecrate/cli/docs/images.md) | 从 Steam 上的游戏中构建一个可启动图像 |
| [参考文献](https://npmcn.com/package/%40gamecrate/cli/docs/reference.md) | 每个子命令、 旗帜、 环境变量和退出代码 |
| [写入插件](https://npmcn.com/package/%40gamecrate/cli/docs/plugins.md) | 教游戏新游戏 |

[`@gamecrate/rimworld`](https://npmcn.com/package/%40gamecrate/rimworld) 是 RimWorld 插件,也是一个完整的示例 插件合同.

## 常见问题

### @gamecrate/cli 是什么？

在容器中运行一个嵌入式游戏, 由您的本地检出解决 Mods \.

### 如何安装 @gamecrate/cli？

在项目目录运行 npm install @gamecrate/cli，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 gamecrate，可以用 npx gamecrate 直接运行。

### @gamecrate/cli 支持 TypeScript 吗？

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

### @gamecrate/cli 支持 ESM 还是 CommonJS？

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

### @gamecrate/cli 需要什么版本的 Node\.js？

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

### @gamecrate/cli 可以商用吗？

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

### @gamecrate/cli 的下载量有多少？

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

### @gamecrate/cli 还在维护吗？

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