Open 3D Engine (O3DE) is an open-source, real-time, multi-platform 3D engine that enables developers and content creators to build AAA games, cinema-quality 3D worlds, and high-fidelity simulations without any fees or commercial obligations.
- Removed instructions for the 3rdParty zip file and downloader URL. This is no longer a requirement.
- Updated instructions for dependencies
- Links to full documentation
April 7-13, 2021
## Contribute
- Updates to the 3rdParty zip file
For information about contributing to Open 3D Engine, visit https://o3de.org/docs/contributing/
March 25, 2021
- Initial commit for instructions
## Download and Install
## Download and Install
This repository uses Git LFS for storing large binary files. You will need to create a Github personal access token to authenticate with the LFS service.
This repository uses Git LFS for storing large binary files.
To install Git LFS, download the binary here: https://git-lfs.github.com/.
After installation, you will need to install the necessary git hooks with this command
Verify you have Git LFS installed by running the following command to print the version number.
```
```
git lfs install
git lfs --version
```
```
### Create a Git Personal Access Token
If Git LFS is not installed, download and run the installer from: https://git-lfs.github.com/.
You will need your personal access token credentials to authenticate when you clone the repository and when downloading objects from Git LFS
[Create a personal access token with the 'repo' scope.](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token)
During the clone operation, you will be prompted to enter a password. Your token will be used as the password. You will also be prompted a second time for Git LFS.
### (Recommended) Verify you have a credential manager installed to store your credentials
Recent versions of Git install a credential manager to store your credentials so you don't have to put in the credentials for every request.
### Install Git LFS hooks
It is highly recommended you check that you have a [credential manager installed and configured](https://github.com/microsoft/Git-Credential-Manager-Core)
For Linux and Mac, use the following commands to store credentials
Linux:
```
git config --global credential.helper cache
```
```
Mac:
git lfs install
```
git config --global credential.helper osxkeychain
```
```
### Clone the repository
### Clone the repository
```shell
```shell
> git clone https://github.com/o3de/o3de.git
git clone https://github.com/o3de/o3de.git
Cloning into 'o3de'...
# initial prompt for credentials to download the repository code
# enter your Github username and personal access token
* Note: This requires registration and installation of a client to download
* Note: This requires registration and installation of a client application to download
* You will also need to set a environment variable: `set LY_WWISE_INSTALL_PATH=<path to WWise version>`
* Make sure to select the SDK(C++) component during installation of Wwise
* For example: `set LY_WWISE_INSTALL_PATH="C:\Program Files (x86)\Audiokinetic\Wwise 2019.2.8.7432"`
* You will also need to set an environment variable: `set LY_WWISE_INSTALL_PATH=<path to Wwise version>`
* For example: `set LY_WWISE_INSTALL_PATH="C:\Program Files (x86)\Audiokinetic\Wwise 2021.1.1.7601"`
### Quick Start Build Steps
### Quick Start Build Steps
1. Create a writable folder to cache 3rd Party dependencies. You can also use this to store other redistributable SDKs.
1. Create a writable folder to cache 3rd Party dependencies. You can also use this to store other redistributable SDKs.
> For the 0.5 branch - Create an empty text file named `3rdParty.txt` in this folder, to allow a legacy CMake validator to pass
1. Install the following redistributables to the following:
1. Install the following redistributables to the following:
- Visual Studio and VC++ redistributable can be installed to any location
- Visual Studio and VC++ redistributable can be installed to any location
- CMake can be installed to any location, as long as it's available in the system path
- CMake can be installed to any location, as long as it's available in the system path
- WWise can be installed anywhere, but you will need to set an environment variable for CMake to detect it: `set LY_WWISE_INSTALL_PATH=<path to WWise>`
- (Optional) Wwise can be installed anywhere, but you will need to set an environment variable for CMake to detect it: `set LY_WWISE_INSTALL_PATH=<path to Wwise>`
1. Navigate into the repo folder, then download the python runtime with this command
> For the 0.5 branch - Set this environment variable prior to the `get_python` command below:
> ```
> set LY_PACKAGE_SERVER_URLS=https://d2c171ws20a1rv.cloudfront.net
> ```
```
python\get_python.bat
```
1. Configure the source into a solution using this command line, replacing <yourbuildpath> and <3rdPartycachepath> to a path you've created:
1. Configure the source into a solution using this command line, replacing <yourbuildpath> and <3rdPartycachepath> to a path you've created:
```
```
@ -139,7 +83,7 @@ If you have the Git credential manager core or other credential helpers installe
```
```
scripts\o3de.bat register --this-engine
scripts\o3de.bat register --this-engine
```
```
1. Setup new projects using the `o3de create-project` command. In the 0.5 branch, the project directory must be a subdirectory in the repo folder.
1. Setup new projects using the `o3de create-project` command.
Alex Peterson
5 years ago
committed by
GitHub