# @gamemaker/gm-cli 中文文档

规范地址：https://npmcn.com/package/%40gamemaker/gm-cli/

版本：2\.4\.1
npm 元数据更新时间：2026-09-28T08:48:05.026Z
中文译文更新时间：2026-11-15T22:10:09.755Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40gamemaker/gm-cli
原文对照：https://npmcn.com/package/%40gamemaker/gm-cli/?lang=original
源码仓库：https://github.com/YoYoGames/gm-cli

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

- 包体积（解压后）：2.1 MB，34 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=24
- 运行依赖：0 个
- 首次发布：2026-04-29T08:55:41.959Z
- 最新版本发布：2026-09-28T08:48:04.739Z
- 近 30 天下载量：4494（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：16（近 12 个月 16 个）

## 中文简介

GameMaker命令行界面GM-CLI是编辑,编译,包装和运行您GameMaker项目的有用工具.

## 安装

```sh
npm install @gamemaker/gm-cli
```

也可以使用：`pnpm add @gamemaker/gm-cli`、`yarn add @gamemaker/gm-cli`、`bun add @gamemaker/gm-cli`

## README

# 游戏Maker CLI

**GameMaker 命令行界面 `gm-cli` 是编辑、编译、包装和运行您的 GameMaker 项目的有用工具.**

![Recording of the gm-cli run command](https://raw.githubusercontent.com/YoYoGames/gm-cli/refs/heads/main/recordings/run.gif)

# 使用量

> 您必须先安装 [节点JS](https://nodejs.org/en) 和工具一起来的 `npm` 财务报告和审定财务报表 `npx`。 。 。 .

运行 :

```sh
npx @gamemaker/gm-cli@latest --help
```

...或者如果你喜欢安装 `gm-cli` 全球

```
npm install -g @gamemaker/gm-cli@latest
gm-cli --help
```

GameMaker CLI 有许多 _命令_更多了解他们,使用 `--help` 旗帜。 举例来说,看看如何 `compile` 命令工作, 运行 :

```
npx @gamemaker/gm-cli@latest compile --help
```

### 创建新项目

使用 `gm-cli init` 从空白游戏或模板创建新项目.

```sh
npx @gamemaker/gm-cli@latest init
```

如果您愿意,它也会帮助您设置更高级的功能,例如:

-   GitHub 自动化管道来编译和包装您的工程
-   AI 代理集成(AGENTS.md, MCP, Claude Config)

### 编译、运行和软件包项目

GameMaker CLI可以自动下载运行时间以及编译和运行您项目所需的所有其他工具.

尝试在文件夹中运行其中一项命令 `.yyp` 文件 :

```sh
npx @gamemaker/gm-cli@latest run
npx @gamemaker/gm-cli@latest compile
npx @gamemaker/gm-cli@latest package
```

请注意,有许多选项,例如: `target`, (中文(简体) ), `runtime` 财务报告和审定财务报表 `toolchain` 如果您愿意,则要配置。 使用 `--help` 更多细节。 例如:

```
npx @gamemaker/gm-cli@latest compile --runtime=vm --target=operagx --toolchain=gms2@2024.14.3.260
```

### 没有 IDE 编辑工程

使用 `gm-cli resourcetool` 在程序上修改您的项目文件而无需使用IDE。 在项目里试试看

```sh
gm-cli resourcetool eval "resource list"
```

使用"资源工具"的方法有很多种,最方便的是使用"资源工具"的AI代理 [示范背景协议](https://modelcontextprotocol.io/docs/getting-started/intro) `gm-cli resourcetool mcp`。但您也可以在交互式会话中使用它 `gm-cli resourcetool repl` 或作作是语.

### 签名

GameMaker CLI 自动给您一个来宾执照,所以不需要签入. 但如果你想用你自己的接入密钥 [https://gameker.io/en/access/access-keys 互联网档案馆的存檔,存档日期2013-12-02](https://gamemaker.io/en/account/access-keys)您可以运行 :

```
npx @gamemaker/gm-cli@latest login <my key>
```

### 查询 GameMaker 手册

命令 `gm-cli manual` 可用于 _模拟_ 搜索 [GameMaker 手册](https://manual.gamemaker.io/monthly/en/)。使用 `open` 在浏览器中打开网页的子命令。 您也可以通过 `--language`。试试看:

```sh
gm-cli manual open "sprites" --language=es
```

这个 `read` 子命令直接在终端显示文章,

```sh
gm-cli manual read "data structures"
```

### 发布到 GX. 游戏

使用 `gm-cli gxgames` 发布游戏到 [gx.game 游戏](https://gx.games/)运行 `gm-cli gxgames --help` 用于完整子命令列表.

流量 :

1.  **软件包** 游戏作为 OperaGX zip :
    
    ```sh
    npx @gamemaker/gm-cli@latest package --target=operagx --output=game.zip
    ```
    
2.  **链接** 项目到工作室和游戏(打开浏览器,以便在第一次使用时签名):
    
    ```sh
    npx @gamemaker/gm-cli@latest gxgames link --studioid=<id> --gameid=<id>
    ```
    
    关闭旗帜 选择交互.
3.  **上传** zip( 秒数为 a) `X.Y.Z.B` 版本,如果 `--version` 删去:
    
    ```sh
    npx @gamemaker/gm-cli@latest gxgames upload --file=game.zip --version=1.0.0.0
    ```
    
4.  **设置元数据** 需要用于出版——标题(必须在整个GX.Games中独有),描述,年龄评级,平台,16:9封面,16:9截图. 封面和图形必须 **准确** 16:9相相比(如1920×1080):
    
    ```sh
    npx @gamemaker/gm-cli@latest gxgames meta \
      --title="My Game" \
      --description="A short description" \
      --age-rating=EVERYONE \
      --platforms=DESKTOP,MOBILE \
      --cover=cover_1920x1080.png \
      --graphic=screenshot_1920x1080.png
    ```
    
    每个旗帜都覆盖一个字段;省略了旗帜保留当前服务器值.
5.  **发布** 使游戏公开(打开已公布的关于成功页面):
    
    ```sh
    npx @gamemaker/gm-cli@latest gxgames publish
    ```
    

## 捐款

GameMaker CLI是为社区制作的,我们欢迎你们的反馈! 请提出特征 或告诉我们你有任何问题.

## 常见问题

### @gamemaker/gm-cli 是什么？

GameMaker命令行界面GM-CLI是编辑,编译,包装和运行您GameMaker项目的有用工具\.

### 如何安装 @gamemaker/gm-cli？

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

### @gamemaker/gm-cli 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/gamemaker\_\_gm-cli 是否存在。

### @gamemaker/gm-cli 支持 ESM 还是 CommonJS？

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

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

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

### @gamemaker/gm-cli 可以商用吗？

@gamemaker/gm-cli 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @gamemaker/gm-cli 的下载量有多少？

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

### @gamemaker/gm-cli 还在维护吗？

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