How ihmcrobotics/simulation-construction-set-2 works
Project type and purpose
• This is a multi-module Java monorepo for a desktop simulation platform (“SCS2”) comprising:
• Core definition & IO libraries (robot, terrain, visuals)
• Simulation backends (built-in physics, Bullet bridge)
• Session management & buffering (in-memory & shared-memory)
• Logging & remote session support (MCAP, video scrubbers)
• Visualization layers (engine-agnostic + JavaFX GUI)
• Examples, symbolic equation support, packaging and CI
• scs2-definition
• scs2-shared-memory
• scs2-session
• scs2-simulation
• scs2-bullet-simulation
• scs2-session-logger
• scs2-session-visualizer (core)
• scs2-session-visualizer-jfx (JavaFX GUI)
• scs2-simulation-construction-set (bundled application entry point)
• scs2-symbolic, scs2-examples (auxiliary/library consumers)
Relationships and data flow
• Definitions → consumed by Simulation backends & GUI
• Simulation engines (SCS2 core + Bullet) → produce YoVariables & RobotState
• Shared-memory & session modules → buffer those variables over time
• Session-logger → reads from session buffer → writes log files (MCAP, video) or serves remote clients
• Visualizer modules → read live or logged session data → render 2D/3D graphics via JavaFX
• The “SimulationConstructionSet2” top-level app pulls all layers together
Architectural patterns & principles
• Layered + plugin-style physics engines via Factory interfaces
• Clear separation between:
• Definition (data models & IO)
• Simulation (computation)
• Session (buffering & control)
• Logging/Remote (persistence & streaming)
• Visualization (rendering & GUI)
• Multi-project Gradle build orchestrates module dependencies
• Use of JavaFX for GUI, MCAP for log format, URDF/SDF tools, Bullet native bridge