Skip to content

Commit

Permalink
Refreshed docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Geolykt committed May 16, 2021
1 parent 08ef68c commit 7af6afc
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 6 deletions.
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,21 @@ that may arise (for example overwriting static methods) via our Event API.
## Building

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

./gradlew publishToMavenLocal

or you can use the maven package `de.geolykt:starloader-api:CURRENT_VERSION_HERE`
at `https://geolykt.de/maven`

## Which version for what?

- 3cffffb5bd0f208712deadd98e0efeb2fa38251e (N/A) -> Galimulator 4.7
- 08ef68c9883a076279bee8aa9e7e09937312852c (v1.2) -> Galimulator 4.8 + 4.8-beta.2

## Existing Extensions making use of this API (that I know of)

- [Datadriven-specials](https://github.com/Geolykt/Datadriven-specials)

## Licensing and decompiled code

Expand Down Expand Up @@ -115,7 +123,7 @@ The listener can then be registered via

EventManager.registerListener(new StarloaderDemoListener(logger));

however it should be noted that you cannot register the same listener multiple
however it should be noted that you cannot register the same listener instance multiple
times, although this should rearely be an issue for you. It should also be noted
that the event API is very fragile at the moment and you should avoid
registering or unregistering listeners an incredible amount of times as that
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -95,19 +95,21 @@ public interface ActiveEmpire extends Empire, Metadatable {
* Obtains the wrapper representation of the Alliance the empire currently is
* in.
*
* @return The Alliance the empire currently is in, or null
* @return The Alliance the empire currently is in, or null if not applicable
*/
public @Nullable Alliance getAlliance();

/**
* Obtains the X coordinate of the capital star assigned to this empire.
* This almost always points to a star that is owned by this empire
*
* @return The X coordinate of the capital
*/
public float getCapitalX();

/**
* Obtains the Y coordinate of the capital star assigned to this empire.
* This almost always points to a star that is owned by this empire
*
* @return The Y coordinate of the capital
*/
Expand Down

0 comments on commit 7af6afc

Please sign in to comment.