[isaacsim.app.setup] Isaac Sim Setup#
Version: 1.12.0
Overview#
The isaacsim.app.setup extension handles the initial configuration and layout setup for the Isaac Sim application. This extension configures window arrangements, application menus, and various Isaac Sim-specific UI components during application startup.
Functionality#
The extension manages several key aspects of Isaac Sim application initialization:
Window Layout Management - The load_layout function provides programmatic control over window arrangements by loading saved layout configurations from JSON files. This allows for consistent workspace setups across different Isaac Sim sessions.
Application Configuration - The extension handles core application setup including window docking order, property window delegate configuration, and menu system initialization. It establishes the standard Isaac Sim window arrangement with proper positioning for Stage, Layer, Console, Content, and Assets windows.
Platform-Specific Settings - The extension includes platform-specific configuration options for ROS bridge integration and simulation control extensions, allowing different setups for Windows and Linux environments.
Key Components#
Layout Loading#
The load_layout function accepts a JSON layout file path and applies the saved window configuration:
await load_layout("path/to/layout.json", keep_windows_open=False)
The function includes timing coordination to avoid conflicts with main window initialization and provides options for preserving existing window states.
Startup Configuration#
The extension manages Isaac Sim-specific startup behaviors through its settings, including automatic stage creation and optional ROS bridge integration based on platform requirements.
Integration#
The extension uses **omni.kit.quicklayout** for layout management operations and integrates with **omni.kit.window.property** to configure property window delegates for Isaac Sim-specific prim types. It also leverages **omni.kit.menu.common** for menu system setup and **omni.kit.stage_templates** for initial stage configuration.
Enable Extension#
The extension can be enabled (if not already) in one of the following ways:
Define the next entry as an application argument from a terminal.
APP_SCRIPT.(sh|bat) --enable isaacsim.app.setup
Define the next entry under [dependencies] in an experience (.kit) file or an extension configuration (extension.toml) file.
[dependencies]
"isaacsim.app.setup" = {}
Open the Window > Extensions menu in a running application instance and search for isaacsim.app.setup.
Then, toggle the enable control button if it is not already active.
Extension: {{ extension_version }} |
Documentation Generated: Jun 05, 2026 |
Settings#
Settings Provided by the Extension#
isaac.startup.create_new_stage#
Default Value: true
Description: Creates a new stage when this extension is enabled so there is something visible in the viewport.
isaac.startup.ros_bridge_extension#
Default Value: “” (empty string)
Description: Specifies the ROS bridge extension to use for the platform, with blank meaning no ROS bridge.
isaac.startup.ros_sim_control_extension#
Default Value: false
Description: Specifies the sim control extension to use for the platform, with false meaning no sim control.
Actions in isaacsim.app.setup#
ID |
Display Name |
Description |
|---|---|---|
layout_default |
Load Layout: Default |
Load the Default layout |
layout_quick_load |
Layout: Quick Load |
Execute layout action: Quick Load |
layout_quick_save |
Layout: Quick Save |
Execute layout action: Quick Save |
layout_replicator |
Load Layout: Replicator |
Load the Replicator layout |
layout_visual_scripting |
Load Layout: Visual Scripting |
Load the Visual Scripting layout |
show_ui_docs |
Show Omni UI Docs |
Open the Omni UI documentation |