Working with Projects

A project is an independent entity that contains all the data on your application content organized in a set of directories. The .project file containing metadata is associated with the project.

Notice

One project can consist of several worlds. So, there is no need to create a separate project for each world.

Before starting to create new projects you should have an SDK installed. Once you have the required version of the SDK, you can create a new project as follows:

Open the Projects tab in the SDK browser.
Click Create New. The new project creation window will be opened.
Define the name of the project, choose a path to store project files and specify the SDK to be used.
Specify the required application and general settings.
Specify the add-ons to be added (optional).
Click Create New Project. The project will appear in the projects list.

Notice

You can change the project settings any time by clicking Other Actions -> Configure Project.

Application Settings

The project can be created with the following application settings:

API	Projects creation language. The following APIs are available: UnigineScript only - UnigineScript will be used to implement the project. C++ - C++ API will be used to implement the project. Depending on the OS, the following tools can be chosen to compile a project: On Windows - Visual Studio 2010 or Visual Studio 2013. On Linux - GNU Make. On Mac OS X - Xcode or GNU Make. C# - C# API will be used to implement the project. The Visual Studio will be used to compile a project.
Architecture	The version of the release version of an application: 32 bit - create the 32-bit release version of the application (_x86 postfix of the binary executable). 64 bit - create the 64-bit release version of the application (_x64 postfix of the binary executable). 32 and 64 bits - create the both 32-bit and 64-bit release versions of the application. Notice The libraries and binaries of the corresponding version will be copied to the bin directory of the project folder.
Precision	The coordinates precision to be used: Float - single precision. Double - double precision.

General Settings

The project can be created with the following general settings:

GUI-based settings configurator	Create a project with the launcher.

Click Video output options to specify the following:

NVIDIA 3DSurround 3-monitor stereo 3D (App3DSurround plugin)	Render the application across 3 monitors using the NVIDIA 3D Vision technology and multiple GPUs. Notice The App3DSurround plugin is available on DirectX 11 only.
NVIDIA 3DVision stereo 3D (App3DVision plugin)	Render the application onto 1 monitor using NVIDIA 3D Vision technology. Notice The App3DVision plugin is available on DirectX 11 only.
Oculus support (AppOculus plugin)	Create project with the Oculus Rift virtual display support. Notice On Linux, there is no head tracking support. On OS X, head tracking is available only for the 64-bit application version.
Dual output stereo 3D (AppSeparate plugin)	Output 2 separate images for each eye. Notice The AppSeparate supports DirectX 11 only.

Panoramic rendering with a single output device (AppPanorama plugin)	Render 180 degree panorama on one monitor. Several monitors are also supported.
Multi-projector output with edge blending and non-linear image mapping	Create a project with the AppProjection plugin. All necessary files are copied and the launcher with the corresponding settings is generated.
3-monitor output (AppSurround plugin)	Render the application across 3 monitors simultaneously.
Monitor wall (AppWall plugin)	Render the application into the configurable number of monitors. Notice The AppWall plugin is not available on OS X.

GPU Monitor	GPU frequencies and temperature monitoring.
Renderer	Enable the ability to fire world script callbacks on API Renderer callbacks. Notice You cannot use any rendering mode in conjunction with the Renderer plugin.
AppGrabber	Current viewport grabbing (AppGrabber plugin).

Add-Ons

The project can be created including any add-on available in the Add-Ons tab. All of the required add-ons can be added both on and after project's creation.

Specifying Add-Ons on Project's Creation

To create the project with an add-on, you should do the following:

Download the required add-on in the Add-Ons tab by clicking Install.

Notice
Any amount of add-ons could be added to a project afterwards.
On project creation, specify the add-ons to be included by clicking the Add-ons (0) button.
Drop the required add-ons from the Available field to In Use. You can add any amount of add-ons to the project. After all add-ons are dropped, click Ok.

Notice
If you haven't downloaded the add-on, click Manage installed add-ons. You will be redirected to the page with available add-ons.
Click Create New Project. To enable added add-ons in the project, you should follow instructions on each add-on.

Specifying Add-Ons for Existing Project

To extend an existing project with add-ons, do the following:

Download the required add-on in the Add-Ons tab by clicking Install.

Notice
Any amount of add-ons could be added to a project afterwards.
Click Other Actions -> Configure Project.
Click the Add-ons (0) button and drag and drop the required add-ons from the Available field to In Use.

Notice
If you haven't downloaded the add-on, click Manage installed add-ons. You will be redirected to the page with available add-ons.
Click Ok and then click Update Configuration.

To add an existing project to the browser, do the following:

Click Add Existing in the Projects tab.

In the file dialog window that opens, specify the path to the project folder and click Import Project. The project will appear in the projects list.

If the project is created on UNIGINE 1, you will have to specify the following information on the project:

