From 6b0c03bbb5d7c9c2ad6df691938546c88e6a45b3 Mon Sep 17 00:00:00 2001 From: Abhiroop Bhavsar <126786356+akky20@users.noreply.github.com> Date: Thu, 29 Aug 2024 12:00:17 +0530 Subject: [PATCH] Windows instructions updated in harmonic branch (#487) * Windows instructions updated in harmonic branch Signed-off-by: Abhiroop Bhavsar * Updated Windows instructions updated in harmonic branch Signed-off-by: Abhiroop Bhavsar * update windows source installation page Signed-off-by: Abhiroop Bhavsar --------- Signed-off-by: Abhiroop Bhavsar Co-authored-by: Addisu Z. Taddese --- harmonic/install_windows.md | 1 - harmonic/install_windows_src.md | 24 +++++++++++++----------- 2 files changed, 13 insertions(+), 12 deletions(-) diff --git a/harmonic/install_windows.md b/harmonic/install_windows.md index 45808f808..5b544ad60 100644 --- a/harmonic/install_windows.md +++ b/harmonic/install_windows.md @@ -7,7 +7,6 @@ WARNING: Current Windows support is experimental. Most Gazebo packages are available in Windows 10 using the [conda-forge package manager](https://conda-forge.org/), and the Gazebo feedstock recipes can be found [here](https://github.com/search?q=org:conda-forge+libgz&type=code). -Additionally, command line tools, the DART physics engine, and some tests are not currently supported in Windows. In order to use `conda-forge`, you will need to 1. Install a [Conda package management system](https://docs.conda.io/projects/conda/en/latest/user-guide/install/download.html). diff --git a/harmonic/install_windows_src.md b/harmonic/install_windows_src.md index 77e33bbd0..812cd65af 100644 --- a/harmonic/install_windows_src.md +++ b/harmonic/install_windows_src.md @@ -4,10 +4,10 @@ WARNING: Current Windows support is experimental. # Source Installation on Windows 10 or 11 -OGRE2 rendering capabilities are not currently supported in Windows, and Gazebo GUI +OGRE2 rendering capabilities are supported in Windows, and Gazebo GUI works in a limited fashion. These functionalities correspond to the currently building packages `gz-rendering` and `gz-sim`, respectively. The packages will build, -but you can expect runtime failures when using their functionalities. +without any failures when using their functionalities. > **NOTE** > You should be able to use `ogre` as a rendering engine instead of the default `ogre2`. @@ -139,15 +139,19 @@ call install\setup.bat .\install\setup.ps1 ``` +You should now be able to launch gazebo: + +```bash +# Launch server in one terminal +gz sim -s + +# In separate terminal, launch gui +gz sim -g +``` + This is the end of the source install instructions; head back to the [Getting started](getstarted) page to start using Gazebo! -> **NOTE** -> As Gazebo GUI is not yet working, running `gz sim` will not work. You can run only the server with -> ```bat -> gz sim -s -v -> ``` - > **NOTE** > If your username contains spaces (which is quite common on Windows), you will probably get errors > saying `Invalid partition name [Computer:My User With Spaces]`. Fix this by changing `GZ_PARTITION` @@ -160,10 +164,8 @@ page to start using Gazebo! ### Gazebo GUI workaround Although running `gz sim` without arguments is not supported on Windows, -and `gz sim -g` is also not supported, there is a workaround you can apply -to be able to launch `gz sim -g` on Windows. + the `gz sim -g` command is supported, and you can use it to launch the graphical interface on Windows. -> Manually comment [these lines](https://github.com/gazebosim/gz-sim/blob/gz-sim7_7.5.0/src/cmd/cmdsim.rb.in#L497-L501) and [these lines](https://github.com/gazebosim/gz-sim/blob/gz-sim7_7.5.0/src/cmd/cmdsim.rb.in#L558-L562) in file `install\lib\ruby\gz\cmdsim8.rb`. This should allow you to run the GUI in a separate console, connecting to the server running in another console.