Skip to content

Commit 7af6afc

Browse files
committed
Refreshed docs
1 parent 08ef68c commit 7af6afc

2 files changed

Lines changed: 16 additions & 6 deletions

File tree

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,21 @@ that may arise (for example overwriting static methods) via our Event API.
2020
## Building
2121

2222
The project can be built via gradle. This can be easily done via `./gradlew build`
23-
on most systems, however the [Starloader](https://github.com/Geolykt/Starloader) project must be
24-
built and published to mavenLocal as well as the galimulator jar needs to be present
25-
at the project root under `galimulator-desktop.jar`. To use the API within your
26-
project you need to publish the jar via
23+
on most systems. To use the API within your project you need to publish the jar via
2724

2825
./gradlew publishToMavenLocal
2926

27+
or you can use the maven package `de.geolykt:starloader-api:CURRENT_VERSION_HERE`
28+
at `https://geolykt.de/maven`
29+
30+
## Which version for what?
31+
32+
- 3cffffb5bd0f208712deadd98e0efeb2fa38251e (N/A) -> Galimulator 4.7
33+
- 08ef68c9883a076279bee8aa9e7e09937312852c (v1.2) -> Galimulator 4.8 + 4.8-beta.2
34+
35+
## Existing Extensions making use of this API (that I know of)
36+
37+
- [Datadriven-specials](https://github.com/Geolykt/Datadriven-specials)
3038

3139
## Licensing and decompiled code
3240

@@ -115,7 +123,7 @@ The listener can then be registered via
115123

116124
EventManager.registerListener(new StarloaderDemoListener(logger));
117125

118-
however it should be noted that you cannot register the same listener multiple
126+
however it should be noted that you cannot register the same listener instance multiple
119127
times, although this should rearely be an issue for you. It should also be noted
120128
that the event API is very fragile at the moment and you should avoid
121129
registering or unregistering listeners an incredible amount of times as that

src/main/java/de/geolykt/starloader/api/empire/ActiveEmpire.java

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,19 +95,21 @@ public interface ActiveEmpire extends Empire, Metadatable {
9595
* Obtains the wrapper representation of the Alliance the empire currently is
9696
* in.
9797
*
98-
* @return The Alliance the empire currently is in, or null
98+
* @return The Alliance the empire currently is in, or null if not applicable
9999
*/
100100
public @Nullable Alliance getAlliance();
101101

102102
/**
103103
* Obtains the X coordinate of the capital star assigned to this empire.
104+
* This almost always points to a star that is owned by this empire
104105
*
105106
* @return The X coordinate of the capital
106107
*/
107108
public float getCapitalX();
108109

109110
/**
110111
* Obtains the Y coordinate of the capital star assigned to this empire.
112+
* This almost always points to a star that is owned by this empire
111113
*
112114
* @return The Y coordinate of the capital
113115
*/

0 commit comments

Comments
 (0)