Skip to content

Latest commit

 

History

History
90 lines (71 loc) · 2.6 KB

macos.md

File metadata and controls

90 lines (71 loc) · 2.6 KB

Build AYON launcher on macOS

Warning

macOS is not fully supported. The build process may not work on some machines. We try to upload pre-build installer in each release.

Requirements


Important

If you're on M1 or newer mac, you also have to enable Rosetta virtualization on Terminal application. That has to be done before you start the build process or install dependencies. You might have to reinstall dependencies if you've already had installed them.

To build AYON you will need some tools and libraries. We do not provide any of these tools. You have to install them yourself.

Python 3.9.0 is not supported because of this bug.

Tip

It is recommended to use pyenv for python version control.

Prepare requirements

Easy way of installing everything necessary is to use Homebrew.

  1. Install Homebrew:

    /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
  2. Install cmake and create-dmg:

    brew install cmake create-dmg
  3. Install pyenv:

    brew install pyenv
    echo 'eval "$(pyenv init -)"' >> ~/.zshrc
    pyenv init
    exec "$SHELL"
    PATH=$(pyenv root)/shims:$PATH
  4. Pull in required Python version 3.9.x:

    # install Python build dependences
    brew install openssl readline sqlite3 xz zlib
    
    # replace with up-to-date 3.9.x version
    pyenv install 3.9.13
  5. Set local Python version:

    # switch to AYON source directory
    pyenv local 3.9.13

Build

Clone repository

git clone --recurse-submodules [email protected]:ynput/ayon-launcher.git

Prepare environment

Create virtual environment in ./.venv and install python runtime dependencies like PySide, Pillow..

./tools/make.sh create-env
./tools/make.sh install-runtime-dependencies

Build AYON Desktop

Build AYON in ./build/.

./tools/make.sh build

Build should create ./build/AYON {version}.app file.

Create installer

Create installer that can be distributed to server and workstations.

./tools/make.sh make-installer

Output installer is in ./build/installer/ directory. You should find .dmg and .json file. JSON file contains metadata required for server.