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

lumberyard-employee-dm 19619553dd CMake referenced Gems external_subdirectories fixes (#12051) пре 2 година
.github 8839dec1ab Add newline пре 2 година
Assets a99002f00d Remove deprecated selection component from default level template (#11729) пре 2 година
AutomatedTesting db839ee92c Cherry-picks https://github.com/o3de/o3de/pull/11992 (#12043) пре 2 година
Code 757b544be0 Merge pull request #11248 from RoaldFre/Filewatcher-Linux-keep-going пре 2 година
Gems b1dfd4375a [GHI-11704] Assert is being printed in console after adding element to Skeleton LOD modifier in FBX Settings (#11745) пре 2 година
Registry fcdb2c36fd Fix for GHI-7588: Don't merge meshes with varying vertex layouts (#11082) пре 2 година
Templates 5769b615b7 Changed AzTest to fail when no tests were found. (#11231) пре 2 година
Tools dde34ebc71 Added typed exceptions to LyTT. (#11694) пре 2 година
cmake 19619553dd CMake referenced Gems external_subdirectories fixes (#12051) пре 2 година
python 607c548791 Python 3.10 Update (#11216) пре 3 година
scripts ad53e8e509 Merge branch 'stabilization/2210' into moraaar/gitflow_220915_o3de пре 2 година
.clang-format df2f6564e5 Adapt BinPackArguments: false in .clang-format. пре 3 година
.editorconfig a10351f38d Initial commit пре 4 година
.gitattributes badbcd3eab Initial Stars Feature (#8624) пре 3 година
.gitignore c577d3fd65 fix gitignore (#8246) пре 3 година
.lfsconfig 7cda947f6e Update .lfsconfig instructions пре 4 година
CMakeLists.txt 19619553dd CMake referenced Gems external_subdirectories fixes (#12051) пре 2 година
CMakePresets.json 442bc3dd61 Adding CMakePresets support for O3DE. (#9037) пре 3 година
CODE_OF_CONDUCT.md 70dc678be7 Create CODE_OF_CONDUCT.md пре 4 година
CONTRIBUTING.md 4b74fcf708 Updated CONTRIBUTING.md пре 4 година
Doxyfile_ScriptBinds a10351f38d Initial commit пре 4 година
LICENSE.txt 5d941ddee6 Update license references (#11031) пре 3 година
LICENSE_APACHE2.TXT eb0b7346c4 o3de development - update licenses (#1665) пре 4 година
LICENSE_MIT.TXT eb0b7346c4 o3de development - update licenses (#1665) пре 4 година
README.md 7c30adb66c Removes _vs2019 from jenkins jobs and documentation (#5855) пре 3 година
RETIRED_CODE.md c3899c6d5c Updated retired code listing with GridMate and GridHub пре 3 година
SECURITY.MD 0b5cea7397 Provide initial SECURITY.md for O3DE (#8039) пре 3 година
SerializeContextAnalysis.bat 38261d0800 Shorten copyright headers by splitting into 2 lines (#2213) пре 4 година
SliceBuilderSettings.json a10351f38d Initial commit пре 4 година
editor.cfg 80db67e90a Remove many unused variables and unused setting files (#4607) пре 3 година
engine.json 172d9c0d09 Merge branch 'development' into Atom/dmcdiar/ATOM-17749 пре 3 година
pytest.ini 70d7f9dd27 Merge pull request #11237 from aws-lumberyard-dev/pytest_timeouts пре 3 година
system_android_android.cfg 80db67e90a Remove many unused variables and unused setting files (#4607) пре 3 година
system_ios_ios.cfg 80db67e90a Remove many unused variables and unused setting files (#4607) пре 3 година
system_linux_pc.cfg 80db67e90a Remove many unused variables and unused setting files (#4607) пре 3 година
system_mac_mac.cfg 80db67e90a Remove many unused variables and unused setting files (#4607) пре 3 година
system_windows_pc.cfg c35f74e9ce Physics/test axis aligned box shape configuration works #7378a (#5366) пре 3 година

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 -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"
    

    Example:

    cmake -B C:\my-project\build\windows -S C:\my-project -G "Visual Studio 16"
    

    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.