The file README_ORIGINAL.md contains all information related to the Robocar World Championship and the research platform it uses. This file focuses on making things work to participate in the Championship.

In the latest commit, in order to untrack binary and local files we've changed the .gitignore and the binary files now have the .out ending. So, please pay attention to the fact that you may execute the following files and make targets from now on:

• traffic.out
• smartcity.out
• sampleshmclient.out
• samplemyshmclient.out

Command line arguments for traffic.out are no longer available. A configuration file in JSON format must be specified.

You should start with checking whether you have all the dependencies required, please refer to the README_ORIGINAL.md file.

From now on, we assume that you were able to make the contents of rcemu and build the .jar from rcwin.

After acquiring the right .osm file, the first thing you start should be the smartcity, somehow like this:

 rcemu$ src/smartcity.out --osm=../berlin.osm --city=Berlin --shm=BerlinSharedMemory --node2gps=../berlin-lmap.txt

After the --osm you must the .osm file to run the simulation on. Make sure you specify the same shm option from now on to all applications.

We have our playground, let's get some toys! Or something that can handle our toys, that's what traffic.out is:

rcemu$ src/traffic.out

IMPORTANT: The default port is 10007. You can change it using the --port option!

The default configuration file, traffic.json is located in the robocar-emulator/justine/rcemu directory. You may change it using the --config option.

At the moment we are blind, so let's just visualise what's happening:

rcwin$ java -jar target/site/justine-rcwin-0.0.16-jar-with-dependencies.jar ../berlin-lmap.txt

As you've probably noted, the input file given to the Car Window must be the same as the output file of the smartcity.

Also, don't forget to build the jar file this way:

rcwin$ mvn clean compile package site assembly:assembly

And here it comes! The fun part, adding cop cars and the gangsters:

rcemu$ src/samplemyshmclient.out --shm=BerlinSharedMemory --team=BerlinPolice

The default port is 10007.

Gangsters:

$ (sleep 1; echo "<init 0 50 g>"; sleep 1)|telnet localhost 10007

NOTE: You may replace 50 with the number of gangsters you want to add to the simulation.

There are some other options for all the applications listed above, so here they are:

--version     -> produce version message
--help -h     -> produce help message
--config -c   -> configuration file in JSON format. Default: "traffic.json"

--version     -> produce version message
--help -h     -> produce help message
--verbose -v  -> verbose mode
--shm -s      -> shared memory segment name
--port -p     -> the TCP port that the traffic server is listening on to allow agents to communicate with the traffic simulation, default is 10007
--team -t     -> team name, default is Police
--cops -c     -> the number of cop cars, default is 10

--playlog -> the log file to replay

If you'd like to replay a log file, there's no need to start the other processes, just the Car Window with the --playlog=x option where x denotes a valid log file. If you've been running the simulation with full logging enabled, then the routes of the cop cars can be examined during the replay.

From now on, traffic.out uses a JSON-format configuration file instead of the huge amount of command line parameters.

The default configuration file is fully specified. You may specify less settings, since for the unspecified settings the default values will be used. Unknown settings will be ignored without any note or warning.

Even if you do not specify any settings, an empty configuration file must be given to the traffic.out!