Example project showing how to develop robocode robots using the Maven build system. To install this package:
- Install robocode
Install both the robocode basic distribution and the robocode testing plugin. Both of these setup.jar files are available for version 1.7.4.4 here.
Be sure to run the system manually from the command line to ensure that you have the appropriate Java installed and so forth.
- Install Maven
Start by following the directions on installing Maven.
Be sure to run mvn --version to verify that it is correctly installed. This package has been tested using Maven 3.0.4.
- Download this robocode-kkc-pikachu package
For those who do not know about git, the easiest way is to click the "ZIP" button at the top of this page, which will download the latest version of this repository as a .zip file.
For those who know about git, you will want to clone it.
- Install robocode jar files into your local Maven repository
Robocode binaries are not provided as part of public Maven repositories, so the next step is to install the seven jar files needed for compilation and testing into your local repository. You accomplish this by changing directory to robocode/libs and executing the following seven commands:
mvn install:install-file -Dfile=robocode.jar -DartifactId=robocode -DgroupId=net.sourceforge.robocode -Dversion=1.7.4.4 -Dpackaging=jar -DgeneratePom=true
mvn install:install-file -Dfile=robocode.testing.jar -DartifactId=robocode.testing -DgroupId=net.sourceforge.robocode -Dversion=1.7.4.4 -Dpackaging=jar -DgeneratePom=true
mvn install:install-file -Dfile=robocode.battle-1.7.4.4.jar -DartifactId=robocode.battle -DgroupId=net.sourceforge.robocode -Dversion=1.7.4.4 -Dpackaging=jar -DgeneratePom=true
mvn install:install-file -Dfile=robocode.core-1.7.4.4.jar -DartifactId=robocode.core -DgroupId=net.sourceforge.robocode -Dversion=1.7.4.4 -Dpackaging=jar -DgeneratePom=true
mvn install:install-file -Dfile=robocode.host-1.7.4.4.jar -DartifactId=robocode.host -DgroupId=net.sourceforge.robocode -Dversion=1.7.4.4 -Dpackaging=jar -DgeneratePom=true
mvn install:install-file -Dfile=robocode.repository-1.7.4.4.jar -DartifactId=robocode.repository -DgroupId=net.sourceforge.robocode -Dversion=1.7.4.4 -Dpackaging=jar -DgeneratePom=true
mvn install:install-file -Dfile=picocontainer-2.14.2.jar -DgroupId=net.sourceforge.robocode -DartifactId=picocontainer -Dversion=2.14.2 -Dpackaging=jar -DgeneratePom=true
A typical output from one of these commands might be:
[~/robocode/libs]-> mvn install:install-file -Dfile=robocode.jar -DartifactId=robocode -DgroupId=net.sourceforge.robocode -Dversion=1.7.4.4 -Dpackaging=jar -DgeneratePom=true
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building Maven Stub Project (No POM) 1
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] --- maven-install-plugin:2.3.1:install-file (default-cli) @ standalone-pom ---
[INFO] Installing C:/robocode/libs/robocode.jar to C:/robocde/.m2/repository/net/sourceforge/robocode/robocode/1.7.4.4/robocode-1.7.4.4.jar
[INFO] Installing /var/folders/__/qq1ydtj56n3fxtccjh9k6dk80000gn/T/mvninstall1027288217865601684.pom to C:/robocode/.m2/repository/net/sourceforge/robocode/robocode/1.7.4.4/robocode-1.7.4.4.pom
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 0.454s
[INFO] Finished at: Mon Jan 28 14:28:31 HST 2013
[INFO] Final Memory: 7M/309M
[INFO] ------------------------------------------------------------------------
[~/robocode/libs]->
- Build and test the system
Now that everything is installed, build and test the system. You use the standard Maven 'test' target. There are two special aspects of this process of which you should be aware.
First, the RobotTestBed class and the Maven POM file requires the definition of a System Property called "robocode.home", which should point to the directory where Robocode is installed. To define this property and its value, use the -Drobocode.home=robocodeHomeDirectory command line option, as illustrated below.
Second, the Robocode runtime system needs your newly developed robot to be known to the system during testing. To accomplish this, the pom.xml file defines a "copy-resource" goal that copies your robot binary from the target/classes directory to the robocode.home/robots directory after completing compilation. Take a look at the pom.xml file to see how this is done.
Note that this approach does not remove these files from the robocode installation after the testing process is done.
Here is an example of the command line used to build and test the system, along with the output.
[~/Users/Kellie/github/robocode-kkc-pikachu]-> mvn -Drobocode.home=C:\robocode test
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building pikachu 1.0-SNAPSHOT
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] --- maven-resources-plugin:2.6:resources (default-resources) @ pikachu ---
[INFO] Using 'UTF-8' encoding to copy filtered resources.
[INFO] skip non existing resourceDirectory /Users/Kellie/github/robocode-kkc-pikachu/src/main/resources
[INFO]
[INFO] --- maven-compiler-plugin:2.3.2:compile (default-compile) @ pikachu ---
[INFO] Compiling 1 source file to /Users/Kellie/github/robocode-kkc-pikachu/target/classes
[INFO]
[INFO] --- maven-resources-plugin:2.6:copy-resources (copy-resources) @ pikachu ---
[INFO] Using 'UTF-8' encoding to copy filtered resources.
[INFO] Copying 1 resource
[INFO]
[INFO] --- maven-resources-plugin:2.6:testResources (default-testResources) @ pikachu---
[INFO] Using 'UTF-8' encoding to copy filtered resources.
[INFO] skip non existing resourceDirectory /Users/Kellie/github/robocode-kkc-pikachu/src/test/resources
[INFO]
[INFO] --- maven-compiler-plugin:2.3.2:testCompile (default-testCompile) @ pikachu ---
[INFO] Compiling 3 source files to /Users/Kellie/github/robocode-kkc-pikachu/target/test-classes
[INFO]
[INFO] --- maven-surefire-plugin:2.10:test (default-test) @ pikachu ---
[INFO] Surefire report directory: /Users/Kellie/github/robocode-kkc-pikachu/target/surefire-reports
-------------------------------------------------------
T E S T S
-------------------------------------------------------
Running kkc.TestPikachuFiring
Loaded net.sf.robocode.api
Loaded net.sf.robocode.core
Loaded net.sf.robocode.battle
Loaded net.sf.robocode.repository
Loaded net.sf.robocode.host
Preparing battle...
----------------------
Round 1 initializing..
Let the games begin!
..
Round 1 cleaning up.
(test output deleted)
Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 1.924 sec
Running kkc.TestPikachuMovement
Preparing battle...
----------------------
Round 1 initializing..
Let the games begin!
..
Round 1 cleaning up.
(test output deleted)
Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.693 sec
Running kkc.TestPikachuSittingDuck
Preparing battle...
----------------------
Round 1 initializing..
Let the games begin!
..
Round 1 cleaning up.
(test output deleted)
Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.62 sec
Results :
Tests run: 3, Failures: 0, Errors: 0, Skipped: 0
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 5.346s
[INFO] Finished at: Mon Jan 28 14:44:59 HST 2013
[INFO] Final Memory: 16M/309M
[INFO] ------------------------------------------------------------------------To remove the robot from the robocode installation, invoke the clean target with the -D property:
[~/Users/Kellie/github/robocode-kkc-pikachu]-> mvn -Drobocode.home=C:\robocode clean
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building pikachu 1.0-SNAPSHOT
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] --- maven-clean-plugin:2.5:clean (default-clean) @ pikachu ---
[INFO] Deleting /Users/Kellie/github/robocode-kkc-pikachu/target
[INFO] Deleting /Users/Kellie/robocode/robots/kkc (includes = [], excludes = [])
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 0.305s
[INFO] Finished at: Tue Jan 29 07:00:17 HST 2013
[INFO] Final Memory: 6M/309M
[INFO] ------------------------------------------------------------------------- Install robocode-kkc-pikachu into Eclipse
Now that the system is running from the command line, you'll want to also run it from Eclipse. To do so, bring up Eclipse, and select File | Import | Maven | Existing Maven Projects, and then complete the dialog boxes to import your project. Eclipse will read the POM file in order to determine the libraries to include on the build path.
To run the kkc.pikachu robot within Eclipse, you must configure Eclipse and Robocode in the normal way:
- In the Run configuration, change the working directory to your Robocode installation directory.
- In the Robocode window, select Options | Preferences | Development Options to add the target/classes directory so that Robocode will see your robot.
To run the test cases, edit the Run configuration for each test to include -Drobocode.home=robocodeHomeDirectory as a VM argument.
- Use this project as a template for your own development
Once you have completed the above steps, you are ready to use this project for your own development. To do this:
- Duplicate the robocode-kkc-pikachu directory, and rename it with your own robot's name.
- Edit the POM file, and change the top lines to correspond to your own robot name.
- Import the project (as a Maven project) into Eclipse.
- In Eclipse, select the project (robocode-kkc-pikachu), then right-click and Refactor | Rename to rename the project to your own robot name.