Compilando para macOS

Nota

Esta página describe cómo compilar el editor y las plantillas de exportación de macOS desde el código fuente. Si estás buscando exportar tu proyecto a macOS, lee Exportando para macOS.

Requerimientos

Para compilar en macOS, se requiere lo siguiente:

  • Python 3.8+.

  • SCons 4.0+ build system.

  • Xcode (o las herramientas de línea de comandos más ligeras para Xcode).

  • Vulkan SDK for MoltenVK (macOS doesn't support Vulkan out of the box). The latest Vulkan SDK version can be installed quickly by running misc/scripts/install_vulkan_sdk_macos.sh within the Godot source repository.

Nota

If you have Homebrew installed, you can easily install SCons using the following command:

brew install scons

La instalación de Homebrew también descargará automáticamente las Command Line Tools para Xcode si aún no las tienes.

Similarly, if you have MacPorts installed, you can easily install SCons using the following command:

sudo port install scons

Ver también

Para obtener el código fuente de Godot para compilarlo, consulta la sección Consiguiendo el código fuente.

Para obtener una visión general del uso de SCons para Godot, consulta la sección Introducción al sistema de compilación.

Compilando

Para comenzar, abre una terminal y ve al directorio raíz del código fuente del motor (game engine).

Para compilar para Macs con procesadores Intel (x86-64), utiliza el siguiente comando:

scons platform=macos arch=x86_64

Para compilar para Macs con procesadores Apple Silicon (ARM64), utiliza el siguiente comando:

scons platform=macos arch=arm64

Truco

If you are compiling Godot to make changes or contribute to the engine, you may want to use the SCons options dev_build=yes or dev_mode=yes. See Development and production aliases for more info.

If all goes well, the resulting binary executable will be placed in the bin/ subdirectory. This executable file contains the whole engine and runs without any dependencies. Executing it will bring up the Project Manager.

Nota

No se recomienda utilizar un ejecutable de editor independiente, siempre debe empaquetarse en un paquete .app para evitar problemas de activación de la interfaz de usuario.

Nota

Si deseas utilizar configuraciones de editor separadas para tus propias compilaciones de Godot y las versiones oficiales, puedes habilitar Modo autónomo creando un archivo llamado ._sc_ o _sc_ en la carpeta bin/.

Creación automática de paquetes .app

Para crear automáticamente un paquete .app como en las compilaciones oficiales, use la opción generate_bundle=yes en el último comando SCons usado para compilar el editor:

scons platform=macos arch=x86_64
scons platform=macos arch=arm64 generate_bundle=yes

Manual .app bundle creation

Para admitir ambas arquitecturas en un único archivo binario "Universal 2", ejecuta los dos comandos anteriores y luego utiliza lipo para combinarlos juntos:

lipo -create bin/godot.macos.editor.x86_64 bin/godot.macos.editor.arm64 -output bin/godot.macos.editor.universal

To create an .app bundle, you need to use the template located in misc/dist/macos_tools.app. Typically, for an optimized editor binary built with dev_build=yes:

cp -r misc/dist/macos_tools.app ./bin/Godot.app
mkdir -p bin/Godot.app/Contents/MacOS
cp bin/godot.macos.editor.universal bin/Godot.app/Contents/MacOS/Godot
chmod +x bin/Godot.app/Contents/MacOS/Godot
codesign --force --timestamp --options=runtime --entitlements misc/dist/macos/editor.entitlements -s - bin/Godot.app

Nota

Si estás compilando la rama master, también debe incluir soporte para la biblioteca de portabilidad de Vulkan MoltenVK. Por defecto, se vinculará de manera estática desde su instalación del SDK de Vulkan para macOS. También puedes optar por vincularla de manera dinámica al pasar use_volk=yes e incluir la biblioteca dinámica en su paquete .app:

mkdir -p <Godot bundle name>.app/Contents/Frameworks
cp <Vulkan SDK path>/macOS/lib/libMoltenVK.dylib <Godot bundle name>.app/Contents/Frameworks/libMoltenVK.dylib

Running a headless/server build

To run in headless mode which provides editor functionality to export projects in an automated manner, use the normal build:

scons platform=macos target=editor

Y luego use el argumento de línea de comando --headless:

./bin/godot.macos.editor.x86_64 --headless

Para compilar una versión servidor con depuración que se puede utilizar con herramientas de depuración remota, utiliza:

scons platform=macos target=template_debug

Para compilar una versión optimizada para el servidor de producción, diseñada para ejecutar servidores de juego dedicados, utilice:

scons platform=macos target=template_release production=yes

Construyendo plantillas de exportación

To build macOS export templates, you have to compile using the targets without the editor: target=template_release (release template) and target=template_debug.

Official templates are Universal 2 binaries which support both ARM64 and Intel x86_64 architectures.

  • Para ser compatible con ARM64 (Apple Silicon) + Intel x86_64:

    scons platform=macos target=template_debug arch=arm64
    scons platform=macos target=template_release arch=arm64
    scons platform=macos target=template_debug arch=x86_64
    scons platform=macos target=template_release arch=x86_64 generate_bundle=yes
    
  • Para ser compatible solo con ARM64 (Apple Silicon) (tamaño de archivo más pequeño, pero menos compatible con hardware más antiguo):

    scons platform=macos target=template_debug arch=arm64
    scons platform=macos target=template_release arch=arm64 generate_bundle=yes
    

To create an .app bundle like in the official builds, you need to use the template located in misc/dist/macos_template.app. This process can be automated by using the generate_bundle=yes option on the last SCons command used to build export templates (so that all binaries can be included). This option also takes care of calling lipo to create an Universal 2 binary from two separate ARM64 and x86_64 binaries (if both were compiled beforehand).

Nota

You also need to include support for the MoltenVK Vulkan portability library. By default, it will be linked statically from your installation of the Vulkan SDK for macOS. You can also choose to link it dynamically by passing use_volk=yes and including the dynamic library in your .app bundle:

mkdir -p macos_template.app/Contents/Frameworks
cp <Vulkan SDK path>/macOS/libs/libMoltenVK.dylib macos_template.app/Contents/Frameworks/libMoltenVK.dylib

In most cases, static linking should be preferred as it makes distribution easier. The main upside of dynamic linking is that it allows updating MoltenVK without having to recompile export templates.

You can then zip the macos_template.app folder to reproduce the macos.zip template from the official Godot distribution:

zip -r9 macos.zip macos_template.app

Compilando para macOS desde Linux

Es posible compilar para macOS en un entorno Linux (y tal vez también en Windows utilizando el Subsistema de Windows para Linux). Para ello, deberás instalar OSXCross para poder utilizar macOS como destino. Primero, sigue las instrucciones para instalarlo:

Clona el repositorio OSXCross en algún lugar de tu máquina (o descarga un archivo ZIP y extráelo en algún lugar), por ejemplo:

git clone --depth=1 https://github.com/tpoechtrager/osxcross.git "$HOME/osxcross"
  1. Sigue las instrucciones para empaquetar el SDK en el siguiente enlace: https://github.com/tpoechtrager/osxcross#packaging-the-sdk

  2. Para instalar OSXCross, sigue las instrucciones en el siguiente enlace: https://github.com/tpoechtrager/osxcross#installation

Después de eso, necesitarás definir OSXCROSS_ROOT como la ruta de la instalación de OSXCross (el mismo lugar donde clonaste el repositorio o extrajiste el archivo ZIP), por ejemplo:

export OSXCROSS_ROOT="$HOME/osxcross"

Ahora puedes compilar con SCons como lo harías normalmente:

scons platform=macos

Si tienes una versión de SDK de OSXCross diferente de la esperada por el sistema de construcción de SCons, puedes especificar una personalizada mediante el argumento osxcross_sdk:

scons platform=macos osxcross_sdk=darwin15

Solución De Problemas

Fatal error: 'cstdint' file not found

If you get a compilation error of this form early on, it's likely because the Xcode command line tools installation needs to be repaired after a macOS or Xcode update:

./core/typedefs.h:45:10: fatal error: 'cstdint' file not found
45 | #include <cstdint>
   |          ^~~~~~~~~

Run these two commands to reinstall Xcode command line tools (enter your administrator password as needed):

sudo rm -rf /Library/Developer/CommandLineTools
sudo xcode-select --install

If it still does not work, try updating Xcode from the Mac App Store and try again.