Project name	The name of the project.
SDK	The version of Unigine SDK used to create the project.
Edition	The edition of Unigine SDK used to create the project.
Type	The type of Unigine SDK used to create the project.
Architecture	The version of the release version of an application (32 or/and 64 bit).
Precision	he coordinates precision used to create the project.

This information is required to create the .project file containing metadata associated with the project.

Notice

If the added project was created in the SDK of a previous version, it will be marked with the Upgrade available label.

Projects that require upgrade are marked with the Upgrade available label:

To upgrade your project to the newest installed version of Unigine SDK, do the following:

Click this label or Other Actions -> Configure Project. The following form will open:
Choose the newest installed version of the SDK and click Update Configuration.
Specify a path to the backup folder into which the original project will be copied. Leave Migrate Content checked and click Upgrade Project

The project will be upgraded automatically.

Notice

The source code should be upgraded manually by using UnigineScript or C++ API Migration Guide.

There are several options of running project with default settings:

Run the project without the loaded editor by clicking Run:
Run the project with the loaded editor by clicking Edit Content.

Notice

You can also use launchers created by default in the project folder:

launch_debug - the launcher of the project's debug version.
launch_editor - the launcher of the project's with the loaded editor.
launch_release - the launcher of the project's release version.
launcher - the startup file for the launcher that provides a GUI to configure application options and run the application. This launcher can be customized and used in the release version of your project. To create a project with the launcher, check the GUI-based settings configurator box in the project's creation window.

There are also several options of running project with custom settings:

Run the project without the loaded editor by clicking an ellipsis under the Run button:

In the Customize Run Options form that opens, set the required values and click Run.
Run the project with the loaded editor by clicking an ellipsis under the Edit Content button:

In the Customize UnigineEditor Options form that opens, set the required values and click Edit.

Customize Run Options

Via this form the project without the loaded editor can be run with the custom settings.

Depending on the value of the Application option, different sets of options are available:

Default (main.exe) - the default main application (main.exe) will be run:

The default main application should be used when only UnigineScript is used to implement the project. In this case, the following options can be customized:

Debug	Indicates whether debug or release version of the application should be run.
Architecture	The version of the main application to run. Available values: 32-bit - the 32-bit version of the main application. 64-bit - the 64-bit version of the main application.
Remember	Indicates whether to remember the specified custom settings for future run or not.

Custom command - a custom main application will be run:

This option should be chosen if the C++ or C# API is used to implement the project (besides UnigineScript). In this case, the following options can be customized:

Binary	Name of the custom main application. Here the name of the compiled binary executable located in the bin folder of the project should be specified. If the binary executable is located outside this folder, a path to it relative to the bin folder should be specified.
Arguments	Start-up command-line options.
Remember	Indicates whether to remember the specified custom settings for future run or not.

Customize UnigineEditor Options

Additional arguments	Start-up command-line options.
Debug	The editor version (debug or release) that will be used for project's editing.
Remember	Indicates whether to remember the specified custom settings for future run or not.

To open the project for editing:

On Windows and Mac OS X, click Edit Code:
The project will be opened for editing in an associated tool. To change a tool, click an ellipsis under Edit Code. By default, the following form will open:
Here a path to a custom tool (e.g. IDE or editor) with required arguments can be specified.
On Linux, click Open folder and then edit the code in an associated tool:

See the articles in the Programming Overview section to learn how to edit the opened project.

To create the release build of the project:

Click Other Actions:
Click Assemble project. The following form will open:
Specify the required settings (see below) and click Assemble.

Assembling Settings

Output folder	The release build destination folder. Warning You shouldn't create this folder inside your project folder, as it may significantly increase its size.
Exclude files	Files and folders that should be excluded from the release build. Use the wildcards patterns to exclude the required items.
Architecture	The release build architecture type.
Custom config path	The path to the custom configuration file for the release build (optional).
Compress to UNG	Types of files (for example, .h, .cpp, .ui, .mat, .world, .node, etc.) that should be compressed to reduce hard drive memory usage. This won't influence the engine performance much. Use the wildcards patterns to include/exclude the required items.
Strip binaries	Notice This option is available on Linux and Mac only. Delete all debug information from the build binaries. This will reduce the binaries size without any performance cost.

When clicking the Other Actions button, the following form opens:

Configure Project	Change project settings: the version of the release application, the coordinates precision and the general settings. Also this option should be used when you need to upgrade the existing project to the newest version of the SDK.
Assemble Project	Specify settings to be used for assembling the project.
Open Folder	Open the project folder.
Delete	Delete the project.

In This Article:

Creating New Project

Application Settings

General Settings

Add-Ons

Specifying Add-Ons on Project's Creation

Specifying Add-Ons for Existing Project

Adding Existing Project

Upgrading Existing Project

Running Project with Default Settings

Running Project with Custom Settings

Customize Run Options

Customize UnigineEditor Options

Editing Project

Assembling Project

Assembling Settings

Other Actions