Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Windows instructions updated in harmonic branch #487

Merged
merged 4 commits into from
Aug 29, 2024
Merged

Windows instructions updated in harmonic branch #487

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f3f3a29
Windows instructions updated in harmonic branch
akky20 Aug 16, 2024
3a4d514
Updated Windows instructions updated in harmonic branch
akky20 Aug 16, 2024
e36e82e
update windows source installation page
akky20 Aug 19, 2024
05391c6
Merge branch 'master' into fix/Windows-instructions-updated
azeey Aug 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion harmonic/install_windows.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
24 changes: 13 additions & 11 deletions harmonic/install_windows_src.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
akky20 marked this conversation as resolved.
Show resolved Hide resolved
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`.
Expand Down Expand Up @@ -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`
Expand All @@ -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.

Expand Down
Loading