GZSERVER(1)

📦
version 11.10.2 · 2 versions
, in ubuntu jammy

💖 GZSERVER 💖 (section 1 of the general commands manual, bestie)

okay so welcome to the gzserver page, she's a General Commands Manual girlie and she runs the Gazebo server. that's the whole vibe. let's get into it 🫶

✨ NAME ✨

gzserver — run the Gazebo server. literally that's her job. she serves. 💅

🌸 SYNOPSIS 🌸

gzserver options world_file

🦋 DESCRIPTION 🦋

so the Gazebo server runs the simulation and handles the commandline options, starts a Master, and runs the World update and sensor generation loops. she's doing the most, always, no cap. 🧚✨

👑 OPTIONS 👑

one bullet per option, bestie, we do not skip, we do not summarise, we list all of them because that's the rule. 💖

  • -v, --version — spits out the version info. cute little flex.
  • --verbose — turns the volume UP on messages going to the terminal. more yapping, more info.
  • -h, --help — produces this help message. hello, help, hi. 🎀
  • -u, --pause — starts the server in a paused state. she's awake but she's not moving, she's just vibing.
  • --lockstep — lockstep simulation so the sensor update rates are respected. periodt, respect the rates.
  • -e, --physics arg — pick a physics engine (ode|bullet|dart|simbody). choose your fighter. ⭐
  • -p, --play arg — play a log file. press play bestie 🍓
  • -r, --record — record state data. camera's rolling, main character energy.
  • --record_encoding arg (=zlib) — the compression encoding format for log data (zlib|bz2|txt). default is zlib, she likes her files smol.
  • --record_path arg — absolute path where the state data gets stored. absolute, not relative, don't play.
  • --record_period arg (=-1) — recording period, in seconds. default is -1.
  • --record_filter arg — recording filter. supports wildcard and regular expression. fancy fr fr.
  • --record_resources — record with model meshes and materials. the whole fit, not just the face. 💅
  • --seed arg — start with a given random number seed. determinism queen 👑
  • --iters arg — number of iterations to simulate. she'll loop that many times and then she's done.
  • --minimal_comms — reduce the TCP/IP traffic output by gzserver. lowkey introvert mode, less chatter on the network.
  • -s, --server-plugin arg — load a plugin. plug it in, plug it in 🔌✨
  • -o, --profile arg — physics preset profile name, pulled from the options in the world file.

🌈 AUTHOR 🌈

Open Source Robotics Foundation. icons only, we stan. 🫶

Copyright (C) 2012 Open Source Robotics Foundation

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.

okay so that's the legal bit and it is NOT a vibe you can skip, bestie, it's literally in the page. read it. comply with it. slay responsibly. 😭

and that's the whole page!! shoutout to the March 2022 date stamp and the GZSERVER(1) source up top — she's been iconic since 2012 and she's still iconic now. bye bestie, go simulate something 🦋💖✨

📦 where this page comes from