O3DE-Extras

Extras add-on repo for O3DE.

Contribute

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

Download and Install

Clone the repository

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

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. Register gems with this command:

   scripts\o3de.bat register -gp <your path to o3de-extras>/Gems/<gem name>
   

   To recursively register all gems in the path, use the -agp or --all-gems-path parameter

3. Add these gems to your project with this command:

   scripts\o3de.bat enable-gem -gn <gem name> -pn <your project name>
   

   To enable all gems in a path, use the -agp or --all-gems-paths parameter

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

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