You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Pure Java [bwapi](https://github.com/bwapi/bwapi) 4.4.0 client implementation backed by [N00byEdge](https://github.com/N00byEdge)'s [JavaBWAPIBackend](https://github.com/N00byEdge/JavaBWAPIBackend) idea and automated by [Bytekeeper](https://github.com/Bytekeeper).
4
5
5
6
Also contains a modified version of the pure Java BWEM implementation from [BWAPI4J](https://github.com/OpenBW/BWAPI4J).
6
7
7
-
## goals
8
+
## Goals
9
+
8
10
- Have a similar (Java) interface to BWMirror to make porting BWMirror bots easy without all the DLL and JNI hassle and overhead.
9
-
- Stay as updated as possible with the BWAPI releases
11
+
- Stay as updated as possible with the BWAPI releases.
12
+
13
+
## Advantages
10
14
11
-
## advantages
12
-
- no dependency on external DLL's
13
-
- at least [5x](https://github.com/JavaBWAPI/JBWAPI/issues/17) faster compared to bwmirror for primitives as it directly reads the memory mapped client file. Even faster for bwapi objects as it also avoids type marshalling
14
-
- supports both 32 and 64 bit Java (e.g. [deeplearning4j](https://deeplearning4j.org/) requires 64 bit Java which bwmirror doesn't support)
15
-
- BWEM instead of BWTA as map analyser
15
+
- No dependency on external DLL's.
16
+
- At least [5x](https://github.com/JavaBWAPI/JBWAPI/issues/17) faster compared to bwmirror for primitives as it directly reads the memory mapped client file. Even faster for bwapi objects as it also avoids type marshalling
17
+
- Supports both 32 and 64 bit Java (e.g. [deeplearning4j](https://deeplearning4j.org/) requires 64 bit Java which bwmirror doesn't support).
18
+
- BWEM instead of BWTA as map analyser.
16
19
17
-
## warnings
18
-
- JBWAPI by default has Lateny Compensation disabled (and at the moment has no LatCom at all).
19
-
- 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.
20
+
## Warnings
21
+
- A fake BWTA is provided for easier porting from BWMirror, but it translates BWTA calls to their respective BWEM calls, so specific Regions/Chokepoints etc. may differ.
20
22
21
-
## usage
22
-
**maven**
23
+
## Usage
23
24
24
-
Add JitPack as a repository
25
+
**Maven**
26
+
27
+
Add JitPack as a repository:
25
28
```
26
29
<repositories>
27
30
<repository>
@@ -30,7 +33,7 @@ Add JitPack as a repository
30
33
</repository>
31
34
</repositories>
32
35
```
33
-
Add JBWAPI as a dependecy
36
+
Add JBWAPI as a dependency:
34
37
```
35
38
<dependency>
36
39
<groupId>com.github.JavaBWAPI</groupId>
@@ -39,9 +42,9 @@ Add JBWAPI as a dependecy
39
42
</dependency>
40
43
```
41
44
42
-
**gradle**
45
+
**Gradle**
43
46
44
-
Add JitPack as a repository
47
+
Add JitPack as a repository:
45
48
```
46
49
allprojects {
47
50
repositories {
@@ -50,31 +53,31 @@ allprojects {
50
53
}
51
54
}
52
55
```
53
-
Add JBWAPI as a dependency
56
+
Add JBWAPI as a dependency:
54
57
```
55
58
dependencies {
56
59
implementation 'com.github.JavaBWAPI:JBWAPI:0.8'
57
60
}
58
61
```
59
62
60
-
**jar**
63
+
**Jar**
61
64
62
65
Alternatively add the latest .jar from the [releases](https://github.com/JavaBWAPI/JBWAPI/releases) page to your project.
63
66
64
-
## compilation
67
+
## Compilation
68
+
65
69
`mvnw.cmd package`
66
70
67
71
or if you already have maven installed
68
72
69
73
`mvn package`
70
74
71
-
## documentation
75
+
## Documentation
72
76
73
77
The API documentation can be found [here](https://javabwapi.github.io/JBWAPI/).
74
78
75
79
You can also ask any further questions on the [SSCAIT Discord](https://discord.gg/DqvHsq9)
76
80
77
-
## tutorial
81
+
## Tutorial
78
82
79
83
If you are a just starting out with bot development, it might be helpful to follow the [tutorial](https://github.com/JavaBWAPI/Java-BWAPI-Tutorial/wiki)!
0 commit comments