Launching the Editor
The ezEditor can be launched simply by running ezEditor.exe. By default, it will restore the project that was open during the last session (see Editor Preferences).
Command Line Options
The editor supports the following command line arguments:
| Option | Description |
|---|---|
-project <path> |
Opens the editor with the specified project. The path should point to the project's ezProject file, or to the folder containing it. |
-documents <path> ... |
Documents to open after the project. The paths are relative to a data directory. Only used together with -project. |
-noRecent |
Opens the editor without loading a recent project. Use this to start with a blank editor. |
-safe |
Starts the editor in safe mode, which disables automatic loading of projects and scenes. This is useful for troubleshooting startup issues. |
-unattended |
Tells the editor that no user is present, see below. |
-NoSplash |
Disables the splash screen. |
-createProject <path> |
Creates a new project and opens it, see below. |
-projectTemplate <name> |
Which project template -createProject should use. |
-pluginTemplate <name> |
Which plugin template -createProject should use. |
-listTemplates |
Logs the names that -projectTemplate and -pluginTemplate accept, then continues. |
Running ezEditor.exe -help prints the full list.
Examples
ezEditor.exe -project "C:/dev/MyGame/ezProject"
ezEditor.exe -noRecent
ezEditor.exe -safe
Creating a Project
A project can also be created from the command line, which is useful in scripts and for automated tests:
ezEditor.exe -createProject "C:/dev/MyGame" -projectTemplate "Basic FPS"
The path has to be absolute, and the directory must either not exist yet, or be empty. The new project is opened right afterwards.
Without -projectTemplate, a blank project is created. In that case -pluginTemplate determines which plugins it starts with (General3D if not specified). A project template brings its own plugin selection, so the two options are not combined.
-listTemplates logs which names are available:
ezEditor.exe -listTemplates
The same options are understood by ezEditorProcessor.exe, which creates the project without opening a UI and then exits. See ezEditorProcessor.
Unattended Mode
-unattended is meant for editors that are driven by a script or another tool. Modal dialogs are suppressed and the questions they would ask are answered with the option that lets the operation continue, rather than the safest one - a half-started editor is of no use to an automated caller. Notably, the offer to start in safe mode after a crash is declined, since accepting it would prevent the project from being loaded.
Without this option, a dialog that nobody closes blocks the editor indefinitely.
Windows Taskbar Integration
On Windows, the editor integrates with the taskbar jumplist. Right-click the editor icon in the taskbar to access:
- Recent Projects - Quickly open one of your recently used projects.
- New Window - Launch a new editor instance without loading a project.
- Start in Safe Mode - Launch the editor in safe mode.