Building via Command Line

Click here to see this page in full context

通过命令行构建

注意通过命令行生成可执行文件需要登录到 IDE。

GameMaker除了通过IDE构建项目外，还允许您使用下面介绍的许多选项和命令通过命令行界面构建项目。您可以通过运行一个批处理文件来生成项目、测试项目并将其部署到多个平台，以及通过自动化服务器（如Jenkins）设置连续集成。

这是由运行Igor.exe可执行文件来完成的，该文件存在于你的运行文件夹中，并传入本页所列的选项和命令。

默认情况下，Igor可以在。

Windows: C:\ProgramData\GameMakerStudio2\Cache\runtimes\runtime-[version]\bin\igor\<OS>\<architecture>\
macOS: /Users/Shared/GameMakerStudio2/Cache/runtimes/runtime-[version]/bin/igor/osx/<architecture>/

注意在尝试命令行构建之前，你必须至少用你的账户登录过IDE。

Igor 持续集成构建

设置

要在计算机上设置CI构建，需要执行以下操作：

安装GameMaker和所需的运行时
通过IDE为所需目标构建项目，以确保它们工作正常
从命令行进行构建测试（请参见下面的示例）
创建一个批处理文件，该文件将执行任务中所需的生成（从命令行测试）
设置CI环境(这取决于您将如何构建游戏)，如 Jenkins
设置您的CI任务并确保已设置所有先决条件(即源代码管理与项目同步)
将批处理文件挂接到CI任务并在Jenkins环境中进行测试

注意

一些平台可能对你的文件路径的长度有问题，在这种情况下，你需要subst 你的PC上的虚拟驱动器，然后再把它们传到你的命令中。
有些平台（特别是安卓）会在构建时自动subst一个驱动器，所以你可能需要在出现错误时手动清理。

选项

以下是运行Igor可执行文件时可以使用的选项：

选项	描述
/lf=[licence_plist_file]	The full path to the licence file, either from the IDE or from the Access Key service To retrieve the licence from the IDE, the paths are as follows: Windows: %appdata%\GameMakerStudio2\<user_name>_<number>\licence.plist macOS: ~/.config/GameMakerStudio2/<user_name>_<number>/licence.plist
/uf=[user_folder]	The user folder used for retrieving licence information, alternative to /lf On Windows, this will be: %appdata%\GameMakerStudio2\<user_name>_<number> On macOS, this will be: ~/.config/GameMakerStudio2/<user_name>_<number>
/rp=[runtime_root]	The root folder of the runtime
/project=[project_YYP_file]	The full path to the project's .yyp file
/cache=[cache_dir_path]	The cache directory to use (defaults to \cache in the current directory)
/temp=[temp_dir_path]	The temporary directory to use (defaults to c:\temp)
/of=[output_filename]	The filename of the output executable without the extension, e.g. C:/output/game, which would output the executable at C:/output/game.zip (or a different file format depending on the platform) If this is not specified, a directory named output will be created in the same directory as the .bat file (or where the command is running from), containing the extracted build files
/tf=[target_file]	The actual file name of the ZIP file or NSIS installer that is created
/config=[configName]	The name of the configuration to use (defaults to Default)
/runtime=YYC\|VM	The output type (either YYC or VM), defaults to VM
/j=[NumCPUs]	The number of CPUs to use during the build process
/df=[devices_json_file]	The path to your devices.json file, required when building to other devices. On Windows, this will be: %appdata%\GameMakerStudio2\<user_name>_<number>\devices.json On macOS, this will be: ~/.config/GameMakerStudio2/<user_name>_<number>/devices.json
/device=[device_name_from_IDE]	The name of the target device to build to, as set up in the IDE
/launch	Launch the executable on the target device after building; same as the "Create Executable and Launch" option in the IDE

访问密钥

/lf选项需要你的licence.plist文件的路径，你可以在登录IDE后从GameMaker安装中获取，如上表所述。

