Skip to content

docs: add comprehensive keyboard shortcuts reference for Simulate viewer#3309

Open
genius-0963 wants to merge 1 commit into
google-deepmind:mainfrom
genius-0963:docs/simulate-keyboard-shortcuts
Open

docs: add comprehensive keyboard shortcuts reference for Simulate viewer#3309
genius-0963 wants to merge 1 commit into
google-deepmind:mainfrom
genius-0963:docs/simulate-keyboard-shortcuts

Conversation

@genius-0963
Copy link
Copy Markdown

Add a new documentation page listing all built-in keyboard shortcuts and mouse controls for the MuJoCo Simulate viewer (simulate binary and mujoco.viewer).

The page covers:

  • Simulation control (play/pause, stepping, speed, reset, reload)
  • Camera control (free camera, fixed camera cycling, frame/label modes)
  • UI and overlay toggles (F1-F5 for help, info, profiler, sensors, fullscreen)
  • File and simulation menu shortcuts (Ctrl+M/D/P/Q/A/C)
  • All visualization flag toggles from mjVISSTRING (25 single-key shortcuts)
  • All render flag toggles from mjRNDSTRING (8 single-key shortcuts)
  • Group visibility shortcuts (Geom 0-5, Site Shift+0-5)
  • Mouse interaction controls (13 actions including perturbation)
  • Python key_callback extension point

Every shortcut was verified against the source code in simulate.cc, simulate.h, and engine_vis_init.c.

Also adds a cross-reference from the existing simulate sample description in samples.rst to the new page.

Add a new documentation page listing all built-in keyboard shortcuts
and mouse controls for the MuJoCo Simulate viewer (simulate binary
and mujoco.viewer).

The page covers:
- Simulation control (play/pause, stepping, speed, reset, reload)
- Camera control (free camera, fixed camera cycling, frame/label modes)
- UI and overlay toggles (F1-F5 for help, info, profiler, sensors, fullscreen)
- File and simulation menu shortcuts (Ctrl+M/D/P/Q/A/C)
- All visualization flag toggles from mjVISSTRING (25 single-key shortcuts)
- All render flag toggles from mjRNDSTRING (8 single-key shortcuts)
- Group visibility shortcuts (Geom 0-5, Site Shift+0-5)
- Mouse interaction controls (13 actions including perturbation)
- Python key_callback extension point

Every shortcut was verified against the source code in simulate.cc,
simulate.h, and engine_vis_init.c.

Also adds a cross-reference from the existing simulate sample
description in samples.rst to the new page.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant