Welcome! The purpose of this repository is to guide the testing of various functionalities of Gazebo Jetty prior to official release. In other words, welcome to the Tutorial Party!
Note
Everyone, all contributions are welcome!
Jetty on Ubuntu is only supported on the Noble version of Ubuntu (24.04). If you don't have this platform, there are docker images ready to use.
We recommend installing
rocker for
running the docker image since it handles X11 and GPU configurations for you.
Once installed, you can run
rocker --x11 -- ghcr.io/gazebosim/gz-jetty:mainto start bash inside a gz-jetty container. Then you can run any of the
Gazebo commands in the tutorial e.g., gz sim -v4 shapes.sdf. Alternatively,
you can run Gazebo directly through a rocker one-liner.
rocker --x11 -- ghcr.io/gazebosim/gz-jetty:main gz sim -v4 shapes.sdfTip
If you have an NVIDIA graphics card, you'll need to add --nvidia to the rocker command. See rocker README.
Tip
If you have an Intel integrated graphics card, you'll need to add --devices /dev/dri to the rocker command.
See rocker README.
The first step is to register on our sign up form so we can map your Github username to your email so we can send you instructions on getting your free swag if you are in the top 20.
Note
More detailed instructions are available on our Discourse post
The Issues page has several tickets each containing specific instructions to test a particular functionality of Gazebo Jetty. Each ticket will have the following sections:
- Setup: Details on the desired hardware and software setup for this test. The following combinations are possible.
- BuildType:
binary: pre-built Debian packages from the apt repositorysource: building your own workspace from source
- Os:
Ubuntu Noble,WindowsandMacOS
- BuildType:
- Links: Any relevant references for this test.
- Checks: A list of functionalities to validate.
To contribute, first ensure if you have the relevant setup as described in the ticket. If you don't have the setup, you can find the installation instructions at https://gazebosim.org/docs/jetty/install. Next, comment on the ticket indicating your interest so that others will know you are working on it. Then follow the instructions to perform the necessary checks.
All checks passed?
Great! Attaching your terminal output (codeblock comment or gist file) or a screenshot as a form of verification is greatly appreciated.
At the end of your comment, add a specially formatted text, [status: passed] to let us know that it passed.
Encountered failures?
If one or more checks fail, please provide the error message in a codeblock comment or as a gist file attachment.
At the end of your comment, add a specially formatted text, [status: failed] to let us know that it failed.
Binaries for the prereleases are not available for Windows, therefore, it is necessary to build all Gazebo packages from source following the Install from source instructions.
With the introduction of standalone executables, you should now be to run gz sim without starting the server and the GUI separately.
If you would like to test the functionality of any other package or extend the capabilities tested above, please reach out to us on Discord in the in the #gazebo-help channel.
Questions related to testing may be posted on Discord in the in the #gazebo-help channel. Kindly ensure to link the relevant issue ticket when starting a new discussion.
buildType: Binary,os: Ubuntu NoblebuildType: Binary,os: MacOSbuildType: Source,os: Ubuntu NoblebuildType: Source,os: MacOSbuildType: Source,os: Windowsos: Ubuntu Nobleos: MacOSos: Windowsos: Any
Here are some things to know about Github search:
- You can filter available results with a label by typing
label:my-label. And it works for multiple labels:label:my-label-1 label:my-label-2. - If your label has a space in it, you can put the label in quotes:
label:"my label". - To show results that don't have a label, use a minus sign:
-label:no-results-with-this-label.