然而，如果你不能访问IDE安装，你可以从GameMaker网站上申请一个访问密钥，并从中生成一个licence.plist文件。

进入gamemaker.io/account/access_keys，用拥有相应许可证的账户登录。
生成一个密钥并将其复制到你的剪贴板上
打开命令提示符，导航到Igor目录（路径在本页顶部给出）
- cd <igor dir>
使用Igor生成许可证文件
- igor runtime FetchLicences -ak=<KeyFromSite> -of=<OutputFileName>
生成到-of路径的licence.plist文件现在可以在/lf选项中使用。

Hello World

下面是一个在Windows上运行游戏的步骤示例：

打开一个命令提示窗口
- Win+R，写上cmd，按Enter
导航到本页顶部给出的Igor目录
- cd <igor dir>
写下igor，然后按回车键，确认你在正确的位置。这样做应该会给你一个Igor的命令列表。如果你得到一个不同的结果，请确保你在正确的目录中。
通过提供项目文件、运行时目录、许可证文件、平台和构建类型来运行一个游戏。用双引号（""）括住每个目录，以确保空间得到正确处理。
- igor /project="<yourProjectDir>\projectname.yyp" /rp="<runtime dir>" /lf="<plist dir>\licence.plist" Windows Run
你的游戏现在应该运行了!

平台实例

下面您可以找到所有平台的构建命令示例:

GX.gamesGX.games

清理 GX.games 项目:

Igor.exe /uf=[user_folder] /rp=[runtime_path] /project=[project_YYP_file] /cache=[cache_dir_path] /temp=[temp_dir_path] -- OperaGX Clean

运行 GX.game:

Igor.exe /uf=[user_folder] /rp=[runtime_path] /project=[project_YYP_file] /cache=[cache_dir_path] /temp=[temp_dir_path] -- OperaGX Run

WindowsWindows

清理 Windows 项目:

Igor.exe /uf=[user_folder] /rp=[runtime_path] /project=[project_YYP_file] /cache=[cache_dir_path] /temp=[temp_dir_path] -- Windows Clean

为 Windows 进行 VM 构建 —— Run、 PackageZip 和 PackageNsis :

Igor.exe /uf=[user_folder] /rp=[runtime_path] /project=[project_YYP_file] /cache=[cache_dir_path] /temp=[temp_dir_path] -- Windows Run

Igor.exe /uf=[user_folder] /rp=[runtime_path] /project=[project_YYP_file] /cache=[cache_dir_path] /temp=[temp_dir_path] /of=[output_filename] /tf=[target_file] -- Windows PackageZip

Igor.exe /uf=[user_folder] /rp=[runtime_path] /project=[project_YYP_file] /cache=[cache_dir_path] /temp=[temp_dir_path] /of=[output_filename] /tf=[target_file] -- Windows PackageNsis

为 Windows 进行 YYC 构建 ——Run、PackageZip和PackageNsis :

Igor.exe /uf=[user_folder] /rp=[runtime_path] /project=[project_YYP_file] /cache=[cache_dir_path] /temp=[temp_dir_path] /runtime=YYC -- Windows Run

Igor.exe /uf=[user_folder] /rp=[runtime_path] /project=[project_YYP_file] /cache=[cache_dir_path] /temp=[temp_dir_path] /of=[output_filename] /tf=[target_file] /runtime=YYC -- Windows PackageZip

Igor.exe /uf=[user_folder] /rp=[runtime_path] /project=[project_YYP_file] /cache=[cache_dir_path] /temp=[temp_dir_path] /of=[output_filename] /tf=[target_file] /runtime=YYC -- Windows PackageNsis

macOSmacOS

重要在 Mac 上需要使用 mono 来运行 Igor，所以在所有命令之前需要编写 mono ，例如: mono Igor.exe [options]"

清理 MacOS 项目:

