Skip to content

Conversation

@liamckenna
Copy link

About

Introduces GUI to allow for script execution and scene/robot config file editing from within the simulation.
Once the activate env script is selected and a python script is selected, all relevant scene and robot config settings are made available to the user.

Features

  • UI does not appear on other viewports, can be minimized and thus ignored entirely if need be.
  • Python scripts can be executed from the UI no longer needing external windows for terminals.
  • Fully backwards compatible with existing config file system.
  • Dynamically sized, only displays relevant config file data and safely editable parameters.
  • Parameters are limited based on the documentation, ie. the menu won't allow users to put a string of letters as a coordinate or an FOV >170 or < 5, etc.
  • Running a script will reset the scene's actors and disable any ongoing script, regardless if the scripts share actors. E.g. running hello_drone.py while hello_rover.py will remove the rover from the scene and start as though no script was playing to begin with.

Limitations

  • Editing the json files through the UI will result in any comments left in said files being deleted.
  • The menu does not allow users to add/remove actors or list elements from the configs, only edit existing ones.
  • Has been tested in shipping (built from source) but not a dedicated prebuilt binary.
  • Only approved for windows (11), linux support is a couple lines away but I personally cannot test a linux build.
  • Assumes config files to exist in a subdirectory of the python scripts called "sim_config" in order to function. Based on the setup documentation it seemed users were already expected to organize their files this way.
  • Menu blueprints are currently within the blocks scene and not the plugin. Slight reorganizing of assets and retesting is needed to host it all in the plugin.

How Has This Been Tested?

Tested in both UE5 editor Blocks scene and in the shipping build, on Windows 11 built from source.

Notes

Some files had to receive slight adjustments for successful compilation. Beyond the newly created files, I'm unsure as to what additional changes, if any, need to be brought over for the menu to work in main.

Screenshots and videos (if appropriate):

Initial menu (top left):
image

Fully minimized:
image

Uses window filesystem popup to select files:
image

Once a valid python script is selected, the user gains full access to the menu:
image

image image image

@jonyMarino jonyMarino added the enhancement New feature or request label Jan 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants