gered/BWMirror-Generator
Archived
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases 3 Wiki Activity

update README.md

Browse source
This commit is contained in:
Gered 2017-04-12 21:51:38 -04:00
parent c3053f5c7b
commit 6b810bcd2e
1 changed files with 5 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -1,6 +1,8 @@
# BWMirror API # BWMirror API
This is the BWMirror Generator which is used to generate the Java classes that will mirror the ones found in BWAPI and automatically generate the C++ JNI glue that makes it all work. A Java API for [BWAPI](http://bwapi.github.io/) and [BWTA2](https://bitbucket.org/auriarte/bwta2) allowing you to create Starcraft: Broodwar AIs using Java.
This repository contains a "generator" project which is used to programmatically generate the Java classes that will mirror the ones found in BWAPI/BWTA2 and automatically generate the C++ JNI glue that makes it all work together. It's fairly involved, but if you're just interested in writing a Starcraft AI in Java, then you don't need to worry about the details too much!
## Usage ## Usage
@ -34,7 +36,7 @@ public class ExampleBot {
} }
@Override @Override
public void onEnd(boolean b) { public void onEnd(boolean isWinner) {
System.out.println("Game has ended"); System.out.println("Game has ended");
} }
@ -66,7 +68,7 @@ public class ExampleBot {
## Building BWMirror ## Building BWMirror
This is a fair bit involved due to the nature of the project. If you want to contribute to BWMirror, read on. This is a fair bit involved due to the nature of the project. If you want to contribute to BWMirror, read on. If you are only interested in writing a Starcraft AI, then you can stop here.
### Installing Pre-Requisites ### Installing Pre-Requisites