How to compile out Godot 2.1.6 on MacOS 10.15.2?

m04arjun

I have tried multiple times to compile out Godot 2.1.6 on MacOS 10.15.2 but it keeps giving errors.I have a project that was made in godot 2.1 that I want to port over to a Mac. This project requires a custom module that we added so we need to compile out the editor as well.

When I tried to compile out the editor, I was getting some error messages related to xcode. I am attaching the image of the error messages that I am getting. These messages were from trying to compile out (clean) Godot 2.1.6 using the source code from the official godot git(https://github.com/godotengine/godot/releases/tag/2.1.6-stable)with nothing else added extra. Dev Environment: I am using a Macbook air running macOS 10.15.2. I tried to use xcode 11.5 at first and got these errors and assumed that xcode may have some changes to rhe SDK that were causing these errors. I then tried to use Xcode 10.2, which also resulted in the same errors.

**I cannot use a prebuilt version of Godot because that wouldn't have the module that we require. I cannot use the latest version of Godot because this project is around 5-6 years old and it wouldn't open on Godot 3.

Thanks in advance!

Calinou

In general, old versions will have trouble compiling on modern operating systems. This issue happens with pretty much any C/C++ application, on any operating system.

It's suggested you use the 2.1 branch instead of the 2.1.6 tagged release, try to fix the compilation issue there and open a pull request against the 2.1 branch so everyone can benefit from it. Since we have few contributors proficient with macOS/iOS (I'm not one of those), you'll have to figure out how to fix this on your own.

gioele

Hello, I helped out solving this problem and I would like to share the solution and ask for some suggestions on the next step.

We were able to compile Godot 2.1.6 using the following components: macOS 10.14 (comes with python 2.7 pre-installed) Xcode command line tools 10.2.1 * scons 3.1.2 (last one supporting python 2.7)

macOS 10.15 SDK where changed so it is necessary to get an old machine or a virtual machine. Software can be found on https://developer.apple.com/download/more/ (free developer account required)

After unzipping Godot 2.1.6 and scons, it is necessary to move scons folder inside Godot directory and make sure it is named scons (it makes following command easier).

The to compile just open Terminal and move to Godot directory type: python scons/src/script/scons.py p=osx target=release_debug bits=64

To make the portable app package just follow the official documentation to move the bin inside the app template.

If the app is fat or 64 bits, it will work for sure on macOS 10.15

gioele

That was the solution, now move on to the next problem.

To compile with custom module we just put the code folder inside godot-2.1.6/modules subfolder and compiled as above.

The process runs smoothly and at the end it is possible to import and run correctly the project using the custom module from the editor.

The problem raises when we export the project. We are currently using export templates provided with 2.1.6 release (they work correctly with simple test projects).

The exported file runs but then raises an error in mac console

At: res://Scripts/[scriptName].gdc:283.```

By checking source gd script, that is the place where the custom component is loaded.

I think there's a problem exporting the code from custom module, **is there some option or some extra step we should do while compiling to make sure the custom code is exported with the app?**

Megalomaniak

You need to also compile custom export template that includes your custom module.

gioele

Hello thank you! That was actually one of my doubts but I was not able to find documentation about it. Could someone point the documentation about template creation?

Megalomaniak

This links for android but it's the closest thing I could quickly find: https://docs.godotengine.org/en/stable/development/compiling/compiling_for_android.html#building-the-export-templates

but theres also this page: https://docs.godotengine.org/en/stable/development/compiling/introduction_to_the_buildsystem.html#export-templates

Calinou

To compile custom macOS export templates:

Build with usual SCons flags, but add tools=no target=release_debug to get debug export templates.
Build with usual SCons flags, but add tools=no target=release to get release export templates.
Package the binaries in a fashion similar to the official export templates. Download the official 2.1.6 export templates, extract the TPZ file (it's a ZIP archive with a renamed extension) then open osx.zip. You can replace the binaries included in osx.zip and it should work out of the box as long as the export templates are installed in the correct folder.

Note that you need to have both debug and release export template binaries available for osx.zip to be considered valid. If you never plan to export in debug mode, you can copy the release binary and rename it to have the same name as the debug binary.

gioele

Thank you very much to both. I was working with an old answer found on the forum but this is very useful.

gioele

I was able to compile both and to create the package replacing osx.zip but unfortunately Godot gets stuck while importing the repackaged tpz file (while downloaded template has no problem in importing). I wonder if there may be some other problem or if I need t place the template manually inside Godot.

By the way, current Godot 3.x stores export templates in ApplicationSupport subfolder on macOS, but I can't find where Godot 2.1.6 stores them.

Anyway tomorrow I will try again compiling them.

Side note: downloadable templates are fat binaries but using macOS 10.14 it is not possible to generate them as SDK do not have anymore references to Carbon. So I packed 64 bits binaries, Could it be this the reason of the problem?

Probably I could solve by compiling on 10.11 where I could generate also fat binaries.

gioele

I tried compiling again but the import process in Godot fails and it gets stuck. By checking the code, it looks like it fails while unzipping the tpz file and opening the template, editor_node.cpp around this lines:

FileAccess *f = FileAccess::open(EditorSettings::get_singleton()->get_settings_path() + "/templates/" + file, FileAccess::WRITE);
ERR_CONTINUE(!f);

I made fat binaries, I checked permissions and that zip file was well generated with the right names when unzipped (I only replaced the necessary files) but it still fails. I thought this last part was the simplest but it looks like I am missing something in templates format (I even use .tpz extension).

I tried to place the templates in Application Support folder, but it looks like Godot 2.1.6 does not pick them from that folder (I have the ones I use with 3.2, so I made a folder for 2.1.6, and even tried to install regular templates but with no success, I cannot find where they are placed).

If I could manually place the templates where they should be, I believe it should work fine.

gioele

I solved the problem. I created a fat release and debug template and packed osx.zip as described above.

By searching in a clean Virtual Machine (where I had no other installation of Godot) I found that 2.x instead of using Library/ApplicationSupport used an hidden .godot folder in user's home folder.

So I opened Godot custom build, I imported official standar export templates and then I replaced the files inside the imported ones and it worked.

I hope this helps other people with similar problems with legacy code.