birkeh
/
o3de
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
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.
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
8,047 Commits
3 Branches
3 Tags
148 MiB
C++ 82.6%
Python 13.1%
CMake 1.5%
Roff 1.2%
Lua 0.5%
Other 0.8%
 
 
 
 
 
 
development
monroegm-disable-blank-issue-2
main
2111.2
2111.1
2107.1
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '714f5357b2'
${ noResults }
Go to file
amzn-phist 714f5357b2
Add an error message to AP when the project path is invalid (#4801) 
* Add an error message to AP when bad project path

Produce a log error or a dialog box error when the project path for AP
does not have a project.json and is invalid.

Signed-off-by: amzn-phist <52085794+amzn-phist@users.noreply.github.com>

* Fix a failing unit test - AssetProcessorMessages

Adding a check for 'project.json' caused BeforeRun() in a test fixture
to fail.  Teardown of the fixture was also broken if the test failed to
fully startup the application manager, so added null checks there.

Added an assert to the fixture's Setup to check the status of BeforeRun().
Added additional settings registry setup to the fixture to make sure the
project path and branch token are configured before BeforeRun() is
called.

Signed-off-by: amzn-phist <52085794+amzn-phist@users.noreply.github.com>
 		4 years ago
.github/ISSUE_TEMPLATE Bug report template improvement suggestions (#4478) 4 years ago
Assets Remove many unused variables and unused setting files (#4607) 4 years ago
AutomatedTesting Updating FBX_Tests and test asset files (#4477) 4 years ago
Code Add an error message to AP when the project path is invalid (#4801) 4 years ago
Gems Improve the stability of metrics gem tests by removing local file operations (#4761) 4 years ago
Registry Update linux AP connection settings to connect to remote AP and wait for the connection (#4685) 4 years ago
Templates Improve the errors in EngineFinder.cmake (#4713) 4 years ago
Tools Mock additional popen calls 4 years ago
cmake Enable cmake-install in project-centric / engine-prebuilt (#4767) 4 years ago
python [Mac] Generate O3DE SDK app bundle that can be notarized and distributed (#4150) 4 years ago
scripts Merge pull request #4773 from aws-lumberyard-dev/ReturnCachedGemJsons 4 years ago
.clang-format Updates to kd-tree ray intersection - ATOM-15673 (#1026) 5 years ago
.editorconfig Initial commit 5 years ago
.gitattributes Merge branch 'main' into cpack_installer 5 years ago
.gitignore adding ignore rule in AP for install folder and making exclusion rule in gitignore to match the one of build 4 years ago
.lfsconfig Update .lfsconfig instructions 5 years ago
CMakeLists.txt [Mac] Generate O3DE SDK app bundle that can be notarized and distributed (#4150) 4 years ago
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 5 years ago
CONTRIBUTING.md Updated CONTRIBUTING.md 4 years ago
Doxyfile_ScriptBinds Initial commit 5 years ago
LICENSE.txt o3de development - update licenses (#1665) 5 years ago
LICENSE_APACHE2.TXT o3de development - update licenses (#1665) 5 years ago
LICENSE_MIT.TXT o3de development - update licenses (#1665) 5 years ago
README.md Clarify CMake GUI step 4 years ago
SerializeContextAnalysis.bat Shorten copyright headers by splitting into 2 lines (#2213) 4 years ago
SliceBuilderSettings.json Initial commit 5 years ago
aztest_bootstrap.json Initial commit 5 years ago
ctest_pytest.ini Add AWSI automation tests to a new test suite and pipe (#3913) 4 years ago
editor.cfg Remove many unused variables and unused setting files (#4607) 4 years ago
engine.json Merge branch 'development' into atom_cpu_profiler_gem_promotion 4 years ago
system_android_android.cfg Remove many unused variables and unused setting files (#4607) 4 years ago
system_ios_ios.cfg Remove many unused variables and unused setting files (#4607) 4 years ago
system_linux_pc.cfg Remove many unused variables and unused setting files (#4607) 4 years ago
system_mac_mac.cfg Remove many unused variables and unused setting files (#4607) 4 years ago
system_windows_pc.cfg Remove many unused variables and unused setting files (#4607) 4 years ago

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.