Skip to main content

Getting Started

This page covers installing SuperDex, opening the example assets, and building SuperDex Studio from source. For a tour of the application, see the Overview.

Quick Start (Python)​

Project SuperDex has first-class Python support. Follow the Python quick-start instructions to install SuperDex.

After installation, follow these steps:

  1. Launch SuperDex Studio with uv run --no-project superdex-studio.
  2. In Studio, select File → Add Folder to Workspace…, then open project_superdex/assets/bots or project_superdex/assets/prefabs.
  3. In the Asset Browser, open one of the provided example bots, prefabs, or 3D models.

SuperDex Studio has separate editors for bots, prefabs, and 3D models. Use the Bot Editor to import and edit bots, the Prefab Editor to create and edit prefabs, and the Model Editor to refine 3D models.

SuperDex Studio with a Franka arm and a five-finger hand open in the Bot Editor: viewport at center, Bot Hierarchy and Bot Link Details docked right, Asset Browser along the bottom.

Building from Source (Python)​

Follow the Project SuperDex Python build instructions.

Building from Source (C++)​

Studio also builds with CMake by enabling -DSUPERDEX_BUILD_STUDIO=ON.

  1. Follow steps 1–3 of the Project SuperDex C++ build instructions to get the source code, install the prerequisites, open the Windows developer shell when applicable, and enter the repository root.
  2. Configure the build to include Studio: cmake -B build -DCMAKE_BUILD_TYPE=Release -DMOCHI_BUILD_DEBUGGER=OFF -DMOCHI_USE_PYBIND=OFF -DSUPERDEX_BUILD_STUDIO=ON -G Ninja
  3. Build: cmake --build build --parallel
  4. Run Studio from build/bin: ./superdex_studio on Linux or macOS, or superdex_studio.exe on Windows.
note

Studio is not enabled for CMake builds by default because it needs desktop graphics dependencies that a headless build does not.