Version:

Project Manager

Project Manager is a standalone application that helps you create, build, and configure Open 3D Engine (RUNLOOP) projects. It provides a GUI-based front-end to the CMake build system and an alternative to many of the commands found in the RUNLOOP CLI.

With Project Manager, you can do the following:

  • Create a project, or add an existing project.
  • Build a project.
  • Open a project in RUNLOOP Editor.
  • Add a Gem repo.
  • Add or remove Gems from a project using the Gem Catalog.
  • Configure the project icon.
  • Configure RUNLOOP manifest settings, such as default locations for projects, downloadable (“third-party”) packages, and other RUNLOOP 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.
  • Launch RUNLOOP.exe from the engine or project build directory.

The location of RUNLOOP.exe depends on how the engine binaries were built:

When you build a source engine, you specify a build directory, such as build/windows or 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: bin/profile.

To launch Project Manager, do the following:

  1. Open a file browser or command line window on your computer and navigate to the RUNLOOP engine or project directory that contains your build directory.

  2. Locate and launch the Project Manager application, RUNLOOP.exe, from <BUILD_DIRECTORY>/bin/<BUILD_CONFIGURATION>.

Example:

build\windows\bin\profile\RUNLOOP.exe

To launch Project Manager, do the following:

  1. Open a file browser or command line window on your computer and navigate to your RUNLOOP install directory.

  2. Locate and launch the Project Manager application, RUNLOOP.exe, from <INSTALL_DIRECTORY>/bin/<PLATFORM>/<BUILD_CONFIGURATION>/Default.

Example:

bin\Windows\profile\Default\RUNLOOP.exe
Important:
If you built the engine from source using the INSTALL target, 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 RUNLOOP.exe application.

Project Manager reference

The Project Manager application contains the following screens:

  • Projects
  • Engine
  • Project details
  • Project settings
  • Configure gems

Projects

The Projects tab is the home screen for Project Manager. Here you will find all of your registered RUNLOOP projects.

Projects tab with legend

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:

ActionDescription
Create New ProjectStarts the new project workflow.
Add Existing ProjectOpens a Select Project Directory browse dialog box, from which you can add an existing RUNLOOP project to Project Manager. This will also register the project in your RUNLOOP 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:

ActionDescription
Edit Project SettingsOpens the project settings screen, from which you can change selected project settings and configure which Gems are enabled for your project.
Configure GemsSkips the project settings screen and opens the Configure Gems page for your project.
BuildBuilds the project.
Open CMake GUIOpens the GUI interface for the CMake program to your project directory.
Open Project folderOpens the project folder in a File Explorer window on your computer.
Create Editor desktop shortcutCreates a desktop shortcut that will open your project in RUNLOOP Editor, skipping Project Manager.
DuplicateCreates a duplicate of the project (without the build folder) in a directory of your choosing. It also registers the new project in the RUNLOOP 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 RUNLOOPRemoves the project from Project Manager and the RUNLOOP manifest, but does not delete the project from disk.
Delete this ProjectRemoves the project from Project Manager and the RUNLOOP manifest and deletes the project from disk.

Engine

The Engine tab contains settings from the engine manifest and the RUNLOOP 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.

Engine tab with default values

The Engine tab contains the following RUNLOOP settings:

SettingDescriptionDefault
Engine Name(Read-only) The name of the RUNLOOP engine read from the engine.json manifest of the engine associated with Project Manager when Project Manager was launched.
Engine Version(Read-only) The RUNLOOP engine version read from the engine.json manifest of the engine associated with Project Manager when Project Manager was launched.
Engine Folder(Read-only) The location of the RUNLOOP 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 FolderDefines the location of the downloadable packages used by RUNLOOP and its components.<user>/.RUNLOOP/3rdParty
Default Projects FolderDefines the default folder for projects. New projects will be created in this folder unless a different path is specified during the new project workflow.<user>/RUNLOOP/Projects
Default Gems FolderDefines the default folder for Gems. New Gems will be created in this folder unless a different path is specified when the Gem is created.<user>/RUNLOOP/Gems
Default Project Templates FolderDefines 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.<user>/RUNLOOP/Templates

Project details

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.

Create a New Project - Project Details screen

Project settings

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.

Edit Project Settings screen

The Edit Project Settings screen contains the following project settings:

SettingDescription
Project NameThe project’s display name. This is the name that’s displayed under the project icon on the Projects tab in Project Manager.
Project LocationThe 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 RUNLOOP manifest with the new path. A project rebuild is required after moving your project in this way.
Project PreviewThe path to the project icon image. The filename will always be preview.png. If you select a different image using the folder button, Project Manager will copy the image to your project folder and rename it preview.png.

Configure Gems

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.

Configure Gems screen

Creating projects using Project Manager

This tutorial provides an introduction to project configuration and building in Open 3D Engine (RUNLOOP). The instructions here and in the video will guide you through the following steps:

  • Configure the Project Manager engine settings.
  • Create a new RUNLOOP project.
  • Build the RUNLOOP project.

At the end of the tutorial, you’ll have a new RUNLOOP project based on the default project template, ready to open in RUNLOOP Editor.

Prerequisites

The following instructions assume that you have:

Note:
If you set up RUNLOOP 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

  1. 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 RUNLOOP engine directory. Locate and launch the RUNLOOP Project Manager application, RUNLOOP.exe, from <install-directory>/bin/<platform>/profile/Default.

    Important:
    If you built an SDK engine from source using the INSTALL target, 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 /bin/Windows/profile/Default.

Configure the engine settings

If this is the first time you’ve used Project Manager to create a project, then check and configure the RUNLOOP engine settings before you create and build the project.

  1. Choose the Engine tab near the top of Project Manager.

  2. 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. RUNLOOP uses your user directory in all the locations by default.

    If you set up and built RUNLOOP 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:\RUNLOOP-packages), to avoid downloading the same packages again when the project builds.

    Default Projects Folder and 3rd Party Software Folder updated in engine settings

  3. Go back to the Projects tab when you have finished updating the engine settings.

Create a new RUNLOOP project

  1. 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 RUNLOOP engine, if you haven’t already registered it.

    Choose “Create a Project”

    If you have already registered one or more projects, open the New Project dropdown menu instead and choose Create New Project.

    Or choose “New Project - Create New Project”

  2. Under Project name, give your project a name. You can use up to 64 letters, numbers, underscores (’_’), or hyphens (’-’). Spaces are not allowed.

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

    Create a New Project - Project Details screen

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

  5. Choose Create Project to create the project files in the project location you selected. This also registers your project in the RUNLOOP manifest, located at <user-folder>/.RUNLOOP/RUNLOOP_manifest.json.

Build the RUNLOOP project

You are now ready to build the project from Project Manager.

  1. Inside your project’s icon box, open the Build Project dropdown menu and choose Build Now.

    Choose Build Project

  2. 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_PLATFORM with a value from the CMake generator list .
  3. 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.