PSwiki - User contributions [en]

Building PSUnreal on macOS

2020-07-19T09:43:20Z

Gellule:

== Reference docs ==

* Downloading Unreal Engine source code: https://docs.unrealengine.com/en-US/GettingStarted/DownloadingUnrealEngine/index.html
* Compiling Unreal Engine source code: https://github.com/EpicGames/UnrealEngine/blob/release/README.md

== Compiling Unreal Engine ==

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

* Step 1: Install the latest version of Xcode.
** Install the latest version of [https://itunes.apple.com/us/app/xcode/id497799835 Xcode] from the App Store.
** Install the Command Line Tools by running '''xcode-select --install''' from a Terminal.

* Step 2: Get access to the Unreal Engine source code.
** You must be an Unreal Engine subscriber (if not, open an account there: https://www.unrealengine.com)
** You must have a GitHub account (if not, open an account there: https://github.com)
** Have associated your GitHub account with your Unreal Engine account as described on the [https://www.unrealengine.com/en-US/ue4-on-github UE4 on GitHub page].
** At this point you should be able to access the [https://github.com/EpicGames/UnrealEngine Unreal Engine repository] on GitHub.

* Step 3: Get the Unreal Engine source code.
** Get the source code with: '''git clone -b 4.24.3-release https://github.com/EpicGames/UnrealEngine.git'''.
** This will create an '''UnrealEngine''' sub-directory where you run the commands of the next step.

* 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 UE4 blue icon for the project on the left, and click on "Project Navigator" icon (looks like a folder icon)
** Click on "Signing and Capabilities" and leave "Team" empty, "Sign to run locally"
** Click on "Build Settings", search "Signing Identity", remove everything there by clicking on "Others" and clearing the field. Or use Sign Run Locally. This way we disable the signing completely.
** 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.

== Obtaining PSUnreal ==

* Create PSUnreal dir
> cd \
> mkdir PSUnreal

* Install macports and svn command line
** Install macports: Download https://distfiles.macports.org/MacPorts/MacPorts-2.6.2-10.15-Catalina.pkg
> 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

== Building dependencies ==

=== MariaDB connector ===

* 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'''.

=== Wordnet ===

* Build Wordnet
> cd /Users/luke/PSUnreal/ThirdParty/Wordnet
> gcc -shared -o Wordnet.dylib -fPIC *.c

=== libzip ===

* Obtain https://libzip.org with:
> git clone git@github.com:nih-at/libzip.git
* In the newly created '''libzip''' directory, create a '''build''' sub-directory.
> cd libzip
> mkdir build
* In '''libzip/build''' run '''cmake''' as follows (this turns off all the options we do not need):
> cd build
> cmake -DENABLE_COMMONCRYPTO=OFF -DENABLE_GNUTLS=OFF -DENABLE_MBEDTLS=OFF -DENABLE_OPENSSL=OFF -DENABLE_WINDOWS_CRYPTO=OFF -DENABLE_BZIP2=OFF -DENABLE_LZMA=OFF ..
* Then build with:
> make --build .
* Copy the '''libzip''' library and headers to the third party subfolder of PSUnreal.
> cp lib/libzip.5.3.dylib PSUnreal/ThirdParty/Libzip/Libraries/Mac/libzip.5.dylib
> cp ../lib/zip.h PSUnreal/ThirdParty/Libzip/Includes/.
> cp zipconf.h PSUnreal/ThirdParty/Libzip/Includes/Mac/.
* Finalize the library.
> cd PSUnreal/ThirdParty/Libzip/Libraries/Mac
> install_name_tool

== 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
* Select the UE4 blue icon for the project on the left, and click on "Project Navigator" icon (looks like a folder icon)
* Click on "Signing and Capabilities" and leave "Team" empty, "Sign to run locally"
* Click on "Build Settings", search "Signing Identity", remove everything there by clicking on "Others" and clearing the field. Or use Sign Run Locally. This way we disable the signing completely.
* Build with Product > Build menu item.

== Finalize PS Unreal ==

Note: The following should be added to the build process. To be done by hand for now.

* Copy '''Wordnet.dylib''', '''libmariadb.3.dylib''', '''libmariadb.dylib''' to inside folder '''./PSUnreal.app/Content/MacOS'''.
* Modify the library paths in the main '''PSUnreal''' executable as follows:
** '''install_name_tool -change /Users/luke/PSUnreal/ThirdParty/MariaDB/libmariadb/libmariadb.3.dylib @loader_path/libmariadb.3.dylib ./PSUnreal.app/Contents/MacOS/PSUnreal'''
** '''install_name_tool -change Wordnet.dylib @loader_path/Wordnet.dylib ./PSUnreal.app/Contents/MacOS/PSUnreal'''
* Add file '''serverlist.xml''' to inside folder '''./PSUnreal.app/Contents/UE4/PSUnreal/Config'''. ('''Config''' directory needs to be created)
* Finally, you can sign the app bundle with the following '''codesign -s <email> PSUnreal.app''', where <email> is the E-mail for your Apple Development ID (check it in your Keychain Access app > My Certificates).

== Troubleshooting ==

If there is a problem like:
Unable to load module '/Users/luke/PSUnreal/Binaries/Mac/UE4Editor-PSUnreal.dylib' because the file couldn't be loaded by the OS.

You can use otool to see the dependencies
otool -L /Users/luke/PSUnreal/Binaries/Mac/UE4Editor-PSUnreal.dylib

== Running a local server ==

=== Prepare the server database ===

* Connect to your database as root, create the planeshift database and user.

> mysql -u root -p

mysql> CREATE DATABASE planeshift;
mysql> CREATE USER 'planeshift'@'localhost' IDENTIFIED WITH mysql_native_password BY 'planeshift';
mysql> GRANT ALL PRIVILEGES ON planeshift.* TO 'planeshift'@'localhost';
mysql> quit

* Connect to the database as planeshift, populate the database (adapt psunreal_mysql_XXXXXXXX.sql to the currently available file).

> cd PSUnreal\Scripts
> mysql -u planeshift -pplaneshift

mysql> USE planeshift;
mysql> SOURCE psunreal_mysql_XXXXXXXX.sql;
mysql> quit

* If you need to upgrade your database, perform the following as root, and re-populate the database as done above.

> mysql -u root -p

mysql> DROP DATABASE planeshift;
mysql> CREATE DATABASE planeshift;
mysql> GRANT ALL PRIVILEGES ON planeshift.* TO 'planeshift'@'localhost';
mysql> quit

Building PSUnreal on macOS

2020-06-22T15:22:24Z

Gellule: /* libzip */

Building PSUnreal on macOS

2020-06-22T14:38:20Z

Gellule:

== Reference docs ==

* Downloading Unreal Engine source code: https://docs.unrealengine.com/en-US/GettingStarted/DownloadingUnrealEngine/index.html
* Compiling Unreal Engine source code: https://github.com/EpicGames/UnrealEngine/blob/release/README.md

== Compiling Unreal Engine ==

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

* Step 1: Install the latest version of Xcode.
** Install the latest version of [https://itunes.apple.com/us/app/xcode/id497799835 Xcode] from the App Store.
** Install the Command Line Tools by running '''xcode-select --install''' from a Terminal.

* Step 2: Get access to the Unreal Engine source code.
** You must be an Unreal Engine subscriber (if not, open an account there: https://www.unrealengine.com)
** You must have a GitHub account (if not, open an account there: https://github.com)
** Have associated your GitHub account with your Unreal Engine account as described on the [https://www.unrealengine.com/en-US/ue4-on-github UE4 on GitHub page].
** At this point you should be able to access the [https://github.com/EpicGames/UnrealEngine Unreal Engine repository] on GitHub.

* Step 3: Get the Unreal Engine source code.
** Get the source code with: '''git clone -b 4.24.3-release https://github.com/EpicGames/UnrealEngine.git'''.
** This will create an '''UnrealEngine''' sub-directory where you run the commands of the next step.

* 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 UE4 blue icon for the project on the left, and click on "Project Navigator" icon (looks like a folder icon)
** Click on "Signing and Capabilities" and leave "Team" empty, "Sign to run locally"
** Click on "Build Settings", search "Signing Identity", remove everything there by clicking on "Others" and clearing the field. Or use Sign Run Locally. This way we disable the signing completely.
** 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.

== Obtaining PSUnreal ==

* Create PSUnreal dir
> cd \
> mkdir PSUnreal

* Install macports and svn command line
** Install macports: Download https://distfiles.macports.org/MacPorts/MacPorts-2.6.2-10.15-Catalina.pkg
> 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

== Building dependencies ==

=== MariaDB connector ===

* 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'''.

=== Wordnet ===

* Build Wordnet
> cd /Users/luke/PSUnreal/ThirdParty/Wordnet
> gcc -shared -o Wordnet.dylib -fPIC *.c

=== libzip ===

* Obtain https://libzip.org with:
> git clone git@github.com:nih-at/libzip.git
* In the newly created '''libzip''' directory, create a '''build''' sub-directory.
> cd libzip
> mkdir build
* In '''libzip/build''' run '''cmake''' as follows (this turns off all the options we do not need):
> cd build
> cmake -DENABLE_COMMONCRYPTO=OFF -DENABLE_GNUTLS=OFF -DENABLE_MBEDTLS=OFF -DENABLE_OPENSSL=OFF -DENABLE_WINDOWS_CRYPTO=OFF -DENABLE_BZIP2=OFF -DENABLE_LZMA=OFF ..
* Then build with:
> make --build .
* Copy the '''libzip''' library and headers to the third party subfolder of PSUnreal.
> cp lib/libzip.5.3.dylib PSUnreal/ThirdParty/Libzip/Libraries/Mac/.
> cp ../lib/zip.h PSUnreal/ThirdParty/Libzip/Includes/.
> cp zipconf.h PSUnreal/ThirdParty/Libzip/Includes/Mac/.

== 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
* Select the UE4 blue icon for the project on the left, and click on "Project Navigator" icon (looks like a folder icon)
* Click on "Signing and Capabilities" and leave "Team" empty, "Sign to run locally"
* Click on "Build Settings", search "Signing Identity", remove everything there by clicking on "Others" and clearing the field. Or use Sign Run Locally. This way we disable the signing completely.
* Build with Product > Build menu item.

== Finalize PS Unreal ==

Note: The following should be added to the build process. To be done by hand for now.

* Copy '''Wordnet.dylib''', '''libmariadb.3.dylib''', '''libmariadb.dylib''' to inside folder '''./PSUnreal.app/Content/MacOS'''.
* Modify the library paths in the main '''PSUnreal''' executable as follows:
** '''install_name_tool -change /Users/luke/PSUnreal/ThirdParty/MariaDB/libmariadb/libmariadb.3.dylib @loader_path/libmariadb.3.dylib ./PSUnreal.app/Contents/MacOS/PSUnreal'''
** '''install_name_tool -change Wordnet.dylib @loader_path/Wordnet.dylib ./PSUnreal.app/Contents/MacOS/PSUnreal'''
* Add file '''serverlist.xml''' to inside folder '''./PSUnreal.app/Contents/UE4/PSUnreal/Config'''. ('''Config''' directory needs to be created)
* Finally, you can sign the app bundle with the following '''codesign -s <email> PSUnreal.app''', where <email> is the E-mail for your Apple Development ID (check it in your Keychain Access app > My Certificates).

Building PSUnreal on macOS

2020-06-22T14:20:11Z

Gellule: /* libzip */

== Reference docs ==

* Downloading Unreal Engine source code: https://docs.unrealengine.com/en-US/GettingStarted/DownloadingUnrealEngine/index.html
* Compiling Unreal Engine source code: https://github.com/EpicGames/UnrealEngine/blob/release/README.md

== Compiling Unreal Engine ==

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

* Step 1: Install the latest version of Xcode.
** Install the latest version of [https://itunes.apple.com/us/app/xcode/id497799835 Xcode] from the App Store.
** Install the Command Line Tools by running '''xcode-select --install''' from a Terminal.

* Step 2: Get access to the Unreal Engine source code.
** You must be an Unreal Engine subscriber (if not, open an account there: https://www.unrealengine.com)
** You must have a GitHub account (if not, open an account there: https://github.com)
** Have associated your GitHub account with your Unreal Engine account as described on the [https://www.unrealengine.com/en-US/ue4-on-github UE4 on GitHub page].
** At this point you should be able to access the [https://github.com/EpicGames/UnrealEngine Unreal Engine repository] on GitHub.

* Step 3: Get the Unreal Engine source code.
** Get the source code with: '''git clone -b 4.24.3-release https://github.com/EpicGames/UnrealEngine.git'''.
** This will create an '''UnrealEngine''' sub-directory where you run the commands of the next step.

* 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 UE4 blue icon for the project on the left, and click on "Project Navigator" icon (looks like a folder icon)
** Click on "Signing and Capabilities" and leave "Team" empty, "Sign to run locally"
** Click on "Build Settings", search "Signing Identity", remove everything there by clicking on "Others" and clearing the field. Or use Sign Run Locally. This way we disable the signing completely.
** 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.

== Obtaining PSUnreal ==

* Create PSUnreal dir
> cd \
> mkdir PSUnreal

* Install macports and svn command line
** Install macports: Download https://distfiles.macports.org/MacPorts/MacPorts-2.6.2-10.15-Catalina.pkg
> 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

== Building dependencies ==

=== MariaDB connector ===

* 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'''.

=== Wordnet ===

* Build Wordnet
> cd /Users/luke/PSUnreal/ThirdParty/Wordnet
> gcc -shared -o Wordnet.dylib -fPIC *.c

=== libzip ===

* Obtain https://libzip.org with git clone git@github.com:nih-at/libzip.git

== 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
* Select the UE4 blue icon for the project on the left, and click on "Project Navigator" icon (looks like a folder icon)
* Click on "Signing and Capabilities" and leave "Team" empty, "Sign to run locally"
* Click on "Build Settings", search "Signing Identity", remove everything there by clicking on "Others" and clearing the field. Or use Sign Run Locally. This way we disable the signing completely.
* Build with Product > Build menu item.

== Finalize PS Unreal ==

Note: The following should be added to the build process. To be done by hand for now.

* Copy '''Wordnet.dylib''', '''libmariadb.3.dylib''', '''libmariadb.dylib''' to inside folder '''./PSUnreal.app/Content/MacOS'''.
* Modify the library paths in the main '''PSUnreal''' executable as follows:
** '''install_name_tool -change /Users/luke/PSUnreal/ThirdParty/MariaDB/libmariadb/libmariadb.3.dylib @loader_path/libmariadb.3.dylib ./PSUnreal.app/Contents/MacOS/PSUnreal'''
** '''install_name_tool -change Wordnet.dylib @loader_path/Wordnet.dylib ./PSUnreal.app/Contents/MacOS/PSUnreal'''
* Add file '''serverlist.xml''' to inside folder '''./PSUnreal.app/Contents/UE4/PSUnreal/Config'''. ('''Config''' directory needs to be created)
* Finally, you can sign the app bundle with the following '''codesign -s <email> PSUnreal.app''', where <email> is the E-mail for your Apple Development ID (check it in your Keychain Access app > My Certificates).

Building PSUnreal on macOS

2020-06-22T14:09:26Z

Gellule:

== Reference docs ==

* Downloading Unreal Engine source code: https://docs.unrealengine.com/en-US/GettingStarted/DownloadingUnrealEngine/index.html
* Compiling Unreal Engine source code: https://github.com/EpicGames/UnrealEngine/blob/release/README.md

== Compiling Unreal Engine ==

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

* Step 1: Install the latest version of Xcode.
** Install the latest version of [https://itunes.apple.com/us/app/xcode/id497799835 Xcode] from the App Store.
** Install the Command Line Tools by running '''xcode-select --install''' from a Terminal.

* Step 2: Get access to the Unreal Engine source code.
** You must be an Unreal Engine subscriber (if not, open an account there: https://www.unrealengine.com)
** You must have a GitHub account (if not, open an account there: https://github.com)
** Have associated your GitHub account with your Unreal Engine account as described on the [https://www.unrealengine.com/en-US/ue4-on-github UE4 on GitHub page].
** At this point you should be able to access the [https://github.com/EpicGames/UnrealEngine Unreal Engine repository] on GitHub.

* Step 3: Get the Unreal Engine source code.
** Get the source code with: '''git clone -b 4.24.3-release https://github.com/EpicGames/UnrealEngine.git'''.
** This will create an '''UnrealEngine''' sub-directory where you run the commands of the next step.

* 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 UE4 blue icon for the project on the left, and click on "Project Navigator" icon (looks like a folder icon)
** Click on "Signing and Capabilities" and leave "Team" empty, "Sign to run locally"
** Click on "Build Settings", search "Signing Identity", remove everything there by clicking on "Others" and clearing the field. Or use Sign Run Locally. This way we disable the signing completely.
** 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.

== Obtaining PSUnreal ==

* Create PSUnreal dir
> cd \
> mkdir PSUnreal

* Install macports and svn command line
** Install macports: Download https://distfiles.macports.org/MacPorts/MacPorts-2.6.2-10.15-Catalina.pkg
> 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

== Building dependencies ==

=== MariaDB connector ===

* 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'''.

=== Wordnet ===

* Build Wordnet
> cd /Users/luke/PSUnreal/ThirdParty/Wordnet
> gcc -shared -o Wordnet.dylib -fPIC *.c

=== libzip ===

== 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
* Select the UE4 blue icon for the project on the left, and click on "Project Navigator" icon (looks like a folder icon)
* Click on "Signing and Capabilities" and leave "Team" empty, "Sign to run locally"
* Click on "Build Settings", search "Signing Identity", remove everything there by clicking on "Others" and clearing the field. Or use Sign Run Locally. This way we disable the signing completely.
* Build with Product > Build menu item.

== Finalize PS Unreal ==

Note: The following should be added to the build process. To be done by hand for now.

* Copy '''Wordnet.dylib''', '''libmariadb.3.dylib''', '''libmariadb.dylib''' to inside folder '''./PSUnreal.app/Content/MacOS'''.
* Modify the library paths in the main '''PSUnreal''' executable as follows:
** '''install_name_tool -change /Users/luke/PSUnreal/ThirdParty/MariaDB/libmariadb/libmariadb.3.dylib @loader_path/libmariadb.3.dylib ./PSUnreal.app/Contents/MacOS/PSUnreal'''
** '''install_name_tool -change Wordnet.dylib @loader_path/Wordnet.dylib ./PSUnreal.app/Contents/MacOS/PSUnreal'''
* Add file '''serverlist.xml''' to inside folder '''./PSUnreal.app/Contents/UE4/PSUnreal/Config'''. ('''Config''' directory needs to be created)
* Finally, you can sign the app bundle with the following '''codesign -s <email> PSUnreal.app''', where <email> is the E-mail for your Apple Development ID (check it in your Keychain Access app > My Certificates).

Building PSUnreal on macOS

2020-05-24T20:49:02Z

Gellule:

== Reference docs ==

* Downloading Unreal Engine source code: https://docs.unrealengine.com/en-US/GettingStarted/DownloadingUnrealEngine/index.html
* Compiling Unreal Engine source code: https://github.com/EpicGames/UnrealEngine/blob/release/README.md

== Compiling Unreal Engine ==

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

* Step 1: Install the latest version of Xcode.
** Install the latest version of [https://itunes.apple.com/us/app/xcode/id497799835 Xcode] from the App Store.
** Install the Command Line Tools by running '''xcode-select --install''' from a Terminal.

* Step 2: Get access to the Unreal Engine source code.
** You must be an Unreal Engine subscriber (if not, open an account there: https://www.unrealengine.com)
** You must have a GitHub account (if not, open an account there: https://github.com)
** Have associated your GitHub account with your Unreal Engine account as described on the [https://www.unrealengine.com/en-US/ue4-on-github UE4 on GitHub page].
** At this point you should be able to access the [https://github.com/EpicGames/UnrealEngine Unreal Engine repository] on GitHub.

* Step 3: Get the Unreal Engine source code.
** Get the source code with: '''git clone -b 4.24.3-release https://github.com/EpicGames/UnrealEngine.git'''.
** This will create an '''UnrealEngine''' sub-directory where you run the commands of the next step.

* 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 UE4 blue icon for the project on the left, and click on "Project Navigator" icon (looks like a folder icon)
** Click on "Signing and Capabilities" and leave "Team" empty, "Sign to run locally"
** Click on "Build Settings", search "Signing Identity", remove everything there by clicking on "Others" and clearing the field. Or use Sign Run Locally. This way we disable the signing completely.
** 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

* Install macports and svn command line
** Install macports: Download https://distfiles.macports.org/MacPorts/MacPorts-2.6.2-10.15-Catalina.pkg
> 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
* Select the UE4 blue icon for the project on the left, and click on "Project Navigator" icon (looks like a folder icon)
* Click on "Signing and Capabilities" and leave "Team" empty, "Sign to run locally"
* Click on "Build Settings", search "Signing Identity", remove everything there by clicking on "Others" and clearing the field. Or use Sign Run Locally. This way we disable the signing completely.
* Build with Product > Build menu item.

== Finalize PS Unreal ==

Note: The following should be added to the build process. To be done by hand for now.

* Copy '''Wordnet.dylib''', '''libmariadb.3.dylib''', '''libmariadb.dylib''' to inside folder '''./PSUnreal.app/Content/MacOS'''.
* Modify the library paths in the main '''PSUnreal''' executable as follows:
** '''install_name_tool -change /Users/luke/PSUnreal/ThirdParty/MariaDB/libmariadb/libmariadb.3.dylib @loader_path/libmariadb.3.dylib ./PSUnreal.app/Content/MacOS/PSUnreal'''
** '''install_name_tool -change Wordnet.dylib @loader_path/Wordnet.dylib ./PSUnreal.app/Content/MacOS/PSUnreal'''
* Add file '''serverlist.xml''' to inside folder '''./PSUnreal.app/Content/UE4/PSUnreal/Config'''. ('''Config''' directory needs to be created)
* Finally, you can sign the app bundle with the following '''codesign -s <email> PSUnreal.app''', where <email> is the E-mail for your Apple Development ID (check it in your Keychain Access app > My Certificates).

Building PSUnreal on macOS

2020-05-24T18:13:03Z

Gellule:

== Reference docs ==

* Downloading Unreal Engine source code: https://docs.unrealengine.com/en-US/GettingStarted/DownloadingUnrealEngine/index.html
* Compiling Unreal Engine source code: https://github.com/EpicGames/UnrealEngine/blob/release/README.md

== Compiling Unreal Engine ==

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

* Step 1: Install the latest version of Xcode.
** Install the latest version of [https://itunes.apple.com/us/app/xcode/id497799835 Xcode] from the App Store.
** Install the Command Line Tools by running '''xcode-select --install''' from a Terminal.

* Step 2: Get access to the Unreal Engine source code.
** You must be an Unreal Engine subscriber (if not, open an account there: https://www.unrealengine.com)
** You must have a GitHub account (if not, open an account there: https://github.com)
** Have associated your GitHub account with your Unreal Engine account as described on the [https://www.unrealengine.com/en-US/ue4-on-github UE4 on GitHub page].
** At this point you should be able to access the [https://github.com/EpicGames/UnrealEngine Unreal Engine repository] on GitHub.

* Step 3: Get the Unreal Engine source code.
** Get the source code with: '''git clone -b 4.24.3-release https://github.com/EpicGames/UnrealEngine.git'''.
** This will create an '''UnrealEngine''' sub-directory where you run the commands of the next step.

* 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 UE4 blue icon for the project on the left, and click on "Project Navigator" icon (looks like a folder icon)
** Click on "Signing and Capabilities" and leave "Team" empty, "Sign to run locally"
** Click on "Build Settings", search "Signing Identity", remove everything there by clicking on "Others" and clearing the field. Or use Sign Run Locally. This way we disable the signing completely.
** 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

* Install macports and svn command line
** Install macports: Download https://distfiles.macports.org/MacPorts/MacPorts-2.6.2-10.15-Catalina.pkg
> 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
* Select the UE4 blue icon for the project on the left, and click on "Project Navigator" icon (looks like a folder icon)
* Click on "Signing and Capabilities" and leave "Team" empty, "Sign to run locally"
* Click on "Build Settings", search "Signing Identity", remove everything there by clicking on "Others" and clearing the field. Or use Sign Run Locally. This way we disable the signing completely.
* Build with Product > Build menu item.

== Finalize PS Unreal ==

Note: The following should be added to the build process. To be done by hand for now.

* Copy '''Wordnet.dylib''', '''libmariadb.3.dylib''', '''libmariadb.dylib''' to inside folder '''./PSUnreal.app/Content/MacOS'''.
* Modify the library paths in the main '''PSUnreal''' executable as follows:
** '''install_name_tool -change /Users/luke/PSUnreal/ThirdParty/MariaDB/libmariadb/libmariadb.3.dylib @loader_path/libmariadb.3.dylib ./PSUnreal.app/Content/MacOS/PSUnreal'''
** '''install_name_tool -change Wordnet.dylib @loader_path/Wordnet.dylib ./PSUnreal.app/Content/MacOS/PSUnreal'''
* Add file '''serverlist.xml''' to inside folder '''./PSUnreal.app/Content/UE4/PSUnreal/Config'''. ('''Config''' directory needs to be created)

Building PSUnreal on macOS

2020-05-24T07:48:18Z

Gellule:

Building PSUnreal on macOS

2020-05-24T07:47:25Z

Gellule:

Building PSUnreal on macOS

2020-05-24T07:46:49Z

Gellule:

Building PSUnreal on macOS

2020-05-24T07:46:06Z

Gellule:

Building PSUnreal on macOS

2020-05-24T07:45:20Z

Gellule:

Building PSUnreal on macOS

2020-05-21T17:20:43Z

Gellule:

Building PSUnreal on macOS

2020-05-16T07:14:34Z

Gellule:

Building PSUnreal on macOS

2020-05-16T07:12:40Z

Gellule:

Building PSUnreal on macOS

2020-05-07T16:07:24Z

Gellule: /* Compiling Unreal Engine */

Building PSUnreal on macOS

2020-05-06T15:55:44Z

Gellule:

Building PSUnreal on macOS

2020-05-05T21:53:33Z

Gellule:

Building PSUnreal on macOS

2020-05-05T21:48:05Z

Gellule:

Building PSUnreal on macOS

2020-05-05T21:46:21Z

Gellule:

PSUnreal Programming

2020-05-05T21:23:25Z

Gellule:

== Installation of Unreal Engine ==

The overall process begins by installing Unreal Engine and building from source, then follows through the PSUnreal setup page.

{| style="width: 85%;"
|-
| http://www.planeshift.it/graphics/bullets/windows_icon.png|| http://www.planeshift.it/graphics/bullets/linux_icon.png || http://www.planeshift.it/graphics/bullets/mac_icon.png
|-
| [[Building PSUnreal on Windows]]|| [[Building PSUnreal on Linux]]|| [[Building PSUnreal on macOS]]
|}

[[Errors Unreal Compile]]

[[Errors in Running the client]]

== Engine ==

[[Best tutorials to start]] with UE

[[Packing and shipping a project]]

[[CS Code convertion]]

[[Engine inner working]]

Check this article if you are suffering from slow Intellisense parsing: https://forums.unrealengine.com/development-discussion/c-gameplay-programming/65252-for-those-who-suffer-from-visual-studio-intellisense-slowness

== PS Unreal Engine ==

Put here the notes of our architecture for Unreal.

[[PSUECharacter setup]]

== Update Unreal Engine and Git commands ==
If you messed up your repository, try: git reset --hard

If you miss files try : git checkout .

To update to a newer UE version:

* git fetch
* git reset --hard (to discard local changes in case you have)
* git tag --list (to list all available new tags)
* git log --tags --simplify-by-decoration --pretty="format:%ai %d" (to see all tags with dates)
* git checkout 4.24.1-release --force
* launch Setup.bat to update dependencies
* launch GenerateProjectFiles.bat
* Delete all files contained in PSUnreal\Intermediate
* Clean the UE4 project from VS
* Rebuild

== Alternative Update Unreal Engine using Tortoise Git GUI ==

[https://tortoisegit.org/download/ Get TortoiseGit here].

To update to a newer UE version, In windows explorer right click on folder containing Unreal engine then:

* select > TortoiseGit > fetch. (make sure in window that opens "tags" is selected under options
* TortoiseGit > revert (to discard local changes in case you have)
* TortoiseGit > switch/checkout
** Then select tag and choose 4.24.1-release from dropdown
** Under options only have "overwrite working tree changes (force)" selected
** Press "ok" and allow it to update.
* launch Setup.bat to update dependencies
* launch GenerateProjectFiles.bat
* Delete all files contained in PSUnreal\Intermediate
* Clean the UE4 project from VS
* Rebuild

Building PSUnreal on MacOSX

2020-05-05T21:21:03Z

Gellule: Gellule moved page Building PSUnreal on MacOSX to Building PSUnreal on macOS

#REDIRECT [[Building PSUnreal on macOS]]

Building PSUnreal on macOS

2020-05-05T21:21:03Z

Gellule: Gellule moved page Building PSUnreal on MacOSX to Building PSUnreal on macOS

Building PSUnreal on macOS

2020-05-05T21:16:42Z

Gellule: Created page with "== Reference docs == * Downloading Unreal Engine source code: https://docs.unrealengine.com/en-US/GettingStarted/DownloadingUnrealEngine/index.html * Compiling Unreal Engine..."