Difference between revisions of "Building PSUnreal on macOS"

From PSwiki
Jump to navigation Jump to search
(Compiling Unreal Engine)
(10 intermediate revisions by the same user not shown)
Line 23: Line 23:
 
* Step 4: Prepare the Xcode workspace.
 
* Step 4: Prepare the Xcode workspace.
 
** In the UnrealEngine directory, run the script '''Setup.command'''. It downloads 11.5GB of dependencies and may take a while.
 
** In the UnrealEngine directory, run the script '''Setup.command'''. It downloads 11.5GB of dependencies and may take a while.
** At the same location, run the script '''GenerateProjectFiles.bat'''. It generates the '''UE4.xcworkspace''' Xcode workspace.
+
** At the same location, run the script '''GenerateProjectFiles.command'''. It generates the '''UE4.xcworkspace''' Xcode workspace.
  
 
* Step 5: Compile Unreal Engine with Xcode.
 
* Step 5: Compile Unreal Engine with Xcode.
Line 32: Line 32:
 
** Compiling may take a long time, depending on your system specs.
 
** Compiling may take a long time, depending on your system specs.
 
** After the compilation finishes, select the 'Product > Run' menu item to load the editor.
 
** After the compilation finishes, select the 'Product > Run' menu item to load the editor.
 +
 +
* Step 6: set xcode tools
 +
** Open Xcode and go to Preferences>Locations and set the Command Line Tools or Unreal will give this error: "Xcode is not installed on this Mac ... Falling back to runtime text shaders, which are slower. "
 +
 +
* Launch the Editor to test if it works
 +
** You can launch the editor with \UnrealEngine\Engine\Binaries\Mac\UE4Editor.app
 +
 +
If you get this error:
 +
  xcode command codesign failed with exit code 1
 +
You need to access the project settings and set the code signing.
  
 
== Building PSUnreal ==
 
== Building PSUnreal ==
  
Crate PSUnreal dir
+
* Create PSUnreal dir
 
   > cd \
 
   > cd \
 
   > mkdir PSUnreal
 
   > mkdir PSUnreal
  
install Homebrew and svn command line
+
* Install macports and svn command line
  > /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
+
** Install macports: Download  https://distfiles.macports.org/MacPorts/MacPorts-2.6.2-10.15-Catalina.pkg
   > brew options subversion
+
   > sudo port install subversion
   > brew install subversion
+
 
 +
Get the sources from the Planeshift repository.
 +
* Open a Terminal and go to you home directory with
 +
   > '''cd ~'''. We will build from there; adapt if needed.
  
Checkout the svn repository in the directory PSUnreal
+
* Checkout the sources from the PS Unreal repository with:
 
   > svn co svn://xxx.xxx.xxx/psunreal/PSUnreal PSUnreal
 
   > svn co svn://xxx.xxx.xxx/psunreal/PSUnreal PSUnreal
  
 
+
* Build the MariaDB Connector from source.
* Step 1: Get the sources from the Planeshift repository.
+
** Install prerequisites: sudo port install cmake jemalloc judy openssl boost gnutls
** Open a Terminal and go to you home directory with '''cd ~'''. We will build from there; adapt if needed.
 
** Checkout the sources from the PS Unreal repository with: '''svn co svn://xxx.xxx.xxx/psunreal/PSUnreal PSUnreal'''
 
 
 
* Step 2: Build the MariaDB Connector from source.
 
 
** Download the MariaDB Connector for C from '''https://downloads.mariadb.com/Connectors/c/connector-c-3.1.8/mariadb-connector-c-3.1.8-src.tar.gz'''.
 
** Download the MariaDB Connector for C from '''https://downloads.mariadb.com/Connectors/c/connector-c-3.1.8/mariadb-connector-c-3.1.8-src.tar.gz'''.
 
** Expand the '''tar.gz''' in your home directory. From your terminal, '''cd ~/mariadb-connector-c-3.1.8-src''', to go to the directory that contain the MariaDB Connector sources.
 
