|
| 1 | +# Install on Windows |
| 2 | + |
| 3 | +This document collects the different options available on Windows to bring |
| 4 | +Gazebo into a Windows system. |
| 5 | + |
| 6 | +Windows is not a fully officially supported platform by Open Robotics for |
| 7 | +Gazebo. Open Robotics guarantees that the code is compatible with compilations |
| 8 | +on Windows but there are no packages officially available. Since Gazebo is open |
| 9 | +source, the Gazebo Community provides distribution using different projects. |
| 10 | + |
| 11 | +## Community support |
| 12 | + |
| 13 | +The Gazebo Community runs different projects to facilitate the |
| 14 | +Windows installation providing all the dependencies and patch the code to solve |
| 15 | +problems at runtime (help from Open Robotics is usually provided). |
| 16 | + |
| 17 | +For the different Community projects available, |
| 18 | +[checkout the issue tracker](https://github.com/osrf/gazebo/issues/2901). Below |
| 19 | +is a quick overview of some of them. |
| 20 | + |
| 21 | +### Gazebo on Windows via conda-forge |
| 22 | + |
| 23 | +[conda-forge](https://conda-forge.org/) is a collection of packages to be used |
| 24 | +with the conda package manager. |
| 25 | + |
| 26 | +General feedback on using conda-forge is collected |
| 27 | +[in this Gazebo issue](https://github.com/osrf/gazebo/issues/2899). |
| 28 | + |
| 29 | +For contributions or bug reports on using Gazebo with conda the best place is the |
| 30 | +[conda-forge issue tracker](https://github.com/conda-forge/gazebo-feedstock). |
| 31 | + |
| 32 | +### Gazebo on Windows via vcpkg |
| 33 | + |
| 34 | +[vcpkg](https://github.com/microsoft/vcpkg) is a package manager oriented to C |
| 35 | +and C++ libraries and tools managed by Microsoft. There is a port for |
| 36 | +[Gazebo](https://github.com/microsoft/vcpkg/tree/master/ports/gazebo). |
| 37 | + |
| 38 | +General feedback on using vcpkg is collected |
| 39 | +[in this Gazebo issue](https://github.com/osrf/gazebo/issues/3202). |
| 40 | + |
| 41 | +For contributions or bug reports on using Gazebo with vcpkg the best place is the |
| 42 | +[vcpkg issue tracker](https://github.com/microsoft/vcpkg/issues) |
| 43 | + |
| 44 | +### Gazebo on Windows via WSL (Windows Subsystem for Linux) |
| 45 | + |
| 46 | +[WSL](https://docs.microsoft.com/en-us/windows/wsl/install) is a compatibility |
| 47 | +layer for running Linux binary executables on Windows 10 and newer. |
| 48 | + |
| 49 | +The [Project DAVE](https://github.com/Field-Robotics-Lab/dave/wiki) provides |
| 50 | +[detailed instructions](https://github.com/Field-Robotics-Lab/dave/wiki/Install-on-Windows-using-WSL2) |
| 51 | +to setup WSL and install Gazebo together with ROS Noetic using Ubuntu Linux |
| 52 | +installed on Windows. ROS installation can be avoided and just follow |
| 53 | +instructions until the point of installing ROS Noetic packages and |
| 54 | +use apt to install `libgazebo11-dev`. |
0 commit comments