Igor.exe /uf=[user_folder] /rp=[runtime_path] /project=[project_YYP_file] /cache=[cache_dir_path] /temp=[temp_dir_path] -- Mac Clean

在 Mac 上为 macOS VM 构建:

注意使用 PackageZip 构建 ZIP 文件，使用 PackageDMG 构建 DMG。这些示例使用 PackageZip。

Igor.exe /uf=[user_folder] /rp=[runtime_path] /project=[project_YYP_file] /cache=[cache_dir_path] /temp=[temp_dir_path] /of=[output_filename] /tf=[target_file] -- Mac PackageZip

在 PC 上为 macOS VM 构建:

Igor.exe /uf=[user_folder] /rp=[runtime_path] /project=[project_YYP_file] /cache=[cache_dir_path] /temp=[temp_dir_path] /of=[output_filename] /tf=[target_file] /device=[device_IDE_Name] -- Mac PackageZip

在 Mac 上为 macOS YYC 构建:

Igor.exe /uf=[user_folder] /rp=[runtime_path] /project=[project_YYP_file] /cache=[cache_dir_path] /temp=[temp_dir_path] /of=[output_filename] /tf=[target_file] /runtime=YYC -- Mac PackageZip

在 PC 上为 macOS YYC 构建:

Linux / UbuntuLinux / Ubuntu

清理 Linux 项目:

Igor.exe /uf=[user_folder] /rp=[runtime_path] /project=[project_YYP_file] /cache=[cache_dir_path] /temp=[temp_dir_path] -- Linux Clean

在 PC 上为 Linux VM 构建:

在 PC 上为 Linux YYC 构建:

HTML5HTML5

清理 HTML5项目:

Igor.exe /uf=[user_folder] /rp=[runtime_path] /project=[project_YYP_file] /cache=[cache_dir_path] /temp=[temp_dir_path] -- HTML5 Clean

构建 HTML5文件夹(确保用/tf 指定目标文件夹) :

Igor.exe /uf=[user_folder] /rp=[runtime_path] /project=[project_YYP_file] /cache=[cache_dir_path] /temp=[temp_dir_path] /of=[output_filename] /tf=[target_folder] -- HTML5 folder

iOSiOS

在 Mac 上为 iOS VM 构建:

Igor.exe /uf=[user_folder] /rp=[runtime_path] /project=[project_YYP_file] /cache=[cache_dir_path] /temp=[temp_dir_path] /of=[output_filename] /tf=[target_file] -- ios Package

在 PC 上为 iOS VM 构建:

在 Mac 上为 iOS YYC构建:

Igor.exe /uf=[user_folder] /rp=[runtime_path] /project=[project_YYP_file] /cache=[cache_dir_path] /temp=[temp_dir_path] /of=[output_filename] /tf=[target_file] /runtime=YYC -- ios Package

在PC上为 iOS YYC 构建:

AndroidAndroid

清理 Android 项目:

Igor.exe /uf=[user_folder] /rp=[runtime_path] /project=[project_YYP_file] /cache=[cache_dir_path] /temp=[temp_dir_path] -- Windows Clean

使用 VM 构建 Android APK:

Igor.exe /uf=[user_folder] /rp=[runtime_path] /project=[project_YYP_file] /cache=[cache_dir_path] /temp=[temp_dir_path] /of=[output_filename] /tf=[target_file] -- Android Package

使用 YYC 构建 Android APK:

Igor.exe /uf=[user_folder] /rp=[runtime_path] /project=[project_YYP_file] /cache=[cache_dir_path] /temp=[temp_dir_path] /of=[output_filename] /tf=[target_file] /runtime=YYC -- Android Package

tvOStvOS

清理 tvOS 工程:

Igor.exe /uf=[user_folder] /rp=[runtime_path] /project=[project_YYP_file] /cache=[cache_dir_path] /temp=[temp_dir_path] -- tvos Clean

在 Mac 上为 tvOS VM 构建:

