Command Line Options

Pls read this https://urho3d.github.io/documentation/HEAD/_running.html and delete the page

The Urho3D engine behavior can be modified by using command line options which are automatically available through the engine itself. For the curious ones, the source file that processes the "default" command line options is here:

~/Urho3D/Engine/Engine.cpp

in the "Engine::ParseParameters(…)" method.

Such command line options when indicated take precedence over the default values initialized within the engine at startup. However, any other behavior that is programmatically written in your application will then take precedence at the end over the command line parameters.

Consequently, the order of precedence is the following:

1. engine default values
2. command line parameters
3. parameters set inside your application

For example, if you want to set up a window width of 640 pixel, then you can modify that behavior by indicating -x 800 to actually have a 800 pixel width window.

A command line option is indicated like any other regular option. Here is an example:

# YourUrho3DApp -x 800 -y 420 -headless -monitor 2

That example shows you how to activate options that are defined by the engine. Of course, you can define your own options but in such a case, your options must not be confused with the engine default ones.

That Wiki page provides the list of available command line options with their meaning in the list below. As you can see, some of them are TBD (To Be Defined) since their behavior is not fully understood at the time that page is being written. They will be hopefully solved, or maybe if someone reading this page can give some more details, this will be welcome.

Here are the engine default options…

• headless : no display is available meaning there are no graphic outputs
• nolimit : do not limit the number of frames per second
• flushgpu : TBD
• gl2 : force OpenGL2
• landscape : force landscape shape
• portrait : force portrait shape
• nosound : do not use the sound system
• noip : TBD
• mono : do not use stereo sound, use mono instead
• prepass : TBD
• deferred : TBD
• renderpath : set a particular renderpath
• noshadows : do not cast shadows
• lgshadows : TBD
• nothreads : TBD
• v : enable vertical synchronization
• t : enable triple buffer usage
• w : enable widnowed
• borderless : borderless window
• lowdpi : force low dot per inch screen resolution
• s : force window to be resizeable either it is disabled in your app
• q : quiet logs
• log : set the log level
• x : set window width
• y : set window height
• monitor : set monitor to use for display in case you have several displays (only valid when displaying in fullscreen)
• hz : set refresh rate
• m (multi-sample) : TBD
• b (sound buffer) : TBD
• r (sound mix rate) : set sound mix rate
• pp (resource prefix paths) : set the prefix path (to locate resource and assets files)
• p (resource paths) : set paths to access resources and assets
• pf (resource packages) : TBD
• ap (autoload paths) : TBD
• ds (dump shaders) : TBD
• mq (material quality) : TBD
• tq (texture quality) : set texture quality
• tf (texture filter mode) : TBD
• af (anisotropic texture filter mode) : TBD
• touch : emulate a touchscreen

The "TBD" stands for "To Be Defined".