IN THIS ARTICLE
Project Manager is a standalone application that helps you create, build, and configure Open 3D Engine (O3DE) projects. It provides a GUI-based front-end to the CMake build system and an alternative to many of the commands found in the O3DE CLI.
With Project Manager, you can do the following:
- Create a project, or add an existing project.
- Build a project.
- Open a project in O3DE Editor.
- Add a Gem repo.
- Add or remove Gems from a project using the Gem Catalog.
- Configure the project icon.
- Configure O3DE manifest settings, such as default locations for projects, downloadable (“third-party”) packages, and other O3DE objects on your computer.
Launching Project Manager
To launch Project Manager, do one of the following:
- Open the Project Manager shortcut that was placed on your desktop during installation.
o3de.exefrom the engine or project build directory.
The location of
o3de.exe depends on how the engine binaries were built:
When you build a source engine, you specify a build directory, such as
build/linux. The binaries are located in a subdirectory of the build directory. The path name of this subdirectory depends on the build configuration you chose. Example:
To launch Project Manager, do the following:
Open a file browser or command line window on your computer and navigate to the O3DE engine or project directory that contains your build directory.
Locate and launch the Project Manager application,
To launch Project Manager, do the following:
Open a file browser or command line window on your computer and navigate to your O3DE install directory.
Locate and launch the Project Manager application,
Important:If you built the engine from source using the
INSTALLtarget, make sure that you launch Project Manager from the installed engine’s build directory, not the engine’s build directory. This is important, because the engine that Project Manager uses for various operations, such as creating new projects, is determined based on the location of the
Project Manager reference
The Project Manager application contains the following screens:
- Project details
- Project settings
- Configure gems
The Projects tab is the home screen for Project Manager. Here you will find all of your registered O3DE projects.
When one or more projects are registered on your computer, the New Project… menu (1) appears in the upper right corner of the window, containing the following choices:
|Create New Project||Starts the new project workflow.|
|Add Existing Project||Opens a Select Project Directory browse dialog box, from which you can add an existing O3DE project to Project Manager. This will also register the project in your O3DE manifest.|
Each project is represented by its project icon (2) and a project display name (3). Messages and buttons relevant to the current state of the project appear inside the project icon rectangle. Underneath each project’s icon is the project context drop-down menu (4) containing actions that can be performed on that project.
Note:Hover over the project name below the project icon to show the absolute path to the project as a tooltip.
The project context menu contains the following actions:
|Edit Project Settings||Opens the project settings screen, from which you can change selected project settings and configure which Gems are enabled for your project.|
|Configure Gems||Skips the project settings screen and opens the Configure Gems page for your project.|
|Build||Builds the project.|
|Open CMake GUI||Opens the GUI interface for the CMake program to your project directory.|
|Open Project folder||Opens the project folder in a File Explorer window on your computer.|
|Create Editor desktop shortcut||Creates a desktop shortcut that will open your project in O3DE Editor, skipping Project Manager.|
|Duplicate||Creates a duplicate of the project (without the build folder) in a directory of your choosing. It also registers the new project in the O3DE manifest in your user folder. Note that the project display name of the duplicate project will be the same as the original. You can update the display name in Project Settings.|
|Remove from O3DE||Removes the project from Project Manager and the O3DE manifest, but does not delete the project from disk.|
|Delete this Project||Removes the project from Project Manager and the O3DE manifest and deletes the project from disk.|
The Engine tab contains settings from the engine manifest and the O3DE manifest. The default folder locations are editable on this screen.
Note:The default location for all of the default folders is in your user folder. If you have limited drive space in your user folder, consider changing some of these default folder locations—particularly the “3rd Party Software Folder,” which will contain several GB of downloaded packages after building your first project.
The Engine tab contains the following O3DE settings:
|Engine Name||(Read-only) The name of the O3DE engine read from the |
|Engine Version||(Read-only) The O3DE engine version read from the |
|Engine Folder||(Read-only) The location of the O3DE engine associated with Project Manager when Project Manager was launched. Clicking on the folder icon opens the engine folder in a File Explorer window on your computer.|
|3rd Party Software Folder||Defines the location of the downloadable packages used by O3DE and its components.|
|Default Projects Folder||Defines the default folder for projects. New projects will be created in this folder unless a different path is specified during the new project workflow.|
|Default Gems Folder||Defines the default folder for Gems. New Gems will be created in this folder unless a different path is specified when the Gem is created.|
|Default Project Templates Folder||Defines the default folder for project templates. New project templates will be created in this folder unless a different path is specified when the project template is created.|
The Enter Project Details screen is part of the “new project” workflow. On this screen, you can set the project’s name and location on your computer. You can also choose the project template, which defines the initial set of Gems that are enabled in your new project. You can further refine the initial set of Gems using the Configure Gems button.
The Edit Project Settings menu action in the project context menu opens the Edit Project Settings screen. On this screen, you can change the project’s display name and update the project’s icon. These settings and other information are stored in the
project.json file located at the root of your project directory. You can also change the set of Gems that are enabled for your project using the Configure Gems button.
The Edit Project Settings screen contains the following project settings:
|Project Name||The project’s display name. This is the name that’s displayed under the project icon on the Projects tab in Project Manager.|
|Project Location||The project’s location on your computer. If you select a different folder using the folder button, Project Manager will move your project to the new location and update the O3DE manifest with the new path. A project rebuild is required after moving your project in this way.|
|Project Preview||The path to the project icon image. The filename will always be |
The Configure Gems screen enables you to change the collection of Gems that are enabled in your project. You can open this screen during the new project workflow, from the Enter Project Details screen, or from the Edit Project Settings screen of an existing project. You can use the Gem Catalog in the Configure Gems screen to find and enable new Gems for your project. Refer to Adding and Removing Gems in a Project for instructions on using Configure Gems.
Creating projects using Project Manager
This tutorial provides an introduction to project configuration and building in Open 3D Engine (O3DE). The instructions here and in the video will guide you through the following steps:
- Configure the Project Manager engine settings.
- Create a new O3DE project.
- Build the O3DE project.
At the end of the tutorial, you’ll have a new O3DE project based on the default project template, ready to open in O3DE Editor.
The following instructions assume that you have:
- O3DE installed or built as an SDK engine on your computer. For help, refer to Set up Open 3D Engine.
- Met all hardware and software requirements listed in O3DE System Requirements.
Note:If you set up O3DE from GitHub and chose the source engine build type, you need to create a project from the command line and build it before you’ll have a version of Project Manager that will work with your new project. Follow the instructions in Creating Projects Using the CLI to create a project for your source engine.
Launch Project Manager
Either launch Project Manager from an icon on your desktop, or open a file browser or command line window on your computer and navigate to your O3DE engine directory. Locate and launch the O3DE Project Manager application,
<install-directory>/bin/<platform>/profile/Default.Important:If you built an SDK engine from source using the
INSTALLtarget, make sure you launch the Project Manager and other tools from the install directory, not the build directory in the engine root. For example, the Windows install directory will typically end in
Configure the engine settings
If this is the first time you’ve used Project Manager to create a project, then check and configure the O3DE engine settings before you create and build the project.
Choose the Engine tab near the top of Project Manager.
Review the default locations and update as desired, taking into consideration that the 3rd Party Software Folder and a typical project located in the Default Projects Folder each require 10 - 20 GB of free space on a computer. O3DE uses your user directory in all the locations by default.
If you set up and built O3DE from GitHub, you can set the 3rd Party Software Folder to the same packages directory you created when you built the engine (for example,
C:\o3de-packages), to avoid downloading the same packages again when the project builds.
Go back to the Projects tab when you have finished updating the engine settings.
Create a new O3DE project
In Project Manager, choose Create a Project. This will guide you through creating a new project, starting from the default project template. It will also register the O3DE engine, if you haven’t already registered it.
If you have already registered one or more projects, open the New Project dropdown menu instead and choose Create New Project.
Under Project name, give your project a name. You can use up to 64 letters, numbers, underscores (’_’), or hyphens (’-’). Spaces are not allowed.
If you want to change the project location, under Project Location, choose the folder icon, and then use the Browse dialog box to choose a new location. If needed, you can create a new project folder. The folder that you choose becomes the project root directory.
Under Select a Project Template, you can choose a project template with a pre-configured selection of Gems. You can modify the list of Gems enabled for your project by choosing the Configure Gems button. This tutorial uses the default template and its pre-configured selection of common Gems.
Choose Create Project to create the project files in the project location you selected. This also registers your project in the O3DE manifest, located at
Build the O3DE project
You are now ready to build the project from Project Manager.
Inside your project’s icon box, open the Build Project dropdown menu and choose Build Now.
After choosing Yes in the next dialog box to confirm that you are ready to build your project, the build will begin.Note:The first build may take some time to complete if the required third-party packages need to be downloaded.
When the build completes, you can find the project binaries in your project directory under
build/<platform>/bin/profile.Note:On Windows, if you have multiple versions of Visual Studio installed, Project Manager will build with the highest version detected. To specify the version of Visual Studio, use the CMake environment variable
CMAKE_GENERATOR_PLATFORMwith a value from the CMake generator list .
To open your built project in the Editor, move your pointer inside your project’s icon box and choose Open Editor.
For more information about project configuration and building, refer to the Project Configuration and Build sections of the User Guide.