Igor.exe /uf=[user_folder] /rp=[runtime_path] /project=[project_YYP_file] /cache=[cache_dir_path] /temp=[temp_dir_path] /of=[output_filename] /tf=[target_file] -- tvos Package

在 PC 上为 tvOS VM 构建:

在 Mac 上为 tvOS YYC 构建:

Igor.exe /uf=[user_folder] /rp=[runtime_path] /project=[project_YYP_file] /cache=[cache_dir_path] /temp=[temp_dir_path] /of=[output_filename] /tf=[target_file] /runtime=YYC -- tvos Package

在PC上为 tvOS YYC 构建:

PS4PS4

清理 PS4 工程:

Igor.exe /uf=[user_folder] /rp=[runtime_path] /project=[project_YYP_file] /cache=[cache_dir_path] /temp=[temp_dir_path] -- ps4 Clean

在 PC 上为 PS4 VM 构建:

在PC上为 PS4 YYC 构建:

PS5PS5

清理 PS5 工程:

Igor.exe /uf=[user_folder] /rp=[runtime_path] /project=[project_YYP_file] /cache=[cache_dir_path] /temp=[temp_dir_path] -- ps5 Clean

在 PC 上为 PS5 VM 构建:

在PC上为 PS5 YYC 构建:

Xbox OneXbox One

清理 Xbox One 项目:

Igor.exe /uf=[user_folder] /rp=[runtime_path] /project=[project_YYP_file] /cache=[cache_dir_path] /temp=[temp_dir_path] -- XBoxOne Clean

在 PC 上为 Xbox One VM 构建:

在PC上为 Xbox One YYC 构建:

Xbox Series X/SXbox Series X/S

清理 Xbox X/S 系列项目:

Igor.exe /uf=[user_folder] /rp=[runtime_path] /project=[project_YYP_file] /cache=[cache_dir_path] /temp=[temp_dir_path] -- XBoxOneSeriesXS Clean

为 Xbox X/S 系列 VM 构建:

为 Xbox X/S 系列 YYC 构建:

SwitchSwitch

清理Switch项目:

Igor.exe /uf=[user_folder] /rp=[runtime_path] /project=[project_YYP_file] /cache=[cache_dir_path] /temp=[temp_dir_path] -- Switch Clean

在 PC 上为 Switch VM 构建:

在 PC 上为 Switch YYC 构建:

Igor 运行时

下面是可以与 Igor 运行时一起使用的选项:

选项	描述
/uf=[user_folder]	Set the user folder used for retrieving licence information so GameMaker knows which modules can be installed
/lf=[license_file]	Set the direct path to a licence file, can be used as an alternative to setting a user folder (/uf)
/ru=[runtime_url]	Set the URL to fetch runtime information from (defaults to the stable release)
/rp=[runtime_root]	Set the local runtime install folder to list the installed runtimes or install new runtimes

下面是可以与 Igor 运行时一起使用的命令:

语法:

Igor.exe [command]

Command	描述
Runtime List	Lists the runtimes available on a feed (version number, date/time of build)
Runtime ListInstalled [-directory]	Lists the runtimes available in the current folder (directory=full path to the folder) You can specify a directory to look in, but if it's not specified it will default to the current directory This also checks whether there is a receipt.json file and a manifest folder inside the directory (making sure that it's actually a runtime)
Runtime Info [-version]	Prints out information about the most recent runtime on the given feed; also needs a licence file to show information regarding the modules available for the user version can either by a string used to search through the feed titles (e.g.: "739" would show information for all builds containing 739 in their version numbers), or it can be all to show information for all feeds It will list the modules with the .zip file names for each module
Runtime Install [-version]	Installs the latest runtime from the given feed using the given version as a search filter; if that is not specified, it defaults to the latest version. It will get all the modules that the user has on their licence.
Runtime Verify [-folder=.]	Calculates the checksums for all the installed files and compares them to the checksums written into the manifest folder. You can specify a folder to check, however if that is not specified it will default to the current directory. This will flag any files where the checksums don't match, files that are missing and files that should not be there. Do note that the manifest files themselves are not verified and a user can alter the manifest files to match the installed ones.
Runtime FetchLicences [-ak] [-of]	Generates a licence.plist file (-of) from an access key (-ak), see Access Key

