Command-Line Interface

The FBX Converter is a command-line tool.

To run the FBX Converter open a Windows Command Prompt, which can be found in the Windows Start menu under All Programs -> Accessories. A command prompt can also be opened by typing cmd in the Windows Run prompt in the Start menu. Once a command prompt has been opened, we recommend launching the FBX Converter from the folder where the source FBX files are located.

The FBX Converter comes with the following tools:

  FbxConvertx64.exe   (from Oculus VR)
  TimeStampx64.exe    (from Oculus VR)
  PVRTexTool/*        (version 3.4, from the PowerVR SDK version 3.3)
  7Zip/*              (version 9.20, from www.7-zip.org)

The FbxConvert64.exe is the executable that is launched by the user. The other executables are directly or indirectly used by the FbxConvertx64.exe executable.

Options

The FBX Converter supports the following command-line options:

CommandDescription
-o <output>Specify the name for the .ovrscene file. Specify this name without extension.
-render <model.fbx>Specify model used for rendering.
-collision <model.fbx|meshes>Specify model or meshes for wall collision.
-ground <model.fbx|meshes>Specify model or meshes for floor collision.
-raytrace <model.fbx|meshes>Specify model or meshes for focus tracking.
-translate <x> <y> <z>Translate the models by x,y,z.
-rotate <degrees>Rotate the models about the Y axis.
-scale <factor>Scale the models by the given factor.
-swapXZSwap the X and Z axis.
-flipUFlip the U texture coordinate.
-flipVFlip the V texture coordinate.
-stripModoNumbersStrip duplicate name numbers added by MODO.
-sort <+|-><X|Y|Z|origin>Sort geometry along axis or from origin.
-expand <dist>Expand collision walls by this distance. Defaults to 0.5
-remove <mesh1> [<mesh2> ...]Remove these source meshes for rendering.
-atlas <mesh1> [<mesh2> ...]Create texture atlas for these meshes.
-discrete <mesh1> [<mesh2> ...]Keep these meshes separate for rendering.
-skin <mesh1> [<mesh2> ...]Skin these source meshes rigidly to a joint.
-tag <mesh1> [<mesh2> ...]Turn 1st triangles of these meshes into tags.
-attrib <attr1> [<attr2> ...]Only keep these attributes: [position, normal, tangent, binormal, color, uv0, uv1, auto].
-anim <rotate> <pitch> <yaw> <roll> <timeoffset> <timescale> <joint1> [<joint2> ...] -anim <sway> <pitch> <yaw> <roll> <timeoffset> <timescale> <joint1> [<joint2> ...] -anim <bob> <X> <Y> <Z> <timeoffset> <timescale> <joint1> [<joint2>...]Apply parametric animation to joints.
-ktxCompress textures to KTX files (default).
-pvrCompress textures to PVR files.
-ddsCompress textures to DDS files.
-alphaKeep texture alpha channels if present.
-cleanDelete previously compressed textures.
-include <file1> [<file2> ...] Include these files in the package.
-packAutomatically run <output>_pack.bat file.
-zip <x>7-Zip compression level (0=none, 9=ultra).
-fullTextStore binary data as text in JSON file.
-noPushDo not push to device in batch file.
-noTestDo not run a test scene from batch file.
-cinemaLaunch VrCinema instead of VrScene.
-expoLaunch VrExpo instead of VrScene.

The -collision, -ground and -raytrace command-line options may either specify a separate FBX file or a list of meshes from the FBX file specified with the -render command-line option. If the collision and ray-trace meshes are in the same FBX file as the to be rendered meshes but the collision and ray-trace surface should not be rendered, then these meshes can be removed for rendering using the -remove command-line option.

Note that the -collision, -ground, -raytrace, -remove, -atlas, -discrete, -skin and -tag command-line options accept wild cards like * and ?. For instance, to make all surfaces discrete use: -discrete *

Batch Execution

Instead of typing all the command-line options on the command prompt, it is common practice to use a batch file to launch the FBX Converter with a number of options. This allows for quick iteration on the assets while consistently using the same settings. The following is the contents of the batch file that was used to convert the FBX for the home theater:

FbxConvertx64.exe -o home_theater -pack -stripModoNumbers -rotate 180 -scale 0.01 -translate 0.45 0 -3 -swapxz -flipv -sort origin -tag screen -render 
home_theater\home_theater.fbx -raytrace screen

Troubleshooting

The FBX Converter prints several things on the screen such as configuration options and warnings and errors. Warnings (e.g., missing textures) are printed in yellow, and errors (e.g., missing executables) are printed in red.