Developer Setup - MacOS

Introduction

PLEASE NOTE: MacOS support has been dropped due to signing requirements which require a paid Apple developer account. It is still possible to set Semblage up as a developer, and the instructions also still exist to export a release of Semblage. However, the signing issue needs to be straightened out before the app will run. If you are a MacOS developer with a paid developer account who is willing to help out with this, please let us know in the communication channels.

Below are the steps that should produce a working Semblage environment from scratch. This guide will walk developers through that process, and will also explain the export process to get a Semblage package ready for distribution. These steps should be similar (but not exactly the same) on Windows, Mac OS and Linux. Please contribute to this guide if you develop primarily on MacOS and have suggestions on how to make this guide better.

Prerequisites

Open a terminal and run the following commands.

  • xcode-select --install
  • brew install python3 openssl zlib

Steps For Working Dev Environment

  • Download and install Godot 3.4.5 or a newer 3.4.x version for MacOS.
  • Clone the Semblage repo with git clone --recurse-submodules https://github.com/7BIndustries/Semblage.git.
  • Run Godot and open the Semblage project file.
  • Go to the AssetLib tab.
  • Search for "pythonscript".
  • Click on the PythonScript plugin available from touilleMan.
  • Click the Download button in the dialog that comes up.
  • One the download has completed, click the Install... button.
  • Leave everything at the default in the Package Installer dialog and click the Install button.
  • You should eventually get a message that the package installed successfully and you can click the OK button.
  • Search the AssetLib for gut.
  • Install the Gut - Godot Unit Testing package from bitwes.
  • Open a terminal and make sure you are in the root Semblage directory.
  • Set addons/pythonscript/osx-64/bin/python3.8 to be executable: chmod +x addons/pythonscript/osx-64/bin/python3.8
  • Run addons/pythonscript/osx-64/bin/python3.8 -m ensurepip
  • Run addons/pythonscript/x11-64/bin/python3.8 -m pip install git+https://github.com/CadQuery/cadquery.git
  • Restart Godot and reopen the Semblage project.
  • Semblage should now run and work properly, including exporting the project for distribution.

Exporting

Support for MacOS release packages has been dropped due to problems with not having the Python library signed. If someone is a MacOS user with a paid Appple developer account who wants to take on getting MacOS builds working again, please contact the development team. Below are the steps that should provide a working export package if application signing is possible with your developer account.

This process should be done on a MacOS computer, and has been tested on Mojave 10.14.6. Please note that the first time that you attempt to export the project the export dialog will prompt you to install the templates. Follow the process in the Godot documentation to install the templates.

  • From within Godot click Project -> Export...
  • In the dialog that comes up click Mac OSX (Runnable) under Presets
  • Click the Export Project button
  • Set an empty directory named Semblage to export the files to in Path:
  • Make sure that the File: field is set to Semblage.zip
  • Uncheck Export With Debug if it is checked
  • Click the Save button

The MacOS export process is partly managed by a custom export plugin, and this can take awhile to run. It may make it seem like the export dialog has stalled, but it has not. Once the Save a File dialog closes you can also close the Export dialog and inspect the directory holding the new export.

Once the export has completed, one clean-up action needs to be completed.

  • Expand the Semblage.zip file into the root Semblage export directory.
  • Delete the Semblage.zip file.

Testing an Exported Package

To test an exported package, double click Semblage in the export directory. The Semblage GUI should launch. Next, right click and add a New Component. All of the default settings are fine. Then right click again and add a box (under the 3D group). The default settings for this are fine too. If the box is rendered your release is valid, and can be packaged.

Creating the Release Archive

Add the Semblage directory to an archive named Semblage_MacOS.zip. This archive can then be uploaded to a release.