** Expand the '''tar.gz''' in your home directory. From your terminal, '''cd ~/mariadb-connector-c-3.1.8-src''', to go to the directory that contain the MariaDB Connector sources.
** Inside that directory, create a '''build''' sub-directory with '''mkdir build'''. Switch to that directory with '''cd build'''.
+
** move the sources in PSUnreal: mv * /Users/luke/PSUnreal/ThirdParty/MariaDB
** Generate the makefiles with '''cmake -DCMAKE_INSTALL_PREFIX=~/PSUnreal/ThirdParty/MariaDB ..'''.
+
** Generate the makefiles with '''cmake . '''.
 
** Build and install the connector in your PSUnreal source tree with '''make all install'''.
 
** Build and install the connector in your PSUnreal source tree with '''make all install'''.
  
* Step 3: Build PS Unreal.
+
* Build Wordnet
 +
  > cd /Users/luke/PSUnreal/ThirdParty/Wordnet
 +
  > gcc -shared -o Wordnet.dylib -fPIC *.c
 +
 
 +
=== Build PS Unreal. ===
 +
* Generate project files:
 +
  > /Users/luke/UnrealEngine/GenerateProjectFiles.command -project="/Users/luke/PSUnreal/PSUnreal.uproject" -game -engine
 +
 
 +
* Launch XCode and open PSUnreal.xcworkspace
 +
* Build with Product > Build menu item.

Revision as of 02:23, 23 May 2020

Reference docs

Compiling Unreal Engine

Note: As of 2020-05-05, you need ~120GB of disk space for a compiled version of the Unreal Engine.

  • Step 3: Install the latest version of Xcode.
    • Install the latest version of Xcode.
  • Step 4: Prepare the Xcode workspace.
    • In the UnrealEngine directory, run the script Setup.command. It downloads 11.5GB of dependencies and may take a while.
    • At the same location, run the script GenerateProjectFiles.command. It generates the UE4.xcworkspace Xcode workspace.
  • Step 5: Compile Unreal Engine with Xcode.
    • Load the UE4.xcworkspace into Xcode.
    • Select the ShaderCompileWorker > My Mac target in the title bar, then build with Product > Build menu item.
    • Wait for the build to complete.
    • Select the UE4 > My Mac target, and build again.
    • Compiling may take a long time, depending on your system specs.
    • After the compilation finishes, select the 'Product > Run' menu item to load the editor.
  • Step 6: set xcode tools
    • Open Xcode and go to Preferences>Locations and set the Command Line Tools or Unreal will give this error: "Xcode is not installed on this Mac ... Falling back to runtime text shaders, which are slower. "
  • Launch the Editor to test if it works
    • You can launch the editor with \UnrealEngine\Engine\Binaries\Mac\UE4Editor.app

If you get this error:

 xcode command codesign failed with exit code 1 

You need to access the project settings and set the code signing.

Building PSUnreal

  • Create PSUnreal dir
 > cd \
 > mkdir PSUnreal
 > sudo port install subversion

Get the sources from the Planeshift repository.

  • Open a Terminal and go to you home directory with
 > cd ~. We will build from there; adapt if needed.
  • Checkout the sources from the PS Unreal repository with:
 > svn co svn://xxx.xxx.xxx/psunreal/PSUnreal PSUnreal
  • Build the MariaDB Connector from source.
    • Install prerequisites: sudo port install cmake jemalloc judy openssl boost gnutls
    • Download the MariaDB Connector for C from https://downloads.mariadb.com/Connectors/c/connector-c-3.1.8/mariadb-connector-c-3.1.8-src.tar.gz.
    • Expand the tar.gz in your home directory. From your terminal, cd ~/mariadb-connector-c-3.1.8-src, to go to the directory that contain the MariaDB Connector sources.
    • move the sources in PSUnreal: mv * /Users/luke/PSUnreal/ThirdParty/MariaDB
    • Generate the makefiles with cmake . .
    • Build and install the connector in your PSUnreal source tree with make all install.
  • Build Wordnet
 > cd /Users/luke/PSUnreal/ThirdParty/Wordnet
 > gcc -shared -o Wordnet.dylib -fPIC *.c

Build PS Unreal.

  • Generate project files:
 > /Users/luke/UnrealEngine/GenerateProjectFiles.command -project="/Users/luke/PSUnreal/PSUnreal.uproject" -game -engine
  • Launch XCode and open PSUnreal.xcworkspace
  • Build with Product > Build menu item.