UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Using Editor Tools for Specific Tasks
FAQ
Программирование
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
CIGI Client Plugin
Rendering-Related Classes

Rebuild in Windows via Visual Studio

This article explains how you can rebuild the UNIGINE Engine and its components (samples, plugins, etc.) by using Visual Studio on the Windows platform.

Rebuilding UNIGINE Engine or Its Components#

Customization Options#

Apart from developing your project with UnigineScript, you can also customize the UNIGINE application C++ code. What exactly is available for customization depends on the version of UNIGINE SDK:

  • With the limited binary/evaluation version you can only modify the following components:
    1. C++ plugins for the engine (in the evaluation version, some plugins cannot be rebuilt).
    2. The source code of UNIGINE-based sample applications.

    You can also modify the source code of high-level scripts: just like all other scripts, they do not require recompilation.

  • If you have the full source version, you can modify the entire UNIGINE codebase:
    1. The C++ source code of the engine itself.
    2. All UNIGINE standalone tools.
    3. C++ plugins for the engine.
    4. The source code of UNIGINE-based sample applications.

After customizing the code, recompilation of UNIGINE application or its libraries is required.

Notice
It is strongly not recommended to modify the engine source code directly, because you will need to merge your modifications each SDK update. Instead, it is better to use C++ API (including C++ plugin system) designed specifically for extending basic UNIGINE functionality.

Rebuild the UNIGINE-Powered Application#

For Windows, 32-bit or 64-bit, debug or release, single or double coordinates precision versions can be compiled. To recompile both the UNIGINE engine (i.e. the dynamic library Unigine_*.dll) and application on its base (i.e. the main application main_*.exe), do the following: For compilation via MS Visual Studio:

  • To rebuild the engine libraries:
    1. Open the solution file for Visual Studio: <UNIGINE_SDK>\source\engine\unigine_vs2013.vcxproj or <UNIGINE_SDK>\source\engine\unigine_vs2015.vcxproj. The postfix shows the version of Microsoft Visual Studio.
      Notice
      If you use Visual Studio 2017, open unigine_vs2015.vcxproj and click Upgrade.
    2. Specify the solution configuration: Debug, Debug-Double, Release or Release-Double.

    3. Choose Build -> Build Solution in the menu or press F7.

  • To rebuild the main application:
    1. Open <UNIGINE_SDK>\source\apps\main\main_vs2013.vcxproj or <UNIGINE_SDK>\source\apps\main\main_vs2015.vcxproj. The postfix shows the version of Microsoft Visual Studio.
      Notice
      If you use Visual Studio 2017, open main_vs2015.vcxproj and click Upgrade.
    2. Specify the solution configuration: Debug, Debug-Double, Release or Release-Double.

    3. Choose Build -> Build Solution in the menu or press F7.

Rebuild Engine Plugins#

To rebuild engine C++ plugins, perform one of the following: >To rebuild a plugin with Microsoft Visual Studio, do the following:

  • Open the solution of the necessary plugin to rebuild. All plugins are located in <UNIGINE_SDK>\source\plugins\.
  • Specify the solution configuration: Debug, Debug-Double, Release or Release-Double.

  • Choose Build -> Build Solution in the menu or press F7.

Rebuild Task-Specific Applications#

Some specific functionality is not supported by the main UNIGINE application. For that, you need to recompile separate applications (their binary executables).

Notice
Only one plugin from <UnigineSDK>\source\plugins\App\ can be loaded at the same time. To load another plugin, you should unload the previous one.

To rebuild athe task-specific application with Microsoft Visual Studio, do the following:

  1. Open the solution of the necessary plugin to rebuild. All plugins are located in <UNIGINE_SDK>\source\plugins\.
  2. Specify the solution configuration: Debug, Debug-Double, Release or Release-Double.

  3. Choose Build -> Build Solution in the menu or press F7.

Rebuild Sample Applications#

In UNIGINE SDK, there are included sample applications that can be modified and used as templates to create your own applications.

To rebuild UNIGINE samples, you should do the following:

  1. Open the Visual Studio project file of the sample. Samples are located in the<UnigineSDK>\source\samples\ directory.
  2. Specify the solution configuration: Debug, Debug-Double, Release or Release-Double.

  3. Choose Build -> Build Solution in the menu or press F7.

Last update: 27.12.2018