Skip to content

Latest commit

 

History

History
134 lines (96 loc) · 5.11 KB

README.md

File metadata and controls

134 lines (96 loc) · 5.11 KB
Raw

RoboCup Soccer Simulator Monitor

GitHub license

Logo

RoboCup Soccer Simulator Monitor (rcssmonitor) is used to view the simulation as it takes place by connecting to the RoboCup Soccer Simulator Server (rcssserver) or to view the playback of a simulation by loading game log files.

⚽ Quick Start

rcssmonitor is implemented by C++14 and depends Qt5. At first, related tools have to be installed on the system. In the case of Ubuntu 22.04, execute the following command:

sudo apt install build-essential automake autoconf libtool libboost-all-dev qtbase5-dev qt5-qmake libfontconfig1-dev libaudio-dev libxt-dev libglib2.0-dev libxi-dev libxrender-dev

In the case of Ubuntu 16.04 - 20.04, execute the following command:

sudo apt install build-essential qt5-default libfontconfig1-dev libaudio-dev libxt-dev libglib2.0-dev libxi-dev libxrender-dev

Then, clone the repository. From its directory, execute commands:

./bootstrap
./configure
make

Alternatively you can download the tarball from the releases section, extract it and run from its contents:

tar xzvfp rcssmonitor-x.x.x.tar.gz
cd rcssmonitor-x.x.x
./configure
make

This will built the necessary binaries to get you up and running. rcssmonitor/src/rcssmonitor will be the binary for the monitor.

The version 16.0.0 or later support CMake. If CMake is prefered or problems with the above procedure, try the following commands:

mkdir build
cd build
cmake ..
make

In this case, rcssmonitor/build/rcssmonitor will be the binary for the monitor.

🛠️ Configuring & Building

Before building rcssmonitor you will need to run the configure script located in the root of the distribution directory.

The default configuration will set up to install the monitor components in the following location:

/usr/local/bin for the executables

You may need administrator privileges to install the monitor into the default location. This locations can be modified by using configure's --prefix=DIR and related options. See configure --help for more details.

./configure --prefix=YOUR_INSTALLATION_DIR

The monitor has several features that can be enabled or disabled at configure time by using the --enable-FEATURE[=ARG] or --disable-FEATURE parameters to configure. --disable-FEATURE is equivalent to --enable-FEATURE=no and --enable-FEATURE is equivlant to --enable-FEATURE=yes. The only valid values for ARG are yes and no.

Once you have successfully configured the monitor, simply run make to build the sources.

If CMake is chosen, ccmake command is available for the configuration:

cd build
ccmake ..

📦 Installing

When you have completed building the monitor, it's components can be installed into their default locations or the locations specified during configuring by running

make install

Depending on where you are installing the monitor, you may need special permissions.

If you install the monitor under the location you specified, you may need to set the environment variable PATH. Otherwise, you have to enter the full path to the executable when you execute the monitor. In the case of Linux system, the recommended way is to add the following line at the bottom of ~/.profile:

PATH="YOUR_INSTALLATION_DIR/bin:$PATH"

Then, log out and log in again.

You may also need to set the library path before executing the monitor. In most Linux systems, you can modify the library path by editing /etc/ld.so.conf or the environment variable LD_LIBRARY_PATH. The recommended way is to use LD_LIBRARY_PATH because all users can edit this variable without extra privileges. Add the following line at the bottom of ~/.bashrc:

LD_LIBRARY_PATH="YOUR_INSTALLATION_DIR/lib:$LD_LIBRARY_PATH"
export LD_LIBRARY_PATH

Then, open a new terminal.

🗑️ Uninstalling

In the case of autotools, the monitor can also be easily removed by entering the distribution directory and running

make uninstall

This will remove all the files that where installed, but not any directories that were created during the installation process.

In the case of CMake, find install_manifest.txt under the build directory, then execute:

xargs rm < install_manifest.txt

⏯️ Using the Monitor

To start the monitor either type

./rcssmonitor

from the directory containing the executable or

rcssmonitor

If you invoke rcssmonitor with --help option, available options are displayed in your console.

📨 Contributing

For bug reports, feature requests and latest updates, please goto https://github.com/rcsoccersim/rcssmonitor and open an issue or a pull request.

The RoboCup Soccer Server Maintainance Group