UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes

Syncker-Specific Options

Warning
The functionality described in this article is not available in the Community SDK edition.
You should upgrade to Sim SDK edition to use it.

There are 2 types of Syncker-specific options:

  • Command-line options used to specify screen configuration, addressing mode, multicast address of the master computer, or a port to be used on the application start-up. These options have the same syntax as the other start-up command-line options.
  • Console options that can be run from the application console on the master or slave sides.

Command-Line Options#

Common Options#

The following command-line options can be run on master or slave application start-up:

Name Description Arguments Default
sync_view_config Specifies a screen/projection configuration to be used. This configuration represents a configuration of monitors, onto which the application is rendered, or projectors that project the application onto projection screens (1 unit = 1 meter). Projection and modelview matrices are automatically calculated on the basis of the camera position and slave name. When no configuration file is specified, all slaves clone master's display.
Notice
Check the full list of configuration requirements here.
Shell commands
-sync_view_config "my_project/my_config.sync"
A path to the .sync file. syncker.cfg
sync_master Sets the flag indicating whether the computer is a master.
Shell commands
-sync_master 1
Master flag. 1
sync_method Sets the addressing mode to be used by Syncker. One of the following: unicast, multicast, and broadcast.
Shell commands
-sync_method broadcast
Addressing mode. unicast
sync_async Sets the flag indicating whether the asynchronous mode is to be used. The default value of 0 corresponds to synchronous mode.
Shell commands
-sync_async 1
Asynchronous mode flag. 0
sync_multicast_address Sets a multicast address that is used by the master computer to send messages to slaves over the network.
Shell commands
-sync_multicast_address "xxx.xxx.xxx.xxx"
A multicast address in the xxx.xxx.xxx.xxx format. 239.0.0.1
sync_port Sets the UDP port to be used to send and receive messages for the Syncker.
Shell commands
-sync_port 8890
UDP port number. 8890
sync_view Sets the view (display or projector stored in the configuration file) to be used. This option is equivalent to sync_view_0.
Shell commands
-sync_view display_name
Name of the display/projector stored in the .sync configuration file. -
sync_view_0 Sets the view (display or projector stored in the configuration file) to be used for the 1st monitor/projector of the computer.
Shell commands
-sync_view_0 display_name
Name of the display/projector stored in the .sync configuration file. -
sync_view_1 Sets the view (display or projector stored in the configuration file) to be used for the 2nd monitor/projector of the computer.
Notice
To be specified when a multi-monitor configuration is used.
Shell commands
-sync_view_1 display_name
Name of the display/projector stored in the .sync configuration file. -
sync_view_2 Sets the view (display or projector stored in the configuration file) to be used for the 3rd monitor/projector of the computer.
Notice
To be specified when a multi-monitor configuration is used.
Shell commands
-sync_view_2 display_name
Name of the display/projector stored in the .sync configuration file. -
sync_view_3 Sets the view (display or projector stored in the configuration file) to be used for the 4th monitor/projector of the computer.
Notice
To be specified when a multi-monitor configuration is used.
Shell commands
-sync_view_3 display_name
Name of the display/projector stored in the .sync configuration file. -
sync_view_4 Sets the view (display or projector stored in the configuration file) to be used for the 5th monitor/projector of the computer.
Notice
To be specified when a multi-monitor configuration is used.
Shell commands
-sync_view_4 display_name
Name of the display/projector stored in the .sync configuration file. -
sync_view_5 Sets the view (display or projector stored in the configuration file) to be used for the 6th monitor/projector of the computer.
Notice
To be specified when a multi-monitor configuration is used.
Shell commands
-sync_view_5 display_name
Name of the display/projector stored in the .sync configuration file. -

Master Options#

The following command-line options can be run on the master application start-up:

Name Description Arguments Default
sync_count Sets a number of Syncker hosts (including the Master itself) in the network.
Shell commands
-sync_count 3
Number of hosts. 1
sync_broadcast_address Sets a broadcast address of the master computer that is used to broadcast messages to slaves over the network. If the key is not specified Syncker shall try to determine the value automatically.
Shell commands
-sync_broadcast_address "xxx.xxx.xxx.xxx"
A broadcast address in the xxx.xxx.xxx.xxx format. -
sync_allow_extra_slaves Sets the flag indicating whether additional Slaves can be connected after starting the session.
Shell commands
-sync_allow_extra_slaves 1
Extra slaves flag. 0

Slave Options#

The following command-line options can be run on the slave application start-up:

Name Description Arguments Default
sync_slave_port Sets a UDP port to be used by the Slave. 0 - means any unused port available.
Shell commands
-sync_slave_port 0
UDP port number. 0
sync_master_address Sets the address of the master computer. If the key is not specified Syncker shall try to determine the value automatically.
Shell commands
-sync_master_address "xxx.xxx.xxx.xxx"
Master's address in the xxx.xxx.xxx.xxx format. -

Console Commands#

The following console commands can be run on a master or a slave computer.

Name Description Arguments
sync
  • Command. Runs the specified console command on master and all slaves.
    Source code
    sync show_profiler 3 
    //shows the profiler on all computers

A console command to run.

syncker_interpolation

0 - disabled

1 - enabled (by default)

syncker_interpolation_period
  • Variable. Prints the current interpolation period value for the computer, in seconds.
  • Command. Sets the interpolation period for the computer.
    Source code
    syncker_interpolation_period 0.04

Interpolation period, in seconds

(0.04 - by default)

syncker_extrapolation_period
  • Variable. Prints the current extrapolation period value for the computer, in seconds.
  • Command. Sets the extrapolation period for the computer.
    Source code
    syncker_extrapolation_period 0.2

Extrapolation period, in seconds

(0.2 - by default)

syncker_setup
  • Variable. Prints the value indicating if screen/ projection setup mode is active.
  • Command. Enables or disables screen/ projection setup mode.
    Source code
    syncker_setup 1

0 - return to standard mode.

1 - enter the screen/ projection setup mode.

syncker_debug
  • Variable. Prints the value indicating if the debug window is active.
  • Command. Shows or hides the debug window.
    Source code
    syncker_debug 1

0 - hide the debug window.

1 - show the debug window.

Last update: 2020-04-10