Documentation/Engine/Console/Commands/multimon

From SCS Modding Wiki
Jump to navigation Jump to search

While the multimon command allows dynamic changes of the size of the monitor views at runtime, increasing the size can not increase the maximal effective rendering resolution beyond the resolution used by the biggest view the game started with. In that case the changed view will have proper size however its content might look blurry. To fix it, restart the game or temporarily change (and apply) vsync settings in display options after saving the configuration first using multimon save.

The following commands are supported:

init

Syntax: multimon init <setup_name>

Example: multimon init three

This command initializes the runtime configuration using one from predefined setups. Following setups are supported:

  • empty - No views, UI over entire screen. This is convenient starting point for more complex custom setups.
  • one - Creates single wide view UI over entire screen. This is similar to predefined mode 0 however it provides ability to disable interior rendering if desired.
  • three - Setup corresponding to predefined mode 2
  • three_with_dash - Setup corresponding to predefined mode 3

When initializing using three or three_with_dash, the state of corresponding tweaking cvars at the moment of the initialization is applied to the runtime configuration. This can be used to do basic setup using the cvars in predefined mode and use the custom mode to only tweak the result.

reload

Syntax: multimon reload

Example: multimon reload

Replaces the runtime configuration using a content of multimon_config.sii

save

Syntax: multimon save

Example: multimon save

Saves the current runtime configuration to multimon_config.sii. This MUST be used for the changes to persist restart of the game or change of display settings.

add

Syntax: multimon add <name> <x> <y> <width> <height>

Example: multimon add left 0.25 0 0.5 1

Defines monitor in specified area of output resolution and associates it with specified name. Note that name ui is reserved for special use.

remove

Syntax: multimon remove <name>

Example: multimon remove left

Removes monitor associated with specified name.

make primary

Syntax: multimon make_primary <name>

Example: multimon make_primary center

Marks specified monitor as primary. This should likely be the monitor in the center of the view.

list

Syntax: multimon list

Example: multimon list

List names of all defined monitors

set

Syntax: multimon set <name> <attribute> <value>

Example: multimon set left horizontal_fov_override 60

Sets specified attribute for specified monitor. Special monitor name ui allows changes of position of the ui itself.

get

Syntax: multimon get <name> [<attribute_prefix>]

Example: multimon get left normalized_

Prints values of all attributes of specified monitor whose name begins with specified prefix. As with set ui provides access to the ui itself.