-
-
Notifications
You must be signed in to change notification settings - Fork 0
Reference Modules and coordinates
Every published artefact, its coordinate, the repository that serves it and its rendered Javadoc.
This page is a generation target, currently written by hand. Source of truth: the
maven-publishconfiguration and the version catalog in the Falco repository. Until the generator lands, the version numbers below can go stale — Renovate keeps the snippets in the repository README current and cannot reach a wiki, so where this page and the README disagree, the README is right. The authoritative list of published versions is Releases.
| Endpoint | Authentication | |
|---|---|---|
| Releases | https://repo.onelitefeather.dev/releases |
none |
| Snapshots | https://repo.onelitefeather.dev/snapshots |
none |
Consuming Falco needs no credentials. Only building Falco itself does — see How-to Build Falco from source.
| Kind | java-library |
| Current version | 2.1.0 |
| Since | 0.1.0 |
| Javadoc | latest release |
An Anvil region-file chunk loader for Minestom.
| Kind | java-library |
| Current version | 2.1.0 |
| Since | 0.1.0 |
| Javadoc | latest release |
A block- and sky-light engine for Minestom.
| Kind | java-library |
| Current version | 2.1.0 |
| Since | 0.1.0 |
| Javadoc | latest release |
An Instance implementation that unloads the chunks it loaded, plus a Chunk that allocates its
sections on demand.
| Kind | java-library |
| Current version | 2.1.0 |
| Since | 2.0.0 |
| Javadoc | not yet rendered at a stable address |
Lifts a world older than the running server to it. Needed only when loading such a world; see How-to Migrate a world from an older version.
| Kind | java-platform |
| Current version | 2.1.0 |
| Since | 1.0.0 |
| Javadoc | none — the artefact carries no classes |
Carries one version constraint for each of the four modules above, so a build states the version once. A platform constrains versions; it does not pull in a module that was not declared.
falco-bom was added after 0.3.0 was cut, so releases before 1.0.0 do not serve it.
https://repo.onelitefeather.dev/javadoc/<releases|snapshots>/net/onelitefeather/<module>/<version>
latest is accepted in place of a version and follows the newest one on that endpoint. A version
never published to an endpoint answers 404 rather than showing an older one.
Every published module also carries a -javadoc.jar next to its main jar — the copy an IDE fetches
through Download Sources and Documentation.
A push to main that does not cut a release publishes to the snapshot endpoint under the released
version with its patch bumped and -SNAPSHOT appended: while 1.0.0 is the latest release, the
snapshot endpoint serves 1.0.1-SNAPSHOT. That version keeps moving as commits land.
Minestom, fastutil and adventure-nbt are compileOnly in every module and do not arrive with these
artefacts. A consumer declares its own Minestom version; Falco declares none.
Related: How-to Add Falco to your build · Explanation Why a second Anvil loader
Every published table lives on Reference Measured results, which owns them; a correction is made
there and nowhere else. What the ± after a JMH mean covers is defined once, in
Explanation What a measurement here means.
Wiki home · Repository · README and quick start · API documentation · Issues · Licence: AGPL-3.0
Getting started
How-to guides
- How-to Add Falco to your build
- How-to Load an Anvil world
- How-to Compute light for a loaded world
- How-to Keep chunk light up to date automatically
- How-to Use FalcoInstance instead of InstanceContainer
- How-to Migrate a world from an older version
four more
Reference
six more
Background
- Explanation Choosing between Falco and the built-in loader
- Explanation Scope and non-goals
- Explanation When light computation actually runs
- Explanation What a measurement here means
nine more
- Explanation Choosing between FalcoInstance and InstanceContainer
- Explanation How the Anvil loader is built
- Explanation How the light engine works
- Explanation How the concurrency design works
- Explanation How world migration works
- Explanation The chunk version guard
- Explanation Why a second Anvil loader
- Explanation Why a custom light engine
- Explanation Why falco-instance exists
- Explanation Comparing the light engine with Minestoms
- Explanation What the benchmarks establish
Project record
Working on Falco