Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Reverted from v. 29

To begin working with CRYENGINE, you must first create or import a project. This will be your game's foundation.

Creating Projects

Projects can be created through the Launcher or, in the case of more recent CRYENGINE versions, through the Sandbox Editor itself.

To create a new project for a specific version of CRYENGINE via the Launcher, this is what you need to do:

  1. Open the Projects tab in the Launcher and click the  button in the top-right corner of the dashboard. This brings up the Select Engine Version prompt, as shown:
    Image Removed
    Image Added
    Select Engine version

  2. Choose which installed version of CRYENGINE you'd like to use for your project.info

CRYENGINE 5.6 and Later

From CRYENGINE release 5.6 onwards, projects are created directly in the Sandbox Editor through the Project Browser.

Choosing to create your project through the Launcher with CRYENGINE 5.6 or later versions will bring up the following prompt:

Image Modified
Create new project

Click

- 5.6.x

  1. Click Launch Sandbox to open up the Sandbox Editor's Project Browser, which lists templates that can be used to create projects.

    Image Modified
    New Project

  2. Select a template, set its storage location and name, and click Create Project to complete the process. Your project will then open in the Sandbox Editor, and will also be listed in the Projects library of the Launcher.

CRYENGINE Versions Before 5.6

  1. Choosing to create a project in CRYENGINE versions earlier than 5.6 will open the following dashboard in the Launcher:
    Image Added
    Create new project dashboard

  2. Choose a template for your project, set its directory and name, and click Create Project. The project will be added to the Projects library of the Launcher.

    Info
    • If the Create Project and Launch in Sandbox Immediately checkbox is ticked, the project will open in the Sandbox Editor immediately after you click the Create Project button.
    • To open your project if you didn't tick the checkbox:
      1. Navigate to the Projects tab of the Launcher.
      2. Locate your project and click the Image Added icon in its listing.
      3. Select the Launch in Sandbox Editor option from the menu that opens.
        Image Added
        Launch in Sandbox Editor


Importing Projects

To import a previously created CRYENGINE project that is not listed in the Launcher:

  1. Click the Projects tab in the Launcher to open the Projects library.
  2. In the top right corner of the Projects library, click ; this opens the file explorer, allowing you to search for an existing CRYENGINE project to import.

The imported project will then be listed in the Projects library.

Warning

Importing projects that were created using Launcher versions prior to V.1.6.6 (available from the 18th of May, 2017) may cause their names to be changed; an imported project might be automatically renamed to Blank Game Template, for instance.

To fix this;

  1. Select the project you'd like to upgrade.
  2. Click the  button in its listing.
  3. Select the Edit Project Details option from the menu.
  4. Change the name of the project in the Project Title field of the Edit Project dashboard that opens.


Upgrading Projects

Projects created in CRYENGINE version 5.2 and onwards can be upgraded to work with newer Engine versions.

To do that, proceed as follows:

  1. Click the Projects tab in the Launcher to open the Projects library.
  2. Select the project you'd like to upgrade, click the  button in its listing, and select the Edit Project Details option from the menu

    Edit project details

  3. This opens the Edit Project dashboard; scroll down to the Engine Version field and select your target Engine version using the dropdown. Click Save Changes to proceed.

    Anchor
    engine_version
    engine_version
    Image Removed
    Image Added
    Engine Version

  4. You will then be prompted to confirm the Engine version switch. Click Switch Engine Version to proceed.


    Switch Engine Version confirmation

    Note

    Make sure to tick the Create Backup checkbox to avoid loss of data. When ticked, this option allows you to create an entire copy of your project and save it in a folder of your choice.


Info

When updating from an older version of the Launcher, some of your assets might need to be migrated in order to sync correctly with the updated Launcher version. When this is the case, you will receive the following prompt:

Anchor
Migrate_assets
Migrate_assets


  • Clicking Migrate All will initiate the migration of all your assets following your confirmation. You will see a confirmation once the migration is complete.
  • Clicking Customize allows you to choose which assets to migrate.

  • If you choose to Skip this step, you will see a reminder to complete the migration process in the Asset Library.


Note

Errors might arise while upgrading projects, due to the differing interfaces of different Engine versions; this can be fixed manually. In the event of an unexpected error, an output.log file will be generated in the project's storage directory, which can be reviewed to determine the cause of the error.

Please note however that,

  • Users inexperienced in handling game code may prefer to create a new project template in their target Engine version via the Launcher, and copy the Assets folder of their source project to the root directory of the new project.
  • If the source project that is being updated was built using a project template, a new game.dll file must be generated by recompiling the project's solution after performing the update.
  • To recompile the solution, locate the project's .cryproject file on disk, right-click it, and select the Generate Solution option from the context menu.

If switching to a newer Engine version still fails, users may revert back to the previous CRYENGINE version by repeating the steps described in this section, and selecting the previous CRYENGINE version from the Engine Version dropdown.


On This Page

Table of Contents
excludeOn This Page

...