RoboRealm Command Line Parameters

When invoking RoboRealm.exe from your own application you have several command line options that you can use to force RoboRealm's behavior when it runs. To avoid typing in these commands each time you can place the command line parameters into a .bat file. See the RoboRealm_Faceless.bat and RoboRealm_Force_GUI.bat files in the RoboRealm folder as examples.

"c:\Program Files (x86)\RoboRealm\RoboRealm.exe" -api_port 1234 -new_instance -instance_2 -ini_file c:\temp\RoboRealm.ini -faceless

new_instance

"c:\Program Files (x86)\RoboRealm\RoboRealm.exe" -new_instance

Forces another RoboRealm instance to appear as apposed to defaulting to the already running instance. This option can also be found in Options Button->Startup Tab in the GUI.

instance_2

"c:\Program Files (x86)\RoboRealm\RoboRealm.exe" -instance_2

Forces RoboRealm to run using the configuration of the second instance of RoboRealm. Whenever RoboRealm is run with more than one instance of the application the settings for that instance are separate from the first. This allows successive instances to run using the same settings as they did the last time they ran. Using the -instance_X command will allow you to pick which instance to run regardless of how many actual instances of RoboRealm you currently have running. Note that -instance_1, -instance_2, ... -instance_16 are valid parameters but only one is valid at a time.

api_port

"c:\Program Files (x86)\RoboRealm\RoboRealm.exe" -api_port 1234

If you wish to run multiple copies of RoboRealm and use the API in each separate instance you will have to run RoboRealm with different API port numbers. Using -api_port 1234 will run a copy of RoboRealm using the API port 1234 instead of whatever is saved as the last configuration or the default 6060. Specifying the -api_port will also force the API server to execute regardless of the settings saved within RoboRealm's configuration. To force a new instance of RoboRealm each time you can use. This option can also be found in Options Button->API Tab in the GUI or also specifed new_instance parameter.

ini_file

"c:\Program Files (x86)\RoboRealm\RoboRealm.exe" -ini_file c:\temp\RoboRealm.ini

The ini_file parameter forces RoboRealm to read all configuration that is normally stored in the Registry from an ini file. This can be useful if you want to copy the configuration of RoboRealm and move it to another machine without having to reconfigure the application. Note that the instance_X parameter still applies in this case as each instance is also stored in the single ini file.

faceless

"c:\Program Files (x86)\RoboRealm\RoboRealm.exe" -faceless

(Commercial Version Only) Forces RoboRealm to operate in faceless (without GUI) mode. The expectation is that the API will be used to communicate to RoboRealm from another application that is providing an interface. Please note this is only available in the Commercial version.

silent

"c:\Program Files (x86)\RoboRealm\RoboRealm.exe" -silent

(Commercial Version Only) Forces RoboRealm to NOT popup error messages that require user interaction during normal program operation. All errors are saved in RoboRealm.log instead of causing a popup to occur. The RoboRealm.log file will be created in the current folder where RoboRealm is being executed. To warn of this event a red square text area in the main GUI window will appear for 15 seconds to remind you that errors are being logged instead of alerting via popups. Note that this red square will NOT be part of the image being processed and is only displayed as a reminder.

eula_agree

"c:\Program Files (x86)\RoboRealm\RoboRealm.exe" -eula_agree

(Commercial Version Only) Forces RoboRealm to agree to the End User License Agreement that is displayed on first run after an installtion. This can be used in a large deployment to avoid users from having to read the EULA when the providing organization has taken responsiblility for the EULA agreement.

license_allow

"c:\Program Files (x86)\RoboRealm\RoboRealm.exe" -license_allow

(Commercial Version Only) Forces RoboRealm to automtically connect over the Internet to verify licensing for the current machine. Prior to this action, the end user is provided with a dialog that confirms this action. This command line parameter will avoid the display of this confirmation interface and continue to verify licenses. Note, this only happens on first run of the application.