Igor 测试

下面是用 Igor 测试构建的选项:

选项	描述
/uf=[user_folder]	Set the user folder used for retrieving licence information so GameMaker knows which modules can be installed
/lf=[license_file]	Set a direct path to a licence file, can be used as an alternative to setting a user folder (/uf)
/df=[device_file]	Set a direct path to a devices.json file, can be used as an alternative to setting a user folder (/uf)
/timeout=[number_of_seconds_to_wait]	The timeout to use for the test in seconds, defaults to 120 seconds; the test will be stopped after this timeout is over and will be marked as failed
/waittime=[number_of_seconds_to_wait]	Number of seconds to wait in the main loop before declaring the test as passed, defaults to 30 seconds
/device=[device_name]	Used to look up the device name in the user folder's devices.json file
/target=[list_of_targets]	Comma-separated list of targets in the PLATFORM\|DEVICE format, e.g.: /target="Windows\|Local,HTML\|Firefox" If you specify all, the tests will attempt to run for every device in the devices.json file

有一个命令可以用来对 Igor 运行测试:

Igor.exe Tests RunTests [test_directory/test_filename]

必须指定测试目录或测试文件名。

如果是目录，Igor将在目录中查找名为tests.json的文件
- 如果找不到文件，Igor将递归搜索 .yyz 和.yyp文件
  - 找到的每个项目都将在Windows上构建和运行
  - 它会一直等到runner到达主环路
    - 如果运行程序在等待时间之后仍在运行，则测试通过
    - 如果项目没有在超时时间内编译，或者在等待时间结束之前崩溃，则测试失败
- 如果找到tests.json文件，Igor将运行文件中描述的测试(参见下面的示例)
或者，您可以提供到 tests.json 文件的直接路径，而不是目录

Tests.json 文件

格式

tests.json文件必须具有以下格式:

JSON 文件应该包含一个对象数组
每个对象应描述一个测试
- 测试对象必须包含这些键:
  - name: 用于报告测试通过还是失败的名称
  - path: 用于测试的.yyp、.yyz、.gml、.js文件或文件夹的路径
  - command: 用于测试的Igor命令（如上所述的Run、 Package 等）
- 测试对象也可以包含这些键:
  - platform: 直接传给Igor做测试
  - device: 来自devices.json文件的设备名称
  - target: “平台|目标”格式，例如： “Windows|Local”
  - timeout: 包括编译和运行在内的整个测试的超时;如果超时，测试将停止并标记为失败
  - waittime: 进入主循环后在决定测试是否通过之前等待的时间长度
  - owner: 如果此测试失败，将收到电子邮件的用户的电子邮件地址

例子

下面是tests.json文件的一个示例:

[
{
"name" : "Game Idea Windows",
"path" : "C:/scratch/GameIdea.yyz",
"platform" : "Windows",
"command" : "Run",
"timeout" : "500",
"waittime" : "30"
},
{
"name" : "Platformer Game Windows",
"path" : "C:/Users/<MY USERNAME>/Documents/GameMakerStudio2/Platformer Game/PlatformerGame.yyp",
"target" : "Windows|Local,HTML5|selenium:firefox,PS4|Default",
"command" : "Run"
},
{
"name" : "Puzzle Game Windows",
"path" : "C:/Users/<MY USERNAME>/Documents/GameMakerStudio2/Puzzle Game/PuzzleGame.yyp",
"platform" : "HTML5",
"command" : "Run",
"device" : "selenium:chrome"
}
]