Open 3D Engine (O3DE) is an Apache 2.0-licensed 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. #o3de #gameengine #engine

amzn-mike 5cee9b43b7 Squashed commit of Procedural Prefab work (#4481) 3 jaren geleden
.github d950dc2aac Merge pull request #3691 from aws-lumberyard-dev/nbftemplate 3 jaren geleden
Assets f648cb1fd8 Update the FileIO Aliases (#4186) 3 jaren geleden
AutomatedTesting 5cee9b43b7 Squashed commit of Procedural Prefab work (#4481) 3 jaren geleden
Code 5cee9b43b7 Squashed commit of Procedural Prefab work (#4481) 3 jaren geleden
Gems 5cee9b43b7 Squashed commit of Procedural Prefab work (#4481) 3 jaren geleden
Registry f648cb1fd8 Update the FileIO Aliases (#4186) 3 jaren geleden
Templates 6c3ac70531 Added the "external_subdirectories" array object to the Project Templates (#4460) 3 jaren geleden
Tools fec77632ef Archive Component - Rewrite and additional work on Archive and Asset Bundler (#4332) 3 jaren geleden
cmake 977d58e1a8 Update ZLIB min req osx ios and android to reasonable limits (#4473) 3 jaren geleden
python 1f542838bb [Mac] Generate O3DE SDK app bundle that can be notarized and distributed (#4150) 3 jaren geleden
scripts f3e6adce7f LYN-6882 release builds are executing code in asserts (#4305) 3 jaren geleden
.clang-format 4a5b7edbfe Updates to kd-tree ray intersection - ATOM-15673 (#1026) 4 jaren geleden
.editorconfig a10351f38d Initial commit 4 jaren geleden
.gitattributes 78d6909bda Merge branch 'main' into cpack_installer 4 jaren geleden
.gitignore b7291cf740 adding ignore rule in AP for install folder and making exclusion rule in gitignore to match the one of build 3 jaren geleden
.lfsconfig 7cda947f6e Update .lfsconfig instructions 4 jaren geleden
CMakeLists.txt 1f542838bb [Mac] Generate O3DE SDK app bundle that can be notarized and distributed (#4150) 3 jaren geleden
CODE_OF_CONDUCT.md 70dc678be7 Create CODE_OF_CONDUCT.md 4 jaren geleden
CONTRIBUTING.md 4b74fcf708 Updated CONTRIBUTING.md 4 jaren geleden
Doxyfile_ScriptBinds a10351f38d Initial commit 4 jaren geleden
LICENSE.txt eb0b7346c4 o3de development - update licenses (#1665) 4 jaren geleden
LICENSE_APACHE2.TXT eb0b7346c4 o3de development - update licenses (#1665) 4 jaren geleden
LICENSE_MIT.TXT eb0b7346c4 o3de development - update licenses (#1665) 4 jaren geleden
README.md 53ea897371 Clarify CMake GUI step 4 jaren geleden
SerializeContextAnalysis.bat 38261d0800 Shorten copyright headers by splitting into 2 lines (#2213) 4 jaren geleden
SliceBuilderSettings.json a10351f38d Initial commit 4 jaren geleden
aztest_bootstrap.json a10351f38d Initial commit 4 jaren geleden
ctest_pytest.ini 8edcc504bd Add AWSI automation tests to a new test suite and pipe (#3913) 3 jaren geleden
editor.cfg d14229c67e some replacements and fixes that were referring Sandbox/Editor 4 jaren geleden
engine.json 97a053a540 Initial stub terrain gem (#3368) 4 jaren geleden
system_android_android.cfg 9b1be43367 Renamed osx_gl to mac and es3 to android for cache folders (#949) 4 jaren geleden
system_ios_ios.cfg a10351f38d Initial commit 4 jaren geleden
system_linux_pc.cfg a10351f38d Initial commit 4 jaren geleden
system_mac_mac.cfg 9b1be43367 Renamed osx_gl to mac and es3 to android for cache folders (#949) 4 jaren geleden
system_windows_pc.cfg a10351f38d Initial commit 4 jaren geleden

README.md

O3DE (Open 3D Engine)

O3DE (Open 3D Engine) 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.

Contribute

For information about contributing to Open 3D Engine, visit https://o3de.org/docs/contributing/.

Download and Install

This repository uses Git LFS for storing large binary files.

Verify you have Git LFS installed by running the following command to print the version number.

git lfs --version 

If Git LFS is not installed, download and run the installer from: https://git-lfs.github.com/.

Install Git LFS hooks

git lfs install

Clone the repository

git clone https://github.com/o3de/o3de.git

Building the Engine

Build requirements and redistributables

For the latest details and system requirements, refer to System Requirements in the documentation.

Windows

Optional

  • Wwise audio SDK
    • For the latest version requirements and setup instructions, refer to the Wwise Audio Engine Gem reference in the documentation.

Quick start engine setup

To set up a project-centric source engine, complete the following steps. For other build options, refer to Setting up O3DE from GitHub in the documentation.

  1. Create a writable folder to cache downloadable third-party packages. You can also use this to store other redistributable SDKs.

  2. Install the following redistributables:

    • 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.
  3. Configure the engine source into a solution using this command line, replacing <your build path>, <your source path>, and <3rdParty package path> with the paths you've created:

    cmake -B <your build path> -S <your source path> -G "Visual Studio 16" -DLY_3RDPARTY_PATH=<3rdParty package path>
    

    Example:

    cmake -B C:\o3de\build\windows_vs2019 -S C:\o3de -G "Visual Studio 16" -DLY_3RDPARTY_PATH=C:\o3de-packages
    

    Note: Do not use trailing slashes for the <3rdParty package path>.

  4. 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 Add Entry and add a cache entry for the <3rdParty package path> folder you created, using the following values:
      1. Name: LY_3RDPARTY_PATH
      2. Type: STRING
      3. Value: <3rdParty package path>
    5. Click Configure.
    6. Wait for the key values to populate. Update or add any additional fields that are needed for your project.
    7. Click Generate.
  5. Register the engine with this command:

    scripts\o3de.bat register --this-engine
    
  6. The configuration of the solution is complete. You are now ready to create a project and build the engine.

For more details on the steps above, refer to Setting up O3DE from GitHub in the documentation.

Setting up new projects and building the engine

  1. From the O3DE repo folder, set up a new project using the o3de create-project command.

    scripts\o3de.bat create-project --project-path <your new project path>
    
  2. Configure a solution for your project.

    cmake -B <your project build path> -S <your new project source path> -G "Visual Studio 16" -DLY_3RDPARTY_PATH=<3rdParty cache path>
    

    Example:

    cmake -B C:\my-project\build\windows_vs2019 -S C:\my-project -G "Visual Studio 16" -DLY_3RDPARTY_PATH=C:\o3de-packages
    

    Note: Do not use trailing slashes for the <3rdParty cache path>.

  3. Build the project, Asset Processor, and Editor to binaries by running this command inside your project:

    cmake --build <your project build path> --target <New Project Name>.GameLauncher Editor --config profile -- /m
    

    Note: Your project name used in the build target is the same as the directory name of your project.

This will compile after some time and binaries will be available in the project build path you've specified, under bin/profile.

For a complete tutorial on project configuration, see Creating Projects Using the Command Line Interface in the documentation.

License

For terms please see the LICENSE*.TXT files at the root of this distribution.