Manual Compilation via SCons

Using SCons you can re-build the Unigine engine and its components (Network plugin, standalone tools, plugins for 3D editors) as well as binary executable of a custom application. It reads the default compilation settings stored in SConstruct and SConscript files which are provided in the Unigine SDK.

To build the development version of Unigine engine or tools (the same bitness as the native platform) via SCons, perform the following steps:

1. Open the console.
2. Go to the target directory which contains a SConscript file (depending on what you are going to compile).
3. Type scons and press ENTER to start building.
   By default cross-compilation is disabled and the compiled application and tools have the native bitness. If necessary, you can set your custom compilation options.

Using Scons Under Windows

C:\Windows\system32>c:

C:\Windows\system32>cd c:\UnigineSDK\source\app\main

C:\UnigineSDK\source\app\main>scons debug=0

C:\UnigineSDK\source\app\main>scons cross=x64 double=1

Using Scons Under Linux

username@pc-name$ cd /home/username/UnigineSDK/source/app/main/
username@pc-name$ scons debug=0 cross=x86

Using Scons Under Mac OS X

mac-name:~ username$ cd ~/home/username/UnigineSDK/source/app/main/
mac-name:main username$ scons debug=0 cross=x86

When rebuilding the Unigine engine, the available options are the following:

• platform PLATFORM - platform to build for. Possible values are:
  • default - the native platform that SCons is currently run on (for Linux). To create 64-bit Windows application, scons with the cross=x64 option should be run. For Mac OS X the default is always 64-bit architecture. This is a default option.
  • ps3 - PlayStation 3
  • android - Android
  • ios - iOS
  • webgl - WebGL (still in the pipeline, so can cause building-up problems; available only for source versions)
• cross BITS - bitness of the target platform. Possible values are:
  • default - version with the same bitness as the platform that SCons is currently run on. This is a default option.
  • x86 - 32-bit version
  • x64 - 64-bit version
  • arm - ARM-based version
• debug - generate detailed debugging information or not. Possible values are: 1 (by default), 0.
• double DOUBLE - build with double precision coordinates (for large coordinates support). Possible values are: 1, 0 (by default).
• compiler COMPILER - compiler to be used. It is not recommended to override the default setting. Possible values are:
  • default - the native compiler for the chosen platform. This is the default option.
  • gcc - GCC (the GNU Compiler Collection)
  • msvs - MS Visual Studio compiler
  • ps3ppusnc - PlayStation 3 compiler
  • clang - Clang compiler
• jobs JOBS - the number of parallel building jobs to be run. Possible values are: 0, 1, 2, 3, 4, 6, 8, 16. The default is 0.
• batch - enable batch build mode for MS Visual Studio to skip all prompts for user input. Possible values are: 1 (by default), 0.
• simd SIMD - perform parallel compilation using the SIMD operations. Possible values are:
  • default - use ARM NEON technology. This is the default value.
  • none - do not use SIMD
  • sse - use Streaming SIMD Extensions technology
  • sse2 - use Streaming SIMD Extensions 2 technology (Intel SIMD)
  • avx - use AVX
  • altivec - use AltiVec instructions
  • neon - use ARM NEON technology
• emulation EMULATION - emulate the selected platform. When this option is used the build system creates PC/Mac based binary which emulates the platfom. Also it can be used as a script cache generator. Possible values are:
  • none - do not emulate. This is the default value.
  • ps3 - PlayStation 3
  • android - Android
  • ios - iOS
  • webgl - WebGL

Renderer Options

Sound Options

Computing Options

Other Options

Protection Options

For compiling the Network plugin the following options can be set:

• platform PLATFORM - platform to build for. Possible values are:
  • default - the native platform that SCons is currently run on (Windows, Linux or Mac OS X). This is a default option.
  • ps3 - PlayStation 3
• compiler COMPILER - compiler to be used. It is not recommended to override the default setting. Possible values are:
  • default - the native compiler for the chosen platform. This is a default option.
  • gcc - GCC (the GNU Compiler Collection)
  • msvs - MS Visual Studio compiler
  • ps3ppusnc - PlayStation 3 compiler
• cross BITS - bitness of the target platform. Possible values are:
  • default - version with the same bitness as the platform that SCons is currently run on
  • x86 - 32-bit version
  • x64 - 64-bit version
• debug - generate detailed debugging information or not. Possible values are: 1, 0 (by default).
• double DOUBLE - build with double precision coordinates (for large coordinates support). Possible values are: 1, 0 (by default).
• check_memory - this option is for 32-bit Windows debug builds only. It allows to check memory leaks in the system. Possible values are: 1, 0 (by default).
• prof - generate profiling information or not. This option creates a release build version that, however, also contains some required debugging information. The default value is 0.
• jobs JOBS - the number of parallel building jobs to be run. Possible values are: 0, 1, 2, 4, 8, 16. The default is 0.