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.
7,747 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 '80dcc34e6f'
${ noResults }
Go to file
amzn-phist 80dcc34e6f
Add "Registry" folders as scan folders (#4583) 
* Add "Registry" folders as scan folders

For projects, Gems, and Engine, add the "Registry" folder as scan
folders.

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

* Change params for adding scan folder

Also add trailing newlines to setreg files.

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

* Adjust the priority order for project templates

Scan folder orders were way too high, they should be very low to become
highest priority order.

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

* Removes change of default assets folder to Assets

Need to revert this change so it can be done separately.
Renamed the scan folder to 'Project/Assets' to prep for Assets folder
change later on.

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

* Update platform configuration test to pass

Adjusted expectation of scan folder count from 1 to 2 per Gem for
'Assets' and 'Registry' now.

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 Re-add pytest.mark.test_case_id markers (#4621) 4 years ago
Code Add "Registry" folders as scan folders (#4583) 4 years ago
Gems Merge pull request #4673 from aws-lumberyard-dev/Atom/guthadam/update_material_editor_icons 4 years ago
Registry Add "Registry" folders as scan folders (#4583) 4 years ago
Templates Add "Registry" folders as scan folders (#4583) 4 years ago
Tools Merge pull request #4589 from aws-lumberyard-dev/lytt_integ_linux 4 years ago
cmake Update tiff to the new package revision (fixes IOS TIFF package) (#4638) 4 years ago
python [Mac] Generate O3DE SDK app bundle that can be notarized and distributed (#4150) 4 years ago
scripts Merge pull request #4486 from aws-lumberyard-dev/Prism/ShowRepoList 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 ATOM-16658 Remove PBSreferenceMaterials gem which is a gem for legacy cry3dengine (#4616) 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.