Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/o3de/o3de

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.
https://github.com/o3de/o3de

3d-graphics 3d-graphics-engine animation game-development game-engine gamedev

Last synced: 2 days ago
JSON representation

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.

Awesome Lists containing this project

README 

        
# 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/](https://o3de.org/docs/contributing/).



## Roadmap

For information about upcoming work and features, please visit [https://o3de.org/roadmap](https://o3de.org/roadmap). Progress against the roadmap is tracked [here](https://github.com/orgs/o3de/projects/56/views/2).



## 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/](https://git-lfs.github.com/).



### Install Git LFS hooks 

```

git lfs install

```



### Clone the repository 



```shell

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](https://o3de.org/docs/welcome-guide/requirements/) in the documentation.



#### Windows



*   Visual Studio 2019 16.9.2 minimum (All editions supported, including Community): [https://visualstudio.microsoft.com/downloads/](https://visualstudio.microsoft.com/downloads/)

    *   Check [System Requirements](https://o3de.org/docs/welcome-guide/requirements/) for other supported versions.

    *   Install the following workloads:

        *   Game Development with C++

        *   MSVC v142 - VS 2019 C++ x64/x86

        *   C++ 2019 redistributable update

*   CMake 3.22.0 minimum: [https://cmake.org/download/#latest](https://cmake.org/download/#latest) (Release Candidate versions are not supported)



#### Optional



*   Wwise audio SDK

    *   For the latest version requirements and setup instructions, refer to the [Wwise Audio Engine Gem](https://o3de.org/docs/user-guide/gems/reference/audio/wwise/audio-engine-wwise/) 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](https://o3de.org/docs/welcome-guide/setup/setup-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.

    

1.  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.



1.  Configure the engine source into a solution using this command line, replacing ``, ``, and `<3rdParty package path>` with the paths you've created:

    ```

    cmake -B  -S  -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>.



1.  Alternatively, you can do this through the CMake GUI:

    

    1.  Start `cmake-gui.exe`.

    1.  Select the local path of the repo under "Where is the source code".

    1.  Select a path where to build binaries under "Where to build the binaries".

    1.  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

        1.  **Type:** STRING

        1.  **Value:** `<3rdParty package path>`

    1.  Click **Configure**.

    1.  Wait for the key values to populate. Update or add any additional fields that are needed for your project.

    1.  Click **Generate**.

    

1.  Register the engine with this command:

    ```

    scripts\o3de.bat register --this-engine

    ```



1.  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](https://o3de.org/docs/welcome-guide/setup/setup-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 

    ```



1. Configure a solution for your project.

    ```

    cmake -B  -S  -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>.



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

    ```

    cmake --build  --target .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](https://o3de.org/docs/welcome-guide/create/creating-projects-using-cli/) in the documentation.



## Code Contributors



This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].






## License



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