From 73fed749c348055d76cdd497a4dd8af82dfc369a Mon Sep 17 00:00:00 2001 From: changml Date: Thu, 25 Mar 2021 12:11:03 -0700 Subject: [PATCH 1/6] Added build instructions, including 3p --- README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) diff --git a/README.md b/README.md index 9f8a14afd2..c17cc18eb3 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,53 @@ Filtering content: 100% (3853/3853), 621.43 MiB | 881.00 KiB/s, done. If you have the Git credential manager core installed, you should not be prompted for your credentials anymore. +## Building the Engine +### Build Requirements and redistributables + +* Visual Studio 2019 16.9.2 (All versions supported, including Community): [https://visualstudio.microsoft.com/downloads/](https://visualstudio.microsoft.com/downloads/) + * Install the following workloads: + * Game Development with C++ + * MSVC v142 - VS 2019 C++ x64/x86 +* Visual C++ redistributable: [https://visualstudio.microsoft.com/downloads/#other-family](https://visualstudio.microsoft.com/downloads/#other-family) +* FBXSDK for VS2015: [https://www.autodesk.com/developer-network/platform-technologies/fbx-sdk-2016-1-2](https://www.autodesk.com/developer-network/platform-technologies/fbx-sdk-2016-1-2) +* WWise -2019.2.8.7432: https://www.audiokinetic.com/download/ +* CMake 3.19.1: [https://cmake.org/files/LatestRelease/cmake-3.19.1-win64-x64.msi](https://cmake.org/files/LatestRelease/cmake-3.19.1-win64-x64.msi) + +### Build Steps + +1. Download the 3rdParty zip file from here: **https://d2c171ws20a1rv.cloudfront.net/3rdParty-windows-no-symbols-rev4.zip** +2. Unzip this file into a writable folder. This will also act as a cache location for the 3rdParty downloader by default (configurable with the `LY_PACKAGE_DOWNLOAD_CACHE_LOCATION` environment variable) +3. Install the following redistributables to the following: + - Visual Studio and VC++ redistributable can be installed to any location + - FBXSDK should be installed to `<3rdParty path>\FbxSdk\2016.1.2-az.1`. See the README in this folder for details + - WWise should be installed to: `<3rdPartyPath>\Wwise\2019.2.8.7432` + - CMake should be installed to: `<3rdPartyPath>\Wwise\3.19.1` +4. Add the following environment variables through the command line + ``` + set LY_3RDPARTY_PATH= + set LY_PACKAGE_SERVER_URLS="https://d2c171ws20a1rv.cloudfront.net" + ``` + +5. Compile the source into a binary using this command line, replacing to a path you've created + ``` + cmake -B \windows_10 -S -G "Visual Studio 16 2019" -DLY_3RDPARTY_PATH="%LY_3RDPARTY_PATH% -DLY_PROJECTS=CMakeTestbed -DLY_MONOLITHIC_GAME=1 + ``` + +6. Alternatively, you can do this through the CMake GUI: + + 1. Start `cmake-gui.exe` + 2. Select the local path of the repo under "Where is the source code" + 3. Select a path where to build binaries under "Where to build the binaries" + 4. Click "Configure" + 5. Wait for the key values to populate. Fill in the fields that are relevant, including `LY_3RDPARTY_PATH`, `LY_PACKAGE_SERVER_URLS`, and `LY_PROJECTS` + 6. + +7. After some time, the compile will complete and binaries will be available in the build path you've specified + +8. Setup projects using this command + ``` + \scripts\o3de.bat create-project --project-path + ``` ## License From c1e12ce067ee1c03ab802902cfe31122cea34698 Mon Sep 17 00:00:00 2001 From: changml Date: Thu, 25 Mar 2021 12:32:19 -0700 Subject: [PATCH 2/6] Fixed typos --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c17cc18eb3..0bfc49de4e 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,7 @@ If you have the Git credential manager core installed, you should not be prompte * MSVC v142 - VS 2019 C++ x64/x86 * Visual C++ redistributable: [https://visualstudio.microsoft.com/downloads/#other-family](https://visualstudio.microsoft.com/downloads/#other-family) * FBXSDK for VS2015: [https://www.autodesk.com/developer-network/platform-technologies/fbx-sdk-2016-1-2](https://www.autodesk.com/developer-network/platform-technologies/fbx-sdk-2016-1-2) -* WWise -2019.2.8.7432: https://www.audiokinetic.com/download/ +* WWise - 2019.2.8.7432: https://www.audiokinetic.com/download/ * CMake 3.19.1: [https://cmake.org/files/LatestRelease/cmake-3.19.1-win64-x64.msi](https://cmake.org/files/LatestRelease/cmake-3.19.1-win64-x64.msi) ### Build Steps @@ -65,7 +65,7 @@ If you have the Git credential manager core installed, you should not be prompte - Visual Studio and VC++ redistributable can be installed to any location - FBXSDK should be installed to `<3rdParty path>\FbxSdk\2016.1.2-az.1`. See the README in this folder for details - WWise should be installed to: `<3rdPartyPath>\Wwise\2019.2.8.7432` - - CMake should be installed to: `<3rdPartyPath>\Wwise\3.19.1` + - CMake should be installed to: `<3rdPartyPath>\CMake\3.19.1` 4. Add the following environment variables through the command line ``` set LY_3RDPARTY_PATH= From 164c70363ded2c67d4026367fe24969d22e327dd Mon Sep 17 00:00:00 2001 From: changml Date: Thu, 25 Mar 2021 12:34:46 -0700 Subject: [PATCH 3/6] More typo fixes --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 0bfc49de4e..ca5c5ad855 100644 --- a/README.md +++ b/README.md @@ -84,7 +84,6 @@ If you have the Git credential manager core installed, you should not be prompte 3. Select a path where to build binaries under "Where to build the binaries" 4. Click "Configure" 5. Wait for the key values to populate. Fill in the fields that are relevant, including `LY_3RDPARTY_PATH`, `LY_PACKAGE_SERVER_URLS`, and `LY_PROJECTS` - 6. 7. After some time, the compile will complete and binaries will be available in the build path you've specified From 10bd5746f0850cafc5a9803e1ea01d8ec6d04782 Mon Sep 17 00:00:00 2001 From: changml Date: Thu, 25 Mar 2021 12:37:38 -0700 Subject: [PATCH 4/6] Fixing links --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ca5c5ad855..0572c824ee 100644 --- a/README.md +++ b/README.md @@ -54,12 +54,12 @@ If you have the Git credential manager core installed, you should not be prompte * MSVC v142 - VS 2019 C++ x64/x86 * Visual C++ redistributable: [https://visualstudio.microsoft.com/downloads/#other-family](https://visualstudio.microsoft.com/downloads/#other-family) * FBXSDK for VS2015: [https://www.autodesk.com/developer-network/platform-technologies/fbx-sdk-2016-1-2](https://www.autodesk.com/developer-network/platform-technologies/fbx-sdk-2016-1-2) -* WWise - 2019.2.8.7432: https://www.audiokinetic.com/download/ +* WWise - 2019.2.8.7432: [https://www.audiokinetic.com/download/](https://www.audiokinetic.com/download/) * CMake 3.19.1: [https://cmake.org/files/LatestRelease/cmake-3.19.1-win64-x64.msi](https://cmake.org/files/LatestRelease/cmake-3.19.1-win64-x64.msi) ### Build Steps -1. Download the 3rdParty zip file from here: **https://d2c171ws20a1rv.cloudfront.net/3rdParty-windows-no-symbols-rev4.zip** +1. Download the 3rdParty zip file from here: **[https://d2c171ws20a1rv.cloudfront.net/3rdParty-windows-no-symbols-rev4.zip](https://d2c171ws20a1rv.cloudfront.net/3rdParty-windows-no-symbols-rev4.zip])** 2. Unzip this file into a writable folder. This will also act as a cache location for the 3rdParty downloader by default (configurable with the `LY_PACKAGE_DOWNLOAD_CACHE_LOCATION` environment variable) 3. Install the following redistributables to the following: - Visual Studio and VC++ redistributable can be installed to any location @@ -72,7 +72,7 @@ If you have the Git credential manager core installed, you should not be prompte set LY_PACKAGE_SERVER_URLS="https://d2c171ws20a1rv.cloudfront.net" ``` -5. Compile the source into a binary using this command line, replacing to a path you've created +5. Configure and build the source into a binary using this command line, replacing to a path you've created ``` cmake -B \windows_10 -S -G "Visual Studio 16 2019" -DLY_3RDPARTY_PATH="%LY_3RDPARTY_PATH% -DLY_PROJECTS=CMakeTestbed -DLY_MONOLITHIC_GAME=1 ``` From d463a2e17898aa564c9aca8aff170d0dc638dbcb Mon Sep 17 00:00:00 2001 From: changml Date: Thu, 25 Mar 2021 16:35:40 -0700 Subject: [PATCH 5/6] Addressed feedback, updated build commands, redistributables --- README.md | 29 ++++++++++++++++++++--------- 1 file changed, 20 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 0572c824ee..c4f8c86fcf 100644 --- a/README.md +++ b/README.md @@ -59,7 +59,7 @@ If you have the Git credential manager core installed, you should not be prompte ### Build Steps -1. Download the 3rdParty zip file from here: **[https://d2c171ws20a1rv.cloudfront.net/3rdParty-windows-no-symbols-rev4.zip](https://d2c171ws20a1rv.cloudfront.net/3rdParty-windows-no-symbols-rev4.zip])** +1. Download the 3rdParty zip file from here: **[https://d2c171ws20a1rv.cloudfront.net/3rdParty-windows-no-symbols-rev7.zip](https://d2c171ws20a1rv.cloudfront.net/3rdParty-windows-no-symbols-rev7.zip)** 2. Unzip this file into a writable folder. This will also act as a cache location for the 3rdParty downloader by default (configurable with the `LY_PACKAGE_DOWNLOAD_CACHE_LOCATION` environment variable) 3. Install the following redistributables to the following: - Visual Studio and VC++ redistributable can be installed to any location @@ -72,9 +72,9 @@ If you have the Git credential manager core installed, you should not be prompte set LY_PACKAGE_SERVER_URLS="https://d2c171ws20a1rv.cloudfront.net" ``` -5. Configure and build the source into a binary using this command line, replacing to a path you've created +5. Configure the source into a solution using this command line, replacing to a path you've created ``` - cmake -B \windows_10 -S -G "Visual Studio 16 2019" -DLY_3RDPARTY_PATH="%LY_3RDPARTY_PATH% -DLY_PROJECTS=CMakeTestbed -DLY_MONOLITHIC_GAME=1 + cmake -B -S -G "Visual Studio 16 2019" -DLY_3RDPARTY_PATH="%LY_3RDPARTY_PATH% -DLY_UNITY_BUILD=ON -DLY_PROJECTS=AutomatedTesting -DLY_MONOLITHIC_GAME=1 ``` 6. Alternatively, you can do this through the CMake GUI: @@ -84,16 +84,27 @@ If you have the Git credential manager core installed, you should not be prompte 3. Select a path where to build binaries under "Where to build the binaries" 4. Click "Configure" 5. Wait for the key values to populate. Fill in the fields that are relevant, including `LY_3RDPARTY_PATH`, `LY_PACKAGE_SERVER_URLS`, and `LY_PROJECTS` + 6. Click "Generate" -7. After some time, the compile will complete and binaries will be available in the build path you've specified - -8. Setup projects using this command +7. The configuration of the solution is complete. To build the Editor and AssetProcessor to binaries, run this command inside your repo: + ``` + cmake --build --target AutomatedTesting.GameLauncher AssetProcessor Editor --config profile -- /m + ``` + +8. This will compile after some time and binaries will be available in the build path you've specified + +### Setting up new projects +1. Setup new projects using this command ``` \scripts\o3de.bat create-project --project-path ``` +2. Once you're ready to build the project, run the same set of commands to configure and build: + ``` + cmake -B -S -G "Visual Studio 16 2019" -DLY_3RDPARTY_PATH="%LY_3RDPARTY_PATH%" -DLY_PROJECTS= -DLY_MONOLITHIC_GAME=1 + + cmake --build --target --config profile -- /m + ``` ## License -For terms please see the LICENSE*.TXT file at the root of this distribution. - - +For terms please see the LICENSE*.TXT file at the root of this distribution. \ No newline at end of file From c8f1b7b07dd7b7ea13037c44d97b0c59384919c1 Mon Sep 17 00:00:00 2001 From: changml Date: Thu, 25 Mar 2021 17:32:40 -0700 Subject: [PATCH 6/6] Fixed hanging quote --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c4f8c86fcf..5244a5ea60 100644 --- a/README.md +++ b/README.md @@ -64,8 +64,8 @@ If you have the Git credential manager core installed, you should not be prompte 3. Install the following redistributables to the following: - Visual Studio and VC++ redistributable can be installed to any location - FBXSDK should be installed to `<3rdParty path>\FbxSdk\2016.1.2-az.1`. See the README in this folder for details - - WWise should be installed to: `<3rdPartyPath>\Wwise\2019.2.8.7432` - - CMake should be installed to: `<3rdPartyPath>\CMake\3.19.1` + - WWise should be installed to: `<3rdParty Path>\Wwise\2019.2.8.7432` + - CMake should be installed to: `<3rdParty Path>\CMake\3.19.1` 4. Add the following environment variables through the command line ``` set LY_3RDPARTY_PATH= @@ -74,7 +74,7 @@ If you have the Git credential manager core installed, you should not be prompte 5. Configure the source into a solution using this command line, replacing to a path you've created ``` - cmake -B -S -G "Visual Studio 16 2019" -DLY_3RDPARTY_PATH="%LY_3RDPARTY_PATH% -DLY_UNITY_BUILD=ON -DLY_PROJECTS=AutomatedTesting -DLY_MONOLITHIC_GAME=1 + cmake -B -S -G "Visual Studio 16 2019" -DLY_3RDPARTY_PATH=%LY_3RDPARTY_PATH% -DLY_UNITY_BUILD=ON -DLY_PROJECTS=AutomatedTesting -DLY_MONOLITHIC_GAME=1 ``` 6. Alternatively, you can do this through the CMake GUI: @@ -100,7 +100,7 @@ If you have the Git credential manager core installed, you should not be prompte ``` 2. Once you're ready to build the project, run the same set of commands to configure and build: ``` - cmake -B -S -G "Visual Studio 16 2019" -DLY_3RDPARTY_PATH="%LY_3RDPARTY_PATH%" -DLY_PROJECTS= -DLY_MONOLITHIC_GAME=1 + cmake -B -S -G "Visual Studio 16 2019" -DLY_3RDPARTY_PATH=%LY_3RDPARTY_PATH% -DLY_PROJECTS= -DLY_MONOLITHIC_GAME=1 cmake --build --target --config profile -- /m ```