Command Line Arguments
Player and Streamer accept an optional project path. Player also accepts an optional settings file path after the project path. You can put the flags below before or after these paths.
Headless
The --headless flag runs the Player or Streamer application without a window, meaning the GUI is not rendered to the screen.
Useful for running Streamer as a service, e.g. on an embedded system such as the NVIDIA Jetson platform, or a Player whose video is only used by plugins or texture exports.
On Linux no display server is needed: Oden renders off-screen on the GPU, a Player without a GPU renders in software through Mesa, and Oden starts in headless mode automatically when neither DISPLAY nor WAYLAND_DISPLAY is set.
On Windows and macOS the flag works like --windowless.
A headless or windowless Player does not sync to a display. It runs at 30 fps by default, or at the Cap Idle Framerate if that is enabled, and it syncs to the Video Sync source if one is set, so that stream is processed at its own frame rate. A windowless Player with an active HMD keeps the HMD’s pacing.
A headless Player draws its view only for print screens, so plugin draw callbacks only run on those frames, while entity and plugin updates, clone streams, virtual cameras and texture exports run every frame. With automatic video packing, a headless Player only requests the Remote Streamer streams that texture exports use, and the Streamer sends the others at minimum size, so turn it off when plugins, clone streams or virtual cameras need the video.
Configurator (Streamer)
The --configurator flag enables a Player application with the Streamer Configurator entity to connect to and configure a Streamer, without an active Remote Streamer connection.
This is useful when setting up a headless Streamer on a platform without a monitor.
Windowless
The --windowless flag runs the Player or Streamer application in windowless mode, meaning that the window is hidden from the user.
A windowless Player paces itself like a headless one, see Headless above.
GUI Visibility
The --hide-gui flag starts Player or Streamer with the built-in GUI hidden.
The GUI can still be shown using the Toggle Hide GUI shortcut (default CTRL+H) or a plugin.
The --disable-gui flag keeps the built-in GUI hidden for the entire run, including attempts to show it through shortcuts or plugins.
Authentication and exit confirmation dialogs remain available. Plugin-provided interfaces are not disabled.
Mouse Look
The --inhibit-mouse-look flag prevents interactive viewport camera movement in Player and Streamer, using the same behavior as the window.inhibit_mouse_look setting.
This includes mouse dragging, scroll zoom, touch gestures and keyboard camera movement. The pointer and GUI controls remain usable; HMD tracking and plugin-controlled views are unaffected.
These three flags affect only the current run and do not change the saved configuration.
Allow Multiple Streamers
The --multiple-streamers flag can be set in order to run multiple streamers on the same computer.
Project
The --project [path] flag loads the given project file at startup.
If you give both --project [path] and a project path without a flag, the --project path is used.
Plugin Parameters
The --plugin-param [key] [value] flag passes a key/value parameter to plugins. The flag may be repeated to pass multiple parameters.