Skip to content

Commit 8a7312d

Browse files
committed
update readme & version to 0.4
1 parent aadcebb commit 8a7312d

File tree

2 files changed

+51
-9
lines changed

2 files changed

+51
-9
lines changed

README.md

Lines changed: 50 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,63 @@
11
# JBWAPI
2-
Pure Java [bwapi](https://github.com/bwapi/bwapi) client (4.2.0) implementation backed by [N00byEdge](https://github.com/N00byEdge)'s [JavaBWAPIBackend](https://github.com/N00byEdge/JavaBWAPIBackend).
2+
Pure Java [bwapi](https://github.com/bwapi/bwapi) client (4.2.0) implementation backed by [N00byEdge](https://github.com/N00byEdge)'s [JavaBWAPIBackend](https://github.com/N00byEdge/JavaBWAPIBackend) idea and automated by [Bytekeeper](https://github.com/Bytekeeper).
33

44
Also contains the pure Java BWEM implementation from [BWAPI4J](https://github.com/OpenBW/BWAPI4J).
55

6-
**WORK IN PROGRESS**
7-
8-
If you currently need a Java API for bot development, please use the much more modern and stable [BWAPI4J](https://github.com/OpenBW/BWAPI4J).
9-
10-
If you find any bugs please create an issue.
11-
126
### goals
13-
Have a similar (java) interface to BWMirror to make porting bwmirror bots easy without all the DLL and JNI hassle and overhead.
7+
Have a similar (Java) interface to BWMirror to make porting BWMirror bots easy without all the DLL and JNI hassle and overhead.
148

159
### advantages
1610
- no dependency on external DLL's
1711
- no type marshalling
1812
- fast (citation needed)
13+
- BWEM instead of BWTA as map analyser
14+
15+
### warnings
16+
- JBWAPI by default has Lateny Compensation disabled (and at the moment has no LatCom at all).
17+
- A fake BWTA is provided for easier porting, but it translates BWTA calls to their respective BWEM calls, so specific Regions/Chokepoints etc. may differ.
18+
19+
### usage
20+
**maven**
21+
22+
Add JitPack as a repository
23+
```
24+
<repositories>
25+
<repository>
26+
<id>jitpack.io</id>
27+
<url>https://jitpack.io</url>
28+
</repository>
29+
</repositories>
30+
```
31+
Add JBWAPI as a dependecy
32+
```
33+
<dependency>
34+
<groupId>com.github.JasperGeurtz</groupId>
35+
<artifactId>JBWAPI</artifactId>
36+
<version>0.3</version>
37+
</dependency>
38+
```
39+
40+
**gradle**
41+
42+
Add JitPack as a repository
43+
```
44+
allprojects {
45+
repositories {
46+
...
47+
maven { url 'https://jitpack.io' }
48+
}
49+
}
50+
```
51+
Add JBWAPI as a dependecy
52+
```
53+
dependencies {
54+
implementation 'com.github.JasperGeurtz:JBWAPI:0.3'
55+
}
56+
```
57+
58+
**jar**
59+
60+
Alternatively add the latest .jar from the [releases](https://github.com/JasperGeurtz/JBWAPI/releases) page to your project.
1961

2062
### compilation
2163
`mvnw.cmd package`

pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
<groupId>jbwapi</groupId>
88
<artifactId>jbwapi</artifactId>
9-
<version>0.3</version>
9+
<version>0.4</version>
1010

1111
<properties>
1212
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

0 commit comments

Comments
 (0)