diff --git a/README.md b/README.md index 81e0a72..043ab19 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,7 @@ From nothing to a server that serves a stored world, in five steps. Step 4 needs ### 1. Declare the dependency + ```kotlin repositories { mavenCentral() @@ -39,7 +40,7 @@ repositories { dependencies { // One version for all three, so they cannot drift into a combination nobody tested. - implementation(platform("net.onelitefeather:falco-bom:3.0.0")) + implementation(platform("net.onelitefeather:falco-bom:3.0.1")) implementation("net.onelitefeather:falco-anvil") // reading and writing Anvil worlds implementation("net.onelitefeather:falco-light") // block and sky light @@ -52,6 +53,7 @@ dependencies { implementation("net.minestom:minestom:") } ``` + Take only the modules you need — a platform constrains a version for each, it does not pull one in. Steps 2 to 4 below use the first two; step 5 uses all three. Individual coordinates, Maven and diff --git a/docs/how-to/add-falco-to-your-build.md b/docs/how-to/add-falco-to-your-build.md index 94d237a..884b9b1 100644 --- a/docs/how-to/add-falco-to-your-build.md +++ b/docs/how-to/add-falco-to-your-build.md @@ -19,6 +19,8 @@ snapshot endpoints are both public. 2. Import `falco-bom` as a platform and declare the modules you need without versions: + + ```kotlin dependencies { implementation(platform("net.onelitefeather:falco-bom:3.0.1")) @@ -30,6 +32,8 @@ snapshot endpoints are both public. } ``` + + Take only the modules you need. The platform constrains a version for `falco-anvil`, `falco-light` and `falco-instance`; it does not pull in one you did not declare, and it does not cover `falco-migration`. @@ -46,6 +50,7 @@ snapshot endpoints are both public. Version each module individually instead of step 2: + ```kotlin dependencies { implementation("net.onelitefeather:falco-anvil:3.0.1") @@ -54,6 +59,7 @@ dependencies { implementation("net.onelitefeather:falco-migration:3.0.1") } ``` + Use this only if your build cannot import a platform. Versioning the modules by hand lets them drift into a combination that was never built or tested together. diff --git a/docs/reference/modules-and-coordinates.md b/docs/reference/modules-and-coordinates.md index c219d06..2d04330 100644 --- a/docs/reference/modules-and-coordinates.md +++ b/docs/reference/modules-and-coordinates.md @@ -28,7 +28,7 @@ Consuming Falco needs no credentials. Only building Falco itself does — see | | | | --- | --- | | Kind | `java-library` | -| Current version | `3.0.1` | +| Current version | `3.0.1` | | Since | `0.1.0` | | Javadoc | [latest release](https://repo.onelitefeather.dev/javadoc/releases/net/onelitefeather/falco-anvil/latest) | @@ -39,7 +39,7 @@ An Anvil region-file chunk loader for Minestom. | | | | --- | --- | | Kind | `java-library` | -| Current version | `3.0.1` | +| Current version | `3.0.1` | | Since | `0.1.0` | | Javadoc | [latest release](https://repo.onelitefeather.dev/javadoc/releases/net/onelitefeather/falco-light/latest) | @@ -50,7 +50,7 @@ A block- and sky-light engine for Minestom. | | | | --- | --- | | Kind | `java-library` | -| Current version | `3.0.1` | +| Current version | `3.0.1` | | Since | `0.1.0` | | Javadoc | [latest release](https://repo.onelitefeather.dev/javadoc/releases/net/onelitefeather/falco-instance/latest) | @@ -62,7 +62,7 @@ sections on demand. | | | | --- | --- | | Kind | `java-library` | -| Current version | `3.0.1` | +| Current version | `3.0.1` | | Since | `2.0.0` | | Javadoc | not yet rendered at a stable address | @@ -74,7 +74,7 @@ Lifts a world older than the running server to it. Needed only when loading such | | | | --- | --- | | Kind | `java-platform` | -| Current version | `3.0.1` | +| Current version | `3.0.1` | | Since | `1.0.0` | | Javadoc | none — the artefact carries no classes |