Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Redot.

Checking the stable version of the documentation...

Xcode

Xcode is a free macOS-only IDE. You can download it from the Mac App Store.

Importing the project

  • From Xcode's main screen create a new project using the Other > External Build System template.

../../../_images/xcode_1_create_external_build_project.webp

  • Now choose a name for your project and set the path to scons executable in build tool (to find the path you can type where scons in a terminal).

../../../_images/xcode_2_set_external_build_project_parameters.webp

  • Open the main target from the Targets section and select the Info tab.

../../../_images/xcode_3_configure_scons.webp

  • Fill out the form with the following settings:

    Arguments

    See Introduction to the buildsystem for a full list of arguments.

    Directory

    A full path to the Redot root folder

  • Add a Command Line Tool target which will be used for indexing the project by choosing File > New > Target....

../../../_images/xcode_4_add_new_target.webp

  • Select macOS > Application > Command Line Tool.

../../../_images/xcode_5_select_command_line_target.webp

Note

Name it something so you know not to compile with this target (e.g. GodotXcodeIndex).

  • For this target open the Build Settings tab and look for Header Search Paths.

  • Set Header Search Paths to the absolute path to the Redot root folder. You need to include subdirectories as well. To achieve that, add two two asterisks (**) to the end of the path, e.g. /Users/me/repos/redot-source/**.

  • Add the Redot source to the project by dragging and dropping it into the project file browser.

  • Select Create groups for the Added folders option and check only your command line indexing target in the Add to targets section.

../../../_images/xcode_6_after_add_redot_source_to_project.webp

  • Xcode will now index the files. This may take a few minutes.

  • Once Xcode is done indexing, you should have jump-to-definition, autocompletion, and full syntax highlighting.

Debugging the project

To enable debugging support you need to edit the external build target's build and run schemes.

  • Open the scheme editor of the external build target.

  • Locate the Build > Post Actions section.

  • Add a new script run action

  • Under Provide build settings from select your project. This allows to reference the project directory within the script.

  • Create a script that will give the binary a name that Xcode can recognize, e.g.:

ln -f ${PROJECT_DIR}/godot/bin/redot.macos.tools.64 ${PROJECT_DIR}/godot/bin/redot
../../../_images/xcode_7_setup_build_post_action.webp

  • Build the external build target.

  • Open the scheme editor again and select Run.

../../../_images/xcode_8_setup_run_scheme.webp

  • Set the Executable to the file you linked in your post-build action script.

  • Check Debug executable.

  • You can add two arguments on the Arguments tab: the -e flag opens the editor instead of the Project Manager, and the --path argument tells the executable to open the specified project (must be provided as an absolute path to the project root, not the project.godot file).

To check that everything is working, put a breakpoint in platform/macos/redot_main_macos.mm and run the project.

If you run into any issues, ask for help in one of Redot's community channels.