aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCamil Staps2015-02-18 22:44:48 +0100
committerCamil Staps2015-02-18 22:44:48 +0100
commitac67a69dc34a4da11341a0f4f5ab406d3ca16849 (patch)
tree0c009cfd4aafbee933559981e1fec1fbb38c8605
parentMerge branch 'master' of https://github.com/camilstaps/Botleagues (diff)
Added engine enstructions in the readme
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
index ae53ae0..24f44d9 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,19 @@
# Botleagues
This is a work in progress. Please go away.
+
+## Backyard
+
+### Java engine (java)
+
+In the java folder there's the java engine or GameController. It lets bots compete against each other.
+
+To run, cd into `/backyard/java/trunk/GameController/bin` and do:
+
+ java nl.camilstaps.botleagues.MyGame /path/to/bot1/package.mybot.MyBot /path/to/bot2/package.mybot.MyBot ...
+
+For example, for the example bot in `/backyard/java-bot/trunk`, that would mean:
+
+ java nl.camilstaps.botleagues.MyGame ../../../../java-bot/trunk/bin/nl.camilstaps.botleagues.bot.BotStarter ../../../../java-bot/trunk/bin/nl.camilstaps.botleagues.bot.BotStarter
+
+Note that you can add as many bots as you want. Also, you can add multiple bots of the same type (like in the example). That's not really a feature, but it is useful for debugging. \ No newline at end of file