bw logo

Chapter 9. common_options.xml

The common_options.xml file was created to hold settings and options that are common to more than one BigWorld tool.

The common_options.xml file format specification is illustrated below:

<root>
    <cooperative>
        ?<mode> [AUTO|ON|OFF] </mode>

        <apps>
            *<app> string </app>
        </apps>
    </cooperative>
</root>

Grammar of common_options.xml file

The list below describes the tags in the common_options.xml file:

  • mode (section cooperative)

    Sets the way World Editor, Model Editor and Particle Editor should cooperate with each other and with other DirectX applications. Only three values are allowed:

    - AUTO: It's the recommended and default state, and ensures the tools release their video memory when an application in the <apps> list below is running and the tool is in the background, but keeps DirectX resources if no other specified applications are running to improve performance.

    - ON: Always releases DirectX resources when it is switched to the background, to allow maximum compatibility with other applications, but makes switching between applications slower.

    - OFF: Never releases its DirectX resources, making application switching fast, but can result in problems and/or crashes when running multiple DirectX applications.

  • app (section cooperative/apps)

    Specifies one or more executables that World Editor, Particle Editor and Model Editor should cooperate with. DOS-style wildcards can be used so, for example, if you include modeleditor*.exe in the <apps> list, the tools will cooperate with modeleditor.exe, modeleditor_debug.exe, modeleditor_eval.exe, etc. Multiple applications can be specified by including more than one <app> tags, and applications don't have to be BigWorld tools. For example, you could include 3dsmax.exe and maya.exe to ensure smooth operation with those tools.