General documentation for the PacketWorld Application

This project contains code for the PacketWorld Application, a simple Multi-agent framework to develop and evaluate pickup and delivery problems with.

Project structure

The project consists of two main parts: (1) the source code and (2) configuration files.

The source code is located under the src directory. In the source code you can find 6 main packages:

• agent: Implementations of different agent behaviours and behaviour changes.
• environment: Code related to the environment as well as definitions for worlds in the applications.
• gui: Code related to the Graphical User Interface.
• support: Classes which support the functionality of the application.
• synchronizer: Classes used to realize synchronization in the application.
• util: General purpose classes and functions used within the project.

Configuration files can be found in the configfiles directory. A distinction is made between behaviours and environments. A behaviour configuration file describes the different behaviour states an agent can have, and how an agent can transition between these states.

An environment configuration file describes an environment in which the selected implementation is evaluated. The environment contains information about agents, packets, energy stations, etc.

Running the code

The project uses Apache Maven as a build framework. To compile the code, simply run the following command:

mvn compile

To run the code we use the maven exec plugin. The plugin can be invoked as follows:

mvn exec:java

Finally, if desired, you can clear previously built source files with the following command:

mvn clean

Final notes

To quickly get started, make sure to take a look at the example implementation provided in the configuration file configfiles/behaviours/wander.txt and the java source file src/main/java/agent/behaviour/wander/Wander.java.

We provided solutions for all three parts of the assignment. The behaviour for part 1 is called autonomous-behaviour (for worlds basic-) The optimised behaviour for part 1 is called autonomous-behaviour-optimized (for worlds basic-) The behaviour for part 2 is called energy-constrained (for worlds energy-1 and energy-2) The behaviour for part 3 is called colored (for the task-delegation world)

It is not necessary to manually edit environment configuration files if you would like to test different scenarios than the ones already provided. Simply choose the environment editor in the main menu of the application to edit or create new environments to test your implementation in.