JPCatarino / ciberRatoTools

***************************************************************************
*  CiberRato Robot Simulation Environment                                 *
*  Ciber-Rato 2021 - Universidade de Aveiro                               *
***************************************************************************

### Information

CiberRato Robot Simulation Environment simulates the movement
of robots inside a labyrinth.  Robots objective is to go from their
starting position to beacon area and then return to their start position.

http://microrato.ua.pt/

This is the source code release of CiberRato tools.

### Version Info

CiberRato tools v2.2.6.pc

simulator         version 2.2.7.rmi  - October 12, 2021
Viewer            version 2.2.7.rmi  - October 12, 2021
logplayer         version 2.2.7.rmi  - October 12, 2021
robsample         version 2.2.7.rmi  - October 12, 2021
GUISample         version 2.2.7.rmi  - October 12, 2021
jClient           version 2.2.7.rmi  - October 12, 2021

### Contents

simulator/           The simulator source code
Viewer/              The Visualizer source code
logplayer/           The logplayer source code
GUISample/           Graphical robot agent (C++) source code
robsample/           robot agent (C) source code
jClient/             robot agent (Java) source code
pClient/             robot agent (Python) source code
Labs/                examples of labyrinths used in previous competitions

README               This README file

startAll             Startup script that runs the simulator, the visualizer and 5 GUISamples
startSimViewer       Startup script that runs the simulator and the Viewer

### Operating System and Compiler

The source code was compiled with gcc/g++ - Gnu Project C/C++ Compiler
(gcc version  5.4.0) using the Qt libraries (release 4.8) on 
Ubuntu 16.04.

It is required to have the development version of Qt libraries 
release 4.x installed in the system prior to compilation.
It is also required to have qmake (or qmake-qt4) installed.

More information on Qt can be found at https://download.qt.io/archive/qt/4.8/


### Instructions on how to use this release:


To compile the CiberRato tools

        1- execute make:
 
          make

        if this does not work you may have to execute qmake (or qmake-qt4) before executing make
 
After compiling, to run the simulator, the visualizer and 3 GUISamples
 
       ./startAll
 
After compliling, to run the simulator and the Viewer
 
       ./startSimViewer
 
       Then each robot should be started manually
 
After compiling, to run the logplayer
 
       cd logplayer
       logplayer -log <logfile>
 
To run a sample individually
 
       LD_LIBRARY_PATH=../libRobSock/ ./GUISample
 
### More Information
 
    Please consult:
        http://microrato.ua.pt/
 
    or Please Contact :
        Nuno Lau
        University of Aveiro
        email: [e-mail]
 
        Artur C. Pereira
        University of Aveiro
        email: [e-mail]
 
        Andreia Melo
        University of Aveiro
        email: [e-mail]
 
        Antonio Neves
        University of Aveiro
        email: [e-mail]
 
        Joao Figueiredo
        University of Aveiro
        email: [e-mail]
 
        Miguel Rodrigues
        University of Aveiro
        email: [e-mail]
 
 Copyright (C) 2001-2021 Universidade de Aveiro