Home First-Step Tutorials IDE Integration
Integrate Agent.GUI in your IDE Print option in slimbox / lytebox? (info) E-mail

Developing your agent project together with Agent.GUI will require testing your developments within Agent.GUI. For this and other reasons Agent.GUI has to be integrated into your IDE-project. Since Agent.GUI not only allows you to integrated finished or packed JAVA jar-files, the cycle between development and testing can be shorten and configured quite easy, which will (should) accelerate your developments.

It is important to understand that we use the term “project” at two points and that these are two different things (or projects). One project is located in your IDE (e. g. Eclipse) the other project is located in the Agent.GUI-toolkit or application window.

Step by Step for Eclipse

1. Create a new JAVA project in your IDE.

2. Create a folder lib and copy the whole Agent.GUI folder to it; for example after extracting the downloaded executable version.

3. Navigate to “Project Properties” (context menu or ALT+ENTER at the project root) => “JAVA Build Path” => “Libraries”

4. Press “Add JARs” and select the file AgentGui.jar out of the projects library folder.

5. In order to execute your developments within Agent.GUI, create a new Run configuration (menu “Run” => “Run Configuration”). Select Java Application and create a new one.

6. Chose an appropriate name for the configuration and select agentgui.core.application.Application as the main class. In the Arguments tab the Agent-GUI-project that has to be opened can be configured. Do this with the parameter “-project myProjectFolder” for the program parameter. Because you have not created this project yet, we will describe this point further below.

7. Execute your Run Configuration. The Agent.GUI application window will (should) appear and is now ready for usage.


8. In Agent.GUI navigate to “Projects” and create a “New Project”.

9. Name the project as you like and press “OK”. Keep in mind the displayed Folder name. This name can be used in the Arguments tab, described above.

10. In order to understand what a project can consists of and what for developing options you have, please see the introduction tutorial.

11. Navigate to the “Configuration” => “Resources”. Here you will find the list of “External jar resources” that can be used in your Agent.GUI-project.

12. Press the “+”-button for External resources and navigate to your IDE-project of your Eclipse-Workspace. Normally a new project is that organized, that the IDE-project sources (normally located in the folder “src”) are automatically built and compiled into the “bin”-folder of the IDE-project. Just select this bin folder as an external resource (first image). Agent.GUI will integrate the stored and compiled classes by packing them temporary into a JAVA jar-file (second image) each time you open the Agent.GUI-project.

13. For now, just close and save your project and Agent.GUI.


14. Go back to Eclipse and once again open the Run Configuration. Go to the Arguments tab and insert the parameter “-project myagentproject” for the Program arguments.

15. Optionally, you can also add some parameter to the VM arguments. Here we are using for example parameters like “-Xms032m”, “-Xmx1024m” or “-XX:MaxPermSize=128M”. For further information about this topic, consult the JAVA help.


Now you are ready to develop your project with, within or for Agent.GUI. In order to test the resulting development cycle, try the following:

16. Create a package “test” in your src-folder.

17. Create a Jade agent in the package “test” by extending the class jade.core.Agent. For the moment it is enough, if we have just an empty class as shell.

18. Save that and just execute the Run Configuration of your project again. Agent.GUI appears and your Agent.GUI project should be opened directly (because of the argument definition above).

19. Navigate to “Configuration” => “Agents”. After a while and by searching your resources, the created agent will appear in the list of available project agents. By selecting this agent and pressing the “OK”-button in this tab, JADE will be started first, than the agent will be executed in a special project container.


At some point a development should have reached a level that can be used productively. In this case you can use the export functionality of your IDE in order to generate an encapsulated unit of your developments and your agency: a final Java jar-file.

20. Just export this jar-file to the specific Agent.GUI project folder and exchange the bin-folder with this jar-file as “External resource”. Now your developments can run independently within Agent.GUI.



Joomla templates by a4joomla