iv4XR Demo

This is a demo version 2.5.x for the iv4XR Agent-based Testing Framework, demonstrating that iv4XR test agents can control a game called Lab Recruits to perform testing tasks. The game executable is no longer included in the repository; you need to build it yourself from its repository.

You will need correct versions of the iv4XR Framework and the game Lab Recruits, which are compatible with this version of Demo.

• Which version of Lab Recruits game should be used? Demo version 2.3.x should use LR-game version 2.1.x (e.g. 2.1.5). This version has no monster. Demo version 2.4.x can use LR-game 2.3.1 (with monsters, and can take screenshots). Demo version 2.5.x should use LR-game 2.3.2 (include important bug fixes).

• Which version of APLIB (aka the iv4XR Framework-core) is needed? Check the pom.xml of this Demo project.

  

What is the demo? A set of JUnit test classes demonstrating how iv4xr test agents are used to implement a number of testing tasks for the game Lab Recruits. These classes are located in src/test/java/agents/demo. You can simply run them, or modify them yourself. When you run them you don't usually see anything because the tests run pretty fast. You can insert pause-points yourself (e.g. using console-read).

The Lab Recruits Game. It is a 3D game (a screenshot is shown above) written for the purpose of testing AI (like the AI of our iv4xr test agents). It features custom level that you can define yourself through a CSV file. Keep in mind that the game is also work in progress. More about this game can be found in its repository.

Deploying the demo

Build an executable of the Lab Recruits. To do this you can clone or download the source code of this game. Open the project in Unity (note the specific version it needs) and build the executable from there.

• Windows: put the produced files including LabRecruits.exe in gym/Windows/bin.
• Mac: put the produced LabRecruits.app in gym/Mac/bin.
• Linux: put the produced files including LabRecruits in gym/Linux/bin.

The demo classes are in src/test/java/agents/demo. The demos are by default non-visual (you don't literally see the game runs). Set the variable TestSettings.USE_GRAPHICS in the corresponding demo-class to true if you want it to be visual.

• Eclipse

  This will allow you to run/modify/rerun the demo classes. Import the project into Eclipse as a maven project. The demo classes are in src/test/java/agents/demo. You can run them as junit tests.

• Maven

  This is if you just want to check that the project builds and that all its tests pass. Just do mvn compile and mvn test at the project root. Since the demo-classes are actually test-classes you can also use Maven to run them individually, e.g.:

  mvn test -Dtest=agents.demo.R8FireTest

  See above how to turn on visualization.

Other documentations

• Basic interface to control Lab Recruits](./docs/BasicInterface.md)
• World Object Model
• Where to find goals and tactics

What's in the package

• ./src the source files. It follows Maven's convention, so the root of the source files is in src/main/java and the root of tests' source files is in src/test/java.
• ./src/test/resources/levels contain sample level definitions for Lab Recruits.

Contributors

Computer Science students from Utrecht University: Adam Smits, August van Casteren, Bram Smit, Frank Hoogmoed, Jacco van Mourik, Jesse van de Berg, Maurin Voshol, Menno Klunder, Stijn Hinlopen, Tom Tanis. Others: Wishnu Prasetya, Naraenda Prasetya.